Merge pull request #21 from crypto-org-chain/refactor/remove-active-precompiles-from-vm-context

chore: remove active precompiles from vm context

Author: randy-cro

.github/workflows/go.yml

@@ -1,16 +1,15 @@
 name: i386 linux tests
 
 on:
-  push:
-    branches: [ master ]
+  push:  
   pull_request:
     branches: [ master ]
   workflow_dispatch:
 
 jobs:
   lint:
     name: Lint
-    runs-on: self-hosted
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
 
@@ -33,7 +32,7 @@ jobs:
         go run build/ci.go check_baddeps
 
   build:
-    runs-on: self-hosted
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - name: Set up Go
@@ -42,7 +41,7 @@ jobs:
           go-version: 1.24.0
           cache: false
       - name: Run tests
-        run: go test -short ./...
+        run: make test
         env:
           GOOS: linux
-          GOARCH: 386
+          GOARCH: 386

CHANGELOG.md

@@ -5,3 +5,4 @@
 ### State Machine Breaking
 
 - [#20](https://github.com/crypto-org-chain/go-ethereum/pull/20) feat: support cronos precompiles
+- [#21](https://github.com/crypto-org-chain/go-ethereum/pull/21) chore: Remove active precompiles from VMContext and fixed tests

Makefile

@@ -4,6 +4,8 @@
 
 .PHONY: geth all test lint fmt clean devtools help
 
+TESTPATH?= ./...
+
 GOBIN = ./build/bin
 GO ?= latest
 GORUN = go run
@@ -19,8 +21,10 @@ all:
 	$(GORUN) build/ci.go install
 
 #? test: Run the tests.
+#? to test a specific package eg `make test TESTPATH=./core/vm`
+#? to test specific packages eg `make test TESTPATH="./core/vm ./eth/tracers/native ./internal/ethapi"`	
 test: all
-	$(GORUN) build/ci.go test
+	$(GORUN) build/ci.go test $(TESTPATH)
 
 #? lint: Run certain pre-selected linters.
 lint: ## Run linters.

build/checksums.txt

@@ -3,7 +3,7 @@
 # version:spec-tests pectra-devnet-6@v1.0.0
 # https://github.com/ethereum/execution-spec-tests/releases
 # https://github.com/ethereum/execution-spec-tests/releases/download/pectra-devnet-6%40v1.0.0/
-b69211752a3029083c020dc635fe12156ca1a6725a08559da540a0337586a77e  fixtures_pectra-devnet-6.tar.gz
+5ed3bec40a02776a4096c17b84b59fb20fd99fbabba8101fdac3d35a001cf82a  fixtures_pectra-devnet-6.tar.gz
 
 # version:golang 1.24.2
 # https://go.dev/dl/

core/state_transition.go

@@ -476,7 +476,7 @@ func (st *stateTransition) execute() (*ExecutionResult, error) {
 	// Execute the preparatory steps for state transition which includes:
 	// - prepare accessList(post-berlin)
 	// - reset transient storage(eip 1153)
-	st.state.Prepare(rules, msg.From, st.evm.Context.Coinbase, msg.To, st.evm.ActivePrecompiles(rules), msg.AccessList)
+	st.state.Prepare(rules, msg.From, st.evm.Context.Coinbase, msg.To, vm.ActivePrecompiles(rules), msg.AccessList)
 
 	var (
 		ret   []byte

core/tracing/hooks.go

@@ -59,13 +59,12 @@ type StateDB interface {
 
 // VMContext provides the context for the EVM execution.
 type VMContext struct {
-	Coinbase          common.Address
-	BlockNumber       *big.Int
-	Time              uint64
-	Random            *common.Hash
-	BaseFee           *big.Int
-	StateDB           StateDB
-	ActivePrecompiles []common.Address
+	Coinbase    common.Address
+	BlockNumber *big.Int
+	Time        uint64
+	Random      *common.Hash
+	BaseFee     *big.Int
+	StateDB     StateDB
 }
 
 // BlockEvent is emitted upon tracing an incoming block.

core/vm/contracts.go

@@ -200,8 +200,8 @@ func ActivePrecompiledContracts(rules params.Rules) PrecompiledContracts {
 	return maps.Clone(activePrecompiledContracts(rules))
 }
 
-// DefaultActivePrecompiles returns the set of precompiles enabled with the default configuration.
-func DefaultActivePrecompiles(rules params.Rules) []common.Address {
+// ActivePrecompiles returns the precompile addresses enabled with the current configuration.
+func ActivePrecompiles(rules params.Rules) []common.Address {
 	switch {
 	case rules.IsPrague:
 		return PrecompiledAddressesPrague
@@ -219,7 +219,7 @@ func DefaultActivePrecompiles(rules params.Rules) []common.Address {
 }
 
 // DefaultPrecompiles define the mapping of address and precompiles from the default configuration
-func DefaultPrecompiles(rules params.Rules) (precompiles map[common.Address]PrecompiledContract) {
+func DefaultPrecompiles(rules params.Rules) (precompiles PrecompiledContracts) {
 	switch {
 	case rules.IsVerkle:
 		precompiles = PrecompiledContractsVerkle
@@ -240,32 +240,13 @@ func DefaultPrecompiles(rules params.Rules) (precompiles map[common.Address]Prec
 	return precompiles
 }
 
-// ActivePrecompiles returns the precompiles enabled with the current configuration.
-//
-// NOTE: The rules argument is ignored as the active precompiles can be set via the WithPrecompiles
-// method according to the chain rules from the current block context.
-func (evm *EVM) ActivePrecompiles(_ params.Rules) []common.Address {
-	return evm.activePrecompiles
-}
-
 // Precompile returns a precompiled contract for the given address. This
 // function returns false if the address is not a registered precompile.
 func (evm *EVM) Precompile(addr common.Address) (PrecompiledContract, bool) {
 	p, ok := evm.precompiles[addr]
 	return p, ok
 }
 
-// WithPrecompiles sets the precompiled contracts and the slice of actives precompiles.
-// IMPORTANT: This function does NOT validate the precompiles provided to the EVM. The caller should
-// use the ValidatePrecompiles function for this purpose prior to calling WithPrecompiles.
-func (evm *EVM) WithPrecompiles(
-	precompiles map[common.Address]PrecompiledContract,
-	activePrecompiles []common.Address,
-) {
-	evm.precompiles = precompiles
-	evm.activePrecompiles = activePrecompiles
-}
-
 // ValidatePrecompiles validates the precompile map against the active
 // precompile slice.
 // It returns an error if the precompiled contract map has a different length
@@ -908,7 +889,7 @@ type bls12381G1Add struct{}
 // Address defines the precompiled contract address. This MUST match the address
 // set in the precompiled contract map.
 func (bls12381G1Add) Address() common.Address {
-	return common.BytesToAddress([]byte{10})
+	return common.BytesToAddress([]byte{11})
 }
 
 // RequiredGas returns the gas required to execute the pre-compiled contract.
@@ -1059,7 +1040,7 @@ type bls12381G2MultiExp struct{}
 // Address defines the precompiled contract address. This MUST match the address
 // set in the precompiled contract map.
 func (bls12381G2MultiExp) Address() common.Address {
-	return common.BytesToAddress([]byte{15})
+	return common.BytesToAddress([]byte{14})
 }
 
 // RequiredGas returns the gas required to execute the pre-compiled contract.
@@ -1125,7 +1106,7 @@ type bls12381Pairing struct{}
 // Address defines the precompiled contract address. This MUST match the address
 // set in the precompiled contract map.
 func (bls12381Pairing) Address() common.Address {
-	return common.BytesToAddress([]byte{16})
+	return common.BytesToAddress([]byte{15})
 }
 
 // RequiredGas returns the gas required to execute the pre-compiled contract.
@@ -1283,7 +1264,7 @@ type bls12381MapG1 struct{}
 // Address defines the precompiled contract address. This MUST match the address
 // set in the precompiled contract map.
 func (bls12381MapG1) Address() common.Address {
-	return common.BytesToAddress([]byte{17})
+	return common.BytesToAddress([]byte{16})
 }
 
 // RequiredGas returns the gas required to execute the pre-compiled contract.
@@ -1318,7 +1299,7 @@ type bls12381MapG2 struct{}
 // Address defines the precompiled contract address. This MUST match the address
 // set in the precompiled contract map.
 func (bls12381MapG2) Address() common.Address {
-	return common.BytesToAddress([]byte{18})
+	return common.BytesToAddress([]byte{17})
 }
 
 // RequiredGas returns the gas required to execute the pre-compiled contract.

core/vm/contracts_fuzz_test.go

@@ -20,6 +20,7 @@ import (
 	"testing"
 
 	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/params"
 )
 
 func FuzzPrecompiledContracts(f *testing.F) {
@@ -36,7 +37,8 @@ func FuzzPrecompiledContracts(f *testing.F) {
 			return
 		}
 		inWant := string(input)
-		runPrecompiledContract(nil, p, common.Address{}, input, gas, nil, false)
+		evm := NewEVM(BlockContext{}, nil, params.TestChainConfig, Config{})
+		runPrecompiledContract(evm, p, common.Address{}, input, gas, nil, false)
 		if inHave := string(input); inWant != inHave {
 			t.Errorf("Precompiled %v modified input data", a)
 		}

core/vm/contracts_test.go

@@ -25,6 +25,7 @@ import (
 	"time"
 
 	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/params"
 	"github.com/holiman/uint256"
 )
 
@@ -97,7 +98,8 @@ func testPrecompiled(addr string, test precompiledTest, t *testing.T) {
 	in := common.Hex2Bytes(test.Input)
 	gas := p.RequiredGas(in)
 	t.Run(fmt.Sprintf("%s-Gas=%d", test.Name, gas), func(t *testing.T) {
-		if res, _, err := runPrecompiledContract(nil, p, common.Address{}, in, gas, new(uint256.Int), false); err != nil {
+		evm := NewEVM(BlockContext{}, nil, params.TestChainConfig, Config{})
+		if res, _, err := runPrecompiledContract(evm, p, common.Address{}, in, gas, new(uint256.Int), false); err != nil {
 			t.Error(err)
 		} else if common.Bytes2Hex(res) != test.Expected {
 			t.Errorf("Expected %v, got %v", test.Expected, common.Bytes2Hex(res))
@@ -119,7 +121,8 @@ func testPrecompiledOOG(addr string, test precompiledTest, t *testing.T) {
 	gas := p.RequiredGas(in) - 1
 
 	t.Run(fmt.Sprintf("%s-Gas=%d", test.Name, gas), func(t *testing.T) {
-		_, _, err := runPrecompiledContract(nil, p, common.Address{}, in, gas, new(uint256.Int), false)
+		evm := NewEVM(BlockContext{}, nil, params.TestChainConfig, Config{})
+		_, _, err := runPrecompiledContract(evm, p, common.Address{}, in, gas, new(uint256.Int), false)
 		if err.Error() != "out of gas" {
 			t.Errorf("Expected error [out of gas], got [%v]", err)
 		}
@@ -136,7 +139,8 @@ func testPrecompiledFailure(addr string, test precompiledFailureTest, t *testing
 	in := common.Hex2Bytes(test.Input)
 	gas := p.RequiredGas(in)
 	t.Run(test.Name, func(t *testing.T) {
-		_, _, err := runPrecompiledContract(nil, p, common.Address{}, in, gas, new(uint256.Int), false)
+		evm := NewEVM(BlockContext{}, nil, params.TestChainConfig, Config{})
+		_, _, err := runPrecompiledContract(evm, p, common.Address{}, in, gas, new(uint256.Int), false)
 		if err.Error() != test.ExpectedError {
 			t.Errorf("Expected error [%v], got [%v]", test.ExpectedError, err)
 		}
@@ -166,9 +170,10 @@ func benchmarkPrecompiled(addr string, test precompiledTest, bench *testing.B) {
 		bench.ReportAllocs()
 		start := time.Now()
 		bench.ResetTimer()
+		evm := NewEVM(BlockContext{}, nil, params.TestChainConfig, Config{})
 		for i := 0; i < bench.N; i++ {
 			copy(data, in)
-			res, _, err = runPrecompiledContract(nil, p, common.Address{}, in, reqGas, new(uint256.Int), false)
+			res, _, err = runPrecompiledContract(evm, p, common.Address{}, in, reqGas, new(uint256.Int), false)
 		}
 		bench.StopTimer()
 		elapsed := uint64(time.Since(start))

core/vm/evm.go

@@ -115,14 +115,11 @@ type EVM struct {
 	callGasTemp uint64
 
 	// precompiles holds the precompiled contracts for the current epoch
-	precompiles map[common.Address]PrecompiledContract
+	precompiles PrecompiledContracts
 
 	// jumpDests is the aggregated result of JUMPDEST analysis made through
 	// the life cycle of EVM.
 	jumpDests map[common.Hash]bitvec
-
-	// activePrecompiles defines the precompiles that are currently active
-	activePrecompiles []common.Address
 }
 
 // NewEVM constructs an EVM instance with the supplied block context, state
@@ -138,8 +135,6 @@ func NewEVM(blockCtx BlockContext, statedb StateDB, chainConfig *params.ChainCon
 		chainRules:  chainConfig.Rules(blockCtx.BlockNumber, blockCtx.Random != nil, blockCtx.Time),
 		jumpDests:   make(map[common.Hash]bitvec),
 	}
-	// set the default precompiles
-	evm.activePrecompiles = DefaultActivePrecompiles(evm.chainRules)
 	evm.precompiles = DefaultPrecompiles(evm.chainRules)
 	evm.interpreter = NewEVMInterpreter(evm)
 
@@ -637,12 +632,11 @@ func (evm *EVM) captureEnd(depth int, startGas uint64, leftOverGas uint64, ret [
 // to the tracers.
 func (evm *EVM) GetVMContext() *tracing.VMContext {
 	return &tracing.VMContext{
-		Coinbase:          evm.Context.Coinbase,
-		BlockNumber:       evm.Context.BlockNumber,
-		Time:              evm.Context.Time,
-		Random:            evm.Context.Random,
-		BaseFee:           evm.Context.BaseFee,
-		StateDB:           evm.StateDB,
-		ActivePrecompiles: evm.activePrecompiles,
+		Coinbase:    evm.Context.Coinbase,
+		BlockNumber: evm.Context.BlockNumber,
+		Time:        evm.Context.Time,
+		Random:      evm.Context.Random,
+		BaseFee:     evm.Context.BaseFee,
+		StateDB:     evm.StateDB,
 	}
 }