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

const { contract } = useContract(<ContractAddress>);
const { data: totalCirculatingSupply, isLoading, error } = useTotalCirculatingSupply(contract);

Signature:

export declare function useTotalCirculatingSupply(
contract: RequiredParam<NFTContract>,
tokenId: RequiredParam<BigNumberish>,
): import("@tanstack/react-query").UseQueryResult<BigNumber, unknown>;

Parameters

ParameterTypeDescription
contractRequiredParam<NFTContract>an instance of a NFTContract
tokenIdRequiredParam<BigNumberish>

Returns:

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

a response object that incudes the total minted supply