Skip to main content

Module protocol_proto

Module protocol_proto 

Source
Expand description

Generated Canton protocol types (topology mapping items).

Modules§

enums
Nested message and enum types in Enums.
lsu_sequencer_connection_successor
Nested message and enum types in LsuSequencerConnectionSuccessor.
namespace_delegation
Nested message and enum types in NamespaceDelegation.
party_to_participant
Nested message and enum types in PartyToParticipant.
topology_mapping
Nested message and enum types in TopologyMapping.
vetted_packages
Nested message and enum types in VettedPackages.

Structs§

AcsCommitmentsCatchUpConfig
catch-up configuration parameters
DecentralizedNamespaceDefinition
a decentralized namespace definition that creates a new namespace supported by the the original owners authorization: the decentralized namespace definition with serial = 1 must be authorized by all the owners of the namespace that form the decentralized namespace. for definitions with serial > 1, we need the authorization of #threshold owners plus all new owners
DynamicSequencingParameters
DynamicSequencingParametersState
which sequencing dynamic parameters are supposed to be used on the given synchronizer; defaults are used when not set authorization: whoever controls the synchronizer UNIQUE(synchronizer_id)
DynamicSynchronizerParameters
Enums
LsuAnnouncement
indicates the beginning of a synchronizer upgrade and effectuates a topology freeze, after which only synchronizer upgrade specific topology mappings are accepted. removing this mapping unfreezes the topology state again. authorization: whoever controls the synchronizer UNIQUE(successor_physical_synchronizer_id.logical)
LsuSequencerConnectionSuccessor
a sequencer can announce its connections on the successor synchronizer authorization: whoever controls the sequencer UNIQUE(sequencer_id, successor_physical_synchronizer_id.logical)
MediatorSynchronizerState
which mediators and mediator groups are active on the given synchronizer authorization: whoever controls the synchronizer UNIQUE(synchronizer_id, group)
MultiTransactionSignatures
Used in SignedTopologyTransaction to bundle together multiple transaction hashes Allows submitters to only sign a single combined hash to authorize multiple transactions at once The combined hash is computed from the transaction hashes
NamespaceDelegation
[start NamespaceDelegation definition] namespace delegation (equivalent to X509v3 CA root or intermediate CAs) if is_root_delegation==false, the target key may sign all mappings requiring a signature for the namespace except other NamespaceDelegation mappings. authorization: a namespace delegation is either signed by the root key, or is signed by a key for which there exists a series of properly authorized namespace delegations that are ultimately signed by the root key revocation: a revoked namespace delegation cannot be re-created. While the delegation itself is revoked, valid transactions that have been signed using the authority of the delegation before its revocation stay valid. UNIQUE(namespace, target_key)
OwnerToKeyMapping
mapping a member (participant, mediator, sequencer) to a key authorization: whoever controls the member uid UNIQUE(member)
ParticipantSynchronizerLimits
individual per participant limits
ParticipantSynchronizerPermission
the optional trust certificate of the synchronizer towards the participant authorization: whoever controls the synchronizer id UNIQUE(synchronizer_id,participant)
PartyHostingLimits
the optional hosting limits for a party on a given synchronizer these limits can be used to limit the number of participants that can host a given party authorization: whoever controls the synchronizer id UNIQUE(synchronizer_id,party)
PartyToKeyMapping
mapping a party to a key authorization: whoever controls the party uid UNIQUE(party)
PartyToParticipant
[doc-entry-start: PartyToParticipant] Mapping that maps a party to a participant The PartyToParticipant mapping may also specify a list of signing keys for setting up an external party, in which case the keys and the threshold take precedence over any PartyToKeyMapping for the same party. Additionally, the list of signing keys may contain the public key of the party’s namespace, which allows this mapping to authorize itself without the need of a NamespaceDelegation root certificate (called self-signed). authorization: the required authorization of the mapping is a union of the authorization for individual changes
SequencerSynchronizerState
which sequencers are active on the given synchronizer authorization: whoever controls the synchronizer UNIQUE(synchronizer_id)
SetTrafficPurchasedMessage
SignedTopologyTransaction
SignedTopologyTransactions
SynchronizerParametersState
which dynamic synchronizer parameters are supposed to be used on the given synchronizer authorization: whoever controls the synchronizer UNIQUE(synchronizer_id)
SynchronizerTrustCertificate
the trust certificate issued by the participant confirming that the participant wishes to be present on the given synchronizer authorization: whoever controls the participant uid UNIQUE(participant,synchronizer_id)
TopologyMapping
[docs-entry-start: topology mapping]
TopologyTransaction
TopologyTransactionsBroadcast
Accepted topology transaction
TrafficConsumed
Message representing traffic consumed by a member at a given point in time
TrafficControlParameters
TrafficPurchased
Message representing a traffic purchase made on behalf of a member
TrafficReceipt
Message representing a traffic receipt included in SequencedEvent receipts to update sender about the traffic consumed state after sequencing of the event
TrafficState
Traffic state of a member at a given timestamp
VettedPackages
list of packages supported by this participant authorization: whoever controls the participant uid UNIQUE(participant)

Enums§

OnboardingRestriction
Controls how participants can join the synchronizer Note that currently, only transitions from restricted to unrestricted are supported, but not the other way around.