Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Completion

A completion represents the status of a submitted command on the ledger: it can be successful or failed.

Example:

{
    commandId: 'some-command-id',
    status: {
        code: 42,
        message: 'ANSWER'.
        details: []
    },
    transactionId: 'some-tx-id'
}

To express values in a more concise way, you can have a look at the ValueHelpers.

see

Status

see

Any

Hierarchy

  • Completion

Index

Properties

commandId

commandId: string

The identifier of the succeeded or failed command.

Optional status

status: Status

Identifies the exact type of the error. For example, malformed or double spend transactions will result in a INVALID_ARGUMENT status. Transactions with invalid time time windows (which may be valid at a later date) will result in an ABORTED error.

Optional transactionId

transactionId: undefined | string

The identifier of the transaction that resulted from the command with the aforementioned command identifier. Only set for successfully executed commands.

Generated using TypeDoc