From b1eaeb550a27f5839f176aeb685db511a3f679ee Mon Sep 17 00:00:00 2001
From: Dan Laine <daniel.laine@avalabs.org>
Date: Mon, 19 Feb 2024 13:34:54 -0500
Subject: [PATCH] Add proto file for service exposing views/proposals (#529)

Co-authored-by: Ron Kuris <ron.kuris@avalabs.org>
---
 grpc-testtool/proto/merkle/merkle.proto | 102 ++++++++++++++++++++++++
 1 file changed, 102 insertions(+)
 create mode 100644 grpc-testtool/proto/merkle/merkle.proto

diff --git a/grpc-testtool/proto/merkle/merkle.proto b/grpc-testtool/proto/merkle/merkle.proto
new file mode 100644
index 000000000..7519288c7
--- /dev/null
+++ b/grpc-testtool/proto/merkle/merkle.proto
@@ -0,0 +1,102 @@
+syntax = "proto3";
+
+package merkle;
+
+import "google/protobuf/empty.proto";
+
+service Merkle {
+    rpc NewProposal(NewProposalRequest) returns (NewProposalResponse);
+    rpc ProposalCommit(ProposalCommitRequest) returns (ProposalCommitResponse);
+  
+    rpc NewView(NewViewRequest) returns (NewViewResponse);
+    // The methods below may be called with a view ID that corresponds to either a (committable) proposal
+    // or (non-committable) historical view.
+    rpc ViewHas(ViewHasRequest) returns (ViewHasResponse);
+    rpc ViewGet(ViewGetRequest) returns (ViewGetResponse);
+    rpc ViewNewIteratorWithStartAndPrefix(ViewNewIteratorWithStartAndPrefixRequest) returns (ViewNewIteratorWithStartAndPrefixResponse);
+    rpc ViewRelease(ViewReleaseRequest) returns (google.protobuf.Empty);
+}
+
+message NewProposalRequest {
+  // If not given, the parent view is the current database revision.
+  optional uint32 parent_view_id = 1;
+  repeated PutRequest puts = 2;
+  // The keys being deleted.
+  repeated bytes deletes = 3;
+}
+
+message NewProposalResponse {
+  uint32 proposal_id = 1;
+}
+
+message ProposalCommitRequest {
+  uint32 proposal_id = 1;
+}
+
+message ProposalCommitResponse {
+  CommitError err = 1;
+}
+
+message NewViewRequest {
+  bytes root_id = 1;
+}
+
+message NewViewResponse {
+  uint32 view_id = 1;
+}
+
+message ViewHasRequest {
+  uint32 view_id = 1;
+  bytes key = 2;
+}
+
+message ViewHasResponse {
+  bool has = 1;
+}
+
+message ViewGetRequest {
+  uint32 view_id = 1;
+  bytes key = 2;
+}
+
+message ViewGetResponse {
+  bytes value = 1;
+  GetError err = 2;
+}
+
+message ViewNewIteratorWithStartAndPrefixRequest {
+  uint32 view_id = 1;
+  bytes start = 2;
+  bytes prefix = 3;
+}
+
+message ViewNewIteratorWithStartAndPrefixResponse {
+  uint32 iterator_id = 1;
+}
+
+message ViewReleaseRequest {
+  uint32 view_id = 1;
+}
+
+// TODO import this from the rpcdb package.
+message PutRequest {
+  bytes key = 1;
+  bytes value = 2;
+}
+
+enum GetError {
+  // ERROR_UNSPECIFIED_GET is used to indicate that no error occurred.
+  ERROR_UNSPECIFIED_GET = 0;
+  ERROR_CLOSED_GET = 1;
+  ERROR_NOT_FOUND = 2;
+}
+
+enum CommitError {
+  // ERROR_UNSPECIFIED_COMMIT is used to indicate that no error occurred.
+  ERROR_UNSPECIFIED_COMMIT = 0;
+  ERROR_CLOSED_COMMIT = 1;
+  ERROR_INVALID = 2;
+  ERROR_COMMITTED = 3;
+  ERROR_PARENT_NOT_DATABASE = 4;
+  ERROR_NON_PROPOSAL_ID = 5;
+}