v2.0.0-rc.1 release candidate

The API is frozen and later candidates carry fixes only, except the receipt-free and Safe create surface of /fhe-airdrop, which is @beta. Published on the next dist-tag; latest stays on 1.6.0 until 2.0.0.

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

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

function useInferredTotalSupply(options?: BaseHookOptions & ReadHookQueryOptions<bigint>): UseQueryResult<bigint, Error>;

Want to run a similar shape interactively? The Playground ships 12 ready presets across vesting / airdrop / disperse / faucet — deploy a manager, create a vesting, claim, and run the product 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.

Query Key

Description

Signature

Example

See also