aboutsummaryrefslogtreecommitdiffstats
path: root/light/postprocess.go
blob: 95515fa794b8545614710874d904c9c3e7c483d9 (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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
// Copyright 2017 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"
    "encoding/binary"
    "errors"
    "fmt"
    "math/big"
    "time"

    "github.com/dexon-foundation/dexon/common"
    "github.com/dexon-foundation/dexon/common/bitutil"
    "github.com/dexon-foundation/dexon/core"
    "github.com/dexon-foundation/dexon/core/rawdb"
    "github.com/dexon-foundation/dexon/core/types"
    "github.com/dexon-foundation/dexon/ethdb"
    "github.com/dexon-foundation/dexon/log"
    "github.com/dexon-foundation/dexon/params"
    "github.com/dexon-foundation/dexon/rlp"
    "github.com/dexon-foundation/dexon/trie"
)

// IndexerConfig includes a set of configs for chain indexers.
type IndexerConfig struct {
    // The block frequency for creating CHTs.
    ChtSize uint64

    // A special auxiliary field represents client's chtsize for server config, otherwise represents server's chtsize.
    PairChtSize uint64

    // The number of confirmations needed to generate/accept a canonical hash help trie.
    ChtConfirms uint64

    // The block frequency for creating new bloom bits.
    BloomSize uint64

    // The number of confirmation needed before a bloom section is considered probably final and its rotated bits
    // are calculated.
    BloomConfirms uint64

    // The block frequency for creating BloomTrie.
    BloomTrieSize uint64

    // The number of confirmations needed to generate/accept a bloom trie.
    BloomTrieConfirms uint64
}

var (
    // DefaultServerIndexerConfig wraps a set of configs as a default indexer config for server side.
    DefaultServerIndexerConfig = &IndexerConfig{
        ChtSize:           params.CHTFrequencyServer,
        PairChtSize:       params.CHTFrequencyClient,
        ChtConfirms:       params.HelperTrieProcessConfirmations,
        BloomSize:         params.BloomBitsBlocks,
        BloomConfirms:     params.BloomConfirms,
        BloomTrieSize:     params.BloomTrieFrequency,
        BloomTrieConfirms: params.HelperTrieProcessConfirmations,
    }
    // DefaultClientIndexerConfig wraps a set of configs as a default indexer config for client side.
    DefaultClientIndexerConfig = &IndexerConfig{
        ChtSize:           params.CHTFrequencyClient,
        PairChtSize:       params.CHTFrequencyServer,
        ChtConfirms:       params.HelperTrieConfirmations,
        BloomSize:         params.BloomBitsBlocksClient,
        BloomConfirms:     params.HelperTrieConfirmations,
        BloomTrieSize:     params.BloomTrieFrequency,
        BloomTrieConfirms: params.HelperTrieConfirmations,
    }
    // TestServerIndexerConfig wraps a set of configs as a test indexer config for server side.
    TestServerIndexerConfig = &IndexerConfig{
        ChtSize:           64,
        PairChtSize:       512,
        ChtConfirms:       4,
        BloomSize:         64,
        BloomConfirms:     4,
        BloomTrieSize:     512,
        BloomTrieConfirms: 4,
    }
    // TestClientIndexerConfig wraps a set of configs as a test indexer config for client side.
    TestClientIndexerConfig = &IndexerConfig{
        ChtSize:           512,
        PairChtSize:       64,
        ChtConfirms:       32,
        BloomSize:         512,
        BloomConfirms:     32,
        BloomTrieSize:     512,
        BloomTrieConfirms: 32,
    }
)

// trustedCheckpoints associates each known checkpoint with the genesis hash of the chain it belongs to
var trustedCheckpoints = map[common.Hash]*params.TrustedCheckpoint{
    params.MainnetGenesisHash: params.MainnetTrustedCheckpoint,
    params.TestnetGenesisHash: params.TestnetTrustedCheckpoint,
    params.RinkebyGenesisHash: params.RinkebyTrustedCheckpoint,
    params.GoerliGenesisHash:  params.GoerliTrustedCheckpoint,
}

