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.
- Alphabetic
- By Inheritance
- Sequencer
- NamedLogging
- HasCloseContext
- PromiseUnlessShutdownFactory
- AtomicHealthElement
- CloseableHealthQuasiComponent
- HealthQuasiComponent
- CloseableHealthElement
- HealthElement
- FlagCloseable
- PerformUnlessClosing
- HasSynchronizeWithReaders
- HasSynchronizeWithClosing
- OnShutdownRunner
- HasRunOnClosing
- HasUnlessClosing
- AutoCloseable
- SequencerPruning
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type State = SequencerHealthStatus
The type of health states exposed by this component
The type of health states exposed by this component
- Definition Classes
- Sequencer → HealthQuasiComponent → HealthElement
Abstract Value Members
- abstract def acknowledgeSigned(signedAcknowledgeRequest: SignedContent[AcknowledgeRequest])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, 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
- abstract def adminStatus: SequencerAdminStatus
Status relating to administrative sequencer operations.
- abstract def awaitContainingBlockLastTimestamp(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SequencerError, CantonTimestamp]
Return the last timestamp of the containing block of the provided timestamp.
Return the last timestamp of the containing block of the provided timestamp. This is needed to determine the effective timestamp to observe in topology processing, required to produce a correct snapshot.
- abstract def awaitSnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SequencerError, SequencerSnapshot]
Wait for and return the sequencer snapshot that contains the provided timestamp.
- abstract def disableMember(member: Member)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SequencerAdministrationError, 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.
- abstract def findPruningTimestamp(index: PositiveInt)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, 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
- abstract def getTrafficStateAt(member: Member, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TrafficNotFound, Option[TrafficState]]
Return the traffic state of a member at a given timestamp.
- abstract def isEnabled(member: Member)(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]
True if registered member has not been disabled.
- abstract def isRegistered(member: Member)(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]
True if member is registered in sequencer persistent state / storage (i.e.
True if member is registered in sequencer persistent state / storage (i.e. database).
- abstract def loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- NamedLogging
- abstract def prune(requestedTimestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, 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
- abstract def pruningStatus(implicit traceContext: TraceContext): FutureUnlessShutdown[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
- abstract def read(member: Member, timestampInclusive: Option[CantonTimestamp])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CreateSubscriptionError, SequencedEventSource]
- 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
- abstract def sendAsyncSigned(signedSubmission: SignedContent[SubmissionRequest])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SequencerDeliverError, Unit]
- abstract def setTrafficPurchased(member: Member, serial: PositiveInt, totalTrafficPurchased: NonNegativeLong, sequencerClient: SequencerClientSend, synchronizerTimeTracker: SynchronizerTimeTracker)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TrafficControlError, Unit]
Sets the traffic purchased of a member to the new provided value.
Sets the traffic purchased of a member to the new provided value. This will only become effective if / when properly authorized by enough sequencers according to the synchronizer owners threshold.
- abstract def snapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SequencerError, 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.
- abstract def timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- FlagCloseable
- abstract def trafficStatus(members: Seq[Member], selector: TimestampSelector)(implicit traceContext: TraceContext): FutureUnlessShutdown[SequencerTrafficStatus]
Return the latest known status of the specified members, either at wall clock time of this sequencer or latest known sequenced event, whichever is the most recent.
Return the latest known status of the specified members, either at wall clock time of this sequencer or latest known sequenced event, whichever is the most recent. This method should be used for information purpose only and not to get a deterministic traffic state as the state will depend on current time. To get the state at a specific timestamp, use getTrafficStateAt instead. If the list is empty, return the status of all members. Requested members who are not registered in the Sequencer will not be in the response. Registered members with no sent or received event will return an empty status.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- def adminServices: Seq[ServerServiceDefinition]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def associatedHasRunOnClosing: FlagCloseable
The com.digitalasset.canton.lifecycle.HasRunOnClosing associated with this object.
The com.digitalasset.canton.lifecycle.HasRunOnClosing associated with this object.
When this com.digitalasset.canton.lifecycle.HasRunOnClosing closes, the health state permanently becomes closingState and all listeners are notified about this.
- Attributes
- protected
- Definition Classes
- CloseableHealthElement → HealthElement
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- 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
- FlagCloseable → OnShutdownRunner → AutoCloseable
- implicit val closeContext: CloseContext
- Definition Classes
- HasCloseContext
- def closingState: SequencerHealthStatus
The state set when the associatedHasRunOnClosing closes
The state set when the associatedHasRunOnClosing closes
- Definition Classes
- Sequencer → HealthQuasiComponent → HealthElement
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def getState: State
Returns the current state
Returns the current state
- Definition Classes
- HealthElement
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def initialHealthState: SequencerHealthStatus
The initial state upon creation
The initial state upon creation
- Definition Classes
- Sequencer → HealthElement
- 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 → HasUnlessClosing
- def isDegraded: Boolean
- Definition Classes
- HealthQuasiComponent
- def isFailed: Boolean
- Definition Classes
- HealthQuasiComponent
- def isFatal: Boolean
- Definition Classes
- HealthQuasiComponent
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isOk: Boolean
- Definition Classes
- HealthQuasiComponent
- def keepTrackOfReaderCallStack: Boolean
Set this to true to get detailed information about all futures that did not complete during shutdown.
Set this to true to get detailed information about all futures that did not complete during shutdown.
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext): 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 usetrySuccess
. The reason is that the call tosuccess
may fail in case of shutdown.- Definition Classes
- PromiseUnlessShutdownFactory
- val name: String
Name of the health element.
Name of the health element. Used for logging.
- Definition Classes
- Sequencer → HealthElement
- def nameInternal: String
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def onClosed(): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- 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
- PerformUnlessClosing → OnShutdownRunner
- def prettyState: Pretty[State]
- Attributes
- protected
- Definition Classes
- HealthQuasiComponent → HealthElement
- def pruningScheduler: Option[PruningScheduler]
- Definition Classes
- SequencerPruning
- def pruningSchedulerBuilder: Option[(Storage) => PruningScheduler]
Builds a pruning scheduler once storage is available
Builds a pruning scheduler once storage is available
- Definition Classes
- SequencerPruning
- def rateLimitManager: Option[SequencerRateLimitManager]
Return the rate limit manager for this sequencer, if it exists.
- 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 thenewState
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
- def registerHighPriorityOnHealthChange(listener: HealthListener): Boolean
Registers a high priority listener that gets poked upon each change of this element's health state.
Registers a high priority listener that gets poked upon each change of this element's health state. This listener will be run before listeners registered via registerOnHealthChange
- returns
Whether the listener was not registered before
- Definition Classes
- HealthElement
- def registerOnHealthChange(listener: HealthListener, pokeIfNew: Boolean = true): 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.
- pokeIfNew
if true (default), poke the listener if it's new
- returns
Whether the listener was not registered before
- Definition Classes
- HealthElement
- def remainingReaders(): Seq[String]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- def removeReader(handle: ReaderHandle): Unit
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- 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
- def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]
Schedules the given task to be run upon closing.
Schedules the given task to be run upon closing.
- returns
An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the
LifeCycleManager
'scloseAsync
method completes or whenAutoCloseable
'sclose
method returns, unless the returnedLifeCycleRegistrationHandle
was used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.
- Definition Classes
- OnShutdownRunner → HasRunOnClosing
- def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle
Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.
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
'scloseAsync
method completes orAutoCloseable
'sclose
returns. This is because the task is run immediately if the component has already been closed.- Definition Classes
- HasRunOnClosing
- final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
- Definition Classes
- HasRunOnClosing
- def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
- Attributes
- protected[this]
- Definition Classes
- OnShutdownRunner → HasRunOnClosing
- def stateLoggingLevel(state: State): Level
- Attributes
- protected
- Definition Classes
- HealthElement
- def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]
Runs the computation
f
only if the component is not yet closing.Runs the computation
f
only if the component is not yet closing. If so, the component will delay releasing its resources untilf
has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as part off
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- returns
The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
f
has not run. Otherwise it is the result of runningf
.
- Definition Classes
- HasSynchronizeWithClosing
- See also
HasRunOnClosing.isClosing
- def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Convenience method for synchronizing on
Future
s instead ofFutureUnlessShutdown
s.Convenience method for synchronizing on
Future
s instead ofFutureUnlessShutdown
s. Equivalent tosynchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
- Definition Classes
- PerformUnlessClosing
- def synchronizeWithClosingPatience: FiniteDuration
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Runs the computation
f
only if the component is not yet closing.Runs the computation
f
only if the component is not yet closing. If so, the component will delay releasing its resources untilf
has finished or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as part off
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- returns
com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
f
has not run.
- Definition Classes
- HasSynchronizeWithClosing
- Annotations
- @SuppressWarnings()
- See also
HasRunOnClosing.isClosing
- def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
Runs the computation
f
only if the component is not yet closing.Runs the computation
f
only if the component is not yet closing. If so, the component will delay releasing its resources untilf
has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as part off
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- returns
com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
f
has not run. Otherwise the result of runningf
.
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithClosing
- See also
HasRunOnClosing.isClosing
- def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toComponentStatus: ComponentStatus
- Definition Classes
- HealthQuasiComponent
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]
Runs the computation
fa
unless isClosing returns true.Runs the computation
fa
unless isClosing returns true.This method does not delay the closing while
fa
is running, unlike the methods inHasSynchronizeWithClosing
. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.- returns
The result of
fa
or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true
- Definition Classes
- HasUnlessClosing
- Annotations
- @inline()
- def unregisterOnHealthChange(listener: HealthListener): Boolean
Unregisters a listener.
Unregisters a listener.
- returns
Whether the listener was registered before.
- Definition Classes
- HealthElement
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders