|
| 1 | +import { describe, expect, it } from "vitest"; |
| 2 | + |
| 3 | +import type { BigNumber } from "../types"; |
| 4 | +import { ERROR_CODES, ETHERS_ERROR_CODES } from "../constants"; |
| 5 | +import { getParsedEthersError } from "../getParsedEthersError"; |
| 6 | + |
| 7 | +function getTestBigNumber(value: string): BigNumber { |
| 8 | + return { |
| 9 | + gte: (other) => { |
| 10 | + return parseFloat(value) >= parseFloat(other.toString()); |
| 11 | + }, |
| 12 | + toString: () => { |
| 13 | + return value; |
| 14 | + }, |
| 15 | + }; |
| 16 | +} |
| 17 | + |
| 18 | +describe("getParsedEthersError", () => { |
| 19 | + it("should handle transaction underpriced at the top level", () => { |
| 20 | + const result = getParsedEthersError({ |
| 21 | + code: ETHERS_ERROR_CODES.ERROR_WHILE_FORMATTING_OUTPUT_FROM_RPC, |
| 22 | + message: `RPC '{"value":{"data":{"code":${ETHERS_ERROR_CODES.TRANSACTION_UNDERPRICED}}}}'`, |
| 23 | + }); |
| 24 | + |
| 25 | + expect(result).toEqual({ |
| 26 | + errorCode: ERROR_CODES.TRANSACTION_UNDERPRICED, |
| 27 | + context: undefined, |
| 28 | + }); |
| 29 | + }); |
| 30 | + it("should handle transaction underpriced at the nested level", () => { |
| 31 | + const result = getParsedEthersError({ |
| 32 | + error: { |
| 33 | + code: ETHERS_ERROR_CODES.ERROR_WHILE_FORMATTING_OUTPUT_FROM_RPC, |
| 34 | + message: `RPC '{"value":{"data":{"code":${ETHERS_ERROR_CODES.TRANSACTION_UNDERPRICED}}}}'`, |
| 35 | + }, |
| 36 | + }); |
| 37 | + |
| 38 | + expect(result).toEqual({ |
| 39 | + errorCode: ERROR_CODES.TRANSACTION_UNDERPRICED, |
| 40 | + context: undefined, |
| 41 | + }); |
| 42 | + }); |
| 43 | + it("should handle transaction underpriced that does not provide the right JSON details", () => { |
| 44 | + const result1 = getParsedEthersError({ |
| 45 | + code: ETHERS_ERROR_CODES.ERROR_WHILE_FORMATTING_OUTPUT_FROM_RPC, |
| 46 | + message: `RPC '{"value":{"data":{"code":"SOME NON EXPECTED CODE"}}}'`, |
| 47 | + }); |
| 48 | + |
| 49 | + expect(result1).toEqual({ |
| 50 | + errorCode: ERROR_CODES.UNKNOWN_ERROR, |
| 51 | + context: |
| 52 | + ETHERS_ERROR_CODES.ERROR_WHILE_FORMATTING_OUTPUT_FROM_RPC.toString(), |
| 53 | + }); |
| 54 | + |
| 55 | + const result2 = getParsedEthersError({ |
| 56 | + code: ETHERS_ERROR_CODES.ERROR_WHILE_FORMATTING_OUTPUT_FROM_RPC, |
| 57 | + message: `RPC '{}'`, |
| 58 | + }); |
| 59 | + |
| 60 | + expect(result2).toEqual({ |
| 61 | + errorCode: ERROR_CODES.UNKNOWN_ERROR, |
| 62 | + context: |
| 63 | + ETHERS_ERROR_CODES.ERROR_WHILE_FORMATTING_OUTPUT_FROM_RPC.toString(), |
| 64 | + }); |
| 65 | + }); |
| 66 | + it("should handle transaction underpriced that does not provide a valid JSON details", () => { |
| 67 | + const result = getParsedEthersError({ |
| 68 | + code: ETHERS_ERROR_CODES.ERROR_WHILE_FORMATTING_OUTPUT_FROM_RPC, |
| 69 | + message: `RPC 'not-a-json'`, |
| 70 | + }); |
| 71 | + |
| 72 | + expect(result).toEqual({ |
| 73 | + errorCode: ERROR_CODES.UNKNOWN_ERROR, |
| 74 | + context: |
| 75 | + ETHERS_ERROR_CODES.ERROR_WHILE_FORMATTING_OUTPUT_FROM_RPC.toString(), |
| 76 | + }); |
| 77 | + }); |
| 78 | + it("should handle transaction rejected at the top level", () => { |
| 79 | + const message = "User rejected transaction"; |
| 80 | + |
| 81 | + const result = getParsedEthersError({ |
| 82 | + code: ETHERS_ERROR_CODES.REJECTED_TRANSACTION, |
| 83 | + message, |
| 84 | + }); |
| 85 | + |
| 86 | + expect(result).toEqual({ |
| 87 | + errorCode: ERROR_CODES.REJECTED_TRANSACTION, |
| 88 | + context: message, |
| 89 | + }); |
| 90 | + }); |
| 91 | + it("should handle transaction rejected at the nested level", () => { |
| 92 | + const message = "User rejected transaction"; |
| 93 | + |
| 94 | + const result = getParsedEthersError({ |
| 95 | + error: { |
| 96 | + code: ETHERS_ERROR_CODES.REJECTED_TRANSACTION, |
| 97 | + message, |
| 98 | + }, |
| 99 | + }); |
| 100 | + |
| 101 | + expect(result).toEqual({ |
| 102 | + errorCode: ERROR_CODES.REJECTED_TRANSACTION, |
| 103 | + context: message, |
| 104 | + }); |
| 105 | + }); |
| 106 | + it("should handle execution reverted at the top level", () => { |
| 107 | + const reason = "Some reason"; |
| 108 | + |
| 109 | + const result = getParsedEthersError({ |
| 110 | + code: ETHERS_ERROR_CODES.REQUIRE_TRANSACTION, |
| 111 | + message: `execution reverted: ${reason}`, |
| 112 | + }); |
| 113 | + |
| 114 | + expect(result).toEqual({ |
| 115 | + errorCode: ERROR_CODES.EXECUTION_REVERTED, |
| 116 | + context: reason, |
| 117 | + }); |
| 118 | + }); |
| 119 | + it("should handle execution reverted at the nested level", () => { |
| 120 | + const reason = "Some reason"; |
| 121 | + |
| 122 | + const result = getParsedEthersError({ |
| 123 | + error: { |
| 124 | + code: ETHERS_ERROR_CODES.REQUIRE_TRANSACTION, |
| 125 | + message: `execution reverted: ${reason}`, |
| 126 | + }, |
| 127 | + }); |
| 128 | + |
| 129 | + expect(result).toEqual({ |
| 130 | + errorCode: ERROR_CODES.EXECUTION_REVERTED, |
| 131 | + context: reason, |
| 132 | + }); |
| 133 | + }); |
| 134 | + it("should handle transaction run out of gas errors", () => { |
| 135 | + const gasLimit = getTestBigNumber("100"); |
| 136 | + const gasUsed = getTestBigNumber("100"); |
| 137 | + |
| 138 | + const result = getParsedEthersError({ |
| 139 | + transaction: { |
| 140 | + gasLimit, |
| 141 | + }, |
| 142 | + receipt: { |
| 143 | + gasUsed, |
| 144 | + }, |
| 145 | + }); |
| 146 | + |
| 147 | + expect(result).toEqual({ |
| 148 | + errorCode: ERROR_CODES.TRANSACTION_RUN_OUT_OF_GAS, |
| 149 | + context: gasLimit.toString(), |
| 150 | + }); |
| 151 | + }); |
| 152 | + it("should handle unknown errors with a nested level error message", () => { |
| 153 | + const message = "Some internal Ethers error message"; |
| 154 | + |
| 155 | + const result = getParsedEthersError({ |
| 156 | + error: { |
| 157 | + message, |
| 158 | + }, |
| 159 | + }); |
| 160 | + |
| 161 | + expect(result).toEqual({ |
| 162 | + errorCode: ERROR_CODES.UNKNOWN_ERROR, |
| 163 | + context: message, |
| 164 | + }); |
| 165 | + }); |
| 166 | + it("should handle unknown errors with a top level error code", () => { |
| 167 | + const code = "SOME INTERNAL ETHERS CODE"; |
| 168 | + |
| 169 | + const result = getParsedEthersError({ code }); |
| 170 | + |
| 171 | + expect(result).toEqual({ |
| 172 | + errorCode: ERROR_CODES.UNKNOWN_ERROR, |
| 173 | + context: code, |
| 174 | + }); |
| 175 | + }); |
| 176 | + it("should handle totally unknown errors", () => { |
| 177 | + const result = getParsedEthersError({}); |
| 178 | + |
| 179 | + expect(result).toEqual({ |
| 180 | + errorCode: ERROR_CODES.UNKNOWN_ERROR, |
| 181 | + context: undefined, |
| 182 | + }); |
| 183 | + }); |
| 184 | +}); |
0 commit comments