var (
    ErrNoTrustedCht       = errors.New("no trusted canonical hash trie")
    ErrNoTrustedBloomTrie = errors.New("no trusted bloom trie")
    ErrNoHeader           = errors.New("header not found")
    chtPrefix             = []byte("chtRoot-") // chtPrefix + chtNum (uint64 big endian) -> trie root hash
    ChtTablePrefix        = "cht-"
)

// ChtNode structures are stored in the Canonical Hash Trie in an RLP encoded format
type ChtNode struct {
    Hash common.Hash
    Td   *big.Int
}

// GetChtRoot reads the CHT root associated to the given section from the database
// Note that sectionIdx is specified according to LES/1 CHT section size.
func GetChtRoot(db ethdb.Database, sectionIdx uint64, sectionHead common.Hash) common.Hash {
    var encNumber [8]byte
    binary.BigEndian.PutUint64(encNumber[:], sectionIdx)
    data, _ := db.Get(append(append(chtPrefix, encNumber[:]...), sectionHead.Bytes()...))
    return common.BytesToHash(data)
}

// StoreChtRoot writes the CHT root associated to the given section into the database
// Note that sectionIdx is specified according to LES/1 CHT section size.
func StoreChtRoot(db ethdb.Database, sectionIdx uint64, sectionHead, root common.Hash) {
    var encNumber [8]byte
    binary.BigEndian.PutUint64(encNumber[:], sectionIdx)
    db.Put(append(append(chtPrefix, encNumber[:]...), sectionHead.Bytes()...), root.Bytes())
}

// ChtIndexerBackend implements core.ChainIndexerBackend.
type ChtIndexerBackend struct {
    diskdb, trieTable    ethdb.Database
    odr                  OdrBackend
    triedb               *trie.Database
    section, sectionSize uint64
    lastHash             common.Hash
    trie                 *trie.Trie
}

// NewChtIndexer creates a Cht chain indexer
func NewChtIndexer(db ethdb.Database, odr OdrBackend, size, confirms uint64) *core.ChainIndexer {
    trieTable := ethdb.NewTable(db, ChtTablePrefix)
    backend := &ChtIndexerBackend{
        diskdb:      db,
        odr:         odr,
        trieTable:   trieTable,
        triedb:      trie.NewDatabaseWithCache(trieTable, 1), // Use a tiny cache only to keep memory down
        sectionSize: size,
    }
    return core.NewChainIndexer(db, ethdb.NewTable(db, "chtIndex-"), backend, size, confirms, time.Millisecond*100, "cht")
}

// fetchMissingNodes tries to retrieve the last entry of the latest trusted CHT from the
// ODR backend in order to be able to add new entries and calculate subsequent root hashes
func (c *ChtIndexerBackend) fetchMissingNodes(ctx context.Context, section uint64, root common.Hash) error {
    batch := c.trieTable.NewBatch()
    r := &ChtRequest{ChtRoot: root, ChtNum: section - 1, BlockNum: section*c.sectionSize - 1, Config: c.odr.IndexerConfig()}
    for {
        err := c.odr.Retrieve(ctx, r)
        switch err {
        case nil:
            r.Proof.Store(batch)
            return batch.Write()
        case ErrNoPeers:
            // if there are no peers to serve, retry later
            select {
            case <-ctx.Done():
                return ctx.Err()
            case <-time.After(time.Second * 10):
                // stay in the loop and try again
            }
        default:
            return err
        }
    }
}

// Reset implements core.ChainIndexerBackend
func (c *ChtIndexerBackend) Reset(ctx context.Context, section uint64, lastSectionHead common.Hash) error {
    var root common.Hash
    if section > 0 {
        root = GetChtRoot(c.diskdb, section-1, lastSectionHead)
    }
    var err error
    c.trie, err = trie.New(root, c.triedb)

    if err != nil && c.odr != nil {
        err = c.fetchMissingNodes(ctx, section, root)
        if err == nil {
            c.trie, err = trie.New(root, c.triedb)
        }
    }

    c.section = section
    return err
}

