Packages

final class VmbcSequencer extends BaseSequencer with NamedLogging with FlagCloseable

A sequencer in early stages of development that will run the core sequencing logic on the VMware Blockchain.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VmbcSequencer
  2. FlagCloseable
  3. BaseSequencer
  4. Spanning
  5. NamedLogging
  6. Sequencer
  7. AutoCloseable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new VmbcSequencer(config: VmbcSequencerConfig, domainId: DomainId, cryptoApi: SyncCryptoClient, timeouts: ProcessingTimeout, store: SequencerBlockStore, protocolVersion: ProtocolVersion, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext, materializer: Materializer, trace: Tracer)

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable

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. 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.

    Definition Classes
    VmbcSequencerSequencer
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. 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
    VmbcSequencerSequencer
  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
    FlagCloseable → AutoCloseable
    Annotations
    @SuppressWarnings()
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  10. 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
    VmbcSequencerSequencer
  11. 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
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def health(implicit traceContext: TraceContext): Future[SequencerHealthStatus]

    Return a structure indicating the health status of the sequencer implementation.

    Return a structure indicating the health status of the sequencer implementation. Should succeed even if the configured datastore is unavailable.

    Definition Classes
    BaseSequencerSequencer
  17. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  18. 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
    FlagCloseable
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. 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
    VmbcSequencerSequencer
  21. def isRegistered(member: Member)(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    VmbcSequencerSequencer
  22. 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
    FlagCloseable
  23. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  24. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    BaseSequencerNamedLoggingSequencer
  25. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. def onClosed(): Unit
    Definition Classes
    VmbcSequencerFlagCloseable
  32. 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
    FlagCloseable
  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
    FlagCloseable
  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
    FlagCloseable
  35. 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
    FlagCloseable
  36. 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).

    Definition Classes
    VmbcSequencerSequencer
  37. 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
    VmbcSequencerSequencer
  38. def read(member: Member, offset: SequencerCounter)(implicit traceContext: TraceContext): EitherT[Future, CreateSubscriptionError, EventSource]
    Definition Classes
    BaseSequencerSequencer
  39. def readInternal(member: Member, offset: SequencerCounter)(implicit traceContext: TraceContext): EitherT[Future, CreateSubscriptionError, EventSource]
    Attributes
    protected
    Definition Classes
    VmbcSequencerBaseSequencer
  40. def registerMember(member: Member)(implicit traceContext: TraceContext): EitherT[Future, SequencerWriteError[RegisterMemberError], Unit]
    Definition Classes
    VmbcSequencerSequencer
  41. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Definition Classes
    FlagCloseable
  42. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  43. def sendAsync(submission: SubmissionRequest)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncError, Unit]
    Definition Classes
    BaseSequencerSequencer
  44. def sendAsyncInternal(submission: SubmissionRequest)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncError, Unit]
    Attributes
    protected
    Definition Classes
    VmbcSequencerBaseSequencer
  45. 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
    VmbcSequencerSequencer
  46. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  47. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    VmbcSequencerFlagCloseable
  48. def toString(): String
    Definition Classes
    AnyRef → Any
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. def withNewTrace[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit tracer: Tracer): A
    Attributes
    protected
    Definition Classes
    Spanning
  53. def withSpan[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit traceContext: TraceContext, tracer: Tracer): A
    Attributes
    protected
    Definition Classes
    Spanning
  54. def withSpanFromGrpcContext[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit tracer: Tracer): A
    Attributes
    protected
    Definition Classes
    Spanning
  55. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable

Deprecated Value Members

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

Inherited from FlagCloseable

Inherited from BaseSequencer

Inherited from Spanning

Inherited from NamedLogging

Inherited from Sequencer

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped