api/entities/Instruction.Instruction

Represents a settlement Instruction to be executed on a certain Venue

• Entity<UniqueIdentifiers, string>

  ↳ Instruction

• id
• uuid

• affirm
• affirmAsMediator
• details
• executeManually
• exists
• generateOffChainAffirmationReceipt
• getAffirmations
• getInvolvedPortfolios
• getLegs
• getMediators
• getOffChainAffirmationForLeg
• getOffChainAffirmations
• getStatus
• isEqual
• isExecuted
• isPending
• onStatusChange
• reject
• rejectAsMediator
• toHuman
• withdraw
• withdrawAsMediator
• generateUuid
• unserialize

• id: BigNumber

Unique identifier number of the instruction

api/entities/Instruction/index.ts:110

---

• uuid: string

Entity.uuid

api/entities/Entity.ts:46

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

Affirm this instruction (authorize)

Name	Type
args?	AffirmInstructionParams
opts?	ProcedureOpts

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

api/entities/Instruction/index.ts:552

---

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

Affirm this instruction as a mediator (authorize)

Name	Type
args?	AffirmAsMediatorParams
opts?	ProcedureOpts

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

api/entities/Instruction/index.ts:586

---

▸ details(): Promise<InstructionDetails>

Retrieve information specific to this Instruction

Promise<InstructionDetails>

api/entities/Instruction/index.ts:307

---

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

Executes an Instruction either of type SettleManual or a Failed instruction

Name	Type
args?	ExecuteManualInstructionParams
opts?	ProcedureOpts

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

api/entities/Instruction/index.ts:606

---

▸ exists(): Promise<boolean>

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

Promise<boolean>

Entity.exists

api/entities/Instruction/index.ts:289

---

▸ generateOffChainAffirmationReceipt(args): Promise<OffChainAffirmationReceipt>

Generate an offchain affirmation receipt for a specific leg and UID

Name	Type	Description
args	Object	-
args.legId	BigNumber	index of the offchain leg in this instruction
args.metadata?	string	(optional) metadata to be associated with the receipt
args.signer?	string | Account	(optional) Signer to be used to generate receipt signature. Defaults to signing Account associated with the SDK
args.signerKeyRingType?	SignerKeyRingType	(optional) keyring type of the signer. Defaults to 'Sr25519'
args.uid	BigNumber	UID of the receipt

Promise<OffChainAffirmationReceipt>

api/entities/Instruction/index.ts:847

---

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

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

Name	Type
paginationOpts?	PaginationOptions

Promise<ResultSet<InstructionAffirmation>>

Note

supports pagination

api/entities/Instruction/index.ts:359

---

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

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

Name	Type
args	Object
args.did	string

Promise<(NumberedPortfolio | DefaultPortfolio)[]>

api/entities/Instruction/index.ts:685

---

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

Retrieve all legs of this Instruction

Name	Type
paginationOpts?	PaginationOptions

Promise<ResultSet<Leg>>

Note

supports pagination

api/entities/Instruction/index.ts:405

---

▸ getMediators(): Promise<MediatorAffirmation[]>

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

Promise<MediatorAffirmation[]>

api/entities/Instruction/index.ts:732

---

▸ getOffChainAffirmationForLeg(args): Promise<AffirmationStatus>

Returns affirmation status for a specific offchain leg in this Instruction

Name	Type	Description
args	Object	-
args.legId	BigNumber	index of the leg whose affirmation status is to be fetched

Promise<AffirmationStatus>

api/entities/Instruction/index.ts:796

---

▸ getOffChainAffirmations(): Promise<OffChainAffirmation[]>

Returns affirmation statuses for offchain legs in this Instruction

Promise<OffChainAffirmation[]>

api/entities/Instruction/index.ts:761

---

▸ getStatus(): Promise<InstructionStatusResult>

Retrieve current status of this Instruction

Promise<InstructionStatusResult>

Note

uses the middlewareV2

api/entities/Instruction/index.ts:498

---

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Name	Type
entity	Entity<unknown, unknown>

boolean

Entity.isEqual

api/entities/Entity.ts:61

---

▸ isExecuted(): Promise<boolean>

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

Promise<boolean>

api/entities/Instruction/index.ts:201

---

▸ isPending(): Promise<boolean>

Retrieve whether the Instruction is still pending on chain

Promise<boolean>

api/entities/Instruction/index.ts:230

---

▸ onStatusChange(callback): Promise<UnsubCallback>

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

Name	Type
callback	SubCallback<InstructionStatus>

Promise<UnsubCallback>

Note

can be subscribed to, if connected to node using a web socket

Note

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

api/entities/Instruction/index.ts:255

---

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

Reject this instruction

Name	Type
args?	RejectInstructionParams
opts?	ProcedureOpts

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

api/entities/Instruction/index.ts:542

---

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

Reject this instruction as a mediator

Name	Type
opts?	ProcedureOpts

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

api/entities/Instruction/index.ts:576

---

▸ toHuman(): string

Return the Instruction's ID

string

Entity.toHuman

api/entities/Instruction/index.ts:678

---

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

Withdraw affirmation from this instruction (unauthorize)

Name	Type
args?	WithdrawInstructionParams
opts?	ProcedureOpts

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

api/entities/Instruction/index.ts:562

---

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

Withdraw affirmation from this instruction as a mediator (unauthorize)

Name	Type
opts?	ProcedureOpts

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

api/entities/Instruction/index.ts:596

---

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Name
Identifiers

Name	Type
identifiers	Identifiers

string

Entity.generateUuid

api/entities/Entity.ts:14

---

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Name
Identifiers

Name	Type	Description
serialized	string	UUID to unserialize

Identifiers

Entity.unserialize

api/entities/Entity.ts:23