[wip] decouple precompiles from core/vm #1320
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| // (c) 2024, Ava Labs, Inc. All rights reserved. | ||
| // See the file LICENSE for licensing terms. | ||
|
|
||
| package core | ||
|
|
||
| import ( | ||
| "github.com/ava-labs/avalanchego/snow" | ||
| "github.com/ava-labs/subnet-evm/constants" | ||
| "github.com/ava-labs/subnet-evm/core/vm" | ||
| "github.com/ava-labs/subnet-evm/params" | ||
| "github.com/ava-labs/subnet-evm/precompile/contract" | ||
| "github.com/ava-labs/subnet-evm/precompile/contracts/deployerallowlist" | ||
| "github.com/ava-labs/subnet-evm/precompile/modules" | ||
| "github.com/ava-labs/subnet-evm/precompile/precompileconfig" | ||
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/ethereum/go-ethereum/log" | ||
| ) | ||
|
|
||
| var defaultEVMFactory vm.EvmFactory | ||
|
|
||
| func init() { | ||
| defaultEVMFactory = vm.DefaultEVMFactory() | ||
| vm.SetDefaultEVMFactory(&evmFactory{}) | ||
| } | ||
|
|
||
| // IsProhibited returns true if [addr] is in the prohibited list of addresses which should | ||
| // not be allowed as an EOA or newly created contract address. | ||
| func IsProhibited(addr common.Address) bool { | ||
| if addr == constants.BlackholeAddr { | ||
| return true | ||
| } | ||
|
|
||
| return modules.ReservedAddress(addr) | ||
| } | ||
|
|
||
| type evmFactory struct{} | ||
|
|
||
| type EVM struct { | ||
| *vm.EVM | ||
|
|
||
| chainConfig *params.ChainConfig | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. It is needed to return it as a The purpose of this type is to keep our modifications of the EVM out of geth code, so we wrap all avalanche specific inputs and configurations and the geth code will try to call a generic callback to call precompiles instead (changing from |
||
| } | ||
|
|
||
| func (*evmFactory) NewEVM( | ||
| blockCtx vm.BlockContext, txCtx vm.TxContext, statedb vm.StateDB, | ||
| chainConfig vm.ChainConfig, config vm.Config, | ||
| ) *vm.EVM { | ||
| customChainConfig, ok := chainConfig.(*params.ChainConfig) | ||
| if !ok { | ||
|
There was a problem hiding this comment. In what circumstances would someone pass another type? There was a problem hiding this comment. In this PR it is not. But in the future it may be possible that geth / libevm code could use that, until the code is fully separated and there is no "bad imports" |
||
| // If the chainConfig is not a params.ChainConfig, then we can't use the custom | ||
| // EVM implementation, so we fall back to the default implementation. | ||
| log.Warn("ChainConfig is not a *params.ChainConfig, falling back to default EVM") | ||
|
There was a problem hiding this comment. Why does passing a non-geth type result in using the native geth implementation and vice versa? That seems back to front. There was a problem hiding this comment. Sorry if it was unclear, at the moment I do not consider When we are able to properly instantiate geth without these avalanche modifications with its own configuration, many of the merge conflicts (especially in tests) and nuanced test modifications will begin to disappear (we can replace any critical behavior checks with tests that instantiate an avalanche VM) |
||
| return defaultEVMFactory.NewEVM(blockCtx, txCtx, statedb, chainConfig, config) | ||
| } | ||
| evm := &EVM{ | ||
| chainConfig: customChainConfig, | ||
| } | ||
| config.IsProhibited = IsProhibited | ||
| config.DeployerAllowed = evm.DeployerAllowed | ||
| config.CustomPrecompiles = evm.CustomPrecompiles | ||
|
|
||
| evm.EVM = defaultEVMFactory.NewEVM(blockCtx, txCtx, statedb, chainConfig, config) | ||
| return evm.EVM | ||
| } | ||
|
|
||
| func (evm *EVM) GetBlockContext() contract.BlockContext { | ||
| return &evm.EVM.Context | ||
| } | ||
|
|
||
| func (evm *EVM) GetStateDB() contract.StateDB { | ||
| return evm.StateDB | ||
| } | ||
|
|
||
| func (evm *EVM) GetChainConfig() precompileconfig.ChainConfig { | ||
|
There was a problem hiding this comment. Why is this being returned as a My immediate thought, before inspecting the interface definition, was that it seems to be a non sequitur. We're in the Upon inspection I see that it only has There was a problem hiding this comment. It is already being returned as
Probably you looked at coreth, subnet-evm also includes Some precompiles already access parameters from |
||
| return evm.chainConfig | ||
| } | ||
|
|
||
| func (evm *EVM) GetSnowContext() *snow.Context { | ||
| return evm.chainConfig.SnowCtx | ||
| } | ||
|
|
||
| func (evm *EVM) DeployerAllowed(addr common.Address) bool { | ||
| rules := evm.chainConfig.Rules(evm.Context.BlockNumber, evm.Context.Time) | ||
| if rules.IsPrecompileEnabled(deployerallowlist.ContractAddress) { | ||
| allowListRole := deployerallowlist.GetContractDeployerAllowListStatus(evm.StateDB, evm.TxContext.Origin) | ||
| if !allowListRole.IsEnabled() { | ||
| return false | ||
| } | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| func (evm *EVM) CustomPrecompiles(addr common.Address) (vm.RunFunc, bool) { | ||
| rules := evm.chainConfig.Rules(evm.Context.BlockNumber, evm.Context.Time) | ||
| if _, ok := rules.ActivePrecompiles[addr]; !ok { | ||
| return nil, false | ||
| } | ||
| module, ok := modules.GetPrecompileModuleByAddress(addr) | ||
| if !ok { | ||
| return nil, false | ||
| } | ||
|
|
||
| return func( | ||
| caller common.Address, input []byte, suppliedGas uint64, readOnly bool, | ||
| ) (ret []byte, remainingGas uint64, err error) { | ||
| return module.Contract.Run(evm, caller, addr, input, suppliedGas, readOnly) | ||
| }, true | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -114,7 +114,7 @@ func enable1344(jt *JumpTable) { | |
|
|
||
| // opChainID implements CHAINID opcode | ||
| func opChainID(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) { | ||
| chainId, _ := uint256.FromBig(interpreter.evm.chainRules.ChainID) | ||
|
There was a problem hiding this comment. Why the change? Upstream uses There was a problem hiding this comment. this PR makes chainConfig an interface and we cannot reference a field on that. Open to other suggestions |
||
| scope.Stack.push(chainId) | ||
| return nil, nil | ||
| } | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why does this live in
coreinstead ofvm? Being here blurs any existing separation of concerns.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It cannot be in
core/vmsince the purpose is moving to a direction where avalanche packages are not imported in geth code.