Is your pull request closing an issue?

Closes #39

Please explain the main changes of your pull request

Export types

Checklist

• [x] Have you added any new returned codes to the README file ?

Should be able to parse the exact reason from the message key which is inside the error.data object.

This message is the reason for transaction failure often written inside the require function of smart contracts.

Describe the bug

Using the getParsedEthersError in a typescript file leads to this error

TS2345: Argument of type 'unknown' is not assignable to parameter of type 'EthersError'.
    37 |       contract = yield call(async() => await factory.deploy(payload))
    38 |     } catch(e) {
  > 39 |       getParsedEthersError(e)
       |                            ^
    40 |     }

And trying to import it is not working :

Module '"@enzoferey/ethers-error-parser"' has no exported member 'EthersError'.

Expected behavior

The library exposes the types that may be used externally, so this can be written :

import { getParsedEthersError, EthersError } from "@enzoferey/ethers-error-parser"
[…]
getParsedEthersError(e as EthersError)

can no parse this: Error: Transaction has been reverted by the EVM: { "transactionHash": "0xce0f4a5f9e31a7fecac27452376cb27dc4fe5a0b1f2c02e83bf475c5d8ee7d8d", "transactionIndex": 0, "blockHash": "0xa384bb0a3a57972b3482ff372a4437905050612a3a3baadbc80ac1149803cf88", "blockNumber": 27552133, "cumulativeGasUsed": 37047, "gasUsed": 37047, "effectiveGasPrice": 2500000007, "from": "0x57c1b087a970d13e307fab65345439dea4ccba91", "to": "0x2dd39f44758f66fa125f83b0e89136b49a64e18a", "contractAddress": null, "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "status": false, "error": "Reverted 0x41697264726f707065723a207465726d206c696d6974", "type": "0x2", "events": {} }

Please add RETURN_VALUE_ERROR_CODES to the package exports.

I would like to make a switch statement around error codes to handle errors nicely, but it isn't possible because my app code cannot access RETURN_VALUE_ERROR_CODES:

Would it be possible to handle/parse nonce errors?

As an example:

Error: nonce has already been used [ See: https://links.ethers.org/v5-errors-NONCE_EXPIRED ] (error={"code":-32603,"message":"[ethjs-query] while formatting outputs from RPC '{\"value\":{\"code\":-32603,\"data\":{\"code\":-32000,\"message\":\"Nonce too low. Expected nonce to be 117 but got 1.\",\"data\":{\"message\":\"Nonce too low. Expected nonce to be 117 but got 1.\"}}}}'","stack":"{\n \"code\": -32603,\n \"message\": \"[ethjs-query] while formatting outputs from RPC '{\\\"value\\\":{\\\"code\\\":-32603,\\\"data\\\":{\\\"code\\\":-32000,\\\"message\\\":\\\"Nonce too low. Expected nonce to be 117 but got 1.\\\",\\\"data\\\":{\\\"message\\\":\\\"Nonce too low. Expected nonce to be 117 but got 1.\\\"}}}}'\",\n \"stack\": \"Error: [ethjs-query] while formatting outputs from RPC '{\\\"value\\\":{\\\"code\\\":-32603,\\\"data\\\":{\\\"code\\\":-32000,\\\"message\\\":\\\"Nonce too low. Expected nonce to be 117 but got 1.\\\",\\\"data\\\":{\\\"message\\\":\\\"Nonce too low. Expected nonce to be 117 but got 1.\\\"}}}}'\\n

Is your pull request closing an issue?

Closes https://github.com/enzoferey/ethers-error-parser/issues/33.

Please explain the main changes of your pull request

Exports the RETURN_VALUE_ERROR_CODES constant so JavaScript users avoid typos and TypeScript users do not have to hardcode strings.

Is your pull request closing an issue?

Closes https://github.com/enzoferey/ethers-error-parser/issues/26.

Please explain the main changes of your pull request

Supports calls reverts via the CALL_EXCEPTION ethers code.

Checklist

• [x] Have you added any new returned codes to the README file ?

Is your pull request closing an issue?

Closes https://github.com/enzoferey/ethers-error-parser/issues/27.

Please explain the main changes of your pull request

Uses the code and action properties to determine if it was a rejected action and returns the message property as the context value.

I tried a multi template attempt at https://github.com/enzoferey/ethers-error-parser/pull/23 but it does not work like issue templates, so I'm switching to single "good old" pull request template.

Closes https://github.com/enzoferey/ethers-error-parser/issues/17 & https://github.com/enzoferey/ethers-error-parser/issues/18.

Fixes parsing for https://github.com/enzoferey/ethers-error-parser/pull/16.

Is your pull request closing an issue?

No

Please explain the main changes of your pull request

ether.js Contract.deployed function can throw an error about the contract not being deployed.

This adds a new error type CONTRACT_NOT_DEPLOYED for this case with the address having been requested as a context.

Checklist

• [x] Have you added any new returned codes to the README file ?

Hello, while using Ganache as a development backend, some errors are not handled as expected. For instance with the following one (the context is a call to ethers estimateGas method which makes a dry run of the transaction and so can throw similar errors as the actual transaction):

{
	"code": -32603,
	"data": {
		"code": -32000,
		"data": {
			"hash": null,
			"message": "revert",
			"programCounter": 1420,
			"reason": "[revert message]",
			"result": "0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000c34303920436f6e666c6963740000000000000000000000000000000000000000"
		},
		"message": "VM Exception while processing transaction: revert [revert message]",
		"name": "RuntimeError",
		"stack": "RuntimeError: VM Exception while processing transaction: revert [revert message]\n    at exactimate ([path]/node_modules/ganache/dist/node/1.js:2:182333)"
	},
	"message": "Internal JSON-RPC error."
}

It is parsed as { errorCode: 'UNKNOWN_ERROR', context: '-32603' } while imho it should return the EXECUTION_REVERTED one : https://github.com/enzoferey/ethers-error-parser/blob/d4e452b411738e9b97a5e9e8978ce875a46bd967/lib/constants.ts#L6

The text message looks really specific to Ganache and I'm wondering whether the whole error structure is also specific to it. How could it be then handled by the error parser ?

Describe the feature

{
  code: -32603,
  data: {
    code: -32000,
    message: "err: insufficient funds for gas * price + value: address 0x.... have XXX want XXX (supplied gas XXX)"
  }
}