1// Copyright 2020 The go-ethereum Authors
2// This file is part of the go-ethereum library.
3//
4// The go-ethereum library is free software: you can redistribute it and/or modify
5// it under the terms of the GNU Lesser General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// The go-ethereum library is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU Lesser General Public License for more details.
13//
14// You should have received a copy of the GNU Lesser General Public License
15// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
16
17package core
18
19import (
20	"errors"
21	"fmt"
22	"math/big"
23	"testing"
24	"time"
25
26	"github.com/ethereum/go-ethereum/consensus"
27	"github.com/ethereum/go-ethereum/consensus/ethash"
28	"github.com/ethereum/go-ethereum/core/rawdb"
29	"github.com/ethereum/go-ethereum/core/types"
30	"github.com/ethereum/go-ethereum/log"
31	"github.com/ethereum/go-ethereum/params"
32)
33
34func verifyUnbrokenCanonchain(hc *HeaderChain) error {
35	h := hc.CurrentHeader()
36	for {
37		canonHash := rawdb.ReadCanonicalHash(hc.chainDb, h.Number.Uint64())
38		if exp := h.Hash(); canonHash != exp {
39			return fmt.Errorf("Canon hash chain broken, block %d got %x, expected %x",
40				h.Number, canonHash[:8], exp[:8])
41		}
42		// Verify that we have the TD
43		if td := rawdb.ReadTd(hc.chainDb, canonHash, h.Number.Uint64()); td == nil {
44			return fmt.Errorf("Canon TD missing at block %d", h.Number)
45		}
46		if h.Number.Uint64() == 0 {
47			break
48		}
49		h = hc.GetHeader(h.ParentHash, h.Number.Uint64()-1)
50	}
51	return nil
52}
53
54func testInsert(t *testing.T, hc *HeaderChain, chain []*types.Header, wantStatus WriteStatus, wantErr error, forker *ForkChoice) {
55	t.Helper()
56
57	status, err := hc.InsertHeaderChain(chain, time.Now(), forker)
58	if status != wantStatus {
59		t.Errorf("wrong write status from InsertHeaderChain: got %v, want %v", status, wantStatus)
60	}
61	// Always verify that the header chain is unbroken
62	if err := verifyUnbrokenCanonchain(hc); err != nil {
63		t.Fatal(err)
64	}
65	if !errors.Is(err, wantErr) {
66		t.Fatalf("unexpected error from InsertHeaderChain: %v", err)
67	}
68}
69
70// This test checks status reporting of InsertHeaderChain.
71func TestHeaderInsertion(t *testing.T) {
72	var (
73		db      = rawdb.NewMemoryDatabase()
74		genesis = (&Genesis{BaseFee: big.NewInt(params.InitialBaseFee)}).MustCommit(db)
75	)
76
77	hc, err := NewHeaderChain(db, params.AllEthashProtocolChanges, ethash.NewFaker(), func() bool { return false })
78	if err != nil {
79		t.Fatal(err)
80	}
81	// chain A: G->A1->A2...A128
82	chainA := makeHeaderChain(genesis.Header(), 128, ethash.NewFaker(), db, 10)
83	// chain B: G->A1->B1...B128
84	chainB := makeHeaderChain(chainA[0], 128, ethash.NewFaker(), db, 10)
85	log.Root().SetHandler(log.StdoutHandler)
86
87	forker := NewForkChoice(hc, nil)
88	// Inserting 64 headers on an empty chain, expecting
89	// 1 callbacks, 1 canon-status, 0 sidestatus,
90	testInsert(t, hc, chainA[:64], CanonStatTy, nil, forker)
91
92	// Inserting 64 identical headers, expecting
93	// 0 callbacks, 0 canon-status, 0 sidestatus,
94	testInsert(t, hc, chainA[:64], NonStatTy, nil, forker)
95
96	// Inserting the same some old, some new headers
97	// 1 callbacks, 1 canon, 0 side
98	testInsert(t, hc, chainA[32:96], CanonStatTy, nil, forker)
99
100	// Inserting side blocks, but not overtaking the canon chain
101	testInsert(t, hc, chainB[0:32], SideStatTy, nil, forker)
102
103	// Inserting more side blocks, but we don't have the parent
104	testInsert(t, hc, chainB[34:36], NonStatTy, consensus.ErrUnknownAncestor, forker)
105
106	// Inserting more sideblocks, overtaking the canon chain
107	testInsert(t, hc, chainB[32:97], CanonStatTy, nil, forker)
108
109	// Inserting more A-headers, taking back the canonicality
110	testInsert(t, hc, chainA[90:100], CanonStatTy, nil, forker)
111
112	// And B becomes canon again
113	testInsert(t, hc, chainB[97:107], CanonStatTy, nil, forker)
114
115	// And B becomes even longer
116	testInsert(t, hc, chainB[107:128], CanonStatTy, nil, forker)
117}
118