trait TopologySnapshot extends PartyTopologySnapshotClient with BaseTopologySnapshotClient with ParticipantTopologySnapshotClient with KeyTopologySnapshotClient with CertificateSnapshotClient with VettedPackagesSnapshotClient with MediatorDomainStateClient with SequencerDomainStateClient with DomainTrafficControlStateClient with DomainGovernanceSnapshotClient with MembersTopologySnapshotClient

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopologySnapshot
  2. MembersTopologySnapshotClient
  3. DomainGovernanceSnapshotClient
  4. DomainTrafficControlStateClient
  5. SequencerDomainStateClient
  6. MediatorDomainStateClient
  7. VettedPackagesSnapshotClient
  8. CertificateSnapshotClient
  9. KeyTopologySnapshotClient
  10. ParticipantTopologySnapshotClient
  11. BaseTopologySnapshotClient
  12. PartyTopologySnapshotClient
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract 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
    PartyTopologySnapshotClient
  2. abstract def activeParticipantsOfAll(parties: List[LfPartyId]): EitherT[Future, Set[LfPartyId], Set[ParticipantId]]

    Returns all active participants of all the given parties.

    Returns all active participants of all the given parties. Returns a Left if some of the parties don't have active participants, in which case the parties with missing active participants are returned. Note that it will return an empty set as a Right when given an empty list of parties.

    Definition Classes
    PartyTopologySnapshotClient
  3. abstract 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
    PartyTopologySnapshotClient
  4. abstract def activeParticipantsOfPartiesWithAttributes(parties: Seq[LfPartyId]): Future[Map[LfPartyId, Map[ParticipantId, ParticipantAttributes]]]
    Definition Classes
    PartyTopologySnapshotClient
  5. abstract def allHaveActiveParticipants(parties: Set[LfPartyId], check: (ParticipantPermission) => Boolean = _.isActive): EitherT[Future, Set[LfPartyId], Unit]

    Returns Right if all parties have at least an active participant passing the check.

    Returns Right if all parties have at least an active participant passing the check. Otherwise, all parties not passing are passed as Left

    Definition Classes
    PartyTopologySnapshotClient
  6. abstract def allHostedOn(partyIds: Set[LfPartyId], participantId: ParticipantId, permissionCheck: (ParticipantAttributes) => Boolean = _.permission.isActive): Future[Boolean]

    Returns true of all given party ids are hosted on a certain participant

    Returns true of all given party ids are hosted on a certain participant

    Definition Classes
    PartyTopologySnapshotClient
  7. abstract def allMembers(): Future[Set[Member]]
    Definition Classes
    MembersTopologySnapshotClient
  8. 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
  9. abstract def canConfirm(participant: ParticipantId, party: LfPartyId, requiredTrustLevel: TrustLevel = TrustLevel.Ordinary): Future[Boolean]

    Returns whether a participant can confirm on behalf of a party.

    Returns whether a participant can confirm on behalf of a party.

    Definition Classes
    PartyTopologySnapshotClient
  10. abstract 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
    PartyTopologySnapshotClient
  11. abstract def encryptionKey(owner: KeyOwner): Future[Option[EncryptionPublicKey]]

    returns newest encryption public key

    returns newest encryption public key

    Definition Classes
    KeyTopologySnapshotClient
  12. abstract def encryptionKeys(owner: KeyOwner): Future[Seq[EncryptionPublicKey]]

    returns all encryption keys

    returns all encryption keys

    Definition Classes
    KeyTopologySnapshotClient
  13. implicit abstract def executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    BaseTopologySnapshotClient
  14. abstract def findDynamicDomainParameters()(implicit traceContext: TraceContext): Future[Either[String, DynamicDomainParametersWithValidity]]
    Definition Classes
    DomainGovernanceSnapshotClient
  15. abstract def findParticipantCertificate(participantId: ParticipantId)(implicit traceContext: TraceContext): Future[Option[X509Cert]]
    Definition Classes
    CertificateSnapshotClient
    Annotations
    @Deprecated
  16. abstract 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
    VettedPackagesSnapshotClient
  17. abstract def hostedOn(partyId: LfPartyId, participantId: ParticipantId): Future[Option[ParticipantAttributes]]

    Returns the participant permission for that particular participant (if there is one)

    Returns the participant permission for that particular participant (if there is one)

    Definition Classes
    PartyTopologySnapshotClient
  18. 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
  19. 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
  20. abstract def isHostedByAtLeastOneParticipantF(party: LfPartyId, check: (ParticipantAttributes) => Boolean): Future[Boolean]

    Returns true if there is at least one participant that satisfies the predicate

    Returns true if there is at least one participant that satisfies the predicate

    Definition Classes
    PartyTopologySnapshotClient
  21. abstract def isMemberKnown(member: Member): Future[Boolean]
    Definition Classes
    MembersTopologySnapshotClient
  22. abstract 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
    ParticipantTopologySnapshotClient
  23. 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
  24. abstract def mediatorGroups(): Future[Seq[MediatorGroup]]
    Definition Classes
    MediatorDomainStateClient
  25. abstract def participants(): Future[Seq[(ParticipantId, ParticipantPermission)]]
    Definition Classes
    ParticipantTopologySnapshotClient
    Annotations
    @Deprecated
  26. abstract def partiesWithGroupAddressing(parties: Seq[LfPartyId]): Future[Set[LfPartyId]]
    Definition Classes
    PartyTopologySnapshotClient
  27. abstract def sequencerGroup(): Future[Option[SequencerGroup]]

    returns the sequencer group

    returns the sequencer group

    Definition Classes
    SequencerDomainStateClient
  28. abstract def signingKey(owner: KeyOwner): Future[Option[SigningPublicKey]]

    returns newest signing public key

    returns newest signing public key

    Definition Classes
    KeyTopologySnapshotClient
  29. abstract def signingKeys(owner: KeyOwner): Future[Seq[SigningPublicKey]]

    returns all signing keys

    returns all signing keys

    Definition Classes
    KeyTopologySnapshotClient
  30. abstract def timestamp: CantonTimestamp

    The official timestamp corresponding to this snapshot

    The official timestamp corresponding to this snapshot

    Definition Classes
    BaseTopologySnapshotClient
  31. 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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def findDynamicDomainParametersOrDefault(protocolVersion: ProtocolVersion, warnOnUsingDefault: Boolean = true)(implicit traceContext: TraceContext): Future[DynamicDomainParameters]
    Definition Classes
    DomainGovernanceSnapshotClient
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hasParticipantCertificate(participantId: ParticipantId)(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    CertificateSnapshotClient
    Annotations
    @Deprecated
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def isMediatorActive(mediator: MediatorRef): Future[Boolean]
    Definition Classes
    MediatorDomainStateClient
  14. def isMediatorActive(mediatorId: MediatorId): Future[Boolean]
    Definition Classes
    MediatorDomainStateClient
  15. def mediatorGroup(index: MediatorGroupIndex): Future[Option[MediatorGroup]]
    Definition Classes
    MediatorDomainStateClient
  16. def mediatorGroupsOfAll(groups: Seq[MediatorGroupIndex]): EitherT[Future, Seq[MediatorGroupIndex], Seq[MediatorGroup]]
    Definition Classes
    MediatorDomainStateClient
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. 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
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def trafficControlParameters[A](protocolVersion: ProtocolVersion)(implicit tc: TraceContext): Future[Option[TrafficControlParameters]]
    Definition Classes
    DomainGovernanceSnapshotClient
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. 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.

Ungrouped