mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-21 06:04:33 +00:00
1bccf4f2dd
## Why this should be merged The `temporary.WithTempRegisteredExtras()` global lock introduced in #234 wasn't fit for purpose when used in `coreth` as it required central coordination of registration, types, and usage of the payload accessor. ## How this works Instead of a central registration point, the new `libevm.WithTemporaryExtrasLock()` function takes out a global lock and provides the caller with a handle that proves the lock is held. All of the override functions, e.g. `params.WithTempRegisteredExtras()` now require a current lock, which will be propagated by the respective `coreth` functions. See https://github.com/ava-labs/coreth/pull/1328 for intended usage in `coreth` and `subnet-evm`. A consumer of both of these can then safely do the following: ```go import ( "github.com/ava-labs/libevm/libevm" coreth "github.com/ava-labs/coreth/plugin/evm" subnet "github.com/ava-labs/subnet-evm/plugin/evm" ) // asCChain calls `fn` while emulating `coreth`. It is safe for concurrent usage with [asSubnetEVM]. func asCChain(fn func() error) error { return libevm.WithTemporaryExtrasLock(func(l libevm.ExtrasLock) error { return coreth.WithTempRegisteredLibEVMExtras(l, fn) }) } // asSubnetEVM calls `fn` while emulating `subnet-evm`. It is safe for concurrent usage with [asCChain]. func asSubnetEVM(fn func() error) error { return libevm.WithTemporaryExtrasLock(func(l libevm.ExtrasLock) error { return subnet.WithTempRegisteredLibEVMExtras(l, fn) }) } ``` ## How this was tested Unit test of the new function plus existing integration tests of all modified code.
110 lines
3.4 KiB
Go
110 lines
3.4 KiB
Go
// Copyright 2024-2025 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 (
|
|
"math/big"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/ava-labs/libevm/libevm"
|
|
"github.com/ava-labs/libevm/params"
|
|
)
|
|
|
|
type evmArgOverrider struct {
|
|
newEVMchainID int64
|
|
|
|
gotResetChainID *big.Int
|
|
resetTxContextTo TxContext
|
|
resetStateDBTo StateDB
|
|
}
|
|
|
|
func (o *evmArgOverrider) OverrideNewEVMArgs(args *NewEVMArgs) *NewEVMArgs {
|
|
args.ChainConfig = ¶ms.ChainConfig{ChainID: big.NewInt(o.newEVMchainID)}
|
|
return args
|
|
}
|
|
|
|
func (o *evmArgOverrider) OverrideEVMResetArgs(r params.Rules, _ *EVMResetArgs) *EVMResetArgs {
|
|
o.gotResetChainID = r.ChainID
|
|
return &EVMResetArgs{
|
|
TxContext: o.resetTxContextTo,
|
|
StateDB: o.resetStateDBTo,
|
|
}
|
|
}
|
|
|
|
func (o *evmArgOverrider) register(t *testing.T) {
|
|
t.Helper()
|
|
TestOnlyClearRegisteredHooks()
|
|
RegisterHooks(o)
|
|
t.Cleanup(TestOnlyClearRegisteredHooks)
|
|
}
|
|
|
|
func TestOverrideNewEVMArgs(t *testing.T) {
|
|
// The overrideNewEVMArgs function accepts and returns all arguments to
|
|
// NewEVM(), in order. Here we lock in our assumption of that order. If this
|
|
// breaks then all functionality overriding the args MUST be updated.
|
|
var _ func(BlockContext, TxContext, StateDB, *params.ChainConfig, Config) *EVM = NewEVM
|
|
|
|
const chainID = 13579
|
|
hooks := evmArgOverrider{newEVMchainID: chainID}
|
|
hooks.register(t)
|
|
|
|
assertChainID := func(t *testing.T, want int64) {
|
|
t.Helper()
|
|
evm := NewEVM(BlockContext{}, TxContext{}, nil, nil, Config{})
|
|
got := evm.ChainConfig().ChainID
|
|
require.Equalf(t, big.NewInt(want), got, "%T.ChainConfig().ChainID set by NewEVM() hook", evm)
|
|
}
|
|
assertChainID(t, chainID)
|
|
|
|
t.Run("WithTempRegisteredHooks", func(t *testing.T) {
|
|
err := libevm.WithTemporaryExtrasLock(func(lock libevm.ExtrasLock) error {
|
|
override := evmArgOverrider{newEVMchainID: 24680}
|
|
return WithTempRegisteredHooks(lock, &override, func() error {
|
|
assertChainID(t, override.newEVMchainID)
|
|
return nil
|
|
})
|
|
})
|
|
require.NoError(t, err)
|
|
t.Run("after", func(t *testing.T) {
|
|
assertChainID(t, chainID)
|
|
})
|
|
})
|
|
}
|
|
|
|
func TestOverrideEVMResetArgs(t *testing.T) {
|
|
// Equivalent to rationale for TestOverrideNewEVMArgs above.
|
|
var _ func(TxContext, StateDB) = (*EVM)(nil).Reset
|
|
|
|
const (
|
|
chainID = 0xc0ffee
|
|
gasPrice = 1357924680
|
|
)
|
|
hooks := &evmArgOverrider{
|
|
newEVMchainID: chainID,
|
|
resetTxContextTo: TxContext{
|
|
GasPrice: big.NewInt(gasPrice),
|
|
},
|
|
}
|
|
hooks.register(t)
|
|
|
|
evm := NewEVM(BlockContext{}, TxContext{}, nil, nil, Config{})
|
|
evm.Reset(TxContext{}, nil)
|
|
assert.Equalf(t, big.NewInt(chainID), hooks.gotResetChainID, "%T.ChainID passed to Reset() hook", params.Rules{})
|
|
assert.Equalf(t, big.NewInt(gasPrice), evm.GasPrice, "%T.GasPrice set by Reset() hook", evm)
|
|
}
|