Skip to content

fee.getUserToken

Gets the user's default fee token preference. Learn more about fees

Usage

example.ts
import { client } from './viem.config'
 
const { address, id } = await client.fee.getUserToken({
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
})
 
console.log('Fee token address:', address)
Fee token address: 0x20c0000000000000000000000000000000000000
console.log('Fee token ID:', id)
Fee token ID: 0n

Return Type

type ReturnType = {
  /** Address of the fee token */
  address: Address
  /** ID of the fee token */
  id: bigint
} | null

Returns null if the user has not set a default fee token.

Parameters

account

  • Type: Address

Account address.

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.