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 CheckpointSchedule.context

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

id

id: BigNumber

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

Identifier number of the venue

uuid

uuid: string

Inherited from CheckpointSchedule.uuid

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

Methods

affirm

affirm(args: void): Promise‹TransactionQueueInstruction››

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

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:

Returns: Promise‹TransactionQueueInstruction››

details

details(): Promise‹InstructionDetails

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

Retrieve information specific to this Instruction

Returns: Promise‹InstructionDetails

exists

exists(): Promise‹boolean›

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

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

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

Retrieve all legs of this Instruction

note supports pagination

Parameters:

Returns: Promise‹ResultSetLeg››

isEqual

isEqual(entity: Entity‹unknown›): 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

reject

reject(args: void): Promise‹TransactionQueueInstruction››

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

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:

Returns: Promise‹TransactionQueueInstruction››

withdraw

withdraw(args: void): Promise‹TransactionQueueInstruction››

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

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:

Returns: Promise‹TransactionQueueInstruction››

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

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

Parameters:

Returns: Identifiers

Last updated