Merge branch 'libevm' into arr4n/jumptable-override

Author: ARR4N

.golangci.yml

@@ -16,6 +16,7 @@ linters:
     - gci
     - gocheckcompilerdirectives
     - gofmt
+    - goheader
     - goimports
     - gomodguard
     - gosec
@@ -53,6 +54,10 @@ linters-settings:
       - alias
       - dot
       - blank
+  goheader:
+    values:
+    template-path: .libevm-header
+
   gomodguard:
     blocked:
       modules:
@@ -78,6 +83,7 @@ issues:
         - errcheck
         - gci
         - gofmt
+        - goheader
         - gosec
         - gosimple
         - govet
@@ -92,6 +98,7 @@ issues:
         - testifylint
         - thelper
         - tparallel
+        - typecheck
         - usestdlibvars
         - varnamelen
         - wastedassign

.libevm-header

@@ -0,0 +1,15 @@
+Copyright {{ MOD-YEAR }} the libevm authors.
+
+The libevm additions to go-ethereum are free software: you can redistribute
+them and/or modify them 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 libevm additions are distributed in the hope that they 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/>.

README.md

@@ -356,3 +356,9 @@ also included in our repository in the `COPYING.LESSER` file.
 The go-ethereum binaries (i.e. all code inside of the `cmd` directory) are licensed under the
 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also
 included in our repository in the `COPYING` file.
