Instruction
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents a settlement Instruction to be executed on a certain Venue
‹UniqueIdentifiers, string›
↳ Instruction
Protected context• id: BigNumber
Identifier number of the venue
• uuid: string
Affirm this instruction (authorize)
Parameters:
Name
Type
args
void
opts?
Retrieve information specific to this Instruction
▸ exists(): Promise‹boolean›
Retrieve whether the Instruction exists on chain (or existed and was pruned)
Returns: Promise‹boolean›
Retrieve every authorization generated by this Instruction (status and authorizing Identity)
note supports pagination
Parameters:
Name
Type
paginationOpts?
Retrieve all legs of this Instruction
note supports pagination
Parameters:
Name
Type
paginationOpts?
Retrieve current status of this Instruction
note uses the middleware
Whether this Entity is the same as another one
Parameters:
Name
Type
entity
Returns: boolean
▸ isExecuted(): Promise‹boolean›
Retrieve whether the Instruction has already been executed and pruned from the chain.
Returns: Promise‹boolean›
▸ isPending(): Promise‹boolean›
Retrieve whether the Instruction is still pending on chain
Returns: Promise‹boolean›
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:
Name
Type
args
void
opts?
Schedule a failed Instructi oto rwaa
Parameters:
Name
Type
args
void
opts?
â–¸ toJson(): string
Return the Instruction's ID
Returns: string
Withdraw affirmation from this instruction (unauthorize)
Parameters:
Name
Type
args
void
opts?
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
â–ª Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
• context:
Inherited from .
Defined in
Defined in
Inherited from .
Defined in
▸ affirm(args: void, opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call affirm.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ details(): Promise‹›
Defined in
Returns: Promise‹›
Defined in
▸ getAffirmations(paginationOpts?: ): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ getLegs(paginationOpts?: ): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ getStatus(): Promise‹›
Defined in
Returns: Promise‹›
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
Defined in
Defined in
▸ reject(args: void, opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call reject.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ reschedule(args: void, opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call reschedule.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
Overrides .
Defined in
▸ withdraw(args: void, opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call withdraw.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
Inherited from .
Defined in
Inherited from .
Defined in