Skip to content

token.getBalance

Gets the token balance of an address.

Usage

ts
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const balance = await Actions.token.getBalance(config, {
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Balance:', balance)
// @log: Balance: 10500000n
ts
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

Return Type

ts
type ReturnType = bigint // Balance amount

Parameters

account

  • Type: Address

Account address.

token

  • Type: Address | bigint

Address or ID of the TIP20 token.

Viem

Released under the MIT License.