abstract class BaseSequencer extends Sequencer with NamedLogging with Spanning
Provides additional functionality that is common between sequencer implementations:
- auto registers unknown recipients addressed in envelopes from the domain topology manager (avoids explicit registration from the domain node -> sequencer which will be useful when separate processes)
- Alphabetic
- By Inheritance
- BaseSequencer
- Spanning
- Sequencer
- NamedLogging
- HasCloseContext
- PromiseUnlessShutdownFactory
- AtomicHealthElement
- CloseableHealthQuasiComponent
- HealthQuasiComponent
- CloseableHealthElement
- HealthElement
- FlagCloseable
- PerformUnlessClosing
- OnShutdownRunner
- AutoCloseable
- SequencerPruning
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new BaseSequencer(domainManagerId: DomainTopologyManagerId, loggerFactory: NamedLoggerFactory, healthConfig: Option[SequencerHealthConfig], clock: Clock, signatureVerifier: SignatureVerifier)(implicit executionContext: ExecutionContext, trace: Tracer)
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 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
- abstract def acknowledgeSignedInternal(signedAcknowledgeRequest: SignedContent[AcknowledgeRequest])(implicit traceContext: TraceContext): Future[Unit]
- Attributes
- protected
- abstract def adminStatus: SequencerAdminStatus
Status relating to administrative sequencer operations.
Status relating to administrative sequencer operations.
- Definition Classes
- Sequencer
- 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.- Definition Classes
- Sequencer
- 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.
- Definition Classes
- Sequencer
- abstract def healthInternal(implicit traceContext: TraceContext): Future[SequencerHealthStatus]
- Attributes
- protected
- 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).
- Definition Classes
- Sequencer
- abstract def isRegistered(member: Member)(implicit traceContext: TraceContext): Future[Boolean]
- Definition Classes
- Sequencer
- 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
- 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
- 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
- abstract def readInternal(member: Member, offset: SequencerCounter)(implicit traceContext: TraceContext): EitherT[Future, CreateSubscriptionError, EventSource]
- Attributes
- protected
- abstract def registerMember(member: Member)(implicit traceContext: TraceContext): EitherT[Future, SequencerWriteError[RegisterMemberError], Unit]
- Definition Classes
- Sequencer
- 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 sendAsyncInternal(submission: SubmissionRequest)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncError, Unit]
- Attributes
- protected
- abstract def sendAsyncSignedInternal(signedSubmission: SignedContent[SubmissionRequest])(implicit traceContext: TraceContext): EitherT[Future, SendAsyncError, Unit]
- Attributes
- protected
- 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.
- Definition Classes
- Sequencer
- abstract def timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- FlagCloseable
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 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
- BaseSequencer → SequencerPruning
- See also
com.digitalasset.canton.sequencing.client.SequencerClientConfig.acknowledgementInterval for the default interval
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- CloseableHealthElement → HealthElement
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- 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 associatedOnShutdownRunner closes
The state set when the associatedOnShutdownRunner closes
- Definition Classes
- Sequencer → HealthQuasiComponent → HealthElement
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
- def containsShutdownTask(token: Long): Boolean
- Definition Classes
- OnShutdownRunner
- 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
First check is the member is registered and if not call
registerMember
- Definition Classes
- Sequencer
- 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
- @native() @IntrinsicCandidate()
- final def getState: State
Returns the current state
Returns the current state
- Definition Classes
- HealthElement
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def initialHealthState: SequencerHealthStatus
The initial state upon creation
The initial state upon creation
- Definition Classes
- Sequencer → HealthElement
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- 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
- def isDegrading: 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 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
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- BaseSequencer → NamedLogging
- 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
- 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 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
- 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
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def onClosed(): Unit
- Definition Classes
- BaseSequencer → 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
- Annotations
- @SuppressWarnings()
- 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 afterf
completes, but other tasks may execute concurrently withf
, 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 off
, 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
- 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
- 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. Bothetf
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 afteretf
completes, but other tasks may execute concurrently withetf
, 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 ofetf
, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- PerformUnlessClosing
- 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
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- 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 afterf
completes, but other tasks may execute concurrently withf
, 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 off
, 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
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- PerformUnlessClosing
- val periodicHealthCheck: Option[PeriodicAction]
- 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 read(member: Member, offset: SequencerCounter)(implicit traceContext: TraceContext): EitherT[Future, CreateSubscriptionError, EventSource]
- Definition Classes
- BaseSequencer → Sequencer
- 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 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
- 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 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
- 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
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- OnShutdownRunner
- Annotations
- @VisibleForTesting()
- def sendAsync(submission: SubmissionRequest)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncError, Unit]
- Definition Classes
- BaseSequencer → Sequencer
- def sendAsyncSigned(signedSubmission: SignedContent[SubmissionRequest])(implicit traceContext: TraceContext): EitherT[Future, SendAsyncError, Unit]
- Definition Classes
- BaseSequencer → Sequencer
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toComponentStatus: ComponentStatus
- Definition Classes
- HealthQuasiComponent
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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.
- Definition Classes
- Sequencer
- 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]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withNewTrace[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit tracer: Tracer): A
- Attributes
- protected
- Definition Classes
- Spanning
- def withSpan[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit traceContext: TraceContext, tracer: Tracer): A
- Attributes
- protected
- Definition Classes
- Spanning
- def withSpanFromGrpcContext[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit tracer: Tracer): A
- Attributes
- protected
- Definition Classes
- Spanning