Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BankAPI

Hierarchy

  • BaseAPI
    • BankAPI

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

lcd

lcd: LCDClient

Methods

balance

  • balance(address: string, params?: Partial<PaginationOptions & APIParams>): Promise<[Coins, Pagination]>

  • Look up the balance of an account by its address.

    Parameters

    • address: string

      address of account to look up.

    • params: Partial<PaginationOptions & APIParams> = {}

    Returns Promise<[Coins, Pagination]>

getReqFromAddress

  • getReqFromAddress(address: string): APIRequester

getReqFromChainID

  • getReqFromChainID(chainID: string): APIRequester

params

  • params(chainID: string, params?: APIParams): Promise<BankParams>

spendableBalances

  • spendableBalances(address: string, params?: Partial<PaginationOptions & APIParams>): Promise<[Coins, Pagination]>

  • Lqueries the spenable balance of all coins for a single account.

    Parameters

    • address: string

      address of account to look up.

    • params: Partial<PaginationOptions & APIParams> = {}

    Returns Promise<[Coins, Pagination]>

supplyByDenom

  • supplyByDenom(chainID: string, denom: string): Promise<Coin>

  • Get the total supply of tokens in circulation for all denom.

    Parameters

    • chainID: string

      chain id

    • denom: string

      denom of the coin

    Returns Promise<Coin>

total

  • total(chainID: string, params?: Partial<PaginationOptions & APIParams>): Promise<[Coins, Pagination]>

  • Get the total supply of tokens in circulation for all denominations.

    Parameters

    • chainID: string

      chain id

    • params: Partial<PaginationOptions & APIParams> = {}

    Returns Promise<[Coins, Pagination]>