Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TransactionTree

Complete view of an on-ledger transaction.

Example:

{
    commandId: 'some-command-id',
    effectiveAt: {
        seconds: 1554382900
        nanoseconds: 0
    },
    offset: '42',
    transactionId: 'some-tx-id',
    workflowId: 'some-workflow-id',
    eventsById: {
        'some-event-id': {
            eventType: 'created',
            eventId: 'some-event-id',
            contractId: 'some-contract-id',
            templateId: {
                packageId: 'my-package-id',
                moduleName: 'SomeModule',
                entityName: 'SomeTemplate'
            },
            arguments: {
                fields: {
                    someKey: { valueType: 'bool', bool: true }
                }
            },
            witnessParties: [ 'Alice', 'Bob' ]
        }
    },
    rootEventIds: [
        'event-1',
        'event-2'
    ]
}

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

see

Timestamp

see

TreeEvent

see

Record

Hierarchy

  • TransactionTree

Index

Properties

Optional commandId

commandId: undefined | string

The identifier of the command which resulted in this transaction.

Missing for everyone except the submitting party.

effectiveAt

effectiveAt: Timestamp

Ledger effective time.

eventsById

eventsById: Record<string, TreeEvent>

Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.

offset

offset: string

The absolute offset.

rootEventIds

rootEventIds: string[]

Roots of the transaction tree.

transactionId

transactionId: string

Assigned by the server. Useful for correlating logs.

Optional workflowId

workflowId: undefined | string

The workflow identifier used in command submission.

Only set if the workflowIdd for the command was set.

Generated using TypeDoc