package sync

Get desktop application:
View/edit binary Protocol Buffers messages

The interface required by an x/sync/SyncManager for syncing. Note this service definition only exists for use in tests. A database shouldn't expose this over the internet, as it allows for reading/writing to the database.

• rpc GetMerkleRoot (google.protobuf.Empty, GetMerkleRootResponse)

  sync.proto:22

  message GetMerkleRootResponse

  sync.proto:34

  • bytes root_hash = 1

• rpc GetProof (GetProofRequest, GetProofResponse)

  sync.proto:24

  message GetProofRequest

  sync.proto:38

  • bytes key = 1

  message GetProofResponse

  sync.proto:42

  • optional Proof proof = 1

• rpc GetChangeProof (GetChangeProofRequest, GetChangeProofResponse)

  sync.proto:26

  message GetChangeProofRequest

  sync.proto:70

  • bytes start_root_hash = 1

  • bytes end_root_hash = 2

  • optional MaybeBytes start_key = 3

  • optional MaybeBytes end_key = 4

  • uint32 key_limit = 5

  message GetChangeProofResponse

  sync.proto:78

  • oneof response

    • ChangeProof change_proof = 1

    • bool root_not_present = 2

      True iff server errored with merkledb.ErrInsufficientHistory.

• rpc VerifyChangeProof (VerifyChangeProofRequest, VerifyChangeProofResponse)

  sync.proto:27

  message VerifyChangeProofRequest

  sync.proto:86

  • optional ChangeProof proof = 1

  • optional MaybeBytes start_key = 2

  • optional MaybeBytes end_key = 3

  • bytes expected_root_hash = 4

  message VerifyChangeProofResponse

  sync.proto:93

  • string error = 1

    If empty, there was no error.

• rpc CommitChangeProof (CommitChangeProofRequest, google.protobuf.Empty)

  sync.proto:28

  message CommitChangeProofRequest

  sync.proto:98

  • optional ChangeProof proof = 1

• rpc GetRangeProof (GetRangeProofRequest, GetRangeProofResponse)

  sync.proto:30

  message GetRangeProofRequest

  sync.proto:112

  • bytes root_hash = 1

  • optional MaybeBytes start_key = 2

  • optional MaybeBytes end_key = 3

  • uint32 key_limit = 4

  message GetRangeProofResponse

  sync.proto:119

  • optional RangeProof proof = 1

• rpc CommitRangeProof (CommitRangeProofRequest, google.protobuf.Empty)

  sync.proto:31

  message CommitRangeProofRequest

  sync.proto:123

  • optional MaybeBytes start_key = 1

  • optional RangeProof range_proof = 2

Used in: CommitChangeProofRequest, GetChangeProofResponse, SyncGetChangeProofResponse, VerifyChangeProofRequest

• repeated ProofNode start_proof = 1

• repeated ProofNode end_proof = 2

• repeated KeyChange key_changes = 3

Used in: ChangeProof

• bytes key = 1

• optional MaybeBytes value = 2

Used in: RangeProof

• bytes key = 1

• bytes value = 2

Used in: CommitRangeProofRequest, GetChangeProofRequest, GetRangeProofRequest, KeyChange, Proof, ProofNode, SyncGetChangeProofRequest, SyncGetRangeProofRequest, VerifyChangeProofRequest

• bytes value = 1

• bool is_nothing = 2

  If false, this is None. Otherwise this is Some.

Used in: GetProofResponse

• bytes key = 1

• optional MaybeBytes value = 2

• repeated ProofNode proof = 3

Used in: ChangeProof, Proof, RangeProof

• optional SerializedPath key = 1

• optional MaybeBytes value_or_hash = 2

• map<uint32, bytes> children = 3

Used in: CommitRangeProofRequest, GetRangeProofResponse, SyncGetChangeProofResponse

• repeated ProofNode start = 1

• repeated ProofNode end = 2

• repeated KeyValue key_values = 3

Request represents a request for information during syncing.

• oneof message

  • SyncGetRangeProofRequest range_proof_request = 1

  • SyncGetChangeProofRequest change_proof_request = 2

Used in: ProofNode

• uint64 nibble_length = 1

• bytes value = 2

For use in sync client, which has a restriction on the size of the response. GetChangeProof in the DB service doesn't.

Used in: Request

• bytes start_root_hash = 1

• bytes end_root_hash = 2

• optional MaybeBytes start_key = 3

• optional MaybeBytes end_key = 4

• uint32 key_limit = 5

• uint32 bytes_limit = 6

• oneof response

  • ChangeProof change_proof = 1

  • RangeProof range_proof = 2

For use in sync client, which has a restriction on the size of the response. GetRangeProof in the DB service doesn't.

Used in: Request

• bytes root_hash = 1

• optional MaybeBytes start_key = 2

• optional MaybeBytes end_key = 3

• uint32 key_limit = 4

• uint32 bytes_limit = 5