Add new config param to disable snapshot file creation. Defaults to f…

…alse. (#1711)
iotaledger · Dec 27, 2022 · dcff558 · dcff558
1 parent a087afa
commit dcff558
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 0 deletions.
diff --git a/config.json b/config.json
@@ -48,6 +48,7 @@
     "autoRevalidation": false
   },
   "snapshots": {
+    "enabled": false,
     "depth": 50,
     "interval": 200,
     "fullPath": "snapshots/mainnet/full_snapshot.bin",

diff --git a/config_devnet.json b/config_devnet.json
@@ -49,6 +49,7 @@
     "autoRevalidation": false
   },
   "snapshots": {
+    "enabled": false,
     "depth": 50,
     "interval": 200,
     "fullPath": "snapshots/devnet/full_snapshot.bin",

diff --git a/core/snapshot/core.go b/core/snapshot/core.go
@@ -181,6 +181,7 @@ func provide(c *dig.Container) {
 			deps.Storage,
 			deps.SyncManager,
 			deps.UTXOManager,
+			deps.NodeConfig.Bool(CfgSnapshotsEnabled),
 			deps.NetworkID,
 			networkIDSource,
 			deps.SnapshotsFullPath,

diff --git a/core/snapshot/params.go b/core/snapshot/params.go
@@ -9,6 +9,8 @@ import (
 )
 
 const (
+	// whether to generate snapshot files.
+	CfgSnapshotsEnabled = "snapshots.enabled"
 	// the depth, respectively the starting point, at which a snapshot of the ledger is generated
 	CfgSnapshotsDepth = "snapshots.depth"
 	// interval, in milestones, at which snapshot files are created (snapshots are only created if the node is synced)
@@ -42,6 +44,7 @@ var params = &node.PluginParams{
 	Params: map[string]*flag.FlagSet{
 		"nodeConfig": func() *flag.FlagSet {
 			fs := flag.NewFlagSet("", flag.ContinueOnError)
+			fs.Bool(CfgSnapshotsEnabled, false, "whether to generate snapshot files")
 			fs.Int(CfgSnapshotsDepth, 50, "the depth, respectively the starting point, at which a snapshot of the ledger is generated")
 			fs.Int(CfgSnapshotsInterval, 200, "interval, in milestones, at which snapshot files are created (snapshots are only created if the node is synced)")
 			fs.String(CfgSnapshotsFullPath, "snapshots/mainnet/full_snapshot.bin", "path to the full snapshot file")

diff --git a/documentation/docs/how_tos/managing_a_node.md b/documentation/docs/how_tos/managing_a_node.md
@@ -32,6 +32,7 @@ Another important directory is the `snapshots` directory. You can control the `s
 
 ```json
 "snapshots": {
+    "enabled": false,
     "interval": 50,
     "fullPath": "snapshots/mainnet/full_snapshot.bin",
     "deltaPath": "snapshots/mainnet/delta_snapshot.bin",
@@ -111,6 +112,7 @@ Your node's ledger accumulates many messages, which uses a significant disk capa
 
 ```json
  "snapshots": {
+    "enabled": false,
     "interval": 50,
     "fullPath": "snapshots/mainnet/full_snapshot.bin",
     "deltaPath": "snapshots/mainnet/delta_snapshot.bin",

diff --git a/documentation/docs/references/configuration.md b/documentation/docs/references/configuration.md
@@ -146,6 +146,7 @@ Example:
 
 | Name                          | Description                                                                                                                                                            | Type             |
 | :---------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------- |
+| enabled                       | whether to generate snapshot files                                                                                                                                     | bool             |
 | depth                         | The depth, respectively the starting point, at which a snapshot of the ledger is generated                                                                             | integer          |
 | interval                      | Interval, in milestones, at which snapshot files are created (snapshots are only created if the node is synced)                                                        | integer          |
 | fullPath                      | Path to the full snapshot file                                                                                                                                         | string           |
@@ -164,6 +165,7 @@ Example:
 
 ```json
   "snapshots": {
+    "enabled": false,
     "depth": 50,
     "interval": 200,
     "fullPath": "snapshots/mainnet/full_snapshot.bin",

diff --git a/pkg/snapshot/snapshot.go b/pkg/snapshot/snapshot.go
@@ -72,6 +72,7 @@ type SnapshotManager struct {
 	storage                              *storage.Storage
 	syncManager                          *syncmanager.SyncManager
 	utxoManager                          *utxo.Manager
+	snapshotCreationEnabled              bool
 	networkID                            uint64
 	networkIDSource                      string
 	snapshotFullPath                     string
@@ -108,6 +109,7 @@ func NewSnapshotManager(
 	storage *storage.Storage,
 	syncManager *syncmanager.SyncManager,
 	utxoManager *utxo.Manager,
+	snapshotCreationEnabled bool,
 	networkID uint64,
 	networkIDSource string,
 	snapshotFullPath string,
@@ -131,6 +133,7 @@ func NewSnapshotManager(
 		WrappedLogger:                        utils.NewWrappedLogger(log),
 		tangleDatabase:                       tangleDatabase,
 		utxoDatabase:                         utxoDatabase,
+		snapshotCreationEnabled:              snapshotCreationEnabled,
 		storage:                              storage,
 		syncManager:                          syncManager,
 		utxoManager:                          utxoManager,
@@ -168,6 +171,9 @@ func (s *SnapshotManager) IsSnapshottingOrPruning() bool {
 }
 
 func (s *SnapshotManager) shouldTakeSnapshot(confirmedMilestoneIndex milestone.Index) bool {
+	if !s.snapshotCreationEnabled {
+		return false
+	}
 
 	snapshotInfo := s.storage.SnapshotInfo()
 	if snapshotInfo == nil {

diff --git a/private_tangle/config_private_tangle.json b/private_tangle/config_private_tangle.json
@@ -36,6 +36,7 @@
     "autoRevalidation": false
   },
   "snapshots": {
+    "enabled": false,
     "depth": 50,
     "interval": 200,
     "fullPath": "snapshots/private_tangle/full_snapshot.bin",