evm/core/state_processor.go

// Copyright (C) 2019-2025, Lux Industries, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
//
// This file is a derived work, based on the go-ethereum library whose original
// notices appear below.
//
// It is distributed under a license compatible with the licensing terms of the
// original code from which it is derived.
//
// Much love to the original authors for their work.
// **********
// Copyright 2015 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 core

import (
	"fmt"
	"math/big"

	"github.com/luxfi/crypto"
	"github.com/luxfi/evm/consensus"
	"github.com/luxfi/evm/core/parallel"
	"github.com/luxfi/evm/core/state"
	"github.com/luxfi/evm/params"
	"github.com/luxfi/evm/params/extras"
	"github.com/luxfi/evm/predicate"
	"github.com/luxfi/geth/common"
	"github.com/luxfi/geth/core/types"
	"github.com/luxfi/geth/core/vm"
	ethparams "github.com/luxfi/geth/params"
	log "github.com/luxfi/log"
)

// StateProcessor is a basic Processor, which takes care of transitioning
// state from one point to another.
//
// StateProcessor implements Processor.
type StateProcessor struct {
	config *params.ChainConfig // Chain configuration options
	bc     *BlockChain         // Canonical block chain
	engine consensus.Engine    // Consensus engine used for block rewards
}

// NewStateProcessor initialises a new StateProcessor.
func NewStateProcessor(config *params.ChainConfig, bc *BlockChain, engine consensus.Engine) *StateProcessor {
	return &StateProcessor{
		config: config,
		bc:     bc,
		engine: engine,
	}
}

// Process processes the state changes according to the Ethereum rules by running
// the transaction messages using the statedb and applying any rewards to both
// the processor (coinbase) and any included uncles.
//
// Process returns the receipts and logs accumulated during the process and
// returns the amount of gas that was used in the process. If any of the
// transactions failed to execute due to insufficient gas it will return an error.
func (p *StateProcessor) Process(block *types.Block, parent *types.Header, statedb *state.StateDB, cfg vm.Config) (types.Receipts, []*types.Log, uint64, error) {
	var (
		receipts    types.Receipts
		usedGas     = new(uint64)
		header      = block.Header()
		blockHash   = block.Hash()
		blockNumber = block.Number()
		allLogs     []*types.Log
		gp          = new(GasPool).AddGas(block.GasLimit())
	)

	// Configure any upgrades that should go into effect during this block.
	blockContext := NewBlockContext(block.Number(), block.Time())
	err := ApplyUpgrades(p.config, &parent.Time, blockContext, statedb)
	if err != nil {
		log.Error("failed to configure precompiles processing block", "hash", block.Hash(), "number", block.NumberU64(), "timestamp", block.Time(), "err", err)
		return nil, nil, 0, err
	}

	var (
		context = NewEVMBlockContext(header, p.bc, nil)
		signer  = types.MakeSigner(p.config, header.Number, header.Time)
	)
	// Get rules for predicate storage slot computation
	rules := p.config.Rules(header.Number, params.IsMergeTODO, header.Time)
	rulesExtra := params.GetRulesExtra(rules)

	// Parse predicate results from block header extra data
	var predicateResults *predicate.Results
	if rulesExtra.PredicatersExist {
		var parseErr error
		predicateResults, parseErr = predicate.ParseResultsFromHeaderExtra(header.Extra)
		if parseErr != nil {
			log.Debug("failed to parse predicate results from header", "hash", block.Hash(), "err", parseErr)
		}
	}

	// Predicate results are validated separately through the predicate verification
	// path. The consensus identity (networkID, cChainID) reaches stateful precompiles
	// via context.ConsensusContext, set by NewEVMBlockContext(header, p.bc, …) above
	// from the running *BlockChain and preserved onto evm.Context by vm.NewEVM.
	_ = predicateResults
	vmenv := vm.NewEVM(context, statedb, p.config, cfg)
	if beaconRoot := block.BeaconRoot(); beaconRoot != nil {
		ProcessBeaconBlockRoot(*beaconRoot, vmenv, statedb)
	}

	// Parallel execution path: when a BlockExecutor is registered, try it
	// first. Falls through to sequential on (nil, nil) return.
	if parallelReceipts, parallelErr := parallel.DefaultExecutor().ExecuteBlock(
		p.config, header, block.Transactions(), statedb, cfg,
	); parallelReceipts != nil || parallelErr != nil {
		if parallelErr != nil {
			log.Debug("parallel execution failed, falling through to sequential", "block", header.Number, "err", parallelErr)
		} else {
			// Parallel succeeded -- collect logs, finalize, and return.
			parallelLogs := make([]*types.Log, 0)
			var totalGas uint64
			for _, r := range parallelReceipts {
				if r != nil {
					parallelLogs = append(parallelLogs, r.Logs...)
					totalGas = r.CumulativeGasUsed
				}
			}
			if err := p.engine.Finalize(p.bc, block, parent, statedb, parallelReceipts); err != nil {
				log.Debug("parallel execution finalize failed, falling through to sequential", "block", header.Number, "err", err)
			} else {
				return parallelReceipts, parallelLogs, totalGas, nil
			}
		}
	}

	// Sequential execution path (default, or fallback from parallel).
	for i, tx := range block.Transactions() {
		msg, err := TransactionToMessage(tx, signer, header.BaseFee)
		if err != nil {
			return nil, nil, 0, fmt.Errorf("could not apply tx %d [%v]: %w", i, tx.Hash().Hex(), err)
		}
		statedb.SetTxContext(tx.Hash(), i)

		// Compute predicate storage slots for this transaction
		var predicateStorageSlots map[common.Address][][]byte
		if rulesExtra.PredicatersExist {
			extrasRules := &extras.Rules{
				Predicaters: rulesExtra.Predicaters,
				LuxRules:    rulesExtra.LuxRules,
			}
			predicateStorageSlots = predicate.PreparePredicateStorageSlots(extrasRules, tx.AccessList())
		}
		// StatefulPrecompileHook is not yet exposed by luxfi/geth.
		_ = predicateStorageSlots

		receipt, err := applyTransaction(msg, p.config, gp, statedb, blockNumber, blockHash, header.Time, tx, usedGas, vmenv)
		if err != nil {
			return nil, nil, 0, fmt.Errorf("could not apply tx %d [%v]: %w", i, tx.Hash().Hex(), err)
		}
		receipts = append(receipts, receipt)
		allLogs = append(allLogs, receipt.Logs...)
	}
	// Finalize the block, applying any consensus engine specific extras (e.g. block rewards)
	if err := p.engine.Finalize(p.bc, block, parent, statedb, receipts); err != nil {
		return nil, nil, 0, fmt.Errorf("engine finalization check failed: %w", err)
	}

	return receipts, allLogs, *usedGas, nil
}

