Skip to main content
Version: 24.2.x

Class: Instruction

api/entities/Instruction.Instruction

Represents a settlement Instruction to be executed on a certain Venue

Hierarchy

Properties

id

id: BigNumber

Unique identifier number of the instruction

Defined in

api/entities/Instruction/index.ts:93


uuid

uuid: string

Inherited from

Entity.uuid

Defined in

api/entities/Entity.ts:46

Methods

affirm

affirm(args?, opts?): Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Affirm this instruction (authorize)

Parameters

NameType
args?AffirmOrWithdrawInstructionParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Note

this method is of type OptionalArgsProcedureMethod, which means you can call affirm.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Instruction/index.ts:516


affirmAsMediator

affirmAsMediator(args?, opts?): Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Affirm this instruction as a mediator (authorize)

Parameters

NameType
args?AffirmAsMediatorParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Note

this method is of type OptionalArgsProcedureMethod, which means you can call affirmAsMediator.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Instruction/index.ts:550


details

details(): Promise<InstructionDetails>

Retrieve information specific to this Instruction

Returns

Promise<InstructionDetails>

Defined in

api/entities/Instruction/index.ts:288


executeManually

executeManually(args?, opts?): Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Executes an Instruction either of type SettleManual or a Failed instruction

Parameters

NameType
args?ExecuteManualInstructionParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Note

this method is of type OptionalArgsProcedureMethod, which means you can call executeManually.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Instruction/index.ts:570


exists

exists(): Promise<boolean>

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

Returns

Promise<boolean>

Overrides

Entity.exists

Defined in

api/entities/Instruction/index.ts:270


getAffirmations

getAffirmations(paginationOpts?): Promise<ResultSet <InstructionAffirmation>>

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

Parameters

NameType
paginationOpts?PaginationOptions

Returns

Promise<ResultSet <InstructionAffirmation>>

Note

supports pagination

Defined in

api/entities/Instruction/index.ts:340


getInvolvedPortfolios

getInvolvedPortfolios(args): Promise<(NumberedPortfolio | DefaultPortfolio)[]>

Retrieve all the involved portfolios in this Instruction where the given identity is a custodian of

Parameters

NameType
argsObject
args.didstring

Returns

Promise<(NumberedPortfolio | DefaultPortfolio)[]>

Defined in

api/entities/Instruction/index.ts:616


getLegs

getLegs(paginationOpts?): Promise<ResultSet <Leg>>

Retrieve all legs of this Instruction

Parameters

NameType
paginationOpts?PaginationOptions

Returns

Promise<ResultSet <Leg>>

Note

supports pagination

Defined in

api/entities/Instruction/index.ts:386


getMediators

getMediators(): Promise<MediatorAffirmation[]>

Returns the mediators for the Instruction, along with their affirmation status

Returns

Promise<MediatorAffirmation[]>

Defined in

api/entities/Instruction/index.ts:661


getStatus

getStatus(): Promise<InstructionStatusResult>

Retrieve current status of this Instruction

Returns

Promise<InstructionStatusResult>

Note

uses the middlewareV2

Defined in

api/entities/Instruction/index.ts:462


isEqual

isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

NameType
entityEntity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

Defined in

api/entities/Entity.ts:61


isExecuted

isExecuted(): Promise<boolean>

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

Returns

Promise<boolean>

Defined in

api/entities/Instruction/index.ts:184


isPending

isPending(): Promise<boolean>

Retrieve whether the Instruction is still pending on chain

Returns

Promise<boolean>

Defined in

api/entities/Instruction/index.ts:213


onStatusChange

onStatusChange(callback): Promise<UnsubCallback>

Retrieve current status of the Instruction. This can be subscribed to know if instruction fails

Parameters

NameType
callbackSubCallback <InstructionStatus>

Returns

Promise<UnsubCallback>

Note

can be subscribed to

Note

current status as Executed means that the Instruction has been executed/rejected and pruned from the chain.

Defined in

api/entities/Instruction/index.ts:238


reject

reject(args?, opts?): Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Reject this instruction

Parameters

NameType
args?RejectInstructionParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Note

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

Note

reject on SettleOnBlock behaves just like unauthorize

Note

reject on SettleManual behaves just like unauthorize

Note

this method is of type OptionalArgsProcedureMethod, which means you can call reject.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Instruction/index.ts:506


rejectAsMediator

rejectAsMediator(opts?): Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Reject this instruction as a mediator

Parameters

NameType
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Note

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

Note

reject on SettleOnBlock behaves just like unauthorize

Note

reject on SettleManual behaves just like unauthorize

Note

this method is of type NoArgsProcedureMethod, which means you can call rejectAsMediator.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Instruction/index.ts:540


toHuman

toHuman(): string

Return the Instruction's ID

Returns

string

Overrides

Entity.toHuman

Defined in

api/entities/Instruction/index.ts:609


withdraw

withdraw(args?, opts?): Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Withdraw affirmation from this instruction (unauthorize)

Parameters

NameType
args?AffirmOrWithdrawInstructionParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Note

this method is of type OptionalArgsProcedureMethod, which means you can call withdraw.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Instruction/index.ts:526


withdrawAsMediator

withdrawAsMediator(opts?): Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Withdraw affirmation from this instruction as a mediator (unauthorize)

Parameters

NameType
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction <Instruction, Instruction>>

Note

this method is of type NoArgsProcedureMethod, which means you can call withdrawAsMediator.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Instruction/index.ts:560


generateUuid

Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

NameType
identifiersIdentifiers

Returns

string

Inherited from

Entity.generateUuid

Defined in

api/entities/Entity.ts:14


unserialize

Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

NameTypeDescription
serializedstringUUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize

Defined in

api/entities/Entity.ts:23