Skip to main content

useTokenSupply() function​

Get the total circulating supply of a token

Example​

import { useProgram, useMintToken } from "@thirdweb-dev/react/solana";

export default function Component() {
  const { program } = useProgram("{{program_address}}");
  const { data: totalSupply, isLoading } = useTokenSupply(program);

  return <p>{totalSupply}</p>;
}

Signature:

export declare function useTokenSupply(
  program: RequiredParam<Token>,
): import("@tanstack/react-query").UseQueryResult<
  {
    value: string;
    displayValue: string;
  },
  unknown
>;

Parameters​

ParameterTypeDescription
programRequiredParam<Token>The token program to get the supply of

Returns:

import("@tanstack/react-query").UseQueryResult<{ value: string; displayValue: string; }, unknown>