@digitalasset/daml-ledger/lib/model/Checkpoint.d.ts

DAML Ledger API Node.js bindings

import { LedgerOffset } from './LedgerOffset';
import { Timestamp } from './Timestamp';
/**
 * 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 {@link Timestamp} used here is different from
 * the {@link TimestampValue} used to represent DAML timestamps.
 *
 * To express values in a more concise way, you can have a look at the {@link ValueHelpers}.
 *
 * @see Timestamp
 * @see LedgerOffset
 */
export interface Checkpoint {
    /**
     * All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint.
     */
    recordTime: Timestamp;
    /**
     * May be used in a subsequent {@link CompletionStreamRequest} to resume the consumption of this stream at a later time.
     */
    offset: LedgerOffset;
}