chore(evm, feemarket) - Migrate Event emitting to TypedEvent

CHANGELOG.md

@@ -64,6 +64,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Improvements
 
+* (evm) [#1544](https:/evmos/ethermint/pull/1544) Migrate deprecated event emitting to new TypedEvent
 * (tests) [#1507](https:/evmos/ethermint/pull/1507) Remove legacy sim tests
 * (feemarket) [#1508](https:/evmos/ethermint/pull/1508) Remove old x/params migration logic
 * (evm) [#1499](https:/evmos/ethermint/pull/1499) Add Shanghai and Cancun block

proto/ethermint/evm/v1/events.proto

@@ -0,0 +1,44 @@
+syntax = "proto3";
+package ethermint.evm.v1;
+
+option go_package = "github.com/evmos/ethermint/x/evm/types";
+
+// EventEthereumTx defines the event for a Ethereum transaction
+message EventEthereumTx {
+ // amount
+ string amount = 1;
+ // eth_hash Ethereum hash of the transaction
+ string eth_hash = 2;
+ // index of the transaction in the block
+ string index = 3;
+ // gas_used is the amount of gas used by the transaction
+ string gas_used = 4;
+ // hash Tendermint hash of the transaction
+ string hash = 5;
+ // recipient of the transaction
+ string recipient = 6;
+ // eth_tx_failed the VM error
+ string eth_tx_failed = 7;
+}
+
+// EventTxLog defines the event for a Ethereum transaction log
+message EventTxLog {
+ // tx_logs is the log of the transaction
+ repeated string tx_logs = 1;
+}
+
+// EventMessage
+message EventMessage {
+ // module is the module of the message
+ string module = 1;
+ // sender is the sender of the message
+ string sender = 2;
+ // tx_type is the type of the message
+ string tx_type = 3;
+}
+
+// EventBlockBloom defines the event for a Ethereum block bloom filter
+message EventBlockBloom {
+ // bloom is the bloom filter of the block
+ string bloom = 1;
+}

proto/ethermint/feemarket/v1/events.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+package ethermint.feemarket.v1;
+
+option go_package = "github.com/evmos/ethermint/x/feemarket/types";
+
+// EventFeeMarket is the event type for the fee market module
+message EventFeeMarket {
+ // base_fee for EIP-1559 blocks
+ string base_fee = 1;
+}
+
+// EventBlockGas defines the event for a Ethereum block gas
+message EventBlockGas {
+ // height is the height of the block
+ string height = 1;
+ // amount of gas wanted by the block
+ string amount = 2;
+}

x/evm/keeper/abci_test.go

@@ -1,7 +1,6 @@
 package keeper_test
 
 import (
- evmtypes "github.com/evmos/ethermint/x/evm/types"
  "github.com/tendermint/tendermint/abci/types"
 )
 
@@ -14,5 +13,5 @@ func (suite *KeeperTestSuite) TestEndBlock() {
 
  // should emit 1 EventTypeBlockBloom event on EndBlock
  suite.Require().Equal(1, len(em.Events()))
- suite.Require().Equal(evmtypes.EventTypeBlockBloom, em.Events()[0].Type)
+ suite.Require().Equal("ethermint.evm.v1.EventBlockBloom", em.Events()[0].Type)
 }

x/evm/keeper/keeper.go

@@ -133,11 +133,10 @@ func (k Keeper) ChainID() *big.Int {
 
 // EmitBlockBloomEvent emit block bloom events
 func (k Keeper) EmitBlockBloomEvent(ctx sdk.Context, bloom ethtypes.Bloom) {
- ctx.EventManager().EmitEvent(
- sdk.NewEvent(
- types.EventTypeBlockBloom,
- sdk.NewAttribute(types.AttributeKeyEthereumBloom, string(bloom.Bytes())),
- ),
+ _ = ctx.EventManager().EmitTypedEvent(
+ &types.EventBlockBloom{
+ Bloom: string(bloom.Bytes()),
+ },
  )
 }
 

x/evm/keeper/msg_server.go

@@ -72,56 +72,52 @@ func (k *Keeper) EthereumTx(goCtx context.Context, msg *types.MsgEthereumTx) (*t
  }
  }()
 
- attrs := []sdk.Attribute{
- sdk.NewAttribute(sdk.AttributeKeyAmount, tx.Value().String()),
+ eventEthereumTx := &types.EventEthereumTx{
+ Amount: tx.Value().String(),
  // add event for ethereum transaction hash format
- sdk.NewAttribute(types.AttributeKeyEthereumTxHash, response.Hash),
+ EthHash: response.Hash,
  // add event for index of valid ethereum tx
- sdk.NewAttribute(types.AttributeKeyTxIndex, strconv.FormatUint(txIndex, 10)),
+ Index: strconv.FormatUint(txIndex, 10),
  // add event for eth tx gas used, we can't get it from cosmos tx result when it contains multiple eth tx msgs.
- sdk.NewAttribute(types.AttributeKeyTxGasUsed, strconv.FormatUint(response.GasUsed, 10)),
+ GasUsed: strconv.FormatUint(response.GasUsed, 10),
  }
 
  if len(ctx.TxBytes()) > 0 {
  // add event for tendermint transaction hash format
  hash := tmbytes.HexBytes(tmtypes.Tx(ctx.TxBytes()).Hash())
- attrs = append(attrs, sdk.NewAttribute(types.AttributeKeyTxHash, hash.String()))
+ eventEthereumTx.Hash = hash.String()
  }
 
  if to := tx.To(); to != nil {
- attrs = append(attrs, sdk.NewAttribute(types.AttributeKeyRecipient, to.Hex()))
+ eventEthereumTx.Recipient = to.Hex()
  }
 
  if response.Failed() {
- attrs = append(attrs, sdk.NewAttribute(types.AttributeKeyEthereumTxFailed, response.VmError))
+ eventEthereumTx.EthTxFailed = response.VmError
  }
 
- txLogAttrs := make([]sdk.Attribute, len(response.Logs))
+ eventTxLogs := &types.EventTxLog{TxLogs: make([]string, len(response.Logs))}
  for i, log := range response.Logs {
  value, err := json.Marshal(log)
  if err != nil {
  return nil, errorsmod.Wrap(err, "failed to encode log")
  }
- txLogAttrs[i] = sdk.NewAttribute(types.AttributeKeyTxLog, string(value))
+ eventTxLogs.TxLogs[i] = string(value)
  }
 
- // emit events
- ctx.EventManager().EmitEvents(sdk.Events{
- sdk.NewEvent(
- types.EventTypeEthereumTx,
- attrs...,
- ),
- sdk.NewEvent(
- types.EventTypeTxLog,
- txLogAttrs...,
- ),
- sdk.NewEvent(
- sdk.EventTypeMessage,
- sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
- sdk.NewAttribute(sdk.AttributeKeySender, sender),
- sdk.NewAttribute(types.AttributeKeyTxType, fmt.Sprintf("%d", tx.Type())),
- ),
- })
+ err = ctx.EventManager().EmitTypedEvents(
+ eventEthereumTx,
+ eventTxLogs,
+ &types.EventMessage{
+ Module: types.AttributeValueCategory,
+ Sender: sender,
+ TxType: fmt.Sprintf("%d", tx.Type()),
+ },
+ )
+
+ if err != nil {
+ k.Logger(ctx).Error(err.Error())
+ }
 
  return response, nil
 }

x/evm/keeper/state_transition.go

@@ -285,8 +285,9 @@ func (k *Keeper) ApplyTransaction(ctx sdk.Context, tx *ethtypes.Transaction) (*t
  } else if commit != nil {
  // PostTxProcessing is successful, commit the tmpCtx
  commit()
- // Since the post processing can alter the log, we need to update the result
+ // Since the post-processing can alter the log, we need to update the result
  res.Logs = types.NewLogsFromEth(receipt.Logs)
+ // TODO: figure out how to make this work with typed events
  ctx.EventManager().EmitEvents(tmpCtx.EventManager().Events())
  }
  }