TokenOps
ReaduseQuery

useInferredTotalSupply

Read the wrapper's inferred total supply: underlying held in custody divided by rate, an upper bound on the confidential total supply, in CTTT 6-decimal units.

Import
@tokenops/sdk/testnet-faucet/react
Return
{ data, isLoading, error, refetch }
Lifecycle
Read

Query Key

Faucet read hooks use the public constants TESTNET_FAUCET_KEY and TESTNET_FAUCET_NAMESPACE. The method segment for this hook is inferredTotalSupply.

@tokenops/sdk/testnet-faucet/react
ts
queryKey: [
  "tokenops-sdk", // TESTNET_FAUCET_KEY
  "testnet-faucet", // TESTNET_FAUCET_NAMESPACE
  "inferredTotalSupply",
  chainId ?? null,
  address ? address.toLowerCase() : null,
  // hook-specific args normalized: bigint -> decimal string, 0x strings -> lowercase
];

Description

Read the wrapper's inferred total supply: underlying held in custody divided by rate, an upper bound on the confidential total supply, in CTTT 6-decimal units.

Signature

@tokenops/sdk/testnet-faucet/react
ts
function useInferredTotalSupply(options?: BaseHookOptions): UseQueryResult<bigint, Error>;
Want to run a similar shape interactively? The Playground ships 8 ready presets across vesting / airdrop / disperse — deploy a manager, create a vesting, claim, and the airdrop / disperse equivalents. The deep-link above auto-selects the closest preset to useInferredTotalSupply; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/testnet-faucet/react · @example
tsx
const { data: supply } = useInferredTotalSupply();

Pulled directly from the hook's TSDoc block — the same snippet your IDE shows on hover.

See also

Other Read hooks in testnet faucet: