Fix/proto lint (#98)

* fix proto-lint and fill out some comments as stub * run proto-all * make codecov ignore pulsar
initia-labs · Jul 12, 2024 · f25190d · f25190d
1 parent 1ab31b7
commit f25190d
Show file tree

Hide file tree

Showing 11 changed files with 15 additions and 2 deletions.
diff --git a/.codecov.yml b/.codecov.yml
@@ -29,6 +29,7 @@ ignore:
   - "custom/"
   - "**/cli"
   - "**/rest"
+  - "**/*.pulsar.go"
   - "**/*.pb.go"
   - "**/*.pb.gw.go"
   - "**/test_utils.go"

diff --git a/Makefile b/Makefile
@@ -24,7 +24,7 @@ proto-format:
 	@$(protoImage) find ./proto -name "*.proto" -exec clang-format -i {} \;
 
 proto-lint:
-	@$(protoImage) buf lint --error-format=json
+	@$(protoImage) buf lint --error-format=json ./proto
 
 proto-check-breaking:
 	@$(protoImage) buf breaking --against $(HTTPS_GIT)#branch=main

diff --git a/api/opinit/opchild/v1/types.pulsar.go b/api/opinit/opchild/v1/types.pulsar.go
diff --git a/api/opinit/ophost/v1/genesis.pulsar.go b/api/opinit/ophost/v1/genesis.pulsar.go
diff --git a/api/opinit/ophost/v1/query.pulsar.go b/api/opinit/ophost/v1/query.pulsar.go
diff --git a/proto/opinit/opchild/v1/types.proto b/proto/opinit/opchild/v1/types.proto
@@ -114,6 +114,7 @@ message PendingDeposits {
   ];
 }
 
+// CoinsWrapper defines the set of coins.
 message CoinsWrapper {
   repeated cosmos.base.v1beta1.Coin coins = 1 [
     (gogoproto.nullable)     = false,

diff --git a/proto/opinit/ophost/v1/genesis.proto b/proto/opinit/ophost/v1/genesis.proto
@@ -38,6 +38,7 @@ message Bridge {
   repeated BatchInfoWithOutput batch_infos = 8 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
 }
 
+// WrappedOutput defines a wrapped output containing its index and proposal.
 message WrappedOutput {
   uint64 output_index    = 1;
   Output output_proposal = 2 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];

diff --git a/proto/opinit/ophost/v1/query.proto b/proto/opinit/ophost/v1/query.proto
@@ -150,10 +150,12 @@ message QueryTokenPairsResponse {
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
 }
 
+// QueryLastFinalizedOutputRequest is request type for the Query/LastFinalizedOutput RPC method.
 message QueryLastFinalizedOutputRequest {
   uint64 bridge_id = 1;
 }
 
+// QueryLastFinalizedOutputResponse is response type for the Query/LastFinalizedOutput RPC method
 message QueryLastFinalizedOutputResponse {
   uint64 output_index    = 1;
   Output output_proposal = 2 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
@@ -174,7 +176,7 @@ message QueryOutputProposalResponse {
 
 // QueryOutputProposalsRequest is response type for the Query/OutputProposals RPC method
 message QueryOutputProposalsRequest {
-  uint64 bridge_id    = 1;
+  uint64 bridge_id = 1;
   // pagination defines the pagination in the request.
   cosmos.base.query.v1beta1.PageRequest pagination = 3;
 }

diff --git a/x/opchild/types/types.pb.go b/x/opchild/types/types.pb.go
diff --git a/x/ophost/types/genesis.pb.go b/x/ophost/types/genesis.pb.go
diff --git a/x/ophost/types/query.pb.go b/x/ophost/types/query.pb.go