Write an acknowledgement that member has processed earlier timestamps. Only the latest timestamp needs to be stored. Earlier timestamps can be overwritten. Acknowledgements of earlier timestamps should be ignored.

TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

Whether the sequencer store operates is used for a block sequencer or a standalone database sequencer.

In case of single instance sequencer we can use in-memory fanout buffer for events

Maximum memory usage by the events in the buffer before it starts dropping events. If set to 0, caching is disabled and all requests go to the underlying store (e.g. database).

Blocks until all earlier tasks have completed and then prevents further tasks from being run.

Count records currently stored by the sequencer. Used for pruning tests.

Delete all events that are ahead of the watermark of this sequencer. These events will not have been read and should be removed before returning the sequencer online. Should not be called alongside updating the watermark for this sequencer and only while the sequencer is offline. Returns the watermark that was used for the deletion.

Prevents member from sending and reading from the sequencer, and allows unread data for this member to be pruned. It however won't stop any sends addressed to this member.

Fetch the lower bound of events that can be read. Returns None if all events can be read.

Fetch the indexes of all sequencers that are currently online

Fetch previous event timestamp for a member for a given inclusive timestamp.

Read the watermark for this sequencer and its online/offline status. Currently only used for testing.

Flag that we're going offline (likely due to a shutdown)

Mark the sequencer as online and return a timestamp for when this sequencer can start safely producing events.

Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

Set this to true to get detailed information about all futures that did not complete during shutdown.

Return the latest acknowledgements for all members

For a given member and timestamp, return the latest timestamp of a potential topology change, that reached both the sequencer and the member. To be used by the topology snapshot awaiting, should there be a topology change expected to need to be taken into account for timestampExclusive sequencing timestamp.

Locate a timestamp relative to the earliest available event based on a skip index starting at 0. Useful to monitor the progress of pruning and for pruning in batches.

Lookup an existing member id for the given member. Will return a cached value if available. Return scala.None if no id exists.

Lookup member directly without caching.

Flag any sequencers that have a last updated watermark on or before the given cutoffTime as offline.

How often to poll to check that all tasks have completed.

Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

Blocks until all earlier tasks have completed and then prevents further tasks from being run.

Performs the task given by f unless a shutdown has been initiated. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead. Both etf and the error are lazy; etf is only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin after etf completes, but other tasks may execute concurrently with etf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.

DO NOT CALL this.close as part of etf, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

Performs the Future given by f unless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

For a given member find the timestamp of the last event that the member has received before timestampExclusive.

Prune as much data as safely possible from before the given timestamp.

Prune events before the given timestamp

Prune payloads before the given timestamp

Read all events of which a member is a recipient from the provided timestamp but no greater than the earliest watermark. Passing both member and memberId to avoid a database query for the lookup.

Internal non-buffered implementation of readEvents.

The state returned here is used to initialize a separate database sequencer (that does not share the same database as this one) using initializeFromSnapshot such that this new sequencer has enough information (registered members, previous event timestamps, etc) to be able to process new events from the same point as this sequencer to the same clients. This is typically used by block sequencers that use the database sequencer as local storage such that they will process the same events in the same order and they need to be able to spin up new block sequencers from a specific point in time.

Register the provided member. Should be idempotent if member is already registered and return the existing id.

TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

Reset the watermark to an earlier value, i.e. in case of working as a part of block sequencer. Also sets the sequencer as offline. If current watermark value is before ts, it will be left unchanged. If a watermark doesn't yet exist, it won't be inserted, because it would effectively mean setting it to a future value.

Schedules the given task to be run upon closing.

Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the LifeCycleManager's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

Return the minimum watermark across all online sequencers

Save a series of events to the store. Callers should determine batch size. No batching is done within the store. Callers MUST ensure that event-ids are unique as no errors will be returned if a duplicate is present (for the sequencer writer see sequencer.PartitionedTimestampGenerator for use with their instance index).

Save an updated lower bound of events that can be read. Must be equal or greater than any prior set lower bound.

Save a series of payloads to the store. Is up to the caller to determine a reasonable batch size and no batching is done within the store.

Write the watermark that we promise not to write anything earlier than. Does not indicate that there is an event written by this sequencer for this timestamp as there may be no activity at the sequencer, but updating the timestamp allows the sequencer to indicate that it's still alive. Return an error if we find our sequencer is offline.

Build a status object representing the current state of the sequencer.

Runs the computation fa unless isClosing returns true.

This method does not delay the closing while fa is running, unlike the methods in HasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.

Set the "pruned" previous event timestamp for a member. This timestamp is used to serve the oldest (earliest) event that sequencer has for the member:

• after pruning
• after the sequencer's onboarding

Validate that the commit mode of a session is inline with the configured expected commit mode. Return a human readable message about the mismatch in commit modes if not.