// Process implements core.ChainIndexerBackend
func (c *ChtIndexerBackend) Process(ctx context.Context, header *types.Header) error {
    hash, num := header.Hash(), header.Number.Uint64()
    c.lastHash = hash

    td := rawdb.ReadTd(c.diskdb, hash, num)
    if td == nil {
        panic(nil)
    }
    var encNumber [8]byte
    binary.BigEndian.PutUint64(encNumber[:], num)
    data, _ := rlp.EncodeToBytes(ChtNode{hash, td})
    c.trie.Update(encNumber[:], data)
    return nil
}

// Commit implements core.ChainIndexerBackend
func (c *ChtIndexerBackend) Commit() error {
    root, err := c.trie.Commit(nil)
    if err != nil {
        return err
    }
    c.triedb.Commit(root, false)

    if ((c.section+1)*c.sectionSize)%params.CHTFrequencyClient == 0 {
        log.Info("Storing CHT", "section", c.section*c.sectionSize/params.CHTFrequencyClient, "head", fmt.Sprintf("%064x", c.lastHash), "root", fmt.Sprintf("%064x", root))
    }
    StoreChtRoot(c.diskdb, c.section, c.lastHash, root)
    return nil
}

var (
    bloomTriePrefix      = []byte("bltRoot-") // bloomTriePrefix + bloomTrieNum (uint64 big endian) -> trie root hash
    BloomTrieTablePrefix = "blt-"
)

// GetBloomTrieRoot reads the BloomTrie root assoctiated to the given section from the database
func GetBloomTrieRoot(db ethdb.Database, sectionIdx uint64, sectionHead common.Hash) common.Hash {
    var encNumber [8]byte
    binary.BigEndian.PutUint64(encNumber[:], sectionIdx)
    data, _ := db.Get(append(append(bloomTriePrefix, encNumber[:]...), sectionHead.Bytes()...))
    return common.BytesToHash(data)
}

// StoreBloomTrieRoot writes the BloomTrie root assoctiated to the given section into the database
func StoreBloomTrieRoot(db ethdb.Database, sectionIdx uint64, sectionHead, root common.Hash) {
    var encNumber [8]byte
    binary.BigEndian.PutUint64(encNumber[:], sectionIdx)
    db.Put(append(append(bloomTriePrefix, encNumber[:]...), sectionHead.Bytes()...), root.Bytes())
}

// BloomTrieIndexerBackend implements core.ChainIndexerBackend
type BloomTrieIndexerBackend struct {
    diskdb, trieTable ethdb.Database
    triedb            *trie.Database
    odr               OdrBackend
    section           uint64
    parentSize        uint64
    size              uint64
    bloomTrieRatio    uint64
    trie              *trie.Trie
    sectionHeads      []common.Hash
}

// NewBloomTrieIndexer creates a BloomTrie chain indexer
func NewBloomTrieIndexer(db ethdb.Database, odr OdrBackend, parentSize, size uint64) *core.ChainIndexer {
    trieTable := ethdb.NewTable(db, BloomTrieTablePrefix)
    backend := &BloomTrieIndexerBackend{
        diskdb:     db,
        odr:        odr,
        trieTable:  trieTable,
        triedb:     trie.NewDatabaseWithCache(trieTable, 1), // Use a tiny cache only to keep memory down
        parentSize: parentSize,
        size:       size,
    }
    backend.bloomTrieRatio = size / parentSize
    backend.sectionHeads = make([]common.Hash, backend.bloomTrieRatio)
    return core.NewChainIndexer(db, ethdb.NewTable(db, "bltIndex-"), backend, size, 0, time.Millisecond*100, "bloomtrie")
}

