BalanceApi Protocol Reference


                    
                    
                    get(byAccountId:asset:)

Default implementation

Get account balance by account id.

Throws

DCoreException.Network.notFound if account does not exist.

Default Implementation

Declaration

Swift

func get(byAccountId id: AccountObjectIdConvertible, asset: AssetObjectIdConvertible) -> Single<AssetAmount>

Parameters

`id`	Account id, eg. 1.2.*, as `AccountObjectId` or `String` format.
`asset`	Asset id, eg. 1.3.*, as `AssetObjectId` or `String` format.

Return Value

Amount for asset.

Show on GitHub


                    
                    
                    getAll(byAccountId:assets:)

Default implementation

Get all account balances by account id.

Default Implementation

Declaration

Swift

func getAll(byAccountId id: AccountObjectIdConvertible, assets: [AssetObjectIdConvertible]) -> Single<[AssetAmount]>

Parameters

`id`	Account id, eg. 1.2.*, as `AccountObjectId` or `String` format.
`assets`	Asset ids, eg. 1.3.*, as `AssetObjectId` or `String` format, default `[]` - all.

Return Value

Array [AssetAmount] of amount for different assets.

Show on GitHub


                    
                    
                    get(byReference:asset:)

Default implementation

Get account balance by account reference (name or id).

Throws

DCoreException.Network.notFound if account does not exist.

Default Implementation

Declaration

Swift

func get(byReference ref: Account.Reference, asset: AssetObjectIdConvertible) -> Single<AssetAmount>

Parameters

`id`	Account id, eg. 1.2.*.
`asset`	Asset id, eg. 1.3.*, as `AssetObjectId` or `String` format

Return Value

Array [AssetAmount] of amount for different assets.

Show on GitHub


                    
                    
                    getAll(byReference:assets:)

Default implementation

Get all account balances by account reference (name or id).

Default Implementation

Declaration

Swift

func getAll(byReference ref: Account.Reference, assets: [AssetObjectIdConvertible]) -> Single<[AssetAmount]>

Parameters

`id`	Account id, eg. 1.2.*.
`assets`	Asset ids, eg. 1.3.*, as `AssetObjectId` or `String` format, default `[]` - all.

Return Value

Array [AssetAmount] of amount for different assets.

Show on GitHub


                    
                    
                    getWithAsset(byAccountId:symbol:)

Default implementation

Get account balance with asset by account id and symbol.

Throws

DCoreException.Network.notFound if account does not exist.

Default Implementation

Declaration

Swift

func getWithAsset(byAccountId id: AccountObjectIdConvertible, symbol: Asset.Symbol) -> Single<AssetAmountPair>

Parameters

`id`	Account id, eg. 1.2.*, as `AccountObjectId` or `String` format.
`symbol`	Asset symbol, default `Asset.Symbol.dct`.

Return Value

AssetAmountPair asset pair with amount.

Show on GitHub


                    
                    
                    getAllWithAsset(byAccountId:symbols:)

Default implementation

Get all account balances with asset by account id and symbols.

Default Implementation

Declaration

Swift

func getAllWithAsset(byAccountId id: AccountObjectIdConvertible, symbols: [Asset.Symbol]) -> Single<[AssetAmountPair]>

Parameters

`id`	Account id, eg. 1.2.*, as `AccountObjectId` or `String` format.
`symbols`	Asset symbols, eg. `[Asset.Symbol.dct]`.

Return Value

Array [AssetAmountPair] of asset pairs with amounts.

Show on GitHub


                    
                    
                    getAllWithAsset(byAccountId:)

Default implementation

Get all account balances with asset by account id.

Default Implementation

Declaration

Swift

func getAllWithAsset(byAccountId id: AccountObjectIdConvertible) -> Single<[AssetAmountPair]>

Parameters

`id`	Account id, eg. 1.2.*, as `AccountObjectId` or `String` format.

Return Value

Array [AssetAmountPair] of asset pairs with amounts.

Show on GitHub


                    
                    
                    getWithAsset(byReference:symbol:)

Default implementation

Get account balance with asset by account reference (id or name) and symbol.

Throws

DCoreException.Network.notFound if account does not exist.

Default Implementation

Declaration

Swift

func getWithAsset(byReference ref: Account.Reference, symbol: Asset.Symbol) -> Single<AssetAmountPair>

Parameters

`ref`	Account id or name in string format, eg. 1.2.*.
`symbol`	Asset symbol, default `Asset.Symbol.dct`.

Return Value

AssetAmountPair asset pair with amount.

Show on GitHub


                    
                    
                    getAllWithAsset(byReference:)

Default implementation

Get all account balances with asset by account reference (id or name).

Default Implementation

Declaration

Swift

func getAllWithAsset(byReference ref: Account.Reference) -> Single<[AssetAmountPair]>

Parameters

ref

Account id or name in string format, eg. 1.2.*.

Return Value

Array [AssetAmountPair] of asset pairs with amounts.

Show on GitHub


                    
                    
                    getAllWithAsset(byReference:symbols:)

Default implementation

Get all account balances with asset by account reference (id or name) and symbols.

Default Implementation

Declaration

Swift

func getAllWithAsset(byReference ref: Account.Reference, symbols: [Asset.Symbol]) -> Single<[AssetAmountPair]>

Parameters

`ref`	Account id or name in string format, eg. 1.2.*.
`symbols`	Asset symbols, eg. `[Asset.Symbol.dct]`.

Return Value

Array [AssetAmountPair] of asset pairs with amounts.

Show on GitHub


                    
                    
                    getAllVesting(byAccountId:)

Default implementation

Get information about vesting balances by account id.

Default Implementation

Declaration

Swift

func getAllVesting(byAccountId id: AccountObjectIdConvertible) -> Single<[VestingBalance]>

Parameters

`id`	Account id, eg. 1.2.*, as `AccountObjectId` or `String` format.

Return Value

Array [VestingBalance] vesting balances with additional information.

Show on GitHub