api_entities_Instruction.Instruction
Previousapi_entities_Identity_Portfolios.PortfoliosNextapi_entities_KnownPermissionGroup.KnownPermissionGroup
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Instruction
.Instruction
Represents a settlement Instruction to be executed on a certain Venue
<, string>
↳ Instruction
• id: BigNumber
Identifier number of the venue
Defined in
• uuid: string
Inherited from
Defined in
Affirm this instruction (authorize)
Parameters
opts?
Returns
Defined in
Retrieve information specific to this Instruction
Returns
Defined in
â–¸ exists(): Promise<boolean>
Determine whether this Instruction exists on chain (or existed and was pruned)
Returns
Promise<boolean>
Overrides
Defined in
Retrieve every authorization generated by this Instruction (status and authorizing Identity)
note supports pagination
Parameters
paginationOpts?
Returns
Defined in
Retrieve all legs of this Instruction
note supports pagination
Parameters
paginationOpts?
Returns
Defined in
Retrieve current status of this Instruction
note uses the middleware
Returns
Defined in
â–¸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Returns
boolean
Inherited from
Defined in
â–¸ isExecuted(): Promise<boolean>
Retrieve whether the Instruction has already been executed and pruned from the chain.
Returns
Promise<boolean>
Defined in
â–¸ isPending(): Promise<boolean>
Retrieve whether the Instruction is still pending on chain
Returns
Promise<boolean>
Defined in
Reject this instruction
note reject on SettleOnAffirmation will execute the settlement and it will fail immediately.
note reject on SettleOnBlock behaves just like unauthorize
Parameters
opts?
Returns
Defined in
Reschedules a failed Instruction to be tried again
throws if the Instruction status is not InstructionStatus.Failed
Parameters
opts?
Returns
Defined in
â–¸ toHuman(): string
Return the Instruction's ID
Returns
string
Overrides
Defined in
Withdraw affirmation from this instruction (unauthorize)
Parameters
opts?
Returns
Defined in
â–¸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
â–¸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
.
â–¸ affirm(opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
â–¸ details(): Promise<>
Promise<>
.
â–¸ getAffirmations(paginationOpts?): Promise<<>>
Promise<<>>
â–¸ getLegs(paginationOpts?): Promise<<>>
Promise<<>>
â–¸ getStatus(): Promise<>
Promise<>
<unknown, unknown>
.
â–¸ reject(opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
â–¸ reschedule(opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
.
â–¸ withdraw(opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
.
.