token.getAllowance

Gets the amount of tokens that a spender is approved to transfer on behalf of an owner.

Usage

import { client } from './viem.config'
 
const allowance = await client.token.getAllowance({
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  spender: '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
  token: '0x20c0000000000000000000000000000000000000',
})
 
console.log('Allowance:', allowance)
Allowance: 10500000n

Return Type

type ReturnType = bigint // Allowance amount

Parameters

account

• Type: Address

Account address.

spender

• Type: Address

Address of the spender.

token

• Type: Address | bigint

Address or ID of the TIP20 token.

blockNumber (optional)

• Type: bigint

Block number to read the state from.

blockOverrides (optional)

• Type: BlockOverrides

Block overrides to apply to the state.

blockTag (optional)

• Type: BlockTag

Block tag to read the state from.

stateOverride (optional)

• Type: StateOverride

State override to apply.