Class TokenBalanceAPI

TokenBalanceAPI provides methods for retrieving token balances and rich token balance data for Cosmos chains.

Constructors

constructor

Properties

COSMWASM_CLIENTS

Methods

getBalances getCw20Balances getRichBalances

Constructors

constructor

Properties

Static COSMWASM_CLIENTS

COSMWASM_CLIENTS: Record<string, CosmWasmClient> = {}

Fetches the token balances for a given address on a specific chain.

Param: address

The blockchain address.

Param: chains

An array of CosmosChainData objects.

Returns

A Promise resolving to an array of token amounts ([]).

Throws

An error if the chain is not supported or if there's a failure in fetching balances.

Methods

Static getBalances

  • getBalances(address, chainId, chains, isTestnet?): Promise<Amount[]>

  • Parameters

    • address: string
    • chainId: string
    • chains: CosmosChainData[]
    • Optional isTestnet: boolean

    Returns Promise<Amount[]>

Static getCw20Balances

Static getRichBalances

  • getRichBalances(address, chainId, denoms, chains, cw20Tokens?, isTestnet?): Promise<ChainBalanceData>

  • Fetches rich token balances which includes detailed token information along with the balance.

    Parameters

    • address: string

      The blockchain address.

    • chainId: string
    • denoms: Record<string, DenomData>

      A record of denom data indexed by denom strings.

    • chains: CosmosChainData[]

      An array of CosmosChainData objects.

    • cw20Tokens: SkipSupportedAsset[] = []
    • Optional isTestnet: boolean

    Returns Promise<ChainBalanceData>

    A Promise resolving to a ChainBalanceData object containing rich balance data (ChainBalanceData).

    Throws

    An error if the chain is not supported or if there's a failure in fetching rich balances.

Settings

Member Visibility

Theme

On This Page

constructorCOSMWASM_CLIENTSgetBalancesgetCw20BalancesgetRichBalances