Returns the states of contracts at the given timestamp.

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

Shorthand for archiveContracts(Seq(cid), toc)

Marks the given contracts as archived from toc's timestamp (inclusive) onwards.

Marks the given contracts as assigned from toc's timestamp (inclusive) onwards.

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.

Returns all changes to the active contract set between the two timestamps (exclusive lower bound timestamp, inclusive upper bound timestamp) in the order of their changes. The provided lower bound must not be larger than the upper bound.

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

Returns the total number of contracts whose states are stored at the given timestamp.

To get a consistent snapshot, the caller must ensure that the timestamp specifies a time that is not in the future, i.e., not after the timestamp of the clean cursor in the com.digitalasset.canton.participant.protocol.RequestJournal Note that the result may change between two invocations if prune is called in the meantime.

Returns a map to the time of change when the contract became active for the last time before or at the given time of change. Omits contracts that not active right after the given time of change.

Returns a map to the latest reassignment counter of the contracts before the given timestamp. Fails if not all given contract ids are active in the ACS, or if the ACS has not defined their latest reassignment counter.

Deletes all activeness changes from requests whose time of change is at least the given one. This method must not be called concurrently with creating, archiving, or reassigning contracts.

Therefore, this method need not be linearizable w.r.t. creating, archiving, or reassigning contracts. For example, if a request at toc1 creates a contract c and another request at toc2 archives it while deleteSince is running for some toc <= toc1, toc2, then there are no guarantees which of the effects of the requests remain. For example, c could end up being nonexistent, active, or archived but never created, even if the writes for the requests are successful.

Deletes all entries about archived contracts whose status hasn't changed after the timestamp.

The caller must ensure that the given timestamp is at most the one of the clean cursor in the com.digitalasset.canton.participant.protocol.RequestJournal

Returns the latest com.digitalasset.canton.participant.store.ActiveContractStore.Status for the given contract IDs along with its com.digitalasset.canton.participant.util.TimeOfChange.

This method is used by the protocol processors for conflict detection. In-flight transactions may have changesets not yet written to the ACS datastore. Since only the ConflictDetector tracks in-flight changesets, this method cannot be used as a source of valid data to other components.

If a contract is created or assigned and archived or unassigned at the same com.digitalasset.canton.participant.util.TimeOfChange, the contract is ActiveContractStore.Archived or ActiveContractStore.ReassignedAway. A contract cannot be archived and unassigned at the same timestamp.

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.

Shorthand for markContractAdded(Seq(contract), toc)

Shorthand for markContractsCreated(Seq(contract), toc)

Marks the given contracts as active from timestamp (inclusive) onwards.

Unlike creation, add can be done several times in the life of a contract. It is intended to be used for ACS import and purges (e.g. repair service and party replication).

Marks the given contracts as active from timestamp (inclusive) onwards.

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.

Returns Some(contractId) if an active contract belonging to package pkg exists, otherwise returns None. The returned contractId may be any active contract from package pkg. The most recent contract state is used.

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.

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.

The table name to store the pruning timestamp in. The table must define the following fields:

• partitionColumn primary key
• phase stores the com.digitalasset.canton.pruning.PruningPhase
• ts stores the com.digitalasset.canton.data.CantonTimestamp

Purges all data from the store. This MUST ONLY be invoked when none of the data is needed anymore for example on synchronizer migration once all the data has been reassigned to the new synchronizer.

Shorthand for purgeContracts(Seq(cid), toc)

Marks the given contracts as inactive from timestamp (inclusive) onwards.

Unlike archival, purge can be done several times in the life of a contract. It is intended to be used by the repair service.

Depending on the isArchival, will archive (effect of a Daml transaction) or purge (repair service)

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

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.

Returns all contracts that were active right after the given time of change, and when the contract became active for the last time before or at the given time of change.

Marks the given contracts as ActiveContractStore.ReassignedAway from toc's timestamp (inclusive) onwards.

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.