feat: remove util polyfill and fix HISTORY.md (#2432)

- Remove `util` from bundle by switching `inspect` to `JSON.stringify`
- Update `HISTORY.md` with latest 3.0 changes
This commit is contained in:
Caleb Kniffen
2023-08-21 15:16:54 -05:00
parent 3b70a3b919
commit cddb048588
6 changed files with 49 additions and 4 deletions

View File

@@ -1,6 +1,10 @@
# ripple-address-codec
## Unreleased
### Breaking Changes
* Bump typescript to 5.x
* Remove Node 14 support
* Remove `assert` dependency. If you were catching `AssertionError` you need to change to `Error`.
## 4.3.1 (2023-09-27)
### Fixed

View File

@@ -1,6 +1,12 @@
# ripple-binary-codec Release History
## Unreleased
### Breaking Changes
* Bump typescript to 5.x
* Remove Node 14 support
* Remove decimal.js and big-integer. Use `BigNumber` from `bignumber.js` instead of `Decimal` and the native `BigInt` instead of `bigInt`.
* Remove `assert` dependency. If you were catching `AssertionError` you need to change to `Error`.
## 1.11.0 (2023-11-30)
### Added

View File

@@ -1,6 +1,10 @@
# ripple-keypairs Release History
## Unreleased
### Breaking Changes
* Bump typescript to 5.x
* Remove Node 14 support
* Remove `assert` dependency. If you were catching `AssertionError` you need to change to `Error`.
* Fix `deriveKeypair` ignoring manual decoding algorithm. (Specifying algorithm=`ed25519` in `opts` now works on secrets like `sNa1...`)
## 1.3.1 (2023-09-27)

View File

@@ -4,6 +4,39 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
## Unreleased
### Breaking Changes
* Bump typescript to 5.x
* Remove Node 14 support
* Remove `assert` dependency. If you were catching `AssertionError` you need to change to `Error`
* Configuring a proxy:
* Instead of passing various parameters on the `ConnectionsOptions` you know specify the `agent` parameter. This object can use be created by libraries such as `https-proxy-agent` or any that implements the `http.Agent`.
* This was changed to both support the latest `https-proxy-agent` and to remove the need to include the package in bundlers. Tests will still be done using `https-proxy-agent` and only tested in a node environment which was the only way it was previously supported anyway
* Remove `BroadcastClient` which was deprecated
### Bundling Changes
* Bundler configurations are much more simplified.
* removed the following polyfills:
* `assert`
* `buffer`
* `https-browserify`
* `os-browserify`
* `stream-browserify`
* `stream-http`
* `url`
* `util` - previously added automatically by `webpack`
* Removed mappings for:
* `ws` to `WsWrapper`
* Excluding `https-proxy-agent`
### Changed
* Remove `lodash` as a dependency
* Remove many polyfills that were only used for testing in the browser
* Remove `util` from bundle by switching `inspect` to `JSON.stringify`
### Fixed
* Fixed Wallet.generate() ignoring the `algorithm` parameter (Only a problem once binary-codec fix for `derive_keypair` is added)
* Fixed Wallet.fromSeed() ignoring the `algorithm` parameter
## 2.14.1 (2024-02-01)
### Fixed

View File

@@ -1,6 +1,4 @@
/* eslint-disable max-classes-per-file -- Errors can be defined in the same file */
import { inspect } from 'util'
/**
* Base Error class for xrpl.js. All Errors thrown by xrpl.js should throw
* XrplErrors.
@@ -38,7 +36,7 @@ class XrplError extends Error {
public toString(): string {
let result = `[${this.name}(${this.message}`
if (this.data) {
result += `, ${inspect(this.data)}`
result += `, ${JSON.stringify(this.data)}`
}
result += ')]'
return result

View File

@@ -5,7 +5,7 @@ import { XrplError, NotFoundError } from '../../src'
describe('client errors', function () {
it('XrplError with data', async function () {
const error = new XrplError('_message_', '_data_')
assert.strictEqual(error.toString(), "[XrplError(_message_, '_data_')]")
assert.strictEqual(error.toString(), '[XrplError(_message_, "_data_")]')
})
it('NotFoundError default message', async function () {