// fetchMissingNodes tries to retrieve the last entries of the latest trusted bloom trie from the
// ODR backend in order to be able to add new entries and calculate subsequent root hashes
func (b *BloomTrieIndexerBackend) fetchMissingNodes(ctx context.Context, section uint64, root common.Hash) error {
    indexCh := make(chan uint, types.BloomBitLength)
    type res struct {
        nodes *NodeSet
        err   error
    }
    resCh := make(chan res, types.BloomBitLength)
    for i := 0; i < 20; i++ {
        go func() {
            for bitIndex := range indexCh {
                r := &BloomRequest{BloomTrieRoot: root, BloomTrieNum: section - 1, BitIdx: bitIndex, SectionIndexList: []uint64{section - 1}, Config: b.odr.IndexerConfig()}
                for {
                    if err := b.odr.Retrieve(ctx, r); err == ErrNoPeers {
                        // if there are no peers to serve, retry later
                        select {
                        case <-ctx.Done():
                            resCh <- res{nil, ctx.Err()}
                            return
                        case <-time.After(time.Second * 10):
                            // stay in the loop and try again
                        }
                    } else {
                        resCh <- res{r.Proofs, err}
                        break
                    }
                }
            }
        }()
    }

    for i := uint(0); i < types.BloomBitLength; i++ {
        indexCh <- i
    }
    close(indexCh)
    batch := b.trieTable.NewBatch()
    for i := uint(0); i < types.BloomBitLength; i++ {
        res := <-resCh
        if res.err != nil {
            return res.err
        }
        res.nodes.Store(batch)
    }
    return batch.Write()
}

// Reset implements core.ChainIndexerBackend
func (b *BloomTrieIndexerBackend) Reset(ctx context.Context, section uint64, lastSectionHead common.Hash) error {
    var root common.Hash
    if section > 0 {
        root = GetBloomTrieRoot(b.diskdb, section-1, lastSectionHead)
    }
    var err error
    b.trie, err = trie.New(root, b.triedb)
    if err != nil && b.odr != nil {
        err = b.fetchMissingNodes(ctx, section, root)
        if err == nil {
            b.trie, err = trie.New(root, b.triedb)
        }
    }
    b.section = section
    return err
}

// Process implements core.ChainIndexerBackend
func (b *BloomTrieIndexerBackend) Process(ctx context.Context, header *types.Header) error {
    num := header.Number.Uint64() - b.section*b.size
    if (num+1)%b.parentSize == 0 {
        b.sectionHeads[num/b.parentSize] = header.Hash()
    }
    return nil
}

// Commit implements core.ChainIndexerBackend
func (b *BloomTrieIndexerBackend) Commit() error {
    var compSize, decompSize uint64

    for i := uint(0); i < types.BloomBitLength; i++ {
        var encKey [10]byte
        binary.BigEndian.PutUint16(encKey[0:2], uint16(i))
        binary.BigEndian.PutUint64(encKey[2:10], b.section)
        var decomp []byte
        for j := uint64(0); j < b.bloomTrieRatio; j++ {
            data, err := rawdb.ReadBloomBits(b.diskdb, i, b.section*b.bloomTrieRatio+j, b.sectionHeads[j])
            if err != nil {
                return err
            }
            decompData, err2 := bitutil.DecompressBytes(data, int(b.parentSize/8))
            if err2 != nil {
                return err2
            }
            decomp = append(decomp, decompData...)
        }
        comp := bitutil.CompressBytes(decomp)

        decompSize += uint64(len(decomp))
        compSize += uint64(len(comp))
        if len(comp) > 0 {
            b.trie.Update(encKey[:], comp)
        } else {
            b.trie.Delete(encKey[:])
        }
    }
    root, err := b.trie.Commit(nil)
    if err != nil {
        return err
    }
    b.triedb.Commit(root, false)

    sectionHead := b.sectionHeads[b.bloomTrieRatio-1]
    log.Info("Storing bloom trie", "section", b.section, "head", fmt.Sprintf("%064x", sectionHead), "root", fmt.Sprintf("%064x", root), "compression", float64(compSize)/float64(decompSize))
    StoreBloomTrieRoot(b.diskdb, b.section, sectionHead, root)
    return nil
}