Settlements

Handles all Security Token Settlements related functionality

Hierarchy

• Namespace‹SecurityToken›

  ↳ Settlements

Index

Properties

• context

• parent

Methods

• canSettle

Properties

Protected context

• context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:12

Protected parent

• parent: SecurityToken

Inherited from void

Defined in src/api/entities/Namespace.ts:10

Methods

canSettle

▸ canSettle(args: object): Promise‹TransferStatus›

Defined in src/api/entities/SecurityToken/Settlements.ts:32

Check whether it is possible to create a settlement instruction to transfer a certain amount of this asset between two Portfolios.

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 yield failed results because of the funds being locked, even though they haven't been transferred yet

Parameters:

▪ args: object

Name	Type	Description
amount	BigNumber	amount of tokens to transfer
from?	PortfolioLike	sender Portfolio (optional, defaults to the current Identity's Default Portfolio)
to	PortfolioLike	receiver Portfolio

Returns: Promise‹TransferStatus›