Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: override vm.NewEVM() args #35

Merged
merged 5 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions core/vm/evm.go
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ func NewEVM(blockCtx BlockContext, txCtx TxContext, statedb StateDB, chainConfig
blockCtx.BlobBaseFee = new(big.Int)
}
}
blockCtx, txCtx, statedb, chainConfig, config = overrideNewEVMArgs(blockCtx, txCtx, statedb, chainConfig, config)
evm := &EVM{
Context: blockCtx,
TxContext: txCtx,
Expand Down
34 changes: 34 additions & 0 deletions core/vm/evm.libevm_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package vm

import (
"math/big"
"testing"

"github.com/stretchr/testify/require"

"github.com/ethereum/go-ethereum/params"
)

type chainIDOverrider struct {
chainID int64
}

func (o chainIDOverrider) OverrideNewEVMArgs(args *NewEVMArgs) *NewEVMArgs {
args.ChainConfig = &params.ChainConfig{ChainID: big.NewInt(o.chainID)}
return args
}

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
libevmHooks = nil
RegisterHooks(chainIDOverrider{chainID: chainID})
defer func() { libevmHooks = nil }()

got := NewEVM(BlockContext{}, TxContext{}, nil, nil, Config{}).ChainConfig().ChainID
require.Equal(t, big.NewInt(chainID), got)
}
42 changes: 42 additions & 0 deletions core/vm/hooks.libevm.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
package vm

import "github.com/ethereum/go-ethereum/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) {
if libevmHooks != nil {
panic("already registered")
}
libevmHooks = h
}

var libevmHooks Hooks

// Hooks are arbitrary configuration functions to modify default VM behaviour.
type Hooks interface {
OverrideNewEVMArgs(*NewEVMArgs) *NewEVMArgs
}

// NewEVMArgs are the arguments received by [NewEVM], available for override.
type NewEVMArgs struct {
BlockContext BlockContext
TxContext TxContext
StateDB StateDB
ChainConfig *params.ChainConfig
Config Config
}

func overrideNewEVMArgs(
blockCtx BlockContext,
txCtx TxContext,
statedb StateDB,
chainConfig *params.ChainConfig,
config Config,
) (BlockContext, TxContext, StateDB, *params.ChainConfig, Config) {
if libevmHooks == nil {
return blockCtx, txCtx, statedb, chainConfig, config
}
args := libevmHooks.OverrideNewEVMArgs(&NewEVMArgs{blockCtx, txCtx, statedb, chainConfig, config})
return args.BlockContext, args.TxContext, args.StateDB, args.ChainConfig, args.Config
}