@metamask/rpc-errors/CHANGELOG.md

Ethereum RPC and Provider errors

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [7.0.3]

### Changed

- Bump `@metamask/utils` from `^11.0.1` to `^11.4.2` ([#171](https://github.com/MetaMask/rpc-errors/pull/171))

## [7.0.2]

### Changed

- Bump `@metamask/utils` from `^10.0.0` to `^11.0.1` ([#166](https://github.com/MetaMask/rpc-errors/pull/166))

## [7.0.1]

### Changed

- Bump `@metamask/utils` from `^9.0.0` to `^10.0.0` ([#161](https://github.com/MetaMask/rpc-errors/pull/161))

## [7.0.0]

### Changed

- **BREAKING**: Preserve original messages during error serialization by default ([#158](https://github.com/MetaMask/rpc-errors/pull/158))
  - The behavior introduced in [`5.0.0`](#500) of overwriting the original message is available by passing `shouldPreserveMessage: false` to `serializeError()`.
- **BREAKING:** Bump minimum Node.js version from 16 to 18 ([#154](https://github.com/MetaMask/rpc-errors/pull/154))

## [6.4.0]

### Changed

- Migrate to `ts-bridge` ([#152](https://github.com/MetaMask/rpc-errors/pull/152))
  - Migrates to [ts-bridge](https://ts-bridge.dev) from `tsup`, which may resolve issues when importing this package in CommonJS or ESM.

## [6.3.1]

### Changed

- Bump `@metamask/utils` from `^8.3.0` to `^9.0.0` ([#147](https://github.com/MetaMask/rpc-errors/pull/147))

## [6.3.0]

### Added

- Expose error causes as `cause` property ([#140](https://github.com/MetaMask/rpc-errors/pull/140))
  - `JsonRpcError` objects already had a `.data.cause` property. It is now exposed as `.cause` in order to to be recognized as ES Causes.

## [6.2.1]

### Fixed

- Export `OptionalDataWithOptionalCause` type ([#135](https://github.com/MetaMask/rpc-errors/pull/135))

## [6.2.0]

### Added

- Add ESM build ([#133](https://github.com/MetaMask/rpc-errors/pull/133))

### Changed

- Update `@metamask/utils` from `^8.1.0` to `^8.3.0` ([#133](https://github.com/MetaMask/rpc-errors/pull/133))

## [6.1.0]

### Changed

- Update dependency `@metamask/utils` from `^8.0.0` to `^8.1.0` ([#108](https://github.com/MetaMask/rpc-errors/pull/108))

### Fixed

- Exclude `dist/__fixtures__` files from published package ([#114](https://github.com/MetaMask/rpc-errors/pull/114))

## [6.0.0]

### Changed

- Make Data type-parameter optional in JsonRpcError ([#102](https://github.com/MetaMask/rpc-errors/pull/102))

### Fixed

- **BREAKING**: `undefined` is now not recognized as valid JSON value
  - Update dependency `@metamask/utils` from `^5.0.0` to `^8.0.0` ([#101](https://github.com/MetaMask/rpc-errors/pull/101))

## [5.1.1]

### Fixed

- Allow passing unknown values as cause ([#91](https://github.com/MetaMask/rpc-errors/pull/91))
  - Prevously, only `Error` instances were allowed, but any value can be thrown as error

## [5.1.0]

### Added

- Allow passing a cause to predefined error functions ([#83](https://github.com/MetaMask/rpc-errors/pull/83))
  - This allows passing an `Error` instance as cause, by using `{ data: { cause: /* some error */ } }`
  - The error will be properly serialised when calling `serialize`

## [5.0.0]

### Changed

- **BREAKING:** Bump minimum version to Node 16 ([#68](https://github.com/MetaMask/rpc-errors/pull/68))
- **BREAKING:** Rewrite error serialization ([#61](https://github.com/MetaMask/rpc-errors/pull/61))
  - Allows errors that conform to the `JsonRpcError` type
  - If errors don't conform to the type, the error will be wrapped in an internal error and the original error will be available as `data.cause`
- **BREAKING:** Rename exports to be more generic ([#75](https://github.com/MetaMask/rpc-errors/pull/75))
  - JSON-RPC errors and Ethereum EIP-1474 errors are namespaced under "rpcErrors"
  - Ethereum EIP-1193 Provider errors are namespaced under "providerErrors"
- **BREAKING:** Target `ES2020` ([#77](https://github.com/MetaMask/rpc-errors/pull/77))
- Rename package to `@metamask/rpc-errors` ([#67](https://github.com/MetaMask/rpc-errors/pull/67))

## [4.0.3] - 2021-03-10

### Fixed

- Correctly type `ethErrors` getter function argument objects as optional ([#36](https://github.com/MetaMask/eth-rpc-errors/pull/36))

## [4.0.2] - 2020-11-17

### Changed

- Mark the `data` property of `EthereumRpcError` and `EthereumProviderError` as optional rather than `T | undefined` ([#34](https://github.com/MetaMask/eth-rpc-errors/pull/34))

### Fixed

- Correctly type `SerializedEthereumRpcError.stack` as `string`, if present ([#34](https://github.com/MetaMask/eth-rpc-errors/pull/34))

## [4.0.1] - 2020-11-03

### Changed

- Updated README.md ([#30](https://github.com/MetaMask/eth-rpc-errors/pull/30))

## [4.0.0] - 2020-11-02

### Changed

- **BREAKING:** `ERROR_CODES` export renamed to `errorCodes` ([#28](https://github.com/MetaMask/eth-rpc-errors/pull/28))
- **BREAKING:** `ethErrors` getters will now throw an error if passed a truthy, non-string `message` ([#28](https://github.com/MetaMask/eth-rpc-errors/pull/28))
- Updated TypeScript types for all exports ([#28](https://github.com/MetaMask/eth-rpc-errors/pull/28))

## [3.0.0] - 2020-07-29

### Changed

- **BREAKING:** Second argument of `serializeError` is now an options object ([#22](https://github.com/MetaMask/eth-rpc-errors/pull/22))
- Error stacks are no longer serialized by default by `serializeError` ([#22](https://github.com/MetaMask/eth-rpc-errors/pull/22))

## [2.1.1] - 2020-05-12

### Changed

- Prevent unnecessary files from being published ([#17](https://github.com/MetaMask/eth-rpc-errors/pull/17))

## [2.1.0] - 2020-05-11

### Added

- New/missing errors:
  - `ethErrors.provider` ([EIP-1193](https://eips.ethereum.org/EIPS/eip-1474#provider-errors))
    - `.disconnected`, `4900`
    - `.chainDisconnected`, `4901`
  - `ethErrors.rpc` ([EIP-1474](https://eips.ethereum.org/EIPS/eip-1474#error-codes))
    - `.limitExceeded`, `-32005`

### Changed

- Rename package to `eth-rpc-errors`

## [2.0.2] - 2020-02-12

### Changed

- Fix faulty null checks throughout codebase ([764832d](https://github.com/MetaMask/eth-rpc-errors/commit/764832d777f9274ca5bb9a6efa6958db2b640952))

## [2.0.1] - 2020-01-31

### Added

- Error codes in docstrings ([5452001](https://github.com/MetaMask/eth-rpc-errors/commit/545200100af05aeade62ba6b736f5080a6891bc4))

## [2.0.0] - 2019-09-26

### Changed

- **Exports**
  - `errors` renamed `ethErrors`
  - `JsonRpcError` renamed `EthereumRpcError`
  - `EthJsonRpcError` renamed `EthereumProviderError`
    - It is still a subclass of `EthereumRpcError`
  - **TypeScript**
    - Renamed affected interfaces
- `ethErrors`
  - Added missing
    [EIP-1474 errors](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1474.md)
    - Added corresponding codes and messages
  - **Namespacing**
    - EIP-1474 (which includes JSON RPC 2.0) errors now namespaced under `ethErrors.rpc`
      - JSON RPC 2.0 errors were formerly under `errors.jsonRpc`
    - EIP-1193 errors now namespaced under `ethErrors.provider`
      - Formerly under `errors.eth`
  - Most error getters now take a single, _optional_ `opts` argument, which
    is either a string or an object
    - If a string, it becomes the error message
    - If an object, it should have the form: `{ message?: string, data?: any }`
    - **Special Cases**
      - `ethErrors.rpc.server` must receive a single object of the form:
        - `{ code: number, message?: string, data?: any }
      - `ethErrors.provider.custom` must receive a single of the form:
        - `{ code: number, message: string, data?: any }
- **TypeScript**
  - Updated affected interfaces

## [1.1.0] - 2019-09-16

### Changed

- `serializeError`
  - If the object passed to the function has a `.message` property, it will preferred over the `.message` property of the fallback error when creating the returned serialized error object

[Unreleased]: https://github.com/MetaMask/rpc-errors/compare/v7.0.3...HEAD
[7.0.3]: https://github.com/MetaMask/rpc-errors/compare/v7.0.2...v7.0.3
[7.0.2]: https://github.com/MetaMask/rpc-errors/compare/v7.0.1...v7.0.2
[7.0.1]: https://github.com/MetaMask/rpc-errors/compare/v7.0.0...v7.0.1
[7.0.0]: https://github.com/MetaMask/rpc-errors/compare/v6.4.0...v7.0.0
[6.4.0]: https://github.com/MetaMask/rpc-errors/compare/v6.3.1...v6.4.0
[6.3.1]: https://github.com/MetaMask/rpc-errors/compare/v6.3.0...v6.3.1
[6.3.0]: https://github.com/MetaMask/rpc-errors/compare/v6.2.1...v6.3.0
[6.2.1]: https://github.com/MetaMask/rpc-errors/compare/v6.2.0...v6.2.1
[6.2.0]: https://github.com/MetaMask/rpc-errors/compare/v6.1.0...v6.2.0
[6.1.0]: https://github.com/MetaMask/rpc-errors/compare/v6.0.0...v6.1.0
[6.0.0]: https://github.com/MetaMask/rpc-errors/compare/v5.1.1...v6.0.0
[5.1.1]: https://github.com/MetaMask/rpc-errors/compare/v5.1.0...v5.1.1
[5.1.0]: https://github.com/MetaMask/rpc-errors/compare/v5.0.0...v5.1.0
[5.0.0]: https://github.com/MetaMask/rpc-errors/compare/v4.0.3...v5.0.0
[4.0.3]: https://github.com/MetaMask/rpc-errors/compare/v4.0.2...v4.0.3
[4.0.2]: https://github.com/MetaMask/rpc-errors/compare/v4.0.1...v4.0.2
[4.0.1]: https://github.com/MetaMask/rpc-errors/compare/v4.0.0...v4.0.1
[4.0.0]: https://github.com/MetaMask/rpc-errors/compare/v3.0.0...v4.0.0
[3.0.0]: https://github.com/MetaMask/rpc-errors/compare/v2.1.1...v3.0.0
[2.1.1]: https://github.com/MetaMask/rpc-errors/compare/v2.1.0...v2.1.1
[2.1.0]: https://github.com/MetaMask/rpc-errors/compare/v2.0.2...v2.1.0
[2.0.2]: https://github.com/MetaMask/rpc-errors/compare/v2.0.1...v2.0.2
[2.0.1]: https://github.com/MetaMask/rpc-errors/compare/v2.0.0...v2.0.1
[2.0.0]: https://github.com/MetaMask/rpc-errors/compare/v1.1.0...v2.0.0
[1.1.0]: https://github.com/MetaMask/rpc-errors/releases/tag/v1.1.0