mirror of https://github.com/ethereum/go-ethereum
all: separate catalyst package (#24280)
* all: seperate catalyst package * eth/catalyst: moved some methods, added docs * eth/catalyst, les/catalyst: add method docs * core, eth, les, miner: move common function to beacon package * eth/catalyst: goimported * cmd/utils, miner/stress/beacon: naming nitpicks Co-authored-by: Marius van der Wijden <m.vanderwijden@live.de> Co-authored-by: Péter Szilágyi <peterke@gmail.com>pull/24321/head
rjl493456442
3 years ago
committed by
GitHub
parent
a5c0cfb451
commit
9da25c5db7
@ -0,0 +1,29 @@ |
||||
// Copyright 2022 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 beacon |
||||
|
||||
import "github.com/ethereum/go-ethereum/rpc" |
||||
|
||||
var ( |
||||
VALID = GenericStringResponse{"VALID"} |
||||
SUCCESS = GenericStringResponse{"SUCCESS"} |
||||
INVALID = ForkChoiceResponse{Status: "INVALID", PayloadID: nil} |
||||
SYNCING = ForkChoiceResponse{Status: "SYNCING", PayloadID: nil} |
||||
GenericServerError = rpc.CustomError{Code: -32000, ValidationError: "Server error"} |
||||
UnknownPayload = rpc.CustomError{Code: -32001, ValidationError: "Unknown payload"} |
||||
InvalidTB = rpc.CustomError{Code: -32002, ValidationError: "Invalid terminal block"} |
||||
) |
||||
@ -1,6 +1,6 @@ |
||||
// Code generated by github.com/fjl/gencodec. DO NOT EDIT.
|
||||
|
||||
package catalyst |
||||
package beacon |
||||
|
||||
import ( |
||||
"encoding/json" |
||||
@ -1,6 +1,6 @@ |
||||
// Code generated by github.com/fjl/gencodec. DO NOT EDIT.
|
||||
|
||||
package catalyst |
||||
package beacon |
||||
|
||||
import ( |
||||
"encoding/json" |
||||
@ -0,0 +1,178 @@ |
||||
// Copyright 2022 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" |
||||
|
||||
"github.com/ethereum/go-ethereum/common" |
||||
"github.com/ethereum/go-ethereum/core/beacon" |
||||
"github.com/ethereum/go-ethereum/les" |
||||
"github.com/ethereum/go-ethereum/log" |
||||
"github.com/ethereum/go-ethereum/node" |
||||
"github.com/ethereum/go-ethereum/rpc" |
||||
) |
||||
|
||||
// Register adds catalyst APIs to the light client.
|
||||
func Register(stack *node.Node, backend *les.LightEthereum) error { |
||||
log.Warn("Catalyst mode enabled", "protocol", "les") |
||||
stack.RegisterAPIs([]rpc.API{ |
||||
{ |
||||
Namespace: "engine", |
||||
Version: "1.0", |
||||
Service: NewConsensusAPI(backend), |
||||
Public: true, |
||||
}, |
||||
}) |
||||
return nil |
||||
} |
||||
|
||||
type ConsensusAPI struct { |
||||
les *les.LightEthereum |
||||
} |
||||
|
||||
// NewConsensusAPI creates a new consensus api for the given backend.
|
||||
// The underlying blockchain needs to have a valid terminal total difficulty set.
|
||||
func NewConsensusAPI(les *les.LightEthereum) *ConsensusAPI { |
||||
if les.BlockChain().Config().TerminalTotalDifficulty == nil { |
||||
panic("Catalyst started without valid total difficulty") |
||||
} |
||||
return &ConsensusAPI{les: les} |
||||
} |
||||
|
||||
// ForkchoiceUpdatedV1 has several responsibilities:
|
||||
// If the method is called with an empty head block:
|
||||
// we return success, which can be used to check if the catalyst mode 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
|
||||
// We try to set our blockchain to the headBlock
|
||||
// If there are payloadAttributes:
|
||||
// we return an error since block creation is not supported in les mode
|
||||
func (api *ConsensusAPI) ForkchoiceUpdatedV1(heads beacon.ForkchoiceStateV1, payloadAttributes *beacon.PayloadAttributesV1) (beacon.ForkChoiceResponse, error) { |
||||
if heads.HeadBlockHash == (common.Hash{}) { |
||||
return beacon.ForkChoiceResponse{Status: beacon.SUCCESS.Status, PayloadID: nil}, nil |
||||
} |
||||
if err := api.checkTerminalTotalDifficulty(heads.HeadBlockHash); err != nil { |
||||
if header := api.les.BlockChain().GetHeaderByHash(heads.HeadBlockHash); header == nil { |
||||
// TODO (MariusVanDerWijden) trigger sync
|
||||
return beacon.SYNCING, nil |
||||
} |
||||
return beacon.INVALID, err |
||||
} |
||||
// If the finalized block is set, check if it is in our blockchain
|
||||
if heads.FinalizedBlockHash != (common.Hash{}) { |
||||
if header := api.les.BlockChain().GetHeaderByHash(heads.FinalizedBlockHash); header == nil { |
||||
// TODO (MariusVanDerWijden) trigger sync
|
||||
return beacon.SYNCING, nil |
||||
} |
||||
} |
||||
// SetHead
|
||||
if err := api.setHead(heads.HeadBlockHash); err != nil { |
||||
return beacon.INVALID, err |
||||
} |
||||
if payloadAttributes != nil { |
||||
return beacon.INVALID, errors.New("not supported") |
||||
} |
||||
return beacon.ForkChoiceResponse{Status: beacon.SUCCESS.Status, PayloadID: nil}, nil |
||||
} |
||||
|
||||
// GetPayloadV1 returns a cached payload by id. It's not supported in les mode.
|
||||
func (api *ConsensusAPI) GetPayloadV1(payloadID beacon.PayloadID) (*beacon.ExecutableDataV1, error) { |
||||
return nil, &beacon.GenericServerError |
||||
} |
||||
|
||||
// ExecutePayloadV1 creates an Eth1 block, inserts it in the chain, and returns the status of the chain.
|
||||
func (api *ConsensusAPI) ExecutePayloadV1(params beacon.ExecutableDataV1) (beacon.ExecutePayloadResponse, error) { |
||||
block, err := beacon.ExecutableDataToBlock(params) |
||||
if err != nil { |
||||
return api.invalid(), err |
||||
} |
||||
if !api.les.BlockChain().HasHeader(block.ParentHash(), block.NumberU64()-1) { |
||||
/* |
||||
TODO (MariusVanDerWijden) reenable once sync is merged |
||||
if err := api.eth.Downloader().BeaconSync(api.eth.SyncMode(), block.Header()); err != nil { |
||||
return SYNCING, err |
||||
} |
||||
*/ |
||||
// TODO (MariusVanDerWijden) we should return nil here not empty hash
|
||||
return beacon.ExecutePayloadResponse{Status: beacon.SYNCING.Status, LatestValidHash: common.Hash{}}, nil |
||||
} |
||||
parent := api.les.BlockChain().GetHeaderByHash(params.ParentHash) |
||||
if parent == nil { |
||||
return api.invalid(), fmt.Errorf("could not find parent %x", params.ParentHash) |
||||
} |
||||
td := api.les.BlockChain().GetTd(parent.Hash(), block.NumberU64()-1) |
||||
ttd := api.les.BlockChain().Config().TerminalTotalDifficulty |
||||
if td.Cmp(ttd) < 0 { |
||||
return api.invalid(), fmt.Errorf("can not execute payload on top of block with low td got: %v threshold %v", td, ttd) |
||||
} |
||||
if err = api.les.BlockChain().InsertHeader(block.Header()); err != nil { |
||||
return api.invalid(), err |
||||
} |
||||
if merger := api.les.Merger(); !merger.TDDReached() { |
||||
merger.ReachTTD() |
||||
} |
||||
return beacon.ExecutePayloadResponse{Status: beacon.VALID.Status, LatestValidHash: block.Hash()}, nil |
||||
} |
||||
|
||||
// invalid returns a response "INVALID" with the latest valid hash set to the current head.
|
||||
func (api *ConsensusAPI) invalid() beacon.ExecutePayloadResponse { |
||||
return beacon.ExecutePayloadResponse{Status: beacon.INVALID.Status, LatestValidHash: api.les.BlockChain().CurrentHeader().Hash()} |
||||
} |
||||
|
||||
func (api *ConsensusAPI) checkTerminalTotalDifficulty(head common.Hash) error { |
||||
// shortcut if we entered PoS already
|
||||
if api.les.Merger().PoSFinalized() { |
||||
return nil |
||||
} |
||||
// make sure the parent has enough terminal total difficulty
|
||||
header := api.les.BlockChain().GetHeaderByHash(head) |
||||
if header == nil { |
||||
return &beacon.GenericServerError |
||||
} |
||||
td := api.les.BlockChain().GetTd(header.Hash(), header.Number.Uint64()) |
||||
if td != nil && td.Cmp(api.les.BlockChain().Config().TerminalTotalDifficulty) < 0 { |
||||
return &beacon.InvalidTB |
||||
} |
||||
return nil |
||||
} |
||||
|
||||
// setHead is called to perform a force choice.
|
||||
func (api *ConsensusAPI) setHead(newHead common.Hash) error { |
||||
log.Info("Setting head", "head", newHead) |
||||
|
||||
headHeader := api.les.BlockChain().CurrentHeader() |
||||
if headHeader.Hash() == newHead { |
||||
return nil |
||||
} |
||||
newHeadHeader := api.les.BlockChain().GetHeaderByHash(newHead) |
||||
if newHeadHeader == nil { |
||||
return &beacon.GenericServerError |
||||
} |
||||
if err := api.les.BlockChain().SetChainHead(newHeadHeader); err != nil { |
||||
return err |
||||
} |
||||
// Trigger the transition if it's the first `NewHead` event.
|
||||
if merger := api.les.Merger(); !merger.PoSFinalized() { |
||||
merger.FinalizePoS() |
||||
} |
||||
return nil |
||||
} |
||||
@ -0,0 +1,244 @@ |
||||
// Copyright 2020 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 |
||||
|
||||
import ( |
||||
"math/big" |
||||
"testing" |
||||
|
||||
"github.com/ethereum/go-ethereum/common" |
||||
"github.com/ethereum/go-ethereum/consensus/ethash" |
||||
"github.com/ethereum/go-ethereum/core" |
||||
"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/crypto" |
||||
"github.com/ethereum/go-ethereum/eth/downloader" |
||||
"github.com/ethereum/go-ethereum/eth/ethconfig" |
||||
"github.com/ethereum/go-ethereum/les" |
||||
"github.com/ethereum/go-ethereum/node" |
||||
"github.com/ethereum/go-ethereum/params" |
||||
"github.com/ethereum/go-ethereum/trie" |
||||
) |
||||
|
||||
var ( |
||||
// testKey is a private key to use for funding a tester account.
|
||||
testKey, _ = crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291") |
||||
|
||||
// testAddr is the Ethereum address of the tester account.
|
||||
testAddr = crypto.PubkeyToAddress(testKey.PublicKey) |
||||
|
||||
testBalance = big.NewInt(2e18) |
||||
) |
||||
|
||||
func generatePreMergeChain(n int) (*core.Genesis, []*types.Header, []*types.Block) { |
||||
db := rawdb.NewMemoryDatabase() |
||||
config := params.AllEthashProtocolChanges |
||||
genesis := &core.Genesis{ |
||||
Config: config, |
||||
Alloc: core.GenesisAlloc{testAddr: {Balance: testBalance}}, |
||||
ExtraData: []byte("test genesis"), |
||||
Timestamp: 9000, |
||||
BaseFee: big.NewInt(params.InitialBaseFee), |
||||
} |
||||
gblock := genesis.ToBlock(db) |
||||
engine := ethash.NewFaker() |
||||
blocks, _ := core.GenerateChain(config, gblock, engine, db, n, nil) |
||||
totalDifficulty := big.NewInt(0) |
||||
|
||||
var headers []*types.Header |
||||
for _, b := range blocks { |
||||
totalDifficulty.Add(totalDifficulty, b.Difficulty()) |
||||
headers = append(headers, b.Header()) |
||||
} |
||||
config.TerminalTotalDifficulty = totalDifficulty |
||||
|
||||
return genesis, headers, blocks |
||||
} |
||||
|
||||
func TestSetHeadBeforeTotalDifficulty(t *testing.T) { |
||||
genesis, headers, blocks := generatePreMergeChain(10) |
||||
n, lesService := startLesService(t, genesis, headers) |
||||
defer n.Close() |
||||
|
||||
api := NewConsensusAPI(lesService) |
||||
fcState := beacon.ForkchoiceStateV1{ |
||||
HeadBlockHash: blocks[5].Hash(), |
||||
SafeBlockHash: common.Hash{}, |
||||
FinalizedBlockHash: common.Hash{}, |
||||
} |
||||
if _, err := api.ForkchoiceUpdatedV1(fcState, nil); err == nil { |
||||
t.Errorf("fork choice updated before total terminal difficulty should fail") |
||||
} |
||||
} |
||||
|
||||
func TestExecutePayloadV1(t *testing.T) { |
||||
genesis, headers, blocks := generatePreMergeChain(10) |
||||
n, lesService := startLesService(t, genesis, headers[:9]) |
||||
lesService.Merger().ReachTTD() |
||||
defer n.Close() |
||||
|
||||
api := NewConsensusAPI(lesService) |
||||
fcState := beacon.ForkchoiceStateV1{ |
||||
HeadBlockHash: blocks[8].Hash(), |
||||
SafeBlockHash: common.Hash{}, |
||||
FinalizedBlockHash: common.Hash{}, |
||||
} |
||||
if _, err := api.ForkchoiceUpdatedV1(fcState, nil); err != nil { |
||||
t.Errorf("Failed to update head %v", err) |
||||
} |
||||
block := blocks[9] |
||||
|
||||
fakeBlock := types.NewBlock(&types.Header{ |
||||
ParentHash: block.ParentHash(), |
||||
UncleHash: crypto.Keccak256Hash(nil), |
||||
Coinbase: block.Coinbase(), |
||||
Root: block.Root(), |
||||
TxHash: crypto.Keccak256Hash(nil), |
||||
ReceiptHash: crypto.Keccak256Hash(nil), |
||||
Bloom: block.Bloom(), |
||||
Difficulty: big.NewInt(0), |
||||
Number: block.Number(), |
||||
GasLimit: block.GasLimit(), |
||||
GasUsed: block.GasUsed(), |
||||
Time: block.Time(), |
||||
Extra: block.Extra(), |
||||
MixDigest: block.MixDigest(), |
||||
Nonce: types.BlockNonce{}, |
||||
BaseFee: block.BaseFee(), |
||||
}, nil, nil, nil, trie.NewStackTrie(nil)) |
||||
|
||||
_, err := api.ExecutePayloadV1(beacon.ExecutableDataV1{ |
||||
ParentHash: fakeBlock.ParentHash(), |
||||
FeeRecipient: fakeBlock.Coinbase(), |
||||
StateRoot: fakeBlock.Root(), |
||||
ReceiptsRoot: fakeBlock.ReceiptHash(), |
||||
LogsBloom: fakeBlock.Bloom().Bytes(), |
||||
Random: fakeBlock.MixDigest(), |
||||
Number: fakeBlock.NumberU64(), |
||||
GasLimit: fakeBlock.GasLimit(), |
||||
GasUsed: fakeBlock.GasUsed(), |
||||
Timestamp: fakeBlock.Time(), |
||||
ExtraData: fakeBlock.Extra(), |
||||
BaseFeePerGas: fakeBlock.BaseFee(), |
||||
BlockHash: fakeBlock.Hash(), |
||||
Transactions: encodeTransactions(fakeBlock.Transactions()), |
||||
}) |
||||
if err != nil { |
||||
t.Errorf("Failed to execute payload %v", err) |
||||
} |
||||
headHeader := api.les.BlockChain().CurrentHeader() |
||||
if headHeader.Number.Uint64() != fakeBlock.NumberU64()-1 { |
||||
t.Fatal("Unexpected chain head update") |
||||
} |
||||
fcState = beacon.ForkchoiceStateV1{ |
||||
HeadBlockHash: fakeBlock.Hash(), |
||||
SafeBlockHash: common.Hash{}, |
||||
FinalizedBlockHash: common.Hash{}, |
||||
} |
||||
if _, err := api.ForkchoiceUpdatedV1(fcState, nil); err != nil { |
||||
t.Fatal("Failed to update head") |
||||
} |
||||
headHeader = api.les.BlockChain().CurrentHeader() |
||||
if headHeader.Number.Uint64() != fakeBlock.NumberU64() { |
||||
t.Fatal("Failed to update chain head") |
||||
} |
||||
} |
||||
|
||||
func TestEth2DeepReorg(t *testing.T) { |
||||
// TODO (MariusVanDerWijden) TestEth2DeepReorg is currently broken, because it tries to reorg
|
||||
// before the totalTerminalDifficulty threshold
|
||||
/* |
||||
genesis, preMergeBlocks := generatePreMergeChain(core.TriesInMemory * 2) |
||||
n, ethservice := startEthService(t, genesis, preMergeBlocks) |
||||
defer n.Close() |
||||
|
||||
var ( |
||||
api = NewConsensusAPI(ethservice, nil) |
||||
parent = preMergeBlocks[len(preMergeBlocks)-core.TriesInMemory-1] |
||||
head = ethservice.BlockChain().CurrentBlock().NumberU64() |
||||
) |
||||
if ethservice.BlockChain().HasBlockAndState(parent.Hash(), parent.NumberU64()) { |
||||
t.Errorf("Block %d not pruned", parent.NumberU64()) |
||||
} |
||||
for i := 0; i < 10; i++ { |
||||
execData, err := api.assembleBlock(AssembleBlockParams{ |
||||
ParentHash: parent.Hash(), |
||||
Timestamp: parent.Time() + 5, |
||||
}) |
||||
if err != nil { |
||||
t.Fatalf("Failed to create the executable data %v", err) |
||||
} |
||||
block, err := ExecutableDataToBlock(ethservice.BlockChain().Config(), parent.Header(), *execData) |
||||
if err != nil { |
||||
t.Fatalf("Failed to convert executable data to block %v", err) |
||||
} |
||||
newResp, err := api.ExecutePayload(*execData) |
||||
if err != nil || newResp.Status != "VALID" { |
||||
t.Fatalf("Failed to insert block: %v", err) |
||||
} |
||||
if ethservice.BlockChain().CurrentBlock().NumberU64() != head { |
||||
t.Fatalf("Chain head shouldn't be updated") |
||||
} |
||||
if err := api.setHead(block.Hash()); err != nil { |
||||
t.Fatalf("Failed to set head: %v", err) |
||||
} |
||||
if ethservice.BlockChain().CurrentBlock().NumberU64() != block.NumberU64() { |
||||
t.Fatalf("Chain head should be updated") |
||||
} |
||||
parent, head = block, block.NumberU64() |
||||
} |
||||
*/ |
||||
} |
||||
|
||||
// startEthService creates a full node instance for testing.
|
||||
func startLesService(t *testing.T, genesis *core.Genesis, headers []*types.Header) (*node.Node, *les.LightEthereum) { |
||||
t.Helper() |
||||
|
||||
n, err := node.New(&node.Config{}) |
||||
if err != nil { |
||||
t.Fatal("can't create node:", err) |
||||
} |
||||
ethcfg := ðconfig.Config{ |
||||
Genesis: genesis, |
||||
Ethash: ethash.Config{PowMode: ethash.ModeFake}, |
||||
SyncMode: downloader.LightSync, |
||||
TrieDirtyCache: 256, |
||||
TrieCleanCache: 256, |
||||
LightPeers: 10, |
||||
} |
||||
lesService, err := les.New(n, ethcfg) |
||||
if err != nil { |
||||
t.Fatal("can't create eth service:", err) |
||||
} |
||||
if err := n.Start(); err != nil { |
||||
t.Fatal("can't start node:", err) |
||||
} |
||||
if _, err := lesService.BlockChain().InsertHeaderChain(headers, 0); err != nil { |
||||
n.Close() |
||||
t.Fatal("can't import test headers:", err) |
||||
} |
||||
return n, lesService |
||||
} |
||||
|
||||
func encodeTransactions(txs []*types.Transaction) [][]byte { |
||||
var enc = make([][]byte, len(txs)) |
||||
for i, tx := range txs { |
||||
enc[i], _ = tx.MarshalBinary() |
||||
} |
||||
return enc |
||||
} |
||||
Loading…
Reference in new issue