Requirements

Handles all Asset Compliance Requirements related functionality

Hierarchy

• Namespace‹Asset›

  ↳ Requirements

Index

Properties

• context

• parent

Methods

• add

• arePaused

• checkSettle

• get

• modify

• pause

• remove

• reset

• set

• unpause

Properties

Protected context

• context: Context

Inherited from void

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

---

Protected parent

• parent: Asset

Inherited from void

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

Methods

add

▸ add(args: AddAssetRequirementParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/Compliance/Requirements.ts:99

Add a new compliance requirement to the the Asset. This doesn't modify existing requirements

note this method is of type ProcedureMethod, which means you can call add.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
args	AddAssetRequirementParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Asset››

---

arePaused

▸ arePaused(): Promise‹boolean›

Defined in src/api/entities/Asset/Compliance/Requirements.ts:278

Check whether Asset compliance requirements are paused or not

Returns: Promise‹boolean›

---

checkSettle

▸ checkSettle(args: object): Promise‹Compliance›

Defined in src/api/entities/Asset/Compliance/Requirements.ts:249

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 signing Identity)
to	string | Identity	receiver Identity

Returns: Promise‹Compliance›

---

get

▸ get(): Promise‹ComplianceRequirements›

Defined in src/api/entities/Asset/Compliance/Requirements.ts:131

Retrieve all of the Asset's compliance requirements, together with the Default Trusted Claim Issuers

note can be subscribed to

Returns: Promise‹ComplianceRequirements›

▸ get(callback: SubCallback‹ComplianceRequirements›): Promise‹UnsubCallback›

Defined in src/api/entities/Asset/Compliance/Requirements.ts:132

Parameters:

Name	Type
callback	SubCallback‹ComplianceRequirements›

Returns: Promise‹UnsubCallback›

---

modify

▸ modify(args: ModifyComplianceRequirementParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/Compliance/Requirements.ts:302

Modify a compliance requirement for the Asset

note this method is of type ProcedureMethod, which means you can call modify.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
args	ModifyComplianceRequirementParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

---

pause

▸ pause(opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/Compliance/Requirements.ts:225

Pause all the Asset's requirements. This means that all transfers will be allowed until requirements are unpaused

note this method is of type NoArgsProcedureMethod, which means you can call pause.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Asset››

---

remove

▸ remove(args: RemoveAssetRequirementParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/Compliance/Requirements.ts:109

Remove an existing compliance requirement from the Asset

note this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
args	RemoveAssetRequirementParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Asset››

---

reset

▸ reset(opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/Compliance/Requirements.ts:215

Delete all the current requirements for the Asset.

note this method is of type NoArgsProcedureMethod, which means you can call reset.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Asset››

---

set

▸ set(args: SetAssetRequirementsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/Compliance/Requirements.ts:122

Configure compliance requirements for the Asset. This operation will replace all existing requirements with a new requirement set

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 this method is of type ProcedureMethod, which means you can call set.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
args	SetAssetRequirementsParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Asset››

---

unpause

▸ unpause(opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/Compliance/Requirements.ts:235

Un-pause all the Asset's current requirements

note this method is of type NoArgsProcedureMethod, which means you can call unpause.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Asset››