trait TopologySnapshotLoader extends TopologySnapshot with PartyTopologySnapshotLoader with BaseTopologySnapshotClient with ParticipantTopologySnapshotLoader with KeyTopologySnapshotClientLoader with VettedPackagesSnapshotLoader with DomainGovernanceSnapshotLoader with DomainTrafficControlStateClient with NamedLogging
Loading interface with a more optimal method to read data from a store
The topology information is stored in a particular way. In order to optimise loading and caching of the data, we use such loader interfaces, such that we can optimise caching and loading of the data while still providing a good and convenient access to the topology information.
- Alphabetic
- By Inheritance
- 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
Abstract Value Members
- abstract 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
- KeyTopologySnapshotClientLoader
- abstract def allMembers(): Future[Set[Member]]
- Definition Classes
- MembersTopologySnapshotClient
- abstract 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
- PartyTopologySnapshotClient
- implicit abstract def executionContext: ExecutionContext
- Attributes
- protected
- Definition Classes
- BaseTopologySnapshotClient
- abstract def findDynamicDomainParameters()(implicit traceContext: TraceContext): Future[Either[String, DynamicDomainParametersWithValidity]]
- Definition Classes
- DomainGovernanceSnapshotClient
- abstract def findParticipantCertificate(participantId: ParticipantId)(implicit traceContext: TraceContext): Future[Option[X509Cert]]
- Definition Classes
- CertificateSnapshotClient
- Annotations
- @Deprecated
- abstract def findParticipantState(participantId: ParticipantId): Future[Option[ParticipantAttributes]]
- Definition Classes
- ParticipantTopologySnapshotLoader
- abstract 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
- KeyTopologySnapshotClient
- abstract 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
- PartyTopologySnapshotClient
- abstract def isMemberKnown(member: Member): Future[Boolean]
- Definition Classes
- MembersTopologySnapshotClient
- abstract 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
- DomainGovernanceSnapshotClient
- abstract 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
- ParticipantTopologySnapshotLoader
- abstract def loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- NamedLogging
- abstract def mediatorGroups(): Future[Seq[MediatorGroup]]
- Definition Classes
- MediatorDomainStateClient
- abstract def participants(): Future[Seq[(ParticipantId, ParticipantPermission)]]
- Definition Classes
- ParticipantTopologySnapshotClient
- Annotations
- @Deprecated
- abstract def sequencerGroup(): Future[Option[SequencerGroup]]
returns the sequencer group
returns the sequencer group
- Definition Classes
- SequencerDomainStateClient
- abstract def timestamp: CantonTimestamp
The official timestamp corresponding to this snapshot
The official timestamp corresponding to this snapshot
- Definition Classes
- BaseTopologySnapshotClient
- abstract 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
- DomainTrafficControlStateClient
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 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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() @IntrinsicCandidate()
- 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
- def findDynamicDomainParametersOrDefault(protocolVersion: ProtocolVersion, warnOnUsingDefault: Boolean = true)(implicit traceContext: TraceContext): Future[DynamicDomainParameters]
- Definition Classes
- DomainGovernanceSnapshotClient
- def findUnvettedPackagesOrDependencies(participantId: ParticipantId, packages: Set[PackageId]): EitherT[FutureUnlessShutdown, 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[FutureUnlessShutdown, PackageId, Set[PackageId]]): EitherT[FutureUnlessShutdown, PackageId, Set[PackageId]]
- Attributes
- protected
- Definition Classes
- VettedPackagesSnapshotLoader
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hasParticipantCertificate(participantId: ParticipantId)(implicit traceContext: TraceContext): Future[Boolean]
- Definition Classes
- CertificateSnapshotClient
- Annotations
- @Deprecated
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hostedOn(partyId: LfPartyId, participantId: ParticipantId): Future[Option[ParticipantAttributes]]
- Definition Classes
- PartyTopologySnapshotBaseClient
- 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 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 logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- 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() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def participantState(participantId: ParticipantId): Future[ParticipantAttributes]
- Definition Classes
- ParticipantTopologySnapshotLoader
- 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 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
- 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])
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.