aboutsummaryrefslogtreecommitdiffstats
path: root/ethstate/state.go
blob: a4b9b1e9c66d66a24e69885e8344b9381062be53 (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
package ethstate

import (
    "github.com/ethereum/eth-go/ethcrypto"
    "github.com/ethereum/eth-go/ethlog"
    "github.com/ethereum/eth-go/ethtrie"
    "github.com/ethereum/eth-go/ethutil"
    "math/big"
)

var statelogger = ethlog.NewLogger("STATE")

// States within the ethereum protocol are used to store anything
// within the merkle trie. States take care of caching and storing
// nested states. It's the general query interface to retrieve:
// * Contracts
// * Accounts
type State struct {
    // The trie for this structure
    trie *ethtrie.Trie

    stateObjects map[string]*StateObject

    manifest *Manifest
}

// Create a new state from a given trie
func NewState(trie *ethtrie.Trie) *State {
    return &State{trie: trie, stateObjects: make(map[string]*StateObject), manifest: NewManifest()}
}

// Retrieve the balance from the given address or 0 if object not found
func (self *State) GetBalance(addr []byte) *big.Int {
    stateObject := self.GetStateObject(addr)
    if stateObject != nil {
        return stateObject.Amount
    }

    return ethutil.Big0
}

func (self *State) GetNonce(addr []byte) uint64 {
    stateObject := self.GetStateObject(addr)
    if stateObject != nil {
        return stateObject.Nonce
    }

    return 0
}

//
// Setting, updating & deleting state object methods
//

// Update the given state object and apply it to state trie
func (self *State) UpdateStateObject(stateObject *StateObject) {
    addr := stateObject.Address()

    ethutil.Config.Db.Put(ethcrypto.Sha3Bin(stateObject.Code), stateObject.Code)

    self.trie.Update(string(addr), string(stateObject.RlpEncode()))

    self.manifest.AddObjectChange(stateObject)
}

// Delete the given state object and delete it from the state trie
func (self *State) DeleteStateObject(stateObject *StateObject) {
    self.trie.Delete(string(stateObject.Address()))

    delete(self.stateObjects, string(stateObject.Address()))
}

// Retrieve a state object given my the address. Nil if not found
func (self *State) GetStateObject(addr []byte) *StateObject {
    addr = ethutil.Address(addr)

    stateObject := self.stateObjects[string(addr)]
    if stateObject != nil {
        return stateObject
    }

    data := self.trie.Get(string(addr))
    if len(data) == 0 {
        return nil
    }

    stateObject = NewStateObjectFromBytes(addr, []byte(data))
    self.stateObjects[string(addr)] = stateObject

    return stateObject
}

// Retrieve a state object or create a new state object if nil
func (self *State) GetOrNewStateObject(addr []byte) *StateObject {
    stateObject := self.GetStateObject(addr)
    if stateObject == nil {
        stateObject = self.NewStateObject(addr)
    }

    return stateObject
}

// Create a state object whether it exist in the trie or not
func (self *State) NewStateObject(addr []byte) *StateObject {
    addr = ethutil.Address(addr)

    statelogger.Infof("(+) %x\n", addr)

    stateObject := NewStateObject(addr)
    self.stateObjects[string(addr)] = stateObject

    return stateObject
}

// Deprecated
func (self *State) GetAccount(addr []byte) *StateObject {
    return self.GetOrNewStateObject(addr)
}

//
// Setting, copying of the state methods
//

func (s *State) Cmp(other *State) bool {
    return s.trie.Cmp(other.trie)
}

func (self *State) Copy() *State {
    if self.trie != nil {
        state := NewState(self.trie.Copy())
        for k, stateObject := range self.stateObjects {
            state.stateObjects[k] = stateObject.Copy()
        }

        return state
    }

    return nil
}

func (self *State) Set(state *State) {
    if state == nil {
        panic("Tried setting 'state' to nil through 'Set'")
    }

    self.trie = state.trie
    self.stateObjects = state.stateObjects
}

func (s *State) Root() interface{} {
    return s.trie.Root
}

// Resets the trie and all siblings
func (s *State) Reset() {
    s.trie.Undo()

    // Reset all nested states
    for _, stateObject := range s.stateObjects {
        if stateObject.state == nil {
            continue
        }

        //stateObject.state.Reset()
        stateObject.Reset()
    }

    s.Empty()
}

// Syncs the trie and all siblings
func (s *State) Sync() {
    // Sync all nested states
    for _, stateObject := range s.stateObjects {
        //s.UpdateStateObject(stateObject)

        if stateObject.state == nil {
            continue
        }

        stateObject.state.Sync()
    }

    s.trie.Sync()

    s.Empty()
}

func (self *State) Empty() {
    self.stateObjects = make(map[string]*StateObject)
}

func (self *State) Update() {
    for _, stateObject := range self.stateObjects {
        if stateObject.remove {
            self.DeleteStateObject(stateObject)
        } else {
            stateObject.Sync()

            self.UpdateStateObject(stateObject)
        }
    }

    // FIXME trie delete is broken
    valid, t2 := ethtrie.ParanoiaCheck(self.trie)
    if !valid {
        statelogger.Infof("Warn: PARANOIA: Different state root during copy %x vs %x\n", self.trie.Root, t2.Root)

        self.trie = t2
    }
}

// Debug stuff
func (self *State) CreateOutputForDiff() {
    for _, stateObject := range self.stateObjects {
        stateObject.CreateOutputForDiff()
    }
}

func (self *State) Manifest() *Manifest {
    return self.manifest
}

// Object manifest
//
// The object manifest is used to keep changes to the state so we can keep track of the changes
// that occurred during a state transitioning phase.
type Manifest struct {
    // XXX These will be handy in the future. Not important for now.
    objectAddresses  map[string]bool
    storageAddresses map[string]map[string]bool

    objectChanges  map[string]*StateObject
    storageChanges map[string]map[string]*big.Int
}

func NewManifest() *Manifest {
    m := &Manifest{objectAddresses: make(map[string]bool), storageAddresses: make(map[string]map[string]bool)}
    m.Reset()

    return m
}

func (m *Manifest) Reset() {
    m.objectChanges = make(map[string]*StateObject)
    m.storageChanges = make(map[string]map[string]*big.Int)
}

func (m *Manifest) AddObjectChange(stateObject *StateObject) {
    m.objectChanges[string(stateObject.Address())] = stateObject
}

func (m *Manifest) AddStorageChange(stateObject *StateObject, storageAddr []byte, storage *big.Int) {
    if m.storageChanges[string(stateObject.Address())] == nil {
        m.storageChanges[string(stateObject.Address())] = make(map[string]*big.Int)
    }

    m.storageChanges[string(stateObject.Address())][string(storageAddr)] = storage
}