aadcb88675
Here we add a beacon chain light client for use by geth. Geth can now be configured to run against a beacon chain API endpoint, without pointing a CL to it. To set this up, use the `--beacon.api` flag. Information provided by the beacon chain is verified, i.e. geth does not blindly trust the beacon API endpoint in this mode. The root of trust are the beacon chain 'sync committees'. The configured beacon API endpoint must provide light client data. At this time, only Lodestar and Nimbus provide the necessary APIs. There is also a standalone tool, cmd/blsync, which uses the beacon chain light client to drive any EL implementation via its engine API. --------- Co-authored-by: Felix Lange <fjl@twurst.com>
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 (
|
|
"strings"
|
|
|
|
"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/types"
|
|
"github.com/ethereum/go-ethereum/cmd/utils"
|
|
"github.com/ethereum/go-ethereum/common/mclock"
|
|
"github.com/ethereum/go-ethereum/ethdb/memorydb"
|
|
"github.com/ethereum/go-ethereum/event"
|
|
"github.com/urfave/cli/v2"
|
|
)
|
|
|
|
type Client struct {
|
|
scheduler *request.Scheduler
|
|
chainHeadFeed *event.Feed
|
|
urls []string
|
|
customHeader map[string]string
|
|
}
|
|
|
|
func NewClient(ctx *cli.Context) *Client {
|
|
if !ctx.IsSet(utils.BeaconApiFlag.Name) {
|
|
utils.Fatalf("Beacon node light client API URL not specified")
|
|
}
|
|
var (
|
|
chainConfig = makeChainConfig(ctx)
|
|
customHeader = make(map[string]string)
|
|
)
|
|
for _, s := range ctx.StringSlice(utils.BeaconApiHeaderFlag.Name) {
|
|
kv := strings.Split(s, ":")
|
|
if len(kv) != 2 {
|
|
utils.Fatalf("Invalid custom API header entry: %s", s)
|
|
}
|
|
customHeader[strings.TrimSpace(kv[0])] = strings.TrimSpace(kv[1])
|
|
}
|
|
// create data structures
|
|
var (
|
|
db = memorydb.New()
|
|
threshold = ctx.Int(utils.BeaconThresholdFlag.Name)
|
|
committeeChain = light.NewCommitteeChain(db, chainConfig.ChainConfig, threshold, !ctx.Bool(utils.BeaconNoFilterFlag.Name))
|
|
headTracker = light.NewHeadTracker(committeeChain, threshold)
|
|
)
|
|
headSync := sync.NewHeadSync(headTracker, committeeChain)
|
|
|
|
// set up scheduler and sync modules
|
|
chainHeadFeed := new(event.Feed)
|
|
scheduler := request.NewScheduler()
|
|
checkpointInit := sync.NewCheckpointInit(committeeChain, chainConfig.Checkpoint)
|
|
forwardSync := sync.NewForwardUpdateSync(committeeChain)
|
|
beaconBlockSync := newBeaconBlockSync(headTracker, chainHeadFeed)
|
|
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: ctx.StringSlice(utils.BeaconApiFlag.Name),
|
|
customHeader: customHeader,
|
|
chainHeadFeed: chainHeadFeed,
|
|
}
|
|
}
|
|
|
|
// SubscribeChainHeadEvent allows callers to subscribe a provided channel to new
|
|
// head updates.
|
|
func (c *Client) SubscribeChainHeadEvent(ch chan<- types.ChainHeadEvent) event.Subscription {
|
|
return c.chainHeadFeed.Subscribe(ch)
|
|
}
|
|
|
|
func (c *Client) Start() {
|
|
c.scheduler.Start()
|
|
// register server(s)
|
|
for _, url := range c.urls {
|
|
beaconApi := api.NewBeaconLightApi(url, c.customHeader)
|
|
c.scheduler.RegisterServer(request.NewServer(api.NewApiServer(beaconApi), &mclock.System{}))
|
|
}
|
|
}
|
|
|
|
func (c *Client) Stop() {
|
|
c.scheduler.Stop()
|
|
}
|