thirdweb 5.88.2-nightly-0c1bb6ccaec9dc4edf596dac7f7623d0ad90f757-20250212000327 → 5.88.3

package/src/extensions/erc1155/__generated__/DropERC1155/read/verifyClaim.ts

@@ -0,0 +1,223 @@
+import type { AbiParameterToPrimitiveType } from "abitype";
+import { readContract } from "../../../../../transaction/read-contract.js";
+import type { BaseTransactionOptions } from "../../../../../transaction/types.js";
+import { encodeAbiParameters } from "../../../../../utils/abi/encodeAbiParameters.js";
+import { decodeAbiParameters } from "viem";
+import type { Hex } from "../../../../../utils/encoding/hex.js";
+import { detectMethod } from "../../../../../utils/bytecode/detectExtension.js";
+
+/**
+ * Represents the parameters for the "verifyClaim" function.
+ */
+export type VerifyClaimParams = {
+  conditionId: AbiParameterToPrimitiveType<{
+    type: "uint256";
+    name: "_conditionId";
+  }>;
+  claimer: AbiParameterToPrimitiveType<{ type: "address"; name: "_claimer" }>;
+  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" },
+    ];
+  }>;
+};
+
+export const FN_SELECTOR = "0xea1def9c" as const;
+const FN_INPUTS = [
+  {
+    type: "uint256",
+    name: "_conditionId",
+  },
+  {
+    type: "address",
+    name: "_claimer",
+  },
+  {
+    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",
+      },
+    ],
+  },
+] as const;
+const FN_OUTPUTS = [
+  {
+    type: "bool",
+    name: "isOverride",
+  },
+] as const;
+
+/**
+ * Checks if the `verifyClaim` 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 `verifyClaim` method is supported.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { isVerifyClaimSupported } from "thirdweb/extensions/erc1155";
+ * const supported = isVerifyClaimSupported(["0x..."]);
+ * ```
+ */
+export function isVerifyClaimSupported(availableSelectors: string[]) {
+  return detectMethod({
+    availableSelectors,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+  });
+}
+
+/**
+ * Encodes the parameters for the "verifyClaim" function.
+ * @param options - The options for the verifyClaim function.
+ * @returns The encoded ABI parameters.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { encodeVerifyClaimParams } from "thirdweb/extensions/erc1155";
+ * const result = encodeVerifyClaimParams({
+ *  conditionId: ...,
+ *  claimer: ...,
+ *  tokenId: ...,
+ *  quantity: ...,
+ *  currency: ...,
+ *  pricePerToken: ...,
+ *  allowlistProof: ...,
+ * });
+ * ```
+ */
+export function encodeVerifyClaimParams(options: VerifyClaimParams) {
+  return encodeAbiParameters(FN_INPUTS, [
+    options.conditionId,
+    options.claimer,
+    options.tokenId,
+    options.quantity,
+    options.currency,
+    options.pricePerToken,
+    options.allowlistProof,
+  ]);
+}
+
+/**
+ * Encodes the "verifyClaim" function into a Hex string with its parameters.
+ * @param options - The options for the verifyClaim function.
+ * @returns The encoded hexadecimal string.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { encodeVerifyClaim } from "thirdweb/extensions/erc1155";
+ * const result = encodeVerifyClaim({
+ *  conditionId: ...,
+ *  claimer: ...,
+ *  tokenId: ...,
+ *  quantity: ...,
+ *  currency: ...,
+ *  pricePerToken: ...,
+ *  allowlistProof: ...,
+ * });
+ * ```
+ */
+export function encodeVerifyClaim(options: VerifyClaimParams) {
+  // 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 +
+    encodeVerifyClaimParams(options).slice(
+      2,
+    )) as `${typeof FN_SELECTOR}${string}`;
+}
+
+/**
+ * Decodes the result of the verifyClaim function call.
+ * @param result - The hexadecimal result to decode.
+ * @returns The decoded result as per the FN_OUTPUTS definition.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { decodeVerifyClaimResult } from "thirdweb/extensions/erc1155";
+ * const result = decodeVerifyClaimResultResult("...");
+ * ```
+ */
+export function decodeVerifyClaimResult(result: Hex) {
+  return decodeAbiParameters(FN_OUTPUTS, result)[0];
+}
+
+/**
+ * Calls the "verifyClaim" function on the contract.
+ * @param options - The options for the verifyClaim function.
+ * @returns The parsed result of the function call.
+ * @extension ERC1155
+ * @example
+ * ```ts
+ * import { verifyClaim } from "thirdweb/extensions/erc1155";
+ *
+ * const result = await verifyClaim({
+ *  contract,
+ *  conditionId: ...,
+ *  claimer: ...,
+ *  tokenId: ...,
+ *  quantity: ...,
+ *  currency: ...,
+ *  pricePerToken: ...,
+ *  allowlistProof: ...,
+ * });
+ *
+ * ```
+ */
+export async function verifyClaim(
+  options: BaseTransactionOptions<VerifyClaimParams>,
+) {
+  return readContract({
+    contract: options.contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+    params: [
+      options.conditionId,
+      options.claimer,
+      options.tokenId,
+      options.quantity,
+      options.currency,
+      options.pricePerToken,
+      options.allowlistProof,
+    ],
+  });
+}

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