+
+The libevm (i) _additions_ to the go-ethereum library (i.e. all code in files with `libevm` in their full path,
+be it a directory or file name); and (ii) _modifications_ to existing go-ethereum code; are licensed under the
+[GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html),
+also included in our repository in the `COPYING.LESSER` file. A comprehensive outline of _modifications_ is
+produced by the [libevm delta workflow](https://github.com/ava-labs/go-ethereum/actions/workflows/libevm-delta.yml).

core/state_transition.libevm.go

@@ -1,3 +1,18 @@
+// Copyright 2024 the libevm authors.
+//
+// The libevm additions to go-ethereum are free software: you can redistribute
+// them and/or modify them 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 libevm additions are distributed in the hope that they 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 core
 
 // canExecuteTransaction is a convenience wrapper for calling the

core/state_transition.libevm_test.go

@@ -1,3 +1,18 @@
+// Copyright 2024 the libevm authors.
+//
+// The libevm additions to go-ethereum are free software: you can redistribute
+// them and/or modify them 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 libevm additions are distributed in the hope that they 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 core_test
 
 import (

core/vm/contracts.libevm.go

@@ -1,3 +1,19 @@
+// Copyright 2024 the libevm authors.
+//
+// The libevm additions to go-ethereum are free software: you can redistribute
+// them and/or modify them 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 libevm additions are distributed in the hope that they 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 vm
 
 import (

core/vm/contracts.libevm_test.go

@@ -1,3 +1,18 @@
+// Copyright 2024 the libevm authors.
+//
+// The libevm additions to go-ethereum are free software: you can redistribute
+// them and/or modify them 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 libevm additions are distributed in the hope that they 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 vm_test
 
 import (

core/vm/evm.go

@@ -159,8 +159,7 @@ func NewEVM(blockCtx BlockContext, txCtx TxContext, statedb StateDB, chainConfig
 // Reset resets the EVM with a new transaction context.Reset
 // This is not threadsafe and should only be done very cautiously.
 func (evm *EVM) Reset(txCtx TxContext, statedb StateDB) {
-	evm.TxContext = txCtx
-	evm.StateDB = statedb
+	evm.TxContext, evm.StateDB = overrideEVMResetArgs(txCtx, statedb)
 }
 
 // Cancel cancels any running EVM operation. This may be called concurrently and

core/vm/evm.libevm_test.go

@@ -1,3 +1,18 @@
+// Copyright 2024 the libevm authors.
+//
+// The libevm additions to go-ethereum are free software: you can redistribute
+// them and/or modify them 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 libevm additions are distributed in the hope that they 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 vm
 
 import (
@@ -9,16 +24,35 @@ import (
 	"github.com/ethereum/go-ethereum/params"
 )
 
-type chainIDOverrider struct {
-	chainID int64
+type evmArgOverrider struct {
+	newEVMchainID int64
+
+	resetTxCtx   TxContext
+	resetStateDB StateDB
 }
 
-func (o chainIDOverrider) OverrideNewEVMArgs(args *NewEVMArgs) *NewEVMArgs {
-	args.ChainConfig = &params.ChainConfig{ChainID: big.NewInt(o.chainID)}
+func (o evmArgOverrider) OverrideNewEVMArgs(args *NewEVMArgs) *NewEVMArgs {
+	args.ChainConfig = &params.ChainConfig{ChainID: big.NewInt(o.newEVMchainID)}
 	return args
 }
 
-func (chainIDOverrider) OverrideJumpTable(_ params.Rules, jt *JumpTable) *JumpTable { return jt }
+func (evmArgOverrider) OverrideJumpTable(_ params.Rules, jt *JumpTable) *JumpTable { return jt }
+
+func (o evmArgOverrider) OverrideEVMResetArgs(*EVMResetArgs) *EVMResetArgs {
+	return &EVMResetArgs{
+		TxContext: o.resetTxCtx,
+		StateDB:   o.resetStateDB,
+	}
+}
+
+func (o evmArgOverrider) register(t *testing.T) {
+	t.Helper()
+	libevmHooks = nil
+	RegisterHooks(o)
+	t.Cleanup(func() {
+		libevmHooks = nil
+	})
+}
 
 func TestOverrideNewEVMArgs(t *testing.T) {
 	// The overrideNewEVMArgs function accepts and returns all arguments to
@@ -27,10 +61,27 @@ func TestOverrideNewEVMArgs(t *testing.T) {
 	var _ func(BlockContext, TxContext, StateDB, *params.ChainConfig, Config) *EVM = NewEVM
 
 	const chainID = 13579
-	libevmHooks = nil
-	RegisterHooks(chainIDOverrider{chainID: chainID})
-	defer func() { libevmHooks = nil }()
+	hooks := evmArgOverrider{newEVMchainID: chainID}
+	hooks.register(t)
+
+	evm := NewEVM(BlockContext{}, TxContext{}, nil, nil, Config{})
+	got := evm.ChainConfig().ChainID
+	require.Equalf(t, big.NewInt(chainID), got, "%T.ChainConfig().ChainID set by NewEVM() hook", evm)
+}
+
+func TestOverrideEVMResetArgs(t *testing.T) {
+	// Equivalent to rationale for TestOverrideNewEVMArgs above.
+	var _ func(TxContext, StateDB) = (*EVM)(nil).Reset
+
+	const gasPrice = 1357924680
+	hooks := evmArgOverrider{
+		resetTxCtx: TxContext{
+			GasPrice: big.NewInt(gasPrice),
+		},
+	}
+	hooks.register(t)
 
-	got := NewEVM(BlockContext{}, TxContext{}, nil, nil, Config{}).ChainConfig().ChainID
-	require.Equal(t, big.NewInt(chainID), got)
+	evm := NewEVM(BlockContext{}, TxContext{}, nil, nil, Config{})
+	evm.Reset(TxContext{}, nil)
+	require.Equalf(t, big.NewInt(gasPrice), evm.GasPrice, "%T.GasPrice set by Reset() hook", evm)
 }

core/vm/hooks.libevm.go

@@ -1,3 +1,19 @@
+// Copyright 2024 the libevm authors.
+//
+// The libevm additions to go-ethereum are free software: you can redistribute
+// them and/or modify them 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 libevm additions are distributed in the hope that they 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 vm
 
 import "github.com/ethereum/go-ethereum/params"
@@ -14,12 +30,15 @@ func RegisterHooks(h Hooks) {
 var libevmHooks Hooks
 
 // Hooks are arbitrary configuration functions to modify default VM behaviour.
+// See [RegisterHooks].
 type Hooks interface {
 	OverrideNewEVMArgs(*NewEVMArgs) *NewEVMArgs
+	OverrideEVMResetArgs(*EVMResetArgs) *EVMResetArgs
 	OverrideJumpTable(params.Rules, *JumpTable) *JumpTable
 }
 
-// NewEVMArgs are the arguments received by [NewEVM], available for override.
+// NewEVMArgs are the arguments received by [NewEVM], available for override
+// via [Hooks].
 type NewEVMArgs struct {
 	BlockContext BlockContext
 	TxContext    TxContext
@@ -28,11 +47,11 @@ type NewEVMArgs struct {
 	Config       Config
 }
 
-func overrideJumpTable(r params.Rules, jt *JumpTable) *JumpTable {
-	if libevmHooks == nil {
-		return jt
-	}
-	return libevmHooks.OverrideJumpTable(r, jt)
+// EVMResetArgs are the arguments received by [EVM.Reset], available for
+// override via [Hooks].
+type EVMResetArgs struct {
+	TxContext TxContext
+	StateDB   StateDB
 }
 
 func overrideNewEVMArgs(
@@ -48,3 +67,18 @@ func overrideNewEVMArgs(
 	args := libevmHooks.OverrideNewEVMArgs(&NewEVMArgs{blockCtx, txCtx, statedb, chainConfig, config})
 	return args.BlockContext, args.TxContext, args.StateDB, args.ChainConfig, args.Config
 }
+
+func overrideEVMResetArgs(txCtx TxContext, statedb StateDB) (TxContext, StateDB) {
+	if libevmHooks == nil {
+		return txCtx, statedb
+	}
+	args := libevmHooks.OverrideEVMResetArgs(&EVMResetArgs{txCtx, statedb})
+	return args.TxContext, args.StateDB
+}
+
+func overrideJumpTable(r params.Rules, jt *JumpTable) *JumpTable {
+	if libevmHooks == nil {
+		return jt
+	}
+	return libevmHooks.OverrideJumpTable(r, jt)
+}