api_entities_Asset_Compliance_Requirements.Requirements

@polymeshassociation/polymesh-sdk / Modules / api/entities/Asset/Compliance/Requirements / Requirements

Class: Requirements

api/entities/Asset/Compliance/Requirements.Requirements

Handles all Asset Compliance Requirements related functionality

Hierarchy

  • Namespace<Asset>

    Requirements

Table of contents

Methods

Methods

add

add(args, opts?): Promise<TransactionQueue<Asset, Asset, unknown[][]>>

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

Returns

Promise<TransactionQueue<Asset, Asset, unknown[][]>>

Defined in

api/entities/Asset/Compliance/Requirements.ts:103


arePaused

arePaused(): Promise<boolean>

Check whether Asset compliance requirements are paused or not

Returns

Promise<boolean>

Defined in

api/entities/Asset/Compliance/Requirements.ts:282


checkSettle

checkSettle(args): 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

NameTypeDescription

args

Object

-

args.from?

string | Identity

sender Identity (optional, defaults to the signing Identity)

args.to

string | Identity

receiver Identity

Returns

Promise<Compliance>

Defined in

api/entities/Asset/Compliance/Requirements.ts:253


get

get(): Promise<ComplianceRequirements>

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

note can be subscribed to

Returns

Promise<ComplianceRequirements>

Defined in

api/entities/Asset/Compliance/Requirements.ts:135

get(callback): Promise<UnsubCallback>

Parameters

Returns

Promise<UnsubCallback>

Defined in

api/entities/Asset/Compliance/Requirements.ts:136


modify

modify(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>

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

Returns

Promise<TransactionQueue<void, void, unknown[][]>>

Defined in

api/entities/Asset/Compliance/Requirements.ts:306


pause

pause(opts?): Promise<TransactionQueue<Asset, Asset, unknown[][]>>

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

NameType

opts?

Returns

Promise<TransactionQueue<Asset, Asset, unknown[][]>>

Defined in

api/entities/Asset/Compliance/Requirements.ts:229


remove

remove(args, opts?): Promise<TransactionQueue<Asset, Asset, unknown[][]>>

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

Returns

Promise<TransactionQueue<Asset, Asset, unknown[][]>>

Defined in

api/entities/Asset/Compliance/Requirements.ts:113


reset

reset(opts?): Promise<TransactionQueue<Asset, Asset, unknown[][]>>

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

NameType

opts?

Returns

Promise<TransactionQueue<Asset, Asset, unknown[][]>>

Defined in

api/entities/Asset/Compliance/Requirements.ts:219


set

set(args, opts?): Promise<TransactionQueue<Asset, Asset, unknown[][]>>

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

Returns

Promise<TransactionQueue<Asset, Asset, unknown[][]>>

Defined in

api/entities/Asset/Compliance/Requirements.ts:126


unpause

unpause(opts?): Promise<TransactionQueue<Asset, Asset, unknown[][]>>

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

NameType

opts?

Returns

Promise<TransactionQueue<Asset, Asset, unknown[][]>>

Defined in

api/entities/Asset/Compliance/Requirements.ts:239

Last updated