geth/core/rawdb/accessors_indexes_test.go

// Copyright 2018 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library 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.
//
// The go-ethereum library 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 the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package rawdb

import (
	"errors"
	"math/big"
	"testing"

	"github.com/davecgh/go-spew/spew"
	"github.com/holiman/uint256"
	"github.com/luxfi/geth/common"
	"github.com/luxfi/geth/core/types"
	"github.com/luxfi/geth/ethdb"
	"github.com/luxfi/geth/internal/blocktest"
	"github.com/luxfi/geth/rlp"
)

var newTestHasher = blocktest.NewHasher

// Tests that positional lookup metadata can be stored and retrieved.
func TestLookupStorage(t *testing.T) {
	tests := []struct {
		name                        string
		writeTxLookupEntriesByBlock func(ethdb.KeyValueWriter, *types.Block)
	}{
		{
			"DatabaseV6",
			func(db ethdb.KeyValueWriter, block *types.Block) {
				WriteTxLookupEntriesByBlock(db, block)
			},
		},
		{
			"DatabaseV4-V5",
			func(db ethdb.KeyValueWriter, block *types.Block) {
				for _, tx := range block.Transactions() {
					db.Put(txLookupKey(tx.Hash()), block.Hash().Bytes())
				}
			},
		},
		{
			"DatabaseV3",
			func(db ethdb.KeyValueWriter, block *types.Block) {
				for index, tx := range block.Transactions() {
					entry := LegacyTxLookupEntry{
						BlockHash:  block.Hash(),
						BlockIndex: block.NumberU64(),
						Index:      uint64(index),
					}
					data, _ := rlp.EncodeToBytes(entry)
					db.Put(txLookupKey(tx.Hash()), data)
				}
			},
		},
	}

	for _, tc := range tests {
		t.Run(tc.name, func(t *testing.T) {
			db := NewMemoryDatabase()

			tx1 := types.NewTransaction(1, common.BytesToAddress([]byte{0x11}), big.NewInt(111), 1111, big.NewInt(11111), []byte{0x11, 0x11, 0x11})
			tx2 := types.NewTransaction(2, common.BytesToAddress([]byte{0x22}), big.NewInt(222), 2222, big.NewInt(22222), []byte{0x22, 0x22, 0x22})
			tx3 := types.NewTransaction(3, common.BytesToAddress([]byte{0x33}), big.NewInt(333), 3333, big.NewInt(33333), []byte{0x33, 0x33, 0x33})
			tx4 := types.NewTx(&types.DynamicFeeTx{
				To:        new(common.Address),
				Nonce:     5,
				Value:     big.NewInt(5),
				Gas:       5,
				GasTipCap: big.NewInt(55),
				GasFeeCap: big.NewInt(1055),
			})
			txs := []*types.Transaction{tx1, tx2, tx3, tx4}

			block := types.NewBlock(&types.Header{Number: big.NewInt(314)}, &types.Body{Transactions: txs}, nil, newTestHasher())

			// Check that no transactions entries are in a pristine database
			for i, tx := range txs {
				if txn, _, _, _ := ReadCanonicalTransaction(db, tx.Hash()); txn != nil {
					t.Fatalf("tx #%d [%x]: non existent transaction returned: %v", i, tx.Hash(), txn)
				}
			}
			// Insert all the transactions into the database, and verify contents
			WriteCanonicalHash(db, block.Hash(), block.NumberU64())
			WriteBlock(db, block)
			tc.writeTxLookupEntriesByBlock(db, block)

			for i, tx := range txs {
				if txn, hash, number, index := ReadCanonicalTransaction(db, tx.Hash()); txn == nil {
					t.Fatalf("tx #%d [%x]: transaction not found", i, tx.Hash())
				} else {
					if hash != block.Hash() || number != block.NumberU64() || index != uint64(i) {
						t.Fatalf("tx #%d [%x]: positional metadata mismatch: have %x/%d/%d, want %x/%v/%v", i, tx.Hash(), hash, number, index, block.Hash(), block.NumberU64(), i)
					}
					if tx.Hash() != txn.Hash() {
						t.Fatalf("tx #%d [%x]: transaction mismatch: have %v, want %v", i, tx.Hash(), txn, tx)
					}
				}
			}
			// Delete the transactions and check purge
			for i, tx := range txs {
				DeleteTxLookupEntry(db, tx.Hash())
				if txn, _, _, _ := ReadCanonicalTransaction(db, tx.Hash()); txn != nil {
					t.Fatalf("tx #%d [%x]: deleted transaction returned: %v", i, tx.Hash(), txn)
				}
			}
		})
	}
}