@@ -22,6 +22,7 @@ import { deployERC1155Contract } from "../prebuilts/deploy-erc1155.js";
 import { balanceOf } from "./__generated__/IERC1155/read/balanceOf.js";
 import { totalSupply } from "./__generated__/IERC1155/read/totalSupply.js";
 import { nextTokenIdToMint } from "./__generated__/IERC1155Enumerable/read/nextTokenIdToMint.js";
+import { canClaim } from "./drops/read/canClaim.js";
 import { getActiveClaimCondition } from "./drops/read/getActiveClaimCondition.js";
 import { getClaimConditions } from "./drops/read/getClaimConditions.js";
 import { claimTo } from "./drops/write/claimTo.js";
@@ -130,6 +131,20 @@ describe.runIf(process.env.TW_SECRET_KEY)(
         }),
         account: TEST_ACCOUNT_C,
       });
+
+      expect(
+        await canClaim({
+          contract,
+          claimer: TEST_ACCOUNT_C.address,
+          quantity: 1n,
+          tokenId: 0n,
+        }),
+      ).toMatchInlineSnapshot(`
+        {
+          "result": true,
+        }
+      `);
+
       const claimTx = claimTo({
         contract,
         to: TEST_ACCOUNT_C.address,
@@ -205,6 +220,33 @@ describe.runIf(process.env.TW_SECRET_KEY)(
           balanceOf({ contract, owner: TEST_ACCOUNT_B.address, tokenId }),
         ).resolves.toBe(0n);
 
+        expect(
+          await canClaim({
+            contract,
+            claimer: TEST_ACCOUNT_C.address,
+            quantity: 1n,
+            tokenId,
+          }),
+        ).toMatchInlineSnapshot(`
+          {
+            "result": true,
+          }
+        `);
+
+        expect(
+          await canClaim({
+            contract,
+            claimer: TEST_ACCOUNT_B.address,
+            quantity: 1n,
+            tokenId,
+          }),
+        ).toMatchInlineSnapshot(`
+          {
+            "reason": "DropClaimExceedLimit - 0,1",
+            "result": false,
+          }
+        `);
+
         await sendAndConfirmTransaction({
           account: TEST_ACCOUNT_C,
           transaction: claimTo({

package/src/extensions/erc1155/drops/read/canClaim.ts

@@ -0,0 +1,75 @@
+import { extractErrorResult } from "../../../../transaction/extract-error.js";
+import type { BaseTransactionOptions } from "../../../../transaction/types.js";
+import { getClaimParams } from "../../../../utils/extensions/drops/get-claim-params.js";
+import { verifyClaim } from "../../__generated__/DropERC1155/read/verifyClaim.js";
+import { getActiveClaimConditionId } from "../../__generated__/IDrop1155/read/getActiveClaimConditionId.js";
+
+export type CanClaimParams = {
+  claimer: string;
+  quantity: bigint;
+  tokenId: bigint;
+  from?: string;
+};
+
+export type CanClaimResult = {
+  result: boolean;
+  reason?: string;
+};
+
+/**
+ * Check if a user can claim a drop.
+ *
+ * @param options - The options for the transaction.
+ * @returns Whether the user can claim the drop.
+ *
+ * @example
+ * ```ts
+ * const claimResult = await canClaim({
+ *   contract: contract,
+ *   claimer: "0x1234567890123456789012345678901234567890",
+ *   quantity: "1",
+ *   tokenId: 0n,
+ * });
+ * ```
+ *
+ * @extension ERC1155
+ */
+export async function canClaim(
+  options: BaseTransactionOptions<CanClaimParams>,
+): Promise<CanClaimResult> {
+  const [conditionId, { quantity, currency, pricePerToken, allowlistProof }] =
+    await Promise.all([
+      getActiveClaimConditionId({
+        contract: options.contract,
+        tokenId: options.tokenId,
+      }),
+      getClaimParams({
+        contract: options.contract,
+        quantity: options.quantity,
+        to: options.claimer,
+        type: "erc1155",
+        tokenId: options.tokenId,
+        from: options.from,
+      }),
+    ]);
+  try {
+    await verifyClaim({
+      contract: options.contract,
+      claimer: options.claimer,
+      quantity,
+      currency,
+      pricePerToken,
+      allowlistProof,
+      conditionId,
+      tokenId: options.tokenId,
+    });
+    return {
+      result: true,
+    };
+  } catch (error) {
+    return {
+      result: false,
+      reason: await extractErrorResult({ error, contract: options.contract }),
+    };
+  }
+}

package/src/extensions/erc20/__generated__/DropERC20/read/verifyClaim.ts

@@ -0,0 +1,213 @@
+import type { AbiParameterToPrimitiveType } from "abitype";
+import { readContract } from "../../../../../transaction/read-contract.js";
+import type { BaseTransactionOptions } from "../../../../../transaction/types.js";
+import { encodeAbiParameters } from "../../../../../utils/abi/encodeAbiParameters.js";
+import { decodeAbiParameters } from "viem";
+import type { Hex } from "../../../../../utils/encoding/hex.js";
+import { detectMethod } from "../../../../../utils/bytecode/detectExtension.js";
+
+/**
+ * Represents the parameters for the "verifyClaim" function.
+ */
+export type VerifyClaimParams = {
+  conditionId: AbiParameterToPrimitiveType<{
+    type: "uint256";
+    name: "_conditionId";
+  }>;
+  claimer: AbiParameterToPrimitiveType<{ type: "address"; name: "_claimer" }>;
+  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" },
+    ];
+  }>;
+};
+
+export const FN_SELECTOR = "0x23a2902b" as const;
+const FN_INPUTS = [
+  {
+    type: "uint256",
+    name: "_conditionId",
+  },
+  {
+    type: "address",
+    name: "_claimer",
+  },
+  {
+    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",
+      },
+    ],
+  },
+] as const;
+const FN_OUTPUTS = [
+  {
+    type: "bool",
+    name: "isOverride",
+  },
+] as const;
+
+/**
+ * Checks if the `verifyClaim` 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 `verifyClaim` method is supported.
+ * @extension ERC20
+ * @example
+ * ```ts
+ * import { isVerifyClaimSupported } from "thirdweb/extensions/erc20";
+ * const supported = isVerifyClaimSupported(["0x..."]);
+ * ```
+ */
+export function isVerifyClaimSupported(availableSelectors: string[]) {
+  return detectMethod({
+    availableSelectors,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+  });
+}
+
+/**
+ * Encodes the parameters for the "verifyClaim" function.
+ * @param options - The options for the verifyClaim function.
+ * @returns The encoded ABI parameters.
+ * @extension ERC20
+ * @example
+ * ```ts
+ * import { encodeVerifyClaimParams } from "thirdweb/extensions/erc20";
+ * const result = encodeVerifyClaimParams({
+ *  conditionId: ...,
+ *  claimer: ...,
+ *  quantity: ...,
+ *  currency: ...,
+ *  pricePerToken: ...,
+ *  allowlistProof: ...,
+ * });
+ * ```
+ */
+export function encodeVerifyClaimParams(options: VerifyClaimParams) {
+  return encodeAbiParameters(FN_INPUTS, [
+    options.conditionId,
+    options.claimer,
+    options.quantity,
+    options.currency,
+    options.pricePerToken,
+    options.allowlistProof,
+  ]);
+}
+
+/**
+ * Encodes the "verifyClaim" function into a Hex string with its parameters.
+ * @param options - The options for the verifyClaim function.
+ * @returns The encoded hexadecimal string.
+ * @extension ERC20
+ * @example
+ * ```ts
+ * import { encodeVerifyClaim } from "thirdweb/extensions/erc20";
+ * const result = encodeVerifyClaim({
+ *  conditionId: ...,
+ *  claimer: ...,
+ *  quantity: ...,
+ *  currency: ...,
+ *  pricePerToken: ...,
+ *  allowlistProof: ...,
+ * });
+ * ```
+ */
+export function encodeVerifyClaim(options: VerifyClaimParams) {
+  // 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 +
+    encodeVerifyClaimParams(options).slice(
+      2,
+    )) as `${typeof FN_SELECTOR}${string}`;
+}
+
+/**
+ * Decodes the result of the verifyClaim function call.
+ * @param result - The hexadecimal result to decode.
+ * @returns The decoded result as per the FN_OUTPUTS definition.
+ * @extension ERC20
+ * @example
+ * ```ts
+ * import { decodeVerifyClaimResult } from "thirdweb/extensions/erc20";
+ * const result = decodeVerifyClaimResultResult("...");
+ * ```
+ */
+export function decodeVerifyClaimResult(result: Hex) {
+  return decodeAbiParameters(FN_OUTPUTS, result)[0];
+}
+
+/**
+ * Calls the "verifyClaim" function on the contract.
+ * @param options - The options for the verifyClaim function.
+ * @returns The parsed result of the function call.
+ * @extension ERC20
+ * @example
+ * ```ts
+ * import { verifyClaim } from "thirdweb/extensions/erc20";
+ *
+ * const result = await verifyClaim({
+ *  contract,
+ *  conditionId: ...,
+ *  claimer: ...,
+ *  quantity: ...,
+ *  currency: ...,
+ *  pricePerToken: ...,
+ *  allowlistProof: ...,
+ * });
+ *
+ * ```
+ */
+export async function verifyClaim(
+  options: BaseTransactionOptions<VerifyClaimParams>,
+) {
+  return readContract({
+    contract: options.contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+    params: [
+      options.conditionId,
+      options.claimer,
+      options.quantity,
+      options.currency,
+      options.pricePerToken,
+      options.allowlistProof,
+    ],
+  });
+}

package/src/extensions/erc20/drop20.test.ts

@@ -14,6 +14,7 @@ import { resolvePromisedValue } from "../../utils/promise/resolve-promised-value
 import { toEther } from "../../utils/units.js";
 import { name } from "../common/read/name.js";
 import { deployERC20Contract } from "../prebuilts/deploy-erc20.js";
+import { canClaim } from "./drops/read/canClaim.js";
 import { getClaimConditions } from "./drops/read/getClaimConditions.js";
 import { claimTo } from "./drops/write/claimTo.js";
 import { resetClaimEligibility } from "./drops/write/resetClaimEligibility.js";
@@ -76,6 +77,18 @@ describe.runIf(process.env.TW_SECRET_KEY)(
         }),
         account: TEST_ACCOUNT_A,
       });
+
+      expect(
+        await canClaim({
+          contract,
+          claimer: TEST_ACCOUNT_A.address,
+          quantity: "1",
+        }),
+      ).toMatchInlineSnapshot(`
+        {
+          "result": true,
+        }
+      `);
       const claimTx = claimTo({
         contract,
         to: TEST_ACCOUNT_A.address,
@@ -180,6 +193,31 @@ describe.runIf(process.env.TW_SECRET_KEY)(
           }
         `);
 
+        expect(
+          await canClaim({
+            contract,
+            claimer: TEST_ACCOUNT_A.address,
+            quantity: "1",
+          }),
+        ).toMatchInlineSnapshot(`
+          {
+            "result": true,
+          }
+        `);
+
+        expect(
+          await canClaim({
+            contract,
+            claimer: TEST_ACCOUNT_B.address,
+            quantity: "1",
+          }),
+        ).toMatchInlineSnapshot(`
+          {
+            "reason": "DropClaimExceedLimit - 0,1000000000000000000",
+            "result": false,
+          }
+        `);
+
         await sendAndConfirmTransaction({
           account: TEST_ACCOUNT_A,
           transaction: claimTo({