Merge pull request #41 from initia-labs/chore/fix-description

fix descriptions and comments

proto/indexer/block/v1/query.proto

@@ -34,10 +34,10 @@ service Query {
   }
 }
 
-// BlockRequest defines the request for the Blocks RPC.
+// BlockRequest defines the request for the Block RPC.
 message BlockRequest { int64 height = 1; }
 
-// BlockResponse defines the response for the Blocks RPC.
+// BlockResponse defines the response for the Block RPC.
 message BlockResponse { Block block = 1; }
 
 // BlocksRequest defines the request for the Blocks RPC.
@@ -53,9 +53,8 @@ message BlocksResponse {
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
 }
 
-// AvgBlockTimeRequest defines the request for the AvgBlockTime RPC: no params
-// for now.
+// AvgBlockTimeRequest defines the request for the AvgBlockTime RPC.
 message AvgBlockTimeRequest {}
 
 // AvgBlockTimeResponse defines the response for the AvgBlockTime RPC.
-message AvgBlockTimeResponse { double avg_block_time = 1; }
+message AvgBlockTimeResponse { double avg_block_time = 1; }

proto/indexer/block/v1/types.proto

@@ -31,12 +31,12 @@ message Block {
   Proposer proposer = 10;
 }
 
-// Proposer represents the proposer of a block: for minitia, its the L2 operator
+// Proposer represents the proposer of a block: for minitia, it is the L2 operator
 message Proposer {
   string moniker = 1;
   // actually minitias have no identity because they haven't MsgCreateValidator,
   // but we decided to keep this field for compatibility with L1
   string identity = 2;
   string operator_address =
       3; // [(cosmos_proto.scalar) = "cosmos.AddressString"];
-}
+}

proto/indexer/info/query.proto

@@ -7,15 +7,16 @@ import "indexer/info/types.proto";
 
 option go_package = "github.com/initia-labs/kvindexer/x/kvindexer/types";
 
-// Query provides the service definition for the Token Version
+// Query provides defines the gRPC querier service.
 service Query {
-  // Version queries all the collections of an account
+  // Version queries all the versions of the submodules
   rpc Versions(QueryVersionRequest) returns (QueryVersionResponse) {
     option (google.api.http) = {
       get : "/indexer/version"
     };
   }
 
+  // VMType queries the type of the Minitia's VM
   rpc VMType(QueryVMTypeRequest) returns (QueryVMTypeResponse) {
     option (google.api.http) = {
       get : "/indexer/vmtype"

proto/indexer/pair/v1/query.proto

@@ -12,7 +12,7 @@ option go_package = "github.com/initia-labs/kvindexer/pair/types";
 
 // Query provides the service definition for the Token Pairs
 service Query {
-  // Pairs queries all the collections of an account
+  // Pairs queries all the pairs of L1 and L2
   rpc Pairs(QueryPairsRequest) returns (QueryPairsResponse) {
     option (google.api.http) = {
       get : "/indexer/pair/v1/pairs"

proto/indexer/tx/v1/query.proto

@@ -26,14 +26,14 @@ service Query {
     };
   }
 
-  // TxsByAccount queries all the collections of given account
+  // TxsByAccount queries all transactions of given account
   rpc TxsByAccount(QueryTxsByAccountRequest) returns (QueryTxsResponse) {
     option (google.api.http) = {
       get : "/indexer/tx/v1/txs/by_account/{account}"
     };
   }
 
-  // TxsByHeight queries all the collections of given height
+  // TxsByHeight queries all transactions of given height
   rpc TxsByHeight(QueryTxsByHeightRequest) returns (QueryTxsResponse) {
     option (google.api.http) = {
       get : "/indexer/tx/v1/txs/by_height/{height}"
@@ -79,4 +79,4 @@ message QueryTxsResponse {
   // txs is the list of queried transactions.
   repeated cosmos.base.abci.v1beta1.TxResponse txs = 1;
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
-}
+}