Packages

trait Sequencer extends SequencerPruning with CloseableHealthQuasiComponent with AtomicHealthElement with HasCloseContext with NamedLogging

Interface for sequencer operations. The default DatabaseSequencer implementation is backed by a database run by a single operator. Other implementations support operating a Sequencer on top of third party ledgers or other infrastructure.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Sequencer
  2. NamedLogging
  3. HasCloseContext
  4. PromiseUnlessShutdownFactory
  5. AtomicHealthElement
  6. CloseableHealthQuasiComponent
  7. HealthQuasiComponent
  8. CloseableHealthElement
  9. HealthElement
  10. FlagCloseable
  11. PerformUnlessClosing
  12. OnShutdownRunner
  13. AutoCloseable
  14. SequencerPruning
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type State = SequencerHealthStatus

    The type of health states exposed by this component

    The type of health states exposed by this component

    Definition Classes
    SequencerHealthQuasiComponentHealthElement

Abstract Value Members

  1. abstract def acknowledge(member: Member, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]

    Acknowledge that a member has successfully handled all events up to and including the timestamp provided.

    Acknowledge that a member has successfully handled all events up to and including the timestamp provided. Makes earlier events for this member available for pruning. The timestamp is in sequencer time and will likely correspond to an event that the client has processed however this is not validated. It is assumed that members in consecutive calls will never acknowledge an earlier timestamp however this is also not validated (and could be invalid if the member has many subscriptions from the same or many processes). It is expected that members will periodically call this endpoint with their latest clean timestamp rather than calling it for every event they process. The default interval is in the range of once a minute.

    A member should only acknowledge timestamps it has actually received. The behaviour of the sequencer is implementation-defined when a member acknowledges a later timestamp.

    Definition Classes
    SequencerPruning
    See also

    com.digitalasset.canton.sequencing.client.SequencerClientConfig.acknowledgementInterval for the default interval

  2. abstract def acknowledgeSigned(signedAcknowledgeRequest: SignedContent[AcknowledgeRequest])(implicit traceContext: TraceContext): EitherT[Future, String, Unit]

    Newer version of acknowledgements.

    Newer version of acknowledgements. To be active for protocol versions >= 4. The signature is checked on the server side to avoid that malicious sequencers create fake acknowledgements in multi-writer architectures where writers don't fully trust each other.

    Acknowledge that a member has successfully handled all events up to and including the timestamp provided. Makes earlier events for this member available for pruning. The timestamp is in sequencer time and will likely correspond to an event that the client has processed however this is not validated. It is assumed that members in consecutive calls will never acknowledge an earlier timestamp however this is also not validated (and could be invalid if the member has many subscriptions from the same or many processes). It is expected that members will periodically call this endpoint with their latest clean timestamp rather than calling it for every event they process. The default interval is in the range of once a minute.

    A member should only acknowledge timestamps it has actually received. The behaviour of the sequencer is implementation-defined when a member acknowledges a later timestamp.

    Definition Classes
    SequencerPruning
    See also

    com.digitalasset.canton.sequencing.client.SequencerClientConfig.acknowledgementInterval for the default interval

  3. abstract def authorizeLedgerIdentity(identity: LedgerIdentity)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]

    Currently this method is only implemented by the enterprise-only Ethereum driver.

    Currently this method is only implemented by the enterprise-only Ethereum driver. It immediately returns a Left for ledgers where it is not implemented.

    This method authorizes a com.digitalasset.canton.domain.sequencing.sequencer.LedgerIdentity on the underlying ledger. In the Ethereum-backed ledger, this enables the given Ethereum account to also write to the deployed Sequencer.sol contract. Therefore, this method needs to be called before being able to use an Ethereum sequencer with a given Ethereum account.

    NB: in Ethereum, this method needs to be called by an Ethereum sequencer whose associated Ethereum account is already authorized. Else the authorization itself will fail. To bootstrap the authorization, the Ethereum account that deploys the Sequencer.sol contract is the first account to be authorized.

  4. abstract def disableMember(member: Member)(implicit traceContext: TraceContext): Future[Unit]

    Disable the provided member.

    Disable the provided member. Should prevent them from reading or writing in the future (although they can still be addressed). Their unread data can also be pruned. Effectively disables all instances of this member.

  5. abstract def isLedgerIdentityRegistered(identity: LedgerIdentity)(implicit traceContext: TraceContext): Future[Boolean]

    Always returns false for Sequencer drivers that don't support ledger identity authorization.

    Always returns false for Sequencer drivers that don't support ledger identity authorization. Otherwise returns whether the given ledger identity is registered on the underlying ledger (and configured smart contract).

  6. abstract def isRegistered(member: Member)(implicit traceContext: TraceContext): Future[Boolean]
  7. abstract def locatePruningTimestamp(index: PositiveInt)(implicit traceContext: TraceContext): EitherT[Future, PruningSupportError, Option[CantonTimestamp]]

    Locate a timestamp relative to the earliest available sequencer event based on an index starting at one.

    Locate a timestamp relative to the earliest available sequencer event based on an index starting at one.

    When index == 1, indicates the progress of pruning as the timestamp of the oldest unpruned response When index > 1, returns the timestamp of the index'th oldest response which is useful for pruning in batches when index == batchSize.

    Definition Classes
    SequencerPruning
  8. abstract def loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    NamedLogging
  9. abstract def prune(requestedTimestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, PruningError, String]

    Prune as much sequencer data as safely possible without breaking operation (except for members that have been previously flagged as disabled).

    Prune as much sequencer data as safely possible without breaking operation (except for members that have been previously flagged as disabled). Sequencers are permitted to prune to an earlier timestamp if required to for their own consistency. For example, the Database Sequencer will adjust this time to a potentially earlier point in time where counter checkpoints are available for all members (who aren't being ignored).

    Implementations that support pruning also update the "oldest-response-age" metric if pruning succeeds.

    Definition Classes
    SequencerPruning
  10. abstract def pruningStatus(implicit traceContext: TraceContext): Future[SequencerPruningStatus]

    Return a structure containing the members registered with the sequencer and the latest positions of clients reading events.

    Return a structure containing the members registered with the sequencer and the latest positions of clients reading events.

    Definition Classes
    SequencerPruning
  11. abstract def read(member: Member, offset: SequencerCounter)(implicit traceContext: TraceContext): EitherT[Future, CreateSubscriptionError, EventSource]
  12. abstract def registerMember(member: Member)(implicit traceContext: TraceContext): EitherT[Future, SequencerWriteError[RegisterMemberError], Unit]
  13. abstract def reportMaxEventAgeMetric(oldestEventTimestamp: Option[CantonTimestamp]): Either[PruningSupportError, Unit]

    Report the max-event-age metric based on the oldest event timestamp and the current clock time or zero if no oldest timestamp exists (e.g.

    Report the max-event-age metric based on the oldest event timestamp and the current clock time or zero if no oldest timestamp exists (e.g. events fully pruned).

    Definition Classes
    SequencerPruning
  14. abstract def sendAsync(submission: SubmissionRequest)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncError, Unit]
  15. abstract def sendAsyncSigned(signedSubmission: SignedContent[SubmissionRequest])(implicit traceContext: TraceContext): EitherT[Future, SendAsyncError, Unit]
  16. abstract def snapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, String, SequencerSnapshot]

    Return a snapshot state that other newly onboarded sequencers can use as an initial state from which to support serving events.

    Return a snapshot state that other newly onboarded sequencers can use as an initial state from which to support serving events. This state depends on the provided timestamp and will contain registered members, counters per member, latest timestamp (which will be greater than or equal to the provided timestamp) as well as a sequencer implementation specific piece of information such that all together form the point after which the new sequencer can safely operate. The provided timestamp is typically the timestamp of the requesting sequencer's private key, which is the point in time where it can effectively sign events.

  17. abstract def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    FlagCloseable
  18. abstract def trafficStatus(members: Seq[Member])(implicit traceContext: TraceContext): Future[SequencerTrafficStatus]

    Return the status of the specified members.

    Return the status of the specified members. If the list is empty, return the status of all members.

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. final def associatedOnShutdownRunner: FlagCloseable

    The com.digitalasset.canton.lifecycle.OnShutdownRunner associated with this object.

    The com.digitalasset.canton.lifecycle.OnShutdownRunner associated with this object.

    When this com.digitalasset.canton.lifecycle.OnShutdownRunner closes, the health state permanently becomes closingState and all listeners are notified about this.

    Attributes
    protected
    Definition Classes
    CloseableHealthElementHealthElement
  6. 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
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. 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
  9. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  10. def closingState: SequencerHealthStatus

    The state set when the associatedOnShutdownRunner closes

    The state set when the associatedOnShutdownRunner closes

    Definition Classes
    SequencerHealthQuasiComponentHealthElement
  11. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  12. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  13. def ensureRegistered(member: Member)(implicit executionContext: ExecutionContext, traceContext: TraceContext): EitherT[Future, SequencerWriteError[RegisterMemberError], Unit]

    First check is the member is registered and if not call registerMember

  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def getState: State

    Returns the current state

    Returns the current state

    Definition Classes
    HealthElement
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def initialHealthState: SequencerHealthStatus

    The initial state upon creation

    The initial state upon creation

    Definition Classes
    SequencerHealthElement
  21. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  22. def isClosing: Boolean

    Check whether we're closing.

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

    Definition Classes
    OnShutdownRunner
  23. def isFailed: Boolean
    Definition Classes
    HealthQuasiComponent
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. 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
  26. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. 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
  28. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.

    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.

    Definition Classes
    PromiseUnlessShutdownFactory
  29. val name: String

    Name of the health element.

    Name of the health element. Used for logging.

    Definition Classes
    SequencerHealthElement
  30. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  36. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  37. 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()
  38. 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
  39. 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
  40. 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
  41. 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
  42. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  43. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  44. 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
  45. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  46. def prettyState: Pretty[State]
    Attributes
    protected
    Definition Classes
    HealthQuasiComponentHealthElement
  47. def pruningScheduler: Option[PruningScheduler]
    Definition Classes
    SequencerPruning
  48. def pruningSchedulerBuilder: Option[(Storage) => PruningScheduler]

    Builds a pruning scheduler once storage is available

    Builds a pruning scheduler once storage is available

    Definition Classes
    SequencerPruning
  49. def refreshState(newState: Eval[State])(implicit traceContext: TraceContext): Unit

    Triggers a refresh of the component's state, using newState to determine the new state.

    Triggers a refresh of the component's state, using newState to determine the new state. May return before the newState has been evaluated and the listeners have been poked.

    Note that listeners need not be poked about every state change; it suffices that they are poked eventually after each state change. So if there are frequent updates to the state, possibly from concurrent calls, then the listeners may never see some intermediate states.

    Attributes
    protected
    Definition Classes
    HealthElement
  50. def registerOnHealthChange(listener: HealthListener): Boolean

    Registers a listener that gets poked upon each change of this element's health state.

    Registers a listener that gets poked upon each change of this element's health state.

    returns

    Whether the listener was not registered before

    Definition Classes
    HealthElement
  51. def reportHealthState(state: State)(implicit tc: TraceContext): Unit

    Sets the state of this component and notifies its listeners

    Sets the state of this component and notifies its listeners

    Definition Classes
    AtomicHealthElement
  52. 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
  53. 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
  54. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  55. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  56. def toComponentStatus: ComponentStatus
    Definition Classes
    HealthQuasiComponent
  57. def toString(): String
    Definition Classes
    AnyRef → Any
  58. def trafficStates: Future[Map[Member, TrafficState]]

    Return the full traffic state of all known members.

    Return the full traffic state of all known members. This should not be exposed externally as is as it contains information not relevant to external consumers. Use trafficStatus instead.

  59. def unregisterOnHealthChange(listener: HealthListener): Boolean

    Unregisters a listener.

    Unregisters a listener.

    returns

    Whether the listener was registered before.

    Definition Classes
    HealthElement
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  62. 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 HasCloseContext

Inherited from AtomicHealthElement

Inherited from HealthQuasiComponent

Inherited from CloseableHealthElement

Inherited from HealthElement

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from SequencerPruning

Inherited from AnyRef

Inherited from Any

Ungrouped