func applyTransaction(msg *Message, config *params.ChainConfig, gp *GasPool, statedb *state.StateDB, blockNumber *big.Int, blockHash common.Hash, blockTime uint64, tx *types.Transaction, usedGas *uint64, evm *vm.EVM) (*types.Receipt, error) {
	// Create a new context to be used in the EVM environment.
	txContext := NewEVMTxContext(msg)
	evm.SetTxContext(txContext)

	// Apply the transaction to the current state (included in the env).
	result, err := ApplyMessage(evm, msg, gp)
	if err != nil {
		return nil, err
	}

	// Update the state with pending changes.
	var root []byte
	if config.IsByzantium(blockNumber) {
		statedb.Finalise(true)
	} else {
		root = statedb.IntermediateRoot(config.IsEIP158(blockNumber)).Bytes()
	}
	*usedGas += result.UsedGas

	// Create a new receipt for the transaction, storing the intermediate root and gas used
	// by the tx.
	receipt := &types.Receipt{Type: tx.Type(), PostState: root, CumulativeGasUsed: *usedGas}
	if result.Failed() {
		receipt.Status = types.ReceiptStatusFailed
	} else {
		receipt.Status = types.ReceiptStatusSuccessful
	}
	receipt.TxHash = tx.Hash()
	receipt.GasUsed = result.UsedGas

	if tx.Type() == types.BlobTxType {
		receipt.BlobGasUsed = uint64(len(tx.BlobHashes()) * ethparams.BlobTxBlobGasPerBlob)
		receipt.BlobGasPrice = evm.Context.BlobBaseFee
	}

	// If the transaction created a contract, store the creation address in the receipt.
	if msg.To == nil {
		// Convert common.Address to crypto.Address
		var cryptoAddr crypto.Address
		copy(cryptoAddr[:], evm.Origin[:])
		createdAddr := crypto.CreateAddress(cryptoAddr, tx.Nonce())
		// Convert crypto.Address back to common.Address
		receipt.ContractAddress = common.BytesToAddress(createdAddr[:])
	}

	// Set the receipt logs and create the bloom filter.
	receipt.Logs = statedb.GetLogs(tx.Hash(), blockNumber.Uint64(), blockHash, blockTime)
	receipt.Bloom = types.CreateBloom(receipt)
	receipt.BlockHash = blockHash
	receipt.BlockNumber = blockNumber
	receipt.TransactionIndex = uint(statedb.TxIndex())
	return receipt, err
}

