Instruction
Represents a settlement Instruction to be executed on a certain Venue
Hierarchy
Entity‹UniqueIdentifiers›
↳ Instruction
Index
Properties
Methods
Properties
Protected context
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
id
• id: BigNumber
Defined in src/api/entities/Instruction/index.ts:44
Identifier number of the venue
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
authorize
▸ authorize(): Promise‹TransactionQueue‹Instruction››
Defined in src/api/entities/Instruction/index.ts:178
Authorize this instruction
Returns: Promise‹TransactionQueue‹Instruction››
details
▸ details(): Promise‹InstructionDetails›
Defined in src/api/entities/Instruction/index.ts:60
Retrieve information specific to this Instruction
Returns: Promise‹InstructionDetails›
getAuthorizations
▸ getAuthorizations(): Promise‹InstructionAuthorization[]›
Defined in src/api/entities/Instruction/index.ts:103
Retrieve every authorization generated by this Instruction (status and authorizing Identity)
Returns: Promise‹InstructionAuthorization[]›
getLegs
▸ getLegs(): Promise‹Leg[]›
Defined in src/api/entities/Instruction/index.ts:132
Retrieve all legs of this Instruction
Returns: Promise‹Leg[]›
reject
▸ reject(): Promise‹TransactionQueue‹Instruction››
Defined in src/api/entities/Instruction/index.ts:167
Reject this instruction
note reject on SettleOnAuthorization will execute the settlement and it will fail immediately.
note reject on SettleOnBlock behaves just like unauthorize
Returns: Promise‹TransactionQueue‹Instruction››
unauthorize
▸ unauthorize(): Promise‹TransactionQueue‹Instruction››
Defined in src/api/entities/Instruction/index.ts:189
Unauthorize this instruction
Returns: Promise‹TransactionQueue‹Instruction››
Static generateUuid
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: object
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string
Static unserialize
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: object
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last updated