aboutsummaryrefslogtreecommitdiffstats
path: root/light/trie.go
blob: ab4e18b43eecea1b6fff7e1c6421ceaf96d66a63 (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
// 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 light

import (
    "context"
    "errors"
    "fmt"

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

func NewState(ctx context.Context, head *types.Header, odr OdrBackend) *state.StateDB {
    state, _ := state.New(head.Root, NewStateDatabase(ctx, head, odr))
    return state
}

func NewStateDatabase(ctx context.Context, head *types.Header, odr OdrBackend) state.Database {
    return &odrDatabase{ctx, StateTrieID(head), odr}
}

type odrDatabase struct {
    ctx     context.Context
    id      *TrieID
    backend OdrBackend
}

func (db *odrDatabase) OpenTrie(root common.Hash) (state.Trie, error) {
    return &odrTrie{db: db, id: db.id}, nil
}

func (db *odrDatabase) OpenStorageTrie(addrHash, root common.Hash) (state.Trie, error) {
    return &odrTrie{db: db, id: StorageTrieID(db.id, addrHash, root)}, nil
}

func (db *odrDatabase) CopyTrie(t state.Trie) state.Trie {
    switch t := t.(type) {
    case *odrTrie:
        cpy := &odrTrie{db: t.db, id: t.id}
        if t.trie != nil {
            cpytrie := *t.trie
            cpy.trie = &cpytrie
        }
        return cpy
    default:
        panic(fmt.Errorf("unknown trie type %T", t))
    }
}

func (db *odrDatabase) ContractCode(addrHash, codeHash common.Hash) ([]byte, error) {
    if codeHash == sha3_nil {
        return nil, nil
    }
    if code, err := db.backend.Database().Get(codeHash[:]); err == nil {
        return code, nil
    }
    id := *db.id
    id.AccKey = addrHash[:]
    req := &CodeRequest{Id: &id, Hash: codeHash}
    err := db.backend.Retrieve(db.ctx, req)
    return req.Data, err
}

func (db *odrDatabase) ContractCodeSize(addrHash, codeHash common.Hash) (int, error) {
    code, err := db.ContractCode(addrHash, codeHash)
    return len(code), err
}

func (db *odrDatabase) TrieDB() *trie.Database {
    return nil
}

type odrTrie struct {
    db   *odrDatabase
    id   *TrieID
    trie *trie.Trie
}

func (t *odrTrie) TryGet(key []byte) ([]byte, error) {
    key = crypto.Keccak256(key)
    var res []byte
    err := t.do(key, func() (err error) {
        res, err = t.trie.TryGet(key)
        return err
    })
    return res, err
}

func (t *odrTrie) TryUpdate(key, value []byte) error {
    key = crypto.Keccak256(key)
    return t.do(key, func() error {
        return t.trie.TryUpdate(key, value)
    })
}

func (t *odrTrie) TryDelete(key []byte) error {
    key = crypto.Keccak256(key)
    return t.do(key, func() error {
        return t.trie.TryDelete(key)
    })
}

func (t *odrTrie) Commit(onleaf trie.LeafCallback) (common.Hash, error) {
    if t.trie == nil {
        return t.id.Root, nil
    }
    return t.trie.Commit(onleaf)
}

func (t *odrTrie) Hash() common.Hash {
    if t.trie == nil {
        return t.id.Root
    }
    return t.trie.Hash()
}

func (t *odrTrie) NodeIterator(startkey []byte) trie.NodeIterator {
    return newNodeIterator(t, startkey)
}

func (t *odrTrie) GetKey(sha []byte) []byte {
    return nil
}

func (t *odrTrie) Prove(key []byte, fromLevel uint, proofDb ethdb.Putter) error {
    return errors.New("not implemented, needs client/server interface split")
}

// do tries and retries to execute a function until it returns with no error or
// an error type other than MissingNodeError
func (t *odrTrie) do(key []byte, fn func() error) error {
    for {
        var err error
        if t.trie == nil {
            t.trie, err = trie.New(t.id.Root, trie.NewDatabase(t.db.backend.Database()))
        }
        if err == nil {
            err = fn()
        }
        if _, ok := err.(*trie.MissingNodeError); !ok {
            return err
        }
        r := &TrieRequest{Id: t.id, Key: key}
        if err := t.db.backend.Retrieve(t.db.ctx, r); err != nil {
            return err
        }
    }
}

type nodeIterator struct {
    trie.NodeIterator
    t   *odrTrie
    err error
}

func newNodeIterator(t *odrTrie, startkey []byte) trie.NodeIterator {
    it := &nodeIterator{t: t}
    // Open the actual non-ODR trie if that hasn't happened yet.
    if t.trie == nil {
        it.do(func() error {
            t, err := trie.New(t.id.Root, trie.NewDatabase(t.db.backend.Database()))
            if err == nil {
                it.t.trie = t
            }
            return err
        })
    }
    it.do(func() error {
        it.NodeIterator = it.t.trie.NodeIterator(startkey)
        return it.NodeIterator.Error()
    })
    return it
}

func (it *nodeIterator) Next(descend bool) bool {
    var ok bool
    it.do(func() error {
        ok = it.NodeIterator.Next(descend)
        return it.NodeIterator.Error()
    })
    return ok
}

// do runs fn and attempts to fill in missing nodes by retrieving.
func (it *nodeIterator) do(fn func() error) {
    var lasthash common.Hash
    for {
        it.err = fn()
        missing, ok := it.err.(*trie.MissingNodeError)
        if !ok {
            return
        }
        if missing.NodeHash == lasthash {
            it.err = fmt.Errorf("retrieve loop for trie node %x", missing.NodeHash)
            return
        }
        lasthash = missing.NodeHash
        r := &TrieRequest{Id: it.t.id, Key: nibblesToKey(missing.Path)}
        if it.err = it.t.db.backend.Retrieve(it.t.db.ctx, r); it.err != nil {
            return
        }
    }
}

func (it *nodeIterator) Error() error {
    if it.err != nil {
        return it.err
    }
    return it.NodeIterator.Error()
}

func nibblesToKey(nib []byte) []byte {
    if len(nib) > 0 && nib[len(nib)-1] == 0x10 {
        nib = nib[:len(nib)-1] // drop terminator
    }
    if len(nib)&1 == 1 {
        nib = append(nib, 0) // make even
    }
    key := make([]byte, len(nib)/2)
    for bi, ni := 0, 0; ni < len(nib); bi, ni = bi+1, ni+2 {
        key[bi] = nib[ni]<<4 | nib[ni+1]
    }
    return key
}