t

com.digitalasset.canton.topology.client

TopologySnapshotLoader

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.

Linear Supertypes
NamedLogging, DomainGovernanceSnapshotLoader, VettedPackagesSnapshotLoader, KeyTopologySnapshotClientLoader, ParticipantTopologySnapshotLoader, PartyTopologySnapshotLoader, PartyTopologySnapshotBaseClient, TopologySnapshot, MembersTopologySnapshotClient, DomainGovernanceSnapshotClient, DomainTrafficControlStateClient, SequencerDomainStateClient, MediatorDomainStateClient, VettedPackagesSnapshotClient, CertificateSnapshotClient, KeyTopologySnapshotClient, ParticipantTopologySnapshotClient, BaseTopologySnapshotClient, PartyTopologySnapshotClient, AnyRef, Any
Known Subclasses
CachingTopologySnapshot, StoreBasedTopologySnapshot, StoreBasedTopologySnapshotX
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopologySnapshotLoader
  2. NamedLogging
  3. DomainGovernanceSnapshotLoader
  4. VettedPackagesSnapshotLoader
  5. KeyTopologySnapshotClientLoader
  6. ParticipantTopologySnapshotLoader
  7. PartyTopologySnapshotLoader
  8. PartyTopologySnapshotBaseClient
  9. TopologySnapshot
  10. MembersTopologySnapshotClient
  11. DomainGovernanceSnapshotClient
  12. DomainTrafficControlStateClient
  13. SequencerDomainStateClient
  14. MediatorDomainStateClient
  15. VettedPackagesSnapshotClient
  16. CertificateSnapshotClient
  17. KeyTopologySnapshotClient
  18. ParticipantTopologySnapshotClient
  19. BaseTopologySnapshotClient
  20. PartyTopologySnapshotClient
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. 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
  2. abstract def allMembers(): Future[Set[Member]]
    Definition Classes
    MembersTopologySnapshotClient
  3. 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
  4. implicit abstract def executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    BaseTopologySnapshotClient
  5. abstract def findDynamicDomainParameters()(implicit traceContext: TraceContext): Future[Either[String, DynamicDomainParametersWithValidity]]
    Definition Classes
    DomainGovernanceSnapshotClient
  6. abstract def findParticipantCertificate(participantId: ParticipantId)(implicit traceContext: TraceContext): Future[Option[X509Cert]]
    Definition Classes
    CertificateSnapshotClient
    Annotations
    @Deprecated
  7. abstract def findParticipantState(participantId: ParticipantId): Future[Option[ParticipantAttributes]]
    Definition Classes
    ParticipantTopologySnapshotLoader
  8. 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
  9. 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
  10. abstract def isMemberKnown(member: Member): Future[Boolean]
    Definition Classes
    MembersTopologySnapshotClient
  11. 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
  12. 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
  13. abstract def loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    NamedLogging
  14. abstract def mediatorGroups(): Future[Seq[MediatorGroup]]
    Definition Classes
    MediatorDomainStateClient
  15. abstract def participants(): Future[Seq[(ParticipantId, ParticipantPermission)]]
    Definition Classes
    ParticipantTopologySnapshotClient
    Annotations
    @Deprecated
  16. abstract def sequencerGroup(): Future[Option[SequencerGroup]]

    returns the sequencer group

    returns the sequencer group

    Definition Classes
    SequencerDomainStateClient
  17. abstract def timestamp: CantonTimestamp

    The official timestamp corresponding to this snapshot

    The official timestamp corresponding to this snapshot

    Definition Classes
    BaseTopologySnapshotClient
  18. 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

  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. 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
  5. def activeParticipantsOfAll(parties: List[LfPartyId]): EitherT[Future, Set[LfPartyId], Set[ParticipantId]]
    Definition Classes
    PartyTopologySnapshotBaseClient
  6. 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
  7. final def activeParticipantsOfPartiesWithAttributes(parties: Seq[LfPartyId]): Future[Map[LfPartyId, Map[ParticipantId, ParticipantAttributes]]]
    Definition Classes
    PartyTopologySnapshotLoader → PartyTopologySnapshotClient
  8. def allHaveActiveParticipants(parties: Set[LfPartyId], check: (ParticipantPermission) => Boolean = _.isActive): EitherT[Future, Set[LfPartyId], Unit]
    Definition Classes
    PartyTopologySnapshotBaseClient
  9. def allHostedOn(partyIds: Set[LfPartyId], participantId: ParticipantId, permissionCheck: (ParticipantAttributes) => Boolean = _.permission.isActive): Future[Boolean]
    Definition Classes
    PartyTopologySnapshotBaseClient
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def canConfirm(participant: ParticipantId, party: LfPartyId, requiredTrustLevel: TrustLevel = TrustLevel.Ordinary): Future[Boolean]
    Definition Classes
    PartyTopologySnapshotBaseClient
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. 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
  14. def encryptionKey(owner: KeyOwner): Future[Option[EncryptionPublicKey]]

    returns newest encryption public key

    returns newest encryption public key

    Definition Classes
    KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
  15. def encryptionKeys(owner: KeyOwner): Future[Seq[EncryptionPublicKey]]

    returns all encryption keys

    returns all encryption keys

    Definition Classes
    KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  19. def findDynamicDomainParametersOrDefault(protocolVersion: ProtocolVersion, warnOnUsingDefault: Boolean = true)(implicit traceContext: TraceContext): Future[DynamicDomainParameters]
    Definition Classes
    DomainGovernanceSnapshotClient
  20. 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
  21. 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
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def hasParticipantCertificate(participantId: ParticipantId)(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    CertificateSnapshotClient
    Annotations
    @Deprecated
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def hostedOn(partyId: LfPartyId, participantId: ParticipantId): Future[Option[ParticipantAttributes]]
    Definition Classes
    PartyTopologySnapshotBaseClient
  26. def isHostedByAtLeastOneParticipantF(party: LfPartyId, check: (ParticipantAttributes) => Boolean): Future[Boolean]
    Definition Classes
    PartyTopologySnapshotBaseClient
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isMediatorActive(mediator: MediatorRef): Future[Boolean]
    Definition Classes
    MediatorDomainStateClient
  29. def isMediatorActive(mediatorId: MediatorId): Future[Boolean]
    Definition Classes
    MediatorDomainStateClient
  30. 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
  31. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. def mediatorGroup(index: MediatorGroupIndex): Future[Option[MediatorGroup]]
    Definition Classes
    MediatorDomainStateClient
  33. def mediatorGroupsOfAll(groups: Seq[MediatorGroupIndex]): EitherT[Future, Seq[MediatorGroupIndex], Seq[MediatorGroup]]
    Definition Classes
    MediatorDomainStateClient
  34. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. def participantState(participantId: ParticipantId): Future[ParticipantAttributes]
    Definition Classes
    ParticipantTopologySnapshotLoader
  40. final def partiesWithGroupAddressing(parties: Seq[LfPartyId]): Future[Set[LfPartyId]]
    Definition Classes
    PartyTopologySnapshotLoader → PartyTopologySnapshotClient
  41. 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
  42. def signingKey(owner: KeyOwner): Future[Option[SigningPublicKey]]

    returns newest signing public key

    returns newest signing public key

    Definition Classes
    KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
  43. def signingKeys(owner: KeyOwner): Future[Seq[SigningPublicKey]]

    returns all signing keys

    returns all signing keys

    Definition Classes
    KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
  44. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  45. def toString(): String
    Definition Classes
    AnyRef → Any
  46. def trafficControlParameters[A](protocolVersion: ProtocolVersion)(implicit tc: TraceContext): Future[Option[TrafficControlParameters]]
    Definition Classes
    DomainGovernanceSnapshotClient
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  49. 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
    Deprecated
  2. 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.

Inherited from NamedLogging

Inherited from DomainGovernanceSnapshotLoader

Inherited from VettedPackagesSnapshotLoader

Inherited from KeyTopologySnapshotClientLoader

Inherited from ParticipantTopologySnapshotLoader

Inherited from PartyTopologySnapshotLoader

Inherited from PartyTopologySnapshotBaseClient

Inherited from TopologySnapshot

Inherited from MembersTopologySnapshotClient

Inherited from DomainGovernanceSnapshotClient

Inherited from DomainTrafficControlStateClient

Inherited from SequencerDomainStateClient

Inherited from MediatorDomainStateClient

Inherited from VettedPackagesSnapshotClient

Inherited from CertificateSnapshotClient

Inherited from KeyTopologySnapshotClient

Inherited from ParticipantTopologySnapshotClient

Inherited from BaseTopologySnapshotClient

Inherited from PartyTopologySnapshotClient

Inherited from AnyRef

Inherited from Any

Ungrouped