feat: support get checkpoint withdraw proof in pbss

cmd/geth/main.go

@@ -94,8 +94,10 @@ var (
 		utils.TxLookupLimitFlag,
 		utils.TransactionHistoryFlag,
 		utils.StateHistoryFlag,
-		utils.ProposeBlockIntervalFlag,
 		utils.PathDBSyncFlag,
+		utils.ProposeBlockIntervalFlag,
+		utils.EnableCheckpointFlag,
+		utils.MaxCheckpointNumberFlag,
 		utils.LightServeFlag,
 		utils.LightIngressFlag,
 		utils.LightEgressFlag,

cmd/utils/flags.go

@@ -302,16 +302,28 @@ var (
 	}
 	PathDBSyncFlag = &cli.BoolFlag{
 		Name:     "pathdb.sync",
-		Usage:    "sync flush nodes cache to disk in path scheme",
+		Usage:    "Sync flush nodes cache to disk in path scheme",
 		Value:    false,
 		Category: flags.StateCategory,
 	}
 	ProposeBlockIntervalFlag = &cli.Uint64Flag{
 		Name:     "pathdb.proposeblock",
-		Usage:    "keep the same with op-proposer propose block interval",
+		Usage:    "Keep the same with op-proposer propose block interval",
 		Value:    pathdb.DefaultProposeBlockInterval,
 		Category: flags.StateCategory,
 	}
+	EnableCheckpointFlag = &cli.BoolFlag{
+		Name:     "pathdb.enablecheckpoint",
+		Usage:    "Enable trie db checkpoint for get withdraw-contract proof",
+		Value:    true,
+		Category: flags.StateCategory,
+	}
+	MaxCheckpointNumberFlag = &cli.Uint64Flag{
+		Name:     "pathdb.maxcheckpointnumber",
+		Usage:    "Max checkpoint number which will be stored",
+		Value:    pathdb.DefaultMaxCheckpointNumber,
+		Category: flags.StateCategory,
+	}
 	StateHistoryFlag = &cli.Uint64Flag{
 		Name:     "history.state",
 		Usage:    "Number of recent blocks to retain state history for (default = 90,000 blocks, 0 = entire chain)",
@@ -1874,6 +1886,12 @@ func SetEthConfig(ctx *cli.Context, stack *node.Node, cfg *ethconfig.Config) {
 	if ctx.IsSet(ProposeBlockIntervalFlag.Name) {
 		cfg.ProposeBlockInterval = ctx.Uint64(ProposeBlockIntervalFlag.Name)
 	}
+	if ctx.IsSet(EnableCheckpointFlag.Name) {
+		cfg.EnableCheckpoint = ctx.Bool(EnableCheckpointFlag.Name)
+	}
+	if ctx.IsSet(MaxCheckpointNumberFlag.Name) {
+		cfg.MaxCheckpointNumber = ctx.Uint64(MaxCheckpointNumberFlag.Name)
+	}
 	if ctx.String(GCModeFlag.Name) == "archive" && cfg.TransactionHistory != 0 {
 		cfg.TransactionHistory = 0
 		log.Warn("Disabled transaction unindexing for archive node")

core/blockchain.go

@@ -148,6 +148,9 @@ type CacheConfig struct {
 	StateScheme          string        // Scheme used to store ethereum states and merkle tree nodes on top
 	PathSyncFlush        bool          // Whether sync flush the trienodebuffer of pathdb to disk.
 	ProposeBlockInterval uint64        // Propose block to L1 block interval.
+	CheckpointDir        string        // Used to store checkpoints directory
+	EnableCheckpoint     bool          // Enable trie db checkpoint for get withdraw-contract proof
+	MaxCheckpointNumber  uint64        // Max checkpoint number which will be stored
 	SnapshotNoBuild      bool          // Whether the background generation is allowed
 	SnapshotWait         bool          // Wait for snapshot construction on startup. TODO(karalabe): This is a dirty hack for testing, nuke it
 
@@ -169,6 +172,9 @@ func (c *CacheConfig) triedbConfig() *trie.Config {
 			CleanCacheSize:       c.TrieCleanLimit * 1024 * 1024,
 			DirtyCacheSize:       c.TrieDirtyLimit * 1024 * 1024,
 			ProposeBlockInterval: c.ProposeBlockInterval,
+			CheckpointDir:        c.CheckpointDir,
+			EnableCheckpoint:     c.EnableCheckpoint,
+			MaxCheckpointNumber:  c.MaxCheckpointNumber,
 		}
 	}
 	return config

core/rawdb/database.go

@@ -664,3 +664,7 @@ func ReadChainMetadata(db ethdb.KeyValueStore) [][]string {
 	}
 	return data
 }
+
+func (db *freezerdb) NewCheckpoint(destDir string) error {
+	return errors.New("freezerdb checkpoint is unsupported")
+}

core/rawdb/table.go

@@ -17,6 +17,8 @@
 package rawdb
 
 import (
+	"errors"
+
 	"github.com/ethereum/go-ethereum/ethdb"
 )
 
@@ -35,6 +37,10 @@ func NewTable(db ethdb.Database, prefix string) ethdb.Database {
 	}
 }
 
+func (t *table) NewCheckpoint(destDir string) error {
+	return errors.New("table checkpoint is unsupported")
+}
+
 // Close is a noop to implement the Database interface.
 func (t *table) Close() error {
 	return nil

eth/backend.go

@@ -58,6 +58,7 @@ import (
 	"github.com/ethereum/go-ethereum/params"
 	"github.com/ethereum/go-ethereum/rlp"
 	"github.com/ethereum/go-ethereum/rpc"
+	"github.com/ethereum/go-ethereum/trie/triedb/pathdb"
 )
 
 // Config contains the configuration options of the ETH protocol.
@@ -208,6 +209,9 @@ func New(stack *node.Node, config *ethconfig.Config) (*Ethereum, error) {
 			TrieCommitInterval:   config.TrieCommitInterval,
 			PathSyncFlush:        config.PathSyncFlush,
 			ProposeBlockInterval: config.ProposeBlockInterval,
+			EnableCheckpoint:     config.EnableCheckpoint,
+			MaxCheckpointNumber:  config.MaxCheckpointNumber,
+			CheckpointDir:        stack.ResolvePath(pathdb.DefaultCheckpointDir),
 		}
 	)
 	// Override the chain config with provided settings.

eth/ethconfig/config.go

@@ -112,6 +112,8 @@ type Config struct {
 	StateScheme          string `toml:",omitempty"`
 	PathSyncFlush        bool   `toml:",omitempty"` // State scheme used to store ethereum state and merkle trie nodes on top
 	ProposeBlockInterval uint64 `toml:",omitempty"` // Keep the same with op-proposer propose block interval
+	EnableCheckpoint     bool   `toml:",omitempty"` // Enable trie db checkpoint for get withdraw-contract proof
+	MaxCheckpointNumber  uint64 `toml:",omitempty"` // Max checkpoint number which will be stored
 
 	// RequiredBlocks is a set of block number -> hash mappings which must be in the
 	// canonical chain of all remote peers. Setting the option makes geth verify the

ethdb/database.go

@@ -65,6 +65,7 @@ type KeyValueStore interface {
 	Iteratee
 	Compacter
 	Snapshotter
+	Checkpointer
 	io.Closer
 }
 
@@ -149,6 +150,10 @@ type AncientStater interface {
 	AncientDatadir() (string, error)
 }
 
+type Checkpointer interface {
+	NewCheckpoint(destDir string) error
+}
+
 // Reader contains the methods required to read data from both key-value as well as
 // immutable ancient data.
 type Reader interface {
@@ -188,5 +193,6 @@ type Database interface {
 	Stater
 	Compacter
 	Snapshotter
+	Checkpointer
 	io.Closer
 }

ethdb/leveldb/leveldb.go

@@ -483,3 +483,7 @@ func (snap *snapshot) Get(key []byte) ([]byte, error) {
 func (snap *snapshot) Release() {
 	snap.db.Release()
 }
+
+func (db *Database) NewCheckpoint(destDir string) error {
+	return errors.New("leveldb checkpoint is unsupported")
+}

ethdb/memorydb/memorydb.go

@@ -388,3 +388,7 @@ func (snap *snapshot) Release() {
 
 	snap.db = nil
 }
+
+func (db *Database) NewCheckpoint(destDir string) error {
+	return errors.New("memory db checkpoint is unsupported")
+}

ethdb/pebble/pebble.go

@@ -667,3 +667,10 @@ func (iter *pebbleIterator) Value() []byte {
 // Release releases associated resources. Release should always succeed and can
 // be called multiple times without causing error.
 func (iter *pebbleIterator) Release() { iter.iter.Close() }
+
+func (d *Database) NewCheckpoint(destDir string) error {
+	var opts []pebble.CheckpointOption
+	opt := pebble.WithFlushedWAL()
+	opts = append(opts, opt)
+	return d.db.Checkpoint(destDir, opts...)
+}

ethdb/remotedb/remotedb.go

@@ -22,6 +22,8 @@
 package remotedb
 
 import (
+	"errors"
+
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/ethereum/go-ethereum/ethdb"
 	"github.com/ethereum/go-ethereum/rpc"
@@ -152,3 +154,7 @@ func New(client *rpc.Client) ethdb.Database {
 		remote: client,
 	}
 }
+
+func (db *Database) NewCheckpoint(destDir string) error {
+	return errors.New("remotedb checkpoint is unsupported")
+}