Class BalanceApi

Hierarchy

BaseApi
- BalanceApi

Index

Constructors

constructor

Properties

api

Methods

Constructors

constructor

new BalanceApi(api: DCoreApi): BalanceApi

Overrides BaseApi.constructor
- Defined in api/rx/BalanceApi.ts:15
Parameters
- api: DCoreApi
Returns BalanceApi

Properties

Protected api

Methods

Private createTuple

createTuple(assets: Asset[], balances: AssetAmount[]): AssetWithAmount[]

- Defined in api/rx/BalanceApi.ts:90
Parameters
- assets: Asset[]
- balances: AssetAmount[]
Returns AssetWithAmount[]

get

get(account: AccountRef, asset: ChainObject): Observable<AssetAmount>

- Defined in api/rx/BalanceApi.ts:29
Get account balance.

Parameters
- account: AccountRef
  
  account name or account object id, 1.2.*
- asset: ChainObject
  
  object id of the assets, 1.3.*
Returns Observable<AssetAmount>

amount for asset

getAll

getAll(account: AccountRef, assets?: ChainObject[]): Observable<AssetAmount[]>

- Defined in api/rx/BalanceApi.ts:41
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 Observable<AssetAmount[]>

list of amounts for different assets

getAllVesting

getAllVesting(accountId: ChainObject): Observable<VestingBalance[]>

- Defined in api/rx/BalanceApi.ts:86
Get information about a vesting balance object.

Parameters
- accountId: ChainObject
  
  id of the account
Returns Observable<VestingBalance[]>

a list of vesting balances with additional information

getAllWithAsset

getAllWithAsset(account: AccountRef, assetSymbols?: string[]): Observable<AssetWithAmount[]>

- Defined in api/rx/BalanceApi.ts:65
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 Observable<AssetWithAmount[]>

a list of pairs of assets to amounts

Private getBalanceInternal

getBalanceInternal(account: AccountRef, assets?: ChainObject[]): Observable<AssetAmount[]>

- Defined in api/rx/BalanceApi.ts:94
Parameters
- account: AccountRef
- Optional assets: ChainObject[]
Returns Observable<AssetAmount[]>

getWithAsset

getWithAsset(account: AccountRef, assetSymbol?: string): Observable<AssetWithAmount>

- Defined in api/rx/BalanceApi.ts:53
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 Observable<AssetWithAmount>

a pair of asset to amount

Protected request

request<T>(request: BaseRequest<T> | BaseRequest<T> & WithCallback): Observable<T>

Inherited from BaseApi.request
- Defined in api/rx/BaseApi.ts:12
Type parameters
- T
Parameters
- request: BaseRequest<T> | BaseRequest<T> & WithCallback
Returns Observable<T>

Generated using TypeDoc