object party_to_participant_mappings extends Helpful
- Annotations
- @Summary(s = "Manage party to participant mappings", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Party to participant mappings")
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- party_to_participant_mappings
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
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
- def are_known(synchronizerId: SynchronizerId, parties: Seq[PartyId], hostingParticipants: Seq[ParticipantId]): Boolean
Check whether the node knows about
partiesbeing hosted onhostingParticipantsand synchronizersynchronizerId.Check whether the node knows about
partiesbeing hosted onhostingParticipantsand synchronizersynchronizerId.- synchronizerId
Synchronizer on which the party should be hosted
- parties
The parties which needs to be hosted
- hostingParticipants
Expected hosting participants
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- Annotations
- @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
- def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def is_known(synchronizerId: SynchronizerId, party: PartyId, hostingParticipants: Seq[ParticipantId], permission: Option[ParticipantPermission] = None, threshold: Option[PositiveInt] = None): Boolean
Check whether the node knows about
partybeing hosted onhostingParticipantsand synchronizersynchronizerId, optionally the specified expected permission and threshold.Check whether the node knows about
partybeing hosted onhostingParticipantsand synchronizersynchronizerId, optionally the specified expected permission and threshold.- synchronizerId
Synchronizer on which the party should be hosted
- party
The party which needs to be hosted
- hostingParticipants
Expected hosting participants
- permission
If specified, the expected permission
- threshold
If specified, the expected threshold
- def list(synchronizerId: SynchronizerId, proposals: Boolean = false, timeQuery: TimeQuery = TimeQuery.HeadState, operation: Option[TopologyChangeOp] = Some(TopologyChangeOp.Replace), filterParty: String = "", filterParticipant: String = "", filterSigningKey: String = "", protocolVersion: Option[String] = None): Seq[ListPartyToParticipantResult]
- Annotations
- @Summary(s = "List party to participant mapping transactions from synchronizer store", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """List the party to participant mapping transactions present in the stores. Party to participant mappings
|are topology transactions used to allocate a party to certain participants. The same party can be allocated
|on several participants with different privileges.
synchronizerId: Synchronizer to be considered
proposals: Whether to query proposals instead of authorized transactions.
timeQuery: The time query allows to customize the query by time. The following options are supported:
TimeQuery.HeadState (default): The most recent known state.
TimeQuery.Snapshot(ts): The state at a certain point in time.
TimeQuery.Range(fromO, toO): Time-range of when the transaction was added to the store
operation: Optionally, what type of operation the transaction should have.
filterParty: Filter for parties starting with the given filter string.
filterParticipant: If non-empty, returns only parties that are hosted on this participant.
filterSigningKey: Filter for transactions that are authorized with a key that starts with the given filter string.
protocolVersion: Export the topology transactions in the optional protocol version.
|""")
- def list_from_all(proposals: Boolean = false, timeQuery: TimeQuery = TimeQuery.HeadState, operation: Option[TopologyChangeOp] = Some(TopologyChangeOp.Replace), filterParty: String = "", filterParticipant: String = "", filterSigningKey: String = "", protocolVersion: Option[String] = None): Seq[ListPartyToParticipantResult]
- Annotations
- @Summary(s = "List party to participant mapping transactions from all stores", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """List the party to participant mapping transactions present in the stores. Party to participant mappings
|are topology transactions used to allocate a party to certain participants. The same party can be allocated
|on several participants with different privileges.
proposals: Whether to query proposals instead of authorized transactions.
timeQuery: The time query allows to customize the query by time. The following options are supported:
TimeQuery.HeadState (default): The most recent known state.
TimeQuery.Snapshot(ts): The state at a certain point in time.
TimeQuery.Range(fromO, toO): Time-range of when the transaction was added to the store
operation: Optionally, what type of operation the transaction should have.
filterParty: Filter for parties starting with the given filter string.
filterParticipant: Filter for participants starting with the given filter string.
filterSigningKey: Filter for transactions that are authorized with a key that starts with the given filter string.
protocolVersion: Export the topology transactions in the optional protocol version.
|""")
- def list_from_authorized(proposals: Boolean = false, timeQuery: TimeQuery = TimeQuery.HeadState, operation: Option[TopologyChangeOp] = Some(TopologyChangeOp.Replace), filterParty: String = "", filterParticipant: String = "", filterSigningKey: String = "", protocolVersion: Option[String] = None): Seq[ListPartyToParticipantResult]
- Annotations
- @Summary(s = "List party to participant mapping transactions from the authorized store", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """List the party to participant mapping transactions present in the stores. Party to participant mappings
|are topology transactions used to allocate a party to certain participants. The same party can be allocated
|on several participants with different privileges.
proposals: Whether to query proposals instead of authorized transactions.
timeQuery: The time query allows to customize the query by time. The following options are supported:
TimeQuery.HeadState (default): The most recent known state.
TimeQuery.Snapshot(ts): The state at a certain point in time.
TimeQuery.Range(fromO, toO): Time-range of when the transaction was added to the store
operation: Optionally, what type of operation the transaction should have.
filterParty: Filter for parties starting with the given filter string.
filterParticipant: Filter for participants starting with the given filter string.
filterSigningKey: Filter for transactions that are authorized with a key that starts with the given filter string.
protocolVersion: Export the topology transactions in the optional protocol version.
|""")
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def propose(party: PartyId, newParticipants: Seq[(ParticipantId, ParticipantPermission)], threshold: PositiveInt = PositiveInt.one, serial: Option[PositiveInt] = None, signedBy: Seq[Fingerprint] = Seq.empty, operation: TopologyChangeOp = TopologyChangeOp.Replace, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), mustFullyAuthorize: Boolean = false, store: TopologyStoreId = TopologyStoreId.Authorized, forceFlags: ForceFlags = ForceFlags.none): SignedTopologyTransaction[TopologyChangeOp, PartyToParticipant]
- Annotations
- @Summary(s = "Replace party to participant mapping", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Replace the association of a party to hosting participants.
party: The unique identifier of the party whose set of participant permissions to modify.
newParticipants: The unique identifier of the participants to host the party. Each participant entry specifies
the participant's permissions (submission, confirmation, observation).
threshold: The threshold is `1` for regular parties and larger than `1` for "consortium parties". The threshold
indicates how many participant confirmations are needed in order to confirm a Daml transaction on
behalf the party.
signedBy: Refers to the optional fingerprint of the authorizing key which in turn refers to a specific, locally existing certificate.
serial: The expected serial this topology transaction should have. Serials must be contiguous and start at 1.
This transaction will be rejected if another fully authorized transaction with the same serial already
exists, or if there is a gap between this serial and the most recently used serial.
If None, the serial will be automatically selected by the node.
operation: The operation to use. When adding a mapping or making changes, use TopologyChangeOp.Replace.
When removing a mapping, use TopologyChangeOp.Remove and pass the same values as the currently effective mapping.
The default value is TopologyChangeOp.Replace.
synchronize: Synchronize timeout can be used to ensure that the state has been propagated into the node
mustFullyAuthorize: When set to true, the proposal's previously received signatures and the signature of this node must be
sufficient to fully authorize the topology transaction. If this is not the case, the request fails.
When set to false, the proposal retains the proposal status until enough signatures are accumulated to
satisfy the mapping's authorization requirements.
store: - "Authorized": The topology transaction will be stored in the node's authorized store and automatically
propagated to connected synchronizers, if applicable.
- "<synchronizer id>": The topology transaction will be directly submitted to the specified synchronizer without
storing it locally first. This also means it will _not_ be synchronized to other synchronizers
automatically.
""")
- def propose_delta(party: PartyId, adds: Seq[(ParticipantId, ParticipantPermission)] = Nil, removes: Seq[ParticipantId] = Nil, signedBy: Option[Fingerprint] = None, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), mustFullyAuthorize: Boolean = false, store: TopologyStoreId = TopologyStoreId.Authorized, forceFlags: ForceFlags = ForceFlags.none): SignedTopologyTransaction[TopologyChangeOp, PartyToParticipant]
- Annotations
- @Summary(s = "Change party to participant mapping", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Change the association of a party to hosting participants.
party: The unique identifier of the party whose set of participants or permission to modify.
adds: The unique identifiers of the participants to host the party each specifying the participant's permissions
(submission, confirmation, observation). If the participant already hosts the specified party, update the
participant's permissions.
removes: The unique identifiers of the participants that should no longer host the party.
signedBy: Refers to the optional fingerprint of the authorizing key which in turn refers to a specific, locally existing certificate.
synchronize: Synchronize timeout can be used to ensure that the state has been propagated into the node
mustFullyAuthorize: When set to true, the proposal's previously received signatures and the signature of this node must be
sufficient to fully authorize the topology transaction. If this is not the case, the request fails.
When set to false, the proposal retains the proposal status until enough signatures are accumulated to
satisfy the mapping's authorization requirements.
store: - "Authorized": The topology transaction will be stored in the node's authorized store and automatically
propagated to connected synchronizers, if applicable.
- "<synchronizer id>": The topology transaction will be directly submitted to the specified synchronizer without
storing it locally first. This also means it will _not_ be synchronized to other synchronizers
automatically.
force: must be set when disabling a party with active contracts
""")
- 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])