// ApplyTransaction attempts to apply a transaction to the given state database
// and uses the input parameters for its environment. It returns the receipt
// for the transaction, gas used and an error if the transaction failed,
// indicating the block was invalid.
func ApplyTransaction(config *params.ChainConfig, bc ChainContext, blockContext vm.BlockContext, gp *GasPool, statedb *state.StateDB, header *types.Header, tx *types.Transaction, usedGas *uint64, cfg vm.Config) (*types.Receipt, error) {
	return ApplyTransactionWithResults(config, bc, blockContext, gp, statedb, header, tx, usedGas, cfg, nil)
}

// ApplyTransactionWithResults is like ApplyTransaction but accepts pre-computed predicate results.
// This is used by the miner when it has already verified predicates.
func ApplyTransactionWithResults(config *params.ChainConfig, bc ChainContext, blockContext vm.BlockContext, gp *GasPool, statedb *state.StateDB, header *types.Header, tx *types.Transaction, usedGas *uint64, cfg vm.Config, predicateResults *predicate.Results) (*types.Receipt, error) {
	msg, err := TransactionToMessage(tx, types.MakeSigner(config, header.Number, header.Time), header.BaseFee)
	if err != nil {
		return nil, err
	}
	// Create a new context to be used in the EVM environment
	txContext := NewEVMTxContext(msg)

	// Compute predicate storage slots from the transaction's access list
	rules := config.Rules(header.Number, params.IsMergeTODO, header.Time)
	rulesExtra := params.GetRulesExtra(rules)
	var predicateStorageSlots map[common.Address][][]byte
	if rulesExtra.PredicatersExist {
		extrasRules := &extras.Rules{
			Predicaters: rulesExtra.Predicaters,
			LuxRules:    rulesExtra.LuxRules,
		}
		predicateStorageSlots = predicate.PreparePredicateStorageSlots(extrasRules, tx.AccessList())
	}

	// Thread the chain's consensus context (which embeds the chain Runtime via
	// runtime.WithContext at initializeChain) into the EVM block context so a
	// stateful precompile can recover the real (networkID, cChainID) through
	// runtime.FromContext(env.ConsensusContext()). geth's vm.BlockContext exposes
	// ConsensusContext and vm.NewEVM preserves it onto evm.Context, so this is the
	// supported seam — the prior "StatefulPrecompileHook not exposed" note was stale.
	//
	// The miner already builds blockContext via NewEVMBlockContext(env.header,
	// w.chain, …), which sets ConsensusContext from the running *BlockChain; the
	// nil-guard makes that path a no-op while guaranteeing any caller that passes a
	// bare blockContext (so the consensus identity would otherwise be absent, i.e.
	// networkID 0 / C-Chain Empty) still sees the real identity. bc can be nil in
	// test contexts (e.g., AddTxWithVMConfig), in which case there is nothing to thread.
	if bc != nil && blockContext.ConsensusContext == nil {
		blockContext.ConsensusContext = bc.ConsensusContext()
	}
	_ = predicateStorageSlots
	vmenv := vm.NewEVM(blockContext, statedb, config, cfg)
	vmenv.SetTxContext(txContext)
	return applyTransaction(msg, config, gp, statedb, header.Number, header.Hash(), header.Time, tx, usedGas, vmenv)
}

// ProcessBeaconBlockRoot applies the EIP-4788 system call to the beacon block root
// contract. This method is exported to be used in tests.
func ProcessBeaconBlockRoot(beaconRoot common.Hash, vmenv *vm.EVM, statedb *state.StateDB) {
	// If EIP-4788 is enabled, we need to invoke the beaconroot storage contract with
	// the new root
	msg := &Message{
		From:      ethparams.SystemAddress,
		GasLimit:  30_000_000,
		GasPrice:  common.Big0,
		GasFeeCap: common.Big0,
		GasTipCap: common.Big0,
		To:        &ethparams.BeaconRootsAddress,
		Data:      beaconRoot[:],
	}
	vmenv.SetTxContext(NewEVMTxContext(msg))
	statedb.AddAddressToAccessList(ethparams.BeaconRootsAddress)
	_, _, _ = vmenv.Call(msg.From, *msg.To, msg.Data, 30_000_000, common.U2560)
	statedb.Finalise(true)
}