feat(client,simapp): inject keyring in autocli opts

CHANGELOG.md

@@ -66,8 +66,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### API Breaking Changes
 
-* (types) `module.EndBlockAppModule` has been replaced by Core API `appmodule.HasBeginBlocker`.
-* (types) `module.BeginBlockAppModule` has been replaced by Core API `appmodule.HasEndBlocker` or `module.HasABCIEndBlock` when needing validator updates.
+* (types) `module.BeginBlockAppModule` has been replaced by Core API `appmodule.HasBeginBlocker`.
+* (types) `module.EndBlockAppModule` has been replaced by Core API `appmodule.HasEndBlocker` or `module.HasABCIEndBlock` when needing validator updates.
 * (types) [#17358](https://github.com/cosmos/cosmos-sdk/pull/17358) Remove deprecated `sdk.Handler`, use `baseapp.MsgServiceHandler` instead.
 * (x/slashing) [17044](https://github.com/cosmos/cosmos-sdk/pull/17044) Use collections for `AddrPubkeyRelation`:
     * remove from `types`: `AddrPubkeyRelationKey`
@@ -174,7 +174,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Improvements
 
-* (all modules) [#15901](https://github.com/cosmos/cosmos-sdk/issues/15901) All core Cosmos SDK modules query commands have migrated to [AutoCLI](https://docs.cosmos.network/main/building-modules/autocli), ensuring parity between gRPC and CLI queries.
+* (all modules) [#15901](https://github.com/cosmos/cosmos-sdk/issues/15901) All core Cosmos SDK modules query commands have migrated to [AutoCLI](https://docs.cosmos.network/main/core/autocli), ensuring parity between gRPC and CLI queries.
 * (types) [#16890](https://github.com/cosmos/cosmos-sdk/pull/16890) Remove `GetTxCmd() *cobra.Command` and `GetQueryCmd() *cobra.Command` from `module.AppModuleBasic` interface.
 * (cli) [#16856](https://github.com/cosmos/cosmos-sdk/pull/16856) Improve `simd prune` UX by using the app default home directory and set pruning method as first variable argument (defaults to default).
 * (x/authz) [#16869](https://github.com/cosmos/cosmos-sdk/pull/16869) Improve error message when grant not found.
@@ -377,7 +377,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### CLI Breaking Changes
 
-* (all) The migration of modules to [AutoCLI](https://docs.cosmos.network/main/building-modules/autocli) led to no changes in UX but a [small change in CLI outputs](https://github.com/cosmos/cosmos-sdk/issues/16651) where results can be nested.
+* (all) The migration of modules to [AutoCLI](https://docs.cosmos.network/main/core/autocli) led to no changes in UX but a [small change in CLI outputs](https://github.com/cosmos/cosmos-sdk/issues/16651) where results can be nested.
 * (all) Query pagination flags have been renamed with the migration to AutoCLI:
     * `--limit` -> `--page-limit`
     * `--offset` -> `--page-offset`

UPGRADING.md

@@ -220,7 +220,7 @@ Users manually wiring their chain need to use the new `module.NewBasicManagerFro
 
 #### AutoCLI
 
-[`AutoCLI`](https://docs.cosmos.network/main/building-modules/autocli) has been implemented by the SDK for all its module CLI queries. This means chains must add the following in their `root.go` to enable `AutoCLI` in their application:
+[`AutoCLI`](https://docs.cosmos.network/main/core/autocli) has been implemented by the SDK for all its module CLI queries. This means chains must add the following in their `root.go` to enable `AutoCLI` in their application:
 
 ```go
 if err := autoCliOpts.EnhanceRootCommand(rootCmd); err != nil {

client/config/config.go

@@ -78,7 +78,7 @@ func ReadFromClientConfig(ctx client.Context) (client.Context, error) {
 
 	keyring, err := client.NewKeyringFromBackend(ctx, conf.KeyringBackend)
 	if err != nil {
-		return ctx, fmt.Errorf("couldn't get key ring: %w", err)
+		return ctx, fmt.Errorf("couldn't get keyring: %w", err)
 	}
 
 	ctx = ctx.WithKeyring(keyring)

client/v2/README.md

@@ -1,7 +1,186 @@
+---
+sidebar_position: 1
+---
+
 # AutoCLI
 
-The `autocli` package is a Go library for generating CLIs (command line interfaces) for Cosmos SDK-based applications. 
+:::note Synopsis
+This document details how to build CLI and REST interfaces for a module. Examples from various Cosmos SDK modules are included.
+:::
+
+:::note Pre-requisite Readings
+
+* [CLI](https://docs.cosmos.network/main/core/cli)
+
+:::
+
+The `autocli` (also known as `client/v2`) package is a [Go library](https://pkg.go.dev/cosmossdk.io/client/v2/autocli) for generating CLI (command line interface) interfaces for Cosmos SDK-based applications. It provides a simple way to add CLI commands to your application by generating them automatically based on your gRPC service definitions. Autocli generates CLI commands and flags directly from your protobuf messages, including options, input parameters, and output parameters. This means that you can easily add a CLI interface to your application without having to manually create and manage commands.
+
+## Overview
+
+`autocli` generates CLI commands and flags for each method defined in your gRPC service. By default, it generates commands for each gRPC services. The commands are named based on the name of the service method.
+
+For example, given the following protobuf definition for a service:
+
+```protobuf
+service MyService {
+  rpc MyMethod(MyRequest) returns (MyResponse) {}
+}
+```
+
+For instance, `autocli` would generate a command named `my-method` for the `MyMethod` method. The command will have flags for each field in the `MyRequest` message.
+
+It is possible to customize the generation of transactions and queries by defining options for each service.
+
+## Application Wiring
+
+Here are the steps to use AutoCLI:
+
+1. Ensure your app's modules implements the `appmodule.AppModule` interface.
+2. (optional) Configure how behave `autocli` command generation, by implementing the `func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions` method on the module.
+3. Use the `autocli.AppOptions` struct to specify the modules you defined. If you are using `depinject` / app v2, it can automatically create an instance of `autocli.AppOptions` based on your app's configuration.
+4. Use the `EnhanceRootCommand()` method provided by `autocli` to add the CLI commands for the specified modules to your root command.
+
+:::tip
+AutoCLI is additive only, meaning _enhancing_ the root command will only add subcommands that are not already registered. This means that you can use AutoCLI alongside other custom commands within your app.
+:::
+
+Here's an example of how to use `autocli` in your app:
+
+``` go
+// Define your app's modules
+testModules := map[string]appmodule.AppModule{
+    "testModule": &TestModule{},
+}
+
+// Define the autocli AppOptions
+autoCliOpts := autocli.AppOptions{
+    Modules: testModules,
+}
+
+// Create the root command
+rootCmd := &cobra.Command{
+    Use: "app",
+}
+
+if err := appOptions.EnhanceRootCommand(rootCmd); err != nil {
+    return err
+}
+
+// Run the root command
+if err := rootCmd.Execute(); err != nil {
+    return err
+}
+```
+
+### Keyring
+
+`autocli` supports a keyring for key name resolving and signing transactions. Providing a keyring is optional, but if you want to use the `autocli` generated commands to sign transactions, you must provide a keyring.
+
+:::tip
+This provides a better UX as it allows to resolve key names directly from the keyring in all transactions and commands.
+
+```sh
+<appd> q bank balances alice
+<appd> tx bank send alice bob 1000denom
+```
+
+:::
+
+The keyring to be provided to `client/v2` must match the `client/v2` keyring interface. The Cosmos SDK keyring and Hubl keyring both implement this interface.
+The keyring should be provided in the `appOptions` struct as follows, and can be gotten from the client context:
+
+:::warning
+When using AutoCLI the keyring will only be created once and before any command flag parsing.
+:::
+
+```go
+// Get the keyring from the client context
+keyring := ctx.Keyring
+// Set the keyring in the appOptions
+appOptions.Keyring = keyring
+
+err := autoCliOpts.EnhanceRootCommand(rootCmd)
+...
+```
+
+## Module Wiring & Customization
+
+The `AutoCLIOptions()` method on your module allows to specify custom commands, sub-commands or flags for each service, as it was a `cobra.Command` instance, within the `RpcCommandOptions` struct. Defining such options will customize the behavior of the `autocli` command generation, which by default generates a command for each method in your gRPC service.
+
+```go
+*autocliv1.RpcCommandOptions{
+  RpcMethod: "Params", // The name of the gRPC service
+  Use:       "params", // Command usage that is displayed in the help
+  Short:     "Query the parameters of the governance process", // Short description of the command
+  Long:      "Query the parameters of the governance process. Specify specific param types (voting|tallying|deposit) to filter results.", // Long description of the command
+  PositionalArgs: []*autocliv1.PositionalArgDescriptor{
+    {ProtoField: "params_type", Optional: true}, // Transform a flag into a positional argument
+  },
+}
+```
+
+### Specifying Subcommands
+
+By default, `autocli` generates a command for each method in your gRPC service. However, you can specify subcommands to group related commands together. To specify subcommands, use the `autocliv1.ServiceCommandDescriptor` struct.
+
+This example shows how to use the `autocliv1.ServiceCommandDescriptor` struct to group related commands together and specify subcommands in your gRPC service by defining an instance of `autocliv1.ModuleOptions` in your `autocli.go`.
+
+```go reference
+https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-beta.0/x/gov/autocli.go#L94-L97
+```
+
+### Positional Arguments
+
+By default `autocli` generates a flag for each field in your protobuf message. However, you can choose to use positional arguments instead of flags for certain fields.
+
+To add positional arguments to a command, use the `autocliv1.PositionalArgDescriptor` struct, as seen in the example below. Specify the `ProtoField` parameter, which is the name of the protobuf field that should be used as the positional argument. In addition, if the parameter is a variable-length argument, you can specify the `Varargs` parameter as `true`. This can only be applied to the last positional parameter, and the `ProtoField` must be a repeated field.
+
+Here's an example of how to define a positional argument for the `Account` method of the `auth` service:
+
+```go reference
+https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-beta.0/x/auth/autocli.go#L25-L30
+```
+
+Then the command can be used as follows, instead of having to specify the `--address` flag:
+
+```bash
+<appd> query auth account cosmos1abcd...xyz
+```
+
+### Customising Flag Names
+
+By default, `autocli` generates flag names based on the names of the fields in your protobuf message. However, you can customise the flag names by providing a `FlagOptions`. This parameter allows you to specify custom names for flags based on the names of the message fields.
+
+For example, if you have a message with the fields `test` and `test1`, you can use the following naming options to customise the flags:
+
+``` go
+autocliv1.RpcCommandOptions{ 
+    FlagOptions: map[string]*autocliv1.FlagOptions{ 
+        "test": { Name: "custom_name", }, 
+        "test1": { Name: "other_name", }, 
+    }, 
+}
+```
+
+`FlagsOptions` is defined like sub commands in the `AutoCLIOptions()` method on your module.
+
+### Combining AutoCLI with Other Commands Within A Module
+
+AutoCLI can be used alongside other commands within a module. For example, the `gov` module uses AutoCLI to generate commands for the `query` subcommand, but also defines custom commands for the `proposer` subcommands.
+
+In order to enable this behavior, set in `AutoCLIOptions()` the `EnhanceCustomCommand` field to `true`, for the command type (queries and/or transactions) you want to enhance.
+
+```go reference
+https://github.com/cosmos/cosmos-sdk/blob/fa4d87ef7e6d87aaccc94c337ffd2fe90fcb7a9d/x/gov/autocli.go#L98
+```
+
+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).
+
+## Summary
+
+`autocli` let you generate CLI to your Cosmos SDK-based applications without any cobra boilerplate. It allows you to easily generate CLI commands and flags from your protobuf messages, and provides many options for customising the behavior of your CLI application.
 
-Read more about in it the Cosmos SDK documentation:
+To further enhance your CLI experience with Cosmos SDK-based blockchains, you can use `hubl`. `hubl` is a tool that allows you to query any Cosmos SDK-based blockchain using the new AutoCLI feature of the Cosmos SDK. With `hubl`, you can easily configure a new chain and query modules with just a few simple commands.
 
-* https://docs.cosmos.network/main/building-modules/autocli
+For more information on `hubl`, including how to configure a new chain and query a module, see the [Hubl documentation](https://docs.cosmos.network/main/tooling/hubl).

client/v2/autocli/flag/address.go

@@ -50,17 +50,22 @@ func (a addressValue) String() string {
 	return a.value
 }
 
-// Set implements the flag.Value interface for addressValue it only supports bech32 addresses.
+// Set implements the flag.Value interface for addressValue.
 func (a *addressValue) Set(s string) error {
-	_, err := a.keyring.LookupAddressByKeyName(s)
+	addr, err := a.keyring.LookupAddressByKeyName(s)
 	if err == nil {
-		a.value = s
+		addrStr, err := a.addressCodec.BytesToString(addr)
+		if err != nil {
+			return fmt.Errorf("invalid account address got from keyring: %w", err)
+		}
+
+		a.value = addrStr
 		return nil
 	}
 
 	_, err = a.addressCodec.StringToBytes(s)
 	if err != nil {
-		return fmt.Errorf("invalid bech32 account address: %w", err)
+		return fmt.Errorf("invalid account address or key name: %w", err)
 	}
 
 	a.value = s
@@ -69,7 +74,7 @@ func (a *addressValue) Set(s string) error {
 }
 
 func (a addressValue) Type() string {
-	return "bech32 account address"
+	return "account address or key name"
 }
 
 type consensusAddressStringType struct{}
@@ -95,9 +100,14 @@ func (a consensusAddressValue) String() string {
 }
 
 func (a *consensusAddressValue) Set(s string) error {
-	_, err := a.keyring.LookupAddressByKeyName(s)
+	addr, err := a.keyring.LookupAddressByKeyName(s)
 	if err == nil {
-		a.value = s
+		addrStr, err := a.addressCodec.BytesToString(addr)
+		if err != nil {
+			return fmt.Errorf("invalid consensus address got from keyring: %w", err)
+		}
+
+		a.value = addrStr
 		return nil
 	}
 
@@ -115,7 +125,7 @@ func (a *consensusAddressValue) Set(s string) error {
 	var pk cryptotypes.PubKey
 	err2 := cdc.UnmarshalInterfaceJSON([]byte(s), &pk)
 	if err2 != nil {
-		return fmt.Errorf("input isn't a pubkey %w or is invalid bech32 account address: %w", err, err2)
+		return fmt.Errorf("input isn't a pubkey %w or is an invalid account address: %w", err, err2)
 	}
 
 	a.value = sdk.ConsAddress(pk.Address()).String()

client/v2/autocli/flag/builder.go

@@ -40,7 +40,7 @@ type Builder struct {
 	ValidatorAddressCodec address.Codec
 	ConsensusAddressCodec address.Codec
 
-	// Keyring
+	// Keyring implementation
 	Keyring keyring.Keyring
 }
 

client/v2/autocli/keyring/interface.go

@@ -2,5 +2,5 @@ package keyring
 
 type Keyring interface {
 	// LookupAddressByKeyName returns the address of the key with the given name.
-	LookupAddressByKeyName(name string) (string, error)
+	LookupAddressByKeyName(name string) ([]byte, error)
 }

client/v2/autocli/keyring/no_keyring.go

@@ -6,6 +6,6 @@ var _ Keyring = NoKeyring{}
 
 type NoKeyring struct{}
 
-func (k NoKeyring) LookupAddressByKeyName(name string) (string, error) {
-	return "", errors.New("no keyring configured")
+func (k NoKeyring) LookupAddressByKeyName(name string) ([]byte, error) {
+	return nil, errors.New("no keyring configured")
 }

client/v2/autocli/query_test.go

@@ -496,14 +496,14 @@ func TestAddressValidation(t *testing.T) {
 		"1", "abc", "1foo",
 		"--an-address", "regen1y74p8wyy4enfhfn342njve6cjmj5c8dtlqj7ule2",
 	)
-	assert.ErrorContains(t, err, "invalid bech32 account address")
+	assert.ErrorContains(t, err, "invalid account address")
 
 	_, err = runCmd(fixture.conn, fixture.b, buildModuleQueryCommand,
 		"echo",
 		"1", "abc", "1foo",
 		"--an-address", "cosmps1BAD_ENCODING",
 	)
-	assert.ErrorContains(t, err, "invalid bech32 account address")
+	assert.ErrorContains(t, err, "invalid account address")
 }
 
 func TestOutputFormat(t *testing.T) {

client/v2/autocli/testdata/help-deprecated-msg.golden

@@ -8,9 +8,9 @@ Flags:
       --a-bool                                                               
       --a-coin cosmos.base.v1beta1.Coin                                      
       --a-message testpb.AMessage (json)                                     
-      --a-validator-address bech32 account address                           
+      --a-validator-address account address or key name                      
   -a, --account-number uint                                                  The account number of the signing account (offline mode only)
-      --an-address bech32 account address                                    
+      --an-address account address or key name                               
       --an-enum Enum (unspecified | one | two | five | neg-three)             (default unspecified)
       --aux                                                                  Generate aux signer data instead of sending a tx
       --bools bools                                                           (default [])

client/v2/autocli/testdata/help-deprecated.golden

@@ -5,10 +5,10 @@ Usage:
 Flags:
       --a-bool                                                               
       --a-coin cosmos.base.v1beta1.Coin                                      
-      --a-consensus-address bech32 account address                           
+      --a-consensus-address account address or key name                      
       --a-message testpb.AMessage (json)                                     
-      --a-validator-address bech32 account address                           
-      --an-address bech32 account address                                    
+      --a-validator-address account address or key name                      
+      --an-address account address or key name                               
       --an-enum Enum (unspecified | one | two | five | neg-three)             (default unspecified)
       --bools bools                                                           (default [])
       --bz binary                                                            

client/v2/autocli/testdata/help-echo-msg.golden

@@ -13,9 +13,9 @@ Flags:
       --a-bool                                                               
       --a-coin cosmos.base.v1beta1.Coin                                      
       --a-message testpb.AMessage (json)                                     
-      --a-validator-address bech32 account address                           
+      --a-validator-address account address or key name                      
   -a, --account-number uint                                                  The account number of the signing account (offline mode only)
-      --an-address bech32 account address                                    
+      --an-address account address or key name                               
       --an-enum Enum (unspecified | one | two | five | neg-three)             (default unspecified)
       --aux                                                                  Generate aux signer data instead of sending a tx
       --bools bools                                                           (default [])

client/v2/autocli/testdata/help-echo.golden

@@ -12,10 +12,10 @@ echo 1 abc {}
 Flags:
       --a-bool                                                               
       --a-coin cosmos.base.v1beta1.Coin                                      some random coin
-      --a-consensus-address bech32 account address                           
+      --a-consensus-address account address or key name                      
       --a-message testpb.AMessage (json)                                     
-      --a-validator-address bech32 account address                           
-      --an-address bech32 account address                                    
+      --a-validator-address account address or key name                      
+      --an-address account address or key name                               
       --an-enum Enum (unspecified | one | two | five | neg-three)             (default unspecified)
       --bools bools                                                           (default [])
       --bz binary                                                            some bytes