useTotalCirculatingSupply

Defined in react-core/src/evm/hooks/async/nft.ts#L188

Get total minted supply count

function useTotalCirculatingSupply(
  contract: RequiredParam<NFTContract>,
  tokenId?: RequiredParam<BigNumberish>,
): UseQueryResult<BigNumber, unknown>;

Parameters

Returns

a response object that includes the total minted supply

type ReturnType = UseQueryResult<BigNumber, unknown>;

Example

const { contract } = useContract("{{contract_address}}");
const {
  data: totalCirculatingSupply,
  isLoading,
  error,
} = useTotalCirculatingSupply(contract);