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:183
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:153
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›
get
▸ get(): Promise‹Requirement[]›
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:53
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:54
Parameters:
Name
Type
callback
Returns: Promise‹UnsubCallback›
pause
▸ pause(): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:126
Pause all the Security Token's requirements. This means that all transfers will be allowed until requirements are unpaused
Returns: Promise‹TransactionQueue‹SecurityToken››
reset
▸ reset(): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:115
Detele all the current requirements for the Security Token.
Returns: Promise‹TransactionQueue‹SecurityToken››
set
▸ set(args: SetAssetRequirementsParams): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:40
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
Returns: Promise‹TransactionQueue‹SecurityToken››
unpause
▸ unpause(): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:137
Un-pause all the Security Token's current requirements
Returns: Promise‹TransactionQueue‹SecurityToken››
Last updated
Was this helpful?