Settlements
Handles all Security Token Settlements related functionality Handles all Settlement related functionality

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from void
Defined in src/Settlements.ts:10

Protected parent

parent: SecurityToken
Inherited from void

Methods

canSettle

canSettle(args: object): Promise‹TransferStatus
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
deprecated in favor of canTransfer
Parameters:
args: object
Name
Type
Description
amount
BigNumber
amount of tokens to transfer
from?
sender Portfolio (optional, defaults to the current Identity's Default Portfolio)
to
receiver Portfolio
Returns: Promise‹TransferStatus

canTransfer

canTransfer(args: object): 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
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?
sender Portfolio (optional, defaults to the current Identity's Default Portfolio)
to
receiver Portfolio
Returns: Promise‹TransferBreakdown

getInstruction

getInstruction(args: object): Promise‹Instruction
Defined in src/Settlements.ts:45
Retrieve an Instruction by its ID
Parameters:
args: object
Name
Type
id
BigNumber
Returns: Promise‹Instruction

getVenue

getVenue(args: object): Promise‹Venue
Defined in src/Settlements.ts:24
Retrieve a Venue by its ID
Parameters:
args: object
Name
Type
id
BigNumber
Returns: Promise‹Venue
Last modified 26d ago