aboutsummaryrefslogtreecommitdiffstats
path: root/core/vm/runtime/runtime.go
blob: 309d508c3d6d4babb7ffa48ceee722c5c856ce96 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
// Copyright 2015 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it 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 go-ethereum library is distributed in the hope that it 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 runtime

import (
    "math/big"
    "time"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/core/state"
    "github.com/ethereum/go-ethereum/core/vm"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/ethdb"
)

// The default, always homestead, rule set for the vm env
type ruleSet struct{}

func (ruleSet) IsHomestead(*big.Int) bool { return true }

// Config is a basic type specifying certain configuration flags for running
// the EVM.
type Config struct {
    RuleSet     vm.RuleSet
    Difficulty  *big.Int
    Origin      common.Address
    Coinbase    common.Address
    BlockNumber *big.Int
    Time        *big.Int
    GasLimit    *big.Int
    GasPrice    *big.Int
    Value       *big.Int
    DisableJit  bool // "disable" so it's enabled by default
    Debug       bool

    State     *state.StateDB
    GetHashFn func(n uint64) common.Hash
}

// sets defaults on the config
func setDefaults(cfg *Config) {
    if cfg.RuleSet == nil {
        cfg.RuleSet = ruleSet{}
    }

    if cfg.Difficulty == nil {
        cfg.Difficulty = new(big.Int)
    }
    if cfg.Time == nil {
        cfg.Time = big.NewInt(time.Now().Unix())
    }
    if cfg.GasLimit == nil {
        cfg.GasLimit = new(big.Int).Set(common.MaxBig)
    }
    if cfg.GasPrice == nil {
        cfg.GasPrice = new(big.Int)
    }
    if cfg.Value == nil {
        cfg.Value = new(big.Int)
    }
    if cfg.BlockNumber == nil {
        cfg.BlockNumber = new(big.Int)
    }
    if cfg.GetHashFn == nil {
        cfg.GetHashFn = func(n uint64) common.Hash {
            return common.BytesToHash(crypto.Keccak256([]byte(new(big.Int).SetUint64(n).String())))
        }
    }
}

// Execute executes the code using the input as call data during the execution.
// It returns the EVM's return value, the new state and an error if it failed.
//
// Executes sets up a in memory, temporarily, environment for the execution of
// the given code. It enabled the JIT by default and make sure that it's restored
// to it's original state afterwards.
func Execute(code, input []byte, cfg *Config) ([]byte, *state.StateDB, error) {
    if cfg == nil {
        cfg = new(Config)
    }
    setDefaults(cfg)

    if cfg.State == nil {
        db, _ := ethdb.NewMemDatabase()
        cfg.State, _ = state.New(common.Hash{}, db)
    }
    var (
        vmenv    = NewEnv(cfg, cfg.State)
        sender   = cfg.State.CreateAccount(cfg.Origin)
        receiver = cfg.State.CreateAccount(common.StringToAddress("contract"))
    )
    // set the receiver's (the executing contract) code for execution.
    receiver.SetCode(code)

    // Call the code with the given configuration.
    ret, err := vmenv.Call(
        sender,
        receiver.Address(),
        input,
        cfg.GasLimit,
        cfg.GasPrice,
        cfg.Value,
    )

    return ret, cfg.State, err
}

// Call executes the code given by the contract's address. It will return the
// EVM's return value or an error if it failed.
//
// Call, unlike Execute, requires a config and also requires the State field to
// be set.
func Call(address common.Address, input []byte, cfg *Config) ([]byte, error) {
    setDefaults(cfg)

    vmenv := NewEnv(cfg, cfg.State)

    sender := cfg.State.GetOrNewStateObject(cfg.Origin)
    // Call the code with the given configuration.
    ret, err := vmenv.Call(
        sender,
        address,
        input,
        cfg.GasLimit,
        cfg.GasPrice,
        cfg.Value,
    )

    return ret, err
}