simulators/ethereum/pyspec: Add simulator for python spec tests (ethereum/exec-spec-tests)

simulators/ethereum/engine/client/engine.go

@@ -23,6 +23,7 @@ type Eth interface {
 	SendTransaction(ctx context.Context, tx *types.Transaction) error
 	SendTransactions(ctx context.Context, txs []*types.Transaction) []error
 	StorageAt(ctx context.Context, account common.Address, key common.Hash, blockNumber *big.Int) ([]byte, error)
+	StorageAtKeys(ctx context.Context, account common.Address, keys []common.Hash, blockNumber *big.Int) (map[common.Hash]*common.Hash, error)
 	TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
 	NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error)
 	TransactionByHash(ctx context.Context, hash common.Hash) (tx *types.Transaction, isPending bool, err error)

simulators/ethereum/engine/client/hive_rpc/hive_rpc.go

@@ -24,6 +24,7 @@ import (
 	"github.com/ethereum/hive/simulators/ethereum/engine/globals"
 	"github.com/ethereum/hive/simulators/ethereum/engine/helper"
 	"github.com/golang-jwt/jwt/v4"
+	"github.com/pkg/errors"
 )
 
 type HiveRPCEngineStarter struct {
@@ -228,6 +229,40 @@ func toBlockNumArg(number *big.Int) string {
 	return hexutil.EncodeBig(number)
 }
 
+func (ec *HiveRPCEngineClient) StorageAtKeys(ctx context.Context, account common.Address, keys []common.Hash, blockNumber *big.Int) (map[common.Hash]*common.Hash, error) {
+	reqs := make([]rpc.BatchElem, 0, len(keys))
+	results := make(map[common.Hash]*common.Hash, len(keys))
+	var blockNumberString string
+	if blockNumber == nil {
+		blockNumberString = "latest"
+	} else {
+		blockNumberString = hexutil.EncodeBig(blockNumber)
+	}
+	for _, key := range keys {
+		valueResult := &common.Hash{}
+		reqs = append(reqs, rpc.BatchElem{
+			Method: "eth_getStorageAt",
+			Args:   []interface{}{account, key, blockNumberString},
+			Result: valueResult,
+		})
+		results[key] = valueResult
+	}
+
+	if err := ec.PrepareDefaultAuthCallToken(); err != nil {
+		return nil, err
+	}
+	if err := ec.c.BatchCallContext(ctx, reqs); err != nil {
+		return nil, err
+	}
+	for i, req := range reqs {
+		if req.Error != nil {
+			return nil, errors.Wrap(req.Error, fmt.Sprintf("request for storage at index %d failed", i))
+		}
+	}
+
+	return results, nil
+}
+
 func (ec *HiveRPCEngineClient) HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error) {
 	var header *types.Header
 	err := ec.cEth.CallContext(ctx, &header, "eth_getBlockByNumber", toBlockNumArg(number), false)

simulators/ethereum/engine/client/node/node.go

@@ -837,6 +837,10 @@ func (n *GethNode) StorageAt(ctx context.Context, account common.Address, key co
 	return stateDB.GetState(account, key).Bytes(), nil
 }
 
+func (n *GethNode) StorageAtKeys(ctx context.Context, account common.Address, keys []common.Hash, blockNumber *big.Int) (map[common.Hash]*common.Hash, error) {
+	return nil, fmt.Errorf("StorageAtKeys not implemented")
+}
+
 func (n *GethNode) TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error) {
 	return nil, fmt.Errorf("TransactionReceipt not implemented")
 }

simulators/ethereum/engine/client/types/types.go

@@ -89,4 +89,4 @@ func (edv1 *ExecutableDataV1) FromExecutableData(ed *beacon.ExecutableData) {
 	edv1.BaseFeePerGas = ed.BaseFeePerGas
 	edv1.BlockHash = ed.BlockHash
 	edv1.Transactions = ed.Transactions
-}
+}

simulators/ethereum/go.work

@@ -0,0 +1,11 @@
+go 1.19
+
+use (
+	./consensus
+	./engine
+	./graphql
+	./pyspec
+	./rpc
+	./rpc-compat
+	./sync
+)

simulators/ethereum/pyspec/Dockerfile

@@ -0,0 +1,30 @@
+# ---------------------------------------------------------------#
+# This simulation runs the Ethereum python execution-spec-tests. #
+# ---------------------------------------------------------------#
+
+# 1) Create pyspec builder container.
+FROM golang:1-alpine as builder
+RUN apk add --update git ca-certificates gcc musl-dev linux-headers
+
+# Build the pyspec simulator executable.
+ADD . /source
+WORKDIR /source/pyspec
+RUN go build -v .
+
+# 2) Create the simulator container.
+FROM alpine:latest as simulator
+RUN apk add --update wget
+ADD ./pyspec /pyspec
+WORKDIR /pyspec
+COPY --from=builder /source/pyspec/pyspec .
+
+# Download the latest fixture release.
+RUN wget https://github.com/ethereum/execution-spec-tests/releases/latest/download/fixtures.tar.gz
+
+# Extract the latest fixtures.
+RUN tar -xzvf fixtures.tar.gz
+RUN mv fixtures /fixtures
+
+# Point to executable and test fixtures.
+ENV TESTPATH /fixtures
+ENTRYPOINT ["./pyspec"]

