useActiveClaimConditionForWallet

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

Use this to check the claim condition for a given wallet address (including checking for overrides that may exist for that given wallet address).

Signature:

export declare function useActiveClaimConditionForWallet(contract: RequiredParam<DropContract>, walletAddress: RequiredParam<WalletAddress>, tokenId?: BigNumberish): import("@tanstack/react-query").UseQueryResult<{
    metadata?: {
        [x: string]: unknown;
        name?: string | undefined;
    } | undefined;
    snapshot?: {
        price?: string | undefined;
        currencyAddress?: string | undefined;
        address: string;
        maxClaimable: string;
    }[] | null | undefined;
    maxClaimableSupply: string;
    startTime: Date;
    price: import("ethers").BigNumber;
    currencyAddress: string;
    maxClaimablePerWallet: 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;
    };
} | null, unknown>;

Parameters

Parameter	Type	Description
contract	RequiredParam<DropContract>	an instance of a contract that extends the ERC20, ERC721 or ERC1155 spec and implements the `claimConditions` extension.
walletAddress	RequiredParam<WalletAddress>	the wallet address to check the active claim condition for
tokenId	BigNumberish	(Optional) the id of the token to fetch the claim conditions for (if the contract is an ERC1155 contract)

Returns:

import("@tanstack/react-query").UseQueryResult<{ metadata?: { [x: string]: unknown; name?: string | undefined; } | undefined; snapshot?: { price?: string | undefined; currencyAddress?: string | undefined; address: string; maxClaimable: string; }[] | null | undefined; maxClaimableSupply: string; startTime: Date; price: import("ethers").BigNumber; currencyAddress: string; maxClaimablePerWallet: 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; }; } | null, unknown>

the active claim conditon for the wallet address or null if there is no active claim condition

useActiveClaimConditionForWallet

Parameters​

Parameters