Requirements
Last updated
Was this helpful?
Last updated
Was this helpful?
Handles all Security Token Compliance Requirements related functionality
Namespace‹›
↳ Requirements
Protected contextInherited from void
Protected parentInherited from void
Pause all the Security Token's requirements. This means that all transfers will be allowed until requirements are unpaused
note required role:
Security Token Owner
Detele all the current requirements for the Security Token.
note required role:
Security Token Owner
Configure asset compliance requirements for the Security Token. This operation will replace all existing requirements with a new requirement set
This requires two transactions
param array of array of conditions. For a transfer to be successful, it must comply with all the conditions of at least one of the arrays. In other words, higher level arrays are OR between them, while conditions inside each array are AND between them
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.
note required role:
Security Token Owner
Un-pause all the Security Token's current requirements
▸ arePaused(): Promise‹boolean›
Check whether asset compliance requirements are paused or not
Returns: Promise‹boolean›
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
Name
Type
Description
from?
sender Identity (optional, defaults to the current Identity)
to
receiver Identity
Retrieve all of the Security Token's requirements
note can be subscribed to
Parameters:
Name
Type
callback
• context:
Defined in
• parent:
Defined in
• pause: ProcedureMethod‹void, ›
Defined in
• reset: ProcedureMethod‹void, ›
Defined in
• set: ProcedureMethod‹, ›
Defined in
• unpause: ProcedureMethod‹void, ›
Defined in
Defined in
▸ checkSettle(args: object): Promise‹›
Defined in
string |
string |
Returns: Promise‹›
▸ get(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ get(callback: ‹[]›): Promise‹›
Defined in
‹[]›
Returns: Promise‹›