adjust test

Author: kien-ngo

.changeset/bright-walls-applaud.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+Optimize mintAdditionalSupplyToBatch extension

packages/thirdweb/src/extensions/erc1155/write/mintAdditionalSupplyTo.test.ts

@@ -1,13 +1,19 @@
+import { type Abi, toFunctionSelector } from "viem";
 import { describe, expect, it } from "vitest";
 import { ANVIL_CHAIN } from "~test/chains.js";
 import { TEST_CONTRACT_URI } from "~test/ipfs-uris.js";
 import { TEST_CLIENT } from "~test/test-clients.js";
 import { TEST_ACCOUNT_C } from "~test/test-wallets.js";
+import { resolveContractAbi } from "../../../contract/actions/resolve-abi.js";
 import { getContract } from "../../../contract/contract.js";
 import { deployERC1155Contract } from "../../../extensions/prebuilts/deploy-erc1155.js";
 import { sendAndConfirmTransaction } from "../../../transaction/actions/send-and-confirm-transaction.js";
 import { getNFTs } from "../read/getNFTs.js";
-import { mintAdditionalSupplyToBatch } from "./mintAdditionalSupplyToBatch.js";
+import { isMintAdditionalSupplyToSupported } from "./mintAdditionalSupplyTo.js";
+import {
+  mintAdditionalSupplyToBatch,
+  optimizeMintBatchContent,
+} from "./mintAdditionalSupplyToBatch.js";
 import { mintToBatch } from "./mintToBatch.js";
 
 const chain = ANVIL_CHAIN;
@@ -17,6 +23,19 @@ const account = TEST_ACCOUNT_C;
 describe.runIf(process.env.TW_SECRET_KEY)(
   "ERC1155 Edition: mintToBatch",
   () => {
+    it("should optimize the mint content", () => {
+      expect(
+        optimizeMintBatchContent([
+          { tokenId: 0n, supply: 99n, to: account.address },
+          { tokenId: 1n, supply: 49n, to: account.address },
+          { tokenId: 1n, supply: 51n, to: account.address },
+        ]),
+      ).toStrictEqual([
+        { tokenId: 0n, supply: 99n, to: account.address },
+        { tokenId: 1n, supply: 100n, to: account.address },
+      ]);
+    });
+
     it("should mint multiple tokens in one tx", async () => {
       const contract = getContract({
         chain,
@@ -33,6 +52,13 @@ describe.runIf(process.env.TW_SECRET_KEY)(
         }),
       });
 
+      // `isMintAdditionalSupplyToSupported` should work with our Edition contracts
+      const abi = await resolveContractAbi<Abi>(contract);
+      const selectors = abi
+        .filter((f) => f.type === "function")
+        .map((f) => toFunctionSelector(f));
+      expect(isMintAdditionalSupplyToSupported(selectors)).toBe(true);
+
       await sendAndConfirmTransaction({
         account,
         transaction: mintToBatch({
@@ -52,8 +78,9 @@ describe.runIf(process.env.TW_SECRET_KEY)(
           contract,
           nfts: [
             { tokenId: 0n, supply: 99n, to: account.address },
-            { tokenId: 1n, supply: 98n, to: account.address },
+            { tokenId: 1n, supply: 94n, to: account.address },
             { tokenId: 2n, supply: 97n, to: account.address },
+            { tokenId: 1n, supply: 4n, to: account.address },
           ],
         }),
       });

packages/thirdweb/src/extensions/erc1155/write/mintAdditionalSupplyToBatch.test.ts

@@ -1,15 +1,18 @@
 import { multicall } from "../../../extensions/common/__generated__/IMulticall/write/multicall.js";
-import type { BaseTransactionOptions } from "../../../transaction/types.js";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../transaction/types.js";
 import { uri } from "../__generated__/IERC1155/read/uri.js";
 import { encodeMintTo } from "../__generated__/IMintableERC1155/write/mintTo.js";
 import type { MintAdditionalSupplyToParams } from "./mintAdditionalSupplyTo.js";
 
 /**
  * @extension ERC1155
  */
-export type MintAdditionalSupplyToBatchParams = {
+export type MintAdditionalSupplyToBatchParams = WithOverrides<{
   nfts: MintAdditionalSupplyToParams[];
-};
+}>;
 
 /**
  * This extension batches multiple `mintAdditionalSupplyToBatch` extensions into one single multicall.
@@ -38,8 +41,9 @@ export function mintAdditionalSupplyToBatch(
   return multicall({
     contract: options.contract,
     asyncParams: async () => {
+      const nfts = optimizeMintBatchContent(options.nfts);
       const data = await Promise.all(
-        options.nfts.map(async (nft) => {
+        nfts.map(async (nft) => {
           const tokenUri = await uri({
             contract: options.contract,
             tokenId: nft.tokenId,
@@ -54,5 +58,48 @@ export function mintAdditionalSupplyToBatch(
       );
       return { data };
     },
+    overrides: options.overrides,
   });
 }
+
+/**
+ * Optimization
+ *
+ * We can batch the records that share the same "to" & "tokenId" into 1 transaction
+ *
+ * For example, this struct:
+ * [
+ *   { tokenId: 0n, supply: 99n, to: account.address },
+ *   { tokenId: 1n, supply: 49n, to: account.address },
+ *   { tokenId: 1n, supply: 51n, to: account.address },
+ * ]
+ *
+ * ...can be packed into:
+ * [
+ *   { tokenId: 0n, supply: 99n, to: account.address },
+ *   { tokenId: 1n, supply: 100n, to: account.address },
+ * ]
+ * @internal
+ */
+export function optimizeMintBatchContent(
+  nfts: MintAdditionalSupplyToParams[],
+): MintAdditionalSupplyToParams[] {
+  const results: MintAdditionalSupplyToParams[] = [];
+  for (const item of nfts) {
+    const matchingIndex = results.findIndex(
+      (o) =>
+        o.tokenId === item.tokenId &&
+        o.to.toLowerCase() === item.to.toLowerCase(),
+    );
+    if (matchingIndex !== -1) {
+      results[matchingIndex] = {
+        to: item.to,
+        tokenId: item.tokenId,
+        supply: item.supply + (results[matchingIndex]?.supply || 0n),
+      };
+    } else {
+      results.push(item);
+    }
+  }
+  return results;
+}