Skip to main content

useTotalCirculatingSupply() function​

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

Use this to get a the total (minted) supply of your NFTContract.

*

Example 1​

const nftDrop = useNFTDrop(<ContractAddress>);
const { data: totalSupply, isLoading, error } = useNFTSupply(nftDrop);

Example 2​

const { contract } = useContract(<ContractAddress>);
const { data: totalSupply, isLoading, error } = useNFTSupply(contract?.nft);

Signature:

export declare function useTotalCirculatingSupply<
  TContract extends NFTContract,
>(
  ...[contract, tokenId]: useTotalCirculatingSupplyParams<TContract>
): import("@tanstack/react-query").UseQueryResult<BigNumber, unknown>;

Parameters​

ParameterTypeDescription
[contract, tokenId]useTotalCirculatingSupplyParams<TContract>

Returns:

import("@tanstack/react-query").UseQueryResult<BigNumber, unknown>

a response object that incudes the total minted supply