feat(config): add --clear-cache flag (#2701)

<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.

NOTE: PR titles should follow semantic commits:
https://www.conventionalcommits.org/en/v1.0.0/
-->

## Overview

Note, the flag is added in the config, like RootDir, but this will
actually never be written in the yaml.
This is expected.

<!-- 
Please provide an explanation of the PR, including the appropriate
context,
background, goal, and rationale. If there is an issue with this
information,
please provide a tl;dr and link the issue. 

Ex: Closes #<issue number>
-->

Author: julienrbrt

apps/evm/single/cmd/rollback.go

@@ -70,8 +70,7 @@ func NewRollbackCmd() *cobra.Command {
 			}
 
 			if skipP2PStores {
-				fmt.Printf("Rolled back ev-node state to height %d\n", height)
-				return nil
+				return printSuccess(height)
 			}
 
 			// rollback ev-node goheader state
@@ -111,8 +110,7 @@ func NewRollbackCmd() *cobra.Command {
 				return fmt.Errorf("failed to rollback data sync service state: %w", err)
 			}
 
-			fmt.Printf("Rolled back state to height %d\n", height)
-			return nil
+			return printSuccess(height)
 		},
 	}
 
@@ -122,3 +120,9 @@ func NewRollbackCmd() *cobra.Command {
 
 	return cmd
 }
+
+func printSuccess(height uint64) error {
+	fmt.Printf("Rolled back ev-node state to height %d\n", height)
+	fmt.Println("Restart the node with the `--clear-cache` flag")
+	return nil
+}

apps/testapp/cmd/rollback.go

@@ -76,8 +76,7 @@ func NewRollbackCmd() *cobra.Command {
 			}
 
 			if skipP2PStores {
-				fmt.Printf("Rolled back ev-node state to height %d\n", height)
-				return nil
+				return printSuccess(height)
 			}
 
 			// rollback ev-node goheader state
@@ -122,8 +121,7 @@ func NewRollbackCmd() *cobra.Command {
 				return fmt.Errorf("rollback failed: %w", err)
 			}
 
-			fmt.Printf("Rolled back state to height %d\n", height)
-			return nil
+			return printSuccess(height)
 		},
 	}
 
@@ -132,3 +130,9 @@ func NewRollbackCmd() *cobra.Command {
 	cmd.Flags().BoolVar(&skipP2PStores, "skip-p2p-stores", false, "skip rollback p2p stores (goheaderstore)")
 	return cmd
 }
+
+func printSuccess(height uint64) error {
+	fmt.Printf("Rolled back ev-node state to height %d\n", height)
+	fmt.Println("Restart the node with the `--clear-cache` flag")
+	return nil
+}

block/internal/cache/manager.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/gob"
 	"fmt"
+	"os"
 	"path/filepath"
 	"sync"
 
@@ -64,8 +65,11 @@ type Manager interface {
 	// Cleanup operations
 	SaveToDisk() error
 	LoadFromDisk() error
+	ClearFromDisk() error
 }
 
+var _ Manager = (*implementation)(nil)
+
 // implementation provides the concrete implementation of cache Manager
 type implementation struct {
 	headerCache        *Cache[types.SignedHeader]
@@ -105,9 +109,16 @@ func NewManager(cfg config.Config, store store.Store, logger zerolog.Logger) (Ma
 		logger:             logger,
 	}
 
-	// Load existing cache from disk
-	if err := impl.LoadFromDisk(); err != nil {
-		logger.Warn().Err(err).Msg("failed to load cache from disk, starting with empty cache")
+	if cfg.ClearCache {
+		// Clear the cache from disk
+		if err := impl.ClearFromDisk(); err != nil {
+			logger.Warn().Err(err).Msg("failed to clear cache from disk, starting with empty cache")
+		}
+	} else {
+		// Load existing cache from disk
+		if err := impl.LoadFromDisk(); err != nil {
+			logger.Warn().Err(err).Msg("failed to load cache from disk, starting with empty cache")
+		}
 	}
 
 	return impl, nil
@@ -245,3 +256,11 @@ func (m *implementation) LoadFromDisk() error {
 
 	return nil
 }
+
+func (m *implementation) ClearFromDisk() error {
+	cachePath := filepath.Join(m.config.RootDir, "data", cacheDir)
+	if err := os.RemoveAll(cachePath); err != nil {
+		return fmt.Errorf("failed to clear cache from disk: %w", err)
+	}
+	return nil
+}

pkg/config/config.go

@@ -47,6 +47,8 @@ const (
 	FlagLazyBlockTime = FlagPrefixEvnode + "node.lazy_block_interval"
 	// FlagReadinessMaxBlocksBehind configures how many blocks behind best-known head is still considered ready
 	FlagReadinessMaxBlocksBehind = FlagPrefixEvnode + "node.readiness_max_blocks_behind"
+	// FlagClearCache is a flag for clearing the cache
+	FlagClearCache = FlagPrefixEvnode + "clear_cache"
 
 	// Data Availability configuration flags
 
@@ -127,9 +129,11 @@ const (
 
 // Config stores Rollkit configuration.
 type Config struct {
+	RootDir    string `mapstructure:"-" yaml:"-" comment:"Root directory where rollkit files are located"`
+	ClearCache bool   `mapstructure:"-" yaml:"-" comment:"Clear the cache"`
+
 	// Base configuration
-	RootDir string `mapstructure:"-" yaml:"-" comment:"Root directory where rollkit files are located"`
-	DBPath  string `mapstructure:"db_path" yaml:"db_path" comment:"Path inside the root directory where the database is located"`
+	DBPath string `mapstructure:"db_path" yaml:"db_path" comment:"Path inside the root directory where the database is located"`
 	// P2P configuration
 	P2P P2PConfig `mapstructure:"p2p" yaml:"p2p"`
 
@@ -303,6 +307,7 @@ func AddFlags(cmd *cobra.Command) {
 
 	// Add base flags
 	cmd.Flags().String(FlagDBPath, def.DBPath, "path for the node database")
+	cmd.Flags().Bool(FlagClearCache, def.ClearCache, "clear the cache")
 
 	// Node configuration flags
 	cmd.Flags().Bool(FlagAggregator, def.Node.Aggregator, "run node in aggregator mode")

pkg/config/config_test.go

@@ -105,7 +105,7 @@ func TestAddFlags(t *testing.T) {
 	assertFlagValue(t, flags, FlagRPCAddress, DefaultConfig().RPC.Address)
 
 	// Count the number of flags we're explicitly checking
-	expectedFlagCount := 38 // Update this number if you add more flag checks above
+	expectedFlagCount := 39 // Update this number if you add more flag checks above
 
 	// Get the actual number of flags (both regular and persistent)
 	actualFlagCount := 0