thirdweb 5.64.4-nightly-c2a90542d7f870c799c297c59cd2b468816f7939-20241031000332 → 5.64.5

package/src/extensions/erc1155/__generated__/IDropSinglePhase1155/write/claim.ts

@@ -0,0 +1,229 @@
+import type { AbiParameterToPrimitiveType } from "abitype";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../../../transaction/types.js";
+import { prepareContractCall } from "../../../../../transaction/prepare-contract-call.js";
+import { encodeAbiParameters } from "../../../../../utils/abi/encodeAbiParameters.js";
+import { once } from "../../../../../utils/promise/once.js";
+import { detectMethod } from "../../../../../utils/bytecode/detectExtension.js";
+
+/**
+ * Represents the parameters for the "claim" function.
+ */
+export type ClaimParams = WithOverrides<{
+  receiver: AbiParameterToPrimitiveType<{ type: "address"; name: "receiver" }>;
+  tokenId: AbiParameterToPrimitiveType<{ type: "uint256"; name: "tokenId" }>;
+  quantity: AbiParameterToPrimitiveType<{ type: "uint256"; name: "quantity" }>;
+  currency: AbiParameterToPrimitiveType<{ type: "address"; name: "currency" }>;
+  pricePerToken: AbiParameterToPrimitiveType<{
+    type: "uint256";
+    name: "pricePerToken";
+  }>;
+  allowlistProof: AbiParameterToPrimitiveType<{
+    type: "tuple";
+    name: "allowlistProof";
+    components: [
+      { type: "bytes32[]"; name: "proof" },
+      { type: "uint256"; name: "quantityLimitPerWallet" },
+      { type: "uint256"; name: "pricePerToken" },
+      { type: "address"; name: "currency" },
+    ];
+  }>;
+  data: AbiParameterToPrimitiveType<{ type: "bytes"; name: "data" }>;
+}>;
+
+export const FN_SELECTOR = "0x57bc3d78" as const;
+const FN_INPUTS = [
+  {
+    type: "address",
+    name: "receiver",
+  },
+  {
+    type: "uint256",
+    name: "tokenId",
+  },
+  {
+    type: "uint256",
+    name: "quantity",
+  },
+  {
+    type: "address",
+    name: "currency",
+  },
+  {
+    type: "uint256",
+    name: "pricePerToken",
+  },
+  {
+    type: "tuple",
+    name: "allowlistProof",
+    components: [
+      {
+        type: "bytes32[]",
+        name: "proof",
+      },
+      {
+        type: "uint256",
+        name: "quantityLimitPerWallet",
+      },
+      {
+        type: "uint256",
+        name: "pricePerToken",
+      },
+      {
+        type: "address",
+        name: "currency",
+      },
+    ],
+  },
+  {
+    type: "bytes",
+    name: "data",
+  },
+] as const;
+const FN_OUTPUTS = [] as const;
+
+/**
+ * Checks if the `claim` method is supported by the given contract.
+ * @param availableSelectors An array of 4byte function selectors of the contract. You can get this in various ways, such as using "whatsabi" or if you have the ABI of the contract available you can use it to generate the selectors.
+ * @returns A boolean indicating if the `claim` method is supported.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { isClaimSupported } from "thirdweb/extensions/erc1155";
+ *
+ * const supported = isClaimSupported(["0x..."]);
+ * ```
+ */
+export function isClaimSupported(availableSelectors: string[]) {
+  return detectMethod({
+    availableSelectors,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+  });
+}
+
+/**
+ * Encodes the parameters for the "claim" function.
+ * @param options - The options for the claim function.
+ * @returns The encoded ABI parameters.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { encodeClaimParams } from "thirdweb/extensions/erc1155";
+ * const result = encodeClaimParams({
+ *  receiver: ...,
+ *  tokenId: ...,
+ *  quantity: ...,
+ *  currency: ...,
+ *  pricePerToken: ...,
+ *  allowlistProof: ...,
+ *  data: ...,
+ * });
+ * ```
+ */
+export function encodeClaimParams(options: ClaimParams) {
+  return encodeAbiParameters(FN_INPUTS, [
+    options.receiver,
+    options.tokenId,
+    options.quantity,
+    options.currency,
+    options.pricePerToken,
+    options.allowlistProof,
+    options.data,
+  ]);
+}
+
+/**
+ * Encodes the "claim" function into a Hex string with its parameters.
+ * @param options - The options for the claim function.
+ * @returns The encoded hexadecimal string.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { encodeClaim } from "thirdweb/extensions/erc1155";
+ * const result = encodeClaim({
+ *  receiver: ...,
+ *  tokenId: ...,
+ *  quantity: ...,
+ *  currency: ...,
+ *  pricePerToken: ...,
+ *  allowlistProof: ...,
+ *  data: ...,
+ * });
+ * ```
+ */
+export function encodeClaim(options: ClaimParams) {
+  // we do a "manual" concat here to avoid the overhead of the "concatHex" function
+  // we can do this because we know the specific formats of the values
+  return (FN_SELECTOR +
+    encodeClaimParams(options).slice(2)) as `${typeof FN_SELECTOR}${string}`;
+}
+
+/**
+ * Prepares a transaction to call the "claim" function on the contract.
+ * @param options - The options for the "claim" function.
+ * @returns A prepared transaction object.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { sendTransaction } from "thirdweb";
+ * import { claim } from "thirdweb/extensions/erc1155";
+ *
+ * const transaction = claim({
+ *  contract,
+ *  receiver: ...,
+ *  tokenId: ...,
+ *  quantity: ...,
+ *  currency: ...,
+ *  pricePerToken: ...,
+ *  allowlistProof: ...,
+ *  data: ...,
+ *  overrides: {
+ *    ...
+ *  }
+ * });
+ *
+ * // Send the transaction
+ * await sendTransaction({ transaction, account });
+ * ```
+ */
+export function claim(
+  options: BaseTransactionOptions<
+    | ClaimParams
+    | {
+        asyncParams: () => Promise<ClaimParams>;
+      }
+  >,
+) {
+  const asyncOptions = once(async () => {
+    return "asyncParams" in options ? await options.asyncParams() : options;
+  });
+
+  return prepareContractCall({
+    contract: options.contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+    params: async () => {
+      const resolvedOptions = await asyncOptions();
+      return [
+        resolvedOptions.receiver,
+        resolvedOptions.tokenId,
+        resolvedOptions.quantity,
+        resolvedOptions.currency,
+        resolvedOptions.pricePerToken,
+        resolvedOptions.allowlistProof,
+        resolvedOptions.data,
+      ] as const;
+    },
+    value: async () => (await asyncOptions()).overrides?.value,
+    accessList: async () => (await asyncOptions()).overrides?.accessList,
+    gas: async () => (await asyncOptions()).overrides?.gas,
+    gasPrice: async () => (await asyncOptions()).overrides?.gasPrice,
+    maxFeePerGas: async () => (await asyncOptions()).overrides?.maxFeePerGas,
+    maxPriorityFeePerGas: async () =>
+      (await asyncOptions()).overrides?.maxPriorityFeePerGas,
+    nonce: async () => (await asyncOptions()).overrides?.nonce,
+    extraGas: async () => (await asyncOptions()).overrides?.extraGas,
+    erc20Value: async () => (await asyncOptions()).overrides?.erc20Value,
+  });
+}

