Porting EVM tracer + Firehose to seiv2

Author: maoueh

app/app.go

@@ -7,14 +7,19 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"math/big"
 	"os"
 	"path/filepath"
 	"strings"
 	"sync"
 	"time"
 
+	ethcommon "github.com/ethereum/go-ethereum/common"
+	ethhexutil "github.com/ethereum/go-ethereum/common/hexutil"
+	ethtypes "github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/ethclient"
 	ethrpc "github.com/ethereum/go-ethereum/rpc"
+
 	"github.com/sei-protocol/sei-chain/app/antedecorators"
 	"github.com/sei-protocol/sei-chain/evmrpc"
 	"github.com/sei-protocol/sei-chain/precompiles"
@@ -124,6 +129,8 @@ import (
 	"github.com/sei-protocol/sei-chain/x/evm/blocktest"
 	evmkeeper "github.com/sei-protocol/sei-chain/x/evm/keeper"
 	"github.com/sei-protocol/sei-chain/x/evm/replay"
+	evmtracers "github.com/sei-protocol/sei-chain/x/evm/tracers"
+	"github.com/sei-protocol/sei-chain/x/evm/tracing"
 	evmtypes "github.com/sei-protocol/sei-chain/x/evm/types"
 	"github.com/spf13/cast"
 	abci "github.com/tendermint/tendermint/abci/types"
@@ -373,6 +380,7 @@ type App struct {
 
 	encodingConfig appparams.EncodingConfig
 	evmRPCConfig   evmrpc.Config
+	evmTracer      *tracing.Hooks
 }
 
 // New returns a reference to an initialized blockchain app
@@ -609,6 +617,20 @@ func New(
 		app.EvmKeeper.EthClient = ethclient.NewClient(rpcclient)
 	}
 
+	if app.evmRPCConfig.LiveEVMTracer != "" {
+		// PR_REVIEW_NOTE: So I moved this code from `ProcessBlock` and there, I had access to `ctx` so the code was actually looking
+		//                 like `evmtypes.DefaultChainConfig().EthereumConfig(app.EvmKeeper.ChainID(ctx))`. But here, I don't have access to `ctx`
+		//                 Is there another mean to get the EVM chainID from here? I need it to call `OnSeiBlockchainInit` on the logger,
+		//                 so another solution would be to call this one later when EVM chainID is known. Last resort, we have a sync.Once
+		//                 that we can use to call it only once.
+		chainConfig := evmtypes.DefaultChainConfig().EthereumConfig(big.NewInt(int64(app.evmRPCConfig.LiveEVMTracerChainID)))
+		evmTracer, err := evmtracers.NewBlockchainTracer(evmtracers.GlobalLiveTracerRegistry, app.evmRPCConfig.LiveEVMTracer, chainConfig)
+		if err != nil {
+			panic(fmt.Sprintf("error creating EVM tracer due to %s", err))
+		}
+		app.evmTracer = evmTracer
+	}
+
 	customDependencyGenerators := aclmapping.NewCustomDependencyGenerator()
 	aclOpts = append(aclOpts, aclkeeper.WithResourceTypeToStoreKeyMap(aclutils.ResourceTypeToStoreKeyMap))
 	aclOpts = append(aclOpts, aclkeeper.WithDependencyGeneratorMappings(customDependencyGenerators.GetCustomDependencyGenerators(app.EvmKeeper)))
@@ -1401,12 +1423,23 @@ func (app *App) ProcessTXsWithOCC(ctx sdk.Context, txs [][]byte, typedTxs []sdk.
 		wg.Add(1)
 		go func(txIndex int, tx []byte) {
 			defer wg.Done()
+
+			var txTracer sdk.TxTracer
+			if app.evmTracer != nil {
+				txTracer = app.evmTracer
+				if app.evmTracer.GetTxTracer != nil {
+					txTracer = app.evmTracer.GetTxTracer(absoluteTxIndices[txIndex])
+				}
+			}
+
 			deliverTxEntry := &sdk.DeliverTxEntry{
 				Request:       abci.RequestDeliverTx{Tx: tx},
 				SdkTx:         typedTxs[txIndex],
 				Checksum:      sha256.Sum256(tx),
 				AbsoluteIndex: absoluteTxIndices[txIndex],
+				TxTracer:      txTracer,
 			}
+
 			// get prefill estimate
 			estimatedWritesets, err := app.AccessControlKeeper.GenerateEstimatedWritesets(ctx, app.GetAnteDepGenerator(), txIndex, typedTxs[txIndex])
 			// if no error, then we assign the mapped writesets for prefill estimate
@@ -1466,12 +1499,17 @@ func (app *App) BuildDependenciesAndRunTxs(ctx sdk.Context, txs [][]byte, typedT
 	return app.ProcessBlockSynchronous(ctx, txs, typedTxs, absoluteTxIndices), ctx
 }
 
-func (app *App) ProcessBlock(ctx sdk.Context, txs [][]byte, req BlockProcessRequest, lastCommit abci.CommitInfo) ([]abci.Event, []*abci.ExecTxResult, abci.ResponseEndBlock, error) {
+func (app *App) ProcessBlock(ctx sdk.Context, txs [][]byte, req BlockProcessRequest, lastCommit abci.CommitInfo) (events []abci.Event, txResults []*abci.ExecTxResult, endBlockResp abci.ResponseEndBlock, err error) {
 	ctx = ctx.WithIsOCCEnabled(app.OccEnabled())
+
 	goCtx := app.decorateContextWithDexMemState(ctx.Context())
 	ctx = ctx.WithContext(goCtx)
 
-	events := []abci.Event{}
+	if app.evmTracer != nil {
+		ctx = evmtracers.SetCtxBlockchainTracer(ctx, app.evmTracer)
+	}
+
+	events = []abci.Event{}
 	beginBlockReq := abci.RequestBeginBlock{
 		Hash: req.GetHash(),
 		ByzantineValidators: utils.Map(req.GetByzantineValidators(), func(mis abci.Misbehavior) abci.Evidence {
@@ -1496,9 +1534,16 @@ func (app *App) ProcessBlock(ctx sdk.Context, txs [][]byte, req BlockProcessRequ
 	beginBlockResp := app.BeginBlock(ctx, beginBlockReq)
 	events = append(events, beginBlockResp.Events...)
 
-	txResults := make([]*abci.ExecTxResult, len(txs))
+	txResults = make([]*abci.ExecTxResult, len(txs))
 	typedTxs := app.DecodeTransactionsConcurrently(ctx, txs)
 
+	if app.evmTracer != nil {
+		header := ctx.BlockHeader()
+		app.evmTracer.OnSeiBlockStart(req.GetHash(), uint64(header.Size()), TmBlockHeaderToEVM(ctx, header, &app.EvmKeeper))
+		defer func() {
+			app.evmTracer.OnSeiBlockEnd(err)
+		}()
+	}
 	prioritizedTxs, otherTxs, prioritizedTypedTxs, otherTypedTxs, prioritizedIndices, otherIndices := app.PartitionPrioritizedTxs(ctx, txs, typedTxs)
 
 	// run the prioritized txs
@@ -1524,7 +1569,7 @@ func (app *App) ProcessBlock(ctx sdk.Context, txs [][]byte, req BlockProcessRequ
 	lazyWriteEvents := app.BankKeeper.WriteDeferredBalances(ctx)
 	events = append(events, lazyWriteEvents...)
 
-	endBlockResp := app.EndBlock(ctx, abci.RequestEndBlock{
+	endBlockResp = app.EndBlock(ctx, abci.RequestEndBlock{
 		Height: req.GetHeight(),
 	})
 
@@ -1835,3 +1880,38 @@ func init() {
 	// override max wasm size to 2MB
 	wasmtypes.MaxWasmSize = 2 * 1024 * 1024
 }
+
+func TmBlockHeaderToEVM(
+	ctx sdk.Context,
+	block tmproto.Header,
+	k *evmkeeper.Keeper,
+) (header *ethtypes.Header) {
+	number := big.NewInt(block.Height)
+	lastHash := ethcommon.BytesToHash(block.LastBlockId.Hash)
+	appHash := ethcommon.BytesToHash(block.AppHash)
+	txHash := ethcommon.BytesToHash(block.DataHash)
+	resultHash := ethcommon.BytesToHash(block.LastResultsHash)
+	miner := ethcommon.BytesToAddress(block.ProposerAddress)
+	gasLimit, gasWanted := uint64(0), uint64(0)
+
+	header = &ethtypes.Header{
+		Number:      number,
+		ParentHash:  lastHash,
+		Nonce:       ethtypes.BlockNonce{},   // inapplicable to Sei
+		MixDigest:   ethcommon.Hash{},        // inapplicable to Sei
+		UncleHash:   ethtypes.EmptyUncleHash, // inapplicable to Sei
+		Bloom:       k.GetBlockBloom(ctx, block.Height),
+		Root:        appHash,
+		Coinbase:    miner,
+		Difficulty:  big.NewInt(0),      // inapplicable to Sei
+		Extra:       ethhexutil.Bytes{}, // inapplicable to Sei
+		GasLimit:    gasLimit,
+		GasUsed:     gasWanted,
+		Time:        uint64(block.Time.Unix()),
+		TxHash:      txHash,
+		ReceiptHash: resultHash,
+		BaseFee:     k.GetBaseFeePerGas(ctx).RoundInt().BigInt(),
+	}
+
+	return
+}

app/eth_replay.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/cosmos/cosmos-sdk/client"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	ethtracing "github.com/ethereum/go-ethereum/core/tracing"
 	ethtypes "github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/params"
 	ethtests "github.com/ethereum/go-ethereum/tests"
@@ -81,7 +82,7 @@ func Replay(a *App) {
 		for _, w := range b.Withdrawals() {
 			amount := new(big.Int).SetUint64(w.Amount)
 			amount = amount.Mul(amount, big.NewInt(params.GWei))
-			s.AddBalance(w.Address, amount)
+			s.AddBalance(w.Address, amount, ethtracing.BalanceIncreaseWithdrawal)
 		}
 		_, _ = s.Finalize()
 		for _, tx := range b.Txs {

buf.gen.yaml

@@ -0,0 +1,6 @@
+version: v1
+plugins:
+  - plugin: buf.build/protocolbuffers/go:v1.31.0
+    out: pb
+    opt: paths=source_relative
+

evmrpc/config.go

@@ -53,6 +53,22 @@ type Config struct {
 	// Timeout for EVM call in simulation
 	SimulationEVMTimeout time.Duration `mapstructure:"simulation_evm_timeout"`
 
+	// The EVM tracer to use when doing node synchronization, applies to
+	// all block produced but traces only EVM transactions.
+	//
+	// Refer to <TBC> for registered tracers
+	//
+	// PR_REVIEW_NOTE: It his an acceptable way of documenting the available tracers?
+	// PR_REVIEW_NOTE: This section renders as `[evm]` in config but is named EVMRPC on top,
+	//                 is live tracing of block synchronization should be here? Maybe "higher"
+	//                 in the config hierarchy? We might think also about a way that later, we could
+	//                 different trace active for Cosmos related function and EVM related function.
+	LiveEVMTracer string `mapstructure:"live_evm_tracer"`
+
+	// PR_REVIEW_NOTE: This is a hackish workaround because I didn't how to get it in `app/app.go#New`,
+	//                 this will not be part of the final PR.
+	LiveEVMTracerChainID int `mapstructure:"live_evm_tracer_chain_id"`
+
 	// list of CORS allowed origins, separated by comma
 	CORSOrigins string `mapstructure:"cors_origins"`
 
@@ -113,6 +129,9 @@ const (
 	flagCheckTxTimeout       = "evm.checktx_timeout"
 	flagSlow                 = "evm.slow"
 	flagDenyList             = "evm.deny_list"
+	flagLiveEVMTracer        = "evm.live_evm_tracer"
+	// PR_REVIEW_NOTE: This is going to go away, temporary hack
+	flagLiveEVMTracerChainID = "evm.live_evm_tracer_chain_id"
 )
 
 func ReadConfig(opts servertypes.AppOptions) (Config, error) {
@@ -203,5 +222,16 @@ func ReadConfig(opts servertypes.AppOptions) (Config, error) {
 			return cfg, err
 		}
 	}
+	if v := opts.Get(flagLiveEVMTracer); v != nil {
+		if cfg.LiveEVMTracer, err = cast.ToStringE(v); err != nil {
+			return cfg, err
+		}
+	}
+	if v := opts.Get(flagLiveEVMTracerChainID); v != nil {
+		if cfg.LiveEVMTracerChainID, err = cast.ToIntE(v); err != nil {
+			return cfg, err
+		}
+	}
+
 	return cfg, nil
 }

evmrpc/config_test.go

@@ -1,6 +1,7 @@
 package evmrpc_test
 
 import (
+	"fmt"
 	"testing"
 	"time"
 
@@ -26,6 +27,8 @@ type opts struct {
 	maxTxPoolTxs         interface{}
 	slow                 interface{}
 	denyList             interface{}
+	liveEVMTracer        interface{}
+	liveEVMTracerChainID interface{}
 }
 
 func (o *opts) Get(k string) interface{} {
@@ -80,7 +83,13 @@ func (o *opts) Get(k string) interface{} {
 	if k == "evm.deny_list" {
 		return o.denyList
 	}
-	panic("unknown key")
+	if k == "evm.live_evm_tracer" {
+		return o.liveEVMTracer
+	}
+	if k == "evm.live_evm_tracer_chain_id" {
+		return o.liveEVMTracerChainID
+	}
+	panic(fmt.Errorf("unknown key: %s", k))
 }
 
 func TestReadConfig(t *testing.T) {
@@ -102,6 +111,8 @@ func TestReadConfig(t *testing.T) {
 		1000,
 		false,
 		make([]string, 0),
+		"",
+		0,
 	}
 	_, err := evmrpc.ReadConfig(&goodOpts)
 	require.Nil(t, err)

evmrpc/simulate.go

@@ -263,7 +263,7 @@ func (b *Backend) HeaderByNumber(ctx context.Context, bn rpc.BlockNumber) (*etht
 	return b.getHeader(big.NewInt(height)), nil
 }
 
-func (b *Backend) StateAtTransaction(ctx context.Context, block *ethtypes.Block, txIndex int, reexec uint64) (*core.Message, vm.BlockContext, vm.StateDB, tracers.StateReleaseFunc, error) {
+func (b *Backend) StateAtTransaction(ctx context.Context, block *ethtypes.Block, txIndex int, reexec uint64) (*ethtypes.Transaction, vm.BlockContext, vm.StateDB, tracers.StateReleaseFunc, error) {
 	emptyRelease := func() {}
 	// Short circuit if it's genesis block.
 	if block.Number().Int64() == 0 {
@@ -286,7 +286,7 @@ func (b *Backend) StateAtTransaction(ctx context.Context, block *ethtypes.Block,
 			return nil, vm.BlockContext{}, nil, nil, err
 		}
 		if idx == txIndex {
-			return msg, *blockContext, statedb, emptyRelease, nil
+			return tx, *blockContext, statedb, emptyRelease, nil
 		}
 		// Not yet the searched for transaction, execute on top of the current state
 		vmenv := vm.NewEVM(*blockContext, txContext, statedb, b.ChainConfig(), vm.Config{})

go.mod

@@ -346,10 +346,10 @@ require (
 replace (
 	github.com/CosmWasm/wasmd => github.com/sei-protocol/sei-wasmd v0.1.0
 	github.com/confio/ics23/go => github.com/cosmos/cosmos-sdk/ics23/go v0.8.0
-	github.com/cosmos/cosmos-sdk => github.com/sei-protocol/sei-cosmos v0.2.79-seiv2-hotfix
+	github.com/cosmos/cosmos-sdk => github.com/streamingfast/sei-cosmos v0.0.0-20240327153024-8e22d1da5334
 	github.com/cosmos/iavl => github.com/sei-protocol/sei-iavl v0.1.9
 	github.com/cosmos/ibc-go/v3 => github.com/sei-protocol/sei-ibc-go/v3 v3.3.0
-	github.com/ethereum/go-ethereum => github.com/sei-protocol/go-ethereum v1.13.5-sei-12
+	github.com/ethereum/go-ethereum => github.com/sei-protocol/go-ethereum v1.13.5-sei-9.0.20240327165640-6ab0d196bac6
 	github.com/gogo/protobuf => github.com/regen-network/protobuf v1.3.3-alpha.regen.1
 	github.com/sei-protocol/sei-db => github.com/sei-protocol/sei-db v0.0.33
 	// Latest goleveldb is broken, we have to stick to this version

go.sum

@@ -1343,12 +1343,10 @@ github.com/seccomp/libseccomp-golang v0.9.2-0.20220502022130-f33da4d89646/go.mod
 github.com/securego/gosec/v2 v2.11.0 h1:+PDkpzR41OI2jrw1q6AdXZCbsNGNGT7pQjal0H0cArI=
 github.com/securego/gosec/v2 v2.11.0/go.mod h1:SX8bptShuG8reGC0XS09+a4H2BoWSJi+fscA+Pulbpo=
 github.com/segmentio/fasthash v1.0.3/go.mod h1:waKX8l2N8yckOgmSsXJi7x1ZfdKZ4x7KRMzBtS3oedY=
-github.com/sei-protocol/go-ethereum v1.13.5-sei-12 h1:sWGD3sV9F3Ilgmn8le8lhpfAwSi6n57I921cYuNvLuo=
-github.com/sei-protocol/go-ethereum v1.13.5-sei-12/go.mod h1:kcRZmuzRn1lVejiFNTz4l4W7imnpq1bDAnuKS/RyhbQ=
+github.com/sei-protocol/go-ethereum v1.13.5-sei-9.0.20240327165640-6ab0d196bac6 h1:AU9VAvZsTGibuzzVmoX3taGOWjPJJct5ypXDg6vKKu0=
+github.com/sei-protocol/go-ethereum v1.13.5-sei-9.0.20240327165640-6ab0d196bac6/go.mod h1:kcRZmuzRn1lVejiFNTz4l4W7imnpq1bDAnuKS/RyhbQ=
 github.com/sei-protocol/goutils v0.0.2 h1:Bfa7Sv+4CVLNM20QcpvGb81B8C5HkQC/kW1CQpIbXDA=
 github.com/sei-protocol/goutils v0.0.2/go.mod h1:iYE2DuJfEnM+APPehr2gOUXfuLuPsVxorcDO+Tzq9q8=
-github.com/sei-protocol/sei-cosmos v0.2.79-seiv2-hotfix h1:Yx2W7/xrGk13rpZfs+bkjx229b9LCbcCpcwTrzbz26Y=
-github.com/sei-protocol/sei-cosmos v0.2.79-seiv2-hotfix/go.mod h1:ib/gp0gCxN7FXUZ40j5+x8BeyoI7AcX+rTvf53JoDsY=
 github.com/sei-protocol/sei-db v0.0.33 h1:TspNkw/lW7fubR0TsOpmJdzWiLecMDOS5DAxFNQXQ6M=
 github.com/sei-protocol/sei-db v0.0.33/go.mod h1:F/ZKZA8HJPcUzSZPA8yt6pfwlGriJ4RDR4eHKSGLStI=
 github.com/sei-protocol/sei-iavl v0.1.9 h1:y4mVYftxLNRs6533zl7N0/Ch+CzRQc04JDfHolIxgBE=
@@ -1430,6 +1428,8 @@ github.com/stbenjam/no-sprintf-host-port v0.1.1/go.mod h1:TLhvtIvONRzdmkFiio4O8L
 github.com/streadway/amqp v0.0.0-20190404075320-75d898a42a94/go.mod h1:AZpEONHx3DKn8O/DFsRAY58/XVQiIPMTMB1SddzLXVw=
 github.com/streadway/amqp v0.0.0-20190827072141-edfb9018d271/go.mod h1:AZpEONHx3DKn8O/DFsRAY58/XVQiIPMTMB1SddzLXVw=
 github.com/streadway/handy v0.0.0-20190108123426-d5acb3125c2a/go.mod h1:qNTQ5P5JnDBl6z3cMAg/SywNDC5ABu5ApDIw6lUbRmI=
+github.com/streamingfast/sei-cosmos v0.0.0-20240327153024-8e22d1da5334 h1:+4kXknHWASf4Qq0yo67kDmZcBDeSUxVICb34CDEY6Kw=
+github.com/streamingfast/sei-cosmos v0.0.0-20240327153024-8e22d1da5334/go.mod h1:ib/gp0gCxN7FXUZ40j5+x8BeyoI7AcX+rTvf53JoDsY=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=

pb/sf/ethereum/type/v2/type.go

@@ -0,0 +1,27 @@
+package pbeth
+
+import (
+	"encoding/hex"
+	"math/big"
+	"time"
+)
+
+var b0 = big.NewInt(0)
+
+func (b *Block) PreviousID() string {
+	return hex.EncodeToString(b.Header.ParentHash)
+}
+
+func (b *Block) Time() time.Time {
+	return b.Header.Timestamp.AsTime()
+}
+
+func (m *BigInt) Native() *big.Int {
+	if m == nil {
+		return b0
+	}
+
+	z := new(big.Int)
+	z.SetBytes(m.Bytes)
+	return z
+}