Add GRPC API for querying the list of members for a given round

release/proto/openapiv2/rpc/api/v1/api.swagger.json

@@ -70,6 +70,37 @@
         ]
       }
     },
+    "/v1/rounds/{roundId}": {
+      "get": {
+        "summary": "GetRound returns details about the given round",
+        "operationId": "PoetService_GetRound",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/v1GetRoundResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "roundId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "PoetService"
+        ]
+      }
+    },
     "/v1/start": {
       "post": {
         "summary": "Start is used to start the service.",
@@ -228,6 +259,18 @@
         }
       }
     },
+    "v1GetRoundResponse": {
+      "type": "object",
+      "properties": {
+        "members": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "format": "byte"
+          }
+        }
+      }
+    },
     "v1MerkleProof": {
       "type": "object",
       "properties": {
@@ -257,13 +300,6 @@
         "proof": {
           "$ref": "#/definitions/v1MerkleProof"
         },
-        "members": {
-          "type": "array",
-          "items": {
-            "type": "string",
-            "format": "byte"
-          }
-        },
         "leaves": {
           "type": "string",
           "format": "uint64"

rpc/api/v1/api.proto

@@ -56,6 +56,15 @@ service PoetService {
             get: "/v1/proofs/{round_id}"
         };
     }
+
+    /**
+    GetRound returns details about the given round
+    */
+    rpc GetRound(GetRoundRequest) returns (GetRoundResponse) {
+        option (google.api.http) = {
+            get: "/v1/rounds/{round_id}"
+        };
+    }
 }
 
 message StartRequest {
@@ -108,8 +117,7 @@ message MerkleProof {
 
 message PoetProof {
     MerkleProof proof = 1;
-    repeated bytes members = 2;
-    uint64 leaves = 3;
+    uint64 leaves = 2;
 }
 
 message GetProofRequest {
@@ -120,3 +128,11 @@ message GetProofResponse {
     PoetProof proof = 1;
     bytes pubkey = 2;
 }
+
+message GetRoundRequest {
+    string round_id = 1;
+}
+
+message GetRoundResponse {
+    repeated bytes members = 1;
+}

rpc/rpcserver.go

@@ -22,7 +22,7 @@ import (
 
 // rpcServer is a gRPC, RPC front end to poet.
 type rpcServer struct {
-	proofsDb   *service.ProofsDatabase
+	serviceDB  *service.ServiceDatabase
 	s          *service.Service
 	gtwManager *gateway.Manager
 	cfg        config.Config
@@ -36,12 +36,12 @@ var _ api.PoetServiceServer = (*rpcServer)(nil)
 // NewServer creates and returns a new instance of the rpcServer.
 func NewServer(
 	svc *service.Service,
-	proofsDb *service.ProofsDatabase,
+	proofsDb *service.ServiceDatabase,
 	gtwManager *gateway.Manager,
 	cfg config.Config,
 ) *rpcServer {
 	return &rpcServer{
-		proofsDb:   proofsDb,
+		serviceDB:  proofsDb,
 		s:          svc,
 		cfg:        cfg,
 		gtwManager: gtwManager,
@@ -180,7 +180,7 @@ func (r *rpcServer) GetProof(ctx context.Context, in *api.GetProofRequest) (*api
 		}
 	}
 
-	proof, err := r.proofsDb.Get(ctx, in.RoundId)
+	proof, err := r.serviceDB.GetProof(ctx, in.RoundId)
 	switch {
 	case errors.Is(err, service.ErrNotFound):
 		return nil, status.Error(codes.NotFound, "proof not found")
@@ -192,8 +192,7 @@ func (r *rpcServer) GetProof(ctx context.Context, in *api.GetProofRequest) (*api
 					ProvenLeaves: proof.ProvenLeaves,
 					ProofNodes:   proof.ProofNodes,
 				},
-				Members: proof.Members,
-				Leaves:  proof.NumLeaves,
+				Leaves: proof.NumLeaves,
 			},
 			Pubkey: proof.ServicePubKey,
 		}
@@ -203,3 +202,18 @@ func (r *rpcServer) GetProof(ctx context.Context, in *api.GetProofRequest) (*api
 		return nil, status.Error(codes.Internal, err.Error())
 	}
 }
+
+// GetRound implements apiv1.PoetServiceServer.
+func (r *rpcServer) GetRound(ctx context.Context, in *api.GetRoundRequest) (*api.GetRoundResponse, error) {
+	members, err := r.serviceDB.GetRoundMembers(ctx, in.RoundId)
+	switch {
+	case errors.Is(err, service.ErrNotFound):
+		return nil, status.Error(codes.NotFound, "round not found")
+	case err == nil:
+		out := api.GetRoundResponse{Members: members}
+
+		return &out, nil
+	default:
+		return nil, status.Error(codes.Internal, err.Error())
+	}
+}

server/server.go

@@ -101,7 +101,7 @@ func (s *Server) Start(ctx context.Context) error {
 	}
 
 	proofsDbPath := filepath.Join(s.cfg.DataDir, "proofs")
-	proofsDb, err := service.NewProofsDatabase(proofsDbPath, s.svc.ProofsChan())
+	proofsDb, err := service.NewServiceDatabase(proofsDbPath, s.svc.ProofsChan(), s.svc.RoundsDataChan())
 	if err != nil {
 		return fmt.Errorf("failed to create proofs DB: %w", err)
 	}