trait TopologySnapshot extends PartyTopologySnapshotClient with BaseTopologySnapshotClient with ParticipantTopologySnapshotClient with KeyTopologySnapshotClient with CertificateSnapshotClient with VettedPackagesSnapshotClient with MediatorDomainStateClient with SequencerDomainStateClient with DomainTrafficControlStateClient with DomainGovernanceSnapshotClient with MembersTopologySnapshotClient
- Self Type
- TopologySnapshot with BaseTopologySnapshotClient with NamedLogging
- Alphabetic
- By Inheritance
- 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 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
- 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
- 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
- abstract def activeParticipantsOfPartiesWithAttributes(parties: Seq[LfPartyId]): Future[Map[LfPartyId, Map[ParticipantId, ParticipantAttributes]]]
- Definition Classes
- PartyTopologySnapshotClient
- 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
- 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
- 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
- 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
- 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
- abstract def encryptionKey(owner: KeyOwner): Future[Option[EncryptionPublicKey]]
returns newest encryption public key
returns newest encryption public key
- Definition Classes
- KeyTopologySnapshotClient
- abstract def encryptionKeys(owner: KeyOwner): Future[Seq[EncryptionPublicKey]]
returns all encryption keys
returns all encryption keys
- Definition Classes
- KeyTopologySnapshotClient
- 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 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
- VettedPackagesSnapshotClient
- 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
- 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 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
- abstract def isMemberKnown(member: Member): Future[Boolean]
- Definition Classes
- MembersTopologySnapshotClient
- 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
- 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 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 signingKey(owner: KeyOwner): Future[Option[SigningPublicKey]]
returns newest signing public key
returns newest signing public key
- Definition Classes
- KeyTopologySnapshotClient
- abstract def signingKeys(owner: KeyOwner): Future[Seq[SigningPublicKey]]
returns all signing keys
returns all signing keys
- Definition Classes
- KeyTopologySnapshotClient
- 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 asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def findDynamicDomainParametersOrDefault(protocolVersion: ProtocolVersion, warnOnUsingDefault: Boolean = true)(implicit traceContext: TraceContext): Future[DynamicDomainParameters]
- Definition Classes
- DomainGovernanceSnapshotClient
- 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()
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- 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
- 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.