aboutsummaryrefslogtreecommitdiffstats
path: root/core/chain_manager_test.go
blob: 5f8cfd4f4f53ec0f5ad3b9c26881bf14ca412448 (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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
// Copyright 2014 The go-ethereum Authors
// This file is part of go-ethereum.
//
// go-ethereum 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.
//
// go-ethereum 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 go-ethereum.  If not, see <http://www.gnu.org/licenses/>.

package core

import (
    "fmt"
    "math/big"
    "math/rand"
    "os"
    "path/filepath"
    "runtime"
    "strconv"
    "testing"

    "github.com/ethereum/ethash"
    "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/ethdb"
    "github.com/ethereum/go-ethereum/event"
    "github.com/ethereum/go-ethereum/pow"
    "github.com/ethereum/go-ethereum/rlp"
    "github.com/hashicorp/golang-lru"
)

func init() {
    runtime.GOMAXPROCS(runtime.NumCPU())
}

func thePow() pow.PoW {
    pow, _ := ethash.NewForTesting()
    return pow
}

func theChainManager(db common.Database, t *testing.T) *ChainManager {
    var eventMux event.TypeMux
    WriteTestNetGenesisBlock(db, db, 0)
    chainMan, err := NewChainManager(db, db, db, thePow(), &eventMux)
    if err != nil {
        t.Error("failed creating chainmanager:", err)
        t.FailNow()
        return nil
    }
    blockMan := NewBlockProcessor(db, db, nil, chainMan, &eventMux)
    chainMan.SetProcessor(blockMan)

    return chainMan
}

// Test fork of length N starting from block i
func testFork(t *testing.T, bman *BlockProcessor, i, N int, f func(td1, td2 *big.Int)) {
    // switch databases to process the new chain
    db, err := ethdb.NewMemDatabase()
    if err != nil {
        t.Fatal("Failed to create db:", err)
    }
    // copy old chain up to i into new db with deterministic canonical
    bman2, err := newCanonical(i, db)
    if err != nil {
        t.Fatal("could not make new canonical in testFork", err)
    }
    // asert the bmans have the same block at i
    bi1 := bman.bc.GetBlockByNumber(uint64(i)).Hash()
    bi2 := bman2.bc.GetBlockByNumber(uint64(i)).Hash()
    if bi1 != bi2 {
        t.Fatal("chains do not have the same hash at height", i)
    }
    bman2.bc.SetProcessor(bman2)

    // extend the fork
    parent := bman2.bc.CurrentBlock()
    chainB := makeChain(parent, N, db, forkSeed)
    _, err = bman2.bc.InsertChain(chainB)
    if err != nil {
        t.Fatal("Insert chain error for fork:", err)
    }

    tdpre := bman.bc.Td()
    // Test the fork's blocks on the original chain
    td, err := testChain(chainB, bman)
    if err != nil {
        t.Fatal("expected chainB not to give errors:", err)
    }
    // Compare difficulties
    f(tdpre, td)

    // Loop over parents making sure reconstruction is done properly
}

func printChain(bc *ChainManager) {
    for i := bc.CurrentBlock().Number().Uint64(); i > 0; i-- {
        b := bc.GetBlockByNumber(uint64(i))
        fmt.Printf("\t%x %v\n", b.Hash(), b.Difficulty())
    }
}

// process blocks against a chain
func testChain(chainB types.Blocks, bman *BlockProcessor) (*big.Int, error) {
    td := new(big.Int)
    for _, block := range chainB {
        _, _, err := bman.bc.processor.Process(block)
        if err != nil {
            if IsKnownBlockErr(err) {
                continue
            }
            return nil, err
        }
        parent := bman.bc.GetBlock(block.ParentHash())
        block.Td = CalcTD(block, parent)
        td = block.Td

        bman.bc.mu.Lock()
        {
            WriteBlock(bman.bc.blockDb, block)
        }
        bman.bc.mu.Unlock()
    }
    return td, nil
}

func loadChain(fn string, t *testing.T) (types.Blocks, error) {
    fh, err := os.OpenFile(filepath.Join("..", "_data", fn), os.O_RDONLY, os.ModePerm)
    if err != nil {
        return nil, err
    }
    defer fh.Close()

    var chain types.Blocks
    if err := rlp.Decode(fh, &chain); err != nil {
        return nil, err
    }

    return chain, nil
}

func insertChain(done chan bool, chainMan *ChainManager, chain types.Blocks, t *testing.T) {
    _, err := chainMan.InsertChain(chain)
    if err != nil {
        fmt.Println(err)
        t.FailNow()
    }
    done <- true
}

func TestExtendCanonical(t *testing.T) {
    CanonicalLength := 5
    db, err := ethdb.NewMemDatabase()
    if err != nil {
        t.Fatal("Failed to create db:", err)
    }
    // make first chain starting from genesis
    bman, err := newCanonical(CanonicalLength, db)
    if err != nil {
        t.Fatal("Could not make new canonical chain:", err)
    }
    f := func(td1, td2 *big.Int) {
        if td2.Cmp(td1) <= 0 {
            t.Error("expected chainB to have higher difficulty. Got", td2, "expected more than", td1)
        }
    }
    // Start fork from current height (CanonicalLength)
    testFork(t, bman, CanonicalLength, 1, f)
    testFork(t, bman, CanonicalLength, 2, f)
    testFork(t, bman, CanonicalLength, 5, f)
    testFork(t, bman, CanonicalLength, 10, f)
}

func TestShorterFork(t *testing.T) {
    db, err := ethdb.NewMemDatabase()
    if err != nil {
        t.Fatal("Failed to create db:", err)
    }
    // make first chain starting from genesis
    bman, err := newCanonical(10, db)
    if err != nil {
        t.Fatal("Could not make new canonical chain:", err)
    }
    f := func(td1, td2 *big.Int) {
        if td2.Cmp(td1) >= 0 {
            t.Error("expected chainB to have lower difficulty. Got", td2, "expected less than", td1)
        }
    }
    // Sum of numbers must be less than 10
    // for this to be a shorter fork
    testFork(t, bman, 0, 3, f)
    testFork(t, bman, 0, 7, f)
    testFork(t, bman, 1, 1, f)
    testFork(t, bman, 1, 7, f)
    testFork(t, bman, 5, 3, f)
    testFork(t, bman, 5, 4, f)
}

func TestLongerFork(t *testing.T) {
    db, err := ethdb.NewMemDatabase()
    if err != nil {
        t.Fatal("Failed to create db:", err)
    }
    // make first chain starting from genesis
    bman, err := newCanonical(10, db)
    if err != nil {
        t.Fatal("Could not make new canonical chain:", err)
    }
    f := func(td1, td2 *big.Int) {
        if td2.Cmp(td1) <= 0 {
            t.Error("expected chainB to have higher difficulty. Got", td2, "expected more than", td1)
        }
    }
    // Sum of numbers must be greater than 10
    // for this to be a longer fork
    testFork(t, bman, 0, 11, f)
    testFork(t, bman, 0, 15, f)
    testFork(t, bman, 1, 10, f)
    testFork(t, bman, 1, 12, f)
    testFork(t, bman, 5, 6, f)
    testFork(t, bman, 5, 8, f)
}

func TestEqualFork(t *testing.T) {
    db, err := ethdb.NewMemDatabase()
    if err != nil {
        t.Fatal("Failed to create db:", err)
    }
    bman, err := newCanonical(10, db)
    if err != nil {
        t.Fatal("Could not make new canonical chain:", err)
    }
    f := func(td1, td2 *big.Int) {
        if td2.Cmp(td1) != 0 {
            t.Error("expected chainB to have equal difficulty. Got", td2, "expected ", td1)
        }
    }
    // Sum of numbers must be equal to 10
    // for this to be an equal fork
    testFork(t, bman, 0, 10, f)
    testFork(t, bman, 1, 9, f)
    testFork(t, bman, 2, 8, f)
    testFork(t, bman, 5, 5, f)
    testFork(t, bman, 6, 4, f)
    testFork(t, bman, 9, 1, f)
}

func TestBrokenChain(t *testing.T) {
    db, err := ethdb.NewMemDatabase()
    if err != nil {
        t.Fatal("Failed to create db:", err)
    }
    bman, err := newCanonical(10, db)
    if err != nil {
        t.Fatal("Could not make new canonical chain:", err)
    }
    db2, err := ethdb.NewMemDatabase()
    if err != nil {
        t.Fatal("Failed to create db:", err)
    }
    bman2, err := newCanonical(10, db2)
    if err != nil {
        t.Fatal("Could not make new canonical chain:", err)
    }
    bman2.bc.SetProcessor(bman2)
    parent := bman2.bc.CurrentBlock()
    chainB := makeChain(parent, 5, db2, forkSeed)
    chainB = chainB[1:]
    _, err = testChain(chainB, bman)
    if err == nil {
        t.Error("expected broken chain to return error")
    }
}

func TestChainInsertions(t *testing.T) {
    t.Skip("Skipped: outdated test files")

    db, _ := ethdb.NewMemDatabase()

    chain1, err := loadChain("valid1", t)
    if err != nil {
        fmt.Println(err)
        t.FailNow()
    }

    chain2, err := loadChain("valid2", t)
    if err != nil {
        fmt.Println(err)
        t.FailNow()
    }

    chainMan := theChainManager(db, t)

    const max = 2
    done := make(chan bool, max)

    go insertChain(done, chainMan, chain1, t)
    go insertChain(done, chainMan, chain2, t)

    for i := 0; i < max; i++ {
        <-done
    }

    if chain2[len(chain2)-1].Hash() != chainMan.CurrentBlock().Hash() {
        t.Error("chain2 is canonical and shouldn't be")
    }

    if chain1[len(chain1)-1].Hash() != chainMan.CurrentBlock().Hash() {
        t.Error("chain1 isn't canonical and should be")
    }
}

func TestChainMultipleInsertions(t *testing.T) {
    t.Skip("Skipped: outdated test files")

    db, _ := ethdb.NewMemDatabase()

    const max = 4
    chains := make([]types.Blocks, max)
    var longest int
    for i := 0; i < max; i++ {
        var err error
        name := "valid" + strconv.Itoa(i+1)
        chains[i], err = loadChain(name, t)
        if len(chains[i]) >= len(chains[longest]) {
            longest = i
        }
        fmt.Println("loaded", name, "with a length of", len(chains[i]))
        if err != nil {
            fmt.Println(err)
            t.FailNow()
        }
    }

    chainMan := theChainManager(db, t)

    done := make(chan bool, max)
    for i, chain := range chains {
        // XXX the go routine would otherwise reference the same (chain[3]) variable and fail
        i := i
        chain := chain
        go func() {
            insertChain(done, chainMan, chain, t)
            fmt.Println(i, "done")
        }()
    }

    for i := 0; i < max; i++ {
        <-done
    }

    if chains[longest][len(chains[longest])-1].Hash() != chainMan.CurrentBlock().Hash() {
        t.Error("Invalid canonical chain")
    }
}

type bproc struct{}

func (bproc) Process(*types.Block) (state.Logs, types.Receipts, error) { return nil, nil, nil }

func makeChainWithDiff(genesis *types.Block, d []int, seed byte) []*types.Block {
    var chain []*types.Block
    for i, difficulty := range d {
        header := &types.Header{
            Coinbase:   common.Address{seed},
            Number:     big.NewInt(int64(i + 1)),
            Difficulty: big.NewInt(int64(difficulty)),
        }
        if i == 0 {
            header.ParentHash = genesis.Hash()
        } else {
            header.ParentHash = chain[i-1].Hash()
        }
        block := types.NewBlockWithHeader(header)
        chain = append(chain, block)
    }
    return chain
}

func chm(genesis *types.Block, db common.Database) *ChainManager {
    var eventMux event.TypeMux
    bc := &ChainManager{extraDb: db, blockDb: db, stateDb: db, genesisBlock: genesis, eventMux: &eventMux, pow: FakePow{}}
    bc.cache, _ = lru.New(100)
    bc.futureBlocks, _ = lru.New(100)
    bc.processor = bproc{}
    bc.ResetWithGenesisBlock(genesis)
    bc.txState = state.ManageState(bc.State())

    return bc
}

func TestReorgLongest(t *testing.T) {
    db, _ := ethdb.NewMemDatabase()

    genesis, err := WriteTestNetGenesisBlock(db, db, 0)
    if err != nil {
        t.Error(err)
        t.FailNow()
    }
    bc := chm(genesis, db)

    chain1 := makeChainWithDiff(genesis, []int{1, 2, 4}, 10)
    chain2 := makeChainWithDiff(genesis, []int{1, 2, 3, 4}, 11)

    bc.InsertChain(chain1)
    bc.InsertChain(chain2)

    prev := bc.CurrentBlock()
    for block := bc.GetBlockByNumber(bc.CurrentBlock().NumberU64() - 1); block.NumberU64() != 0; prev, block = block, bc.GetBlockByNumber(block.NumberU64()-1) {
        if prev.ParentHash() != block.Hash() {
            t.Errorf("parent hash mismatch %x - %x", prev.ParentHash(), block.Hash())
        }
    }
}

func TestReorgShortest(t *testing.T) {
    db, _ := ethdb.NewMemDatabase()
    genesis, err := WriteTestNetGenesisBlock(db, db, 0)
    if err != nil {
        t.Error(err)
        t.FailNow()
    }
    bc := chm(genesis, db)

    chain1 := makeChainWithDiff(genesis, []int{1, 2, 3, 4}, 10)
    chain2 := makeChainWithDiff(genesis, []int{1, 10}, 11)

    bc.InsertChain(chain1)
    bc.InsertChain(chain2)

    prev := bc.CurrentBlock()
    for block := bc.GetBlockByNumber(bc.CurrentBlock().NumberU64() - 1); block.NumberU64() != 0; prev, block = block, bc.GetBlockByNumber(block.NumberU64()-1) {
        if prev.ParentHash() != block.Hash() {
            t.Errorf("parent hash mismatch %x - %x", prev.ParentHash(), block.Hash())
        }
    }
}

func TestInsertNonceError(t *testing.T) {
    for i := 1; i < 25 && !t.Failed(); i++ {
        db, _ := ethdb.NewMemDatabase()
        genesis, err := WriteTestNetGenesisBlock(db, db, 0)
        if err != nil {
            t.Error(err)
            t.FailNow()
        }
        bc := chm(genesis, db)
        bc.processor = NewBlockProcessor(db, db, bc.pow, bc, bc.eventMux)
        blocks := makeChain(bc.currentBlock, i, db, 0)

        fail := rand.Int() % len(blocks)
        failblock := blocks[fail]
        bc.pow = failpow{failblock.NumberU64()}
        n, err := bc.InsertChain(blocks)

        // Check that the returned error indicates the nonce failure.
        if n != fail {
            t.Errorf("(i=%d) wrong failed block index: got %d, want %d", i, n, fail)
        }
        if !IsBlockNonceErr(err) {
            t.Fatalf("(i=%d) got %q, want a nonce error", i, err)
        }
        nerr := err.(*BlockNonceErr)
        if nerr.Number.Cmp(failblock.Number()) != 0 {
            t.Errorf("(i=%d) wrong block number in error, got %v, want %v", i, nerr.Number, failblock.Number())
        }
        if nerr.Hash != failblock.Hash() {
            t.Errorf("(i=%d) wrong block hash in error, got %v, want %v", i, nerr.Hash, failblock.Hash())
        }

        // Check that all no blocks after the failing block have been inserted.
        for _, block := range blocks[fail:] {
            if bc.HasBlock(block.Hash()) {
                t.Errorf("(i=%d) invalid block %d present in chain", i, block.NumberU64())
            }
        }
    }
}

/*
func TestGenesisMismatch(t *testing.T) {
    db, _ := ethdb.NewMemDatabase()
    var mux event.TypeMux
    genesis := GenesisBlock(0, db)
    _, err := NewChainManager(genesis, db, db, db, thePow(), &mux)
    if err != nil {
        t.Error(err)
    }
    genesis = GenesisBlock(1, db)
    _, err = NewChainManager(genesis, db, db, db, thePow(), &mux)
    if err == nil {
        t.Error("expected genesis mismatch error")
    }
}
*/

// failpow returns false from Verify for a certain block number.
type failpow struct{ num uint64 }

func (pow failpow) Search(pow.Block, <-chan struct{}) (nonce uint64, mixHash []byte) {
    return 0, nil
}
func (pow failpow) Verify(b pow.Block) bool {
    return b.NumberU64() != pow.num
}
func (pow failpow) GetHashrate() int64 {
    return 0
}
func (pow failpow) Turbo(bool) {
}