fix proto-lint and lint some protobufs (#226)

* fix proto-lint and lint some protobufs

* add pulsar.go to codecov's ignore list

.codecov.yml

@@ -30,6 +30,7 @@ ignore:
   - "**/cli"
   - "**/rest"
   - "**/*.pb.go"
+  - "**/*.pulsar.go"
   - "**/*.pb.gw.go"
   - "**/test_utils.go"
   - "**/module.go"

Makefile

@@ -175,7 +175,7 @@ proto-format:
 	@$(protoImage) find ./ -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

proto/buf.yaml

@@ -22,3 +22,5 @@ lint:
     - SERVICE_SUFFIX
     - PACKAGE_VERSION_SUFFIX
     - RPC_REQUEST_STANDARD_NAME
+    - ENUM_VALUE_PREFIX
+    - ENUM_ZERO_VALUE_SUFFIX

proto/ibc/applications/nft_transfer/v1/tx.proto

@@ -3,7 +3,6 @@ syntax = "proto3";
 package ibc.applications.nft_transfer.v1;
 
 import "amino/amino.proto";
-import "cosmos/base/v1beta1/coin.proto";
 import "cosmos/msg/v1/msg.proto";
 import "cosmos_proto/cosmos.proto";
 import "gogoproto/gogo.proto";

proto/ibc/applications/nft_transfer/v1/types.proto

@@ -6,7 +6,6 @@ option go_package = "github.com/initia-labs/initia/x/ibc/nft-transfer/types";
 
 import "gogoproto/gogo.proto";
 import "amino/amino.proto";
-import "cosmos_proto/cosmos.proto";
 
 // ClassTrace contains the base class id for ICS721 non fungible tokens and the
 // source tracing information path.

proto/ibc/applications/perm/v1/query.proto

@@ -12,7 +12,8 @@ option go_package = "github.com/initia-labs/initia/x/ibc/perm/types";
 // Query provides defines the gRPC querier service.
 service Query {
   // PermissionedRelayersByChannel queries a set of permissioned ibc relayers for the specific channel.
-  rpc PermissionedRelayersByChannel(QueryPermissionedRelayersByChannelRequest) returns (QueryPermissionedRelayersByChannelResponse) {
+  rpc PermissionedRelayersByChannel(QueryPermissionedRelayersByChannelRequest)
+      returns (QueryPermissionedRelayersByChannelResponse) {
     option (google.api.http).get = "/ibc/apps/perm/v1/relayers/{port_id}/{channel_id}";
   }
 

proto/ibc/applications/perm/v1/tx.proto

@@ -5,7 +5,6 @@ import "amino/amino.proto";
 import "cosmos/msg/v1/msg.proto";
 import "cosmos_proto/cosmos.proto";
 import "gogoproto/gogo.proto";
-import "ibc/applications/perm/v1/types.proto";
 option go_package = "github.com/initia-labs/initia/x/ibc/perm/types";
 
 // Msg defines the ibc/perm Msg service
@@ -14,7 +13,6 @@ service Msg {
 
   // SetPermissionedRelayers defines a rpc handler method for MsgSetPermissionedRelayers.
   rpc SetPermissionedRelayers(MsgSetPermissionedRelayers) returns (MsgSetPermissionedRelayersResponse);
-
 }
 
 // MsgSetPermissionedRelayers defines msg to set permissioned relyer for
@@ -31,12 +29,8 @@ message MsgSetPermissionedRelayers {
   string authority  = 1 [(gogoproto.moretags) = "yaml:\"authority\"", (cosmos_proto.scalar) = "cosmos.AddressString"];
   string port_id    = 2 [(gogoproto.moretags) = "yaml:\"port_id\""];
   string channel_id = 3 [(gogoproto.moretags) = "yaml:\"channel_id\""];
-  repeated string relayers    = 4 [(gogoproto.moretags) = "yaml:\"relayers\""];
+  repeated string relayers = 4 [(gogoproto.moretags) = "yaml:\"relayers\""];
 }
 
 // MsgSetPermissionedRelayersResponse defines the Msg/SetPermissionedRelayer response type.
 message MsgSetPermissionedRelayersResponse {}
-
-
-
-

proto/ibc/applications/perm/v1/types.proto

@@ -7,11 +7,13 @@ option go_package = "github.com/initia-labs/initia/x/ibc/perm/types";
 // PermissionedRelayer is used to specifiy the permissioned relayer for
 // the specific port-id:channel-id pair.
 message PermissionedRelayers {
-  string port_id    = 1;
-  string channel_id = 2;
-  repeated string relayers    = 3;
+  string          port_id    = 1;
+  string          channel_id = 2;
+  repeated string relayers   = 3;
 }
 
+// PermissionedRelayersList is used to specify the list of permissioned relayers
+// for the specific port-id:channel-id pair.
 message PermissionedRelayersList {
   repeated string relayers = 1;
 }

proto/initia/distribution/v1/genesis.proto

@@ -5,7 +5,6 @@ option go_package            = "github.com/initia-labs/initia/x/distribution/typ
 option (gogoproto.equal_all) = true;
 
 import "gogoproto/gogo.proto";
-import "cosmos/base/v1beta1/coin.proto";
 import "cosmos/distribution/v1beta1/distribution.proto";
 import "cosmos/distribution/v1beta1/genesis.proto";
 import "initia/distribution/v1/distribution.proto";

proto/initia/distribution/v1/query.proto

@@ -4,7 +4,6 @@ package initia.distribution.v1;
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
 
-import "cosmos/base/v1beta1/coin.proto";
 import "cosmos/base/query/v1beta1/pagination.proto";
 
 import "initia/distribution/v1/distribution.proto";

proto/initia/gov/v1/genesis.proto

@@ -2,11 +2,8 @@ syntax = "proto3";
 
 package initia.gov.v1;
 
-import "gogoproto/gogo.proto";
-import "google/protobuf/timestamp.proto";
 import "cosmos/gov/v1/gov.proto";
 import "initia/gov/v1/gov.proto";
-import "amino/amino.proto";
 
 option go_package = "github.com/initia-labs/initia/x/gov/types";
 

proto/initia/gov/v1/query.proto

@@ -3,11 +3,9 @@ package initia.gov.v1;
 
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
-import "google/protobuf/timestamp.proto";
 import "cosmos_proto/cosmos.proto";
 import "cosmos/base/query/v1beta1/pagination.proto";
 import "cosmos/gov/v1/gov.proto";
-import "amino/amino.proto";
 import "initia/gov/v1/gov.proto";
 
 option go_package = "github.com/initia-labs/initia/x/gov/types";

proto/initia/move/v1/types.proto

@@ -90,16 +90,15 @@ message TableEntry {
   bytes  value_bytes = 5;
 }
 
-// UpgradePolicy
-// * `compatible`
-//     Whether a compatibility check should be performed for upgrades. The check only passes if
-//     a new module has (a) the same public functions (b) for existing resources, no layout change.
-// * `immutable`
-//     Whether the modules in the package are immutable and cannot be upgraded.
+// UpgradePolicy is the policy for upgrading a move module.
 enum UpgradePolicy {
+  // UNSPECIFIED: a placeholder for an unspecified upgrade policy.
   UNSPECIFIED = 0;
-  COMPATIBLE  = 1;
-  IMMUTABLE   = 2;
+  // COMPATBILE: Whether a compatibility check should be performed for upgrades. The check only passes if
+  // a new module has (a) the same public functions (b) for existing resources, no layout change.
+  COMPATIBLE = 1;
+  // IMMUTABLE: Whether the modules in the package are immutable and cannot be upgraded.
+  IMMUTABLE = 2;
 }
 
 // proto wrapper to store the value

proto/initia/mstaking/v1/staking.proto

@@ -7,7 +7,6 @@ import "gogoproto/gogo.proto";
 import "google/protobuf/any.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
-import "tendermint/types/types.proto";
 
 option go_package = "github.com/initia-labs/initia/x/mstaking/types";
 

proto/initia/reward/v1/tx.proto

@@ -13,6 +13,7 @@ option go_package = "github.com/initia-labs/initia/x/reward/types";
 service Msg {
   option (cosmos.msg.v1.service) = true;
 
+  // UpdateParams defines a rpc handler method for MsgUpdateParams.
   rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse);
 }