Parameters to control prune batching

If defined, then the pruning window will be computed such that it targets the ideal target batch size in order to optimize the load on the database.

This is currently used with the journal stores. Normal pruning of other stores already does batching on its own.

Actual invocation of doPrune

Finds all stored computed commitments whose period overlaps with the given period.

No guarantees on the order of the returned commitments.

Last locally processed timestamp.

Upon crash-recovery, it is safe to resubscribe to the sequencer starting after the returned timestamp.

Marks a period as processed and thus its end as a safe point for crash-recovery.

To be called by the ACS commitment processor only.

The period must be after the time point returned by lastComputedAndSent.

Mark that remote commitments are outstanding for a period

Mark a period as safe for a counterparticipant. To be called by the ACS commitment processor only.

"Safe" here means that the received commitment matches the locally computed commitment. The toInclusive field of the period must not be higher than that of the last period passed to markComputedAndSent.

May be called with the same parameters again, after a restart or a domain reconnect.

Marking a period as safe may change the result of calling outstanding.

The latest timestamp before or at the given timestamp for which no commitments are outstanding. It is safe to prune the domain at the returned timestamp as long as it is not before the last timestamp needed for crash recovery (see com.digitalasset.canton.participant.pruning.AcsCommitmentProcessor.safeToPrune)

Returns None if no such tick is known.

Inspection: find periods for which commitments are still outstanding, and from whom.

The returned periods may overlap.

Prune all unnecessary data relating to events before the given timestamp.

The meaning of "unnecessary", and whether the limit is inclusive or exclusive both depend on the particular store. The store must implement the actual pruning logic in the doPrune method.

Returns the latest timestamp at which pruning was started or completed. For com.digitalasset.canton.pruning.PruningPhase.Started, it is guaranteed that no pruning has been run on the store after the returned timestamp. For com.digitalasset.canton.pruning.PruningPhase.Completed, it is guaranteed that the store is pruned at least up to the returned timestamp (inclusive). That is, another pruning with the returned timestamp (or earlier) has no effect on the store. Returns scala.None$ if no pruning has ever been started on the store.

Inspection: search computed commitments applicable to the specified period (start is exclusive, end is inclusive)

Inspection: search received commitments applicable to the specified period (start is exclusive, end is inclusive)

Store a locally computed ACS commitment. To be called by the ACS commitment processor only.

If the method is called twice with the same period and counter participant, then the supplied commitments must be the same too. Otherwise, the future fails.

The implementation is guaranteed to be idempotent: calling it twice with the same argument doesn't change the system's behavior compared to calling it only once.

Store a received ACS commitment. To be called by the ACS commitment processor only.

The implementation is guaranteed to be idempotent: calling it twice with the same argument doesn't change the store's behavior compared to calling it only once.

The callers are free to insert multiple different commitments for the same commitment period; all of them will be stored (but will be deduplicated). This can be used in case the commitment sender is malicious or buggy, and sends both a correct and an incorrect commitment for the same time period. The caller can still store both commitments, for example, such that it can later prove to a third party that the sender sent an incorrect commitment.