package/src/extensions/erc1155/__generated__/IDropSinglePhase1155/write/setClaimConditions.ts

@@ -0,0 +1,213 @@
+import type { AbiParameterToPrimitiveType } from "abitype";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../../../transaction/types.js";
+import { prepareContractCall } from "../../../../../transaction/prepare-contract-call.js";
+import { encodeAbiParameters } from "../../../../../utils/abi/encodeAbiParameters.js";
+import { once } from "../../../../../utils/promise/once.js";
+import { detectMethod } from "../../../../../utils/bytecode/detectExtension.js";
+
+/**
+ * Represents the parameters for the "setClaimConditions" function.
+ */
+export type SetClaimConditionsParams = WithOverrides<{
+  tokenId: AbiParameterToPrimitiveType<{ type: "uint256"; name: "tokenId" }>;
+  phase: AbiParameterToPrimitiveType<{
+    type: "tuple";
+    name: "phase";
+    components: [
+      { type: "uint256"; name: "startTimestamp" },
+      { type: "uint256"; name: "maxClaimableSupply" },
+      { type: "uint256"; name: "supplyClaimed" },
+      { type: "uint256"; name: "quantityLimitPerWallet" },
+      { type: "bytes32"; name: "merkleRoot" },
+      { type: "uint256"; name: "pricePerToken" },
+      { type: "address"; name: "currency" },
+      { type: "string"; name: "metadata" },
+    ];
+  }>;
+  resetClaimEligibility: AbiParameterToPrimitiveType<{
+    type: "bool";
+    name: "resetClaimEligibility";
+  }>;
+}>;
+
+export const FN_SELECTOR = "0x8affb89f" as const;
+const FN_INPUTS = [
+  {
+    type: "uint256",
+    name: "tokenId",
+  },
+  {
+    type: "tuple",
+    name: "phase",
+    components: [
+      {
+        type: "uint256",
+        name: "startTimestamp",
+      },
+      {
+        type: "uint256",
+        name: "maxClaimableSupply",
+      },
+      {
+        type: "uint256",
+        name: "supplyClaimed",
+      },
+      {
+        type: "uint256",
+        name: "quantityLimitPerWallet",
+      },
+      {
+        type: "bytes32",
+        name: "merkleRoot",
+      },
+      {
+        type: "uint256",
+        name: "pricePerToken",
+      },
+      {
+        type: "address",
+        name: "currency",
+      },
+      {
+        type: "string",
+        name: "metadata",
+      },
+    ],
+  },
+  {
+    type: "bool",
+    name: "resetClaimEligibility",
+  },
+] as const;
+const FN_OUTPUTS = [] as const;
+
+/**
+ * Checks if the `setClaimConditions` method is supported by the given contract.
+ * @param availableSelectors An array of 4byte function selectors of the contract. You can get this in various ways, such as using "whatsabi" or if you have the ABI of the contract available you can use it to generate the selectors.
+ * @returns A boolean indicating if the `setClaimConditions` method is supported.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { isSetClaimConditionsSupported } from "thirdweb/extensions/erc1155";
+ *
+ * const supported = isSetClaimConditionsSupported(["0x..."]);
+ * ```
+ */
+export function isSetClaimConditionsSupported(availableSelectors: string[]) {
+  return detectMethod({
+    availableSelectors,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+  });
+}
+
+/**
+ * Encodes the parameters for the "setClaimConditions" function.
+ * @param options - The options for the setClaimConditions function.
+ * @returns The encoded ABI parameters.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { encodeSetClaimConditionsParams } from "thirdweb/extensions/erc1155";
+ * const result = encodeSetClaimConditionsParams({
+ *  tokenId: ...,
+ *  phase: ...,
+ *  resetClaimEligibility: ...,
+ * });
+ * ```
+ */
+export function encodeSetClaimConditionsParams(
+  options: SetClaimConditionsParams,
+) {
+  return encodeAbiParameters(FN_INPUTS, [
+    options.tokenId,
+    options.phase,
+    options.resetClaimEligibility,
+  ]);
+}
+
+/**
+ * Encodes the "setClaimConditions" function into a Hex string with its parameters.
+ * @param options - The options for the setClaimConditions function.
+ * @returns The encoded hexadecimal string.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { encodeSetClaimConditions } from "thirdweb/extensions/erc1155";
+ * const result = encodeSetClaimConditions({
+ *  tokenId: ...,
+ *  phase: ...,
+ *  resetClaimEligibility: ...,
+ * });
+ * ```
+ */
+export function encodeSetClaimConditions(options: SetClaimConditionsParams) {
+  // we do a "manual" concat here to avoid the overhead of the "concatHex" function
+  // we can do this because we know the specific formats of the values
+  return (FN_SELECTOR +
+    encodeSetClaimConditionsParams(options).slice(
+      2,
+    )) as `${typeof FN_SELECTOR}${string}`;
+}
+
+/**
+ * Prepares a transaction to call the "setClaimConditions" function on the contract.
+ * @param options - The options for the "setClaimConditions" function.
+ * @returns A prepared transaction object.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { sendTransaction } from "thirdweb";
+ * import { setClaimConditions } from "thirdweb/extensions/erc1155";
+ *
+ * const transaction = setClaimConditions({
+ *  contract,
+ *  tokenId: ...,
+ *  phase: ...,
+ *  resetClaimEligibility: ...,
+ *  overrides: {
+ *    ...
+ *  }
+ * });
+ *
+ * // Send the transaction
+ * await sendTransaction({ transaction, account });
+ * ```
+ */
+export function setClaimConditions(
+  options: BaseTransactionOptions<
+    | SetClaimConditionsParams
+    | {
+        asyncParams: () => Promise<SetClaimConditionsParams>;
+      }
+  >,
+) {
+  const asyncOptions = once(async () => {
+    return "asyncParams" in options ? await options.asyncParams() : options;
+  });
+
+  return prepareContractCall({
+    contract: options.contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+    params: async () => {
+      const resolvedOptions = await asyncOptions();
+      return [
+        resolvedOptions.tokenId,
+        resolvedOptions.phase,
+        resolvedOptions.resetClaimEligibility,
+      ] as const;
+    },
+    value: async () => (await asyncOptions()).overrides?.value,
+    accessList: async () => (await asyncOptions()).overrides?.accessList,
+    gas: async () => (await asyncOptions()).overrides?.gas,
+    gasPrice: async () => (await asyncOptions()).overrides?.gasPrice,
+    maxFeePerGas: async () => (await asyncOptions()).overrides?.maxFeePerGas,
+    maxPriorityFeePerGas: async () =>
+      (await asyncOptions()).overrides?.maxPriorityFeePerGas,
+    nonce: async () => (await asyncOptions()).overrides?.nonce,
+    extraGas: async () => (await asyncOptions()).overrides?.extraGas,
+    erc20Value: async () => (await asyncOptions()).overrides?.erc20Value,
+  });
+}

