feat: support transaction rejected via code

Author: enzoferey

lib/__tests__/getParsedEthersError.test.ts

@@ -82,7 +82,21 @@ describe("getParsedEthersError", () => {
       context: message,
     });
   });
-  it("should handle transaction rejected", () => {
+  it("should handle transaction rejected via code", () => {
+    const message = "User rejected transaction";
+
+    const result = getParsedEthersError({
+      message,
+      code: ETHERS_ERROR_CODES.ACTION_REJECTED,
+      action: "sendTransaction",
+    });
+
+    expect(result).toEqual({
+      errorCode: RETURN_VALUE_ERROR_CODES.REJECTED_TRANSACTION,
+      context: message,
+    });
+  });
+  it("should handle transaction rejected via error code", () => {
     const message = "User rejected transaction";
 
     const result = getParsedEthersError({

lib/constants.ts

@@ -15,6 +15,7 @@ export const RETURN_VALUE_ERROR_CODES = {
 export const ETHERS_ERROR_CODES = {
   NONCE_EXPIRED: "NONCE_EXPIRED",
   UNPREDICTABLE_GAS_LIMIT: "UNPREDICTABLE_GAS_LIMIT",
+  ACTION_REJECTED: "ACTION_REJECTED",
 };
 
 export const NESTED_ETHERS_ERROR_CODES = {

lib/types.ts

@@ -16,6 +16,7 @@ export interface EthersError {
   receipt?: {
     gasUsed: BigNumber;
   };
+  action?: string;
 }
 
 export interface NestedEthersError {

lib/utils/getTopLevelKnownError.ts

@@ -16,6 +16,16 @@ export function getTopLevelKnownError(
     };
   }
 
+  if (
+    ethersError.code === ETHERS_ERROR_CODES.ACTION_REJECTED &&
+    ethersError.action === "sendTransaction"
+  ) {
+    return {
+      errorCode: RETURN_VALUE_ERROR_CODES.REJECTED_TRANSACTION,
+      context: ethersError.message,
+    };
+  }
+
   const unpredictableGasLimitError = getUnpredictableGasLimitError(ethersError);
   if (unpredictableGasLimitError !== undefined) {
     return unpredictableGasLimitError;