feat(client/v2): implement version filtering using annotation (backport

#20083) (#20099) Co-authored-by: Julien Robert <julien@rbrt.fr>
cosmos · Apr 19, 2024 · 2a32f42 · 2a32f42
1 parent a2abf1a
commit 2a32f42
Show file tree

Hide file tree

Showing 14 changed files with 983 additions and 472 deletions.
diff --git a/client/v2/CHANGELOG.md b/client/v2/CHANGELOG.md
@@ -42,9 +42,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 * (deps) [#19810](https://github.com/cosmos/cosmos-sdk/pull/19810) Upgrade SDK version to due prometheus breaking change.
 * (deps) [#19810](https://github.com/cosmos/cosmos-sdk/pull/19810) Bump `cosmossdk.io/store` to v1.1.0.
+* [#20083](https://github.com/cosmos/cosmos-sdk/pull/20083) Integrate latest version of cosmos-proto and improve version filtering.
 * [#19618](https://github.com/cosmos/cosmos-sdk/pull/19618) Marshal enum as string in queries.
 * [#19060](https://github.com/cosmos/cosmos-sdk/pull/19060) Use client context from root (or enhanced) command in autocli commands.
-  * Note, the given command must have a `client.Context` in its context.
+    * Note, the given command must have a `client.Context` in its context.
 * [#19216](https://github.com/cosmos/cosmos-sdk/pull/19216) Do not overwrite TxConfig, use directly the one provided in context. TxConfig should always be set in the `client.Context` in `root.go` of an app.
 
 ### Bug Fixes

diff --git a/client/v2/README.md b/client/v2/README.md
@@ -114,7 +114,7 @@ err := autoCliOpts.EnhanceRootCommand(rootCmd)
 ## Signing
 
 `autocli` supports signing transactions with the keyring.
-The [`cosmos.msg.v1.signer` protobuf annotation](https://github.com/cosmos/cosmos-sdk/blob/9dd34510e27376005e7e7ff3628eab9dbc8ad6dc/docs/build/building-modules/05-protobuf-annotations.md#L9) defines the signer field of the message.
+The [`cosmos.msg.v1.signer` protobuf annotation](https://docs.cosmos.network/main/build/building-modules/protobuf-annotations) defines the signer field of the message.
 This field is automatically filled when using the `--from` flag or defining the signer as a positional argument.
 
 :::warning
@@ -194,6 +194,19 @@ https://github.com/cosmos/cosmos-sdk/blob/fa4d87ef7e6d87aaccc94c337ffd2fe90fcb7a
 
 If not set to true, `AutoCLI` will not generate commands for the module if there are already commands registered for the module (when `GetTxCmd()` or `GetTxCmd()` are defined).
 
+### Skip a command
+
+AutoCLI automatically skips unsupported commands when [`cosmos_proto.method_added_in` protobuf annotation](https://docs.cosmos.network/main/build/building-modules/protobuf-annotations) is present.
+
+Additionally, a command can be manually skipped using the `autocliv1.RpcCommandOptions`:
+
+```go
+*autocliv1.RpcCommandOptions{
+  RpcMethod: "Params", // The name of the gRPC service
+  Skip: true,
+}
+```
+
 ### Use AutoCLI for non module commands
 
 It is possible to use `AutoCLI` for non module commands. The trick is still to implement the `appmodule.Module` interface and append it to the `appOptions.ModuleOptions` map.

diff --git a/client/v2/autocli/common.go b/client/v2/autocli/common.go
@@ -32,11 +32,6 @@ func (b *Builder) buildMethodCommandCommon(descriptor protoreflect.MethodDescrip
 		short = fmt.Sprintf("Execute the %s RPC method", descriptor.Name())
 	}
 
-	long := options.Long
-	if long == "" {
-		long = util.DescriptorDocs(descriptor)
-	}
-
 	inputDesc := descriptor.Input()
 	inputType := util.ResolveMessageType(b.TypeResolver, inputDesc)
 
@@ -48,7 +43,7 @@ func (b *Builder) buildMethodCommandCommon(descriptor protoreflect.MethodDescrip
 	cmd := &cobra.Command{
 		SilenceUsage: false,
 		Use:          use,
-		Long:         long,
+		Long:         options.Long,
 		Short:        short,
 		Example:      options.Example,
 		Aliases:      options.Alias,

diff --git a/client/v2/autocli/flag/builder.go b/client/v2/autocli/flag/builder.go
@@ -307,10 +307,6 @@ func (b *Builder) addFieldFlag(ctx context.Context, flagSet *pflag.FlagSet, fiel
 	}
 
 	usage := opts.Usage
-	if usage == "" {
-		usage = util.DescriptorDocs(field)
-	}
-
 	shorthand := opts.Shorthand
 	defaultValue := opts.DefaultValue
 

diff --git a/client/v2/autocli/msg.go b/client/v2/autocli/msg.go
@@ -83,7 +83,7 @@ func (b *Builder) AddMsgServiceCommands(cmd *cobra.Command, cmdDescriptor *autoc
 			continue
 		}
 
-		if !util.IsSupportedVersion(util.DescriptorDocs(methodDescriptor)) {
+		if !util.IsSupportedVersion(methodDescriptor) {
 			continue
 		}
 

diff --git a/client/v2/autocli/query.go b/client/v2/autocli/query.go
@@ -85,7 +85,7 @@ func (b *Builder) AddQueryServiceCommands(cmd *cobra.Command, cmdDescriptor *aut
 			continue
 		}
 
-		if !util.IsSupportedVersion(util.DescriptorDocs(methodDescriptor)) {
+		if !util.IsSupportedVersion(methodDescriptor) {
 			continue
 		}
 

diff --git a/client/v2/internal/buf.lock b/client/v2/internal/buf.lock
@@ -4,16 +4,30 @@ deps:
   - remote: buf.build
     owner: cosmos
     repository: cosmos-proto
-    commit: 1935555c206d4afb9e94615dfd0fad31
+    commit: 04467658e59e44bbb22fe568206e1f70
+    digest: shake256:73a640bd60e0c523b0f8237ff34eab67c45a38b64bbbde1d80224819d272dbf316ac183526bd245f994af6608b025f5130483d0133c5edd385531326b5990466
   - remote: buf.build
     owner: cosmos
     repository: cosmos-sdk
-    commit: b7797ff7f3814399b0c5d52e1b8227ed
+    commit: 05419252bcc241ea8023acf1ed4cadc5
+    digest: shake256:1e54a48c19a8b59d35e0a7efa76402939f515f2d8005df099856f24c37c20a52800308f025abb8cffcd014d437b49707388aaca4865d9d063d8f25d5d4eb77d5
   - remote: buf.build
     owner: cosmos
     repository: gogo-proto
-    commit: 6652e3443c3b4504bb3bf82e73a7e409
+    commit: 88ef6483f90f478fb938c37dde52ece3
+    digest: shake256:89c45df2aa11e0cff97b0d695436713db3d993d76792e9f8dc1ae90e6ab9a9bec55503d48ceedd6b86069ab07d3041b32001b2bfe0227fa725dd515ff381e5ba
   - remote: buf.build
     owner: googleapis
     repository: googleapis
-    commit: 62f35d8aed1149c291d606d958a7ce32
+    commit: 7e6f6e774e29406da95bd61cdcdbc8bc
+    digest: shake256:fe43dd2265ea0c07d76bd925eeba612667cf4c948d2ce53d6e367e1b4b3cb5fa69a51e6acb1a6a50d32f894f054a35e6c0406f6808a483f2752e10c866ffbf73
+  - remote: buf.build
+    owner: protocolbuffers
+    repository: wellknowntypes
+    commit: 657250e6a39648cbb169d079a60bd9ba
+    digest: shake256:00de25001b8dd2e29d85fc4bcc3ede7aed886d76d67f5e0f7a9b320b90f871d3eb73507d50818d823a0512f3f8db77a11c043685528403e31ff3fef18323a9fb
+  - remote: buf.build
+    owner: tendermint
+    repository: tendermint
+    commit: 33ed361a90514289beabf3189e1d7665
+    digest: shake256:038267e06294714fd883610626554b04a127b576b4e253befb4206cb72d5d3c1eeccacd4b9ec8e3fb891f7c14e1cb0f770c077d2989638995b0a61c85afedb1d
diff --git a/client/v2/internal/testpb/msg.proto b/client/v2/internal/testpb/msg.proto
@@ -11,10 +11,15 @@ import "testpb/query.proto";
 
 service Msg {
   // Send a request and returns the request as a response.
-  rpc Send(MsgRequest) returns (MsgResponse);
+  rpc Send(MsgRequest) returns (MsgResponse) {
+    option (cosmos_proto.method_added_in) = "cosmos-sdk v0.50.0";
+  };
+
+  rpc Clawback(MsgClawbackRequest) returns (MsgClawbackResponse) {
+    option (cosmos_proto.method_added_in) = "cosmos-sdk v0.51.0";
+  }
 }
 
-// MsgRequest is a sample request message
 message MsgRequest {
   // u32 is an uint32
   uint32                                u32        = 1;
@@ -51,3 +56,7 @@ message MsgRequest {
 message MsgResponse {
   MsgRequest request = 1;
 }
+
+message MsgClawbackRequest {}
+
+message MsgClawbackResponse {}