forked from forks/go-ethereum
9f83e9e673
This PR adds a new `--beacon.checkpoint.file` config flag to geth and blsync which specifies a checkpoint import/export file. If a file with an existing checkpoint is specified, it is used for initialization instead of the hardcoded one (except when `--beacon.checkpoint` is also specified simultaneously). Whenever the client encounters a new valid finality update with a suitable finalized beacon block root at an epoch boundary, it saves the block root in hex format to the checkpoint file.
104 lines
3.6 KiB
Go
104 lines
3.6 KiB
Go
// Copyright 2024 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package blsync
|
|
|
|
import (
|
|
"github.com/ethereum/go-ethereum/beacon/light"
|
|
"github.com/ethereum/go-ethereum/beacon/light/api"
|
|
"github.com/ethereum/go-ethereum/beacon/light/request"
|
|
"github.com/ethereum/go-ethereum/beacon/light/sync"
|
|
"github.com/ethereum/go-ethereum/beacon/params"
|
|
"github.com/ethereum/go-ethereum/beacon/types"
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/mclock"
|
|
"github.com/ethereum/go-ethereum/ethdb/memorydb"
|
|
"github.com/ethereum/go-ethereum/event"
|
|
"github.com/ethereum/go-ethereum/log"
|
|
"github.com/ethereum/go-ethereum/rpc"
|
|
)
|
|
|
|
type Client struct {
|
|
urls []string
|
|
customHeader map[string]string
|
|
config *params.ClientConfig
|
|
scheduler *request.Scheduler
|
|
blockSync *beaconBlockSync
|
|
engineRPC *rpc.Client
|
|
|
|
chainHeadSub event.Subscription
|
|
engineClient *engineClient
|
|
}
|
|
|
|
func NewClient(config params.ClientConfig) *Client {
|
|
// create data structures
|
|
var (
|
|
db = memorydb.New()
|
|
committeeChain = light.NewCommitteeChain(db, &config.ChainConfig, config.Threshold, !config.NoFilter)
|
|
headTracker = light.NewHeadTracker(committeeChain, config.Threshold, func(checkpoint common.Hash) {
|
|
if saved, err := config.SaveCheckpointToFile(checkpoint); saved {
|
|
log.Debug("Saved beacon checkpoint", "file", config.CheckpointFile, "checkpoint", checkpoint)
|
|
} else if err != nil {
|
|
log.Error("Failed to save beacon checkpoint", "file", config.CheckpointFile, "checkpoint", checkpoint, "error", err)
|
|
}
|
|
})
|
|
)
|
|
headSync := sync.NewHeadSync(headTracker, committeeChain)
|
|
|
|
// set up scheduler and sync modules
|
|
scheduler := request.NewScheduler()
|
|
checkpointInit := sync.NewCheckpointInit(committeeChain, config.Checkpoint)
|
|
forwardSync := sync.NewForwardUpdateSync(committeeChain)
|
|
beaconBlockSync := newBeaconBlockSync(headTracker)
|
|
scheduler.RegisterTarget(headTracker)
|
|
scheduler.RegisterTarget(committeeChain)
|
|
scheduler.RegisterModule(checkpointInit, "checkpointInit")
|
|
scheduler.RegisterModule(forwardSync, "forwardSync")
|
|
scheduler.RegisterModule(headSync, "headSync")
|
|
scheduler.RegisterModule(beaconBlockSync, "beaconBlockSync")
|
|
|
|
return &Client{
|
|
scheduler: scheduler,
|
|
urls: config.Apis,
|
|
customHeader: config.CustomHeader,
|
|
config: &config,
|
|
blockSync: beaconBlockSync,
|
|
}
|
|
}
|
|
|
|
func (c *Client) SetEngineRPC(engine *rpc.Client) {
|
|
c.engineRPC = engine
|
|
}
|
|
|
|
func (c *Client) Start() error {
|
|
headCh := make(chan types.ChainHeadEvent, 16)
|
|
c.chainHeadSub = c.blockSync.SubscribeChainHead(headCh)
|
|
c.engineClient = startEngineClient(c.config, c.engineRPC, headCh)
|
|
|
|
c.scheduler.Start()
|
|
for _, url := range c.urls {
|
|
beaconApi := api.NewBeaconLightApi(url, c.customHeader)
|
|
c.scheduler.RegisterServer(request.NewServer(api.NewApiServer(beaconApi), &mclock.System{}))
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (c *Client) Stop() error {
|
|
c.engineClient.stop()
|
|
c.chainHeadSub.Unsubscribe()
|
|
c.scheduler.Stop()
|
|
return nil
|
|
}
|