From 616841b9704dac92285834382a8aa7be89845d7b Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Fri, 2 Jun 2023 12:34:34 +0000 Subject: [PATCH] chore: small snapshot commands & docs improvement (backport #16404) (#16408) 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 ++-- docs/docs/run-node/01-run-node.md | 35 ++++++++++++++++++++++++++++--- go.mod | 2 +- server/tm_cmds.go | 2 +- simapp/go.mod | 2 +- snapshots/README.md | 23 ++++++++++---------- 9 files changed, 51 insertions(+), 26 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 6465b7f1e2d6..5ce7161626de 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" @@ -33,7 +31,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)) @@ -41,7 +39,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/docs/docs/run-node/01-run-node.md b/docs/docs/run-node/01-run-node.md index 8369920707be..a040380272da 100644 --- a/docs/docs/run-node/01-run-node.md +++ b/docs/docs/run-node/01-run-node.md @@ -152,12 +152,41 @@ log_level: "state:info,p2p:info,consensus:info,x/staking:info,x/ibc:info,*error" ## State Sync -State sync is the act in which a node syncs the latest or close to the latest state of a blockchain. This is useful for users who don't want to sync all the blocks in history. You can read more here: https://docs.cometbft.com/v0.37/core/state-sync +State sync is the act in which a node syncs the latest or close to the latest state of a blockchain. This is useful for users who don't want to sync all the blocks in history. Read more in [CometBFT documentation](https://docs.cometbft.com/v0.37/core/state-sync). + +State sync works thanks to snapshots. Read how the SDK handles snapshots [here](https://github.com/cosmos/cosmos-sdk/blob/825245d/store/snapshots/README.md). ### Local State Sync Local state sync work similar to normal state sync except that it works off a local snapshot of state instead of one provided via the p2p network. The steps to start local state sync are similar to normal state sync with a few different designs. 1. As mentioned in https://docs.cometbft.com/v0.37/core/state-sync, one must set a height and hash in the config.toml along with a few rpc servers (the afromentioned link has instructions on how to do this). -2. Bootsrapping Comet state in order to start the node after the snapshot has been ingested. This can be done with the bootstrap command ` comet bootstrap-state` - +2. Run ` ` to restore a local snapshot (note: first load it from a file with the *load* command). +3. Bootsrapping Comet state in order to start the node after the snapshot has been ingested. This can be done with the bootstrap command ` comet bootstrap-state` + +### Snapshots Commands + +The Cosmos SDK provides commands for managing snapshots. +These commands can be added in an app with the following snippet in `cmd//root.go`: + +```go +import ( + "github.com/cosmos/cosmos-sdk/client/snapshot" +) + +func initRootCmd(/* ... */) { + // ... + rootCmd.AddCommand( + snapshot.Cmd(appCreator), + ) +} +``` + +Then following commands are available at ` snapshots [command]`: + +* **list**: list local snapshots +* **load**: Load a snapshot archive file into snapshot store +* **restore**: Restore app state from local snapshot +* **export**: Export app state to snapshot store +* **dump**: Dump the snapshot as portable archive format +* **delete**: Delete a local snapshot diff --git a/go.mod b/go.mod index c128bffb2736..1914ca20b333 100644 --- a/go.mod +++ b/go.mod @@ -177,7 +177,7 @@ replace ( // Fix upstream GHSA-h395-qcrw-5vmq and GHSA-3vp4-m3rf-835h vulnerabilities. // TODO Remove it: https://github.com/cosmos/cosmos-sdk/issues/10409 github.com/gin-gonic/gin => github.com/gin-gonic/gin v1.9.0 - // Downgraded to avoid bugs in following commits which caused simulations to fail. + // replace broken goleveldb github.com/syndtr/goleveldb => github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7 ) diff --git a/server/tm_cmds.go b/server/tm_cmds.go index 63b4e718d0a1..772c4fc897c8 100644 --- a/server/tm_cmds.go +++ b/server/tm_cmds.go @@ -209,7 +209,7 @@ func BootstrapStateCmd(appCreator types.AppCreator) *cobra.Command { }, } - cmd.Flags().Int64("height", 0, "Block height to bootstrap state at, if not provided will use the latest block height in app state") + cmd.Flags().Int64("height", 0, "Block height to bootstrap state at, if not provided it uses the latest block height in app state") return cmd } diff --git a/simapp/go.mod b/simapp/go.mod index c6b260784057..7a2315dd6823 100644 --- a/simapp/go.mod +++ b/simapp/go.mod @@ -170,6 +170,6 @@ replace ( // Fix upstream GHSA-h395-qcrw-5vmq and GHSA-3vp4-m3rf-835h vulnerabilities. // TODO Remove it: https://github.com/cosmos/cosmos-sdk/issues/10409 github.com/gin-gonic/gin => github.com/gin-gonic/gin v1.9.0 - // Downgraded to avoid bugs in following commits which caused simulations to fail. + // replace broken goleveldb github.com/syndtr/goleveldb => github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7 ) diff --git a/snapshots/README.md b/snapshots/README.md index c4d011f1de26..6de723246885 100644 --- a/snapshots/README.md +++ b/snapshots/README.md @@ -55,16 +55,16 @@ Snapshot settings are optional. However, if set, they have an effect on how prun persisting the heights that are multiples of `state-sync.snapshot-interval` until after the snapshot is complete. If pruning is enabled (not `pruning = "nothing"`), we avoid pruning heights that are multiples of -`state-sync.snapshot-interval` in the regular logic determined by the -pruning settings and applied after every `Commit()`. This is done to prevent a -height from being removed before a snapshot is complete. Therefore, we keep -such heights until after a snapshot is done. At this point, the height is sent to +`state-sync.snapshot-interval` in the regular logic determined by the +pruning settings and applied after every `Commit()`. This is done to prevent a +height from being removed before a snapshot is complete. Therefore, we keep +such heights until after a snapshot is done. At this point, the height is sent to the `pruning.Manager` to be pruned according to the pruning settings after the next `Commit()`. To illustrate, assume that we are currently at height 960 with `pruning-keep-recent = 50`, `pruning-interval = 10`, and `state-sync.snapshot-interval = 100`. Let's assume that the snapshot that was triggered at height `900` **just finishes**. Then, we can prune height -`900` right away (that is, when we call `Commit()` at height 960 because 900 is less than `960 - 50 = 910`. +`900` right away (that is, when we call `Commit()` at height 960 because 900 is less than `960 - 50 = 910`). Let's now assume that all conditions stay the same but the snapshot at height 900 is **not complete yet**. Then, we cannot prune it to avoid deleting a height that is still being snapshotted. Therefore, we keep track @@ -78,23 +78,22 @@ Note that in both examples, if we let current height = C, and previous height P P - `pruning-keep-recent` - `pruning-interval` <= h <= P - `pruning-keep-recent` -we can prune height h. In our first example, all heights 899 - 909 fall in this range and are pruned at height 960 as long as +we can prune height h. In our first example, all heights 899 - 909 fall in this range and are pruned at height 960 as long as h is not a snapshot height (E.g. 900). That is, we always use current height to determine at which height to prune (960) while we use previous to determine which heights are to be pruned (959 - 50 - 10 = 899-909 = 959 - 50). - ## Configuration * `state-sync.snapshot-interval` - * the interval at which to take snapshots. - * the value of 0 disables snapshots. - * if pruning is enabled, it is done after a snapshot is complete for the heights that are multiples of this interval. + * the interval at which to take snapshots. + * the value of 0 disables snapshots. + * if pruning is enabled, it is done after a snapshot is complete for the heights that are multiples of this interval. * `state-sync.snapshot-keep-recent`: - * the number of recent snapshots to keep. - * 0 means keep all. + * the number of recent snapshots to keep. + * 0 means keep all. ## Snapshot Metadata