simulators/ethereum/pyspec/README.md

@@ -0,0 +1,40 @@
+# Hive Pyspec
+
+This is a `simulator` for running the python [execution-spec-tests](https://github.com/ethereum/execution-spec-tests) within [`hive`](https://github.com/ethereum/hive), based on the `consensus` simulator. It differs mostly by using the `Engine API` to feed blocks into clients. 
+
+The simulator is only valid for post `Merge` forks (>= `Merge`).
+
+It can be run from the `hive` root directory simply:
+```sh
+./hive --client go-ethereum --sim ethereum/pyspec
+```
+
+The `pyspec simulator` uses the latest test fixtures from the
+most recent execution-spec-tests [release](https://github.com/ethereum/execution-spec-tests/releases).
+
+
+### Running Specific Test Fixtures
+
+By default all test fixtures will run. To run a specific test or set of test fixtures the regex `--sim-limit /<pattern>` option can be used.
+
+This can utilised in `pyspec` for running tests exclusive to  a specific fork. The pattern must match at least one hive simulation test name within the `pyspec` suite.
+
+Test names are of the type `<path-to-json>_<fixture-name>` omiting `fixtures` from the path. For example, the fixture test `000_push0_key_sstore_shanghai` within `push0.json` will have a hive test name of: `eips_eip3855_000_push0_key_sstore_shanghai`.
+
+1) To run only this test, an example pattern could be:
+   - `./hive --sim ethereum/pyspec --sim.limit /0_push0_key_sstore`
+
+2) To run every withdrawals test in the suite:
+   - `./hive --sim ethereum/pyspec --sim.limit /withdrawals`
+
+3) To run only tests exclusive to the `Shanghai` fork:
+   - `./hive --sim ethereum/pyspec --sim.limit /shanghai`
+
+For a better understand of how to utilise the regex pattern please browse the folder structure of the latest fixture [release](https://github.com/ethereum/execution-spec-tests/releases).
+
+
+### Excluding Test Fixtures
+
+To exclude a file or set of files, partial paths can be added to `excludePaths := []string{"example/"}` within \
+the first code section of `runner.go/LoadFixtureTests()`. By default we exclude all files within the path `fixtures/example/example/*`. 
+

simulators/ethereum/pyspec/forks.go

@@ -0,0 +1,45 @@
+package main
+
+var envForks = map[string]map[string]int{
+	"Merge": {
+		"HIVE_FORK_HOMESTEAD":            0,
+		"HIVE_FORK_TANGERINE":            0,
+		"HIVE_FORK_SPURIOUS":             0,
+		"HIVE_FORK_BYZANTIUM":            0,
+		"HIVE_FORK_CONSTANTINOPLE":       0,
+		"HIVE_FORK_PETERSBURG":           0,
+		"HIVE_FORK_ISTANBUL":             0,
+		"HIVE_FORK_BERLIN":               0,
+		"HIVE_FORK_LONDON":               0,
+		"HIVE_FORK_MERGE":                0,
+		"HIVE_TERMINAL_TOTAL_DIFFICULTY": 0,
+	},
+	"Shanghai": {
+		"HIVE_FORK_HOMESTEAD":            0,
+		"HIVE_FORK_TANGERINE":            0,
+		"HIVE_FORK_SPURIOUS":             0,
+		"HIVE_FORK_BYZANTIUM":            0,
+		"HIVE_FORK_CONSTANTINOPLE":       0,
+		"HIVE_FORK_PETERSBURG":           0,
+		"HIVE_FORK_ISTANBUL":             0,
+		"HIVE_FORK_BERLIN":               0,
+		"HIVE_FORK_LONDON":               0,
+		"HIVE_FORK_MERGE":                0,
+		"HIVE_TERMINAL_TOTAL_DIFFICULTY": 0,
+		"HIVE_SHANGHAI_TIMESTAMP":        0,
+	},
+	"MergeToShanghaiAtTime15k": {
+		"HIVE_FORK_HOMESTEAD":            0,
+		"HIVE_FORK_TANGERINE":            0,
+		"HIVE_FORK_SPURIOUS":             0,
+		"HIVE_FORK_BYZANTIUM":            0,
+		"HIVE_FORK_CONSTANTINOPLE":       0,
+		"HIVE_FORK_PETERSBURG":           0,
+		"HIVE_FORK_ISTANBUL":             0,
+		"HIVE_FORK_BERLIN":               0,
+		"HIVE_FORK_LONDON":               0,
+		"HIVE_FORK_MERGE":                0,
+		"HIVE_TERMINAL_TOTAL_DIFFICULTY": 0,
+		"HIVE_SHANGHAI_TIMESTAMP":        15000,
+	},
+}