Skip to content

Commit b16dcdd

Browse files
author
aljo242
committed
Revert "refactor: remove v1 commands and begin server removal (#23018)"
This reverts commit 6a550b9.
1 parent 0ce19f2 commit b16dcdd

File tree

71 files changed

+5405
-468
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+5405
-468
lines changed

client/pruning/main.go

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
package pruning
2+
3+
import (
4+
"errors"
5+
"fmt"
6+
"path/filepath"
7+
8+
dbm "github.com/cosmos/cosmos-db"
9+
"github.com/spf13/cobra"
10+
"github.com/spf13/viper"
11+
12+
corestore "cosmossdk.io/core/store"
13+
pruningtypes "cosmossdk.io/store/pruning/types"
14+
"cosmossdk.io/store/rootmulti"
15+
16+
"github.com/cosmos/cosmos-sdk/client"
17+
"github.com/cosmos/cosmos-sdk/client/flags"
18+
"github.com/cosmos/cosmos-sdk/server"
19+
servertypes "github.com/cosmos/cosmos-sdk/server/types"
20+
"github.com/cosmos/cosmos-sdk/version"
21+
)
22+
23+
const FlagAppDBBackend = "app-db-backend"
24+
25+
// Cmd prunes the sdk root multi store history versions based on the pruning options
26+
// specified by command flags.
27+
func Cmd[T servertypes.Application](appCreator servertypes.AppCreator[T]) *cobra.Command {
28+
cmd := &cobra.Command{
29+
Use: "prune [pruning-method]",
30+
Short: "Prune app history states by keeping the recent heights and deleting old heights",
31+
Long: `Prune app history states by keeping the recent heights and deleting old heights.
32+
The pruning option is provided via the 'pruning' argument or alternatively with '--pruning-keep-recent'
33+
34+
- default: the last 362880 states are kept
35+
- nothing: all historic states will be saved, nothing will be deleted (i.e. archiving node)
36+
- everything: 2 latest states will be kept
37+
- custom: allow pruning options to be manually specified through 'pruning-keep-recent'
38+
39+
Note: When the --app-db-backend flag is not specified, the default backend type is 'goleveldb'.
40+
Supported app-db-backend types include 'goleveldb', 'rocksdb', 'pebbledb'.`,
41+
Example: fmt.Sprintf("%s prune custom --pruning-keep-recent 100 --app-db-backend 'goleveldb'", version.AppName),
42+
Args: cobra.RangeArgs(0, 1),
43+
RunE: func(cmd *cobra.Command, args []string) error {
44+
// bind flags to the Context's Viper so we can get pruning options.
45+
vp := viper.New()
46+
if err := vp.BindPFlags(cmd.Flags()); err != nil {
47+
return err
48+
}
49+
if err := vp.BindPFlags(cmd.PersistentFlags()); err != nil {
50+
return err
51+
}
52+
53+
// must disable async pruning
54+
vp.Set(server.FlagIAVLSyncPruning, true)
55+
56+
// use the first argument if present to set the pruning method
57+
if len(args) > 0 {
58+
vp.Set(server.FlagPruning, args[0])
59+
} else {
60+
vp.Set(server.FlagPruning, pruningtypes.PruningOptionDefault)
61+
}
62+
pruningOptions, err := server.GetPruningOptionsFromFlags(vp)
63+
if err != nil {
64+
return err
65+
}
66+
67+
cmd.Printf("get pruning options from command flags, strategy: %v, keep-recent: %v\n",
68+
pruningOptions.Strategy,
69+
pruningOptions.KeepRecent,
70+
)
71+
72+
home := vp.GetString(flags.FlagHome)
73+
db, err := openDB(home, server.GetAppDBBackend(vp))
74+
if err != nil {
75+
return err
76+
}
77+
78+
// in our test, it's important to close db explicitly for pebbledb to write to disk.
79+
defer db.Close()
80+
81+
logger := client.GetLoggerFromCmd(cmd)
82+
app := appCreator(logger, db, nil, vp)
83+
cms := app.CommitMultiStore()
84+
85+
rootMultiStore, ok := cms.(*rootmulti.Store)
86+
if !ok {
87+
return errors.New("currently only support the pruning of rootmulti.Store type")
88+
}
89+
latestHeight := rootmulti.GetLatestVersion(db)
90+
// valid heights should be greater than 0.
91+
if latestHeight <= 0 {
92+
return fmt.Errorf("the database has no valid heights to prune, the latest height: %v", latestHeight)
93+
}
94+
95+
pruningHeight := latestHeight - int64(pruningOptions.KeepRecent)
96+
cmd.Printf("pruning heights up to %v\n", pruningHeight)
97+
98+
err = rootMultiStore.PruneStores(pruningHeight)
99+
if err != nil {
100+
return err
101+
}
102+
103+
cmd.Println("successfully pruned the application root multi stores")
104+
return nil
105+
},
106+
}
107+
108+
cmd.Flags().String(FlagAppDBBackend, "", "The type of database for application and snapshots databases")
109+
cmd.Flags().Uint64(server.FlagPruningKeepRecent, 0, "Number of recent heights to keep on disk (ignored if pruning is not 'custom')")
110+
cmd.Flags().Uint64(server.FlagPruningInterval, 10,
111+
`Height interval at which pruned heights are removed from disk (ignored if pruning is not 'custom'),
112+
this is not used by this command but kept for compatibility with the complete pruning options`)
113+
114+
return cmd
115+
}
116+
117+
func openDB(rootDir string, backendType dbm.BackendType) (corestore.KVStoreWithBatch, error) {
118+
dataDir := filepath.Join(rootDir, "data")
119+
return dbm.NewDB("application", backendType, dataDir)
120+
}

