819 lines
35 KiB
Go
819 lines
35 KiB
Go
// Copyright 2021 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 catalyst implements the temporary eth1/eth2 RPC integration.
|
|
package catalyst
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"math/big"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
"github.com/ethereum/go-ethereum/core/beacon"
|
|
"github.com/ethereum/go-ethereum/core/rawdb"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/eth"
|
|
"github.com/ethereum/go-ethereum/eth/downloader"
|
|
"github.com/ethereum/go-ethereum/log"
|
|
"github.com/ethereum/go-ethereum/miner"
|
|
"github.com/ethereum/go-ethereum/node"
|
|
"github.com/ethereum/go-ethereum/rpc"
|
|
)
|
|
|
|
// Register adds the engine API to the full node.
|
|
func Register(stack *node.Node, backend *eth.Ethereum) error {
|
|
log.Warn("Engine API enabled", "protocol", "eth")
|
|
stack.RegisterAPIs([]rpc.API{
|
|
{
|
|
Namespace: "engine",
|
|
Service: NewConsensusAPI(backend),
|
|
Authenticated: true,
|
|
},
|
|
})
|
|
return nil
|
|
}
|
|
|
|
const (
|
|
// invalidBlockHitEviction is the number of times an invalid block can be
|
|
// referenced in forkchoice update or new payload before it is attempted
|
|
// to be reprocessed again.
|
|
invalidBlockHitEviction = 128
|
|
|
|
// invalidTipsetsCap is the max number of recent block hashes tracked that
|
|
// have lead to some bad ancestor block. It's just an OOM protection.
|
|
invalidTipsetsCap = 512
|
|
|
|
// beaconUpdateStartupTimeout is the time to wait for a beacon client to get
|
|
// attached before starting to issue warnings.
|
|
beaconUpdateStartupTimeout = 30 * time.Second
|
|
|
|
// beaconUpdateExchangeTimeout is the max time allowed for a beacon client to
|
|
// do a transition config exchange before it's considered offline and the user
|
|
// is warned.
|
|
beaconUpdateExchangeTimeout = 2 * time.Minute
|
|
|
|
// beaconUpdateConsensusTimeout is the max time allowed for a beacon client
|
|
// to send a consensus update before it's considered offline and the user is
|
|
// warned.
|
|
beaconUpdateConsensusTimeout = 30 * time.Second
|
|
|
|
// beaconUpdateWarnFrequency is the frequency at which to warn the user that
|
|
// the beacon client is offline.
|
|
beaconUpdateWarnFrequency = 5 * time.Minute
|
|
)
|
|
|
|
// All methods provided over the engine endpoint.
|
|
var caps = []string{
|
|
"engine_forkchoiceUpdatedV1",
|
|
"engine_forkchoiceUpdatedV2",
|
|
"engine_exchangeTransitionConfigurationV1",
|
|
"engine_getPayloadV1",
|
|
"engine_getPayloadV2",
|
|
"engine_newPayloadV1",
|
|
"engine_newPayloadV2",
|
|
"engine_getPayloadBodiesByHashV1",
|
|
"engine_getPayloadBodiesByRangeV1",
|
|
}
|
|
|
|
type ConsensusAPI struct {
|
|
eth *eth.Ethereum
|
|
|
|
remoteBlocks *headerQueue // Cache of remote payloads received
|
|
localBlocks *payloadQueue // Cache of local payloads generated
|
|
|
|
// The forkchoice update and new payload method require us to return the
|
|
// latest valid hash in an invalid chain. To support that return, we need
|
|
// to track historical bad blocks as well as bad tipsets in case a chain
|
|
// is constantly built on it.
|
|
//
|
|
// There are a few important caveats in this mechanism:
|
|
// - The bad block tracking is ephemeral, in-memory only. We must never
|
|
// persist any bad block information to disk as a bug in Geth could end
|
|
// up blocking a valid chain, even if a later Geth update would accept
|
|
// it.
|
|
// - Bad blocks will get forgotten after a certain threshold of import
|
|
// attempts and will be retried. The rationale is that if the network
|
|
// really-really-really tries to feed us a block, we should give it a
|
|
// new chance, perhaps us being racey instead of the block being legit
|
|
// bad (this happened in Geth at a point with import vs. pending race).
|
|
// - Tracking all the blocks built on top of the bad one could be a bit
|
|
// problematic, so we will only track the head chain segment of a bad
|
|
// chain to allow discarding progressing bad chains and side chains,
|
|
// without tracking too much bad data.
|
|
invalidBlocksHits map[common.Hash]int // Ephemeral cache to track invalid blocks and their hit count
|
|
invalidTipsets map[common.Hash]*types.Header // Ephemeral cache to track invalid tipsets and their bad ancestor
|
|
invalidLock sync.Mutex // Protects the invalid maps from concurrent access
|
|
|
|
// Geth can appear to be stuck or do strange things if the beacon client is
|
|
// offline or is sending us strange data. Stash some update stats away so
|
|
// that we can warn the user and not have them open issues on our tracker.
|
|
lastTransitionUpdate time.Time
|
|
lastTransitionLock sync.Mutex
|
|
lastForkchoiceUpdate time.Time
|
|
lastForkchoiceLock sync.Mutex
|
|
lastNewPayloadUpdate time.Time
|
|
lastNewPayloadLock sync.Mutex
|
|
|
|
forkchoiceLock sync.Mutex // Lock for the forkChoiceUpdated method
|
|
newPayloadLock sync.Mutex // Lock for the NewPayload method
|
|
}
|
|
|
|
// NewConsensusAPI creates a new consensus api for the given backend.
|
|
// The underlying blockchain needs to have a valid terminal total difficulty set.
|
|
func NewConsensusAPI(eth *eth.Ethereum) *ConsensusAPI {
|
|
if eth.BlockChain().Config().TerminalTotalDifficulty == nil {
|
|
log.Warn("Engine API started but chain not configured for merge yet")
|
|
}
|
|
api := &ConsensusAPI{
|
|
eth: eth,
|
|
remoteBlocks: newHeaderQueue(),
|
|
localBlocks: newPayloadQueue(),
|
|
invalidBlocksHits: make(map[common.Hash]int),
|
|
invalidTipsets: make(map[common.Hash]*types.Header),
|
|
}
|
|
eth.Downloader().SetBadBlockCallback(api.setInvalidAncestor)
|
|
go api.heartbeat()
|
|
|
|
return api
|
|
}
|
|
|
|
// ForkchoiceUpdatedV1 has several responsibilities:
|
|
//
|
|
// We try to set our blockchain to the headBlock.
|
|
//
|
|
// If the method is called with an empty head block: we return success, which can be used
|
|
// to check if the engine API is enabled.
|
|
//
|
|
// If the total difficulty was not reached: we return INVALID.
|
|
//
|
|
// If the finalizedBlockHash is set: we check if we have the finalizedBlockHash in our db,
|
|
// if not we start a sync.
|
|
//
|
|
// If there are payloadAttributes: we try to assemble a block with the payloadAttributes
|
|
// and return its payloadID.
|
|
func (api *ConsensusAPI) ForkchoiceUpdatedV1(update beacon.ForkchoiceStateV1, payloadAttributes *beacon.PayloadAttributes) (beacon.ForkChoiceResponse, error) {
|
|
if payloadAttributes != nil && payloadAttributes.Withdrawals != nil {
|
|
return beacon.STATUS_INVALID, beacon.InvalidParams.With(fmt.Errorf("withdrawals not supported in V1"))
|
|
}
|
|
return api.forkchoiceUpdated(update, payloadAttributes)
|
|
}
|
|
|
|
// ForkchoiceUpdatedV2 is equivalent to V1 with the addition of withdrawals in the payload attributes.
|
|
func (api *ConsensusAPI) ForkchoiceUpdatedV2(update beacon.ForkchoiceStateV1, payloadAttributes *beacon.PayloadAttributes) (beacon.ForkChoiceResponse, error) {
|
|
if payloadAttributes != nil {
|
|
if err := api.verifyPayloadAttributes(payloadAttributes); err != nil {
|
|
return beacon.STATUS_INVALID, beacon.InvalidParams.With(err)
|
|
}
|
|
}
|
|
return api.forkchoiceUpdated(update, payloadAttributes)
|
|
}
|
|
|
|
func (api *ConsensusAPI) verifyPayloadAttributes(attr *beacon.PayloadAttributes) error {
|
|
if !api.eth.BlockChain().Config().IsShanghai(attr.Timestamp) {
|
|
// Reject payload attributes with withdrawals before shanghai
|
|
if attr.Withdrawals != nil {
|
|
return errors.New("withdrawals before shanghai")
|
|
}
|
|
} else {
|
|
// Reject payload attributes with nil withdrawals after shanghai
|
|
if attr.Withdrawals == nil {
|
|
return errors.New("missing withdrawals list")
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (api *ConsensusAPI) forkchoiceUpdated(update beacon.ForkchoiceStateV1, payloadAttributes *beacon.PayloadAttributes) (beacon.ForkChoiceResponse, error) {
|
|
api.forkchoiceLock.Lock()
|
|
defer api.forkchoiceLock.Unlock()
|
|
|
|
log.Trace("Engine API request received", "method", "ForkchoiceUpdated", "head", update.HeadBlockHash, "finalized", update.FinalizedBlockHash, "safe", update.SafeBlockHash)
|
|
if update.HeadBlockHash == (common.Hash{}) {
|
|
log.Warn("Forkchoice requested update to zero hash")
|
|
return beacon.STATUS_INVALID, nil // TODO(karalabe): Why does someone send us this?
|
|
}
|
|
// Stash away the last update to warn the user if the beacon client goes offline
|
|
api.lastForkchoiceLock.Lock()
|
|
api.lastForkchoiceUpdate = time.Now()
|
|
api.lastForkchoiceLock.Unlock()
|
|
|
|
// Check whether we have the block yet in our database or not. If not, we'll
|
|
// need to either trigger a sync, or to reject this forkchoice update for a
|
|
// reason.
|
|
block := api.eth.BlockChain().GetBlockByHash(update.HeadBlockHash)
|
|
if block == nil {
|
|
// If this block was previously invalidated, keep rejecting it here too
|
|
if res := api.checkInvalidAncestor(update.HeadBlockHash, update.HeadBlockHash); res != nil {
|
|
return beacon.ForkChoiceResponse{PayloadStatus: *res, PayloadID: nil}, nil
|
|
}
|
|
// If the head hash is unknown (was not given to us in a newPayload request),
|
|
// we cannot resolve the header, so not much to do. This could be extended in
|
|
// the future to resolve from the `eth` network, but it's an unexpected case
|
|
// that should be fixed, not papered over.
|
|
header := api.remoteBlocks.get(update.HeadBlockHash)
|
|
if header == nil {
|
|
log.Warn("Forkchoice requested unknown head", "hash", update.HeadBlockHash)
|
|
return beacon.STATUS_SYNCING, nil
|
|
}
|
|
// Header advertised via a past newPayload request. Start syncing to it.
|
|
// Before we do however, make sure any legacy sync in switched off so we
|
|
// don't accidentally have 2 cycles running.
|
|
if merger := api.eth.Merger(); !merger.TDDReached() {
|
|
merger.ReachTTD()
|
|
api.eth.Downloader().Cancel()
|
|
}
|
|
log.Info("Forkchoice requested sync to new head", "number", header.Number, "hash", header.Hash())
|
|
if err := api.eth.Downloader().BeaconSync(api.eth.SyncMode(), header); err != nil {
|
|
return beacon.STATUS_SYNCING, err
|
|
}
|
|
return beacon.STATUS_SYNCING, nil
|
|
}
|
|
// Block is known locally, just sanity check that the beacon client does not
|
|
// attempt to push us back to before the merge.
|
|
if block.Difficulty().BitLen() > 0 || block.NumberU64() == 0 {
|
|
var (
|
|
td = api.eth.BlockChain().GetTd(update.HeadBlockHash, block.NumberU64())
|
|
ptd = api.eth.BlockChain().GetTd(block.ParentHash(), block.NumberU64()-1)
|
|
ttd = api.eth.BlockChain().Config().TerminalTotalDifficulty
|
|
)
|
|
if td == nil || (block.NumberU64() > 0 && ptd == nil) {
|
|
log.Error("TDs unavailable for TTD check", "number", block.NumberU64(), "hash", update.HeadBlockHash, "td", td, "parent", block.ParentHash(), "ptd", ptd)
|
|
return beacon.STATUS_INVALID, errors.New("TDs unavailable for TDD check")
|
|
}
|
|
if td.Cmp(ttd) < 0 {
|
|
log.Error("Refusing beacon update to pre-merge", "number", block.NumberU64(), "hash", update.HeadBlockHash, "diff", block.Difficulty(), "age", common.PrettyAge(time.Unix(int64(block.Time()), 0)))
|
|
return beacon.ForkChoiceResponse{PayloadStatus: beacon.INVALID_TERMINAL_BLOCK, PayloadID: nil}, nil
|
|
}
|
|
if block.NumberU64() > 0 && ptd.Cmp(ttd) >= 0 {
|
|
log.Error("Parent block is already post-ttd", "number", block.NumberU64(), "hash", update.HeadBlockHash, "diff", block.Difficulty(), "age", common.PrettyAge(time.Unix(int64(block.Time()), 0)))
|
|
return beacon.ForkChoiceResponse{PayloadStatus: beacon.INVALID_TERMINAL_BLOCK, PayloadID: nil}, nil
|
|
}
|
|
}
|
|
valid := func(id *beacon.PayloadID) beacon.ForkChoiceResponse {
|
|
return beacon.ForkChoiceResponse{
|
|
PayloadStatus: beacon.PayloadStatusV1{Status: beacon.VALID, LatestValidHash: &update.HeadBlockHash},
|
|
PayloadID: id,
|
|
}
|
|
}
|
|
if rawdb.ReadCanonicalHash(api.eth.ChainDb(), block.NumberU64()) != update.HeadBlockHash {
|
|
// Block is not canonical, set head.
|
|
if latestValid, err := api.eth.BlockChain().SetCanonical(block); err != nil {
|
|
return beacon.ForkChoiceResponse{PayloadStatus: beacon.PayloadStatusV1{Status: beacon.INVALID, LatestValidHash: &latestValid}}, err
|
|
}
|
|
} else if api.eth.BlockChain().CurrentBlock().Hash() == update.HeadBlockHash {
|
|
// If the specified head matches with our local head, do nothing and keep
|
|
// generating the payload. It's a special corner case that a few slots are
|
|
// missing and we are requested to generate the payload in slot.
|
|
} else {
|
|
// If the head block is already in our canonical chain, the beacon client is
|
|
// probably resyncing. Ignore the update.
|
|
log.Info("Ignoring beacon update to old head", "number", block.NumberU64(), "hash", update.HeadBlockHash, "age", common.PrettyAge(time.Unix(int64(block.Time()), 0)), "have", api.eth.BlockChain().CurrentBlock().NumberU64())
|
|
return valid(nil), nil
|
|
}
|
|
api.eth.SetSynced()
|
|
|
|
// If the beacon client also advertised a finalized block, mark the local
|
|
// chain final and completely in PoS mode.
|
|
if update.FinalizedBlockHash != (common.Hash{}) {
|
|
if merger := api.eth.Merger(); !merger.PoSFinalized() {
|
|
merger.FinalizePoS()
|
|
}
|
|
// If the finalized block is not in our canonical tree, somethings wrong
|
|
finalBlock := api.eth.BlockChain().GetBlockByHash(update.FinalizedBlockHash)
|
|
if finalBlock == nil {
|
|
log.Warn("Final block not available in database", "hash", update.FinalizedBlockHash)
|
|
return beacon.STATUS_INVALID, beacon.InvalidForkChoiceState.With(errors.New("final block not available in database"))
|
|
} else if rawdb.ReadCanonicalHash(api.eth.ChainDb(), finalBlock.NumberU64()) != update.FinalizedBlockHash {
|
|
log.Warn("Final block not in canonical chain", "number", block.NumberU64(), "hash", update.HeadBlockHash)
|
|
return beacon.STATUS_INVALID, beacon.InvalidForkChoiceState.With(errors.New("final block not in canonical chain"))
|
|
}
|
|
// Set the finalized block
|
|
api.eth.BlockChain().SetFinalized(finalBlock)
|
|
}
|
|
// Check if the safe block hash is in our canonical tree, if not somethings wrong
|
|
if update.SafeBlockHash != (common.Hash{}) {
|
|
safeBlock := api.eth.BlockChain().GetBlockByHash(update.SafeBlockHash)
|
|
if safeBlock == nil {
|
|
log.Warn("Safe block not available in database")
|
|
return beacon.STATUS_INVALID, beacon.InvalidForkChoiceState.With(errors.New("safe block not available in database"))
|
|
}
|
|
if rawdb.ReadCanonicalHash(api.eth.ChainDb(), safeBlock.NumberU64()) != update.SafeBlockHash {
|
|
log.Warn("Safe block not in canonical chain")
|
|
return beacon.STATUS_INVALID, beacon.InvalidForkChoiceState.With(errors.New("safe block not in canonical chain"))
|
|
}
|
|
// Set the safe block
|
|
api.eth.BlockChain().SetSafe(safeBlock)
|
|
}
|
|
// If payload generation was requested, create a new block to be potentially
|
|
// sealed by the beacon client. The payload will be requested later, and we
|
|
// will replace it arbitrarily many times in between.
|
|
if payloadAttributes != nil {
|
|
args := &miner.BuildPayloadArgs{
|
|
Parent: update.HeadBlockHash,
|
|
Timestamp: payloadAttributes.Timestamp,
|
|
FeeRecipient: payloadAttributes.SuggestedFeeRecipient,
|
|
Random: payloadAttributes.Random,
|
|
Withdrawals: payloadAttributes.Withdrawals,
|
|
}
|
|
id := args.Id()
|
|
// If we already are busy generating this work, then we do not need
|
|
// to start a second process.
|
|
if api.localBlocks.has(id) {
|
|
return valid(&id), nil
|
|
}
|
|
payload, err := api.eth.Miner().BuildPayload(args)
|
|
if err != nil {
|
|
log.Error("Failed to build payload", "err", err)
|
|
return valid(nil), beacon.InvalidPayloadAttributes.With(err)
|
|
}
|
|
api.localBlocks.put(id, payload)
|
|
return valid(&id), nil
|
|
}
|
|
return valid(nil), nil
|
|
}
|
|
|
|
// ExchangeTransitionConfigurationV1 checks the given configuration against
|
|
// the configuration of the node.
|
|
func (api *ConsensusAPI) ExchangeTransitionConfigurationV1(config beacon.TransitionConfigurationV1) (*beacon.TransitionConfigurationV1, error) {
|
|
log.Trace("Engine API request received", "method", "ExchangeTransitionConfiguration", "ttd", config.TerminalTotalDifficulty)
|
|
if config.TerminalTotalDifficulty == nil {
|
|
return nil, errors.New("invalid terminal total difficulty")
|
|
}
|
|
// Stash away the last update to warn the user if the beacon client goes offline
|
|
api.lastTransitionLock.Lock()
|
|
api.lastTransitionUpdate = time.Now()
|
|
api.lastTransitionLock.Unlock()
|
|
|
|
ttd := api.eth.BlockChain().Config().TerminalTotalDifficulty
|
|
if ttd == nil || ttd.Cmp(config.TerminalTotalDifficulty.ToInt()) != 0 {
|
|
log.Warn("Invalid TTD configured", "geth", ttd, "beacon", config.TerminalTotalDifficulty)
|
|
return nil, fmt.Errorf("invalid ttd: execution %v consensus %v", ttd, config.TerminalTotalDifficulty)
|
|
}
|
|
if config.TerminalBlockHash != (common.Hash{}) {
|
|
if hash := api.eth.BlockChain().GetCanonicalHash(uint64(config.TerminalBlockNumber)); hash == config.TerminalBlockHash {
|
|
return &beacon.TransitionConfigurationV1{
|
|
TerminalTotalDifficulty: (*hexutil.Big)(ttd),
|
|
TerminalBlockHash: config.TerminalBlockHash,
|
|
TerminalBlockNumber: config.TerminalBlockNumber,
|
|
}, nil
|
|
}
|
|
return nil, fmt.Errorf("invalid terminal block hash")
|
|
}
|
|
return &beacon.TransitionConfigurationV1{TerminalTotalDifficulty: (*hexutil.Big)(ttd)}, nil
|
|
}
|
|
|
|
// GetPayloadV1 returns a cached payload by id.
|
|
func (api *ConsensusAPI) GetPayloadV1(payloadID beacon.PayloadID) (*beacon.ExecutableData, error) {
|
|
data, err := api.getPayload(payloadID)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return data.ExecutionPayload, nil
|
|
}
|
|
|
|
// GetPayloadV2 returns a cached payload by id.
|
|
func (api *ConsensusAPI) GetPayloadV2(payloadID beacon.PayloadID) (*beacon.ExecutionPayloadEnvelope, error) {
|
|
return api.getPayload(payloadID)
|
|
}
|
|
|
|
func (api *ConsensusAPI) getPayload(payloadID beacon.PayloadID) (*beacon.ExecutionPayloadEnvelope, error) {
|
|
log.Trace("Engine API request received", "method", "GetPayload", "id", payloadID)
|
|
data := api.localBlocks.get(payloadID)
|
|
if data == nil {
|
|
return nil, beacon.UnknownPayload
|
|
}
|
|
return data, nil
|
|
}
|
|
|
|
// NewPayloadV1 creates an Eth1 block, inserts it in the chain, and returns the status of the chain.
|
|
func (api *ConsensusAPI) NewPayloadV1(params beacon.ExecutableData) (beacon.PayloadStatusV1, error) {
|
|
if params.Withdrawals != nil {
|
|
return beacon.PayloadStatusV1{Status: beacon.INVALID}, fmt.Errorf("withdrawals not supported in V1")
|
|
}
|
|
return api.newPayload(params)
|
|
}
|
|
|
|
// NewPayloadV2 creates an Eth1 block, inserts it in the chain, and returns the status of the chain.
|
|
func (api *ConsensusAPI) NewPayloadV2(params beacon.ExecutableData) (beacon.PayloadStatusV1, error) {
|
|
return api.newPayload(params)
|
|
}
|
|
|
|
func (api *ConsensusAPI) newPayload(params beacon.ExecutableData) (beacon.PayloadStatusV1, error) {
|
|
// The locking here is, strictly, not required. Without these locks, this can happen:
|
|
//
|
|
// 1. NewPayload( execdata-N ) is invoked from the CL. It goes all the way down to
|
|
// api.eth.BlockChain().InsertBlockWithoutSetHead, where it is blocked on
|
|
// e.g database compaction.
|
|
// 2. The call times out on the CL layer, which issues another NewPayload (execdata-N) call.
|
|
// Similarly, this also get stuck on the same place. Importantly, since the
|
|
// first call has not gone through, the early checks for "do we already have this block"
|
|
// will all return false.
|
|
// 3. When the db compaction ends, then N calls inserting the same payload are processed
|
|
// sequentially.
|
|
// Hence, we use a lock here, to be sure that the previous call has finished before we
|
|
// check whether we already have the block locally.
|
|
api.newPayloadLock.Lock()
|
|
defer api.newPayloadLock.Unlock()
|
|
|
|
log.Trace("Engine API request received", "method", "NewPayload", "number", params.Number, "hash", params.BlockHash)
|
|
block, err := beacon.ExecutableDataToBlock(params)
|
|
if err != nil {
|
|
log.Debug("Invalid NewPayload params", "params", params, "error", err)
|
|
return beacon.PayloadStatusV1{Status: beacon.INVALIDBLOCKHASH}, nil
|
|
}
|
|
// Stash away the last update to warn the user if the beacon client goes offline
|
|
api.lastNewPayloadLock.Lock()
|
|
api.lastNewPayloadUpdate = time.Now()
|
|
api.lastNewPayloadLock.Unlock()
|
|
|
|
// If we already have the block locally, ignore the entire execution and just
|
|
// return a fake success.
|
|
if block := api.eth.BlockChain().GetBlockByHash(params.BlockHash); block != nil {
|
|
log.Warn("Ignoring already known beacon payload", "number", params.Number, "hash", params.BlockHash, "age", common.PrettyAge(time.Unix(int64(block.Time()), 0)))
|
|
hash := block.Hash()
|
|
return beacon.PayloadStatusV1{Status: beacon.VALID, LatestValidHash: &hash}, nil
|
|
}
|
|
// If this block was rejected previously, keep rejecting it
|
|
if res := api.checkInvalidAncestor(block.Hash(), block.Hash()); res != nil {
|
|
return *res, nil
|
|
}
|
|
// If the parent is missing, we - in theory - could trigger a sync, but that
|
|
// would also entail a reorg. That is problematic if multiple sibling blocks
|
|
// are being fed to us, and even more so, if some semi-distant uncle shortens
|
|
// our live chain. As such, payload execution will not permit reorgs and thus
|
|
// will not trigger a sync cycle. That is fine though, if we get a fork choice
|
|
// update after legit payload executions.
|
|
parent := api.eth.BlockChain().GetBlock(block.ParentHash(), block.NumberU64()-1)
|
|
if parent == nil {
|
|
return api.delayPayloadImport(block)
|
|
}
|
|
// We have an existing parent, do some sanity checks to avoid the beacon client
|
|
// triggering too early
|
|
var (
|
|
ptd = api.eth.BlockChain().GetTd(parent.Hash(), parent.NumberU64())
|
|
ttd = api.eth.BlockChain().Config().TerminalTotalDifficulty
|
|
gptd = api.eth.BlockChain().GetTd(parent.ParentHash(), parent.NumberU64()-1)
|
|
)
|
|
if ptd.Cmp(ttd) < 0 {
|
|
log.Warn("Ignoring pre-merge payload", "number", params.Number, "hash", params.BlockHash, "td", ptd, "ttd", ttd)
|
|
return beacon.INVALID_TERMINAL_BLOCK, nil
|
|
}
|
|
if parent.Difficulty().BitLen() > 0 && gptd != nil && gptd.Cmp(ttd) >= 0 {
|
|
log.Error("Ignoring pre-merge parent block", "number", params.Number, "hash", params.BlockHash, "td", ptd, "ttd", ttd)
|
|
return beacon.INVALID_TERMINAL_BLOCK, nil
|
|
}
|
|
if block.Time() <= parent.Time() {
|
|
log.Warn("Invalid timestamp", "parent", block.Time(), "block", block.Time())
|
|
return api.invalid(errors.New("invalid timestamp"), parent.Header()), nil
|
|
}
|
|
// Another cornercase: if the node is in snap sync mode, but the CL client
|
|
// tries to make it import a block. That should be denied as pushing something
|
|
// into the database directly will conflict with the assumptions of snap sync
|
|
// that it has an empty db that it can fill itself.
|
|
if api.eth.SyncMode() != downloader.FullSync {
|
|
return api.delayPayloadImport(block)
|
|
}
|
|
if !api.eth.BlockChain().HasBlockAndState(block.ParentHash(), block.NumberU64()-1) {
|
|
api.remoteBlocks.put(block.Hash(), block.Header())
|
|
log.Warn("State not available, ignoring new payload")
|
|
return beacon.PayloadStatusV1{Status: beacon.ACCEPTED}, nil
|
|
}
|
|
log.Trace("Inserting block without sethead", "hash", block.Hash(), "number", block.Number)
|
|
if err := api.eth.BlockChain().InsertBlockWithoutSetHead(block); err != nil {
|
|
log.Warn("NewPayloadV1: inserting block failed", "error", err)
|
|
|
|
api.invalidLock.Lock()
|
|
api.invalidBlocksHits[block.Hash()] = 1
|
|
api.invalidTipsets[block.Hash()] = block.Header()
|
|
api.invalidLock.Unlock()
|
|
|
|
return api.invalid(err, parent.Header()), nil
|
|
}
|
|
// We've accepted a valid payload from the beacon client. Mark the local
|
|
// chain transitions to notify other subsystems (e.g. downloader) of the
|
|
// behavioral change.
|
|
if merger := api.eth.Merger(); !merger.TDDReached() {
|
|
merger.ReachTTD()
|
|
api.eth.Downloader().Cancel()
|
|
}
|
|
hash := block.Hash()
|
|
return beacon.PayloadStatusV1{Status: beacon.VALID, LatestValidHash: &hash}, nil
|
|
}
|
|
|
|
// delayPayloadImport stashes the given block away for import at a later time,
|
|
// either via a forkchoice update or a sync extension. This method is meant to
|
|
// be called by the newpayload command when the block seems to be ok, but some
|
|
// prerequisite prevents it from being processed (e.g. no parent, or snap sync).
|
|
func (api *ConsensusAPI) delayPayloadImport(block *types.Block) (beacon.PayloadStatusV1, error) {
|
|
// Sanity check that this block's parent is not on a previously invalidated
|
|
// chain. If it is, mark the block as invalid too.
|
|
if res := api.checkInvalidAncestor(block.ParentHash(), block.Hash()); res != nil {
|
|
return *res, nil
|
|
}
|
|
// Stash the block away for a potential forced forkchoice update to it
|
|
// at a later time.
|
|
api.remoteBlocks.put(block.Hash(), block.Header())
|
|
|
|
// Although we don't want to trigger a sync, if there is one already in
|
|
// progress, try to extend if with the current payload request to relieve
|
|
// some strain from the forkchoice update.
|
|
if err := api.eth.Downloader().BeaconExtend(api.eth.SyncMode(), block.Header()); err == nil {
|
|
log.Debug("Payload accepted for sync extension", "number", block.NumberU64(), "hash", block.Hash())
|
|
return beacon.PayloadStatusV1{Status: beacon.SYNCING}, nil
|
|
}
|
|
// Either no beacon sync was started yet, or it rejected the delivered
|
|
// payload as non-integratable on top of the existing sync. We'll just
|
|
// have to rely on the beacon client to forcefully update the head with
|
|
// a forkchoice update request.
|
|
if api.eth.SyncMode() == downloader.FullSync {
|
|
// In full sync mode, failure to import a well-formed block can only mean
|
|
// that the parent state is missing and the syncer rejected extending the
|
|
// current cycle with the new payload.
|
|
log.Warn("Ignoring payload with missing parent", "number", block.NumberU64(), "hash", block.Hash(), "parent", block.ParentHash())
|
|
} else {
|
|
// In non-full sync mode (i.e. snap sync) all payloads are rejected until
|
|
// snap sync terminates as snap sync relies on direct database injections
|
|
// and cannot afford concurrent out-if-band modifications via imports.
|
|
log.Warn("Ignoring payload while snap syncing", "number", block.NumberU64(), "hash", block.Hash())
|
|
}
|
|
return beacon.PayloadStatusV1{Status: beacon.SYNCING}, nil
|
|
}
|
|
|
|
// setInvalidAncestor is a callback for the downloader to notify us if a bad block
|
|
// is encountered during the async sync.
|
|
func (api *ConsensusAPI) setInvalidAncestor(invalid *types.Header, origin *types.Header) {
|
|
api.invalidLock.Lock()
|
|
defer api.invalidLock.Unlock()
|
|
|
|
api.invalidTipsets[origin.Hash()] = invalid
|
|
api.invalidBlocksHits[invalid.Hash()]++
|
|
}
|
|
|
|
// checkInvalidAncestor checks whether the specified chain end links to a known
|
|
// bad ancestor. If yes, it constructs the payload failure response to return.
|
|
func (api *ConsensusAPI) checkInvalidAncestor(check common.Hash, head common.Hash) *beacon.PayloadStatusV1 {
|
|
api.invalidLock.Lock()
|
|
defer api.invalidLock.Unlock()
|
|
|
|
// If the hash to check is unknown, return valid
|
|
invalid, ok := api.invalidTipsets[check]
|
|
if !ok {
|
|
return nil
|
|
}
|
|
// If the bad hash was hit too many times, evict it and try to reprocess in
|
|
// the hopes that we have a data race that we can exit out of.
|
|
badHash := invalid.Hash()
|
|
|
|
api.invalidBlocksHits[badHash]++
|
|
if api.invalidBlocksHits[badHash] >= invalidBlockHitEviction {
|
|
log.Warn("Too many bad block import attempt, trying", "number", invalid.Number, "hash", badHash)
|
|
delete(api.invalidBlocksHits, badHash)
|
|
|
|
for descendant, badHeader := range api.invalidTipsets {
|
|
if badHeader.Hash() == badHash {
|
|
delete(api.invalidTipsets, descendant)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
// Not too many failures yet, mark the head of the invalid chain as invalid
|
|
if check != head {
|
|
log.Warn("Marked new chain head as invalid", "hash", head, "badnumber", invalid.Number, "badhash", badHash)
|
|
for len(api.invalidTipsets) >= invalidTipsetsCap {
|
|
for key := range api.invalidTipsets {
|
|
delete(api.invalidTipsets, key)
|
|
break
|
|
}
|
|
}
|
|
api.invalidTipsets[head] = invalid
|
|
}
|
|
// If the last valid hash is the terminal pow block, return 0x0 for latest valid hash
|
|
lastValid := &invalid.ParentHash
|
|
if header := api.eth.BlockChain().GetHeader(invalid.ParentHash, invalid.Number.Uint64()-1); header != nil && header.Difficulty.Sign() != 0 {
|
|
lastValid = &common.Hash{}
|
|
}
|
|
failure := "links to previously rejected block"
|
|
return &beacon.PayloadStatusV1{
|
|
Status: beacon.INVALID,
|
|
LatestValidHash: lastValid,
|
|
ValidationError: &failure,
|
|
}
|
|
}
|
|
|
|
// invalid returns a response "INVALID" with the latest valid hash supplied by latest or to the current head
|
|
// if no latestValid block was provided.
|
|
func (api *ConsensusAPI) invalid(err error, latestValid *types.Header) beacon.PayloadStatusV1 {
|
|
currentHash := api.eth.BlockChain().CurrentBlock().Hash()
|
|
if latestValid != nil {
|
|
// Set latest valid hash to 0x0 if parent is PoW block
|
|
currentHash = common.Hash{}
|
|
if latestValid.Difficulty.BitLen() == 0 {
|
|
// Otherwise set latest valid hash to parent hash
|
|
currentHash = latestValid.Hash()
|
|
}
|
|
}
|
|
errorMsg := err.Error()
|
|
return beacon.PayloadStatusV1{Status: beacon.INVALID, LatestValidHash: ¤tHash, ValidationError: &errorMsg}
|
|
}
|
|
|
|
// heartbeat loops indefinitely, and checks if there have been beacon client updates
|
|
// received in the last while. If not - or if they but strange ones - it warns the
|
|
// user that something might be off with their consensus node.
|
|
//
|
|
// TODO(karalabe): Spin this goroutine down somehow
|
|
func (api *ConsensusAPI) heartbeat() {
|
|
// Sleep a bit on startup since there's obviously no beacon client yet
|
|
// attached, so no need to print scary warnings to the user.
|
|
time.Sleep(beaconUpdateStartupTimeout)
|
|
|
|
var (
|
|
offlineLogged time.Time
|
|
ttd = api.eth.BlockChain().Config().TerminalTotalDifficulty
|
|
)
|
|
// If the network is not yet merged/merging, don't bother continuing.
|
|
if ttd == nil {
|
|
return
|
|
}
|
|
for {
|
|
// Sleep a bit and retrieve the last known consensus updates
|
|
time.Sleep(5 * time.Second)
|
|
|
|
api.lastTransitionLock.Lock()
|
|
lastTransitionUpdate := api.lastTransitionUpdate
|
|
api.lastTransitionLock.Unlock()
|
|
|
|
api.lastForkchoiceLock.Lock()
|
|
lastForkchoiceUpdate := api.lastForkchoiceUpdate
|
|
api.lastForkchoiceLock.Unlock()
|
|
|
|
api.lastNewPayloadLock.Lock()
|
|
lastNewPayloadUpdate := api.lastNewPayloadUpdate
|
|
api.lastNewPayloadLock.Unlock()
|
|
|
|
// If there have been no updates for the past while, warn the user
|
|
// that the beacon client is probably offline
|
|
if api.eth.BlockChain().Config().TerminalTotalDifficultyPassed || api.eth.Merger().TDDReached() {
|
|
if time.Since(lastForkchoiceUpdate) <= beaconUpdateConsensusTimeout || time.Since(lastNewPayloadUpdate) <= beaconUpdateConsensusTimeout {
|
|
offlineLogged = time.Time{}
|
|
continue
|
|
}
|
|
if time.Since(lastTransitionUpdate) > beaconUpdateExchangeTimeout {
|
|
if time.Since(offlineLogged) > beaconUpdateWarnFrequency {
|
|
if lastTransitionUpdate.IsZero() {
|
|
log.Warn("Post-merge network, but no beacon client seen. Please launch one to follow the chain!")
|
|
} else {
|
|
log.Warn("Previously seen beacon client is offline. Please ensure it is operational to follow the chain!")
|
|
}
|
|
offlineLogged = time.Now()
|
|
}
|
|
continue
|
|
}
|
|
if time.Since(offlineLogged) > beaconUpdateWarnFrequency {
|
|
if lastForkchoiceUpdate.IsZero() && lastNewPayloadUpdate.IsZero() {
|
|
log.Warn("Beacon client online, but never received consensus updates. Please ensure your beacon client is operational to follow the chain!")
|
|
} else {
|
|
log.Warn("Beacon client online, but no consensus updates received in a while. Please fix your beacon client to follow the chain!")
|
|
}
|
|
offlineLogged = time.Now()
|
|
}
|
|
continue
|
|
}
|
|
if time.Since(lastTransitionUpdate) <= beaconUpdateExchangeTimeout {
|
|
offlineLogged = time.Time{}
|
|
continue
|
|
}
|
|
if time.Since(offlineLogged) > beaconUpdateWarnFrequency {
|
|
// Retrieve the last few blocks and make a rough estimate as
|
|
// to when the merge transition should happen
|
|
var (
|
|
chain = api.eth.BlockChain()
|
|
head = chain.CurrentHeader()
|
|
htd = chain.GetTd(head.Hash(), head.Number.Uint64())
|
|
)
|
|
if htd.Cmp(ttd) >= 0 {
|
|
if lastTransitionUpdate.IsZero() {
|
|
log.Warn("Merge already reached, but no beacon client seen. Please launch one to follow the chain!")
|
|
} else {
|
|
log.Warn("Merge already reached, but previously seen beacon client is offline. Please ensure it is operational to follow the chain!")
|
|
}
|
|
offlineLogged = time.Now()
|
|
continue
|
|
}
|
|
var eta time.Duration
|
|
if head.Number.Uint64() > 0 {
|
|
// Accumulate the last 64 difficulties to estimate the growth
|
|
var (
|
|
deltaDiff uint64
|
|
deltaTime uint64
|
|
current = head
|
|
)
|
|
for i := 0; i < 64; i++ {
|
|
parent := chain.GetHeader(current.ParentHash, current.Number.Uint64()-1)
|
|
if parent == nil {
|
|
break
|
|
}
|
|
deltaDiff += current.Difficulty.Uint64()
|
|
deltaTime += current.Time - parent.Time
|
|
current = parent
|
|
}
|
|
// Estimate an ETA based on the block times and the difficulty growth
|
|
if deltaTime > 0 {
|
|
growth := deltaDiff / deltaTime
|
|
left := new(big.Int).Sub(ttd, htd)
|
|
eta = time.Duration(new(big.Int).Div(left, new(big.Int).SetUint64(growth+1)).Uint64()) * time.Second
|
|
}
|
|
}
|
|
message := "Merge is configured, but previously seen beacon client is offline. Please ensure it is operational before the transition arrives!"
|
|
if lastTransitionUpdate.IsZero() {
|
|
message = "Merge is configured, but no beacon client seen. Please ensure you have one available before the transition arrives!"
|
|
}
|
|
if eta < time.Second {
|
|
log.Warn(message)
|
|
} else {
|
|
log.Warn(message, "eta", common.PrettyAge(time.Now().Add(-eta))) // weird hack, but duration formatted doesn't handle days
|
|
}
|
|
offlineLogged = time.Now()
|
|
}
|
|
}
|
|
}
|
|
|
|
// ExchangeCapabilities returns the current methods provided by this node.
|
|
func (api *ConsensusAPI) ExchangeCapabilities([]string) []string {
|
|
return caps
|
|
}
|
|
|
|
// GetPayloadBodiesV1 implements engine_getPayloadBodiesByHashV1 which allows for retrieval of a list
|
|
// of block bodies by the engine api.
|
|
func (api *ConsensusAPI) GetPayloadBodiesByHashV1(hashes []common.Hash) []*beacon.ExecutionPayloadBodyV1 {
|
|
var bodies = make([]*beacon.ExecutionPayloadBodyV1, len(hashes))
|
|
for i, hash := range hashes {
|
|
block := api.eth.BlockChain().GetBlockByHash(hash)
|
|
bodies[i] = getBody(block)
|
|
}
|
|
return bodies
|
|
}
|
|
|
|
// GetPayloadBodiesByRangeV1 implements engine_getPayloadBodiesByRangeV1 which allows for retrieval of a range
|
|
// of block bodies by the engine api.
|
|
func (api *ConsensusAPI) GetPayloadBodiesByRangeV1(start, count uint64) ([]*beacon.ExecutionPayloadBodyV1, error) {
|
|
if start == 0 || count == 0 || count > 1024 {
|
|
return nil, beacon.InvalidParams.With(fmt.Errorf("invalid start or count, start: %v count: %v", start, count))
|
|
}
|
|
// limit count up until current
|
|
current := api.eth.BlockChain().CurrentBlock().NumberU64()
|
|
end := start + count
|
|
if end > current {
|
|
end = current
|
|
}
|
|
var bodies []*beacon.ExecutionPayloadBodyV1
|
|
for i := start; i < end; i++ {
|
|
block := api.eth.BlockChain().GetBlockByNumber(i)
|
|
bodies = append(bodies, getBody(block))
|
|
}
|
|
return bodies, nil
|
|
}
|
|
|
|
func getBody(block *types.Block) *beacon.ExecutionPayloadBodyV1 {
|
|
if block == nil {
|
|
return nil
|
|
}
|
|
|
|
var (
|
|
body = block.Body()
|
|
txs = make([]hexutil.Bytes, len(body.Transactions))
|
|
withdrawals = body.Withdrawals
|
|
)
|
|
|
|
for j, tx := range body.Transactions {
|
|
data, _ := tx.MarshalBinary()
|
|
txs[j] = hexutil.Bytes(data)
|
|
}
|
|
|
|
// Post-shanghai withdrawals MUST be set to empty slice instead of nil
|
|
if withdrawals == nil && block.Header().WithdrawalsHash != nil {
|
|
withdrawals = make([]*types.Withdrawal, 0)
|
|
}
|
|
|
|
return &beacon.ExecutionPayloadBodyV1{
|
|
TransactionData: txs,
|
|
Withdrawals: withdrawals,
|
|
}
|
|
}
|