thirdwebDocs
GitHub

useUnclaimedNFTSupply

Defined in

Hook for fetching the number of unclaimed NFTs from an NFT/Edition Drop contract.

Unclaimed NFTs are tokens that were lazy-minted but have not yet been claimed by a user.

Available to use on contracts that implement the LazyMint extension; such as the NFT Drop contract.

Example

import {
  useUnclaimedNFTSupply,
  useContract,
} from "@thirdweb-dev/react";
 
function App() {
  const { contract } = useContract(contractAddress, "nftDrop");
  const { data, isLoading, error } = useUnclaimedNFTSupply(contract);
}
function useUnclaimedNFTSupply(
  contract: RequiredParam<
    null | NFTDrop | SignatureDrop | SmartContract<BaseContract>
  >,
): UseQueryResult<BigNumber, unknown>;

Parameters

Instance of a contract that extends the ERC721 spec (NFT drop, Signature Drop, or any custom contract that extends the ERC721 spec)

Type

let contract: RequiredParam<
  null | NFTDrop | SignatureDrop | SmartContract<BaseContract>
>;

Returns

let returnType: UseQueryResult<BigNumber, unknown>;

The hook's data property, once loaded, contains a BigNumber representing the number of unclaimed NFTs.