Requirements
Handles all Security Token Compliance Requirements related functionality
Hierarchy
↳ Requirements
Index
Properties
Methods
Properties
Protected
context
Protected
contextInherited from void
Protected
parent
Protected
parentInherited from void
Methods
arePaused
▸ arePaused(): Promise‹boolean›
Check whether asset compliance requirements are paused or not
Returns: Promise‹boolean›
checkSettle
▸ checkSettle(args
: object): Promise‹Compliance›
Check whether the sender and receiver Identities in a transfer comply with all the requirements of this asset
note
this does not take balances into account
deprecated
in favor of settlements.canTransfer
Parameters:
▪ args: object
Returns: Promise‹Compliance›
get
Retrieve all of the Security Token's requirements
note
can be subscribed to
Parameters:
pause
Pause all the Security Token's requirements. This means that all transfers will be allowed until requirements are unpaused
Parameters:
reset
Detele all the current requirements for the Security Token.
Parameters:
set
Configure asset compliance requirements for the Security Token. This operation will replace all existing requirements with a new requirement set
This requires two transactions
example
Say A, B, C, D and E are requirements and we arrange them as [[A, B], [C, D], [E]]
. For a transfer to succeed, it must either comply with A AND B, C AND D, OR E.
Parameters:
unpause
Un-pause all the Security Token's current requirements
Parameters:
Last updated