Packages

trait AcsCommitmentStore extends AcsCommitmentLookup with PrunableByTime[AcsCommitmentStoreError] with AutoCloseable

Read and write interface for ACS commitments. Apart from pruning, should only be used by the ACS commitment processor

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AcsCommitmentStore
  2. AutoCloseable
  3. PrunableByTime
  4. AcsCommitmentLookup
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def advancePruningTimestamp(phase: PruningPhase, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, AcsCommitmentStoreError, Unit]
    Attributes
    protected[canton]
    Definition Classes
    PrunableByTime
    Annotations
    @VisibleForTesting()
  2. abstract def close(): Unit
    Definition Classes
    AutoCloseable
    Annotations
    @throws(classOf[java.lang.Exception])
  3. abstract def doPrune(limit: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, AcsCommitmentStoreError, Unit]
    Attributes
    protected[canton]
    Definition Classes
    PrunableByTime
    Annotations
    @VisibleForTesting()
  4. implicit abstract val ec: ExecutionContext
    Attributes
    protected
    Definition Classes
    PrunableByTime
  5. abstract def getComputed(period: CommitmentPeriod, counterParticipant: ParticipantId)(implicit traceContext: TraceContext): Future[Iterable[(CommitmentPeriod, CommitmentType)]]

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

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

    No guarantees on the order of the returned commitments.

    Definition Classes
    AcsCommitmentLookup
  6. abstract def lastComputedAndSent(implicit traceContext: TraceContext): Future[Option[CantonTimestampSecond]]

    Last locally processed timestamp.

    Last locally processed timestamp.

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

    Definition Classes
    AcsCommitmentLookup
  7. abstract def markComputedAndSent(period: CommitmentPeriod)(implicit traceContext: TraceContext): Future[Unit]

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

    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.

  8. abstract def markOutstanding(period: CommitmentPeriod, counterParticipants: Set[ParticipantId])(implicit traceContext: TraceContext): Future[Unit]

    Mark that remote commitments are outstanding for a period

  9. abstract def markSafe(counterParticipant: ParticipantId, period: CommitmentPeriod)(implicit traceContext: TraceContext): Future[Unit]

    Mark a period as safe for a counterparticipant.

    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.

    TODO(#8207): Currently, the implementations may assume that all arguments this method is ever called with will have the same interval, as will the intervals in the arguments to storeReceived and storeComputed.

  10. abstract def noOutstandingCommitments(beforeOrAt: CantonTimestamp)(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]

    The latest timestamp before or at the given timestamp for which no commitments are 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.

    Definition Classes
    AcsCommitmentLookup
  11. abstract def outstanding(start: CantonTimestamp, end: CantonTimestamp, counterParticipant: Option[ParticipantId])(implicit traceContext: TraceContext): Future[Iterable[(CommitmentPeriod, ParticipantId)]]

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

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

    The returned periods may overlap.

    Definition Classes
    AcsCommitmentLookup
  12. abstract def pruningStatus(implicit traceContext: TraceContext): EitherT[Future, AcsCommitmentStoreError, Option[PruningStatus]]

    Returns the latest timestamp at which pruning was started or completed.

    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.

    Definition Classes
    PrunableByTime
  13. abstract val queue: CommitmentQueue
  14. abstract val runningCommitments: IncrementalCommitmentStore
  15. abstract def searchComputedBetween(start: CantonTimestamp, end: CantonTimestamp, counterParticipant: Option[ParticipantId] = None)(implicit traceContext: TraceContext): Future[Iterable[(CommitmentPeriod, ParticipantId, CommitmentType)]]

    Inspection: search computed commitments applicable to the specified period (start/end are inclusive)

    Inspection: search computed commitments applicable to the specified period (start/end are inclusive)

    Definition Classes
    AcsCommitmentLookup
  16. abstract def searchReceivedBetween(start: CantonTimestamp, end: CantonTimestamp, counterParticipant: Option[ParticipantId] = None)(implicit traceContext: TraceContext): Future[Iterable[SignedProtocolMessage[AcsCommitment]]]

    Inspection: search received commitments applicable to the specified period (start/end are inclusive)

    Inspection: search received commitments applicable to the specified period (start/end are inclusive)

    Definition Classes
    AcsCommitmentLookup
  17. abstract def storeComputed(period: CommitmentPeriod, counterParticipant: ParticipantId, commitment: CommitmentType)(implicit traceContext: TraceContext): Future[Unit]

    Store a locally computed ACS commitment.

    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.

  18. abstract def storeReceived(commitment: SignedProtocolMessage[AcsCommitment])(implicit traceContext: TraceContext): Future[Unit]

    Store a received ACS commitment.

    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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def prune(limit: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, AcsCommitmentStoreError, Unit]

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

    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.

    Definition Classes
    PrunableByTime
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AutoCloseable

Inherited from AcsCommitmentLookup

Inherited from AnyRef

Inherited from Any

Ungrouped