erigon-pulse/migrations/receipt_repair.go

package migrations

import (
	"bytes"
	"context"
	"encoding/binary"
	"fmt"
	"time"

	"github.com/ledgerwatch/erigon/common"
	"github.com/ledgerwatch/erigon/common/dbutils"
	"github.com/ledgerwatch/erigon/common/etl"
	"github.com/ledgerwatch/erigon/consensus/ethash"
	"github.com/ledgerwatch/erigon/consensus/misc"
	"github.com/ledgerwatch/erigon/core"
	"github.com/ledgerwatch/erigon/core/rawdb"
	"github.com/ledgerwatch/erigon/core/state"
	"github.com/ledgerwatch/erigon/core/types"
	"github.com/ledgerwatch/erigon/core/vm"
	"github.com/ledgerwatch/erigon/ethdb"
	"github.com/ledgerwatch/erigon/ethdb/cbor"
	"github.com/ledgerwatch/erigon/log"
	"github.com/ledgerwatch/erigon/params"
)

var ReceiptRepair = Migration{
	Name: "receipt_repair",
	Up: func(db ethdb.Database, tmpdir string, progress []byte, CommitProgress etl.LoadCommitHandler) (err error) {
		var tx ethdb.RwTx
		if hasTx, ok := db.(ethdb.HasTx); ok {
			tx = hasTx.Tx().(ethdb.RwTx)
		} else {
			return fmt.Errorf("no transaction")
		}
		if sm, smErr := ethdb.GetStorageModeFromDB(tx); smErr != nil {
			return smErr
		} else {
			if !sm.History {
				log.Warn("Could not perform this migration because history is not in storage mode")
				return CommitProgress(db, nil, true)
			}
			if !sm.Receipts {
				log.Info("Migration is only relevant for storage mode with receipts, skipping")
				return CommitProgress(db, nil, true)
			}
		}

		genesisBlock, err := rawdb.ReadBlockByNumber(tx, 0)
		if err != nil {
			return err
		}
		chainConfig, cerr := rawdb.ReadChainConfig(tx, genesisBlock.Hash())
		if cerr != nil {
			return cerr
		}
		vmConfig := vm.Config{}
		noOpWriter := state.NewNoopWriter()
		var buf bytes.Buffer
		fixedCount := 0
		logInterval := 30 * time.Second
		logEvery := time.NewTicker(logInterval)
		var key [8]byte
		var v []byte
		for blockNum := uint64(1); true; blockNum++ {
			select {
			default:
			case <-logEvery.C:
				log.Info("Progress", "block", blockNum, "fixed", fixedCount)
			}
			var hash common.Hash
			if hash, err = rawdb.ReadCanonicalHash(tx, blockNum); err != nil {
				return err
			}
			if hash == (common.Hash{}) {
				break
			}
			binary.BigEndian.PutUint64(key[:], blockNum)
			if v, err = tx.GetOne(dbutils.BlockReceiptsPrefix, key[:]); err != nil {
				return err
			}
			var receipts types.Receipts
			if err = cbor.Unmarshal(&receipts, bytes.NewReader(v)); err == nil {
				broken := false
				for _, receipt := range receipts {
					if receipt.CumulativeGasUsed < 10000 {
						broken = true
						break
					}
				}
				if !broken {
					continue
				}
			}
			var block *types.Block
			if block, _, err = rawdb.ReadBlockWithSenders(tx, hash, blockNum); err != nil {
				return err
			}

			dbstate := state.NewPlainKvState(tx, block.NumberU64()-1)
			intraBlockState := state.New(dbstate)

			getHeader := func(hash common.Hash, number uint64) *types.Header { return rawdb.ReadHeader(tx, hash, number) }
			receipts1, err1 := runBlock(intraBlockState, noOpWriter, noOpWriter, chainConfig, getHeader, nil /* checkTEVM */, block, vmConfig)
			if err1 != nil {
				return err1
			}
			fix := true
			if chainConfig.IsByzantium(block.Number().Uint64()) {
				receiptSha := types.DeriveSha(receipts1)
				if receiptSha != block.Header().ReceiptHash {
					fmt.Printf("(retrace) mismatched receipt headers for block %d: %x, %x\n", block.NumberU64(), receiptSha, block.Header().ReceiptHash)
					fix = false
				}
			}
			if fix {
				// All good, we can fix receipt record
				buf.Reset()
				err := cbor.Marshal(&buf, receipts1)
				if err != nil {
					return fmt.Errorf("encode block receipts for block %d: %v", blockNum, err)
				}
				if err = tx.Put(dbutils.BlockReceiptsPrefix, key[:], buf.Bytes()); err != nil {
					return fmt.Errorf("writing receipts for block %d: %v", blockNum, err)
				}
				fixedCount++
			}
		}
		return CommitProgress(db, nil, true)
	},
}

func runBlock(ibs *state.IntraBlockState, txnWriter state.StateWriter, blockWriter state.StateWriter,
	chainConfig *params.ChainConfig, getHeader func(hash common.Hash, number uint64) *types.Header, checkTEVM func(common.Hash) (bool, error), block *types.Block, vmConfig vm.Config) (types.Receipts, error) {
	header := block.Header()
	vmConfig.TraceJumpDest = true
	engine := ethash.NewFullFaker()
	gp := new(core.GasPool).AddGas(block.GasLimit())
	usedGas := new(uint64)
	var receipts types.Receipts
	if chainConfig.DAOForkSupport && chainConfig.DAOForkBlock != nil && chainConfig.DAOForkBlock.Cmp(block.Number()) == 0 {
		misc.ApplyDAOHardFork(ibs)
	}
	for i, tx := range block.Transactions() {
		ibs.Prepare(tx.Hash(), block.Hash(), i)
		receipt, _, err := core.ApplyTransaction(chainConfig, getHeader, engine, nil, gp, ibs, txnWriter, header, tx, usedGas, vmConfig, checkTEVM)
		if err != nil {
			return nil, fmt.Errorf("could not apply tx %d [%x] failed: %v", i, tx.Hash(), err)
		}
		receipts = append(receipts, receipt)
	}

	if !vmConfig.ReadOnly {
		// Finalize the block, applying any consensus engine specific extras (e.g. block rewards)
		if _, err := engine.FinalizeAndAssemble(chainConfig, header, ibs, block.Transactions(), block.Uncles(), receipts, nil); err != nil {
			return nil, fmt.Errorf("finalize of block %d failed: %v", block.NumberU64(), err)
		}

		ctx := chainConfig.WithEIPsFlags(context.Background(), header.Number.Uint64())
		if err := ibs.CommitBlock(ctx, blockWriter); err != nil {
			return nil, fmt.Errorf("committing block %d failed: %v", block.NumberU64(), err)
		}
	}

	return receipts, nil
}