TokenOps
ReaduseQuery

useFaucetMetadata

Read consolidated faucet metadata in a single hook — both tokens' name/symbol/decimals/address, the conversion rate, and the maxTotalSupply ceiling.

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 getMetadata.

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

Description

Read consolidated faucet metadata in a single hook — both tokens' name/symbol/decimals/address, the conversion rate, and the maxTotalSupply ceiling. Handy for rendering a faucet panel without composing several reads.

Signature

@tokenops/sdk/testnet-faucet/react
ts
function useFaucetMetadata(options?: BaseHookOptions): UseQueryResult<FaucetMetadata, 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 useFaucetMetadata; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/testnet-faucet/react · @example
tsx
const { data: meta } = useFaucetMetadata();
// meta?.confidential.symbol, meta?.underlying.decimals, meta?.rate, ...

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

See also

Other Read hooks in testnet faucet: