Move genesis commands to a sub-command and add the SDK's auto-cli commands.

CHANGELOG.md

@@ -83,6 +83,13 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * Clean up all the module codecs [#1957](https://github.com/provenance-io/provenance/pull/1957).
 * Switch to auto-generated `String` and `Equal` methods for most proto messages [#1957](https://github.com/provenance-io/provenance/pull/1957).
 * Clean up the marker module's expected BankKeeper interface [#1954](https://github.com/provenance-io/provenance/pull/1954).
+* Add the auto-cli commands and a few others newly added by the SDK [#1971](https://github.com/provenance-io/provenance/pull/1971).
+
+### Client Breaking
+
+* The `provenanced query account` command has been removed. It is still available as `provenanced query auth account` [#1971](https://github.com/provenance-io/provenance/pull/1971).
+* Move the genesis-related commands into a new `genesis` sub-command, and remove the `genesis-` parts of their names [#1971](https://github.com/provenance-io/provenance/pull/1971).
+* Many of the SDK's query commands have had their usage altered [#1971](https://github.com/provenance-io/provenance/pull/1971).
 
 ### Deprecated
 

app/app.go

@@ -19,6 +19,8 @@
 	abci "github.com/cometbft/cometbft/abci/types"
 	cmtos "github.com/cometbft/cometbft/libs/os"
 
+	"cosmossdk.io/client/v2/autocli"
+	"cosmossdk.io/core/appmodule"
 	"cosmossdk.io/log"
 	sdkmath "cosmossdk.io/math"
 	storetypes "cosmossdk.io/store/types"
@@ -42,6 +44,7 @@
 	"github.com/cosmos/cosmos-sdk/codec/address"
 	"github.com/cosmos/cosmos-sdk/codec/types"
 	"github.com/cosmos/cosmos-sdk/runtime"
+	runtimeservices "github.com/cosmos/cosmos-sdk/runtime/services"
 	"github.com/cosmos/cosmos-sdk/server/api"
 	serverconfig "github.com/cosmos/cosmos-sdk/server/config"
 	servertypes "github.com/cosmos/cosmos-sdk/server/types"
@@ -1320,6 +1323,28 @@
 	nodeservice.RegisterNodeService(clientCtx, app.GRPCQueryRouter(), cfg)
 }
 
+// AutoCliOpts returns the autocli options for the app.
+func (app *App) AutoCliOpts() autocli.AppOptions {
+	modules := make(map[string]appmodule.AppModule, 0)
+	for _, m := range app.mm.Modules {
+		if moduleWithName, ok := m.(module.HasName); ok {
+			moduleName := moduleWithName.Name()
+			if appModule, ok := moduleWithName.(appmodule.AppModule); ok {
+				modules[moduleName] = appModule
+			}
+		}
+	}
+
+	cfg := sdk.GetConfig()
+	return autocli.AppOptions{
+		Modules:               modules,
+		ModuleOptions:         runtimeservices.ExtractAutoCLIOptions(app.mm.Modules),
+		AddressCodec:          authcodec.NewBech32Codec(cfg.GetBech32AccountAddrPrefix()),
+		ValidatorAddressCodec: authcodec.NewBech32Codec(cfg.GetBech32ValidatorAddrPrefix()),
+		ConsensusAddressCodec: authcodec.NewBech32Codec(cfg.GetBech32ConsensusAddrPrefix()),
+	}
+}
+
 // RegisterSwaggerAPI registers swagger route with API Server
 func RegisterSwaggerAPI(_ client.Context, rtr *mux.Router) {
 	statikFS, err := fs.New()

cmd/provenanced/cmd/addresses.go

@@ -102,8 +102,9 @@ Excess (hex): %s
 // AddMetaAddressEncoder returns metadata address encoder cobra Command.
 func AddMetaAddressEncoder() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "encode [type] [uuid] [uuid|name]",
-		Short: "Encodes metadata uuids to bech32 address for specific type",
+		Use:     "encode [type] [uuid] [uuid|name]",
+		Aliases: []string{"e"},
+		Short:   "Encodes metadata uuids to bech32 address for specific type",
 		Long: fmt.Sprintf(`Encodes metadata uuids to bech32 address for specific type.
 
 %[1]s encode type uuid [uuid|name]

cmd/provenanced/cmd/cmd_test.go

@@ -10,7 +10,6 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/genutil/client/cli"
 
 	"github.com/provenance-io/provenance/cmd/provenanced/cmd"
-	"github.com/provenance-io/provenance/testutil/assertions"
 )
 
 func TestInitCmd(t *testing.T) {
@@ -28,59 +27,3 @@ func TestInitCmd(t *testing.T) {
 	err := cmd.Execute(rootCmd)
 	require.NoError(t, err)
 }
-
-func TestGenAutoCompleteCmd(t *testing.T) {
-	home := t.TempDir()
-
-	tests := []struct {
-		name string
-		args []string
-		err  string
-	}{
-		{
-			name: "failure - missing arg",
-			err:  "accepts 1 arg(s), received 0",
-		},
-		{
-			name: "failure - too many args",
-			args: []string{"bash", "fish"},
-			err:  "accepts 1 arg(s), received 2",
-		},
-		{
-			name: "failure - invalid shell type",
-			args: []string{"badshellname"},
-			err:  "shell badshellname is not supported",
-		},
-		{
-			name: "success - works with bash",
-			args: []string{"bash"},
-		},
-		{
-			name: "success - works with zsh",
-			args: []string{"zsh"},
-		},
-		{
-			name: "success - works with fish",
-			args: []string{"fish"},
-		},
-		{
-			name: "success - works with powershell",
-			args: []string{"powershell"},
-		},
-	}
-
-	for _, tc := range tests {
-		t.Run(tc.name, func(t *testing.T) {
-			args := []string{"--home", home, "enable-cli-autocomplete"}
-			args = append(args, tc.args...)
-
-			rootCmd, _ := cmd.NewRootCmd(false)
-			rootCmd.SetArgs(args)
-			rootCmd.SetOut(io.Discard)
-			rootCmd.SetErr(io.Discard)
-
-			err := cmd.Execute(rootCmd)
-			assertions.AssertErrorValue(t, err, tc.err, "should have the correct output value")
-		})
-	}
-}

cmd/provenanced/cmd/config_test.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/server"
+	sdk "github.com/cosmos/cosmos-sdk/types"
 
 	"github.com/provenance-io/provenance/app"
 	simappparams "github.com/provenance-io/provenance/app/params"
@@ -46,10 +47,15 @@ type ConfigTestSuite struct {
 	BaseFNApp    string
 	BaseFNCMT    string
 	baseFNClient string
+
+	origAddrCacheEnabled bool
 }
 
 func (s *ConfigTestSuite) SetupTest() {
 	s.Home = s.T().TempDir()
+	s.origAddrCacheEnabled = sdk.IsAddrCacheEnabled()
+	sdk.SetAddrCacheEnabled(false)
+
 	s.T().Logf("%s Home: %s", s.T().Name(), s.Home)
 
 	pioconfig.SetProvenanceConfig("confcoin", 5)
@@ -81,6 +87,10 @@ func (s *ConfigTestSuite) SetupTest() {
 	s.ensureConfigFiles()
 }
 
+func (s *ConfigTestSuite) TearDownTest() {
+	sdk.SetAddrCacheEnabled(s.origAddrCacheEnabled)
+}
+
 func TestConfigTestSuite(t *testing.T) {
 	suite.Run(t, new(ConfigTestSuite))
 }

cmd/provenanced/cmd/docgen.go

@@ -3,6 +3,7 @@ package cmd
 import (
 	"fmt"
 	"os"
+	"strings"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/cobra/doc"
@@ -101,3 +102,88 @@ func exists(dir string) bool {
 	_, err := os.Stat(dir)
 	return err == nil
 }
+
+// GetTreeCmd gets the tree command that will output all the commands available.
+func GetTreeCmd() *cobra.Command {
+	aliasesFlag := "aliases"
+	cmd := &cobra.Command{
+		Use:    "tree [sub-command]",
+		Short:  "Get a tree of the commands optionally limited to a specific sub-command",
+		Hidden: true,
+		Args:   cobra.ArbitraryArgs,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if len(args) > 0 && args[0] != "provenanced" {
+				args = append([]string{"provenanced"}, args...)
+			}
+
+			incAliases, _ := cmd.Flags().GetBool(aliasesFlag)
+			cmds := getAllCommands(cmd.Root(), "", args, incAliases)
+			cmd.Printf(strings.Join(cmds, "\n") + "\n")
+			return nil
+		},
+	}
+	cmd.Flags().Bool(aliasesFlag, false, "Include command aliases in the output")
+
+	return cmd
+}
+
+// hasNameOrAlias returns true if the provided command as a name or an alias equal to the provided arg.
+func hasNameOrAlias(cmd *cobra.Command, arg string) bool {
+	if cmd.Name() == arg {
+		return true
+	}
+	for _, alias := range cmd.Aliases {
+		if alias == arg {
+			return true
+		}
+	}
+	return false
+}
+
+// getNameAndAliases gets a list of the command's name and aliases (without any duplicates).
+func getNameAndAliases(cmd *cobra.Command) []string {
+	rv := make([]string, 1, 1+len(cmd.Aliases))
+	rv[0] = cmd.Name()
+	for _, alias := range cmd.Aliases {
+		known := false
+		for _, prev := range rv {
+			if prev == alias {
+				known = true
+			}
+		}
+		if !known {
+			rv = append(rv, alias)
+		}
+	}
+	return rv
+}
+
+// getAllCommands gets all of the possible commands under the given command.
+func getAllCommands(cmd *cobra.Command, prev string, limitTo []string, incAliases bool) []string {
+	if len(limitTo) > 0 {
+		if !hasNameOrAlias(cmd, limitTo[0]) {
+			return nil
+		}
+		limitTo = limitTo[1:]
+	}
+
+	name := cmd.Name()
+	if incAliases {
+		names := getNameAndAliases(cmd)
+		if len(names) > 1 {
+			name = "[" + strings.Join(names, " ") + "]"
+		}
+	}
+	cur := strings.TrimSpace(prev + " " + name)
+
+	subCmds := cmd.Commands()
+	if len(subCmds) == 0 {
+		return []string{cur}
+	}
+
+	var rv []string
+	for _, subCmd := range subCmds {
+		rv = append(rv, getAllCommands(subCmd, cur, limitTo, incAliases)...)
+	}
+	return rv
+}