Instruction
Represents a settlement Instruction to be executed on a certain Venue

Hierarchy

    Entity‹UniqueIdentifiers, string›
    Instruction

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from Entity.context

id

id: BigNumber
Identifier number of the venue

uuid

uuid: string
Inherited from Entity.uuid

Methods

affirm

affirm(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueInstruction››
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:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueueInstruction››

details

details(): Promise‹InstructionDetails
Retrieve information specific to this Instruction
Returns: Promise‹InstructionDetails

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this Instruction exists on chain (or existed and was pruned)
Returns: Promise‹boolean›

getAffirmations

getAffirmations(paginationOpts?: PaginationOptions): Promise‹ResultSetInstructionAffirmation››
Retrieve every authorization generated by this Instruction (status and authorizing Identity)
note supports pagination
Parameters:
Name
Type
paginationOpts?
Returns: Promise‹ResultSetInstructionAffirmation››

getLegs

getLegs(paginationOpts?: PaginationOptions): Promise‹ResultSetLeg››
Retrieve all legs of this Instruction
note supports pagination
Parameters:
Name
Type
paginationOpts?
Returns: Promise‹ResultSetLeg››

getStatus

getStatus(): Promise‹InstructionStatusResult
Retrieve current status of this Instruction
note uses the middleware
Returns: Promise‹InstructionStatusResult

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from Entity.isEqual
Determine whether this Entity is the same as another one
Parameters:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean

isExecuted

isExecuted(): Promise‹boolean›
Retrieve whether the Instruction has already been executed and pruned from the chain.
Returns: Promise‹boolean›

isPending

isPending(): Promise‹boolean›
Retrieve whether the Instruction is still pending on chain
Returns: Promise‹boolean›

reject

reject(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueInstruction››
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:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueueInstruction››

reschedule

reschedule(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueInstruction››
Schedule a failed Instructi oto rwaa
note this method is of type ProcedureMethod, which means you can call reschedule.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueueInstruction››

toJson

toJson(): string
Overrides Entity.toJson
Return the Instruction's ID
Returns: string

withdraw

withdraw(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueInstruction››
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:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueueInstruction››

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
Generate the Entity's UUID from its identifying properties
Type parameters:
Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers
Inherited from Entity.unserialize
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago