Skip to main content
Version: 23.2.x

Class: FungibleSettlements

api/entities/Asset/Base/Settlements.FungibleSettlements

Handles all Asset Settlements related functionality

Hierarchy

Methods

canTransfer

canTransfer(args): Promise<TransferBreakdown>

Check whether it is possible to create a settlement instruction to transfer a certain amount of this asset between two Portfolios. Returns a breakdown of the transaction containing general errors (such as insufficient balance or invalid receiver), any broken transfer restrictions, and any compliance failures

Parameters

NameTypeDescription
argsObject-
args.amountBigNumberamount of tokens to transfer
args.from?PortfolioLikesender Portfolio (optional, defaults to the signing Identity's Default Portfolio)
args.toPortfolioLikereceiver Portfolio

Returns

Promise<TransferBreakdown>

Note

this takes locked tokens into account. For example, if portfolio A has 1000 tokens and this function is called to check if 700 of them can be transferred to portfolio B (assuming everything else checks out) the result will be success. If an instruction is created and authorized to transfer those 700 tokens, they would become locked. From that point, further calls to this function would return failed results because of the funds being locked, even though they haven't been transferred yet

Defined in

api/entities/Asset/Base/Settlements/index.ts:144