github.com/SmartMeshFoundation/Spectrum@v0.0.0-20220621030607-452a266fee1e/les/request_test.go (about)

     1  // Copyright 2016 The Spectrum Authors
     2  // This file is part of the Spectrum library.
     3  //
     4  // The Spectrum 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 Spectrum 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 Spectrum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package les
    18  
    19  import (
    20  	"context"
    21  	"testing"
    22  	"time"
    23  
    24  	"github.com/SmartMeshFoundation/Spectrum/common"
    25  	"github.com/SmartMeshFoundation/Spectrum/core"
    26  	"github.com/SmartMeshFoundation/Spectrum/crypto"
    27  	"github.com/SmartMeshFoundation/Spectrum/eth"
    28  	"github.com/SmartMeshFoundation/Spectrum/ethdb"
    29  	"github.com/SmartMeshFoundation/Spectrum/light"
    30  )
    31  
    32  var testBankSecureTrieKey = secAddr(testBankAddress)
    33  
    34  func secAddr(addr common.Address) []byte {
    35  	return crypto.Keccak256(addr[:])
    36  }
    37  
    38  type accessTestFn func(db ethdb.Database, bhash common.Hash, number uint64) light.OdrRequest
    39  
    40  func TestBlockAccessLes1(t *testing.T) { testAccess(t, 1, tfBlockAccess) }
    41  
    42  func TestBlockAccessLes2(t *testing.T) { testAccess(t, 2, tfBlockAccess) }
    43  
    44  func tfBlockAccess(db ethdb.Database, bhash common.Hash, number uint64) light.OdrRequest {
    45  	return &light.BlockRequest{Hash: bhash, Number: number}
    46  }
    47  
    48  func TestReceiptsAccessLes1(t *testing.T) { testAccess(t, 1, tfReceiptsAccess) }
    49  
    50  func TestReceiptsAccessLes2(t *testing.T) { testAccess(t, 2, tfReceiptsAccess) }
    51  
    52  func tfReceiptsAccess(db ethdb.Database, bhash common.Hash, number uint64) light.OdrRequest {
    53  	return &light.ReceiptsRequest{Hash: bhash, Number: number}
    54  }
    55  
    56  func TestTrieEntryAccessLes1(t *testing.T) { testAccess(t, 1, tfTrieEntryAccess) }
    57  
    58  func TestTrieEntryAccessLes2(t *testing.T) { testAccess(t, 2, tfTrieEntryAccess) }
    59  
    60  func tfTrieEntryAccess(db ethdb.Database, bhash common.Hash, number uint64) light.OdrRequest {
    61  	return &light.TrieRequest{Id: light.StateTrieID(core.GetHeader(db, bhash, core.GetBlockNumber(db, bhash))), Key: testBankSecureTrieKey}
    62  }
    63  
    64  func TestCodeAccessLes1(t *testing.T) { testAccess(t, 1, tfCodeAccess) }
    65  
    66  func TestCodeAccessLes2(t *testing.T) { testAccess(t, 2, tfCodeAccess) }
    67  
    68  func tfCodeAccess(db ethdb.Database, bhash common.Hash, number uint64) light.OdrRequest {
    69  	header := core.GetHeader(db, bhash, core.GetBlockNumber(db, bhash))
    70  	if header.Number.Uint64() < testContractDeployed {
    71  		return nil
    72  	}
    73  	sti := light.StateTrieID(header)
    74  	ci := light.StorageTrieID(sti, crypto.Keccak256Hash(testContractAddr[:]), common.Hash{})
    75  	return &light.CodeRequest{Id: ci, Hash: crypto.Keccak256Hash(testContractCodeDeployed)}
    76  }
    77  
    78  func testAccess(t *testing.T, protocol int, fn accessTestFn) {
    79  	// Assemble the test environment
    80  	peers := newPeerSet()
    81  	dist := newRequestDistributor(peers, make(chan struct{}))
    82  	rm := newRetrieveManager(peers, dist, nil)
    83  	db, _ := ethdb.NewMemDatabase()
    84  	ldb, _ := ethdb.NewMemDatabase()
    85  	odr := NewLesOdr(ldb, light.NewChtIndexer(db, true), light.NewBloomTrieIndexer(db, true), eth.NewBloomIndexer(db, light.BloomTrieFrequency), rm)
    86  
    87  	pm := newTestProtocolManagerMust(t, false, 4, testChainGen, nil, nil, db)
    88  	lpm := newTestProtocolManagerMust(t, true, 0, nil, peers, odr, ldb)
    89  	_, err1, lpeer, err2 := newTestPeerPair("peer", protocol, pm, lpm)
    90  	select {
    91  	case <-time.After(time.Millisecond * 100):
    92  	case err := <-err1:
    93  		t.Fatalf("peer 1 handshake error: %v", err)
    94  	case err := <-err2:
    95  		t.Fatalf("peer 1 handshake error: %v", err)
    96  	}
    97  
    98  	lpm.synchronise(lpeer)
    99  
   100  	test := func(expFail uint64) {
   101  		for i := uint64(0); i <= pm.blockchain.CurrentHeader().Number.Uint64(); i++ {
   102  			bhash := core.GetCanonicalHash(db, i)
   103  			if req := fn(ldb, bhash, i); req != nil {
   104  				ctx, cancel := context.WithTimeout(context.Background(), 200*time.Millisecond)
   105  				defer cancel()
   106  
   107  				err := odr.Retrieve(ctx, req)
   108  				got := err == nil
   109  				exp := i < expFail
   110  				if exp && !got {
   111  					t.Errorf("object retrieval failed")
   112  				}
   113  				if !exp && got {
   114  					t.Errorf("unexpected object retrieval success")
   115  				}
   116  			}
   117  		}
   118  	}
   119  
   120  	// temporarily remove peer to test odr fails
   121  	peers.Unregister(lpeer.id)
   122  	time.Sleep(time.Millisecond * 10) // ensure that all peerSetNotify callbacks are executed
   123  	// expect retrievals to fail (except genesis block) without a les peer
   124  	test(0)
   125  
   126  	peers.Register(lpeer)
   127  	time.Sleep(time.Millisecond * 10) // ensure that all peerSetNotify callbacks are executed
   128  	lpeer.lock.Lock()
   129  	lpeer.hasBlock = func(common.Hash, uint64) bool { return true }
   130  	lpeer.lock.Unlock()
   131  	// expect all retrievals to pass
   132  	test(5)
   133  }