mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-24 15:44:32 +00:00
35926db4d6
## Why this should be merged Registration of extras requires runtime enforcement of payload types. In production, only a single set of types can be registered and any attempts at re-registration will panic (by design). Although this makes production usage safe, it doesn't allow downstream consumers (e.g. data indexers) to use extras from different chains (e.g. `coreth` _and_ `subnet-evm`) at the same time. ## How this works 1. The `libevm/register.AtMostOnce` type can now be overridden temporarily. 2. `params`, `core/types`, `core/vm`, and `state` packages introduce `WithTempRegisteredExtras()` functions. 3. `libevm/temporary.WithRegisteredExtras()` provides "atomic" override of all extras. In all cases, the scope of the override is limited to the life of a single function call. ## How this was tested Relative to numbered list above: 1. Unit test of new and existing functionality. 2. Integration tests of both packages, demonstrating both payload and behavioural override.
95 lines
3.3 KiB
Go
95 lines
3.3 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 (
|
|
"github.com/ava-labs/libevm/libevm/register"
|
|
"github.com/ava-labs/libevm/params"
|
|
)
|
|
|
|
// RegisterHooks registers the Hooks. It is expected to be called in an `init()`
|
|
// function and MUST NOT be called more than once.
|
|
func RegisterHooks(h Hooks) {
|
|
libevmHooks.MustRegister(h)
|
|
}
|
|
|
|
// WithTempRegisteredHooks temporarily registers `h` as if calling
|
|
// [RegisterHooks] the same type parameter. After `fn` returns, the registration
|
|
// is returned to its former state, be that none or the types originally passed
|
|
// to [RegisterHooks].
|
|
//
|
|
// This MUST NOT be used on a live chain. It is solely intended for off-chain
|
|
// consumers that require access to extras. Said consumers SHOULD NOT, however
|
|
// call this function directly. Use the libevm/temporary.WithRegisteredExtras()
|
|
// function instead as it atomically overrides all possible packages.
|
|
func WithTempRegisteredHooks(h Hooks, fn func()) {
|
|
libevmHooks.TempOverride(h, fn)
|
|
}
|
|
|
|
// TestOnlyClearRegisteredHooks clears the [Hooks] previously passed to
|
|
// [RegisterHooks]. It panics if called from a non-testing call stack.
|
|
func TestOnlyClearRegisteredHooks() {
|
|
libevmHooks.TestOnlyClear()
|
|
}
|
|
|
|
var libevmHooks register.AtMostOnce[Hooks]
|
|
|
|
// Hooks are arbitrary configuration functions to modify default VM behaviour.
|
|
// See [RegisterHooks].
|
|
type Hooks interface {
|
|
OverrideNewEVMArgs(*NewEVMArgs) *NewEVMArgs
|
|
OverrideEVMResetArgs(params.Rules, *EVMResetArgs) *EVMResetArgs
|
|
}
|
|
|
|
// NewEVMArgs are the arguments received by [NewEVM], available for override
|
|
// via [Hooks].
|
|
type NewEVMArgs struct {
|
|
BlockContext BlockContext
|
|
TxContext TxContext
|
|
StateDB StateDB
|
|
ChainConfig *params.ChainConfig
|
|
Config Config
|
|
}
|
|
|
|
// EVMResetArgs are the arguments received by [EVM.Reset], available for
|
|
// override via [Hooks].
|
|
type EVMResetArgs struct {
|
|
TxContext TxContext
|
|
StateDB StateDB
|
|
}
|
|
|
|
func overrideNewEVMArgs(
|
|
blockCtx BlockContext,
|
|
txCtx TxContext,
|
|
statedb StateDB,
|
|
chainConfig *params.ChainConfig,
|
|
config Config,
|
|
) (BlockContext, TxContext, StateDB, *params.ChainConfig, Config) {
|
|
if !libevmHooks.Registered() {
|
|
return blockCtx, txCtx, statedb, chainConfig, config
|
|
}
|
|
args := libevmHooks.Get().OverrideNewEVMArgs(&NewEVMArgs{blockCtx, txCtx, statedb, chainConfig, config})
|
|
return args.BlockContext, args.TxContext, args.StateDB, args.ChainConfig, args.Config
|
|
}
|
|
|
|
func (evm *EVM) overrideEVMResetArgs(txCtx TxContext, statedb StateDB) (TxContext, StateDB) {
|
|
if !libevmHooks.Registered() {
|
|
return txCtx, statedb
|
|
}
|
|
args := libevmHooks.Get().OverrideEVMResetArgs(evm.chainRules, &EVMResetArgs{txCtx, statedb})
|
|
return args.TxContext, args.StateDB
|
|
}
|