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
  • id
  • uuid
  • Methods
  • affirm
  • details
  • exists
  • getAffirmations
  • getLegs
  • isEqual
  • reject
  • withdraw
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

Instruction

PreviousIdentityAuthorizationsNextIssuance

Last updated 3 years ago

Was this helpful?

Represents a settlement Instruction to be executed on a certain Venue

Hierarchy

  • ‹UniqueIdentifiers›

    ↳ Instruction

Index

Properties

Methods

Properties

Protected context

id

• id: BigNumber

Identifier number of the venue

uuid

• uuid: string

Methods

affirm

Affirm this instruction (authorize)

Parameters:

Name

Type

args

void

details

Retrieve information specific to this Instruction

exists

▸ exists(): Promise‹boolean›

Retrieve whether the Instruction still exists on chain. Executed/rejected instructions are pruned from the storage

Returns: Promise‹boolean›

getAffirmations

Retrieve every authorization generated by this Instruction (status and authorizing Identity)

note supports pagination

Parameters:

Name

Type

paginationOpts?

getLegs

Retrieve all legs of this Instruction

note supports pagination

Parameters:

Name

Type

paginationOpts?

isEqual

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Returns: boolean

reject

Reject this instruction

note reject on SettleOnAffirmation will execute the settlement and it will fail immediately.

note reject on SettleOnBlock behaves just like unauthorize

Parameters:

Name

Type

args

void

withdraw

Withdraw affirmation from this instruction (unauthorize)

Parameters:

Name

Type

args

void

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

• context:

Inherited from .

Defined in

Defined in

Inherited from .

Defined in

▸ affirm(args: void): Promise‹‹››

Defined in

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

Returns: Promise‹‹››

▸ details(): Promise‹›

Defined in

Returns: Promise‹›

Defined in

▸ getAffirmations(paginationOpts?: ): Promise‹‹››

Defined in

Returns: Promise‹‹››

▸ getLegs(paginationOpts?: ): Promise‹‹››

Defined in

Returns: Promise‹‹››

▸ isEqual(entity: ‹unknown›): boolean

Inherited from .

Defined in

‹unknown›

▸ reject(args: void): Promise‹‹››

Defined in

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

Returns: Promise‹‹››

▸ withdraw(args: void): Promise‹‹››

Defined in

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

Returns: Promise‹‹››

Inherited from .

Defined in

Inherited from .

Defined in

Context
src/api/entities/Entity.ts:48
src/api/entities/Instruction/index.ts:61
src/api/entities/Entity.ts:46
TransactionQueue
Instruction
src/api/entities/Instruction/index.ts:296
ProcedureMethod
TransactionQueue
Instruction
src/api/entities/Instruction/index.ts:129
src/api/entities/Instruction/index.ts:108
PaginationOptions
ResultSet
InstructionAffirmation
src/api/entities/Instruction/index.ts:185
ResultSet
InstructionAffirmation
PaginationOptions
ResultSet
Leg
src/api/entities/Instruction/index.ts:231
ResultSet
Leg
Entity
src/api/entities/Entity.ts:61
TransactionQueue
Instruction
src/api/entities/Instruction/index.ts:286
ProcedureMethod
TransactionQueue
Instruction
TransactionQueue
Instruction
src/api/entities/Instruction/index.ts:306
ProcedureMethod
TransactionQueue
Instruction
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
context
id
uuid
affirm
details
exists
getAffirmations
getLegs
isEqual
reject
withdraw
generateUuid
unserialize
PaginationOptions
PaginationOptions
Entity
CheckpointSchedule
CheckpointSchedule
CheckpointSchedule
CheckpointSchedule
CheckpointSchedule
InstructionDetails
InstructionDetails
context
uuid
isEqual
generateUuid
unserialize