Type Members

1.  class AuthorizedTopologyManager extends LocalTopologyManager[AuthorizedStore]
2.  final case class ExternalPartyOnboardingDetails extends Product with Serializable

   Data class containing onbarding signed topology transactions for an external party.

   Data class containing onbarding signed topology transactions for an external party.

   The following invariants are enforced in the create method of the companion object:

   • The namespaces of all 3 transactions are consistent
   • There is at least one confirming participant
   • There is no participant with submission permission
3.  sealed abstract class ForceFlag extends AnyRef

   A force flag is used to override specific safety checks in the topology manager.

4.  final case class ForceFlags(flags: Set[ForceFlag]) extends Product with Serializable

   A container for a set of force flags to pass around.

5.  trait HasNamespace extends HasFingerprint
6.  trait HasUniqueIdentifier extends HasNamespace
7.  sealed trait Identity extends HasUniqueIdentifier with Product with Serializable with PrettyPrinting

   Top level trait representing an identity within the system

8.  final case class KeyCollection(signingKeys: Seq[SigningPublicKey], encryptionKeys: Seq[EncryptionPublicKey]) extends Product with Serializable
9.  abstract class LocalTopologyManager[StoreId <: TopologyStoreId] extends TopologyManager[StoreId]
10.  final case class MediatorGroup(index: MediatorGroupIndex, active: Seq[MediatorId], passive: Seq[MediatorId], threshold: PositiveInt) extends Product with Serializable

    Represents a mediator group, containing only mediators that have at least 1 signing key.

    Represents a mediator group, containing only mediators that have at least 1 signing key.

    index

    uniquely identifies the group, just like MediatorId for single mediators.

    active

    the active mediators belonging to the group

    passive

    the passive mediators belonging to the group

    threshold

    the minimum size of a quorum

11.  final case class MediatorId(uid: UniqueIdentifier) extends Member with NodeIdentity with Product with Serializable
12.  sealed trait Member extends Identity with Product with Serializable

    A member in a synchronizer such as a participant and or synchronizer entities

    A member in a synchronizer such as a participant and or synchronizer entities

    A member can be addressed and talked to on the transaction level through the sequencer.

13.  sealed trait MemberCode extends AnyRef
14.  final case class Namespace(fingerprint: Fingerprint) extends HasFingerprint with PrettyPrinting with Product with Serializable

    A namespace spanned by the fingerprint of a pub-key

    A namespace spanned by the fingerprint of a pub-key

    This is based on the assumption that the fingerprint is unique to the public-key

15.  sealed trait NodeIdentity extends Identity
16.  final case class ParticipantId(uid: UniqueIdentifier) extends Member with NodeIdentity with Product with Serializable

    A participant identifier

17.  final case class PartyId(uid: UniqueIdentifier) extends Identity with Product with Serializable

    A party identifier based on a unique identifier

18.  class PartyToParticipantComputations extends NamedLogging
19.  final case class PendingTransactions(transactions: Seq[GenericSignedTopologyTransaction], newWatermark: CantonTimestamp) extends Product with Serializable
20.  class QueueBasedSynchronizerOutbox extends SynchronizerOutbox with QueueBasedSynchronizerOutboxDispatchHelper with FlagCloseable
21.  trait QueueBasedSynchronizerOutboxDispatchHelper extends SynchronizerOutboxDispatchHelper
22.  final case class SequencerGroup(active: Seq[SequencerId], passive: Seq[SequencerId], threshold: PositiveInt) extends Product with Serializable

    Contains only sequencers from SequencerSynchronizerState that also have at least 1 signing key.

    Contains only sequencers from SequencerSynchronizerState that also have at least 1 signing key.

    When reading threshold, recall the contract of SequencerSynchronizerState: The system must tolerate up to min(threshold - 1, (active.size - 1)/3) malicious active sequencers.

23.  final case class SequencerId(uid: UniqueIdentifier) extends Member with NodeIdentity with Product with Serializable
24.  class StoreBasedSynchronizerOutbox extends SynchronizerOutbox with SynchronizerOutboxDispatch with HasFutureSupervision with StoreBasedSynchronizerOutboxDispatchHelper
25.  trait StoreBasedSynchronizerOutboxDispatchHelper extends SynchronizerOutboxDispatchHelper
26.  final case class SynchronizerId(uid: UniqueIdentifier) extends Identity with Product with Serializable
27.  abstract class SynchronizerOutbox extends SynchronizerOutboxHandle
28.  trait SynchronizerOutboxDispatch extends NamedLogging with FlagCloseable
29.  trait SynchronizerOutboxDispatchHelper extends NamedLogging
30.  class SynchronizerOutboxDynamicObserver extends TopologyManagerObserver with NamedLogging

    Dynamic version of a TopologyManagerObserver allowing observers to be dynamically added or removed while the TopologyManager stays up.

    Dynamic version of a TopologyManagerObserver allowing observers to be dynamically added or removed while the TopologyManager stays up. (This is helpful for mediator node failover where synchronizer-outboxes are started and closed.)

31.  class SynchronizerOutboxFactory extends NamedLogging
32.  class SynchronizerOutboxFactorySingleCreate extends SynchronizerOutboxFactory with FlagCloseable
33.  trait SynchronizerOutboxHandle extends FlagCloseable
34.  class SynchronizerOutboxQueue extends NamedLogging

    The SynchronizerOutboxQueue connects a SynchronizerTopologyManager and a SynchronizerOutbox.

    The SynchronizerOutboxQueue connects a SynchronizerTopologyManager and a SynchronizerOutbox. The topology manager enqueues transactions that the synchronizer outbox will pick up and send to the synchronizer to be sequenced and distributed to the nodes in the synchronizer.

    On the one hand, com.digitalasset.canton.topology.SynchronizerOutboxQueue#enqueue may be called at any point to add more topology transactions to the queue. On the other hand, each invocation of com.digitalasset.canton.topology.SynchronizerOutboxQueue#dequeue must be followed by either com.digitalasset.canton.topology.SynchronizerOutboxQueue#requeue or com.digitalasset.canton.topology.SynchronizerOutboxQueue#completeCycle, before com.digitalasset.canton.topology.SynchronizerOutboxQueue#dequeue is called again.

35.  class SynchronizerTopologyManager extends TopologyManager[SynchronizerStore]
36.  class TemporaryStoreRegistry extends NamedLogging with FlagCloseable
37.  class TemporaryTopologyManager extends LocalTopologyManager[TemporaryStore]
38.  abstract class TopologyManager[+StoreID <: TopologyStoreId] extends TopologyManagerStatus with NamedLogging with FlagCloseable
39.  sealed trait TopologyManagerError extends ContextualizedCantonError
40.  trait TopologyManagerObserver extends AnyRef
41.  trait TopologyManagerStatus extends AnyRef
42.  class TopologyStateProcessor extends NamedLogging

43.  final case class UniqueIdentifier extends HasNamespace with PrettyPrinting with Product with Serializable

    a unique identifier within a namespace Based on the Ledger API PartyIds/LedgerStrings being limited to 255 characters, we allocate

    a unique identifier within a namespace Based on the Ledger API PartyIds/LedgerStrings being limited to 255 characters, we allocate

    • 64 + 4 characters to the namespace/fingerprint (essentially SHA256 with extra bytes),
    • 2 characters as delimiters, and
    • the last 185 characters for the Identifier.