aboutsummaryrefslogtreecommitdiffstats
path: root/core/state/state_object.go
blob: 353f2357b2b217658687f22c4b31e98d857c7ad2 (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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
// 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 state

import (
    "bytes"
    "fmt"
    "math/big"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/ethdb"
    "github.com/ethereum/go-ethereum/logger"
    "github.com/ethereum/go-ethereum/logger/glog"
    "github.com/ethereum/go-ethereum/rlp"
    "github.com/ethereum/go-ethereum/trie"
)

type Code []byte

func (self Code) String() string {
    return string(self) //strings.Join(Disassemble(self), " ")
}

type Storage map[string]common.Hash

func (self Storage) String() (str string) {
    for key, value := range self {
        str += fmt.Sprintf("%X : %X\n", key, value)
    }

    return
}

func (self Storage) Copy() Storage {
    cpy := make(Storage)
    for key, value := range self {
        cpy[key] = value
    }

    return cpy
}

type StateObject struct {
    // State database for storing state changes
    db   ethdb.Database
    trie *trie.SecureTrie

    // Address belonging to this account
    address common.Address
    // The balance of the account
    balance *big.Int
    // The nonce of the account
    nonce uint64
    // The code hash if code is present (i.e. a contract)
    codeHash []byte
    // The code for this account
    code Code
    // Temporarily initialisation code
    initCode Code
    // Cached storage (flushed when updated)
    storage Storage

    // Total gas pool is the total amount of gas currently
    // left if this object is the coinbase. Gas is directly
    // purchased of the coinbase.
    gasPool *big.Int

    // Mark for deletion
    // When an object is marked for deletion it will be delete from the trie
    // during the "update" phase of the state transition
    remove  bool
    deleted bool
    dirty   bool
}

func NewStateObject(address common.Address, db ethdb.Database) *StateObject {
    object := &StateObject{db: db, address: address, balance: new(big.Int), gasPool: new(big.Int), dirty: true}
    object.trie = trie.NewSecure((common.Hash{}).Bytes(), db)
    object.storage = make(Storage)
    object.gasPool = new(big.Int)

    return object
}

func NewStateObjectFromBytes(address common.Address, data []byte, db ethdb.Database) *StateObject {
    // TODO clean me up
    var extobject struct {
        Nonce    uint64
        Balance  *big.Int
        Root     common.Hash
        CodeHash []byte
    }
    err := rlp.Decode(bytes.NewReader(data), &extobject)
    if err != nil {
        fmt.Println(err)
        return nil
    }

    object := &StateObject{address: address, db: db}
    object.nonce = extobject.Nonce
    object.balance = extobject.Balance
    object.codeHash = extobject.CodeHash
    object.trie = trie.NewSecure(extobject.Root[:], db)
    object.storage = make(map[string]common.Hash)
    object.gasPool = new(big.Int)
    object.code, _ = db.Get(extobject.CodeHash)

    return object
}

func (self *StateObject) MarkForDeletion() {
    self.remove = true
    self.dirty = true

    if glog.V(logger.Core) {
        glog.Infof("%x: #%d %v X\n", self.Address(), self.nonce, self.balance)
    }
}

func (c *StateObject) getAddr(addr common.Hash) common.Hash {
    var ret []byte
    rlp.DecodeBytes(c.trie.Get(addr[:]), &ret)
    return common.BytesToHash(ret)
}

func (c *StateObject) setAddr(addr []byte, value common.Hash) {
    v, err := rlp.EncodeToBytes(bytes.TrimLeft(value[:], "\x00"))
    if err != nil {
        // if RLPing failed we better panic and not fail silently. This would be considered a consensus issue
        panic(err)
    }
    c.trie.Update(addr, v)
}

func (self *StateObject) Storage() Storage {
    return self.storage
}

func (self *StateObject) GetState(key common.Hash) common.Hash {
    strkey := key.Str()
    value, exists := self.storage[strkey]
    if !exists {
        value = self.getAddr(key)
        if (value != common.Hash{}) {
            self.storage[strkey] = value
        }
    }

    return value
}

func (self *StateObject) SetState(k, value common.Hash) {
    self.storage[k.Str()] = value
    self.dirty = true
}

// Update updates the current cached storage to the trie
func (self *StateObject) Update() {
    for key, value := range self.storage {
        if (value == common.Hash{}) {
            self.trie.Delete([]byte(key))
            continue
        }

        self.setAddr([]byte(key), value)
    }
}

func (c *StateObject) AddBalance(amount *big.Int) {
    c.SetBalance(new(big.Int).Add(c.balance, amount))

    if glog.V(logger.Core) {
        glog.Infof("%x: #%d %v (+ %v)\n", c.Address(), c.nonce, c.balance, amount)
    }
}

func (c *StateObject) SubBalance(amount *big.Int) {
    c.SetBalance(new(big.Int).Sub(c.balance, amount))

    if glog.V(logger.Core) {
        glog.Infof("%x: #%d %v (- %v)\n", c.Address(), c.nonce, c.balance, amount)
    }
}

func (c *StateObject) SetBalance(amount *big.Int) {
    c.balance = amount
    c.dirty = true
}

func (c *StateObject) St() Storage {
    return c.storage
}

//
// Gas setters and getters
//

// Return the gas back to the origin. Used by the Virtual machine or Closures
func (c *StateObject) ReturnGas(gas, price *big.Int) {}

func (self *StateObject) SetGasLimit(gasLimit *big.Int) {
    self.gasPool = new(big.Int).Set(gasLimit)

    if glog.V(logger.Core) {
        glog.Infof("%x: gas (+ %v)", self.Address(), self.gasPool)
    }
}

func (self *StateObject) SubGas(gas, price *big.Int) error {
    if self.gasPool.Cmp(gas) < 0 {
        return GasLimitError(self.gasPool, gas)
    }

    self.gasPool.Sub(self.gasPool, gas)

    rGas := new(big.Int).Set(gas)
    rGas.Mul(rGas, price)

    self.dirty = true

    return nil
}

func (self *StateObject) AddGas(gas, price *big.Int) {
    self.gasPool.Add(self.gasPool, gas)
}

func (self *StateObject) Copy() *StateObject {
    stateObject := NewStateObject(self.Address(), self.db)
    stateObject.balance.Set(self.balance)
    stateObject.codeHash = common.CopyBytes(self.codeHash)
    stateObject.nonce = self.nonce
    stateObject.trie = self.trie
    stateObject.code = common.CopyBytes(self.code)
    stateObject.initCode = common.CopyBytes(self.initCode)
    stateObject.storage = self.storage.Copy()
    stateObject.gasPool.Set(self.gasPool)
    stateObject.remove = self.remove
    stateObject.dirty = self.dirty
    stateObject.deleted = self.deleted

    return stateObject
}

//
// Attribute accessors
//

func (self *StateObject) Balance() *big.Int {
    return self.balance
}

// Returns the address of the contract/account
func (c *StateObject) Address() common.Address {
    return c.address
}

func (self *StateObject) Trie() *trie.SecureTrie {
    return self.trie
}

func (self *StateObject) Root() []byte {
    return self.trie.Root()
}

func (self *StateObject) Code() []byte {
    return self.code
}

func (self *StateObject) SetCode(code []byte) {
    self.code = code
    self.dirty = true
}

func (self *StateObject) SetNonce(nonce uint64) {
    self.nonce = nonce
    self.dirty = true
}

func (self *StateObject) Nonce() uint64 {
    return self.nonce
}

func (self *StateObject) EachStorage(cb func(key, value []byte)) {
    // When iterating over the storage check the cache first
    for h, v := range self.storage {
        cb([]byte(h), v.Bytes())
    }

    it := self.trie.Iterator()
    for it.Next() {
        // ignore cached values
        key := self.trie.GetKey(it.Key)
        if _, ok := self.storage[string(key)]; !ok {
            cb(key, it.Value)
        }
    }
}

//
// Encoding
//

// State object encoding methods
func (c *StateObject) RlpEncode() []byte {
    return common.Encode([]interface{}{c.nonce, c.balance, c.Root(), c.CodeHash()})
}

func (c *StateObject) CodeHash() common.Bytes {
    return crypto.Sha3(c.code)
}

// Storage change object. Used by the manifest for notifying changes to
// the sub channels.
type StorageState struct {
    StateAddress []byte
    Address      []byte
    Value        *big.Int
}