feat(server/v2) Add prune cmd to serverv2

server/v2/cometbft/server.go

@@ -215,7 +215,7 @@ func (s *CometBFTServer[T]) StartCmdFlags() pflag.FlagSet {
 	return flags
 }
 
-func (s *CometBFTServer[T]) CLICommands() serverv2.CLIConfig {
+func (s *CometBFTServer[T]) CLICommands(_ serverv2.AppCreator[T]) serverv2.CLIConfig {
 	return serverv2.CLIConfig{
 		Commands: []*cobra.Command{
 			s.StatusCommand(),

server/v2/commands.go

@@ -70,7 +70,7 @@ func Commands(rootCmd *cobra.Command, newApp AppCreator[transaction.Tx], logger
 		},
 	}
 
-	cmds := server.CLICommands()
+	cmds := server.CLICommands(newApp)
 	cmds.Commands = append(cmds.Commands, startCmd)
 
 	return cmds, nil

server/v2/server.go

@@ -26,7 +26,7 @@ type ServerComponent[T transaction.Tx] interface {
 
 // HasCLICommands is a server module that has CLI commands.
 type HasCLICommands interface {
-	CLICommands() CLIConfig
+	CLICommands(AppCreator[transaction.Tx]) CLIConfig
 }
 
 // HasConfig is a server module that has a config.
@@ -118,13 +118,13 @@ func (s *Server) Stop(ctx context.Context) error {
 }
 
 // CLICommands returns all CLI commands of all components.
-func (s *Server) CLICommands() CLIConfig {
+func (s *Server) CLICommands(appCreator AppCreator[transaction.Tx]) CLIConfig {
 	commands := CLIConfig{}
 	for _, mod := range s.components {
 		if climod, ok := mod.(HasCLICommands); ok {
-			commands.Commands = append(commands.Commands, climod.CLICommands().Commands...)
-			commands.Queries = append(commands.Queries, climod.CLICommands().Queries...)
-			commands.Txs = append(commands.Txs, climod.CLICommands().Txs...)
+			commands.Commands = append(commands.Commands, climod.CLICommands(appCreator).Commands...)
+			commands.Queries = append(commands.Queries, climod.CLICommands(appCreator).Queries...)
+			commands.Txs = append(commands.Txs, climod.CLICommands(appCreator).Txs...)
 		}
 	}
 

server/v2/store/commands.go

@@ -0,0 +1,125 @@
+package store
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/spf13/cast"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+
+	"cosmossdk.io/core/transaction"
+	"cosmossdk.io/log"
+	serverv2 "cosmossdk.io/server/v2"
+	pruningtypes "cosmossdk.io/store/pruning/types"
+	storev2 "cosmossdk.io/store/v2"
+
+	"github.com/cosmos/cosmos-sdk/version"
+)
+
+// QueryBlockResultsCmd implements the default command for a BlockResults query.
+func (s StoreComponent) PrunesCmd(appCreator serverv2.AppCreator[transaction.Tx]) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "prune [pruning-method]",
+		Short: "Prune app history states by keeping the recent heights and deleting old heights",
+		Long: `Prune app history states by keeping the recent heights and deleting old heights.
+The pruning option is provided via the 'pruning' argument or alternatively with '--pruning-keep-recent'
+
+- default: the last 362880 states are kept
+- nothing: all historic states will be saved, nothing will be deleted (i.e. archiving node)
+- everything: 2 latest states will be kept
+- custom: allow pruning options to be manually specified through 'pruning-keep-recent'
+
+Note: When the --app-db-backend flag is not specified, the default backend type is 'goleveldb'.
+Supported app-db-backend types include 'goleveldb', 'rocksdb', 'pebbledb'.`,
+		Example: fmt.Sprintf("%s prune custom --pruning-keep-recent 100 --app-db-backend 'goleveldb'", version.AppName),
+		Args:    cobra.RangeArgs(0, 1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			// bind flags to the Context's Viper so we can get pruning options.
+			vp := viper.New()
+			if err := vp.BindPFlags(cmd.Flags()); err != nil {
+				return err
+			}
+			if err := vp.BindPFlags(cmd.PersistentFlags()); err != nil {
+				return err
+			}
+
+			// use the first argument if present to set the pruning method
+			if len(args) > 0 {
+				vp.Set(FlagPruning, args[0])
+			} else {
+				vp.Set(FlagPruning, pruningtypes.PruningOptionDefault)
+			}
+			pruningOptions, err := getPruningOptionsFromFlags(vp)
+			if err != nil {
+				return err
+			}
+
+			cmd.Printf("get pruning options from command flags, strategy: %v, keep-recent: %v\n",
+				pruningOptions.Strategy,
+				pruningOptions.KeepRecent,
+			)
+
+			logger := log.NewLogger(cmd.OutOrStdout())
+			app := appCreator(logger, vp)
+			store := app.GetStore()
+
+			rootStore, ok := store.(storev2.RootStore)
+			if !ok {
+				return fmt.Errorf("currently only support the pruning of rootmulti.Store type")
+			}
+			latestHeight, err := rootStore.GetLatestVersion()
+			if err != nil {
+				return err
+			}
+
+			// valid heights should be greater than 0.
+			if latestHeight <= 0 {
+				return fmt.Errorf("the database has no valid heights to prune, the latest height: %v", latestHeight)
+			}
+
+			pruningHeight := latestHeight - pruningOptions.KeepRecent
+			cmd.Printf("pruning heights up to %v\n", pruningHeight)
+
+			err = rootStore.Prune(pruningHeight)
+			if err != nil {
+				return err
+			}
+
+			cmd.Println("successfully pruned the application root multi stores")
+			return nil
+		},
+	}
+
+	cmd.Flags().String(FlagAppDBBackend, "", "The type of database for application and snapshots databases")
+	cmd.Flags().Uint64(FlagPruningKeepRecent, 0, "Number of recent heights to keep on disk (ignored if pruning is not 'custom')")
+	cmd.Flags().Uint64(FlagPruningInterval, 10,
+		`Height interval at which pruned heights are removed from disk (ignored if pruning is not 'custom'), 
+		this is not used by this command but kept for compatibility with the complete pruning options`)
+
+	return cmd
+}
+
+func getPruningOptionsFromFlags(v *viper.Viper) (pruningtypes.PruningOptions, error) {
+	strategy := strings.ToLower(cast.ToString(v.Get(FlagPruning)))
+
+	switch strategy {
+	case pruningtypes.PruningOptionDefault, pruningtypes.PruningOptionNothing, pruningtypes.PruningOptionEverything:
+		return pruningtypes.NewPruningOptionsFromString(strategy), nil
+
+	case pruningtypes.PruningOptionCustom:
+		opts := pruningtypes.NewCustomPruningOptions(
+			cast.ToUint64(v.Get(FlagPruningKeepRecent)),
+			cast.ToUint64(v.Get(FlagPruningInterval)),
+		)
+
+		if err := opts.Validate(); err != nil {
+			return opts, fmt.Errorf("invalid custom pruning options: %w", err)
+		}
+
+		return opts, nil
+
+	default:
+		return pruningtypes.PruningOptions{}, fmt.Errorf("unknown pruning strategy %s", strategy)
+	}
+}

server/v2/store/flags.go

@@ -0,0 +1,8 @@
+package store
+
+const (
+	FlagPruning           = "pruning"
+	FlagAppDBBackend      = "app-db-backend"
+	FlagPruningKeepRecent = "pruning-keep-recent"
+	FlagPruningInterval   = "pruning-interval"
+)

server/v2/store/go.mod

@@ -0,0 +1,72 @@
+module cosmossdk.io/server/v2/store
+
+go 1.22.2
+
+replace (
+	cosmossdk.io/api => ../../../api
+	cosmossdk.io/core => ../../../core
+	cosmossdk.io/core/testing => ../../../core/testing
+	cosmossdk.io/depinject => ../../../depinject
+	cosmossdk.io/log => ../../../log
+	cosmossdk.io/server/v2 => ../
+	cosmossdk.io/server/v2/appmanager => ../appmanager
+	cosmossdk.io/store => ../../../store
+	cosmossdk.io/store/v2 => ../../../store/v2
+	cosmossdk.io/x/accounts => ../../../x/accounts
+	cosmossdk.io/x/auth => ../../../x/auth
+	cosmossdk.io/x/bank => ../../../x/bank
+	cosmossdk.io/x/consensus => ../../../x/consensus
+	cosmossdk.io/x/staking => ../../../x/staking
+	github.com/cosmos/cosmos-sdk => ../../../
+)
+
+require (
+	cosmossdk.io/core v0.12.1-0.20231114100755-569e3ff6a0d7
+	cosmossdk.io/log v1.3.1
+	cosmossdk.io/server/v2 v2.0.0-00010101000000-000000000000
+	cosmossdk.io/store v1.1.1-0.20240418092142-896cdf1971bc
+	cosmossdk.io/store/v2 v2.0.0-00010101000000-000000000000
+	github.com/cosmos/cosmos-sdk v0.51.0
+	github.com/spf13/cast v1.6.0
+	github.com/spf13/cobra v1.8.1
+	github.com/spf13/viper v1.19.0
+)
+
+require (
+	cosmossdk.io/errors v1.0.1 // indirect
+	cosmossdk.io/server/v2/appmanager v0.0.0-00010101000000-000000000000 // indirect
+	github.com/cosmos/gogoproto v1.5.0 // indirect
+	github.com/cosmos/ics23/go v0.10.0 // indirect
+	github.com/fsnotify/fsnotify v1.7.0 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/hashicorp/go-immutable-radix v1.3.1 // indirect
+	github.com/hashicorp/go-metrics v0.5.3 // indirect
+	github.com/hashicorp/golang-lru v1.0.2 // indirect
+	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/rs/zerolog v1.33.0 // indirect
+	github.com/sagikazarmark/locafero v0.4.0 // indirect
+	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
+	github.com/sourcegraph/conc v0.3.0 // indirect
+	github.com/spf13/afero v1.11.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/subosito/gotenv v1.6.0 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	golang.org/x/crypto v0.24.0 // indirect
+	golang.org/x/exp v0.0.0-20240531132922-fd00a4e0eefc // indirect
+	golang.org/x/sync v0.7.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
+	golang.org/x/text v0.16.0 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240515191416-fc5f0ca64291 // indirect
+	google.golang.org/grpc v1.64.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	sigs.k8s.io/yaml v1.4.0 // indirect
+)