package topology
- Alphabetic
- Public
- Protected
Package Members
- package admin
- package client
- package processing
- package store
- package transaction
Type Members
- sealed trait AuthenticatedMember extends Member
- sealed trait AuthenticatedMemberCode extends KeyOwnerCode
- class AuthorizedTopologyManagerX extends TopologyManagerX[AuthorizedStore]
- final case class DomainId(uid: UniqueIdentifier) extends NodeIdentity with Product with Serializable
- sealed trait DomainMember extends AuthenticatedMember
- abstract class DomainOutboxCommon extends DomainOutboxHandle
- trait DomainOutboxDispatch[TX, State, +H <: RegisterTopologyTransactionHandleCommon[TX, State], +TS <: TopologyStoreCommon[DomainStore, _, _, TX]] extends NamedLogging with FlagCloseable
- trait DomainOutboxDispatchHelperOld extends DomainOutboxDispatchStoreSpecific[GenericSignedTopologyTransaction, State]
- trait DomainOutboxDispatchHelperX extends DomainOutboxDispatchStoreSpecific[GenericSignedTopologyTransactionX, State]
- trait DomainOutboxDispatchStoreSpecific[TX, State] extends NamedLogging
- trait DomainOutboxHandle extends DomainOutboxStatus with FlagCloseable
- class DomainOutboxQueue extends NamedLogging
The DomainOutboxQueue connects a DomainTopologyManagerX and a
DomainOutboxX
.The DomainOutboxQueue connects a DomainTopologyManagerX and a
DomainOutboxX
. The topology manager enqueues transactions that the domain outbox will pick up and send to the domain to be sequenced and distributed to the nodes in the domain.On the one hand, com.digitalasset.canton.topology.DomainOutboxQueue#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.DomainOutboxQueue#dequeue must be followed by either com.digitalasset.canton.topology.DomainOutboxQueue#requeue or com.digitalasset.canton.topology.DomainOutboxQueue#completeCycle, before com.digitalasset.canton.topology.DomainOutboxQueue#dequeue is called again.
- trait DomainOutboxStatus extends AnyRef
- class DomainOutboxXDynamicObserver 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 MediatorNodeX failover where domain-outboxes are started and closed.)
- class DomainOutboxXFactory extends NamedLogging
- class DomainOutboxXFactorySingleCreate extends DomainOutboxXFactory with FlagCloseable
- final case class DomainTopologyManagerId(uid: UniqueIdentifier) extends DomainMember with Product with Serializable
The domain topology manager id
The domain topology manager id
The domain manager is the topology manager of the domain. The read side of the domain manager is the IdentityProvidingService.
- class DomainTopologyManagerX extends TopologyManagerX[DomainStore]
- final case class Identifier extends LengthLimitedStringWrapper with PrettyPrinting with Product with Serializable
An identifier such as a random or a readable string
- sealed trait Identity extends Product with Serializable with PrettyPrinting
Top level trait representing an identity within the system
- final case class KeyCollection(signingKeys: Seq[SigningPublicKey], encryptionKeys: Seq[EncryptionPublicKey]) extends Product with Serializable
- sealed trait KeyOwner extends Identity
An identity within the system that owns a key
An identity within the system that owns a key
- Annotations
- @Deprecated
- sealed trait KeyOwnerCode extends AnyRef
- final case class MediatorGroup(index: MediatorGroupIndex, active: Seq[MediatorId], passive: Seq[MediatorId], threshold: PositiveInt) extends Product with Serializable
- 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
- final case class MediatorId(uid: UniqueIdentifier) extends DomainMember with NodeIdentity with Product with Serializable
- sealed trait MediatorRef extends PrettyPrinting with Product with Serializable
This class represents a union of MediatorId and com.digitalasset.canton.sequencing.protocol.MediatorsOfDomain.
This class represents a union of MediatorId and com.digitalasset.canton.sequencing.protocol.MediatorsOfDomain. It is used throughout the protocol to represent target/source mediator or mediator group in case of a BFT domain
- sealed trait Member extends KeyOwner with Product with Serializable
A member in a domain such as a participant and or domain entities
A member in a domain such as a participant and or domain entities
A member can be addressed and talked to on the transaction level through the sequencer. Therefore every member is a KeyOwner. And the sequencer is not a member, as he is one level below, dealing with messages.
- final case class Namespace(fingerprint: Fingerprint) extends 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
- final case class NodeId(identity: UniqueIdentifier) extends Product with Serializable
- sealed trait NodeIdentity extends Identity
- final case class ParticipantId(uid: UniqueIdentifier) extends AuthenticatedMember with NodeIdentity with Product with Serializable
A participant identifier
- final case class PartyId(uid: UniqueIdentifier) extends Identity with Product with Serializable
A party identifier based on a unique identifier
- class PartyToParticipantComputations extends NamedLogging
- final case class PendingTransactions[TX](transactions: Seq[TX], newWatermark: CantonTimestamp) extends Product with Serializable
- trait QueueBasedDomainOutboxDispatchHelperX extends DomainOutboxDispatchHelperX
- class QueueBasedDomainOutboxX extends DomainOutboxCommon with QueueBasedDomainOutboxDispatchHelperX with FlagCloseable
- final case class SequencerGroup(active: Seq[SequencerId], passive: Seq[SequencerId], threshold: PositiveInt) extends Product with Serializable
- final case class SequencerId(uid: UniqueIdentifier) extends DomainMember with NodeIdentity with Product with Serializable
- class StoreBasedDomainOutbox extends StoreBasedDomainOutboxCommon[GenericSignedTopologyTransaction, State, RegisterTopologyTransactionHandleCommon[GenericSignedTopologyTransaction, State], TopologyStore[DomainStore]] with DomainOutboxDispatchHelperOld
- abstract class StoreBasedDomainOutboxCommon[TX, State, +H <: RegisterTopologyTransactionHandleCommon[TX, State], +DTS <: TopologyStoreCommon[DomainStore, _, _, TX]] extends DomainOutboxCommon with DomainOutboxDispatch[TX, State, H, DTS]
- trait StoreBasedDomainOutboxDispatchHelperX extends DomainOutboxDispatchHelperX
- class StoreBasedDomainOutboxX extends StoreBasedDomainOutboxCommon[GenericSignedTopologyTransactionX, State, RegisterTopologyTransactionHandleCommon[GenericSignedTopologyTransactionX, State], TopologyStoreX[DomainStore]] with StoreBasedDomainOutboxDispatchHelperX
- abstract class TopologyManager[E <: CantonError] extends TopologyManagerStatus with NamedLogging with FlagCloseableAsync
- sealed trait TopologyManagerError extends CantonError
- trait TopologyManagerObserver extends AnyRef
- trait TopologyManagerStatus extends AnyRef
- abstract class TopologyManagerX[+StoreID <: TopologyStoreId] extends TopologyManagerStatus with NamedLogging with FlagCloseable
- class TopologyStateProcessorX extends NamedLogging
- final case class UnauthenticatedMemberId(uid: UniqueIdentifier) extends Member with Product with Serializable
- final case class UniqueIdentifier(id: Identifier, namespace: Namespace) extends 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 - 64 + 4 characters to the namespace/fingerprint (essentially SHA256 with extra bytes), - 2 characters as delimiters, and - the last 185 characters for the Identifier.
Value Members
- object DomainId extends Serializable
- object DomainMember extends Serializable
- object DomainOutboxStatus
- object DomainTopologyManagerId extends Serializable
- object Identifier extends Serializable
- object KeyCollection extends Serializable
- object KeyOwner extends Serializable
- object KeyOwnerCode
- object MediatorGroup extends Serializable
- object MediatorId extends Serializable
- object MediatorRef extends Serializable
- object Member extends Serializable
- object Namespace extends Serializable
- object ParticipantId extends Serializable
- object PartyId extends Serializable
- object SafeSimpleString
utility class to ensure that strings conform to LF specification minus our internal delimiter
- object SequencerId extends Serializable
- object TopologyManagerError extends TopologyManagerErrorGroup
- object TopologyManagerStatus
- object UnauthenticatedMemberId extends Serializable
- object UniqueIdentifier extends Serializable