1// Copyright 2016 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 light
18
19import (
20	"bytes"
21	"context"
22	"errors"
23	"math/big"
24	"testing"
25	"time"
26
27	"github.com/ethereum/go-ethereum/common"
28	"github.com/ethereum/go-ethereum/common/math"
29	"github.com/ethereum/go-ethereum/consensus/ethash"
30	"github.com/ethereum/go-ethereum/core"
31	"github.com/ethereum/go-ethereum/core/rawdb"
32	"github.com/ethereum/go-ethereum/core/state"
33	"github.com/ethereum/go-ethereum/core/types"
34	"github.com/ethereum/go-ethereum/core/vm"
35	"github.com/ethereum/go-ethereum/crypto"
36	"github.com/ethereum/go-ethereum/ethdb"
37	"github.com/ethereum/go-ethereum/params"
38	"github.com/ethereum/go-ethereum/rlp"
39	"github.com/ethereum/go-ethereum/trie"
40)
41
42var (
43	testBankKey, _  = crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")
44	testBankAddress = crypto.PubkeyToAddress(testBankKey.PublicKey)
45	testBankFunds   = big.NewInt(1_000_000_000_000_000_000)
46
47	acc1Key, _ = crypto.HexToECDSA("8a1f9a8f95be41cd7ccb6168179afb4504aefe388d1e14474d32c45c72ce7b7a")
48	acc2Key, _ = crypto.HexToECDSA("49a7b37aa6f6645917e7b807e9d1c00d4fa71f18343b0d4122a4d2df64dd6fee")
49	acc1Addr   = crypto.PubkeyToAddress(acc1Key.PublicKey)
50	acc2Addr   = crypto.PubkeyToAddress(acc2Key.PublicKey)
51
52	testContractCode = common.Hex2Bytes("606060405260cc8060106000396000f360606040526000357c01000000000000000000000000000000000000000000000000000000009004806360cd2685146041578063c16431b914606b57603f565b005b6055600480803590602001909190505060a9565b6040518082815260200191505060405180910390f35b60886004808035906020019091908035906020019091905050608a565b005b80600060005083606481101560025790900160005b50819055505b5050565b6000600060005082606481101560025790900160005b5054905060c7565b91905056")
53	testContractAddr common.Address
54)
55
56type testOdr struct {
57	OdrBackend
58	indexerConfig *IndexerConfig
59	sdb, ldb      ethdb.Database
60	disable       bool
61}
62
63func (odr *testOdr) Database() ethdb.Database {
64	return odr.ldb
65}
66
67var ErrOdrDisabled = errors.New("ODR disabled")
68
69func (odr *testOdr) Retrieve(ctx context.Context, req OdrRequest) error {
70	if odr.disable {
71		return ErrOdrDisabled
72	}
73	switch req := req.(type) {
74	case *BlockRequest:
75		number := rawdb.ReadHeaderNumber(odr.sdb, req.Hash)
76		if number != nil {
77			req.Rlp = rawdb.ReadBodyRLP(odr.sdb, req.Hash, *number)
78		}
79	case *ReceiptsRequest:
80		number := rawdb.ReadHeaderNumber(odr.sdb, req.Hash)
81		if number != nil {
82			req.Receipts = rawdb.ReadRawReceipts(odr.sdb, req.Hash, *number)
83		}
84	case *TrieRequest:
85		t, _ := trie.New(req.Id.Root, trie.NewDatabase(odr.sdb))
86		nodes := NewNodeSet()
87		t.Prove(req.Key, 0, nodes)
88		req.Proof = nodes
89	case *CodeRequest:
90		req.Data = rawdb.ReadCode(odr.sdb, req.Hash)
91	}
92	req.StoreResult(odr.ldb)
93	return nil
94}
95
96func (odr *testOdr) IndexerConfig() *IndexerConfig {
97	return odr.indexerConfig
98}
99
100type odrTestFn func(ctx context.Context, db ethdb.Database, bc *core.BlockChain, lc *LightChain, bhash common.Hash) ([]byte, error)
101
102func TestOdrGetBlockLes2(t *testing.T) { testChainOdr(t, 1, odrGetBlock) }
103
104func odrGetBlock(ctx context.Context, db ethdb.Database, bc *core.BlockChain, lc *LightChain, bhash common.Hash) ([]byte, error) {
105	var block *types.Block
106	if bc != nil {
107		block = bc.GetBlockByHash(bhash)
108	} else {
109		block, _ = lc.GetBlockByHash(ctx, bhash)
110	}
111	if block == nil {
112		return nil, nil
113	}
114	rlp, _ := rlp.EncodeToBytes(block)
115	return rlp, nil
116}
117
118func TestOdrGetReceiptsLes2(t *testing.T) { testChainOdr(t, 1, odrGetReceipts) }
119
120func odrGetReceipts(ctx context.Context, db ethdb.Database, bc *core.BlockChain, lc *LightChain, bhash common.Hash) ([]byte, error) {
121	var receipts types.Receipts
122	if bc != nil {
123		number := rawdb.ReadHeaderNumber(db, bhash)
124		if number != nil {
125			receipts = rawdb.ReadReceipts(db, bhash, *number, bc.Config())
126		}
127	} else {
128		number := rawdb.ReadHeaderNumber(db, bhash)
129		if number != nil {
130			receipts, _ = GetBlockReceipts(ctx, lc.Odr(), bhash, *number)
131		}
132	}
133	if receipts == nil {
134		return nil, nil
135	}
136	rlp, _ := rlp.EncodeToBytes(receipts)
137	return rlp, nil
138}
139
140func TestOdrAccountsLes2(t *testing.T) { testChainOdr(t, 1, odrAccounts) }
141
142func odrAccounts(ctx context.Context, db ethdb.Database, bc *core.BlockChain, lc *LightChain, bhash common.Hash) ([]byte, error) {
143	dummyAddr := common.HexToAddress("1234567812345678123456781234567812345678")
144	acc := []common.Address{testBankAddress, acc1Addr, acc2Addr, dummyAddr}
145
146	var st *state.StateDB
147	if bc == nil {
148		header := lc.GetHeaderByHash(bhash)
149		st = NewState(ctx, header, lc.Odr())
150	} else {
151		header := bc.GetHeaderByHash(bhash)
152		st, _ = state.New(header.Root, state.NewDatabase(db), nil)
153	}
154
155	var res []byte
156	for _, addr := range acc {
157		bal := st.GetBalance(addr)
158		rlp, _ := rlp.EncodeToBytes(bal)
159		res = append(res, rlp...)
160	}
161	return res, st.Error()
162}
163
164func TestOdrContractCallLes2(t *testing.T) { testChainOdr(t, 1, odrContractCall) }
165
166type callmsg struct {
167	types.Message
168}
169
170func (callmsg) CheckNonce() bool { return false }
171
172func odrContractCall(ctx context.Context, db ethdb.Database, bc *core.BlockChain, lc *LightChain, bhash common.Hash) ([]byte, error) {
173	data := common.Hex2Bytes("60CD26850000000000000000000000000000000000000000000000000000000000000000")
174	config := params.TestChainConfig
175
176	var res []byte
177	for i := 0; i < 3; i++ {
178		data[35] = byte(i)
179
180		var (
181			st     *state.StateDB
182			header *types.Header
183			chain  core.ChainContext
184		)
185		if bc == nil {
186			chain = lc
187			header = lc.GetHeaderByHash(bhash)
188			st = NewState(ctx, header, lc.Odr())
189		} else {
190			chain = bc
191			header = bc.GetHeaderByHash(bhash)
192			st, _ = state.New(header.Root, state.NewDatabase(db), nil)
193		}
194
195		// Perform read-only call.
196		st.SetBalance(testBankAddress, math.MaxBig256)
197		msg := callmsg{types.NewMessage(testBankAddress, &testContractAddr, 0, new(big.Int), 1000000, big.NewInt(params.InitialBaseFee), big.NewInt(params.InitialBaseFee), new(big.Int), data, nil, true)}
198		txContext := core.NewEVMTxContext(msg)
199		context := core.NewEVMBlockContext(header, chain, nil)
200		vmenv := vm.NewEVM(context, txContext, st, config, vm.Config{NoBaseFee: true})
201		gp := new(core.GasPool).AddGas(math.MaxUint64)
202		result, _ := core.ApplyMessage(vmenv, msg, gp)
203		res = append(res, result.Return()...)
204		if st.Error() != nil {
205			return res, st.Error()
206		}
207	}
208	return res, nil
209}
210
211func testChainGen(i int, block *core.BlockGen) {
212	signer := types.HomesteadSigner{}
213	switch i {
214	case 0:
215		// In block 1, the test bank sends account #1 some ether.
216		tx, _ := types.SignTx(types.NewTransaction(block.TxNonce(testBankAddress), acc1Addr, big.NewInt(10_000_000_000_000_000), params.TxGas, block.BaseFee(), nil), signer, testBankKey)
217		block.AddTx(tx)
218	case 1:
219		// In block 2, the test bank sends some more ether to account #1.
220		// acc1Addr passes it on to account #2.
221		// acc1Addr creates a test contract.
222		tx1, _ := types.SignTx(types.NewTransaction(block.TxNonce(testBankAddress), acc1Addr, big.NewInt(1_000_000_000_000_000), params.TxGas, block.BaseFee(), nil), signer, testBankKey)
223		nonce := block.TxNonce(acc1Addr)
224		tx2, _ := types.SignTx(types.NewTransaction(nonce, acc2Addr, big.NewInt(1_000_000_000_000_000), params.TxGas, block.BaseFee(), nil), signer, acc1Key)
225		nonce++
226		tx3, _ := types.SignTx(types.NewContractCreation(nonce, big.NewInt(0), 1000000, block.BaseFee(), testContractCode), signer, acc1Key)
227		testContractAddr = crypto.CreateAddress(acc1Addr, nonce)
228		block.AddTx(tx1)
229		block.AddTx(tx2)
230		block.AddTx(tx3)
231	case 2:
232		// Block 3 is empty but was mined by account #2.
233		block.SetCoinbase(acc2Addr)
234		block.SetExtra([]byte("yeehaw"))
235		data := common.Hex2Bytes("C16431B900000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000001")
236		tx, _ := types.SignTx(types.NewTransaction(block.TxNonce(testBankAddress), testContractAddr, big.NewInt(0), 100000, block.BaseFee(), data), signer, testBankKey)
237		block.AddTx(tx)
238	case 3:
239		// Block 4 includes blocks 2 and 3 as uncle headers (with modified extra data).
240		b2 := block.PrevBlock(1).Header()
241		b2.Extra = []byte("foo")
242		block.AddUncle(b2)
243		b3 := block.PrevBlock(2).Header()
244		b3.Extra = []byte("foo")
245		block.AddUncle(b3)
246		data := common.Hex2Bytes("C16431B900000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000002")
247		tx, _ := types.SignTx(types.NewTransaction(block.TxNonce(testBankAddress), testContractAddr, big.NewInt(0), 100000, block.BaseFee(), data), signer, testBankKey)
248		block.AddTx(tx)
249	}
250}
251
252func testChainOdr(t *testing.T, protocol int, fn odrTestFn) {
253	var (
254		sdb   = rawdb.NewMemoryDatabase()
255		ldb   = rawdb.NewMemoryDatabase()
256		gspec = core.Genesis{
257			Alloc:   core.GenesisAlloc{testBankAddress: {Balance: testBankFunds}},
258			BaseFee: big.NewInt(params.InitialBaseFee),
259		}
260		genesis = gspec.MustCommit(sdb)
261	)
262	gspec.MustCommit(ldb)
263	// Assemble the test environment
264	blockchain, _ := core.NewBlockChain(sdb, nil, params.TestChainConfig, ethash.NewFullFaker(), vm.Config{}, nil, nil)
265	gchain, _ := core.GenerateChain(params.TestChainConfig, genesis, ethash.NewFaker(), sdb, 4, testChainGen)
266	if _, err := blockchain.InsertChain(gchain); err != nil {
267		t.Fatal(err)
268	}
269
270	odr := &testOdr{sdb: sdb, ldb: ldb, indexerConfig: TestClientIndexerConfig}
271	lightchain, err := NewLightChain(odr, params.TestChainConfig, ethash.NewFullFaker(), nil)
272	if err != nil {
273		t.Fatal(err)
274	}
275	headers := make([]*types.Header, len(gchain))
276	for i, block := range gchain {
277		headers[i] = block.Header()
278	}
279	if _, err := lightchain.InsertHeaderChain(headers, 1); err != nil {
280		t.Fatal(err)
281	}
282
283	test := func(expFail int) {
284		for i := uint64(0); i <= blockchain.CurrentHeader().Number.Uint64(); i++ {
285			bhash := rawdb.ReadCanonicalHash(sdb, i)
286			b1, err := fn(NoOdr, sdb, blockchain, nil, bhash)
287			if err != nil {
288				t.Fatalf("error in full-node test for block %d: %v", i, err)
289			}
290
291			ctx, cancel := context.WithTimeout(context.Background(), 200*time.Millisecond)
292			defer cancel()
293
294			exp := i < uint64(expFail)
295			b2, err := fn(ctx, ldb, nil, lightchain, bhash)
296			if err != nil && exp {
297				t.Errorf("error in ODR test for block %d: %v", i, err)
298			}
299
300			eq := bytes.Equal(b1, b2)
301			if exp && !eq {
302				t.Errorf("ODR test output for block %d doesn't match full node", i)
303			}
304		}
305	}
306
307	// expect retrievals to fail (except genesis block) without a les peer
308	t.Log("checking without ODR")
309	odr.disable = true
310	test(1)
311
312	// expect all retrievals to pass with ODR enabled
313	t.Log("checking with ODR")
314	odr.disable = false
315	test(len(gchain))
316
317	// still expect all retrievals to pass, now data should be cached locally
318	t.Log("checking without ODR, should be cached")
319	odr.disable = true
320	test(len(gchain))
321}
322