Skip to main content

useClaimConditions

Get the current claim conditions on an NFT Drop

Example​

import { useProgram, useClaimConditions } from "@thirdweb-dev/react/solana";

export default function Component() {
  const { program } = useProgram("{{program_address}}");
  const { data: claimConditions, isLoading } = useClaimConditions(program);

  return (
    <p>{claimConditions?.price.displayValue}</p>
  )
}

Signature:

export declare function useClaimConditions(program: RequiredParam<NFTDrop>): import("@tanstack/react-query").UseQueryResult<{
    primarySaleRecipient: string;
    startTime: Date | null;
    price: {
        value: string;
        displayValue: string;
    };
    currencyAddress: string | null;
    maxClaimable: string;
    sellerFeeBasisPoints: number;
    totalAvailableSupply: number;
    lazyMintedSupply: number;
    claimedSupply: number;
    isReadyToClaim: boolean;
}, unknown>;

Parameters​

ParameterTypeDescription
programRequiredParam<NFTDrop>The NFT Drop program to get the claim conditions for

Returns:

import("@tanstack/react-query").UseQueryResult<{ primarySaleRecipient: string; startTime: Date | null; price: { value: string; displayValue: string; }; currencyAddress: string | null; maxClaimable: string; sellerFeeBasisPoints: number; totalAvailableSupply: number; lazyMintedSupply: number; claimedSupply: number; isReadyToClaim: boolean; }, unknown>