package/src/extensions/erc1155/customDrop1155.test.ts

@@ -0,0 +1,181 @@
+import { fetchDeployMetadata } from "../../utils/any-evm/deploy-metadata.js";
+
+import { beforeAll, describe, expect, it } from "vitest";
+import { VITALIK_WALLET } from "../../../test/src/addresses.js";
+import { ANVIL_CHAIN } from "../../../test/src/chains.js";
+import { TEST_CLIENT } from "../../../test/src/test-clients.js";
+import {
+  TEST_ACCOUNT_B,
+  TEST_ACCOUNT_C,
+} from "../../../test/src/test-wallets.js";
+import { type ThirdwebContract, getContract } from "../../contract/contract.js";
+import { sendAndConfirmTransaction } from "../../transaction/actions/send-and-confirm-transaction.js";
+import { deployContractfromDeployMetadata } from "../prebuilts/deploy-published.js";
+import { balanceOf } from "./__generated__/IERC1155/read/balanceOf.js";
+import { nextTokenIdToMint } from "./__generated__/IERC1155Enumerable/read/nextTokenIdToMint.js";
+import { claimTo } from "./drops/write/claimTo.js";
+import { setClaimConditions } from "./drops/write/setClaimConditions.js";
+import { getNFT } from "./read/getNFT.js";
+import { lazyMint } from "./write/lazyMint.js";
+
+describe.runIf(process.env.TW_SECRET_KEY)(
+  "CustomDropERC1155",
+  {
+    retry: 0,
+  },
+  () => {
+    let contract: ThirdwebContract;
+
+    beforeAll(async () => {
+      const customDropDeployMetadata = await fetchDeployMetadata({
+        client: TEST_CLIENT,
+        uri: "ipfs://QmaqFExXhU8kWkgAZCqxo8F3GZd8D2NJzCJWerfmFjujo8",
+      });
+      const contractAddress = await deployContractfromDeployMetadata({
+        chain: ANVIL_CHAIN,
+        client: TEST_CLIENT,
+        account: TEST_ACCOUNT_C,
+        deployMetadata: customDropDeployMetadata,
+        initializeParams: {
+          defaultAdmin: TEST_ACCOUNT_C.address,
+          name: "TestCustomDropERC1155",
+          symbol: "TT",
+        },
+      });
+
+      contract = getContract({
+        address: contractAddress,
+        chain: ANVIL_CHAIN,
+        client: TEST_CLIENT,
+      });
+      // this deploys a contract, it may take some time
+    }, 60_000);
+
+    it("should allow for lazy minting tokens", async () => {
+      const mintTx = lazyMint({
+        contract,
+        nfts: [
+          { name: "Test NFT" },
+          { name: "Test NFT 2" },
+          { name: "Test NFT 3" },
+          { name: "Test NFT 4" },
+          { name: "Test NFT 5" },
+          { name: "Test NFT 6" },
+        ],
+      });
+      await sendAndConfirmTransaction({
+        transaction: mintTx,
+        account: TEST_ACCOUNT_C,
+      });
+
+      await expect(nextTokenIdToMint({ contract })).resolves.toBe(6n);
+      await expect(
+        getNFT({ contract, tokenId: 0n }),
+      ).resolves.toMatchInlineSnapshot(`
+          {
+            "id": 0n,
+            "metadata": {
+              "name": "Test NFT",
+            },
+            "owner": null,
+            "supply": 0n,
+            "tokenURI": "ipfs://QmTo68Dm1ntSp2BHLmE9gesS6ELuXosRz5mAgFCK6tfsRk/0",
+            "type": "ERC1155",
+          }
+        `);
+    });
+
+    it("should allow to claim tokens", async () => {
+      await expect(
+        balanceOf({ contract, owner: TEST_ACCOUNT_C.address, tokenId: 0n }),
+      ).resolves.toBe(0n);
+      await sendAndConfirmTransaction({
+        transaction: setClaimConditions({
+          contract,
+          phases: [
+            {
+              startTime: new Date(0),
+              maxClaimableSupply: 10n,
+            },
+          ],
+          tokenId: 0n,
+          singlePhaseDrop: true,
+        }),
+        account: TEST_ACCOUNT_C,
+      });
+      const claimTx = claimTo({
+        contract,
+        to: TEST_ACCOUNT_C.address,
+        tokenId: 0n,
+        quantity: 1n,
+        singlePhaseDrop: true,
+      });
+      await sendAndConfirmTransaction({
+        transaction: claimTx,
+        account: TEST_ACCOUNT_C,
+      });
+      await expect(
+        balanceOf({ contract, owner: TEST_ACCOUNT_C.address, tokenId: 0n }),
+      ).resolves.toBe(1n);
+    });
+
+    it("should allow to claim tokens with an allowlist", async () => {
+      const tokenId = 1n;
+      await sendAndConfirmTransaction({
+        transaction: setClaimConditions({
+          contract,
+          phases: [
+            {
+              overrideList: [
+                { address: TEST_ACCOUNT_C.address, maxClaimable: "100" },
+                { address: VITALIK_WALLET, maxClaimable: "100" },
+              ],
+              maxClaimablePerWallet: 0n,
+            },
+          ],
+          tokenId,
+          singlePhaseDrop: true,
+        }),
+        account: TEST_ACCOUNT_C,
+      });
+
+      await expect(
+        balanceOf({ contract, owner: TEST_ACCOUNT_B.address, tokenId }),
+      ).resolves.toBe(0n);
+
+      await sendAndConfirmTransaction({
+        account: TEST_ACCOUNT_C,
+        transaction: claimTo({
+          contract,
+          from: TEST_ACCOUNT_C.address,
+          to: TEST_ACCOUNT_B.address,
+          tokenId,
+          quantity: 1n,
+          singlePhaseDrop: true,
+        }),
+      });
+
+      await expect(
+        balanceOf({ contract, owner: TEST_ACCOUNT_B.address, tokenId }),
+      ).resolves.toBe(1n);
+
+      await expect(
+        sendAndConfirmTransaction({
+          account: TEST_ACCOUNT_B,
+          transaction: claimTo({
+            contract,
+            to: TEST_ACCOUNT_B.address,
+            tokenId,
+            quantity: 1n,
+            singlePhaseDrop: true,
+          }),
+        }),
+      ).rejects.toThrowErrorMatchingInlineSnapshot(`
+          [TransactionError: Error - !Qty
+
+          contract: ${contract.address}
+          chainId: ${contract.chain.id}]
+        `);
+    });
+  },
+);

