github.hscsec.cn/scroll-tech/go-ethereum@v1.9.7/core/vm/runtime/runtime.go (about)

     1  // Copyright 2015 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package runtime
    18  
    19  import (
    20  	"math"
    21  	"math/big"
    22  	"time"
    23  
    24  	"github.com/ethereum/go-ethereum/common"
    25  	"github.com/ethereum/go-ethereum/core/rawdb"
    26  	"github.com/ethereum/go-ethereum/core/state"
    27  	"github.com/ethereum/go-ethereum/core/vm"
    28  	"github.com/ethereum/go-ethereum/crypto"
    29  	"github.com/ethereum/go-ethereum/params"
    30  )
    31  
    32  // Config is a basic type specifying certain configuration flags for running
    33  // the EVM.
    34  type Config struct {
    35  	ChainConfig *params.ChainConfig
    36  	Difficulty  *big.Int
    37  	Origin      common.Address
    38  	Coinbase    common.Address
    39  	BlockNumber *big.Int
    40  	Time        *big.Int
    41  	GasLimit    uint64
    42  	GasPrice    *big.Int
    43  	Value       *big.Int
    44  	Debug       bool
    45  	EVMConfig   vm.Config
    46  
    47  	State     *state.StateDB
    48  	GetHashFn func(n uint64) common.Hash
    49  }
    50  
    51  // sets defaults on the config
    52  func setDefaults(cfg *Config) {
    53  	if cfg.ChainConfig == nil {
    54  		cfg.ChainConfig = &params.ChainConfig{
    55  			ChainID:        big.NewInt(1),
    56  			HomesteadBlock: new(big.Int),
    57  			DAOForkBlock:   new(big.Int),
    58  			DAOForkSupport: false,
    59  			EIP150Block:    new(big.Int),
    60  			EIP155Block:    new(big.Int),
    61  			EIP158Block:    new(big.Int),
    62  		}
    63  	}
    64  
    65  	if cfg.Difficulty == nil {
    66  		cfg.Difficulty = new(big.Int)
    67  	}
    68  	if cfg.Time == nil {
    69  		cfg.Time = big.NewInt(time.Now().Unix())
    70  	}
    71  	if cfg.GasLimit == 0 {
    72  		cfg.GasLimit = math.MaxUint64
    73  	}
    74  	if cfg.GasPrice == nil {
    75  		cfg.GasPrice = new(big.Int)
    76  	}
    77  	if cfg.Value == nil {
    78  		cfg.Value = new(big.Int)
    79  	}
    80  	if cfg.BlockNumber == nil {
    81  		cfg.BlockNumber = new(big.Int)
    82  	}
    83  	if cfg.GetHashFn == nil {
    84  		cfg.GetHashFn = func(n uint64) common.Hash {
    85  			return common.BytesToHash(crypto.Keccak256([]byte(new(big.Int).SetUint64(n).String())))
    86  		}
    87  	}
    88  }
    89  
    90  // Execute executes the code using the input as call data during the execution.
    91  // It returns the EVM's return value, the new state and an error if it failed.
    92  //
    93  // Executes sets up a in memory, temporarily, environment for the execution of
    94  // the given code. It makes sure that it's restored to it's original state afterwards.
    95  func Execute(code, input []byte, cfg *Config) ([]byte, *state.StateDB, error) {
    96  	if cfg == nil {
    97  		cfg = new(Config)
    98  	}
    99  	setDefaults(cfg)
   100  
   101  	if cfg.State == nil {
   102  		cfg.State, _ = state.New(common.Hash{}, state.NewDatabase(rawdb.NewMemoryDatabase()))
   103  	}
   104  	var (
   105  		address = common.BytesToAddress([]byte("contract"))
   106  		vmenv   = NewEnv(cfg)
   107  		sender  = vm.AccountRef(cfg.Origin)
   108  	)
   109  	cfg.State.CreateAccount(address)
   110  	// set the receiver's (the executing contract) code for execution.
   111  	cfg.State.SetCode(address, code)
   112  	// Call the code with the given configuration.
   113  	ret, _, err := vmenv.Call(
   114  		sender,
   115  		common.BytesToAddress([]byte("contract")),
   116  		input,
   117  		cfg.GasLimit,
   118  		cfg.Value,
   119  	)
   120  
   121  	return ret, cfg.State, err
   122  }
   123  
   124  // Create executes the code using the EVM create method
   125  func Create(input []byte, cfg *Config) ([]byte, common.Address, uint64, error) {
   126  	if cfg == nil {
   127  		cfg = new(Config)
   128  	}
   129  	setDefaults(cfg)
   130  
   131  	if cfg.State == nil {
   132  		cfg.State, _ = state.New(common.Hash{}, state.NewDatabase(rawdb.NewMemoryDatabase()))
   133  	}
   134  	var (
   135  		vmenv  = NewEnv(cfg)
   136  		sender = vm.AccountRef(cfg.Origin)
   137  	)
   138  
   139  	// Call the code with the given configuration.
   140  	code, address, leftOverGas, err := vmenv.Create(
   141  		sender,
   142  		input,
   143  		cfg.GasLimit,
   144  		cfg.Value,
   145  	)
   146  	return code, address, leftOverGas, err
   147  }
   148  
   149  // Call executes the code given by the contract's address. It will return the
   150  // EVM's return value or an error if it failed.
   151  //
   152  // Call, unlike Execute, requires a config and also requires the State field to
   153  // be set.
   154  func Call(address common.Address, input []byte, cfg *Config) ([]byte, uint64, error) {
   155  	setDefaults(cfg)
   156  
   157  	vmenv := NewEnv(cfg)
   158  
   159  	sender := cfg.State.GetOrNewStateObject(cfg.Origin)
   160  	// Call the code with the given configuration.
   161  	ret, leftOverGas, err := vmenv.Call(
   162  		sender,
   163  		address,
   164  		input,
   165  		cfg.GasLimit,
   166  		cfg.Value,
   167  	)
   168  
   169  	return ret, leftOverGas, err
   170  }