Polymesh SDK API Reference
v6.0.0
v6.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
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

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

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

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

void

reset

Detele all the current requirements for the Security Token.

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

void

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.

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

unpause

Un-pause all the Security Token's current requirements

Parameters:

Name

Type

args

void

• context:

Defined in

• parent:

Defined in

Defined in

▸ checkSettle(args: object): Promise‹›

Defined in

string |

string |

Returns: Promise‹›

▸ get(): Promise‹[]›

Defined in

Returns: Promise‹[]›

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

Defined in

‹[]›

Returns: Promise‹›

▸ pause(args: void): 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): 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: ): 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): 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:225
Compliance
src/api/entities/SecurityToken/Compliance/Requirements.ts:196
Compliance
Requirement
src/api/entities/SecurityToken/Compliance/Requirements.ts:79
Requirement
src/api/entities/SecurityToken/Compliance/Requirements.ts:80
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Compliance/Requirements.ts:172
ProcedureMethod
TransactionQueue
SecurityToken
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Compliance/Requirements.ts:159
ProcedureMethod
TransactionQueue
SecurityToken
SetAssetRequirementsParams
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Compliance/Requirements.ts:70
ProcedureMethod
TransactionQueue
SecurityToken
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Compliance/Requirements.ts:182
ProcedureMethod
TransactionQueue
SecurityToken
SecurityToken
context
parent
arePaused
checkSettle
get
pause
reset
set
unpause
Identity
Identity
SetAssetRequirementsParams
Requirement
Requirement
SubCallback
UnsubCallback
UnsubCallback
SubCallback