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: params.RulesHooks.ActivePrecompiles override #39

Merged
merged 1 commit into from
Sep 26, 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
5 changes: 4 additions & 1 deletion core/vm/contracts.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,10 @@ func init() {
}

// ActivePrecompiles returns the precompiles enabled with the current configuration.
func ActivePrecompiles(rules params.Rules) []common.Address {
func ActivePrecompiles(rules params.Rules) (active []common.Address) {
defer func() {
active = rules.Hooks().ActivePrecompiles(append([]common.Address{}, active...))
}()
switch {
case rules.IsCancun:
return PrecompiledAddressesCancun
Expand Down
22 changes: 22 additions & 0 deletions core/vm/contracts.libevm_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -423,3 +423,25 @@ func TestCanCreateContract(t *testing.T) {
})
}
}

func TestActivePrecompilesOverride(t *testing.T) {
newRules := func() params.Rules {
return new(params.ChainConfig).Rules(big.NewInt(0), false, 0)
}
defaultActive := vm.ActivePrecompiles(newRules())

rng := ethtest.NewPseudoRand(0xDecafC0ffeeBad)
precompiles := make([]common.Address, rng.Intn(10)+5)
for i := range precompiles {
precompiles[i] = rng.Address()
}
hooks := &hookstest.Stub{
ActivePrecompilesFn: func(active []common.Address) []common.Address {
assert.Equal(t, defaultActive, active, "ActivePrecompiles() hook receives default addresses")
return precompiles
},
}
hooks.Register(t)

require.Equal(t, precompiles, vm.ActivePrecompiles(newRules()), "vm.ActivePrecompiles() returns overridden addresses")
}
10 changes: 10 additions & 0 deletions libevm/hookstest/stub.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ type Stub struct {
CheckConfigCompatibleFn func(*params.ChainConfig, *big.Int, uint64) *params.ConfigCompatError
DescriptionSuffix string
PrecompileOverrides map[common.Address]libevm.PrecompiledContract
ActivePrecompilesFn func([]common.Address) []common.Address
CanExecuteTransactionFn func(common.Address, *common.Address, libevm.StateReader) error
CanCreateContractFn func(*libevm.AddressContext, uint64, libevm.StateReader) (uint64, error)
}
Expand All @@ -71,6 +72,15 @@ func (s Stub) PrecompileOverride(a common.Address) (libevm.PrecompiledContract,
return p, ok
}

// ActivePrecompiles proxies arguments to the s.ActivePrecompilesFn function if
// non-nil, otherwise it acts as a noop.
func (s Stub) ActivePrecompiles(active []common.Address) []common.Address {
if f := s.ActivePrecompilesFn; f != nil {
return f(active)
}
return active
}

// CheckConfigForkOrder proxies arguments to the s.CheckConfigForkOrderFn
// function if non-nil, otherwise it acts as a noop.
func (s Stub) CheckConfigForkOrder() error {
Expand Down
11 changes: 11 additions & 0 deletions params/hooks.libevm.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ type RulesHooks interface {
// [PrecompiledContract] is non-nil. If it returns `false` then the default
// precompile behaviour is honoured.
PrecompileOverride(common.Address) (_ libevm.PrecompiledContract, override bool)
// ActivePrecompiles receives the addresses that would usually be returned
// by a call to [vm.ActivePrecompiles] and MUST return the value to be
// returned by said function, which will be propagated. It MAY alter the
// received slice. The value it returns MUST be consistent with the
// behaviour of the PrecompileOverride hook.
ActivePrecompiles([]common.Address) []common.Address
}

// RulesAllowlistHooks are a subset of [RulesHooks] that gate actions, signalled
Expand Down Expand Up @@ -120,3 +126,8 @@ func (NOOPHooks) CanCreateContract(_ *libevm.AddressContext, gas uint64, _ libev
func (NOOPHooks) PrecompileOverride(common.Address) (libevm.PrecompiledContract, bool) {
return nil, false
}

// ActivePrecompiles echoes the active addresses unchanged.
func (NOOPHooks) ActivePrecompiles(active []common.Address) []common.Address {
return active
}