package canton

Get desktop application:
View/edit binary Protocol Buffers messages

the key can sign all currently known mappings and all mappings that will be added in future releases, except for namespace delegations

Used in: NamespaceDelegation

(message has no fields)

the key can sign all currently known mappings and all mappings that will be added in future releases

Used in: NamespaceDelegation

(message has no fields)

the key can only sign the explicitly specified mappings

Used in: NamespaceDelegation

• repeated TopologyMappingCode mappings = 1

Used in: Metadata.InputContract, Node

• string lf_version = 1

• string contract_id = 2

• string package_name = 3

• optional Identifier template_id = 4

• optional Value argument = 5

• repeated string signatories = 6

• repeated string stakeholders = 7

Serialization format for crypto keys and signatures

Used in: SigningPublicKey

• CRYPTO_KEY_FORMAT_UNSPECIFIED = 0

• CRYPTO_KEY_FORMAT_DER = 2

  ASN.1 + DER encoding Legacy format no longer used, except for migrations

• CRYPTO_KEY_FORMAT_RAW = 3

  Raw encoding of a key, used for symmetric keys

• CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO = 4

  ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1

• CRYPTO_KEY_FORMAT_DER_PKCS8_PRIVATE_KEY_INFO = 5

  ASN.1 + DER-encoding of PKCS #8 PrivateKeyInfo structure: https://datatracker.ietf.org/doc/html/rfc5208#section-5

• CRYPTO_KEY_FORMAT_SYMBOLIC = 10000

  Symbolic crypto, must only be used for testing

Used in: PreparedTransaction

• string version = 1

• repeated string roots = 2

• repeated DamlTransaction.DNode nodes = 3

• repeated DamlTransaction.NodeSeed node_seeds = 4

Used in: DamlTransaction

• string node_id = 1

• oneof versioned_node

  • Node v1 = 1000

Used in: DamlTransaction

• int32 node_id = 1

• bytes seed = 2

Used in: Value

(message has no fields)

Used in: Value

• optional Identifier enum_id = 1

• string constructor = 2

Used in: Node

• string lf_version = 1

• string contract_id = 2

• string package_name = 3

• optional Identifier template_id = 4

• repeated string signatories = 5

• repeated string stakeholders = 6

• repeated string acting_parties = 7

• optional Identifier interface_id = 8

• string choice_id = 9

• optional Value chosen_value = 10

• bool consuming = 11

• repeated string children = 12

• optional Value exercise_result = 13

• repeated string choice_observers = 14

Used in: Node

• string lf_version = 1

• string contract_id = 2

• string package_name = 3

• optional Identifier template_id = 4

• repeated string signatories = 5

• repeated string stakeholders = 6

• repeated string acting_parties = 7

• optional Identifier interface_id = 8

Used in: Value

• repeated GenMap.Entry entries = 1

Used in: GenMap

• optional Value key = 1

• optional Value value = 2

• TopologyChangeOp operation = 1

  * Replace / Remove

• uint32 serial = 2

• optional TopologyMapping mapping = 3

• optional StoreId store = 4

Used in: Metadata.GlobalKeyMappingEntry

• optional Identifier template_id = 1

• string package_name = 2

• optional Value key = 3

• bytes hash = 4

Used in: Create, Enum, Exercise, Fetch, GlobalKey, Record, Variant

• string package_id = 1

• string module_name = 2

• string entity_name = 3

Used in: Value

• repeated Value elements = 1

Used in: PreparedTransaction

• optional Metadata.SubmitterInfo submitter_info = 2

• string synchronizer_id = 3

• uint32 mediator_group = 4

• string transaction_uuid = 5

• uint64 preparation_time = 6

• repeated Metadata.InputContract input_contracts = 7

• optional uint64 min_ledger_effective_time = 9

• optional uint64 max_ledger_effective_time = 10

• repeated Metadata.GlobalKeyMappingEntry global_key_mapping = 8

Used in: Metadata

• optional GlobalKey key = 1

• optional Value value = 2

Used in: Metadata

• oneof contract

  • Create v1 = 1

• uint64 created_at = 1000

• bytes event_blob = 1002

Used in: Metadata

• repeated string act_as = 1

• string command_id = 2

Used in: TopologyMapping

• string namespace = 1

• optional SigningPublicKey target_key = 2

