refactor: add error field in cctx (#2952)

* feat: add error field in cctx

* feat: divide messages into status and error

* fix unit tests

* add function to update error messages

* add query to get cctx error message

* fix error messages

* reviews suggestions

* include new generated files

* make every msg lowercase

* applied suggestions

changelog.md

@@ -26,6 +26,7 @@
 * [2826](https://github.com/zeta-chain/node/pull/2826) - remove unused code from emissions module and add new parameter for fixed block reward amount
 * [2890](https://github.com/zeta-chain/node/pull/2890) - refactor `MsgUpdateChainInfo` to accept a single chain, and add `MsgRemoveChainInfo` to remove a chain
 * [2899](https://github.com/zeta-chain/node/pull/2899) - remove btc deposit fee v1 and improve unit tests
+* [2952](https://github.com/zeta-chain/node/pull/2952) - add error_message to cctx.status
 
 ### Tests
 

docs/openapi/openapi.swagger.yaml

@@ -58446,6 +58446,14 @@ definitions:
  $ref: '#/definitions/crosschainCctxStatus'
  status_message:
  type: string
+ description: |-
+ status_message carries information about the status transitions:
+ why they were triggered, old and new status.
+ error_message:
+ type: string
+ description: |-
+ error_message carries information about the error that caused the tx
+ to be PendingRevert, Reverted or Aborted.
  lastUpdate_timestamp:
  type: string
  format: int64

e2e/e2etests/test_eth_deposit_call.go

@@ -87,6 +87,6 @@ func TestEtherDepositAndCall(r *runner.E2ERunner, args []string) {
 
  r.Logger.Info("Cross-chain call to reverter reverted")
 
- // check the status message contains revert error hash in case of revert
- require.Contains(r, cctx.CctxStatus.StatusMessage, utils.ErrHashRevertFoo)
+ // Check the error carries the revert executed.
+ require.Contains(r, cctx.CctxStatus.ErrorMessage, "revert executed")
 }

e2e/e2etests/test_solana_deposit_refund.go

@@ -31,6 +31,6 @@ func TestSolanaDepositAndCallRefund(r *runner.E2ERunner, args []string) {
  r.Logger.CCTX(*cctx, "solana_deposit_and_refund")
  utils.RequireCCTXStatus(r, cctx, crosschaintypes.CctxStatus_Reverted)
 
- // check the status message contains revert error hash in case of revert
- require.Contains(r, cctx.CctxStatus.StatusMessage, utils.ErrHashRevertFoo)
+ // Check the error carries the revert executed.
+ require.Contains(r, cctx.CctxStatus.ErrorMessage, "revert executed")
 }

proto/zetachain/zetacore/crosschain/cross_chain_tx.proto

@@ -17,7 +17,7 @@ enum CctxStatus {
  Reverted = 5; // inbound reverted.
  Aborted =
  6; // inbound tx error or invalid paramters and cannot revert; just abort.
- // But the amount can be refunded to zetachain using and admin proposal
+  // But the amount can be refunded to zetachain using and admin proposal
 }
 
 enum TxFinalizationStatus {
@@ -94,7 +94,12 @@ message OutboundParams {
 
 message Status {
  CctxStatus status = 1;
+ // status_message carries information about the status transitions:
+ // why they were triggered, old and new status.
  string status_message = 2;
+ // error_message carries information about the error that caused the tx
+ // to be PendingRevert, Reverted or Aborted.
+ string error_message = 6;
  int64 lastUpdate_timestamp = 3;
  bool isAbortRefunded = 4;
  // when the CCTX was created. only populated on new transactions.

testutil/sample/crosschain.go

@@ -191,6 +191,7 @@ func Status(t *testing.T, index string) *types.Status {
  return &types.Status{
  Status: types.CctxStatus(r.Intn(100)),
  StatusMessage: String(),
+ ErrorMessage: String(),
  CreatedTimestamp: createdAt,
  LastUpdateTimestamp: createdAt,
  }

typescript/zetachain/zetacore/crosschain/cross_chain_tx_pb.d.ts

@@ -355,10 +355,21 @@ export declare class Status extends Message<Status> {
  status: CctxStatus;
 
  /**
+ * status_message carries information about the status transitions:
+ * why they were triggered, old and new status.
+ *
  * @generated from field: string status_message = 2;
  */
  statusMessage: string;
 
+ /**
+ * error_message carries information about the error that caused the tx
+ * to be PendingRevert, Reverted or Aborted.
+ *
+ * @generated from field: string error_message = 6;
+ */
+ errorMessage: string;
+
  /**
  * @generated from field: int64 lastUpdate_timestamp = 3;
  */

x/crosschain/keeper/cctx_gateway_observers.go

@@ -75,7 +75,7 @@ func (c CCTXGatewayObservers) InitiateOutbound(
  }()
  if err != nil {
  // do not commit anything here as the CCTX should be aborted
- config.CCTX.SetAbort(err.Error())
+ config.CCTX.SetAbort("internal error", err.Error())
  return types.CctxStatus_Aborted, err
  }
  commit()

x/crosschain/keeper/cctx_gateway_zevm.go

@@ -28,7 +28,9 @@ func (c CCTXGatewayZEVM) InitiateOutbound(
 
  if err != nil && !isContractReverted {
  // exceptional case; internal error; should abort CCTX
- config.CCTX.SetAbort(err.Error())
+ config.CCTX.SetAbort(
+ "error during deposit that is not smart contract revert",
+ err.Error())
  return types.CctxStatus_Aborted, err
  }
 

x/crosschain/keeper/cctx_orchestrator_validate_outbound.go

@@ -53,7 +53,9 @@ func (k Keeper) ValidateOutboundZEVM(
  cctx.InboundParams.Amount,
  )
  if err != nil {
- cctx.SetAbort(fmt.Sprintf("%s : %s", depositErr, err.Error()))
+ cctx.SetAbort(
+ "revert failed",
+ fmt.Sprintf("deposit error: %s, processing error: %s", depositErr.Error(), err.Error()))
  return types.CctxStatus_Aborted
  }
 
@@ -122,7 +124,7 @@ func (k Keeper) processFailedOutboundObservers(ctx sdk.Context, cctx *types.Cros
  if cctx.InboundParams.CoinType == coin.CoinType_Cmd {
  // if the cctx is of coin type cmd or the sender chain is zeta chain, then we do not revert, the cctx is aborted
  cctx.GetCurrentOutboundParam().TxFinalizationStatus = types.TxFinalizationStatus_Executed
- cctx.SetAbort("Outbound failed, cmd cctx reverted")
+ cctx.SetAbort("", "outbound failed for admin tx")
  } else if chains.IsZetaChain(cctx.InboundParams.SenderChainId, k.GetAuthorityKeeper().GetAdditionalChainList(ctx)) {
  switch cctx.InboundParams.CoinType {
  // Try revert if the coin-type is ZETA
@@ -137,7 +139,7 @@ func (k Keeper) processFailedOutboundObservers(ctx sdk.Context, cctx *types.Cros
  default:
  {
  cctx.GetCurrentOutboundParam().TxFinalizationStatus = types.TxFinalizationStatus_Executed
- cctx.SetAbort("Outbound failed for non-ZETA cctx")
+ cctx.SetAbort("", "outbound failed for non-ZETA cctx")
  }
  }
  } else {
@@ -195,10 +197,10 @@ func (k Keeper) processFailedOutboundOnExternalChain(
  return err
  }
  // Not setting the finalization status here, the required changes have been made while creating the revert tx
- cctx.SetPendingRevert(revertMsg)
+ cctx.SetPendingRevert("", revertMsg)
  case types.CctxStatus_PendingRevert:
  cctx.GetCurrentOutboundParam().TxFinalizationStatus = types.TxFinalizationStatus_Executed
- cctx.SetAbort("Outbound failed: revert failed; abort TX")
+ cctx.SetAbort("aborted while processing failed outbound", "outbound and revert failed")
  }
  return nil
 }
@@ -225,9 +227,9 @@ func (k Keeper) processSuccessfulOutbound(
  oldStatus := cctx.CctxStatus.Status
  switch oldStatus {
  case types.CctxStatus_PendingRevert:
- cctx.SetReverted("Outbound succeeded, revert executed")
+ cctx.SetReverted("", "revert executed")
  case types.CctxStatus_PendingOutbound:
- cctx.SetOutboundMined("Outbound succeeded, mined")
+ cctx.SetOutboundMined("")
  default:
  return
  }
@@ -256,7 +258,7 @@ func (k Keeper) processFailedZETAOutboundOnZEVM(ctx sdk.Context, cctx *types.Cro
  }
 
  // Trying to revert the transaction this would get set to a finalized status in the same block as this does not need a TSS singing
- cctx.SetPendingRevert("Outbound failed, trying revert")
+ cctx.SetPendingRevert("", "outbound failed")
  data, err := base64.StdEncoding.DecodeString(cctx.RelayedMessage)
  if err != nil {
  return fmt.Errorf("failed decoding relayed message: %s", err.Error())
@@ -290,7 +292,7 @@ func (k Keeper) processFailedZETAOutboundOnZEVM(ctx sdk.Context, cctx *types.Cro
  return fmt.Errorf("failed ZETARevertAndCallContract: %s", err.Error())
  }
 
- cctx.SetReverted("Outbound failed, revert executed")
+ cctx.SetReverted("", "outbound failed")
  if len(ctx.TxBytes()) > 0 {
  // add event for tendermint transaction hash format
  hash := tmbytes.HexBytes(tmtypes.Tx(ctx.TxBytes()).Hash())
@@ -336,7 +338,7 @@ func (k Keeper) processFailedOutboundV2(ctx sdk.Context, cctx *types.CrossChainT
  }
 
  // update status
- cctx.SetPendingRevert("Outbound failed, trying revert")
+ cctx.SetPendingRevert("", "outbound failed")
 
  // process the revert on ZEVM
  if err := k.fungibleKeeper.ProcessV2RevertDeposit(
@@ -354,7 +356,7 @@ func (k Keeper) processFailedOutboundV2(ctx sdk.Context, cctx *types.CrossChainT
  }
 
  // tx is reverted
- cctx.SetReverted("Outbound failed, revert executed")
+ cctx.SetReverted("", "outbound failed")
 
  // add event for tendermint transaction hash format
  if len(ctx.TxBytes()) > 0 {
@@ -367,7 +369,7 @@ func (k Keeper) processFailedOutboundV2(ctx sdk.Context, cctx *types.CrossChainT
  cctx.GetCurrentOutboundParam().TxFinalizationStatus = types.TxFinalizationStatus_Executed
  case types.CctxStatus_PendingRevert:
  cctx.GetCurrentOutboundParam().TxFinalizationStatus = types.TxFinalizationStatus_Executed
- cctx.SetAbort("Outbound failed: revert failed; abort TX")
+ cctx.SetAbort("aborted while processing failed outbound", "outbound and revert failed")
  }
  return nil
 }

x/crosschain/keeper/cctx_test.go

@@ -170,7 +170,6 @@ func TestCCTXs(t *testing.T) {
  require.True(t, found)
  require.Equal(t, s, send)
  }
-
  })
  }
 }

x/crosschain/keeper/initiate_outbound_test.go

@@ -76,7 +76,7 @@ func TestKeeper_InitiateOutboundZEVMDeposit(t *testing.T) {
  require.ErrorContains(t, err, "deposit error")
  require.Equal(t, types.CctxStatus_Aborted, cctx.CctxStatus.Status)
  require.Equal(t, types.CctxStatus_Aborted, newStatus)
- require.Equal(t, "deposit error", cctx.CctxStatus.StatusMessage)
+ require.Equal(t, "deposit error", cctx.CctxStatus.ErrorMessage)
  })
 
  t.Run(
@@ -111,7 +111,7 @@ func TestKeeper_InitiateOutboundZEVMDeposit(t *testing.T) {
  require.Equal(t, types.CctxStatus_Aborted, newStatus)
  require.Contains(
  t,
- cctx.CctxStatus.StatusMessage,
+ cctx.CctxStatus.ErrorMessage,
  "chain not supported",
  )
  },
@@ -151,7 +151,7 @@ func TestKeeper_InitiateOutboundZEVMDeposit(t *testing.T) {
  require.Equal(t, types.CctxStatus_Aborted, newStatus)
  require.Contains(
  t,
- cctx.CctxStatus.StatusMessage,
+ cctx.CctxStatus.ErrorMessage,
  "GetRevertGasLimit: foreign coin not found for sender chain",
  )
  })
@@ -194,7 +194,7 @@ func TestKeeper_InitiateOutboundZEVMDeposit(t *testing.T) {
  require.Equal(t, types.CctxStatus_Aborted, newStatus)
  require.Contains(
  t,
- cctx.CctxStatus.StatusMessage,
+ cctx.CctxStatus.ErrorMessage,
  "chain not supported",
  )
  },
@@ -239,7 +239,7 @@ func TestKeeper_InitiateOutboundZEVMDeposit(t *testing.T) {
  require.Equal(t, types.CctxStatus_Aborted, newStatus)
  require.Contains(
  t,
- cctx.CctxStatus.StatusMessage,
+ cctx.CctxStatus.ErrorMessage,
  "chain not supported",
  )
  },
@@ -284,7 +284,7 @@ func TestKeeper_InitiateOutboundZEVMDeposit(t *testing.T) {
  require.NoError(t, err)
  require.Equal(t, types.CctxStatus_Aborted, cctx.CctxStatus.Status)
  require.Equal(t, types.CctxStatus_Aborted, newStatus)
- require.Contains(t, cctx.CctxStatus.StatusMessage, "cannot find receiver chain nonce")
+ require.Contains(t, cctx.CctxStatus.ErrorMessage, "cannot find receiver chain nonce")
  })
 
  t.Run("unable to process zevm deposit HandleEVMDeposit revert successfully", func(t *testing.T) {
@@ -321,7 +321,7 @@ func TestKeeper_InitiateOutboundZEVMDeposit(t *testing.T) {
  require.NoError(t, err)
  require.Equal(t, types.CctxStatus_PendingRevert, cctx.CctxStatus.Status)
  require.Equal(t, types.CctxStatus_PendingRevert, newStatus)
- require.Equal(t, errDeposit.Error(), cctx.CctxStatus.StatusMessage)
+ require.Equal(t, errDeposit.Error(), cctx.CctxStatus.ErrorMessage)
  require.Equal(t, updatedNonce, cctx.GetCurrentOutboundParam().TssNonce)
  })
 
@@ -361,7 +361,7 @@ func TestKeeper_InitiateOutboundZEVMDeposit(t *testing.T) {
  require.Equal(t, types.CctxStatus_Aborted, newStatus)
  require.Contains(
  t,
- cctx.CctxStatus.StatusMessage,
+ cctx.CctxStatus.ErrorMessage,
  "cannot revert a revert tx",
  )
  },
@@ -427,7 +427,7 @@ func TestKeeper_InitiateOutboundProcessCrosschainMsgPassing(t *testing.T) {
  require.ErrorIs(t, err, observertypes.ErrSupportedChains)
  require.Equal(t, types.CctxStatus_Aborted, cctx.CctxStatus.Status)
  require.Equal(t, types.CctxStatus_Aborted, newStatus)
- require.Equal(t, observertypes.ErrSupportedChains.Error(), cctx.CctxStatus.StatusMessage)
+ require.Equal(t, observertypes.ErrSupportedChains.Error(), cctx.CctxStatus.ErrorMessage)
  })
 
  t.Run("unable to process crosschain msg passing UpdateNonce fails", func(t *testing.T) {
@@ -456,7 +456,7 @@ func TestKeeper_InitiateOutboundProcessCrosschainMsgPassing(t *testing.T) {
  require.ErrorContains(t, err, "cannot find receiver chain nonce")
  require.Equal(t, types.CctxStatus_Aborted, cctx.CctxStatus.Status)
  require.Equal(t, types.CctxStatus_Aborted, newStatus)
- require.Contains(t, cctx.CctxStatus.StatusMessage, "cannot find receiver chain nonce")
+ require.Contains(t, cctx.CctxStatus.ErrorMessage, "cannot find receiver chain nonce")
  })
 }
 

x/crosschain/keeper/msg_server_migrate_tss_funds.go

@@ -9,7 +9,6 @@ import (
  tmbytes "github.com/cometbft/cometbft/libs/bytes"
  tmtypes "github.com/cometbft/cometbft/types"
  sdk "github.com/cosmos/cosmos-sdk/types"
- "github.com/cosmos/cosmos-sdk/types/errors"
 
  authoritytypes "github.com/zeta-chain/node/x/authority/types"
  "github.com/zeta-chain/node/x/crosschain/types"
@@ -26,7 +25,7 @@ func (k msgServer) MigrateTssFunds(
  // check if authorized
  err := k.GetAuthorityKeeper().CheckAuthorization(ctx, msg)
  if err != nil {
- return nil, errors.Wrap(authoritytypes.ErrUnauthorized, err.Error())
+ return nil, errorsmod.Wrap(authoritytypes.ErrUnauthorized, err.Error())
  }
 
  if k.zetaObserverKeeper.IsInboundEnabled(ctx) {

x/crosschain/keeper/msg_server_vote_inbound_tx_test.go

@@ -265,7 +265,7 @@ func TestKeeper_VoteInbound(t *testing.T) {
  })
 }
 
-func TestStatus_ChangeStatus(t *testing.T) {
+func TestStatus_UpdateCctxStatus(t *testing.T) {
  tt := []struct {
  Name string
  Status types.Status
@@ -302,7 +302,7 @@ func TestStatus_ChangeStatus(t *testing.T) {
  for _, test := range tt {
  test := test
  t.Run(test.Name, func(t *testing.T) {
- test.Status.ChangeStatus(test.NonErrStatus, test.Msg)
+ test.Status.UpdateStatusAndErrorMessages(test.NonErrStatus, test.Msg, "")
  if test.IsErr {
  require.Equal(t, test.ErrStatus, test.Status.Status)
  } else {

x/crosschain/keeper/msg_server_vote_outbound_tx.go

@@ -185,7 +185,7 @@ SaveFailedOutbound saves a failed outbound transaction.It does the following thi
 */
 
 func (k Keeper) SaveFailedOutbound(ctx sdk.Context, cctx *types.CrossChainTx, errMessage string, tssPubkey string) {
- cctx.SetAbort(errMessage)
+ cctx.SetAbort("", errMessage)
  ctx.Logger().Error(errMessage)
  k.SaveOutbound(ctx, cctx, tssPubkey)
 }

x/crosschain/migrations/v5/migrate.go

@@ -137,6 +137,7 @@ func SetZetaAccounting(
 
  return nil
 }
+
 func GetAbortedAmount(cctx types.CrossChainTx) sdkmath.Uint {
  if cctx.OutboundParams != nil && !cctx.GetCurrentOutboundParam().Amount.IsZero() {
  return cctx.GetCurrentOutboundParam().Amount