Polymesh SDK API Reference
v11.0.2
v11.0.2
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • Protected parent
  • Methods
  • arePaused
  • checkSettle
  • get
  • pause
  • reset
  • set
  • unpause

Was this helpful?

  1. Classes

Requirements

PreviousPortfoliosNextSchedules

Last updated 3 years ago

Was this helpful?

Handles all Security Token Compliance Requirements related functionality

Hierarchy

  • Namespace‹›

    ↳ Requirements

Index

Properties

Methods

Properties

Protected context

Inherited from void


Protected parent

Inherited from void

Methods

arePaused

▸ arePaused(): Promise‹boolean›

Check whether asset compliance requirements are paused or not

Returns: Promise‹boolean›


checkSettle

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

â–ª args: object

Name
Type
Description

from?

sender Identity (optional, defaults to the current Identity)

to

receiver Identity

Returns: Promise‹Compliance›


get

Retrieve all of the Security Token's requirements

note can be subscribed to

Parameters:

Name
Type

callback


pause

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

Parameters:

Name
Type

args

void

opts?


reset

Detele all the current requirements for the Security Token.

Parameters:

Name
Type

args

void

opts?


set

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

opts?


unpause

Un-pause all the Security Token's current requirements

Parameters:

Name
Type

args

void

opts?

• context:

Defined in

• parent:

Defined in

Defined in

Defined in

string |

string |

▸ get(): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ get(callback: ‹[]›): Promise‹›

Defined in

‹[]›

Returns: Promise‹›

▸ pause(args: void, opts?: ): Promise‹‹››

Defined in

note this method is of type , which means you can call pause.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹››

▸ reset(args: void, opts?: ): Promise‹‹››

Defined in

note this method is of type , which means you can call reset.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹››

▸ set(args: , opts?: ): Promise‹‹››

Defined in

note this method is of type , which means you can call set.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹››

▸ unpause(args: void, opts?: ): Promise‹‹››

Defined in

note this method is of type , which means you can call unpause.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹››

Context
src/api/entities/Namespace.ts:11
SecurityToken
src/api/entities/Namespace.ts:9
src/api/entities/SecurityToken/Compliance/Requirements.ts:228
src/api/entities/SecurityToken/Compliance/Requirements.ts:199
Requirement
src/api/entities/SecurityToken/Compliance/Requirements.ts:78
Requirement
src/api/entities/SecurityToken/Compliance/Requirements.ts:79
ProcedureOpts
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Compliance/Requirements.ts:175
ProcedureMethod
TransactionQueue
SecurityToken
ProcedureOpts
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Compliance/Requirements.ts:165
ProcedureMethod
TransactionQueue
SecurityToken
SetAssetRequirementsParams
ProcedureOpts
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Compliance/Requirements.ts:69
ProcedureMethod
TransactionQueue
SecurityToken
ProcedureOpts
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Compliance/Requirements.ts:185
ProcedureMethod
TransactionQueue
SecurityToken
SecurityToken
context
parent
arePaused
checkSettle
get
pause
reset
set
unpause
Identity
Identity
ProcedureOpts
ProcedureOpts
SetAssetRequirementsParams
ProcedureOpts
ProcedureOpts
Requirement
Requirement
SubCallback
UnsubCallback
UnsubCallback
SubCallback