github.com/60ke/go-ethereum@v1.10.2/core/headerchain_test.go (about)

     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  
    17  package core
    18  
    19  import (
    20  	"errors"
    21  	"fmt"
    22  	"testing"
    23  	"time"
    24  
    25  	"github.com/ethereum/go-ethereum/consensus"
    26  	"github.com/ethereum/go-ethereum/consensus/ethash"
    27  	"github.com/ethereum/go-ethereum/core/rawdb"
    28  	"github.com/ethereum/go-ethereum/core/types"
    29  	"github.com/ethereum/go-ethereum/log"
    30  	"github.com/ethereum/go-ethereum/params"
    31  )
    32  
    33  func verifyUnbrokenCanonchain(hc *HeaderChain) error {
    34  	h := hc.CurrentHeader()
    35  	for {
    36  		canonHash := rawdb.ReadCanonicalHash(hc.chainDb, h.Number.Uint64())
    37  		if exp := h.Hash(); canonHash != exp {
    38  			return fmt.Errorf("Canon hash chain broken, block %d got %x, expected %x",
    39  				h.Number, canonHash[:8], exp[:8])
    40  		}
    41  		// Verify that we have the TD
    42  		if td := rawdb.ReadTd(hc.chainDb, canonHash, h.Number.Uint64()); td == nil {
    43  			return fmt.Errorf("Canon TD missing at block %d", h.Number)
    44  		}
    45  		if h.Number.Uint64() == 0 {
    46  			break
    47  		}
    48  		h = hc.GetHeader(h.ParentHash, h.Number.Uint64()-1)
    49  	}
    50  	return nil
    51  }
    52  
    53  func testInsert(t *testing.T, hc *HeaderChain, chain []*types.Header, wantStatus WriteStatus, wantErr error) {
    54  	t.Helper()
    55  
    56  	status, err := hc.InsertHeaderChain(chain, time.Now())
    57  	if status != wantStatus {
    58  		t.Errorf("wrong write status from InsertHeaderChain: got %v, want %v", status, wantStatus)
    59  	}
    60  	// Always verify that the header chain is unbroken
    61  	if err := verifyUnbrokenCanonchain(hc); err != nil {
    62  		t.Fatal(err)
    63  	}
    64  	if !errors.Is(err, wantErr) {
    65  		t.Fatalf("unexpected error from InsertHeaderChain: %v", err)
    66  	}
    67  }
    68  
    69  // This test checks status reporting of InsertHeaderChain.
    70  func TestHeaderInsertion(t *testing.T) {
    71  	var (
    72  		db      = rawdb.NewMemoryDatabase()
    73  		genesis = new(Genesis).MustCommit(db)
    74  	)
    75  
    76  	hc, err := NewHeaderChain(db, params.AllEthashProtocolChanges, ethash.NewFaker(), func() bool { return false })
    77  	if err != nil {
    78  		t.Fatal(err)
    79  	}
    80  	// chain A: G->A1->A2...A128
    81  	chainA := makeHeaderChain(genesis.Header(), 128, ethash.NewFaker(), db, 10)
    82  	// chain B: G->A1->B2...B128
    83  	chainB := makeHeaderChain(chainA[0], 128, ethash.NewFaker(), db, 10)
    84  	log.Root().SetHandler(log.StdoutHandler)
    85  
    86  	// Inserting 64 headers on an empty chain, expecting
    87  	// 1 callbacks, 1 canon-status, 0 sidestatus,
    88  	testInsert(t, hc, chainA[:64], CanonStatTy, nil)
    89  
    90  	// Inserting 64 identical headers, expecting
    91  	// 0 callbacks, 0 canon-status, 0 sidestatus,
    92  	testInsert(t, hc, chainA[:64], NonStatTy, nil)
    93  
    94  	// Inserting the same some old, some new headers
    95  	// 1 callbacks, 1 canon, 0 side
    96  	testInsert(t, hc, chainA[32:96], CanonStatTy, nil)
    97  
    98  	// Inserting side blocks, but not overtaking the canon chain
    99  	testInsert(t, hc, chainB[0:32], SideStatTy, nil)
   100  
   101  	// Inserting more side blocks, but we don't have the parent
   102  	testInsert(t, hc, chainB[34:36], NonStatTy, consensus.ErrUnknownAncestor)
   103  
   104  	// Inserting more sideblocks, overtaking the canon chain
   105  	testInsert(t, hc, chainB[32:97], CanonStatTy, nil)
   106  
   107  	// Inserting more A-headers, taking back the canonicality
   108  	testInsert(t, hc, chainA[90:100], CanonStatTy, nil)
   109  
   110  	// And B becomes canon again
   111  	testInsert(t, hc, chainB[97:107], CanonStatTy, nil)
   112  
   113  	// And B becomes even longer
   114  	testInsert(t, hc, chainB[107:128], CanonStatTy, nil)
   115  }