client/v2/go.mod

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ require (
1010
cosmossdk.io/x/tx v1.0.1
1111
github.com/cosmos/cosmos-proto v1.0.0-beta.5
1212
github.com/cosmos/cosmos-sdk v0.53.0
13+
github.com/manifoldco/promptui v0.9.0
14+
github.com/pelletier/go-toml/v2 v2.2.2
1315
github.com/spf13/cobra v1.8.1
1416
github.com/spf13/pflag v1.0.5
1517
go.uber.org/mock v0.5.0
@@ -28,6 +30,27 @@ require (
2830
github.com/cockroachdb/apd/v3 v3.2.1 // indirect
2931
github.com/dgraph-io/ristretto/v2 v2.0.0 // indirect
3032
github.com/klauspost/cpuid/v2 v2.2.9 // indirect
33+
github.com/lib/pq v1.10.9 // indirect
34+
github.com/linxGnu/grocksdb v1.9.3 // indirect
35+
github.com/magiconair/properties v1.8.9 // indirect
36+
github.com/mattn/go-colorable v0.1.13 // indirect
37+
github.com/mattn/go-isatty v0.0.20 // indirect
38+
github.com/minio/highwayhash v1.0.3 // indirect
39+
github.com/mitchellh/mapstructure v1.5.0 // indirect
40+
github.com/mtibben/percent v0.2.1 // indirect
41+
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
42+
github.com/oasisprotocol/curve25519-voi v0.0.0-20220708102147-0a8a51822cae // indirect
43+
github.com/oklog/run v1.1.0 // indirect
44+
github.com/petermattis/goid v0.0.0-20240813172612-4fcff4a6cae7 // indirect
45+
github.com/pkg/errors v0.9.1 // indirect
46+
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
47+
github.com/prometheus/client_golang v1.20.5 // indirect
48+
github.com/prometheus/client_model v0.6.1 // indirect
49+
github.com/prometheus/common v0.62.0 // indirect
50+
github.com/prometheus/procfs v0.15.1 // indirect
51+
github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 // indirect
52+
github.com/rogpeppe/go-internal v1.12.0 // indirect
53+
github.com/rs/cors v1.11.1 // indirect
3154
github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
3255
golang.org/x/arch v0.12.0 // indirect
3356
)
@@ -64,6 +87,7 @@ require (
6487
github.com/cosmos/btcutil v1.0.5 // indirect
6588
github.com/cosmos/cosmos-db v1.1.1 // indirect
6689
github.com/cosmos/go-bip39 v1.0.0
90+
github.com/cosmos/gogogateway v1.2.0 // indirect
6791
github.com/cosmos/gogoproto v1.7.0
6892
github.com/cosmos/iavl v1.3.4 // indirect
6993
github.com/cosmos/ics23/go v0.11.0 // indirect
@@ -76,18 +100,24 @@ require (
76100
github.com/dvsekhvalnov/jose2go v1.6.0 // indirect
77101
github.com/emicklei/dot v1.6.2 // indirect
78102
github.com/fatih/color v1.18.0 // indirect
103+
github.com/felixge/httpsnoop v1.0.4 // indirect
79104
github.com/fsnotify/fsnotify v1.8.0 // indirect
80105
github.com/getsentry/sentry-go v0.30.0 // indirect
81106
github.com/go-kit/log v0.2.1 // indirect
82107
github.com/go-logfmt/logfmt v0.6.0 // indirect
83108
github.com/godbus/dbus v0.0.0-20190726142602-4481cbc300e2 // indirect
109+
github.com/gogo/googleapis v1.4.1 // indirect
84110
github.com/gogo/protobuf v1.3.2 // indirect
85111
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
86112
github.com/golang/protobuf v1.5.4 // indirect
87113
github.com/golang/snappy v0.0.4 // indirect
88114
github.com/google/btree v1.1.3 // indirect
89115
github.com/google/flatbuffers v24.3.25+incompatible // indirect
90116
github.com/google/go-cmp v0.6.0 // indirect
117+
github.com/google/orderedcode v0.0.1 // indirect
118+
github.com/google/uuid v1.6.0 // indirect
119+
github.com/gorilla/handlers v1.5.2 // indirect
120+
github.com/gorilla/mux v1.8.1 // indirect
91121
github.com/gorilla/websocket v1.5.3 // indirect
92122
github.com/grpc-ecosystem/go-grpc-middleware v1.4.0 // indirect
93123
github.com/grpc-ecosystem/grpc-gateway v1.16.0 // indirect
@@ -97,6 +127,7 @@ require (
97127
github.com/hashicorp/go-metrics v0.5.4 // indirect
98128
github.com/hashicorp/go-plugin v1.6.2 // indirect
99129
github.com/hashicorp/golang-lru v1.0.2 // indirect
130+
github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
100131
github.com/hashicorp/hcl v1.0.0 // indirect
101132
github.com/hashicorp/yamux v0.1.2 // indirect
102133
github.com/hdevalence/ed25519consensus v0.2.0 // indirect
@@ -107,26 +138,6 @@ require (
107138
github.com/klauspost/compress v1.17.11 // indirect
108139
github.com/kr/pretty v0.3.1 // indirect
109140
github.com/kr/text v0.2.0 // indirect
110-
github.com/linxGnu/grocksdb v1.9.7 // indirect
111-
github.com/magiconair/properties v1.8.9 // indirect
112-
github.com/manifoldco/promptui v0.9.0
113-
github.com/mattn/go-colorable v0.1.13 // indirect
114-
github.com/mattn/go-isatty v0.0.20 // indirect
115-
github.com/mitchellh/mapstructure v1.5.0 // indirect
116-
github.com/mtibben/percent v0.2.1 // indirect
117-
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
118-
github.com/oasisprotocol/curve25519-voi v0.0.0-20230904125328-1f23a7beb09a // indirect
119-
github.com/oklog/run v1.1.0 // indirect
120-
github.com/pelletier/go-toml/v2 v2.2.3
121-
github.com/petermattis/goid v0.0.0-20240813172612-4fcff4a6cae7 // indirect
122-
github.com/pkg/errors v0.9.1 // indirect
123-
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
124-
github.com/prometheus/client_golang v1.20.5 // indirect
125-
github.com/prometheus/client_model v0.6.1 // indirect
126-
github.com/prometheus/common v0.62.0 // indirect
127-
github.com/prometheus/procfs v0.15.1 // indirect
128-
github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 // indirect
129-
github.com/rogpeppe/go-internal v1.13.1 // indirect
130141
github.com/rs/zerolog v1.33.0 // indirect
131142
github.com/sagikazarmark/locafero v0.4.0 // indirect
132143
github.com/sagikazarmark/slog-shim v0.1.0 // indirect

0 commit comments

Comments
 (0)