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

Affirm this instruction (authorize)

Protected context

context: Context

Inherited from CheckpointSchedule.context

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

id

id: BigNumber

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

Identifier number of the venue

reject

reject: ProcedureMethod‹void, Instruction

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

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

Inherited from CheckpointSchedule.uuid

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

withdraw

withdraw: ProcedureMethod‹void, Instruction

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

Withdraw affirmation from this instruction (unauthorize)

Methods

details

details(): Promise‹InstructionDetails

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

Retrieve information specific to this Instruction

Returns: Promise‹InstructionDetails

exists

exists(): Promise‹boolean›

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

Retrieve whether the Instruction still exists on chain. Executed/rejected instructions are pruned from the storage

Returns: Promise‹boolean›

getAffirmations

getAffirmations(paginationOpts?: PaginationOptions): Promise‹ResultSetInstructionAffirmation››

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

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

note supports pagination

Parameters:

Returns: Promise‹ResultSetInstructionAffirmation››

getLegs

getLegs(paginationOpts?: PaginationOptions): Promise‹ResultSetLeg››

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

Retrieve all legs of this Instruction

note supports pagination

Parameters:

Returns: Promise‹ResultSetLeg››

isEqual

isEqual(entity: Entity‹object›): boolean

Inherited from CheckpointSchedule.isEqual

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

Whether this Entity is the same as another one

Parameters:

Returns: boolean

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.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 CheckpointSchedule.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