class AcsCommitmentProcessor extends AcsChangeListener with FlagCloseable with NamedLogging

Computes, sends, receives and compares ACS commitments

In more detail:

  • The class computes the participant's ACS commitments (for each of the participant's "counter-participants", i.e., participants who host a stakeholder of some contract in participant's ACS). The commitments are computed at specified (sequencer) times that are configured by the domain and are uniform for all participants connected to the domain. We refer to them as "commitment ticks". The commitments must be computed "online", i.e., after the the state of the ACS at a commitment tick becomes known.
  • After the commitments for a tick are computed, they should be distributed to the counter-participants; but this is best-effort.
  • The class processes the ACS commitments from counter-participants (method processBatch):
  • it checks that the commitments are properly signed
  • it checks that they match the locally computed ACS commitments
  • The class must define crash recovery points, such that the class itself combined with startup procedures of the node jointly ensure that the participant doesn't neglect to send its ACS commitments or process the remote ones. We allow the participant to send the same commitments multiple times in case of a crash, and we do allow the participant to not send some commitments in some edge cases due to crashes.
  • Finally, the class supports pruning: it computes the safe timestamps for participant pruning, such that, after pruning, non-repudiation still holds for any contract in the ACS

The first four pieces of class functionality must be appropriately synchronized:

  • ACS commitments for a tick cannot be completely processed before the local commitment for that tick is computed. Note that the class cannot make many assumptions on the received commitments: the counter-participants can send them in any order, and they can either precede or lag behind the local commitment computations.
  • The recovery points must be chosen such that the participant computes its local commitments correctly, and never misses to compute a local commitment for every tick. Otherwise, the participant will start raising false alarms when remote commitments are received (either because it computes the wrong thing, or because it doesn't compute anything at all and thus doesn't expect to receive anything).

Additionally, the startup procedure must ensure that:

Finally, the class requires the reconciliation interval to be a multiple of 1 second.

The commitmentPeriodObserver is called whenever a commitment is computed for a period, except if the participant crashes. If publish is called multiple times for the same timestamp (once before a crash and once after the recovery), the observer may also be called twice for the same period.

When a participant's ACS commitment processor falls behind some counter participants' processors, the participant has the option to enter a so-called "catch-up mode". In catch-up mode, the participant skips sending and checking commitments for some reconciliation intervals. The parameter governing catch-up mode is:

Annotations
@SuppressWarnings()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AcsCommitmentProcessor
  2. NamedLogging
  3. FlagCloseable
  4. PerformUnlessClosing
  5. OnShutdownRunner
  6. AutoCloseable
  7. AcsChangeListener
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AcsCommitmentProcessor(domainId: DomainId, participantId: ParticipantId, sequencerClient: SequencerClient, domainCrypto: SyncCryptoClient[SyncCryptoApi], sortedReconciliationIntervalsProvider: SortedReconciliationIntervalsProvider, store: AcsCommitmentStore, pruningObserver: (TraceContext) => Unit, metrics: PruningMetrics, protocolVersion: ProtocolVersion, timeouts: ProcessingTimeout, futureSupervisor: FutureSupervisor, activeContractStore: ActiveContractStore, contractStore: ContractStore, enableAdditionalConsistencyChecks: Boolean, loggerFactory: NamedLoggerFactory, testingConfig: TestingConfigInternal)(implicit ec: ExecutionContext)

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 cancelShutdownTask(token: Long): Unit

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Definition Classes
    OnShutdownRunner
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. final def close(): Unit

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

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

    Definition Classes
    FlagCloseableOnShutdownRunner → AutoCloseable
  8. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    AcsCommitmentProcessorFlagCloseablePerformUnlessClosing
  9. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. def initializeTicksOnStartup(timestamps: List[EffectiveTime])(implicit traceContext: TraceContext): Unit
  16. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  17. def isClosing: Boolean

    Check whether we're closing.

    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.

    Definition Classes
    OnShutdownRunner
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def keepTrackOfOpenFutures: Boolean

    track running futures on shutdown

    track running futures on shutdown

    set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  20. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    AcsCommitmentProcessorNamedLogging
  22. def maxSleepMillis: Long

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

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

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  23. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  28. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  29. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    AcsCommitmentProcessorPerformUnlessClosing
  30. final def onFirstClose(): Unit

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

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

    Definition Classes
    PerformUnlessClosingOnShutdownRunner
    Annotations
    @SuppressWarnings()
  31. def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Performs the task given by f unless a shutdown has been initiated.

    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.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    PerformUnlessClosing
  32. def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
    Definition Classes
    PerformUnlessClosing
  33. def performUnlessClosingEitherT[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead.

    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.

    etf

    The task to perform

    Definition Classes
    PerformUnlessClosing
  34. def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    PerformUnlessClosing
  35. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  36. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  37. def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Performs the Future given by f unless a shutdown has been initiated.

    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.

    f

    The task to perform

    returns

    The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.

    Definition Classes
    PerformUnlessClosing
  38. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  39. def processBatch(timestamp: CantonTimestamp, batch: Traced[List[OpenEnvelope[SignedProtocolMessage[AcsCommitment]]]]): FutureUnlessShutdown[Unit]
  40. def processBatchInternal(timestamp: CantonTimestamp, batch: List[OpenEnvelope[SignedProtocolMessage[AcsCommitment]]])(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    Process incoming commitments.

    Process incoming commitments.

    The caller(s) must jointly ensure that all incoming commitments are passed to this method, in their order of arrival. Upon startup, the method must be called on all incoming commitments whose processing hasn't finished yet, including those whose processing has been aborted due to shutdown.

    There is no special catch-up logic on the incoming queue, because processing was never a bottleneck here. However, the incoming queue is important because it gives us the condition to initiate catch-up by allowing us to look at the timestamp of received commitments. Should processing of incoming commitments become a bottleneck, we can do the following:

    • to quickly detect a possible catch-up condition, we validate incoming commitments (including signature) as they come and store them; the catch-up condition looks at the timestamp of incoming commitments in the queue
    • to enable match checks of local and remote commitments, in a separate thread continue processing the commitments by checking matches and buffering them if needed.
      • during catch-up, the processing order is first commitments at catch-up boundaries in increasing timestamp order, then other commitments in increasing timestamp order
      • outside catch-up, process commitments as they come
  41. def publish(toc: RecordTime, acsChange: AcsChange)(implicit traceContext: TraceContext): Unit

    ACS change notification.

    ACS change notification. Any response logic needs to happen in the background. The ACS change set may be empty, (e.g., in case of time proofs).

    toc

    time of the change

    acsChange

    active contract set change descriptor

    Definition Classes
    AcsCommitmentProcessorAcsChangeListener
  42. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Definition Classes
    OnShutdownRunner
  43. def runOnShutdown_[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task to run when shutdown is initiated.

    Register a task to run when shutdown is initiated.

    You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".

    Definition Classes
    OnShutdownRunner
  44. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  45. val runningCommitments: Future[RunningCommitments]
  46. def scheduleTopologyTick(effectiveTime: Traced[EffectiveTime]): Unit
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    AcsCommitmentProcessorFlagCloseable
  49. def toString(): String
    Definition Classes
    AnyRef → Any
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  52. 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
    Deprecated

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from AcsChangeListener

Inherited from AnyRef

Inherited from Any

Ungrouped