feat: Namadillo - Improve gasLimit error (#1977)

Author: jurevans

apps/namadillo/src/lib/query.ts

@@ -18,6 +18,7 @@ import {
   TransactionEventsClasses,
   TransactionEventsStatus,
 } from "types/events";
+import { toErrorDetail } from "utils";
 import { getSdkInstance } from "utils/sdk";
 
 export type TransactionPair<T> = {
@@ -234,7 +235,7 @@ export const broadcastTxWithEvents = async <T>(
       if (result.status === "fulfilled") {
         return result.value.commitments;
       } else {
-        throw new Error(result.reason.toString());
+        throw new Error(toErrorDetail(encodedTx.txs, result.reason));
       }
     });
 

apps/namadillo/src/utils/index.ts

@@ -1,6 +1,12 @@
 import { Asset, AssetDenomUnit } from "@chain-registry/types";
 import namadaAssets from "@namada/chain-registry/namada/assetlist.json";
-import { ProposalStatus, ProposalTypeString } from "@namada/types";
+import {
+  BroadcastTxError,
+  ProposalStatus,
+  ProposalTypeString,
+  ResultCode,
+  TxMsgValue,
+} from "@namada/types";
 import { localnetConfigAtom } from "atoms/integrations/atoms";
 import BigNumber from "bignumber.js";
 import { getDefaultStore } from "jotai";
@@ -114,3 +120,22 @@ export const toBaseAmount = (
   }
   return displayAmount.shiftedBy(displayUnit.exponent);
 };
+
+/**
+ * Returns formatted error message based on tx props and error code
+ */
+export const toErrorDetail = (
+  tx: TxMsgValue[],
+  error: BroadcastTxError
+): string => {
+  const { gasLimit } = tx[0].args;
+  const { code } = error.toProps();
+
+  // TODO: Over time we may expand this to format errors for more result codes
+  switch (code) {
+    case ResultCode.TxGasLimit:
+      return `${error.toString()} Please raise the Gas Amount above the previously provided ${gasLimit} in the fee options for your transaction.`;
+    default:
+      return error.toString();
+  }
+};

packages/types/src/tx/types.ts

@@ -108,7 +108,7 @@ export const ResultCodes: Record<ResultCode, string> = {
   [ResultCode.ReplayTx]: "Replayed tx",
   [ResultCode.InvalidChainId]: "Invalid chain ID",
   [ResultCode.ExpiredTx]: "Expired tx",
-  [ResultCode.TxGasLimit]: "Exceeded gas limit",
+  [ResultCode.TxGasLimit]: "Transaction gas required exceeds the gas limit.",
   [ResultCode.FeeError]: "Error in paying tx fee",
   [ResultCode.InvalidVoteExtension]: "Invalid vote extension",
   [ResultCode.TooLarge]: "Tx is too large",