ReaduseQuery

useUnderlyingBalance

Read the plaintext underlying TokenopsTestToken (TTT) balance for account (defaults to the connected wallet), in TTT 18-decimal base 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 underlyingBalanceOf.

@tokenops/sdk/testnet-faucet/react

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

Description

Read the plaintext underlying TokenopsTestToken (TTT) balance for account (defaults to the connected wallet), in TTT 18-decimal base units.

Signature

@tokenops/sdk/testnet-faucet/react

function useUnderlyingBalance(args?: UseUnderlyingBalanceArgs): UseQueryResult<bigint, Error>;

Parameters

Shape of the options object passed to the hook itself.

Property	Type	Description
account	Address	Account whose underlying TTT balance to read. Defaults to the connected wallet (`useAccount().address`). The hook stays disabled until an account is available.

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 useUnderlyingBalance; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/testnet-faucet/react · @example

tsx

const { data: balance } = useUnderlyingBalance(); // my own TTT balance

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