aboutsummaryrefslogtreecommitdiffstats
path: root/core/vm/contract.go
blob: 5981dcca0d36b1e8f75475a22d7763f1d3760c88 (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
// Copyright 2014 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 vm

import (
    "math/big"

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

// ContractRef is a reference to the contract's backing object
type ContractRef interface {
    ReturnGas(*big.Int, *big.Int)
    Address() common.Address
    SetCode([]byte)
    EachStorage(cb func(key, value []byte))
}

// Contract represents an ethereum contract in the state database. It contains
// the the contract code, calling arguments. Contract implements ContractReg
type Contract struct {
    caller ContractRef
    self   ContractRef

    jumpdests destinations // result of JUMPDEST analysis.

    Code     []byte
    Input    []byte
    CodeAddr *common.Address

    value, Gas, UsedGas, Price *big.Int

    Args []byte
}

// Create a new context for the given data items.
func NewContract(caller ContractRef, object ContractRef, value, gas, price *big.Int) *Contract {
    c := &Contract{caller: caller, self: object, Args: nil}

    if parent, ok := caller.(*Contract); ok {
        // Reuse JUMPDEST analysis from parent context if available.
        c.jumpdests = parent.jumpdests
    } else {
        c.jumpdests = make(destinations)
    }

    // Gas should be a pointer so it can safely be reduced through the run
    // This pointer will be off the state transition
    c.Gas = gas //new(big.Int).Set(gas)
    c.value = new(big.Int).Set(value)
    // In most cases price and value are pointers to transaction objects
    // and we don't want the transaction's values to change.
    c.Price = new(big.Int).Set(price)
    c.UsedGas = new(big.Int)

    return c
}

// GetOp returns the n'th element in the contract's byte array
func (c *Contract) GetOp(n uint64) OpCode {
    return OpCode(c.GetByte(n))
}

// GetByte returns the n'th byte in the contract's byte array
func (c *Contract) GetByte(n uint64) byte {
    if n < uint64(len(c.Code)) {
        return c.Code[n]
    }

    return 0
}

// Return returns the given ret argument and returns any remaining gas to the
// caller
func (c *Contract) Return(ret []byte) []byte {
    // Return the remaining gas to the caller
    c.caller.ReturnGas(c.Gas, c.Price)

    return ret
}

// UseGas attempts the use gas and subtracts it and returns true on success
func (c *Contract) UseGas(gas *big.Int) (ok bool) {
    ok = useGas(c.Gas, gas)
    if ok {
        c.UsedGas.Add(c.UsedGas, gas)
    }
    return
}

// ReturnGas adds the given gas back to itself.
func (c *Contract) ReturnGas(gas, price *big.Int) {
    // Return the gas to the context
    c.Gas.Add(c.Gas, gas)
    c.UsedGas.Sub(c.UsedGas, gas)
}

// Address returns the contracts address
func (c *Contract) Address() common.Address {
    return c.self.Address()
}

// SetCode sets the code to the contract
func (self *Contract) SetCode(code []byte) {
    self.Code = code
}

// SetCallCode sets the code of the contract and address of the backing data
// object
func (self *Contract) SetCallCode(addr *common.Address, code []byte) {
    self.Code = code
    self.CodeAddr = addr
}

// EachStorage iterates the contract's storage and calls a method for every key
// value pair.
func (self *Contract) EachStorage(cb func(key, value []byte)) {
    self.caller.EachStorage(cb)
}