func TestFindTxInBlockBody(t *testing.T) {
	tx1 := types.NewTx(&types.LegacyTx{
		Nonce:    1,
		GasPrice: big.NewInt(1),
		Gas:      1,
		To:       new(common.Address),
		Value:    big.NewInt(5),
		Data:     []byte{0x11, 0x11, 0x11},
	})
	tx2 := types.NewTx(&types.AccessListTx{
		Nonce:    1,
		GasPrice: big.NewInt(1),
		Gas:      1,
		To:       new(common.Address),
		Value:    big.NewInt(5),
		Data:     []byte{0x11, 0x11, 0x11},
		AccessList: []types.AccessTuple{
			{
				Address:     common.Address{0x1},
				StorageKeys: []common.Hash{{0x1}, {0x2}},
			},
		},
	})
	tx3 := types.NewTx(&types.DynamicFeeTx{
		Nonce:     1,
		Gas:       1,
		To:        new(common.Address),
		Value:     big.NewInt(5),
		Data:      []byte{0x11, 0x11, 0x11},
		GasTipCap: big.NewInt(55),
		GasFeeCap: big.NewInt(1055),
		AccessList: []types.AccessTuple{
			{
				Address:     common.Address{0x1},
				StorageKeys: []common.Hash{{0x1}, {0x2}},
			},
		},
	})
	tx4 := types.NewTx(&types.BlobTx{
		Nonce:     1,
		Gas:       1,
		To:        common.Address{0x1},
		Value:     uint256.NewInt(5),
		Data:      []byte{0x11, 0x11, 0x11},
		GasTipCap: uint256.NewInt(55),
		GasFeeCap: uint256.NewInt(1055),
		AccessList: []types.AccessTuple{
			{
				Address:     common.Address{0x1},
				StorageKeys: []common.Hash{{0x1}, {0x2}},
			},
		},
		BlobFeeCap: uint256.NewInt(1),
		BlobHashes: []common.Hash{{0x1}, {0x2}},
	})
	tx5 := types.NewTx(&types.SetCodeTx{
		Nonce:     1,
		Gas:       1,
		To:        common.Address{0x1},
		Value:     uint256.NewInt(5),
		Data:      []byte{0x11, 0x11, 0x11},
		GasTipCap: uint256.NewInt(55),
		GasFeeCap: uint256.NewInt(1055),
		AccessList: []types.AccessTuple{
			{
				Address:     common.Address{0x1},
				StorageKeys: []common.Hash{{0x1}, {0x2}},
			},
		},
		AuthList: []types.SetCodeAuthorization{
			{
				ChainID: uint256.Int{1},
				Address: common.Address{0x1},
			},
		},
	})

	txs := []*types.Transaction{tx1, tx2, tx3, tx4, tx5}

	block := types.NewBlock(&types.Header{Number: big.NewInt(314)}, &types.Body{Transactions: txs}, nil, newTestHasher())
	db := NewMemoryDatabase()
	WriteBlock(db, block)

	rlp := ReadBodyRLP(db, block.Hash(), block.NumberU64())
	for i := 0; i < len(txs); i++ {
		tx, txIndex, err := findTxInBlockBody(rlp, txs[i].Hash())
		if err != nil {
			t.Fatalf("Failed to retrieve tx, err: %v", err)
		}
		if txIndex != uint64(i) {
			t.Fatalf("Unexpected transaction index, want: %d, got: %d", i, txIndex)
		}
		if tx.Hash() != txs[i].Hash() {
			want := spew.Sdump(txs[i])
			got := spew.Sdump(tx)
			t.Fatalf("Unexpected transaction, want: %s, got: %s", want, got)
		}
	}
}

func TestExtractReceiptFields(t *testing.T) {
	receiptWithPostState := types.ReceiptForStorage(types.Receipt{
		Type:              types.LegacyTxType,
		PostState:         []byte{0x1, 0x2, 0x3},
		CumulativeGasUsed: 100,
	})
	receiptWithPostStateBlob, _ := rlp.EncodeToBytes(&receiptWithPostState)

	receiptNoLogs := types.ReceiptForStorage(types.Receipt{
		Type:              types.LegacyTxType,
		Status:            types.ReceiptStatusSuccessful,
		CumulativeGasUsed: 100,
	})
	receiptNoLogBlob, _ := rlp.EncodeToBytes(&receiptNoLogs)

	receiptWithLogs := types.ReceiptForStorage(types.Receipt{
		Type:              types.LegacyTxType,
		Status:            types.ReceiptStatusSuccessful,
		CumulativeGasUsed: 100,
		Logs: []*types.Log{
			{
				Address: common.BytesToAddress([]byte{0x1}),
				Topics: []common.Hash{
					common.BytesToHash([]byte{0x1}),
				},
				Data: []byte{0x1},
			},
			{
				Address: common.BytesToAddress([]byte{0x2}),
				Topics: []common.Hash{
					common.BytesToHash([]byte{0x2}),
				},
				Data: []byte{0x2},
			},
		},
	})
	receiptWithLogBlob, _ := rlp.EncodeToBytes(&receiptWithLogs)

	invalidReceipt := types.ReceiptForStorage(types.Receipt{
		Type:              types.LegacyTxType,
		Status:            types.ReceiptStatusSuccessful,
		CumulativeGasUsed: 100,
	})
	invalidReceiptBlob, _ := rlp.EncodeToBytes(&invalidReceipt)
	invalidReceiptBlob[len(invalidReceiptBlob)-1] = 0xf

	var cases = []struct {
		logs       rlp.RawValue
		expErr     error
		expGasUsed uint64
		expLogs    uint
	}{
		{receiptWithPostStateBlob, nil, 100, 0},
		{receiptNoLogBlob, nil, 100, 0},
		{receiptWithLogBlob, nil, 100, 2},
		{invalidReceiptBlob, rlp.ErrExpectedList, 100, 0},
	}
	for _, c := range cases {
		gasUsed, logs, err := extractReceiptFields(c.logs)
		if c.expErr != nil {
			if !errors.Is(err, c.expErr) {
				t.Fatalf("Unexpected error, want: %v, got: %v", c.expErr, err)
			}
		} else {
			if err != nil {
				t.Fatalf("Unexpected error %v", err)
			}
			if gasUsed != c.expGasUsed {
				t.Fatalf("Unexpected gas used, want %d, got %d", c.expGasUsed, gasUsed)
			}
			if logs != c.expLogs {
				t.Fatalf("Unexpected logs, want %d, got %d", c.expLogs, logs)
			}
		}
	}
}