Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Checkpoint

Checkpoints may be used to:

  • detect time out of commands.
  • provide an offset which can be used to restart consumption.

Example:

{
    recordTime: {
        seconds: 1554382900
        nanoseconds: 0
    },
    offset: {
        offsetType: 'absolute',
        absolute: LedgerOffsetBoundaryValue.END
    }
}

Please note that the Timestamp used here is different from the TimestampValue used to represent DAML timestamps.

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

see

Timestamp

see

LedgerOffset

Hierarchy

  • Checkpoint

Index

Properties

Properties

offset

offset: LedgerOffset

May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time.

recordTime

recordTime: Timestamp

All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint.

Generated using TypeDoc