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
▸ arePaused(): Promise‹boolean›
Check whether asset compliance requirements are paused or not
Returns: Promise‹boolean›
▸ 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
Parameters:
▪ args: object
Name
Type
Description
from?
sender Identity (optional, defaults to the current Identity)
to
receiver Identity
Returns: Promise‹Compliance›
Retrieve all of the Security Token's requirements
note can be subscribed to
Parameters:
Name
Type
callback
Pause all the Security Token's requirements. This means that all transfers will be allowed until requirements are unpaused
Detele all the current requirements for the Security Token.
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:
Name
Type
args
Un-pause all the Security Token's current requirements
• context:
Defined in
• parent:
Defined in
Defined in
Defined in
string |
string |
▸ get(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ get(callback: ‹[]›): Promise‹›
Defined in
‹[]›
Returns: Promise‹›
▸ pause(): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ reset(): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ set(args: ): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ unpause(): Promise‹‹››
Defined in
Returns: Promise‹‹››