useTotalCirculatingSupply

Hook for fetching the total number of NFTs in circulation for a given smart contract.

This takes into account the increase in supply due to minting and the decrease in supply due to burning.

Available to use on contracts that implement either the ERC721 or ERC1155 standard.

Example


import {
  useTotalCirculatingSupply,
  useContract,
} from "@thirdweb-dev/react";
 
function App() {
  const { contract } = useContract(contractAddress);
  const { data, isLoading, error } =
    useTotalCirculatingSupply(contract);
}

Parameters

Returns

A BigNumber representing the total circulating supply.