• bool is_root_delegation = 3

  flag indicating whether the given delegation is a root delegation or not a root delegation is also allowed to issue other NamespaceDelegations.

• oneof restriction

  restricts target_key to only sign transactions with the specified mapping types. for backwards compatibility, only the following combinations are valid: * is_root_delegation = true, restriction = empty: the key can sign all mappings * is_root_delegation = false, restriction = empty: the key can sign all mappings but namespace delegations * is_root_delegation = false, restriction = non-empty: the key can only sign the mappings according the restriction that is set

  • CanSignAllMappings can_sign_all_mappings = 4

  • CanSignAllButNamespaceDelegations can_sign_all_but_namespace_delegations = 5

  • CanSignSpecificMappings can_sign_specific_mapings = 6

Used in: DamlTransaction.DNode

• oneof node_type

  • Create create = 1

  • Fetch fetch = 2

  • Exercise exercise = 3

  • Rollback rollback = 4

Used in: Value

• optional Value value = 1

Used in: PartyToParticipant.HostingParticipant

• PARTICIPANT_PERMISSION_UNSPECIFIED = 0

• PARTICIPANT_PERMISSION_SUBMISSION = 1

  participant is active, can submit transactions and reassignments

• PARTICIPANT_PERMISSION_CONFIRMATION = 2

  participant is passive, can only confirm transactions and submit reassignments

• PARTICIPANT_PERMISSION_OBSERVATION = 3

  participant is passive, can only observe transactions and submit reassignments

Used in: TopologyMapping

• string party = 1

  the party

• uint32 threshold = 3

  the authorization threshold

• repeated SigningPublicKey signing_keys = 4

  the designated signing keys

Used in: TopologyMapping

• string party = 1

  the party that is to be represented by the participants

• uint32 threshold = 2

  the signatory threshold required by the participants to be able to act on behalf of the party. a mapping with threshold > 1 is considered a definition of a consortium party

• repeated PartyToParticipant.HostingParticipant participants = 3

  which participants will host the party. if threshold > 1, must be Confirmation or Observation

Used in: PartyToParticipant

• string participant_uid = 1

  the target participant that the party should be mapped to

• ParticipantPermission permission = 2

  permission of the participant for this particular party (the actual will be min of ParticipantSynchronizerPermission.ParticipantPermission and this setting)

• optional HostingParticipant.Onboarding onboarding = 3

  optional, present iff the party is being onboarded to the participant

Used in: HostingParticipant

(message has no fields)

• optional DamlTransaction transaction = 1

• optional Metadata metadata = 2

Used in: Value

• optional Identifier record_id = 1

• repeated RecordField fields = 2

Used in: Record

• string label = 1

• optional Value value = 2

Used in: Node

• repeated string children = 1

@deprecated

Used in: SigningPublicKey

• SIGNING_KEY_SCHEME_UNSPECIFIED = 0

• SIGNING_KEY_SCHEME_ED25519 = 1

  Signature based on Curve25519 http://ed25519.cr.yp.to/

• SIGNING_KEY_SCHEME_EC_DSA_P256 = 2

  EC-DSA with NIST curve P-256 or P-384

• SIGNING_KEY_SCHEME_EC_DSA_P384 = 3

Used in: SigningPublicKey

• SIGNING_KEY_SPEC_UNSPECIFIED = 0

• SIGNING_KEY_SPEC_EC_CURVE25519 = 1

  Elliptic Curve Key from Curve25519 as defined in http://ed25519.cr.yp.to/

• SIGNING_KEY_SPEC_EC_P256 = 2

  Elliptic Curve Key from the NIST P-256 curve (aka secp256r1) as defined in https://doi.org/10.6028/NIST.FIPS.186-4

• SIGNING_KEY_SPEC_EC_P384 = 3

  Elliptic Curve Key from the NIST P-384 curve (aka secp384r1) as defined in https://doi.org/10.6028/NIST.FIPS.186-4

• SIGNING_KEY_SPEC_EC_SECP256K1 = 4

  Elliptic Curve Key from SECG P256k1 curve (aka secp256k1) commonly used in bitcoin and ethereum as defined in https://www.secg.org/sec2-v2.pdf

Used in: SigningPublicKey

• SIGNING_KEY_USAGE_UNSPECIFIED = 0

• SIGNING_KEY_USAGE_NAMESPACE = 1

  the root namespace key that defines a node's identity and signs topology requests

• SIGNING_KEY_USAGE_IDENTITY_DELEGATION = 2

  No longer used (only kept for backwards compatibility)

• SIGNING_KEY_USAGE_SEQUENCER_AUTHENTICATION = 3

  keys that authenticate members of the network towards a sequencer

• SIGNING_KEY_USAGE_PROTOCOL = 4

  keys that deal with all the signing that happens as part of the protocol

• SIGNING_KEY_USAGE_PROOF_OF_OWNERSHIP = 5

  used internally to identify keys that can self-sign to prove ownership

Used in: NamespaceDelegation, PartyToKeyMapping

• CryptoKeyFormat format = 2

• bytes public_key = 3

  Serialized public key in the format specified above

• SigningKeyScheme scheme = 4

  No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.

• repeated SigningKeyUsage usage = 5

  Explicitly state the key's intended use

• SigningKeySpec key_spec = 6

  The key specification that was used to generate the key pair

Used in: GenerateTransactionRequestProposal

• oneof store

  • StoreId.Authorized authorized = 1

  • Synchronizer synchronizer = 2

  • StoreId.Temporary temporary = 3

Used in: StoreId

(message has no fields)

Used in: StoreId

• string name = 1

Used in: StoreId

• oneof kind

  • string id = 1

  • string physical_id = 2

Used in: Value

• repeated TextMap.Entry entries = 1

Used in: TextMap

• string key = 1

• optional Value value = 2

Used in: GenerateTransactionRequestProposal

• TOPOLOGY_CHANGE_OP_UNSPECIFIED = 0

• TOPOLOGY_CHANGE_OP_ADD_REPLACE = 1

  Adds a new or replaces an existing mapping

• TOPOLOGY_CHANGE_OP_REMOVE = 2

  Remove an existing mapping

Used in: GenerateTransactionRequestProposal

• oneof mapping

  • NamespaceDelegation namespace_delegation = 1

  • PartyToParticipant party_to_participant = 9

  • PartyToKeyMapping party_to_key_mapping = 16

Used in: CanSignSpecificMappings

• TOPOLOGY_MAPPING_CODE_UNSPECIFIED = 0

• TOPOLOGY_MAPPING_CODE_NAMESPACE_DELEGATION = 1

• TOPOLOGY_MAPPING_CODE_DECENTRALIZED_NAMESPACE_DEFINITION = 3

• TOPOLOGY_MAPPING_CODE_OWNER_TO_KEY_MAPPING = 4

• TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_TRUST_CERTIFICATE = 5

• TOPOLOGY_MAPPING_CODE_PARTICIPANT_PERMISSION = 6

• TOPOLOGY_MAPPING_CODE_PARTY_HOSTING_LIMITS = 7

• TOPOLOGY_MAPPING_CODE_VETTED_PACKAGES = 8

• TOPOLOGY_MAPPING_CODE_PARTY_TO_PARTICIPANT = 9

• TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_PARAMETERS_STATE = 11

• TOPOLOGY_MAPPING_CODE_MEDIATOR_SYNCHRONIZER_STATE = 12

• TOPOLOGY_MAPPING_CODE_SEQUENCER_SYNCHRONIZER_STATE = 13

• TOPOLOGY_MAPPING_CODE_SEQUENCING_DYNAMIC_PARAMETERS_STATE = 17

• TOPOLOGY_MAPPING_CODE_PARTY_TO_KEY_MAPPING = 18

• TOPOLOGY_MAPPING_CODE_SYNCHRONIZER_MIGRATION_ANNOUNCEMENT = 19

• TOPOLOGY_MAPPING_CODE_SEQUENCER_CONNECTION_SUCCESSOR = 20

Used in: Create, Exercise, GenMap.Entry, GlobalKey, List, Metadata.GlobalKeyMappingEntry, Optional, RecordField, TextMap.Entry, Variant

• oneof sum

  • Empty unit = 1

  • bool boolean = 2

  • sint64 int64 = 3

  • int32 date = 4

  • sfixed64 timestamp = 5

  • string numeric = 6

  • string party = 7

  • string text = 8

  • string contract_id = 9

  • Optional optional = 10

  • List list = 11

  • TextMap text_map = 12

  • GenMap gen_map = 13

  • Record record = 14

  • Variant variant = 15

  • Enum enum_t = 16

Used in: Value

• optional Identifier variant_id = 1

• string constructor = 2

• optional Value value = 3