From 086573cb3b030835ac3702c873357e1c1f9db5de Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Fri, 2 Jun 2023 12:20:47 +0000 Subject: [PATCH] chore: small snapshot commands & docs improvement (backport #16404) (#16409) Co-authored-by: Julien Robert --- client/snapshot/cmd.go | 1 - client/snapshot/export.go | 6 ++---- client/snapshot/list.go | 2 +- client/snapshot/load.go | 4 ++-- server/util.go | 12 ++++++------ 5 files changed, 11 insertions(+), 14 deletions(-) diff --git a/client/snapshot/cmd.go b/client/snapshot/cmd.go index f49f2b51c2b4..14388bc8d05e 100644 --- a/client/snapshot/cmd.go +++ b/client/snapshot/cmd.go @@ -10,7 +10,6 @@ func Cmd(appCreator servertypes.AppCreator) *cobra.Command { cmd := &cobra.Command{ Use: "snapshots", Short: "Manage local snapshots", - Long: "Manage local snapshots", } cmd.AddCommand( ListSnapshotsCmd, diff --git a/client/snapshot/export.go b/client/snapshot/export.go index cc39209a08f8..cb6ebc1417a4 100644 --- a/client/snapshot/export.go +++ b/client/snapshot/export.go @@ -1,8 +1,6 @@ package snapshot import ( - "fmt" - "github.com/cosmos/cosmos-sdk/server" servertypes "github.com/cosmos/cosmos-sdk/server/types" "github.com/spf13/cobra" @@ -34,7 +32,7 @@ func ExportSnapshotCmd(appCreator servertypes.AppCreator) *cobra.Command { height = app.CommitMultiStore().LastCommitID().Version } - fmt.Printf("Exporting snapshot for height %d\n", height) + cmd.Printf("Exporting snapshot for height %d\n", height) sm := app.SnapshotManager() snapshot, err := sm.Create(uint64(height)) @@ -42,7 +40,7 @@ func ExportSnapshotCmd(appCreator servertypes.AppCreator) *cobra.Command { return err } - fmt.Printf("Snapshot created at height %d, format %d, chunks %d\n", snapshot.Height, snapshot.Format, snapshot.Chunks) + cmd.Printf("Snapshot created at height %d, format %d, chunks %d\n", snapshot.Height, snapshot.Format, snapshot.Chunks) return nil }, } diff --git a/client/snapshot/list.go b/client/snapshot/list.go index 6ff6391d4211..78612bf916ee 100644 --- a/client/snapshot/list.go +++ b/client/snapshot/list.go @@ -22,7 +22,7 @@ var ListSnapshotsCmd = &cobra.Command{ return fmt.Errorf("failed to list snapshots: %w", err) } for _, snapshot := range snapshots { - fmt.Println("height:", snapshot.Height, "format:", snapshot.Format, "chunks:", snapshot.Chunks) + cmd.Println("height:", snapshot.Height, "format:", snapshot.Format, "chunks:", snapshot.Chunks) } return nil diff --git a/client/snapshot/load.go b/client/snapshot/load.go index 6797d58bafec..7834aa21e2e7 100644 --- a/client/snapshot/load.go +++ b/client/snapshot/load.go @@ -22,7 +22,7 @@ const SnapshotFileName = "_snapshot" func LoadArchiveCmd() *cobra.Command { return &cobra.Command{ Use: "load ", - Short: "Load a snapshot archive file into snapshot store", + Short: "Load a snapshot archive file (.tar.gz) into snapshot store", Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { ctx := server.GetServerContextFromCmd(cmd) @@ -70,7 +70,7 @@ func LoadArchiveCmd() *cobra.Command { savedSnapshot, err := snapshotStore.Save(snapshot.Height, snapshot.Format, chunks) if err != nil { - fmt.Println("failed to save snapshot", err) + cmd.Println("failed to save snapshot", err) return } quitChan <- savedSnapshot diff --git a/server/util.go b/server/util.go index 8fc9c31d3ff7..73d6d308abbc 100644 --- a/server/util.go +++ b/server/util.go @@ -309,12 +309,12 @@ func interceptConfigs(rootViper *viper.Viper, customAppTemplate string, customCo return conf, nil } -// AddCommands add server commands -func AddCommands[T types.Application](rootCmd *cobra.Command, appCreator types.AppCreator[T], opts StartCmdOptions[T]) { - cometCmd := &cobra.Command{ - Use: "comet", - Aliases: []string{"cometbft", "tendermint"}, - Short: "CometBFT subcommands", +// add server commands +func AddCommands(rootCmd *cobra.Command, defaultNodeHome string, appCreator types.AppCreator, appExport types.AppExporter, addStartFlags types.ModuleInitFlags) { + tendermintCmd := &cobra.Command{ + Use: "tendermint", + Aliases: []string{"comet", "cometbft"}, + Short: "Tendermint subcommands", } cometCmd.AddCommand(