Requirements

Handles all Security Token Compliance Requirements related functionality

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

Protected parent

parent: SecurityToken

Inherited from void

Defined in src/api/entities/Namespace.ts:9

pause

pause: ProcedureMethod‹void, SecurityToken

Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:163

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

reset

reset: ProcedureMethod‹void, SecurityToken

Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:155

Detele all the current requirements for the Security Token.

note required role:

  • Security Token Owner

set

set: ProcedureMethod‹SetAssetRequirementsParams, 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

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

unpause

unpause: ProcedureMethod‹void, SecurityToken

Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:168

Un-pause all the Security Token's current requirements

Methods

arePaused

arePaused(): Promise‹boolean›

Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:209

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:180

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?

string | Identity

sender Identity (optional, defaults to the current Identity)

to

string | Identity

receiver Identity

Returns: Promise‹Compliance

get

get(): Promise‹Requirement[]›

Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:78

Retrieve all of the Security Token's requirements

note can be subscribed to

Returns: Promise‹Requirement[]›

get(callback: SubCallbackRequirement[]›): Promise‹UnsubCallback

Defined in src/api/entities/SecurityToken/Compliance/Requirements.ts:79

Parameters:

Name

Type

callback

Returns: Promise‹UnsubCallback

Last updated