package/src/extensions/erc1155/drops/write/claimTo.ts

@@ -2,6 +2,7 @@ import type { BaseTransactionOptions } from "../../../../transaction/types.js";
 import { getClaimParams } from "../../../../utils/extensions/drops/get-claim-params.js";
 import { isGetContractMetadataSupported } from "../../../common/read/getContractMetadata.js";
 import * as GeneratedClaim from "../../__generated__/IDrop1155/write/claim.js";
+import { isClaimConditionSupported } from "../../__generated__/IDropSinglePhase1155/read/claimCondition.js";
 import { isGetActiveClaimConditionSupported } from "../read/getActiveClaimCondition.js";
 
 /**
@@ -12,6 +13,7 @@ export type ClaimToParams = {
   tokenId: bigint;
   quantity: bigint;
   from?: string;
+  singlePhaseDrop?: boolean;
 };
 
 /**
@@ -59,6 +61,7 @@ export function claimTo(options: BaseTransactionOptions<ClaimToParams>) {
         quantity: options.quantity,
         from: options.from,
         tokenId: options.tokenId,
+        singlePhaseDrop: options.singlePhaseDrop,
       });
 
       return {
@@ -85,9 +88,10 @@ export function isClaimToSupported(availableSelectors: string[]) {
   return [
     // has to support the claim method
     GeneratedClaim.isClaimSupported(availableSelectors),
-    // has to support the getActiveClaimCondition method
-    isGetActiveClaimConditionSupported(availableSelectors),
     // requires contractMetadata for claimer proofs
     isGetContractMetadataSupported(availableSelectors),
+    // required to check if the contract supports the getActiveClaimCondition method
+    isGetActiveClaimConditionSupported(availableSelectors) ||
+      isClaimConditionSupported(availableSelectors),
   ].every(Boolean);
 }

package/src/extensions/erc1155/drops/write/setClaimConditions.ts

@@ -8,6 +8,7 @@ import {
 } from "../../../common/__generated__/IMulticall/write/multicall.js";
 import { isGetContractMetadataSupported } from "../../../common/read/getContractMetadata.js";
 import { isSetClaimConditionsSupported as isSetClaimConditionsSupportedGenerated } from "../../__generated__/IDrop1155/write/setClaimConditions.js";
+import { isSetClaimConditionsSupported as isSetClaimConditionsSupportedGeneratedSinglePhase } from "../../__generated__/IDropSinglePhase1155/write/setClaimConditions.js";
 
 /**
  * @extension ERC1155
@@ -16,6 +17,7 @@ export type SetClaimConditionsParams = {
   tokenId: bigint;
   phases: ClaimConditionsInput[];
   resetClaimEligibility?: boolean;
+  singlePhaseDrop?: boolean;
 };
 
 /**
@@ -58,6 +60,7 @@ export function setClaimConditions(
           resetClaimEligibility: options.resetClaimEligibility,
           tokenId: options.tokenId,
           tokenDecimals: 0,
+          singlePhase: options.singlePhaseDrop,
         }),
       };
     },
@@ -83,6 +86,7 @@ export function isSetClaimConditionsSupported(availableSelectors: string[]) {
     isGetContractMetadataSupported(availableSelectors) &&
     isSetContractURISupported(availableSelectors) &&
     // needs to actually be able to set the claim Conditions
-    isSetClaimConditionsSupportedGenerated(availableSelectors)
+    (isSetClaimConditionsSupportedGenerated(availableSelectors) ||
+      isSetClaimConditionsSupportedGeneratedSinglePhase(availableSelectors))
   );
 }