Polymesh SDK API Reference
v10.0.0
v10.0.0
  • Introduction
  • 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
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • PermissionGroupType
    • PermissionType
    • ProposalStage
    • RoleType
    • ScopeType
    • SignerType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddPairBaseParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • AgentWithGroup
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateGroupParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • FeesBreakdown
    • GroupedInstructions
    • HistoricAgentOperation
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityRole
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • InviteExternalAgentParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProcedureOpts
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveExternalAgentParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetGroupPermissionsParams
    • SetPercentageTransferRestrictionsParams
    • SetPermissionGroupParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • Subsidy
    • TaxWithholding
    • ThirdPartyFees
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenBase
    • TokenDocument
    • TokenIdentifier
    • TokenWithGroup
    • TransactionPermissions
    • TransactionsParams
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • TxGroupParams
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
    • WaivePermissionsParams
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • id
  • uuid
  • Methods
  • affirm
  • details
  • exists
  • getAffirmations
  • getLegs
  • getStatus
  • isEqual
  • isExecuted
  • isPending
  • reject
  • reschedule
  • toJson
  • 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, string›

    ↳ 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

opts?

details

Retrieve information specific to this Instruction

exists

▸ exists(): Promise‹boolean›

Determine whether this Instruction exists on chain (or existed and was pruned)

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?

getStatus

Retrieve current status of this Instruction

note uses the middleware

isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean

isExecuted

▸ isExecuted(): Promise‹boolean›

Retrieve whether the Instruction has already been executed and pruned from the chain.

Returns: Promise‹boolean›

isPending

▸ isPending(): Promise‹boolean›

Retrieve whether the Instruction is still pending on chain

Returns: Promise‹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

opts?

reschedule

Schedule a failed Instructi oto rwaa

Parameters:

Name
Type

args

void

opts?

toJson

â–¸ toJson(): string

Return the Instruction's ID

Returns: string

withdraw

Withdraw affirmation from this instruction (unauthorize)

Parameters:

Name
Type

args

void

opts?

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, opts?: ): 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‹›

Overrides .

Defined in

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

Defined in

Returns: Promise‹‹››

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

Defined in

Returns: Promise‹‹››

▸ getStatus(): Promise‹›

Defined in

Returns: Promise‹›

▸ isEqual(entity: ‹unknown, unknown›): boolean

Inherited from .

Defined in

‹unknown, unknown›

Defined in

Defined in

▸ reject(args: void, opts?: ): 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‹‹››

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

Defined in

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

Returns: Promise‹‹››

Overrides .

Defined in

▸ withdraw(args: void, opts?: ): 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:77
src/api/entities/Entity.ts:46
ProcedureOpts
TransactionQueue
Instruction
src/api/entities/Instruction/index.ts:402
ProcedureMethod
TransactionQueue
Instruction
src/api/entities/Instruction/index.ts:194
src/api/entities/Instruction/index.ts:176
PaginationOptions
ResultSet
InstructionAffirmation
src/api/entities/Instruction/index.ts:253
ResultSet
InstructionAffirmation
PaginationOptions
ResultSet
Leg
src/api/entities/Instruction/index.ts:299
ResultSet
Leg
src/api/entities/Instruction/index.ts:350
Entity
src/api/entities/Entity.ts:61
src/api/entities/Instruction/index.ts:131
src/api/entities/Instruction/index.ts:155
ProcedureOpts
TransactionQueue
Instruction
src/api/entities/Instruction/index.ts:392
ProcedureMethod
TransactionQueue
Instruction
ProcedureOpts
TransactionQueue
Instruction
src/api/entities/Instruction/index.ts:422
ProcedureMethod
TransactionQueue
Instruction
src/api/entities/Instruction/index.ts:451
ProcedureOpts
TransactionQueue
Instruction
src/api/entities/Instruction/index.ts:412
ProcedureMethod
TransactionQueue
Instruction
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
context
id
uuid
affirm
details
exists
getAffirmations
getLegs
getStatus
isEqual
isExecuted
isPending
reject
reschedule
toJson
withdraw
generateUuid
unserialize
ProcedureOpts
PaginationOptions
PaginationOptions
Entity
ProcedureOpts
ProcedureOpts
ProcedureOpts
Entity
Entity
Entity
Entity
Entity
Entity
Entity
context
uuid
exists
isEqual
toJson
generateUuid
unserialize
InstructionDetails
InstructionDetails
InstructionStatusResult
InstructionStatusResult