simulators/eth2/engine: Add test, several improvements

Author: marioevz

simulators/eth2/engine/chain_generators.go

@@ -1,8 +1,6 @@
 package main
 
 import (
-	"crypto/rand"
-
 	"github.com/ethereum/go-ethereum/consensus"
 	"github.com/ethereum/go-ethereum/consensus/ethash"
 	"github.com/ethereum/go-ethereum/core"
@@ -26,6 +24,8 @@ var PoWChainGeneratorDefaults = ethash.Config{
 type PoWChainGenerator struct {
 	BlockCount int
 	ethash.Config
+	GenFunction func(int, *core.BlockGen)
+	blocks      []*types.Block
 }
 
 // instaSeal wraps a consensus engine with instant block sealing. When a block is produced
@@ -46,16 +46,17 @@ func (e instaSeal) FinalizeAndAssemble(chain consensus.ChainHeaderReader, header
 	return <-sealedBlock, nil
 }
 
-func (p PoWChainGenerator) Generate(genesis *setup.Eth1Genesis) ([]*types.Block, error) {
+func (p *PoWChainGenerator) Generate(genesis *setup.Eth1Genesis) ([]*types.Block, error) {
+	// We generate a new chain only if the generator had not generated one already.
+	// This is done because the chain generators can be reused on different clients to ensure
+	// they start with the same chain.
+	if p.blocks != nil {
+		return p.blocks, nil
+	}
 	db := rawdb.NewMemoryDatabase()
 	engine := ethash.New(p.Config, nil, false)
 	insta := instaSeal{engine}
 	genesisBlock := genesis.Genesis.ToBlock(db)
-	gen := func(i int, blockGen *core.BlockGen) {
-		data := make([]byte, 16)
-		rand.Read(data)
-		blockGen.SetExtra(data)
-	}
-	blocks, _ := core.GenerateChain(genesis.Genesis.Config, genesisBlock, insta, db, p.BlockCount, gen)
-	return blocks, nil
+	p.blocks, _ = core.GenerateChain(genesis.Genesis.Config, genesisBlock, insta, db, p.BlockCount, p.GenFunction)
+	return p.blocks, nil
 }

simulators/eth2/engine/helper.go

@@ -69,6 +69,7 @@ type Config struct {
 	SlotTime                        *big.Int
 	TerminalTotalDifficulty         *big.Int
 	SafeSlotsToImportOptimistically *big.Int
+	ExtraShares                     *big.Int
 
 	// Node configurations to launch. Each node as a proportional share of
 	// validators.
@@ -104,6 +105,7 @@ func (a *Config) join(b *Config) *Config {
 	c.SlotTime = choose(a.SlotTime, b.SlotTime)
 	c.TerminalTotalDifficulty = choose(a.TerminalTotalDifficulty, b.TerminalTotalDifficulty)
 	c.SafeSlotsToImportOptimistically = choose(a.SafeSlotsToImportOptimistically, b.SafeSlotsToImportOptimistically)
+	c.ExtraShares = choose(a.ExtraShares, b.ExtraShares)
 
 	// EL config
 	c.InitialBaseFeePerGas = choose(a.InitialBaseFeePerGas, b.InitialBaseFeePerGas)
@@ -560,9 +562,46 @@ func forkchoiceResponseSpoof(method string, status PayloadStatusV1, payloadID *P
 	}, nil
 }
 
+// List of Hashes that can be accessed concurrently
+type SyncHashes struct {
+	Hashes []common.Hash
+	Lock   *sync.Mutex
+}
+
+func NewSyncHashes(hashes ...common.Hash) *SyncHashes {
+	newSyncHashes := &SyncHashes{
+		Hashes: make([]common.Hash, 0),
+		Lock:   &sync.Mutex{},
+	}
+	for _, h := range hashes {
+		newSyncHashes.Hashes = append(newSyncHashes.Hashes, h)
+	}
+	return newSyncHashes
+}
+
+func (syncHashes *SyncHashes) Contains(hash common.Hash) bool {
+	syncHashes.Lock.Lock()
+	defer syncHashes.Lock.Unlock()
+	if syncHashes.Hashes == nil {
+		return false
+	}
+	for _, h := range syncHashes.Hashes {
+		if h == hash {
+			return true
+		}
+	}
+	return false
+}
+
+func (syncHashes *SyncHashes) Add(hash common.Hash) {
+	syncHashes.Lock.Lock()
+	defer syncHashes.Lock.Unlock()
+	syncHashes.Hashes = append(syncHashes.Hashes, hash)
+}
+
 // Generate a callback that invalidates either a call to `engine_forkchoiceUpdatedV1` or `engine_newPayloadV1`
-// if the hash of the payload matches the specified hash.
-func InvalidateExecutionPayloadByHash(method string, payloadHash common.Hash, called chan<- interface{}) func([]byte, []byte) *proxy.Spoof {
+// for all hashes with given exceptions, and a given LatestValidHash.
+func InvalidateExecutionPayloads(method string, exceptions *SyncHashes, latestValidHash *common.Hash, invalidated chan<- common.Hash) func([]byte, []byte) *proxy.Spoof {
 	if method == EngineForkchoiceUpdatedV1 {
 		return func(res []byte, req []byte) *proxy.Spoof {
 			var (
@@ -575,18 +614,17 @@ func InvalidateExecutionPayloadByHash(method string, payloadHash common.Hash, ca
 			if err != nil {
 				panic(err)
 			}
-			if fcState.HeadBlockHash == payloadHash {
-				zeroHash := common.Hash{}
+			if !exceptions.Contains(fcState.HeadBlockHash) {
 				spoof, err = forkchoiceResponseSpoof(EngineForkchoiceUpdatedV1, PayloadStatusV1{
 					Status:          Invalid,
-					LatestValidHash: &zeroHash,
+					LatestValidHash: latestValidHash,
 					ValidationError: nil,
 				}, nil)
 				if err != nil {
 					panic(err)
 				}
 				select {
-				case called <- fcState:
+				case invalidated <- fcState.HeadBlockHash:
 				default:
 				}
 				return spoof
@@ -605,18 +643,17 @@ func InvalidateExecutionPayloadByHash(method string, payloadHash common.Hash, ca
 			if err != nil {
 				panic(err)
 			}
-			if payload.BlockHash == payloadHash {
-				zeroHash := common.Hash{}
+			if !exceptions.Contains(payload.BlockHash) {
 				spoof, err = payloadStatusSpoof(EngineNewPayloadV1, &PayloadStatusV1{
 					Status:          Invalid,
-					LatestValidHash: &zeroHash,
+					LatestValidHash: latestValidHash,
 					ValidationError: nil,
 				})
 				if err != nil {
 					panic(err)
 				}
 				select {
-				case called <- payload:
+				case invalidated <- payload.BlockHash:
 				default:
 				}
 				return spoof
@@ -713,8 +750,9 @@ func SlotsUntilBellatrix(genesisTime beacon.Timestamp, spec *beacon.Spec) beacon
 	if currentTimestamp >= bellatrixTime {
 		return beacon.Slot(0)
 	}
-	fmt.Printf("INFO: bellatrixTime:%d, currentTimestamp:%d\n", bellatrixTime, currentTimestamp)
-	return beacon.Slot((bellatrixTime-currentTimestamp)/spec.SECONDS_PER_SLOT) + 1
+	s := beacon.Slot((bellatrixTime-currentTimestamp)/spec.SECONDS_PER_SLOT) + 1
+	fmt.Printf("INFO: bellatrixTime:%d, currentTimestamp:%d, slots=%d\n", bellatrixTime, currentTimestamp, s)
+	return s
 }
 
 func TimeUntilTerminalBlock(e *Eth1Node, c setup.Eth1Consensus, defaultTTD *big.Int, n node) uint64 {

simulators/eth2/engine/main.go

@@ -17,7 +17,7 @@ var (
 	VAULT_KEY, _       = crypto.HexToECDSA("63b508a03c3b5937ceb903af8b1b0c191012ef6eb7e9c3fb7afa94e5d214d376")
 )
 
-var tests = []testSpec{
+var engineTests = []testSpec{
 	//{Name: "transition-testnet", Run: TransitionTestnet},
 	{Name: "test-rpc-error", Run: TestRPCError},
 	{Name: "block-latest-safe-finalized", Run: BlockLatestSafeFinalized},
@@ -28,7 +28,8 @@ var tests = []testSpec{
 	{Name: "syncing-with-invalid-chain", Run: SyncingWithInvalidChain},
 	{Name: "basefee-encoding-check", Run: BaseFeeEncodingCheck},
 	{Name: "invalid-quantity-fields", Run: InvalidQuantityPayloadFields},
-
+}
+var transitionTests = []testSpec{
 	// Transition (TERMINAL_TOTAL_DIFFICULTY) tests
 	{Name: "invalid-transition-payload", Run: InvalidPayloadGen(1, Invalid)},
 	{Name: "unknown-pow-parent-transition-payload", Run: UnknownPoWParent},
@@ -40,14 +41,12 @@ var tests = []testSpec{
 	{Name: "optimistic-syncing-with-valid-chain", Run: OptimisticSyncingWithValidChain},
 	{Name: "syncing-with-chain-having-valid-transition-block", Run: SyncingWithChainHavingValidTransitionBlock},
 	{Name: "syncing-with-chain-having-invalid-transition-block", Run: SyncingWithChainHavingInvalidTransitionBlock},
+	{Name: "syncing-with-chain-having-invalid-post-transition-block", Run: SyncingWithChainHavingInvalidPostTransitionBlock},
+	{Name: "re-org-and-sync-with-chain-having-invalid-terminal-block", Run: ReOrgSyncWithChainHavingInvalidTerminalBlock},
 }
 
 func main() {
-	// Create the test suite that will include all tests
-	var suite = hivesim.Suite{
-		Name:        "eth2-engine",
-		Description: `Collection of test vectors that use a ExecutionClient+BeaconNode+ValidatorClient testnet.`,
-	}
+
 	// Create simulator that runs all tests
 	sim := hivesim.New()
 	// From the simulator we can get all client types provided
@@ -65,12 +64,27 @@ func main() {
 	if len(c.Validator) != 1 {
 		panic("choose 1 validator client type")
 	}
-	// Add all tests to the suite and then run it
-	addAllTests(&suite, c)
-	hivesim.MustRunSuite(sim, suite)
+	// Create the test suites
+	var (
+		engineSuite = hivesim.Suite{
+			Name:        "eth2-engine",
+			Description: `Collection of test vectors that use a ExecutionClient+BeaconNode+ValidatorClient testnet.`,
+		}
+		transitionSuite = hivesim.Suite{
+			Name:        "eth2-engine-transition",
+			Description: `Collection of test vectors that use a ExecutionClient+BeaconNode+ValidatorClient transition testnet.`,
+		}
+	)
+	// Add all tests to the suites
+	addAllTests(&engineSuite, c, engineTests)
+	addAllTests(&transitionSuite, c, transitionTests)
+
+	// Mark suites for execution
+	hivesim.MustRunSuite(sim, engineSuite)
+	hivesim.MustRunSuite(sim, transitionSuite)
 }
 
-func addAllTests(suite *hivesim.Suite, c *ClientDefinitionsByRole) {
+func addAllTests(suite *hivesim.Suite, c *ClientDefinitionsByRole, tests []testSpec) {
 	mnemonic := "couple kiwi radio river setup fortune hunt grief buddy forward perfect empty slim wear bounce drift execute nation tobacco dutch chapter festival ice fog"
 
 	// Generate validator keys to use for all tests.