com.digitalasset.canton.topology.client
StoreBasedTopologySnapshot
Companion object StoreBasedTopologySnapshot
class StoreBasedTopologySnapshot extends TopologySnapshotLoader with NamedLogging with NoTracing
Topology snapshot loader
- Alphabetic
- By Inheritance
- StoreBasedTopologySnapshot
- NoTracing
- TopologySnapshotLoader
- NamedLogging
- DomainGovernanceSnapshotLoader
- VettedPackagesSnapshotLoader
- KeyTopologySnapshotClientLoader
- ParticipantTopologySnapshotLoader
- PartyTopologySnapshotLoader
- PartyTopologySnapshotBaseClient
- TopologySnapshot
- MembersTopologySnapshotClient
- DomainGovernanceSnapshotClient
- DomainTrafficControlStateClient
- SequencerDomainStateClient
- MediatorDomainStateClient
- VettedPackagesSnapshotClient
- CertificateSnapshotClient
- KeyTopologySnapshotClient
- ParticipantTopologySnapshotClient
- BaseTopologySnapshotClient
- PartyTopologySnapshotClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new StoreBasedTopologySnapshot(timestamp: CantonTimestamp, store: TopologyStore[TopologyStoreId], initKeys: Map[KeyOwner, Seq[SigningPublicKey]], useStateTxs: Boolean, packageDependencies: (PackageId) => EitherT[Future, PackageId, Set[PackageId]], loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext)
- timestamp
the asOf timestamp to use
- store
the db store to use
- initKeys
any additional keys to use (for bootstrapping domains)
- useStateTxs
whether the queries should use the state or the tx store. state store means all tx are properly authorized
- packageDependencies
lookup function to determine the direct and indirect package dependencies
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 activeParticipantsOf(party: LfPartyId): Future[Map[ParticipantId, ParticipantAttributes]]
Returns the set of active participants the given party is represented by as of the snapshot timestamp
Returns the set of active participants the given party is represented by as of the snapshot timestamp
Should never return a PartyParticipantRelationship where ParticipantPermission is DISABLED.
- Definition Classes
- PartyTopologySnapshotLoader → PartyTopologySnapshotClient
- def activeParticipantsOfAll(parties: List[LfPartyId]): EitherT[Future, Set[LfPartyId], Set[ParticipantId]]
- Definition Classes
- PartyTopologySnapshotBaseClient
- final def activeParticipantsOfParties(parties: Seq[LfPartyId]): Future[Map[LfPartyId, Set[ParticipantId]]]
Load the set of active participants for the given parties
Load the set of active participants for the given parties
- Definition Classes
- PartyTopologySnapshotLoader → PartyTopologySnapshotClient
- final def activeParticipantsOfPartiesWithAttributes(parties: Seq[LfPartyId]): Future[Map[LfPartyId, Map[ParticipantId, ParticipantAttributes]]]
- Definition Classes
- PartyTopologySnapshotLoader → PartyTopologySnapshotClient
- def allHaveActiveParticipants(parties: Set[LfPartyId], check: (ParticipantPermission) => Boolean = _.isActive): EitherT[Future, Set[LfPartyId], Unit]
- Definition Classes
- PartyTopologySnapshotBaseClient
- def allHostedOn(partyIds: Set[LfPartyId], participantId: ParticipantId, permissionCheck: (ParticipantAttributes) => Boolean = _.permission.isActive): Future[Boolean]
- Definition Classes
- PartyTopologySnapshotBaseClient
- def allKeys(owner: KeyOwner): Future[KeyCollection]
abstract loading function used to obtain the full key collection for a key owner
abstract loading function used to obtain the full key collection for a key owner
- Definition Classes
- StoreBasedTopologySnapshot → KeyTopologySnapshotClientLoader
- def allMembers(): Future[Set[Member]]
- Definition Classes
- StoreBasedTopologySnapshot → MembersTopologySnapshotClient
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def authorityOf(parties: Set[LfPartyId]): Future[AuthorityOfResponse]
Returns the Authority-Of delegations for consortium parties.
Returns the Authority-Of delegations for consortium parties. Non-consortium parties delegate to themselves with threshold one
- Definition Classes
- StoreBasedTopologySnapshot → PartyTopologySnapshotClient
- def canConfirm(participant: ParticipantId, party: LfPartyId, requiredTrustLevel: TrustLevel = TrustLevel.Ordinary): Future[Boolean]
- Definition Classes
- PartyTopologySnapshotBaseClient
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def consortiumThresholds(parties: Set[LfPartyId]): Future[Map[LfPartyId, PositiveInt]]
Returns the consortium thresholds (how many votes from different participants that host the consortium party are required for the confirmation to become valid).
Returns the consortium thresholds (how many votes from different participants that host the consortium party are required for the confirmation to become valid). For normal parties returns 1.
- Definition Classes
- PartyTopologySnapshotLoader → PartyTopologySnapshotClient
- def encryptionKey(owner: KeyOwner): Future[Option[EncryptionPublicKey]]
returns newest encryption public key
returns newest encryption public key
- Definition Classes
- KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
- def encryptionKeys(owner: KeyOwner): Future[Seq[EncryptionPublicKey]]
returns all encryption keys
returns all encryption keys
- Definition Classes
- KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- implicit val executionContext: ExecutionContext
- Definition Classes
- StoreBasedTopologySnapshot → BaseTopologySnapshotClient
- def findDynamicDomainParameters()(implicit traceContext: TraceContext): Future[Either[String, DynamicDomainParametersWithValidity]]
- Definition Classes
- StoreBasedTopologySnapshot → DomainGovernanceSnapshotClient
- def findDynamicDomainParametersOrDefault(protocolVersion: ProtocolVersion, warnOnUsingDefault: Boolean = true)(implicit traceContext: TraceContext): Future[DynamicDomainParameters]
- Definition Classes
- DomainGovernanceSnapshotClient
- def findParticipantCertificate(participantId: ParticipantId)(implicit traceContext: TraceContext): Future[Option[X509Cert]]
- Definition Classes
- StoreBasedTopologySnapshot → CertificateSnapshotClient
- def findParticipantState(participantId: ParticipantId): Future[Option[ParticipantAttributes]]
- Definition Classes
- StoreBasedTopologySnapshot → ParticipantTopologySnapshotLoader
- def findUnvettedPackagesOrDependencies(participantId: ParticipantId, packages: Set[PackageId]): EitherT[Future, PackageId, Set[PackageId]]
Returns the set of packages that are not vetted by the given participant
Returns the set of packages that are not vetted by the given participant
- participantId
the participant for which we want to check the package vettings
- packages
the set of packages that should be vetted
- returns
Right the set of unvetted packages (which is empty if all packages are vetted) Left if a package is missing locally such that we can not verify the vetting state of the package dependencies
- Definition Classes
- VettedPackagesSnapshotLoader → VettedPackagesSnapshotClient
- def findUnvettedPackagesOrDependenciesUsingLoader(participantId: ParticipantId, packages: Set[PackageId], loader: (ParticipantId, PackageId) => EitherT[Future, PackageId, Set[PackageId]]): EitherT[Future, PackageId, Set[PackageId]]
- Attributes
- protected
- Definition Classes
- VettedPackagesSnapshotLoader
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hasParticipantCertificate(participantId: ParticipantId)(implicit traceContext: TraceContext): Future[Boolean]
- Definition Classes
- CertificateSnapshotClient
- Annotations
- @Deprecated
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hostedOn(partyId: LfPartyId, participantId: ParticipantId): Future[Option[ParticipantAttributes]]
- Definition Classes
- PartyTopologySnapshotBaseClient
- def inspectKeys(filterOwner: String, filterOwnerType: Option[KeyOwnerCode], limit: Int): Future[Map[KeyOwner, KeyCollection]]
Returns a list of all known parties on this domain
Returns a list of all known parties on this domain
- Definition Classes
- StoreBasedTopologySnapshot → KeyTopologySnapshotClient
- def inspectKnownParties(filterParty: String, filterParticipant: String, limit: Int): Future[Set[PartyId]]
Returns a list of all known parties on this domain
Returns a list of all known parties on this domain
- Definition Classes
- StoreBasedTopologySnapshot → PartyTopologySnapshotClient
- def isHostedByAtLeastOneParticipantF(party: LfPartyId, check: (ParticipantAttributes) => Boolean): Future[Boolean]
- Definition Classes
- PartyTopologySnapshotBaseClient
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isMediatorActive(mediator: MediatorRef): Future[Boolean]
- Definition Classes
- MediatorDomainStateClient
- def isMediatorActive(mediatorId: MediatorId): Future[Boolean]
- Definition Classes
- MediatorDomainStateClient
- def isMemberKnown(member: Member): Future[Boolean]
- Definition Classes
- StoreBasedTopologySnapshot → MembersTopologySnapshotClient
- def isParticipantActive(participantId: ParticipantId): Future[Boolean]
Checks whether the provided participant exists and is active
Checks whether the provided participant exists and is active
- Definition Classes
- ParticipantTopologySnapshotLoader → ParticipantTopologySnapshotClient
- def listDynamicDomainParametersChanges()(implicit traceContext: TraceContext): Future[Seq[DynamicDomainParametersWithValidity]]
List all the dynamic domain parameters (past and current)
List all the dynamic domain parameters (past and current)
- Definition Classes
- StoreBasedTopologySnapshot → DomainGovernanceSnapshotClient
- def loadParticipantStates(participants: Seq[ParticipantId]): Future[Map[ParticipantId, ParticipantAttributes]]
abstract loading function used to load the participant state for the given set of participant-ids
abstract loading function used to load the participant state for the given set of participant-ids
- Definition Classes
- StoreBasedTopologySnapshot → ParticipantTopologySnapshotLoader
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Definition Classes
- StoreBasedTopologySnapshot → NamedLogging
- def mediatorGroup(index: MediatorGroupIndex): Future[Option[MediatorGroup]]
- Definition Classes
- MediatorDomainStateClient
- def mediatorGroups(): Future[Seq[MediatorGroup]]
returns the list of currently known mediators for singular mediators each one must be wrapped into its own group with threshold = 1 group index in 2.0 topology management is not used and the order of output does not need to be stable
returns the list of currently known mediators for singular mediators each one must be wrapped into its own group with threshold = 1 group index in 2.0 topology management is not used and the order of output does not need to be stable
- Definition Classes
- StoreBasedTopologySnapshot → MediatorDomainStateClient
- def mediatorGroupsOfAll(groups: Seq[MediatorGroupIndex]): EitherT[Future, Seq[MediatorGroupIndex], Seq[MediatorGroup]]
- Definition Classes
- MediatorDomainStateClient
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def participantState(participantId: ParticipantId): Future[ParticipantAttributes]
- Definition Classes
- ParticipantTopologySnapshotLoader
- def participants(): Future[Seq[(ParticipantId, ParticipantPermission)]]
- Definition Classes
- StoreBasedTopologySnapshot → ParticipantTopologySnapshotClient
- final def partiesWithGroupAddressing(parties: Seq[LfPartyId]): Future[Set[LfPartyId]]
- Definition Classes
- PartyTopologySnapshotLoader → PartyTopologySnapshotClient
- def referenceTime: CantonTimestamp
Internally used reference time (representing when the last change happened that affected this snapshot)
Internally used reference time (representing when the last change happened that affected this snapshot)
- Definition Classes
- BaseTopologySnapshotClient
- def sequencerGroup(): Future[Option[SequencerGroup]]
returns the current sequencer group if known TODO(#14048): Decide whether it is advantageous e.g.
returns the current sequencer group if known TODO(#14048): Decide whether it is advantageous e.g. for testing to expose a sequencer-group on daml 2.* perhaps we cook up a SequencerId based on the domainId assuming that the sequencer (or sequencers all with the same sequencerId) is/are active
- Definition Classes
- StoreBasedTopologySnapshot → SequencerDomainStateClient
- def signingKey(owner: KeyOwner): Future[Option[SigningPublicKey]]
returns newest signing public key
returns newest signing public key
- Definition Classes
- KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
- def signingKeys(owner: KeyOwner): Future[Seq[SigningPublicKey]]
returns all signing keys
returns all signing keys
- Definition Classes
- KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timestamp: CantonTimestamp
The official timestamp corresponding to this snapshot
The official timestamp corresponding to this snapshot
- Definition Classes
- StoreBasedTopologySnapshot → BaseTopologySnapshotClient
- def toString(): String
- Definition Classes
- AnyRef → Any
- implicit def traceContext: TraceContext
- Attributes
- protected
- Definition Classes
- NoTracing
- def trafficControlParameters[A](protocolVersion: ProtocolVersion)(implicit tc: TraceContext): Future[Option[TrafficControlParameters]]
- Definition Classes
- DomainGovernanceSnapshotClient
- def trafficControlStatus(members: Seq[Member]): Future[Map[Member, Option[MemberTrafficControlState]]]
Return the traffic control states for the members specified
Return the traffic control states for the members specified
- members
for which to return the traffic state
- returns
all input members with their optional traffic state
- Definition Classes
- StoreBasedTopologySnapshot → DomainTrafficControlStateClient
- 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])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated
- final def mediators(): Future[Seq[MediatorId]]
returns the list of currently known mediators
returns the list of currently known mediators
- Definition Classes
- MediatorDomainStateClient
- Annotations
- @deprecated
- Deprecated
(Since version 2.7) Use mediatorGroups instead.