FT4 Library/lib.ft4.core.assets.locking/get_locked_asset_balance

get_locked_asset_balance

function get_locked_asset_balance(account: account, asset: asset, types: list<text>?, page_size: integer?, page_cursor: text?): list<pagination_result>(source)

Retrieves all balances of a certain asset that were locked from a certain account. Paginated, the returned data is a list of tuples containing the amount and a lock type label: list<(lock type, amount)>

Return

pagination result, where the data is a list of tuples: list<(text, amount)>

Parameters

account

account that locked their assets

asset

the asset that was locked

types

optional list to specify what lock account types to include balances for. If not specified, balances will be fetched for all lock account types.

page_size

the size of the pages to retrieve

page_cursor

a pointer to where the page should start

See also

utils.paged_result

for information about pagination

ACCOUNT_TYPE_LOCK

for more information on lock accounts

get_locked_asset_aggregated_balance

for a function that reports the sum of all these values

get_locked_asset_balances

for a function that reports these values for all assets.