Skip to main content

useClaimConditions() function​

This feature is currently in beta and may change based on feedback that we receive.

Use this to get all claim conditons for ERC20, ERC721 or ERC1155 based contracts. They need to extend the claimCondition extension for this hook to work.

Example 1​

const { data: claimConditions, isLoading, error } = useClaimConditions(<YourERC20ContractInstance>);

Example 2​

const { data: claimConditions, isLoading, error } = useClaimConditions(<YourERC721ContractInstance>);

Example 3​

const { data: claimConditions, isLoading, error } = useClaimConditions(<YourERC1155ContractInstance>, <tokenId>);

Signature:

export declare function useClaimConditions<TContract extends NFTContract>(
  ...[contract, tokenId]: ClaimConditionsInputParams<TContract>
): import("@tanstack/react-query").UseQueryResult<
  {
    snapshot?:
      | {
          address: string;
          maxClaimable: string;
        }[]
      | undefined;
    quantityLimitPerTransaction: string;
    startTime: Date;
    price: import("ethers").BigNumber;
    currencyAddress: string;
    maxQuantity: string;
    waitInSeconds: import("ethers").BigNumber;
    merkleRootHash: string | number[];
    availableSupply: string;
    currentMintSupply: string;
    currencyMetadata: {
      symbol: string;
      value: import("ethers").BigNumber;
      name: string;
      decimals: number;
      displayValue: string;
    };
  }[],
  unknown
>;

Parameters​

ParameterTypeDescription
[contract, tokenId]ClaimConditionsInputParams<TContract>

Returns:

import("@tanstack/react-query").UseQueryResult<{ snapshot?: { address: string; maxClaimable: string; }[] | undefined; quantityLimitPerTransaction: string; startTime: Date; price: import("ethers").BigNumber; currencyAddress: string; maxQuantity: string; waitInSeconds: import("ethers").BigNumber; merkleRootHash: string | number[]; availableSupply: string; currentMintSupply: string; currencyMetadata: { symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; }; }[], unknown>

a response object with the list of claim conditions