Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BalanceApi

Hierarchy

  • BalanceApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private api

api: DCoreApi

Methods

get

  • Get account balance.

    Parameters

    • account: AccountRef

      account name or account object id, 1.2.*

    • asset: ChainObject

      object id of the assets, 1.3.*

    Returns Promise<AssetAmount>

    amount for asset

getAll

  • Get account balances.

    Parameters

    • account: AccountRef

      account name or account object id, 1.2.*

    • Optional assets: ChainObject[]

      object ids of the assets, 1.3.*, or undefined to get all nonzero

    Returns Promise<AssetAmount[]>

    list of amounts for different assets

getAllVesting

  • Get information about a vesting balance object.

    Parameters

    Returns Promise<VestingBalance[]>

    a list of vesting balances with additional information

getAllWithAsset

  • Get account balance with asset.

    Parameters

    • account: AccountRef

      account name or account object id, 1.2.*

    • Optional assetSymbols: string[]

      asset symbols, eg. DCT, or undefined to get all nonzero

    Returns Promise<AssetWithAmount[]>

    a list of pairs of assets to amounts

getWithAsset

  • Get account balance with asset.

    Parameters

    • account: AccountRef

      account name or account object id, 1.2.*

    • Default value assetSymbol: string = DCoreConstants.DCT_ASSET_SYMBOL

      asset symbol, eg. DCT

    Returns Promise<AssetWithAmount>

    a pair of asset to amount

Generated using TypeDoc