thirdweb 5.64.4-nightly-c2a90542d7f870c799c297c59cd2b468816f7939-20241031000332 → 5.64.4

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

@@ -0,0 +1,80 @@
+import { fetchDeployMetadata } from "../../utils/any-evm/deploy-metadata.js";
+
+import { beforeAll, describe, expect, it } from "vitest";
+import { ANVIL_CHAIN } from "../../../test/src/chains.js";
+import { TEST_CLIENT } from "../../../test/src/test-clients.js";
+import { 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 { toWei } from "../../utils/units.js";
+import { deployContractfromDeployMetadata } from "../prebuilts/deploy-published.js";
+import { balanceOf } from "./__generated__/IERC20/read/balanceOf.js";
+import { claimTo } from "./drops/write/claimTo.js";
+import { setClaimConditions } from "./drops/write/setClaimConditions.js";
+
+describe.runIf(process.env.TW_SECRET_KEY)(
+  "CustomDropERC20",
+  {
+    retry: 0,
+  },
+  () => {
+    let contract: ThirdwebContract;
+
+    beforeAll(async () => {
+      const customDropDeployMetadata = await fetchDeployMetadata({
+        client: TEST_CLIENT,
+        uri: "ipfs://QmT6h6gZztc2G83gWkJBkNFeq1b9gKrFKnYwgagXMBHV1d",
+      });
+      const contractAddress = await deployContractfromDeployMetadata({
+        chain: ANVIL_CHAIN,
+        client: TEST_CLIENT,
+        account: TEST_ACCOUNT_C,
+        deployMetadata: customDropDeployMetadata,
+        initializeParams: {
+          defaultAdmin: TEST_ACCOUNT_C.address,
+          name: "TestCustomDropERC20",
+          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 to claim tokens", async () => {
+      await expect(
+        balanceOf({ contract, address: TEST_ACCOUNT_C.address }),
+      ).resolves.toBe(0n);
+      await sendAndConfirmTransaction({
+        transaction: setClaimConditions({
+          contract,
+          phases: [
+            {
+              startTime: new Date(0),
+              maxClaimableSupply: toWei("10"),
+            },
+          ],
+          singlePhaseDrop: true,
+        }),
+        account: TEST_ACCOUNT_C,
+      });
+      const claimTx = claimTo({
+        contract,
+        to: TEST_ACCOUNT_C.address,
+        quantity: "1",
+        singlePhaseDrop: true,
+      });
+      await sendAndConfirmTransaction({
+        transaction: claimTx,
+        account: TEST_ACCOUNT_C,
+      });
+      await expect(
+        balanceOf({ contract, address: TEST_ACCOUNT_C.address }),
+      ).resolves.toBe(toWei("1"));
+    });
+  },
+);

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

@@ -13,6 +13,7 @@ import { isGetActiveClaimConditionSupported } from "../read/getActiveClaimCondit
 export type ClaimToParams = {
   to: Address;
   from?: Address;
+  singlePhaseDrop?: boolean;
 } & ({ quantityInWei: bigint } | { quantity: string });
 
 /**
@@ -71,6 +72,7 @@ export function claimTo(options: BaseTransactionOptions<ClaimToParams>) {
         quantity,
         from: options.from,
         tokenDecimals: await decimals({ contract: options.contract }),
+        singlePhaseDrop: options.singlePhaseDrop,
       });
     },
   });

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

@@ -16,6 +16,7 @@ import { decimals, isDecimalsSupported } from "../../read/decimals.js";
 export type SetClaimConditionsParams = {
   phases: ClaimConditionsInput[];
   resetClaimEligibility?: boolean;
+  singlePhaseDrop?: boolean;
 };
 
 /**
@@ -56,6 +57,7 @@ export function setClaimConditions(
           phases: options.phases,
           resetClaimEligibility: options.resetClaimEligibility,
           tokenDecimals: await decimals({ contract: options.contract }),
+          singlePhase: options.singlePhaseDrop,
         }),
       };
     },

package/src/extensions/erc721/__generated__/IDropSinglePhase/events/ClaimConditionUpdated.ts

@@ -0,0 +1,25 @@
+import { prepareEvent } from "../../../../../event/prepare-event.js";
+
+/**
+ * Creates an event object for the ClaimConditionUpdated event.
+ * @returns The prepared event object.
+ * @extension ERC721
+ * @example
+ * ```ts
+ * import { getContractEvents } from "thirdweb";
+ * import { claimConditionUpdatedEvent } from "thirdweb/extensions/erc721";
+ *
+ * const events = await getContractEvents({
+ * contract,
+ * events: [
+ *  claimConditionUpdatedEvent()
+ * ],
+ * });
+ * ```
+ */
+export function claimConditionUpdatedEvent() {
+  return prepareEvent({
+    signature:
+      "event ClaimConditionUpdated((uint256 startTimestamp, uint256 maxClaimableSupply, uint256 supplyClaimed, uint256 quantityLimitPerWallet, bytes32 merkleRoot, uint256 pricePerToken, address currency, string metadata) condition, bool resetEligibility)",
+  });
+}

package/src/extensions/erc721/__generated__/IDropSinglePhase/events/TokensClaimed.ts

@@ -0,0 +1,53 @@
+import { prepareEvent } from "../../../../../event/prepare-event.js";
+import type { AbiParameterToPrimitiveType } from "abitype";
+
+/**
+ * Represents the filters for the "TokensClaimed" event.
+ */
+export type TokensClaimedEventFilters = Partial<{
+  claimer: AbiParameterToPrimitiveType<{
+    type: "address";
+    name: "claimer";
+    indexed: true;
+  }>;
+  receiver: AbiParameterToPrimitiveType<{
+    type: "address";
+    name: "receiver";
+    indexed: true;
+  }>;
+  startTokenId: AbiParameterToPrimitiveType<{
+    type: "uint256";
+    name: "startTokenId";
+    indexed: true;
+  }>;
+}>;
+
+/**
+ * Creates an event object for the TokensClaimed event.
+ * @param filters - Optional filters to apply to the event.
+ * @returns The prepared event object.
+ * @extension ERC721
+ * @example
+ * ```ts
+ * import { getContractEvents } from "thirdweb";
+ * import { tokensClaimedEvent } from "thirdweb/extensions/erc721";
+ *
+ * const events = await getContractEvents({
+ * contract,
+ * events: [
+ *  tokensClaimedEvent({
+ *  claimer: ...,
+ *  receiver: ...,
+ *  startTokenId: ...,
+ * })
+ * ],
+ * });
+ * ```
+ */
+export function tokensClaimedEvent(filters: TokensClaimedEventFilters = {}) {
+  return prepareEvent({
+    signature:
+      "event TokensClaimed(address indexed claimer, address indexed receiver, uint256 indexed startTokenId, uint256 quantityClaimed)",
+    filters,
+  });
+}

package/src/extensions/erc721/__generated__/IDropSinglePhase/read/claimCondition.ts

@@ -0,0 +1,105 @@
+import { readContract } from "../../../../../transaction/read-contract.js";
+import type { BaseTransactionOptions } from "../../../../../transaction/types.js";
+
+import { decodeAbiParameters } from "viem";
+import type { Hex } from "../../../../../utils/encoding/hex.js";
+import { detectMethod } from "../../../../../utils/bytecode/detectExtension.js";
+
+export const FN_SELECTOR = "0xd637ed59" as const;
+const FN_INPUTS = [] as const;
+const FN_OUTPUTS = [
+  {
+    type: "tuple",
+    name: "condition",
+    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",
+      },
+    ],
+  },
+] as const;
+
+/**
+ * Checks if the `claimCondition` 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 `claimCondition` method is supported.
+ * @extension ERC721
+ * @example
+ * ```ts
+ * import { isClaimConditionSupported } from "thirdweb/extensions/erc721";
+ * const supported = isClaimConditionSupported(["0x..."]);
+ * ```
+ */
+export function isClaimConditionSupported(availableSelectors: string[]) {
+  return detectMethod({
+    availableSelectors,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+  });
+}
+
+/**
+ * Decodes the result of the claimCondition function call.
+ * @param result - The hexadecimal result to decode.
+ * @returns The decoded result as per the FN_OUTPUTS definition.
+ * @extension ERC721
+ * @example
+ * ```ts
+ * import { decodeClaimConditionResult } from "thirdweb/extensions/erc721";
+ * const result = decodeClaimConditionResultResult("...");
+ * ```
+ */
+export function decodeClaimConditionResult(result: Hex) {
+  return decodeAbiParameters(FN_OUTPUTS, result)[0];
+}
+
+/**
+ * Calls the "claimCondition" function on the contract.
+ * @param options - The options for the claimCondition function.
+ * @returns The parsed result of the function call.
+ * @extension ERC721
+ * @example
+ * ```ts
+ * import { claimCondition } from "thirdweb/extensions/erc721";
+ *
+ * const result = await claimCondition({
+ *  contract,
+ * });
+ *
+ * ```
+ */
+export async function claimCondition(options: BaseTransactionOptions) {
+  return readContract({
+    contract: options.contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+    params: [],
+  });
+}

package/src/extensions/erc721/__generated__/IDropSinglePhase/write/claim.ts

@@ -0,0 +1,219 @@
+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" }>;
+  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 = "0x84bb1e42" as const;
+const FN_INPUTS = [
+  {
+    type: "address",
+    name: "receiver",
+  },
+  {
+    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 ERC721
+ * @example
+ * ```ts
+ * import { isClaimSupported } from "thirdweb/extensions/erc721";
+ *
+ * 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 ERC721
+ * @example
+ * ```ts
+ * import { encodeClaimParams } from "thirdweb/extensions/erc721";
+ * const result = encodeClaimParams({
+ *  receiver: ...,
+ *  quantity: ...,
+ *  currency: ...,
+ *  pricePerToken: ...,
+ *  allowlistProof: ...,
+ *  data: ...,
+ * });
+ * ```
+ */
+export function encodeClaimParams(options: ClaimParams) {
+  return encodeAbiParameters(FN_INPUTS, [
+    options.receiver,
+    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 ERC721
+ * @example
+ * ```ts
+ * import { encodeClaim } from "thirdweb/extensions/erc721";
+ * const result = encodeClaim({
+ *  receiver: ...,
+ *  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 ERC721
+ * @example
+ * ```ts
+ * import { sendTransaction } from "thirdweb";
+ * import { claim } from "thirdweb/extensions/erc721";
+ *
+ * const transaction = claim({
+ *  contract,
+ *  receiver: ...,
+ *  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.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,
+  });
+}