Instruction
Represents a settlement Instruction to be executed on a certain Venue
Hierarchy
Entity‹UniqueIdentifiers›
↳ Instruction
Index
Properties
Methods
Properties
affirm
• affirm: ProcedureMethod‹void, Instruction›
Defined in src/api/entities/Instruction/index.ts:221
Affirm this instruction (authorize)
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:50
Identifier number of the venue
reject
• reject: ProcedureMethod‹void, Instruction›
Defined in src/api/entities/Instruction/index.ts:215
Reject this instruction
note reject on SettleOnAffirmation will execute the settlement and it will fail immediately.
note reject on SettleOnBlock behaves just like unauthorize
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
withdraw
• withdraw: ProcedureMethod‹void, Instruction›
Defined in src/api/entities/Instruction/index.ts:226
Withdraw affirmation from this instruction (unauthorize)
Methods
details
▸ details(): Promise‹InstructionDetails›
Defined in src/api/entities/Instruction/index.ts:87
Retrieve information specific to this Instruction
Returns: Promise‹InstructionDetails›
getAffirmations
▸ getAffirmations(paginationOpts?: PaginationOptions): Promise‹ResultSet‹InstructionAffirmation››
Defined in src/api/entities/Instruction/index.ts:134
Retrieve every authorization generated by this Instruction (status and authorizing Identity)
note supports pagination
Parameters:
Name
Type
paginationOpts?
Returns: Promise‹ResultSet‹InstructionAffirmation››
getLegs
▸ getLegs(paginationOpts?: PaginationOptions): Promise‹ResultSet‹Leg››
Defined in src/api/entities/Instruction/index.ts:171
Retrieve all legs of this Instruction
note supports pagination
Parameters:
Name
Type
paginationOpts?
Returns: Promise‹ResultSet‹Leg››
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