Instruction

Represents a settlement Instruction to be executed on a certain Venue

Hierarchy

• Entity‹UniqueIdentifiers, string›

  ↳ Instruction

Index

Properties

• context

• id

• uuid

Methods

• affirm

• details

• exists

• getAffirmations

• getLegs

• getStatus

• isEqual

• isExecuted

• isPending

• reject

• reschedule

• toJson

• withdraw

• generateUuid

• unserialize

Properties

Protected context

• context: Context

Inherited from Entity.context

Defined in src/api/entities/Entity.ts:48

id

• id: BigNumber

Defined in src/api/entities/Instruction/index.ts:77

Identifier number of the venue

uuid

• uuid: string

Inherited from Entity.uuid

Defined in src/api/entities/Entity.ts:46

Methods

affirm

▸ affirm(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹Instruction››

Defined in src/api/entities/Instruction/index.ts:402

Affirm this instruction (authorize)

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

Parameters:

Name	Type
args	void
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Instruction››

details

▸ details(): Promise‹InstructionDetails›

Defined in src/api/entities/Instruction/index.ts:194

Retrieve information specific to this Instruction

Returns: Promise‹InstructionDetails›

exists

▸ exists(): Promise‹boolean›

Defined in src/api/entities/Instruction/index.ts:176

Retrieve whether the Instruction exists on chain (or existed and was pruned)

Returns: Promise‹boolean›

getAffirmations

▸ getAffirmations(paginationOpts?: PaginationOptions): Promise‹ResultSet‹InstructionAffirmation››

Defined in src/api/entities/Instruction/index.ts:253

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

note supports pagination

Parameters:

Name	Type
paginationOpts?	PaginationOptions

Returns: Promise‹ResultSet‹InstructionAffirmation››

getLegs

▸ getLegs(paginationOpts?: PaginationOptions): Promise‹ResultSet‹Leg››

Defined in src/api/entities/Instruction/index.ts:299

Retrieve all legs of this Instruction

note supports pagination

Parameters:

Name	Type
paginationOpts?	PaginationOptions

Returns: Promise‹ResultSet‹Leg››

getStatus

▸ getStatus(): Promise‹InstructionStatusResult›

Defined in src/api/entities/Instruction/index.ts:350

Retrieve current status of this Instruction

note uses the middleware

Returns: Promise‹InstructionStatusResult›

isEqual

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

Inherited from Entity.isEqual

Defined in src/api/entities/Entity.ts:61

Whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

isExecuted

▸ isExecuted(): Promise‹boolean›

Defined in src/api/entities/Instruction/index.ts:131

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

Returns: Promise‹boolean›

isPending

▸ isPending(): Promise‹boolean›

Defined in src/api/entities/Instruction/index.ts:155

Retrieve whether the Instruction is still pending on chain

Returns: Promise‹boolean›

reject

▸ reject(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹Instruction››

Defined in src/api/entities/Instruction/index.ts:392

Reject this instruction

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

note reject on SettleOnBlock behaves just like unauthorize

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

Parameters:

Name	Type
args	void
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Instruction››

reschedule

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

Defined in src/api/entities/Instruction/index.ts:422

Schedule a failed Instructi oto rwaa

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

Parameters:

Name	Type
args	void
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Instruction››

toJson

▸ toJson(): string

Overrides Entity.toJson

Defined in src/api/entities/Instruction/index.ts:451

Return the Instruction's ID

Returns: string

withdraw

▸ withdraw(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹Instruction››

Defined in src/api/entities/Instruction/index.ts:412

Withdraw affirmation from this instruction (unauthorize)

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

Parameters:

Name	Type
args	void
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Instruction››

Static generateUuid

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

Inherited from Entity.generateUuid

Defined in src/api/entities/Entity.ts:14

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

Inherited from Entity.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers