package ic_registry_transport.pb.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Message encoding a response to any *_certified method call.

• optional messaging.xnet.v1.MixedHashTree hash_tree = 1

  The hash tree encoding both the response and the intermediate nodes required to recompute the root hash stored in "certified_data" of the canister. Note that the contents of the tree depends on the type of request issued.

• bytes certificate = 2

  The certificate obtained from the system using ic0.data_certificate_copy.

A precondition on the version at which the value of a given key was last mutated.

Used in: RegistryAtomicMutateRequest

• bytes key = 1

• uint64 expected_version = 2

  The precondition is satisfied if and only is the version in the RegistryValue for the key is equal to this.

Message corresponding to a list of mutations to apply, atomically, to the registry canister. If any of the mutations fails, the whole operation will fail.

• repeated RegistryMutation mutations = 1

  The set of mutations to apply to the registry.

• repeated Precondition preconditions = 5

  Preconditions at the key level.

Message corresponding to the response of an atomic_mutate request. If any of mutations failed the corresponding errors will be reflected in 'errors'. Otherwise 'version' will contain the version under which all the mutations were applied.

• repeated RegistryError errors = 1

  If anything went wrong, the registry canister will set this error.

• uint64 version = 2

  The last version of the registry.

A sequence of changes made to a key in the registry.

Used in: RegistryGetChangesSinceResponse

• bytes key = 1

• repeated RegistryValue values = 2

Message corresponding to an error while performing an operation on the registry.

Used in: RegistryAtomicMutateResponse, RegistryGetChangesSinceResponse, RegistryGetValueResponse

• RegistryError.Code code = 1

• string reason = 2

  The reason for the error. This is optional.

• bytes key = 3

  The key on which the error occurred. This is optional and only present for by-key errors.

Used in: RegistryError

• MALFORMED_MESSAGE = 0

  The message had a problem like a missing field or a field that was set when it shouldn't.

• KEY_NOT_PRESENT = 1

  The 'key' specified on the request was not present in the registry.

• KEY_ALREADY_PRESENT = 2

  The 'key' specified on the request was already present.

• VERSION_NOT_LATEST = 3

  The 'version' specified in a precondition for a mutation was not the lastest version.

• VERSION_BEYOND_LATEST = 4

  The 'version' specified in a precondition for a mutation is beyond the latest version in the registry.

• INTERNAL_ERROR = 999

  A generic internal error occurred in the registry.

Message to retrieve all the changes from the registry since 'version'.

• uint64 version = 1

Message corresponding to the response from the registry canister to a get_latest_version() request.

• optional RegistryError error = 1

  If anything went wrong, the registry canister will set this error.

• uint64 version = 2

  The last version of the registry.

• repeated RegistryDelta deltas = 3

  A list of all the keys and all the values that change and all the intermediate changes since the version requested.

Message corresponding to the response from the canister to a get_latest_version() request.

• uint64 version = 1

  the latest registry version

Message to retrieve a version of some registry key from the registry canister.

• optional google.protobuf.UInt64Value version = 1

  The version of the registry key to retrieve. Optional: If not set (or set to the default value, 0), the method will return the last version.

• bytes key = 2

  The byte array corresponding to the key to retrieve from the registry. Required.

Message corresponding to the response from the canister to a get_value() request. Both 'version' and 'value' are mandatorily set if 'error' is not set.

• optional RegistryError error = 1

  If anything went wrong, the registry canister will set this error.

• uint64 version = 2

  the version at which the value corresponding to the queried key was last mutated (inserted, updated, or deleted) before at or at the version specified in the RegistryGetValueRequest.

• bytes value = 3

  The value retrieved from the registry.

A single mutation in the registry.

Used in: RegistryAtomicMutateRequest

• RegistryMutation.Type mutation_type = 1

  The type of the mutation to apply to the registry. Always required.

• bytes key = 2

  The key of the entry to mutate in the registry. Always required.

• bytes value = 3

  The value to mutate in the registry. Required for insert, update, but not for delete.

Used in: RegistryMutation

• INSERT = 0

  Key is expected to not exist in the registry at the current version. (This includes the case of a key that has existed in the past and later got deleted). The mutation will fail otherwise.

• UPDATE = 1

  Key is expected to exist in the registry at the current version. The mutation will fail otherwise.

• DELETE = 2

  Key is expected to exist in the registry at the current version. The mutation will fail otherwise.

• UPSERT = 4

  If the key does not exist at the current version, it will be created. Otherwise, the value will be updated. The name is common in the database world, and means Update or Insert.

A single change made to a key in the registry.

Used in: RegistryDelta

• bytes value = 1

  The value that was set in this mutation. If the mutation is a deletion, the field has no meaning.

• uint64 version = 2

  The version at which this mutation happened.

• bool deletion_marker = 3

  If true, this change represents a deletion.