abstract class TopologyStore[+StoreID <: TopologyStoreId] extends AutoCloseable

Self Type
TopologyStore[StoreID] with NamedLogging
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopologyStore
  2. AutoCloseable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TopologyStore()(implicit ec: ExecutionContext)

Abstract Value Members

  1. abstract def allTransactions(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]
    Annotations
    @VisibleForTesting()
  2. abstract def close(): Unit
    Definition Classes
    AutoCloseable
    Annotations
    @throws(classOf[java.lang.Exception])
  3. abstract def currentDispatchingWatermark(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]

    returns the current dispatching watermark

    returns the current dispatching watermark

    for topology transaction dispatching, we keep track up to which point in time we have mirrored the authorized store to the remote store

    the timestamp always refers to the timestamp of the authorized store!

  4. abstract def findDispatchingTransactionsAfter(timestampExclusive: CantonTimestamp, limit: Option[Int] = None)(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]

    returns transactions that should be dispatched to the domain

  5. abstract def findInitialState(id: DomainTopologyManagerId)(implicit traceContext: TraceContext): Future[Map[KeyOwner, Seq[PublicKey]]]

    query interface used by DomainTopologyManager to find the set of initial keys

  6. abstract def findParticipantOnboardingTransactions(participantId: ParticipantId, domainId: DomainId)(implicit traceContext: TraceContext): Future[Seq[SignedTopologyTransaction[TopologyChangeOp]]]

    returns initial set of onboarding transactions that should be dispatched to the domain

  7. abstract def findPositiveTransactions(asOf: CantonTimestamp, asOfInclusive: Boolean, includeSecondary: Boolean, types: Seq[DomainTopologyTransactionType], filterUid: Option[Seq[UniqueIdentifier]], filterNamespace: Option[Seq[Namespace]])(implicit traceContext: TraceContext): Future[PositiveStoredTopologyTransactions]

    returns the set of positive transactions

    returns the set of positive transactions

    this function is used by the topology processor to determine the set of transaction, such that we can perform cascading updates if there was a certificate revocation

    asOfInclusive

    whether the search interval should include the current timepoint or not. the state at t is defined as "exclusive" of t, whereas for updating the state, we need to be able to query inclusive.

    includeSecondary

    some topology transactions have an "secondary" uid. currently, this only applies to the party to participant mapping where the secondary uid is the participant uid. we need this information during cascading updates of participant certificates.

  8. abstract def findPositiveTransactionsForMapping(mapping: TopologyMapping)(implicit traceContext: TraceContext): Future[Seq[SignedTopologyTransaction[Positive]]]
  9. abstract def findRemovalTransactionForMappings(mappings: Set[TopologyStateElement[TopologyMapping]])(implicit traceContext: TraceContext): Future[Seq[SignedTopologyTransaction[Remove]]]

    finds transactions in the local store that would remove the topology state elements

  10. abstract def findStateTransactions(asOf: CantonTimestamp, asOfInclusive: Boolean, includeSecondary: Boolean, types: Seq[DomainTopologyTransactionType], filterUid: Option[Seq[UniqueIdentifier]], filterNamespace: Option[Seq[Namespace]])(implicit traceContext: TraceContext): Future[PositiveStoredTopologyTransactions]

    find active topology transactions

    find active topology transactions

    active / state means that for the key authorizing the transaction, there is a connected path to reach the root certificate this function is used for updating and by the lookup client com.digitalasset.canton.topology.client.StoreBasedTopologySnapshot

    asOfInclusive

    whether the search interval should include the current timepoint or not. the state at t is defined as "exclusive" of t, whereas for updating the state, we need to be able to query inclusive.

    includeSecondary

    some topology transactions have an "secondary" uid. currently, this only applies to the party to participant mapping where the secondary uid is the participant uid. we need this information during cascading updates of participant certificates.

  11. abstract def findStored(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Option[StoredTopologyTransaction[TopologyChangeOp]]]
  12. abstract def findTransactionsInRange(asOfExclusive: CantonTimestamp, upToExclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]

    Returns an ordered list of transactions from the transaction store within a certain range

  13. abstract def findTsOfParticipantStateChangesBefore(beforeExclusive: CantonTimestamp, participantId: ParticipantId, limit: Int)(implicit traceContext: TraceContext): Future[Seq[CantonTimestamp]]

    returns an descending ordered list of timestamps of when participant state changes occurred before a certain point in time

  14. abstract def findUpcomingEffectiveChanges(asOfInclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[Seq[Change]]

    fetch the effective time updates greater than or equal to a certain timestamp

    fetch the effective time updates greater than or equal to a certain timestamp

    this function is used to recover the future effective timestamp such that we can reschedule "pokes" of the topology client and updates of the acs commitment processor on startup

  15. abstract def headTransactions(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[Positive]]

    set of topology transactions which are active

  16. abstract def inspect(stateStore: Boolean, timeQuery: TimeQuery, recentTimestampO: Option[CantonTimestamp], ops: Option[TopologyChangeOp], typ: Option[DomainTopologyTransactionType], idFilter: String, namespaceOnly: Boolean)(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]

    query optimized for inspection

    query optimized for inspection

    recentTimestampO

    if exists, use this timestamp for the head state to prevent race conditions on the console

  17. abstract def inspectKnownParties(timestamp: CantonTimestamp, filterParty: String, filterParticipant: String, limit: Int)(implicit traceContext: TraceContext): Future[Set[PartyId]]
  18. abstract def storeId: StoreID
  19. abstract def timestamp(useStateStore: Boolean = false)(implicit traceContext: TraceContext): Future[Option[(SequencedTime, EffectiveTime)]]
  20. abstract def updateDispatchingWatermark(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]

    update the dispatching watermark for this target store

  21. abstract def updateState(sequenced: SequencedTime, effective: EffectiveTime, deactivate: Seq[UniquePath], positive: Seq[SignedTopologyTransaction[Positive]])(implicit traceContext: TraceContext): Future[Unit]

    update active topology transaction to the active topology transaction table

    update active topology transaction to the active topology transaction table

    active means that for the key authorizing the transaction, there is a connected path to reach the root certificate

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. def append(sequenced: SequencedTime, effective: EffectiveTime, transactions: Seq[ValidatedTopologyTransaction])(implicit traceContext: TraceContext): Future[Unit]

    add validated topology transaction as is to the topology transaction table

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def bootstrap(collection: StoredTopologyTransactions[Positive])(implicit traceContext: TraceContext): Future[Unit]

    Bootstrap a node state from a topology transaction collection

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def exists(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Boolean]
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def monotonicityTimeCheckUpdate(ts: CantonTimestamp): Option[CantonTimestamp]
    Attributes
    protected
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. 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

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped