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
deprecated in favor of settlements.canTransfer
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
Parameters:
Name
Type
args
void
opts?
Detele all the current requirements for the Security Token.
Parameters:
Name
Type
args
void
opts?
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
opts?
Un-pause all the Security Token's current requirements
Parameters:
Name
Type
args
void
opts?
• 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(args: void, opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call pause.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ reset(args: void, opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call reset.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ set(args: , opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call set.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ unpause(args: void, opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call unpause.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››