refactor(evm): remove double JSON escaping of EventEthereumTx logs (#…

…2188)

* remove unused protos

* remove unnecessary functions

* rename eth_tx_failed to vmError

* Update CHANGELOG.md

* refactor(proto): remove reserved field

---------

Co-authored-by: Oleg Nikonychev <[email protected]>

CHANGELOG.md

@@ -94,6 +94,7 @@ needed to include double quotes around the hexadecimal string.
 - [#2183](https://github.com/NibiruChain/nibiru/pull/2183) - fix(evm): bank keeper extension gas meter type
 - [#2184](https://github.com/NibiruChain/nibiru/pull/2184) - test(evm): e2e tests configuration enhancements
 - [#2187](https://github.com/NibiruChain/nibiru/pull/2187) - fix(evm): fix eip55 address encoding
+- [#2188](https://github.com/NibiruChain/nibiru/pull/2188) - refactor(evm): update logs emission
 - [#2192](https://github.com/NibiruChain/nibiru/pull/2192) - fix(oracle): correctly handle misscount
 
 #### Nibiru EVM | Before Audit 2 - 2024-12-06

eth/rpc/backend/tx_logs_test.go

@@ -11,7 +11,6 @@ import (
 	"github.com/ethereum/go-ethereum/crypto"
 
 	"github.com/NibiruChain/nibiru/v2/eth"
-	"github.com/NibiruChain/nibiru/v2/eth/rpc/backend"
 	"github.com/NibiruChain/nibiru/v2/x/common/testutil"
 	"github.com/NibiruChain/nibiru/v2/x/evm"
 	"github.com/NibiruChain/nibiru/v2/x/evm/embeds"
@@ -241,8 +240,10 @@ func (s *BackendSuite) assertTxLogsAndTxIndex(
 	foundEthTx := false
 	for _, event := range events {
 		if event.Type == evm.TypeUrlEventTxLog {
-			logs, err := backend.ParseTxLogsFromEvent(event)
+			eventTxLog, err := evm.EventTxLogFromABCIEvent(event)
 			s.Require().NoError(err)
+
+			logs := evm.LogsToEthereum(eventTxLog.Logs)
 			if len(expectedTxLogs) > 0 {
 				s.Require().GreaterOrEqual(len(logs), len(expectedTxLogs))
 				s.assertTxLogsMatch(expectedTxLogs, logs, txInfo)

eth/rpc/backend/utils.go

@@ -2,7 +2,6 @@
 package backend
 
 import (
-	"encoding/json"
 	"fmt"
 	"math/big"
 	"sort"
@@ -11,7 +10,6 @@ import (
 	"cosmossdk.io/errors"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
-	"github.com/cosmos/gogoproto/proto"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 
@@ -210,28 +208,10 @@ func (b *Backend) retrieveEVMTxFeesFromBlock(
 	return nil
 }
 
-// AllTxLogsFromEvents parses all ethereum logs from cosmos events
-func AllTxLogsFromEvents(events []abci.Event) ([][]*gethcore.Log, error) {
-	allLogs := make([][]*gethcore.Log, 0, 4)
-	for _, event := range events {
-		if event.Type != proto.MessageName(new(evm.EventTxLog)) {
-			continue
-		}
-
-		logs, err := ParseTxLogsFromEvent(event)
-		if err != nil {
-			return nil, err
-		}
-
-		allLogs = append(allLogs, logs)
-	}
-	return allLogs, nil
-}
-
 // TxLogsFromEvents parses ethereum logs from cosmos events for specific msg index
 func TxLogsFromEvents(events []abci.Event, msgIndex int) ([]*gethcore.Log, error) {
 	for _, event := range events {
-		if event.Type != proto.MessageName(new(evm.EventTxLog)) {
+		if event.Type != evm.TypeUrlEventTxLog {
 			continue
 		}
 
@@ -241,26 +221,13 @@ func TxLogsFromEvents(events []abci.Event, msgIndex int) ([]*gethcore.Log, error
 			continue
 		}
 
-		return ParseTxLogsFromEvent(event)
-	}
-	return nil, fmt.Errorf("eth tx logs not found for message index %d", msgIndex)
-}
-
-// ParseTxLogsFromEvent parse tx logs from one event
-func ParseTxLogsFromEvent(event abci.Event) ([]*gethcore.Log, error) {
-	eventTxLog, err := evm.EventTxLogFromABCIEvent(event)
-	if err != nil {
-		return nil, errors.Wrapf(err, "failed to parse event tx log")
-	}
-	var evmLogs []*evm.Log
-	for _, logString := range eventTxLog.TxLogs {
-		var evmLog evm.Log
-		if err = json.Unmarshal([]byte(logString), &evmLog); err != nil {
-			return nil, errors.Wrapf(err, "failed to unmarshal event tx log")
+		eventTxLog, err := evm.EventTxLogFromABCIEvent(event)
+		if err != nil {
+			return nil, errors.Wrapf(err, "failed to parse event tx log")
 		}
-		evmLogs = append(evmLogs, &evmLog)
+		return evm.LogsToEthereum(eventTxLog.Logs), nil
 	}
-	return evm.LogsToEthereum(evmLogs), nil
+	return nil, fmt.Errorf("eth tx logs not found for message index %d", msgIndex)
 }
 
 // ShouldIgnoreGasUsed returns true if the gasUsed in result should be ignored
@@ -272,16 +239,27 @@ func ShouldIgnoreGasUsed(res *abci.ResponseDeliverTx) bool {
 // GetLogsFromBlockResults returns the list of event logs from the tendermint block result response
 func GetLogsFromBlockResults(
 	blockRes *tmrpctypes.ResultBlockResults,
-) ([][]*gethcore.Log, error) {
-	blockLogs := [][]*gethcore.Log{}
+) (blockLogs [][]*gethcore.Log, err error) {
+	blockLogs = [][]*gethcore.Log{}
 	for _, txResult := range blockRes.TxsResults {
-		logs, err := AllTxLogsFromEvents(txResult.Events)
-		if err != nil {
-			return nil, err
+		txLogs := []*gethcore.Log{}
+
+		for _, event := range txResult.Events {
+			if event.Type != evm.TypeUrlEventTxLog {
+				continue
+			}
+
+			eventTxLogs, err := evm.EventTxLogFromABCIEvent(event)
+			if err != nil {
+				return nil, err
+			}
+
+			txLogs = append(txLogs, evm.LogsToEthereum(eventTxLogs.Logs)...)
 		}
 
-		blockLogs = append(blockLogs, logs...)
+		blockLogs = append(blockLogs, txLogs)
 	}
+
 	return blockLogs, nil
 }
 

eth/rpc/events_parser.go

@@ -9,7 +9,6 @@ import (
 	abci "github.com/cometbft/cometbft/abci/types"
 	tmrpctypes "github.com/cometbft/cometbft/rpc/core/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	"github.com/cosmos/gogoproto/proto"
 	gethcommon "github.com/ethereum/go-ethereum/common"
 
 	"github.com/NibiruChain/nibiru/v2/eth"
@@ -39,9 +38,6 @@ type ParsedTxs struct {
 
 // ParseTxResult parses eth tx info from the ABCI events of Eth tx msgs
 func ParseTxResult(result *abci.ResponseDeliverTx, tx sdk.Tx) (*ParsedTxs, error) {
-	eventTypePendingEthereumTx := evm.PendingEthereumTxEvent
-	eventTypeEthereumTx := proto.MessageName((*evm.EventEthereumTx)(nil))
-
 	// Parsed txs is the structure being populated from the events
 	// So far (until we allow ethereum_txs as cosmos tx messages) it'll have single tx
 	parsedTxs := &ParsedTxs{
@@ -53,7 +49,7 @@ func ParseTxResult(result *abci.ResponseDeliverTx, tx sdk.Tx) (*ParsedTxs, error
 	msgIndex := -1
 	for _, event := range result.Events {
 		// Pending tx event could be single if tx didn't succeed
-		if event.Type == eventTypePendingEthereumTx {
+		if event.Type == evm.PendingEthereumTxEvent {
 			msgIndex++
 			ethHash, txIndex, err := evm.GetEthHashAndIndexFromPendingEthereumTxEvent(event)
 			if err != nil {
@@ -66,7 +62,7 @@ func ParseTxResult(result *abci.ResponseDeliverTx, tx sdk.Tx) (*ParsedTxs, error
 			}
 			parsedTxs.Txs = append(parsedTxs.Txs, pendingTx)
 			parsedTxs.TxHashes[ethHash] = msgIndex
-		} else if event.Type == eventTypeEthereumTx { // Full event replaces the pending tx
+		} else if event.Type == evm.TypeUrlEventEthereumTx { // Full event replaces the pending tx
 			eventEthereumTx, err := evm.EventEthereumTxFromABCIEvent(event)
 			if err != nil {
 				return nil, err
@@ -84,7 +80,7 @@ func ParseTxResult(result *abci.ResponseDeliverTx, tx sdk.Tx) (*ParsedTxs, error
 				EthTxIndex: int32(ethTxIndexFromEvent),
 				EthHash:    gethcommon.HexToHash(eventEthereumTx.EthHash),
 				GasUsed:    gasUsed,
-				Failed:     len(eventEthereumTx.EthTxFailed) > 0,
+				Failed:     len(eventEthereumTx.VmError) > 0,
 			}
 			// find the pending tx to replace by tx hash
 			pendingMsgIndex, found := parsedTxs.TxHashes[committedTx.EthHash]

eth/rpc/events_parser_test.go

@@ -182,16 +182,16 @@ func pendingEthereumTxEvent(txHash string, txIndex int) abci.Event {
 }
 
 func ethereumTxEvent(txHash string, txIndex int, gasUsed int, failed bool) abci.Event {
-	failure := ""
+	var vmError string
 	if failed {
-		failure = "failed"
+		vmError = "failed"
 	}
 	event, err := sdk.TypedEventToEvent(
 		&evm.EventEthereumTx{
-			EthHash:     txHash,
-			Index:       strconv.Itoa(txIndex),
-			GasUsed:     strconv.Itoa(gasUsed),
-			EthTxFailed: failure,
+			EthHash: txHash,
+			Index:   strconv.Itoa(txIndex),
+			GasUsed: strconv.Itoa(gasUsed),
+			VmError: vmError,
 		},
 	)
 	if err != nil {

proto/eth/evm/v1/events.proto

@@ -4,6 +4,7 @@ package eth.evm.v1;
 
 import "cosmos/base/v1beta1/coin.proto";
 import "gogoproto/gogo.proto";
+import "eth/evm/v1/evm.proto";
 
 option go_package = "github.com/NibiruChain/nibiru/v2/x/evm";
 
@@ -21,14 +22,14 @@ message EventEthereumTx {
   string hash = 5;
   // recipient of the transaction
   string recipient = 6;
-  // eth_tx_failed contains a VM error should it occur
-  string eth_tx_failed = 7;
+  // vm_error contains a VM error should it occur
+  string vm_error = 7;
 }
 
 // EventTxLog defines the event for an Ethereum transaction log
 message EventTxLog {
   // tx_logs is an array of transaction logs
-  repeated string tx_logs = 1;
+  repeated Log logs = 1 [ (gogoproto.nullable) = false ];
 }
 
 // EventBlockBloom defines an Ethereum block bloom filter event

proto/eth/evm/v1/evm.proto

@@ -68,16 +68,6 @@ message State {
   string value = 2;
 }
 
-// TransactionLogs define the logs generated from a transaction execution
-// with a given hash. It it used for import/export data as transactions are not
-// persisted on blockchain state after an upgrade.
-message TransactionLogs {
-  // hash of the transaction
-  string hash = 1;
-  // logs is an array of Logs for the given transaction hash
-  repeated Log logs = 2;
-}
-
 // Log represents an protobuf compatible Ethereum Log that defines a contract
 // log event. These events are generated by the LOG opcode and stored/indexed by
 // the node.
@@ -109,31 +99,6 @@ message Log {
   bool removed = 9;
 }
 
-// TxResult stores results of Tx execution.
-message TxResult {
-  option (gogoproto.goproto_getters) = false;
-
-  // contract_address contains the ethereum address of the created contract (if
-  // any). If the state transition is an evm.Call, the contract address will be
-  // empty.
-  string contract_address = 1
-      [ (gogoproto.moretags) = "yaml:\"contract_address\"" ];
-  // bloom represents the bloom filter bytes
-  bytes bloom = 2;
-  // tx_logs contains the transaction hash and the proto-compatible ethereum
-  // logs.
-  TransactionLogs tx_logs = 3 [
-    (gogoproto.moretags) = "yaml:\"tx_logs\"",
-    (gogoproto.nullable) = false
-  ];
-  // ret defines the bytes from the execution.
-  bytes ret = 4;
-  // reverted flag is set to true when the call has been reverted
-  bool reverted = 5;
-  // gas_used notes the amount of gas consumed while execution
-  uint64 gas_used = 6;
-}
-
 // AccessTuple is the element type of an access list.
 message AccessTuple {
   option (gogoproto.goproto_getters) = false;
@@ -144,9 +109,10 @@ message AccessTuple {
   repeated string storage_keys = 2 [ (gogoproto.jsontag) = "storageKeys" ];
 }
 
-// TracerConfig stores additional tracer args. For geth it's only one attr: onlyTopCall
+// TracerConfig stores additional tracer args. For geth it's only one attr:
+// onlyTopCall
 message TracerConfig {
-  bool only_top_call = 1  [ (gogoproto.jsontag) = "onlyTopCall" ];
+  bool only_top_call = 1 [ (gogoproto.jsontag) = "onlyTopCall" ];
 }
 
 // TraceConfig holds extra parameters to trace functions.