Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Bank

This module is mainly used to transfer coins between accounts, query account balances, and provide common offline transaction signing and broadcasting methods. In addition, the available units of tokens in the IRIShub system are defined using coin-type.

More Details

since

v0.17

Hierarchy

  • Bank

Index

Methods

multiSend

  • multiSend(to: string, amount: Coin[], baseTx: BaseTx): Promise<TxResult>
  • multiSend coins

    since

    v0.17

    Parameters

    • to: string

      Recipient bech32 address

    • amount: Coin[]

      Coins to be sent

    • baseTx: BaseTx

    Returns Promise<TxResult>

queryAllBalances

  • queryAllBalances(address: string): Promise<object>
  • AllBalances queries the balance of all coins for a single account.

    Parameters

    • address: string

      is the address to query balances for.

    Returns Promise<object>

queryBalance

  • queryBalance(address: string, denom: string): Promise<object>
  • Balance queries the balance of a single coin for a single account.

    Parameters

    • address: string

      is the address to query balances for.

    • denom: string

      is the coin denom to query balances for.

    Returns Promise<object>

queryParams

  • queryParams(): Promise<object>
  • Params queries the parameters of x/bank module.

    Returns Promise<object>

querySupplyOf

  • querySupplyOf(denom: string): Promise<object>
  • SupplyOf queries the supply of a single coin.

    Parameters

    • denom: string

      is the coin denom to query balances for.

    Returns Promise<object>

queryTotalSupply

  • queryTotalSupply(): Promise<object>
  • TotalSupply queries the total supply of all coins.

    Returns Promise<object>

send

  • Send coins

    since

    v0.17

    Parameters

    • to: string

      Recipient bech32 address

    • amount: Coin[]

      Coins to be sent

    • baseTx: BaseTx

    Returns Promise<TxResult>

Generated using TypeDoc