Instruction

Represents a settlement Instruction to be executed on a certain Venue

Hierarchy

  • Entity‹UniqueIdentifiers›

    Instruction

Index

Properties

Methods

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:50

Identifier number of the venue

uuid

uuid: string

Inherited from Entity.uuid

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

Methods

affirm

affirm(): Promise‹TransactionQueueInstruction››

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

Affirm this instruction (authorize)

Returns: Promise‹TransactionQueueInstruction››

details

details(): Promise‹InstructionDetails

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

Retrieve information specific to this Instruction

Returns: Promise‹InstructionDetails

getAffirmations

getAffirmations(): Promise‹InstructionAffirmation[]›

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

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

Returns: Promise‹InstructionAffirmation[]›

getLegs

getLegs(): Promise‹Leg[]›

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

Retrieve all legs of this Instruction

Returns: Promise‹Leg[]›

reject

reject(): Promise‹TransactionQueueInstruction››

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

Reject this instruction

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

note reject on SettleOnBlock behaves just like unauthorize

Returns: Promise‹TransactionQueueInstruction››

withdraw

withdraw(): Promise‹TransactionQueueInstruction››

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

Withdraw affirmation from this instruction (unauthorize)

Returns: Promise‹TransactionQueueInstruction››

Static generateUuid

generateUuidIdentifiers›(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: object

Parameters:

Returns: string

Static unserialize

unserializeIdentifiers›(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: object

Parameters:

Returns: Identifiers

Last updated