Requirements
Handles all Security Token Compliance Requirements related functionality
Hierarchy
Namespace‹SecurityToken›
↳ Requirements
Index
Properties
Methods
Properties
Protected context
Protected context• context: Context
Inherited from void
Defined in src/api/entities/Namespace.ts:11
Protected parent
Protected parent• parent: SecurityToken
Inherited from void
Defined in src/api/entities/Namespace.ts:9
Methods
arePaused
▸ arePaused(): Promise‹boolean›
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:226
Check whether asset compliance requirements are paused or not
Returns: Promise‹boolean›
checkSettle
▸ checkSettle(args: object): Promise‹Compliance›
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:197
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 |
| string | Identity | sender Identity (optional, defaults to the current Identity) |
| string | Identity | receiver Identity |
Returns: Promise‹Compliance›
get
▸ get(): Promise‹Requirement[]›
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:80
Retrieve all of the Security Token's requirements
note can be subscribed to
Returns: Promise‹Requirement[]›
▸ get(callback: SubCallback‹Requirement[]›): Promise‹UnsubCallback›
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:81
Parameters:
Name | Type |
|
Returns: Promise‹UnsubCallback›
pause
▸ pause(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:173
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
note this method is of type ProcedureMethod, which means you can call pause.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name | Type |
| void |
|
Returns: Promise‹TransactionQueue‹SecurityToken››
reset
▸ reset(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:160
Detele all the current requirements for the Security Token.
note required role:
Security Token Owner
note this method is of type ProcedureMethod, which means you can call reset.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name | Type |
| void |
|
Returns: Promise‹TransactionQueue‹SecurityToken››
set
▸ set(args: SetAssetRequirementsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:71
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.
note required role:
Security Token Owner
note this method is of type ProcedureMethod, which means you can call set.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name | Type |
| |
|
Returns: Promise‹TransactionQueue‹SecurityToken››
unpause
▸ unpause(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:183
Un-pause all the Security Token's current requirements
note this method is of type ProcedureMethod, which means you can call unpause.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name | Type |
| void |
|
Returns: Promise‹TransactionQueue‹SecurityToken››
Last updated