feat: support call reverted

Author: enzoferey

README.md

@@ -71,6 +71,7 @@ Here is the complete list of returned objects:
 | `TRANSACTION_RAN_OUT_OF_GAS`                           | The transaction gas limit as a string.                                     |
 | `TRANSACTION_UNDERPRICED`                              | `undefined`                                                                |
 | `REJECTED_TRANSACTION`                                 | The reason why the transaction rejected.                                   |
+| `CALL_REVERTED`                                        | The reason why the call reverted.                                          |
 | `EXECUTION_REVERTED`                                   | The reason why the transaction reverted.                                   |
 | `NONCE_TOO_LOW`                                        | The transaction nonce as a string.                                         |
 | `INSUFFICIENT_FUNDS_FOR_GAS`                           | `undefined`                                                                |

lib/__tests__/getParsedEthersError.test.ts

@@ -82,6 +82,20 @@ describe("getParsedEthersError", () => {
       context: message,
     });
   });
+  it("should handle calls reverted via code", () => {
+    const reason = "TOKEN_ID_DOES_NOT_EXIST";
+
+    const result = getParsedEthersError({
+      message: "",
+      code: ETHERS_ERROR_CODES.CALL_EXCEPTION,
+      reason,
+    });
+
+    expect(result).toEqual({
+      errorCode: RETURN_VALUE_ERROR_CODES.CALL_REVERTED,
+      context: reason,
+    });
+  });
   it("should handle transaction rejected via code", () => {
     const message = "User rejected transaction";
 

lib/constants.ts

@@ -2,6 +2,7 @@ export const RETURN_VALUE_ERROR_CODES = {
   TRANSACTION_RAN_OUT_OF_GAS: "TRANSACTION_RAN_OUT_OF_GAS",
   TRANSACTION_UNDERPRICED: "TRANSACTION_UNDERPRICED",
   REJECTED_TRANSACTION: "REJECTED_TRANSACTION",
+  CALL_REVERTED: "CALL_REVERTED",
   EXECUTION_REVERTED: "EXECUTION_REVERTED",
   NONCE_TOO_LOW: "NONCE_TOO_LOW",
   INSUFFICIENT_FUNDS_FOR_GAS: "INSUFFICIENT_FUNDS_FOR_GAS",
@@ -16,6 +17,7 @@ export const ETHERS_ERROR_CODES = {
   NONCE_EXPIRED: "NONCE_EXPIRED",
   UNPREDICTABLE_GAS_LIMIT: "UNPREDICTABLE_GAS_LIMIT",
   ACTION_REJECTED: "ACTION_REJECTED",
+  CALL_EXCEPTION: "CALL_EXCEPTION",
 };
 
 export const NESTED_ETHERS_ERROR_CODES = {

lib/types.ts

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

lib/utils/getTopLevelKnownError.ts

@@ -26,6 +26,16 @@ export function getTopLevelKnownError(
     };
   }
 
+  if (
+    ethersError.code === ETHERS_ERROR_CODES.CALL_EXCEPTION &&
+    ethersError.reason !== undefined
+  ) {
+    return {
+      errorCode: RETURN_VALUE_ERROR_CODES.CALL_REVERTED,
+      context: ethersError.reason,
+    };
+  }
+
   const unpredictableGasLimitError = getUnpredictableGasLimitError(ethersError);
   if (unpredictableGasLimitError !== undefined) {
     return unpredictableGasLimitError;