pevm: support delay gas fee calculation & Uts; (bnb-chain#11)

* pevm: support delay gas fee calculation;
txdag: check gas fee receiver;
tests: support PEVM+TxDAG UTs;

* txdag: skip some cost time operation;
tests: fix some broken UTs;

---------

Co-authored-by: galaio <[email protected]>

cmd/evm/blockrunner.go

@@ -92,7 +92,7 @@ func blockTestCmd(ctx *cli.Context) error {
 					fmt.Println(string(state.Dump(nil)))
 				}
 			}
-		}); err != nil {
+		}, "", true); err != nil {
 			return fmt.Errorf("test %v: %w", name, err)
 		}
 	}

core/blockchain.go

@@ -2706,7 +2706,7 @@ func (bc *BlockChain) TxDAGEnabled() bool {
 	return bc.enableTxDAG
 }
 
-func (bc *BlockChain) EnableTxDAGGeneration(output string) {
+func (bc *BlockChain) SetupTxDAGGeneration(output string) {
 	bc.enableTxDAG = true
 	if len(output) == 0 {
 		return
@@ -2715,7 +2715,7 @@ func (bc *BlockChain) EnableTxDAGGeneration(output string) {
 	var err error
 	bc.txDAGMapping, err = readTxDAGMappingFromFile(output)
 	if err != nil {
-		log.Error("read TxDAG err", err)
+		log.Error("read TxDAG err", "err", err)
 	}
 
 	// write handler

core/parallel_state_processor.go

@@ -50,6 +50,7 @@ type ParallelStateProcessor struct {
 	targetStage2Count     int // when executed txNUM reach it, enter stage2 RT confirm
 	nextStage2TxIndex     int
 	disableStealTx        bool
+	delayGasFee           bool // it is provided by TxDAG
 }
 
 func NewParallelStateProcessor(config *params.ChainConfig, bc *BlockChain, engine consensus.Engine, parallelNum int) *ParallelStateProcessor {
@@ -187,6 +188,8 @@ func (p *ParallelStateProcessor) resetState(txNum int, statedb *state.StateDB) {
 // 3. TODO(galaio) it need to schedule the slow dep tx path properly;
 // 4. TODO(galaio) it is unfriendly for cross slot deps, maybe we can delay dispatch when tx cross in slots, it may increase PEVM parallelism;
 func (p *ParallelStateProcessor) doStaticDispatchV2(txReqs []*ParallelTxRequest, txDAG types.TxDAG) {
+	p.disableStealTx = false
+	p.delayGasFee = false
 	// only support PlainTxDAG dispatch now.
 	if txDAG == nil || txDAG.Type() != types.PlainTxDAGType {
 		p.doStaticDispatch(txReqs)
@@ -213,6 +216,7 @@ func (p *ParallelStateProcessor) doStaticDispatchV2(txReqs []*ParallelTxRequest,
 
 	// it's unnecessary to enable slot steal mechanism, opt the steal mechanism later;
 	p.disableStealTx = true
+	p.delayGasFee = true
 }
 
 // Benefits of StaticDispatch:
@@ -331,7 +335,7 @@ func (p *ParallelStateProcessor) executeInSlot(slotIndex int, txReq *ParallelTxR
 
 	slotDB.SetTxContext(txReq.tx.Hash(), txReq.txIndex)
 
-	evm, result, err := applyTransactionStageExecution(txReq.msg, gpSlot, slotDB, vmenv)
+	evm, result, err := applyTransactionStageExecution(txReq.msg, gpSlot, slotDB, vmenv, p.delayGasFee)
 	txResult := ParallelTxResult{
 		executedIndex: execNum,
 		slotIndex:     slotIndex,
@@ -660,7 +664,19 @@ func (p *ParallelStateProcessor) confirmTxResults(statedb *state.StateDB, gp *Ga
 	}
 
 	resultTxIndex := result.txReq.txIndex
-
+	delayGasFee := result.result.delayFees
+	// add delayed gas fee
+	if delayGasFee != nil {
+		if delayGasFee.TipFee != nil {
+			result.slotDB.AddBalance(delayGasFee.Coinbase, delayGasFee.TipFee)
+		}
+		if delayGasFee.BaseFee != nil {
+			result.slotDB.AddBalance(params.OptimismBaseFeeRecipient, delayGasFee.BaseFee)
+		}
+		if delayGasFee.L1Fee != nil {
+			result.slotDB.AddBalance(params.OptimismL1FeeRecipient, delayGasFee.L1Fee)
+		}
+	}
 	var root []byte
 	header := result.txReq.block.Header()
 
@@ -669,7 +685,7 @@ func (p *ParallelStateProcessor) confirmTxResults(statedb *state.StateDB, gp *Ga
 	result.slotDB.FinaliseForParallel(isByzantium || isEIP158, statedb)
 
 	// merge slotDB into mainDB
-	statedb.MergeSlotDB(result.slotDB, result.receipt, resultTxIndex)
+	statedb.MergeSlotDB(result.slotDB, result.receipt, resultTxIndex, result.result.delayFees)
 
 	// Do IntermediateRoot after mergeSlotDB.
 	if !isByzantium {
@@ -887,13 +903,21 @@ func (p *ParallelStateProcessor) Process(block *types.Block, statedb *state.Stat
 	return receipts, allLogs, *usedGas, nil
 }
 
-func applyTransactionStageExecution(msg *Message, gp *GasPool, statedb *state.ParallelStateDB, evm *vm.EVM) (*vm.EVM, *ExecutionResult, error) {
+func applyTransactionStageExecution(msg *Message, gp *GasPool, statedb *state.ParallelStateDB, evm *vm.EVM, delayGasFee bool) (*vm.EVM, *ExecutionResult, error) {
 	// Create a new context to be used in the EVM environment.
 	txContext := NewEVMTxContext(msg)
 	evm.Reset(txContext, statedb)
 
 	// Apply the transaction to the current state (included in the env).
-	result, err := ApplyMessage(evm, msg, gp)
+	var (
+		result *ExecutionResult
+		err    error
+	)
+	if delayGasFee {
+		result, err = ApplyMessageDelayGasFee(evm, msg, gp)
+	} else {
+		result, err = ApplyMessage(evm, msg, gp)
+	}
 
 	if err != nil {
 		return nil, nil, err

core/state/statedb.go

@@ -60,6 +60,13 @@ type StateObjectSyncMap struct {
 	sync.Map
 }
 
+type DelayedGasFee struct {
+	BaseFee  *uint256.Int
+	TipFee   *uint256.Int
+	L1Fee    *uint256.Int
+	Coinbase common.Address
+}
+
 func (s *StateObjectSyncMap) LoadStateObject(addr common.Address) (*stateObject, bool) {
 	so, ok := s.Load(addr)
 	if !ok {
@@ -239,9 +246,10 @@ type StateDB struct {
 	logSize uint
 
 	// parallel EVM related
-	rwSet    *types.RWSet
-	mvStates *types.MVStates
-	es       *types.ExeStat
+	rwSet        *types.RWSet
+	mvStates     *types.MVStates
+	stat         *types.ExeStat
+	rwRecordFlag bool
 
 	// Preimages occurred seen by VM in the scope of block.
 	preimages map[common.Hash][]byte
@@ -2365,6 +2373,7 @@ func (s *StateDB) BeforeTxTransition() {
 	s.rwSet = types.NewRWSet(types.StateVersion{
 		TxIndex: s.txIndex,
 	})
+	s.rwRecordFlag = true
 }
 
 func (s *StateDB) BeginTxStat(index int) {
@@ -2374,7 +2383,9 @@ func (s *StateDB) BeginTxStat(index int) {
 	if s.mvStates == nil {
 		return
 	}
-	s.es = types.NewExeStat(index).Begin()
+	if metrics.EnabledExpensive {
+		s.stat = types.NewExeStat(index).Begin()
+	}
 }
 
 func (s *StateDB) StopTxStat(usedGas uint64) {
@@ -2385,16 +2396,16 @@ func (s *StateDB) StopTxStat(usedGas uint64) {
 		return
 	}
 	// record stat first
-	if s.es != nil {
-		s.es.Done().WithGas(usedGas).WithRead(len(s.rwSet.ReadSet()))
+	if metrics.EnabledExpensive && s.stat != nil {
+		s.stat.Done().WithGas(usedGas).WithRead(len(s.rwSet.ReadSet()))
 	}
 }
 
 func (s *StateDB) RecordRead(key types.RWKey, val interface{}) {
 	if s.isParallel && s.parallel.isSlotDB {
 		return
 	}
-	if s.mvStates == nil || s.rwSet == nil {
+	if !s.rwRecordFlag {
 		return
 	}
 	// TODO: read from MVStates, record with ver
@@ -2407,7 +2418,7 @@ func (s *StateDB) RecordWrite(key types.RWKey, val interface{}) {
 	if s.isParallel && s.parallel.isSlotDB {
 		return
 	}
-	if s.mvStates == nil || s.rwSet == nil {
+	if !s.rwRecordFlag {
 		return
 	}
 	s.rwSet.RecordWrite(key, val)
@@ -2419,13 +2430,14 @@ func (s *StateDB) ResetMVStates(txCount int) {
 	}
 	s.mvStates = types.NewMVStates(txCount)
 	s.rwSet = nil
+	s.rwRecordFlag = false
 }
 
 func (s *StateDB) FinaliseRWSet() error {
 	if s.isParallel && s.parallel.isSlotDB {
 		return nil
 	}
-	if s.mvStates == nil || s.rwSet == nil {
+	if !s.rwRecordFlag {
 		return nil
 	}
 	if metrics.EnabledExpensive {
@@ -2463,7 +2475,8 @@ func (s *StateDB) FinaliseRWSet() error {
 		}
 	}
 
-	return s.mvStates.FulfillRWSet(s.rwSet, s.es)
+	s.rwRecordFlag = false
+	return s.mvStates.FulfillRWSet(s.rwSet, s.stat)
 }
 
 func (s *StateDB) queryStateObjectsDestruct(addr common.Address) (*types.StateAccount, bool) {
@@ -2493,7 +2506,7 @@ func (s *StateDB) deleteStateObjectsDestruct(addr common.Address) {
 	delete(s.stateObjectsDestruct, addr)
 }
 
-func (s *StateDB) MVStates2TxDAG() (types.TxDAG, map[int]*types.ExeStat) {
+func (s *StateDB) ResolveTxDAG(gasFeeReceivers []common.Address) (types.TxDAG, map[int]*types.ExeStat) {
 	if s.isParallel && s.parallel.isSlotDB {
 		return nil, nil
 	}
@@ -2506,7 +2519,7 @@ func (s *StateDB) MVStates2TxDAG() (types.TxDAG, map[int]*types.ExeStat) {
 		}(time.Now())
 	}
 
-	return s.mvStates.ResolveTxDAG(), s.mvStates.Stats()
+	return s.mvStates.ResolveTxDAG(gasFeeReceivers), s.mvStates.Stats()
 }
 
 func (s *StateDB) MVStates() *types.MVStates {
@@ -2595,7 +2608,7 @@ func (s *StateDB) AddrPrefetch(slotDb *ParallelStateDB) {
 // MergeSlotDB is for Parallel execution mode, when the transaction has been
 // finalized(dirty -> pending) on execution slot, the execution results should be
 // merged back to the main StateDB.
-func (s *StateDB) MergeSlotDB(slotDb *ParallelStateDB, slotReceipt *types.Receipt, txIndex int) *StateDB {
+func (s *StateDB) MergeSlotDB(slotDb *ParallelStateDB, slotReceipt *types.Receipt, txIndex int, fees *DelayedGasFee) *StateDB {
 	s.SetTxContext(slotDb.thash, slotDb.txIndex)
 
 	for s.nextRevisionId < slotDb.nextRevisionId {

core/state/statedb_test.go

@@ -1539,7 +1539,7 @@ func TestMergeSlotDB(t *testing.T) {
 	newSlotDb.SelfDestruct(addr)
 	newSlotDb.Finalise(true)
 
-	changeList := oldSlotDb.MergeSlotDB(newSlotDb, &types.Receipt{}, 0)
+	changeList := oldSlotDb.MergeSlotDB(newSlotDb, &types.Receipt{}, 0, nil)
 
 	if ok := changeList.getDeletedStateObject(addr); ok == nil || !ok.selfDestructed {
 		t.Fatalf("address should exist in StateObjectSuicided")

core/state_processor.go

@@ -22,6 +22,8 @@ import (
 	"math/big"
 	"time"
 
+	"github.com/ethereum/go-ethereum/log"
+
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/consensus"
 	"github.com/ethereum/go-ethereum/consensus/misc"
@@ -125,10 +127,12 @@ func (p *StateProcessor) Process(block *types.Block, statedb *state.StateDB, cfg
 	if p.bc.enableTxDAG {
 		// TODO(galaio): append dag into block body, TxDAGPerformance will print metrics when profile is enabled
 		// compare input TxDAG when it enable in consensus
-		dag, exrStats := statedb.MVStates2TxDAG()
-		fmt.Print(types.EvaluateTxDAGPerformance(dag, exrStats))
-		//log.Info("Process result", "block", block.NumberU64(), "txDAG", dag)
-		// try write txDAG into file
+		dag, extraStats := statedb.ResolveTxDAG([]common.Address{context.Coinbase, params.OptimismBaseFeeRecipient, params.OptimismL1FeeRecipient})
+		log.Debug("Process TxDAG result", "block", block.NumberU64(), "txDAG", dag)
+		if metrics.EnabledExpensive {
+			types.EvaluateTxDAGPerformance(dag, extraStats)
+		}
+		// try to write txDAG into file
 		if p.bc.txDAGWriteCh != nil && dag != nil {
 			p.bc.txDAGWriteCh <- TxDAGOutputItem{
 				blockNumber: block.NumberU64(),

core/state_transition.go

@@ -18,6 +18,7 @@ package core
 
 import (
 	"fmt"
+	"github.com/ethereum/go-ethereum/core/state"
 	"math"
 	"math/big"
 	"time"
@@ -41,6 +42,7 @@ type ExecutionResult struct {
 	RefundedGas uint64 // Total gas refunded after execution
 	Err         error  // Any error encountered during the execution(listed in core/vm/errors.go)
 	ReturnData  []byte // Returned data from evm(function result or data supplied with revert opcode)
+	delayFees   *state.DelayedGasFee
 }
 
 // Unwrap returns the internal evm error which allows us for further
@@ -197,6 +199,12 @@ func ApplyMessage(evm *vm.EVM, msg *Message, gp *GasPool) (*ExecutionResult, err
 	return NewStateTransition(evm, msg, gp).TransitionDb()
 }
 
+func ApplyMessageDelayGasFee(evm *vm.EVM, msg *Message, gp *GasPool) (*ExecutionResult, error) {
+	transition := NewStateTransition(evm, msg, gp)
+	transition.delayGasFee = true
+	return transition.TransitionDb()
+}
+
 // StateTransition represents a state transition.
 //
 // == The State Transitioning Model
@@ -226,6 +234,7 @@ type StateTransition struct {
 	initialGas   uint64
 	state        vm.StateDB
 	evm          *vm.EVM
+	delayGasFee  bool
 }
 
 // NewStateTransition initialises and returns a new state transition object.
@@ -563,20 +572,30 @@ func (st *StateTransition) innerTransitionDb() (*ExecutionResult, error) {
 		}, nil
 	}
 
+	var (
+		tipFee  *uint256.Int
+		baseFee *uint256.Int
+		l1Fee   *uint256.Int
+	)
 	effectiveTip := msg.GasPrice
 	if rules.IsLondon {
 		effectiveTip = cmath.BigMin(msg.GasTipCap, new(big.Int).Sub(msg.GasFeeCap, st.evm.Context.BaseFee))
 	}
 	effectiveTipU256, _ := uint256.FromBig(effectiveTip)
 
+	// delay gas fee calculation, provide from TxDAG
 	if st.evm.Config.NoBaseFee && msg.GasFeeCap.Sign() == 0 && msg.GasTipCap.Sign() == 0 {
 		// Skip fee payment when NoBaseFee is set and the fee fields
 		// are 0. This avoids a negative effectiveTip being applied to
 		// the coinbase when simulating calls.
 	} else {
 		fee := new(uint256.Int).SetUint64(st.gasUsed())
 		fee.Mul(fee, effectiveTipU256)
-		st.state.AddBalance(st.evm.Context.Coinbase, fee)
+		if st.delayGasFee {
+			tipFee = fee
+		} else {
+			st.state.AddBalance(st.evm.Context.Coinbase, fee)
+		}
 	}
 
 	// Check that we are post bedrock to enable op-geth to be able to create pseudo pre-bedrock blocks (these are pre-bedrock, but don't follow l2 geth rules)
@@ -587,22 +606,40 @@ func (st *StateTransition) innerTransitionDb() (*ExecutionResult, error) {
 		if overflow {
 			return nil, fmt.Errorf("optimism gas cost overflows U256: %d", gasCost)
 		}
-		st.state.AddBalance(params.OptimismBaseFeeRecipient, amtU256)
+		if st.delayGasFee {
+			baseFee = amtU256
+		} else {
+			st.state.AddBalance(params.OptimismBaseFeeRecipient, amtU256)
+		}
 		if st.msg.GasPrice.Cmp(big.NewInt(0)) == 0 && st.evm.ChainConfig().IsWright(st.evm.Context.Time) {
-			st.state.AddBalance(params.OptimismL1FeeRecipient, uint256.NewInt(0))
+			if st.delayGasFee {
+				baseFee = uint256.NewInt(0)
+			} else {
+				st.state.AddBalance(params.OptimismBaseFeeRecipient, uint256.NewInt(0))
+			}
 		} else if l1Cost := st.evm.Context.L1CostFunc(st.msg.RollupCostData, st.evm.Context.Time); l1Cost != nil {
 			amtU256, overflow = uint256.FromBig(l1Cost)
 			if overflow {
 				return nil, fmt.Errorf("optimism l1 cost overflows U256: %d", l1Cost)
 			}
-			st.state.AddBalance(params.OptimismL1FeeRecipient, amtU256)
+			if st.delayGasFee {
+				baseFee = amtU256
+			} else {
+				st.state.AddBalance(params.OptimismBaseFeeRecipient, amtU256)
+			}
 		}
 	}
 	return &ExecutionResult{
 		UsedGas:     st.gasUsed(),
 		RefundedGas: gasRefund,
 		Err:         vmerr,
 		ReturnData:  ret,
+		delayFees: &state.DelayedGasFee{
+			TipFee:   tipFee,
+			BaseFee:  baseFee,
+			L1Fee:    l1Fee,
+			Coinbase: st.evm.Context.Coinbase,
+		},
 	}, nil
 }