trait SequencerBlockStore extends AutoCloseable
- Alphabetic
- By Inheritance
- SequencerBlockStore
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def close(): Unit
- Definition Classes
- AutoCloseable
- Annotations
- @throws(classOf[java.lang.Exception])
- abstract def executionContext: ExecutionContext
- Attributes
- protected
- abstract def finalizeBlockUpdate(block: BlockInfo)(implicit traceContext: TraceContext): Future[Unit]
Finalizes the current block whose updates have been added in the calls to partialBlockUpdate since the last call to finalizeBlockUpdate.
Finalizes the current block whose updates have been added in the calls to partialBlockUpdate since the last call to finalizeBlockUpdate.
This method must not be called concurrently with itself or partialBlockUpdate, and must be called for the blocks in monotonically increasing order of height.
- block
The block information about the current block. It is the responsibility of the caller to ensure that the height increases monotonically by one
- abstract def getInitialState(implicit traceContext: TraceContext): Future[BlockEphemeralState]
Get initial state from which this sequencer node supports serving requests.
Get initial state from which this sequencer node supports serving requests. The member counters returned as part of this initial state indicate the minimum counters that this sequencer supports serving requests from. If a member is not included in these counters, it means that this sequencer node supports serving requests from the com.digitalasset.canton.data.CounterCompanion.Genesis for that member.
- abstract def getInitialTopologySnapshotTimestamp(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]
Retrieve the timestamp of the initial topology snapshot if available.
- abstract def partialBlockUpdate(newMembers: MemberTimestamps, events: Seq[MemberSignedEvents], acknowledgments: MemberTimestamps, membersDisabled: Seq[Member], trafficState: Map[Member, TrafficState])(implicit traceContext: TraceContext): Future[Unit]
Stores some updates that happen in a single block.
Stores some updates that happen in a single block. May be called several times for the same block and the same update may be contained in several of the calls. Before adding updates of a subsequent block, finalizeBlockUpdate must be called to wrap up the current block.
This method must not be called concurrently with itself or finalizeBlockUpdate.
- abstract def prune(requestedTimestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[String]
- abstract def pruningStatus()(implicit traceContext: TraceContext): Future[InternalSequencerPruningStatus]
- abstract def readHead(implicit traceContext: TraceContext): Future[BlockEphemeralState]
The current state of the sequencer, which can be used when the node is restarted to deterministically derive the following counters and timestamps.
The current state of the sequencer, which can be used when the node is restarted to deterministically derive the following counters and timestamps.
The state excludes updates of unfinalized blocks added with partialBlockUpdate.
- abstract def readRange(member: Member, startInclusive: SequencerCounter, endExclusive: SequencerCounter)(implicit traceContext: TraceContext): Source[OrdinarySerializedEvent, NotUsed]
Serve events (or tombstones) for member with the given counter range.
Serve events (or tombstones) for member with the given counter range.
The returned range may include events added with partialBlockUpdate even before the corresponding block has been finalized with finalizeBlockUpdate. This ensures that com.digitalasset.canton.sequencing.client.SequencerClients can immediately read events when they are added. In particular, the sequencer's com.digitalasset.canton.topology.client.DomainTopologyClient will see such updates so that block processing can request a com.digitalasset.canton.topology.client.TopologySnapshot that includes the updates in a block while processing continues for the same block.
- abstract def readStateForBlockContainingTimestamp(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, InvalidTimestamp, BlockEphemeralState]
The state at the end of the block that contains the given timestamp.
The state at the end of the block that contains the given timestamp. This will typically be used to inform other sequencer nodes being initialized of the initial state they should use based on the timestamp they provide which is typically the timestamp of their signing key.
- abstract def setInitialState(initial: BlockEphemeralState = BlockEphemeralState.empty, maybeOnboardingTopologyEffectiveTimestamp: Option[CantonTimestamp] = None)(implicit traceContext: TraceContext): Future[Unit]
Set initial state of the sequencer node from which it supports serving requests.
Set initial state of the sequencer node from which it supports serving requests. This should be called at most once. If not called, it means this sequencer node can server requests from genesis.
- abstract def updateMemberCounterSupportedAfter(member: Member, counterLastUnsupported: SequencerCounter)(implicit traceContext: TraceContext): Future[Unit]
Updates the last unsupported member sequencer counter, i.e.
Updates the last unsupported member sequencer counter, i.e. the one just before the first supported sequencer counter. Only ever increases counter.
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def blockInvariant(topologyClientMember: Member, currentBlock: BlockInfo, prevBlockO: Option[BlockInfo], allEventsInBlock: Map[Member, NonEmpty[Seq[OrdinarySerializedEvent]]], newMembersInBlock: Iterable[(Member, CantonTimestamp)])(implicit traceContext: TraceContext): Unit
Check the invariant for a block in the store:
Check the invariant for a block in the store:
- If the previous block is defined, then its block height is
currentBlock.height - 1. - If the previous block is defined, then its com.digitalasset.canton.domain.block.data.BlockInfo.lastTs of the the com.digitalasset.canton.domain.block.data.BlockEphemeralState is no later than the one of the current block. If there are neither events nor registrations in the current block, the two are equal.
- If the previous block is defined, the com.digitalasset.canton.domain.block.data.BlockInfo.latestTopologyClientTimestamp of the its com.digitalasset.canton.domain.block.data.BlockEphemeralState is no later than the one of the current block. In particular, if com.digitalasset.canton.domain.block.data.BlockInfo.latestTopologyClientTimestamp is defined in the previous block, then so is it in the successor block. If it is defined in the successor block, then it is the same as in the predecessor block unless the block contains events addressed to the sequencer's topology client.
- All events and member registrations in the current block are ealier or equal to the blocks' com.digitalasset.canton.domain.block.data.BlockInfo.lastTs. com.digitalasset.canton.domain.block.data.BlockInfo.lastTs is equal to the latest timestamp of an event or member registration in the block, unless the previous block is undefined and the block contains member registrations.
- All events in the block addressed to the
topologyClientMemberhave timestamps of at most com.digitalasset.canton.domain.block.data.BlockInfo.latestTopologyClientTimestamp of the current block.
- topologyClientMember
The member under whom the sequencer's topology client subscribes
- currentBlock
The block info of the current block
- prevBlockO
The block info of the block preceding the
currentBlock, unless the current block is the initial state- allEventsInBlock
All events in the current block
- newMembersInBlock
All member registrations that happened in the block i.e., at
currentBlock's com.digitalasset.canton.domain.block.data.BlockInfo.lastTs.
- Attributes
- protected
- Exceptions thrown
java.lang.IllegalStateExceptionif the invariant is violated
- If the previous block is defined, then its block height is
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])