Type the errors emitted by Ethers

[nathandem]

Describe the Feature

At the moment, Ethers's errors don't have a type. See https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L197

Yet, when inspecting them, they have more properties than the default/standard Error object (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error). They have some fields like method, code and others. For example:

{
  reason: null,
  code: 'CALL_EXCEPTION',
  method: 'changePosition(uint256,uint256,uint256,uint8)',
  data: '0xe1a70630',
  errorArgs: null,
  errorName: null,
  errorSignature: null,
  address: '0x01c1DeF3b91672704716159C9041Aeca392DdFfb',
  args: [
    0,
    BigNumber { _hex: '0x1b98c1a97e69bc91', _isBigNumber: true },
    BigNumber { _hex: '0x012733401c408176e981', _isBigNumber: true },
    1
  ],
  transaction: {
    data: '0x81be72ab00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001b98c1a97e69bc9100000000000000000000000000000000000000000000012733401c408176e9810000000000000000000000000000000000000000000000000000000000000001',
    to: '0x01c1DeF3b91672704716159C9041Aeca392DdFfb',
    from: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
  }
}

I'd be great to add a dedicated type for them, that'd allow to not use any for them in our code.

I can create the type in the logger package (https://github.com/ethers-io/ethers.js/tree/master/packages/logger), if there's interest for this addition ;)

Code Example

No response

[ricmoo]

This already exists in v6, along with the conditional types that automatically determine the error interface based on error string. Check it out here: https://github.com/ethers-io/ethers.js/blob/v6-beta-exports/src.ts/utils/errors.ts#L53

:)

[nathandem]

Great, looking forward to it! Thank you