Skip to main content
Faremeter API
Faremeter API / payment-evm/src / erc20

erc20

Interfaces

GetTokenBalanceArgs

Defined in: packages/payment-evm/src/erc20.ts:7 Arguments for retrieving an ERC-20 token balance.

Properties

account
account: `0x${string}`
Defined in: packages/payment-evm/src/erc20.ts:9 The wallet address to check the balance for
asset
asset: `0x${string}`
Defined in: packages/payment-evm/src/erc20.ts:11 The ERC-20 token contract address
client
client: object
Defined in: packages/payment-evm/src/erc20.ts:13 Viem public client for querying the chain

Functions

getTokenBalance()

getTokenBalance(args): Promise<{ amount: bigint; decimals: number; }>
Defined in: packages/payment-evm/src/erc20.ts:25 Retrieves the ERC-20 token balance and decimals for an account. Uses multicall to fetch both values in a single RPC request.

Parameters

args
GetTokenBalanceArgs The account, asset, and client configuration

Returns

Promise<{ amount: bigint; decimals: number; }> The balance amount and token decimals

Throws

Error if the balance query fails