Firehose EVM tracer addition

.gitignore

@@ -7,6 +7,9 @@ release/
 build/
 cache/
 
+/seid-*
+/libwasmvm.x86_64.so
+
 # Local .terraform directories
 **/.terraform
 

CHANGELOG.md

@@ -71,7 +71,7 @@ sei-tendermint
 * [#263](https://github.com/sei-protocol/sei-tendermint/pull/263) Update ReapMaxBytesMaxGas to include estimated gas
 * [#259](https://github.com/sei-protocol/sei-tendermint/pull/259) Add simulate flag to RequestBeginBlock
 * [#258](https://github.com/sei-protocol/sei-tendermint/pull/258) Add utils to get RequestBeginBlock
- 
+
 ## v6.0.3
 sei-chain
 * [#2057](https://github.com/sei-protocol/sei-chain/pull/2057) Avoid panic tx error message in debug trace
@@ -159,7 +159,7 @@ sei-tendermint
 
 sei-db
 * [#75](https://github.com/sei-protocol/sei-db/pull/75) Online archive node migration
- 
+
 ## v5.9.0
 sei-chain
 * [#1867](https://github.com/sei-protocol/sei-chain/pull/1867) Add synthetic events in separate sei endpoints

Dockerfile.sf

@@ -0,0 +1,63 @@
+FROM ubuntu:22.04 AS base
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y apt-transport-https ca-certificates curl gnupg tar jq vim wget
+
+RUN curl -LO https://github.com/chmln/sd/releases/download/v1.0.0/sd-v1.0.0-x86_64-unknown-linux-gnu.tar.gz \
+    && tar -xzf sd-v1.0.0-x86_64-unknown-linux-gnu.tar.gz \
+    && cp sd-v1.0.0-x86_64-unknown-linux-gnu/sd /usr/local/bin/sd \
+    && rm -rf sd-v1.0.0-x86_64-unknown-linux-gnu sd-v1.0.0-x86_64-unknown-linux-gnu.tar.gz
+
+ENV PATH="/app:${PATH}"
+
+FROM base AS fireeth_download
+
+ARG FIREETH="v2.6.7"
+
+# Download and extract the binary file
+RUN curl -LO https://github.com/streamingfast/firehose-ethereum/releases/download/${FIREETH}/firehose-ethereum_linux_x86_64.tar.gz \
+    && tar -xzf firehose-ethereum_linux_x86_64.tar.gz \
+    && rm firehose-ethereum_linux_x86_64.tar.gz
+
+FROM golang:1.22-alpine AS libwasmvm_download
+
+COPY ./go.mod /work/go.mod
+COPY ./go.sum /work/go.sum
+
+# FIXME: Handle multi-arch build, for now we have hard-coded the x86_64 part, but we should be able to build for arm64 as well
+RUN apk add --no-cache wget && cd /work; \
+    export ARCH=$(uname -m); \
+    export WASM_VERSION="$(go list -m all | grep github.com/CosmWasm/wasmvm | awk '{print $2}')"; \
+    wget -O "/lib/libwasmvm.x86_64.${WASM_VERSION}.so" https://github.com/CosmWasm/wasmvm/releases/download/${WASM_VERSION}/libwasmvm.x86_64.so && \
+    printf "${WASM_VERSION}" > /lib/libwasmvm.x86_64.so.version
+
+FROM base AS cosmovisor_download
+
+ARG COSMOVISOR="v1.5.0"
+
+# Download and extract the binary file
+RUN curl -LO https://github.com/cosmos/cosmos-sdk/releases/download/cosmovisor%2F${COSMOVISOR}/cosmovisor-${COSMOVISOR}-linux-amd64.tar.gz \
+    && tar -xzf cosmovisor-${COSMOVISOR}-linux-amd64.tar.gz \
+    && rm cosmovisor-${COSMOVISOR}-linux-amd64.tar.gz
+
+FROM base AS base_with_gcloud
+
+RUN echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | tee -a /etc/apt/sources.list.d/google-cloud-sdk.list \
+    && curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | gpg --dearmor -o /usr/share/keyrings/cloud.google.gpg \
+    && apt-get update -y \
+    && apt-get install google-cloud-sdk -y
+
+FROM base_with_gcloud
+
+ARG SEID_BIN="seid"
+
+COPY --from=fireeth_download /app/fireeth /app/fireeth
+COPY --from=libwasmvm_download /lib/libwasmvm.x86_64.*.so /lib/
+COPY --from=libwasmvm_download /lib/libwasmvm.x86_64.so.version /lib/
+
+COPY ./${SEID_BIN} /app/seid
+
+RUN chmod +x /app/fireeth && \
+    export WASM_VERSION=$(cat /lib/libwasmvm.x86_64.so.version) && \
+    ln -s /lib/libwasmvm.x86_64.${WASM_VERSION}.so /lib/libwasmvm.x86_64.so

README.sf.md

@@ -0,0 +1,76 @@
+## StreamingFast Sei Fork Notes
+
+### Remotes & Branches
+
+```bash
+git remote set-url origin https://github.com/sei-protocol/sei-chain.git
+git remote add sf git@github.com:streamingfast/sei-chain.git
+```
+
+We maintain 3 branches:
+
+- `feature/firehose-tracer`
+- `feature/firehose-tracer-at-latest-release-tag`
+- `release/firehose`
+
+The `release/firehose` contains Dockerfile and instructions how to build images, this is the branch that should be used to make releases.
+
+The `feature/firehose-tracer` is the PR branch that tracks `origin/main` branch, `feature/firehose-tracer-at-latest-release-tag` is the same as `feature/firehose-tracer` but tracks the latest release tag, which as of time of writing is `v5.5.5`.
+
+### Bumping to new version
+
+```bash
+git fetch origin
+
+# Found correct tag to bump to, we will use `v5.5.6`
+export VERSION=v5.5.6
+
+git checkout feature/firehose-tracer-at-latest-release-tag
+git pull
+
+git merge "${VERSION:?}"
+# Fix any conflicts
+go test ./...
+git commit
+
+git checkout release/firehose
+git pull
+
+git merge feature/firehose-tracer-at-latest-release-tag
+# Fix any conflicts and merge, but there is usually no conflicts in this step
+
+git tag "${VERSION:?}-fh3.0"
+
+git push feature/firehose-tracer-at-latest-release-tag release/firehose "${VERSION:?}-fh3.0"
+```
+
+#### Building Binary & Docker
+
+Built manually for now on the GCP VM, here the commands we use to build it in our VM.
+
+> [!IMPORTANT]
+> The instructions below **must** be run on the VM itself and not on your developer's machine.
+
+```bash
+export SEID_REF=v5.5.6-fh3.0 \
+&& sudo -u sei git -C /data/build/seid/ fetch origin \
+&& sudo -u sei git -C /data/build/seid/ checkout "${SEID_REF:?}" \
+&& sudo -u sei bash -c 'source /etc/profile.d/02-golang.sh && cd /data/build/seid && make install' \
+&& sudo cp /home/sei/go/bin/seid /usr/local/bin/seid-"${SEID_REF:?}"
+```
+
+Then from your developer machine now, run the following commands which download from the VM the binary locally and then build a Docker image from it.
+
+Adjust the `TAG` export to use a repository you control, the `SEID_REF` to fit with the correct version.
+
+```
+# Assumed to be in `sei-chain` root folder, replace `sei0` in scp command to fit your own machine's name
+
+export SEID_REF=v5.5.6-fh3.0 \
+&& export FIREETH=v2.6.2 \
+&& export TAG="ghcr.io/streamingfast/firehose-ethereum:${FIREETH:?}-sei-${SEID_REF:?}" \
+&& scp sei0:/usr/local/bin/seid-${SEID_REF:?} . \
+&& docker build --platform=linux/amd64 --build-arg="FIREETH=${FIREETH:?}" --build-arg="SEID_BIN=seid-${SEID_REF:?}" -t "${TAG:?}" -f Dockerfile.sf . \
+&& docker run --platform=linux/amd64 --rm -it "${TAG:?}" seid version \
+&& docker push "${TAG:?}"
+```

app/app.go

@@ -8,6 +8,7 @@ import (
 	"fmt"
 	"io"
 	"math"
+	"math/big"
 	"net/http"
 	"os"
 	"path/filepath"
@@ -102,6 +103,9 @@ import (
 	ibcporttypes "github.com/cosmos/ibc-go/v3/modules/core/05-port/types"
 	ibchost "github.com/cosmos/ibc-go/v3/modules/core/24-host"
 	ibckeeper "github.com/cosmos/ibc-go/v3/modules/core/keeper"
+	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/gorilla/mux"
@@ -126,6 +130,8 @@ import (
 	evmkeeper "github.com/sei-protocol/sei-chain/x/evm/keeper"
 	"github.com/sei-protocol/sei-chain/x/evm/querier"
 	"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/sei-protocol/sei-chain/x/mint"
 	mintclient "github.com/sei-protocol/sei-chain/x/mint/client/cli"
@@ -370,6 +376,7 @@ type App struct {
 
 	encodingConfig        appparams.EncodingConfig
 	evmRPCConfig          evmrpc.Config
+	evmTracer             *tracing.Hooks
 	lightInvarianceConfig LightInvarianceConfig
 
 	genesisImportConfig genesistypes.GenesisImportConfig
@@ -979,6 +986,15 @@ func New(
 
 	app.RegisterDeliverTxHook(app.AddCosmosEventsToEVMReceiptIfApplicable)
 
+	if app.evmRPCConfig.LiveEVMTracer != "" {
+		chainConfig := evmtypes.DefaultChainConfig().EthereumConfig(app.EvmKeeper.ChainID(app.GetCheckCtx()))
+		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
+	}
+
 	return app
 }
 
@@ -1464,11 +1480,20 @@ func (app *App) ExecuteTxsConcurrently(ctx sdk.Context, txs [][]byte, typedTxs [
 }
 
 func (app *App) GetDeliverTxEntry(ctx sdk.Context, txIndex int, absoluateIndex int, bz []byte, tx sdk.Tx) (res *sdk.DeliverTxEntry) {
+	var txTracer sdk.TxTracer
+	if app.evmTracer != nil {
+		txTracer = app.evmTracer
+		if app.evmTracer.GetTxTracer != nil {
+			txTracer = app.evmTracer.GetTxTracer(absoluateIndex)
+		}
+	}
+
 	res = &sdk.DeliverTxEntry{
 		Request:       abci.RequestDeliverTx{Tx: bz},
 		SdkTx:         tx,
 		Checksum:      sha256.Sum256(bz),
 		AbsoluteIndex: absoluateIndex,
+		TxTracer:      txTracer,
 	}
 	if tx == nil {
 		return
@@ -1553,10 +1578,14 @@ 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, simulate bool) ([]abci.Event, []*abci.ExecTxResult, abci.ResponseEndBlock, error) {
+func (app *App) ProcessBlock(ctx sdk.Context, txs [][]byte, req BlockProcessRequest, lastCommit abci.CommitInfo, simulate bool) (events []abci.Event, txResults []*abci.ExecTxResult, endBlockResp abci.ResponseEndBlock, err error) {
 	ctx = ctx.WithIsOCCEnabled(app.OccEnabled())
 
-	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 {
@@ -1583,9 +1612,16 @@ func (app *App) ProcessBlock(ctx sdk.Context, txs [][]byte, req BlockProcessRequ
 	events = append(events, beginBlockResp.Events...)
 
 	evmTxs := make([]*evmtypes.MsgEVMTransaction, len(txs)) // nil for non-EVM txs
-	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
@@ -1622,7 +1658,7 @@ func (app *App) ProcessBlock(ctx sdk.Context, txs [][]byte, req BlockProcessRequ
 		}
 	}
 
-	endBlockResp := app.EndBlock(ctx, abci.RequestEndBlock{
+	endBlockResp = app.EndBlock(ctx, abci.RequestEndBlock{
 		Height:       req.GetHeight(),
 		BlockGasUsed: evmTotalGasUsed,
 	})
@@ -2038,3 +2074,40 @@ 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) {
+	noGasBillingCtx := ctx.WithGasMeter(storetypes.NewNoConsumptionInfiniteGasMeter())
+
+	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(noGasBillingCtx),
+		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(noGasBillingCtx).RoundInt().BigInt(),
+	}
+
+	return
+}

app/eth_replay.go

@@ -13,7 +13,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/ethereum/go-ethereum/common"
 	ethcore "github.com/ethereum/go-ethereum/core"
-	"github.com/ethereum/go-ethereum/core/tracing"
+	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"
@@ -85,7 +85,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, tracing.BalanceIncreaseWithdrawal)
+			s.AddBalance(w.Address, amount, ethtracing.BalanceIncreaseWithdrawal)
 		}
 		_, _ = s.Finalize()
 		for _, tx := range b.Txs {