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
XRPLF · Oct 5, 2023 · 3763e48 · 3763e48
1 parent 2cc00a2
commit 3763e48
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 4 deletions.
diff --git a/packages/ripple-address-codec/HISTORY.md b/packages/ripple-address-codec/HISTORY.md
@@ -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

diff --git a/packages/ripple-binary-codec/HISTORY.md b/packages/ripple-binary-codec/HISTORY.md
@@ -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.10.0 (2023-09-27)
 ### Added

diff --git a/packages/ripple-keypairs/HISTORY.md b/packages/ripple-keypairs/HISTORY.md
@@ -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)

diff --git a/packages/xrpl/HISTORY.md b/packages/xrpl/HISTORY.md
@@ -4,6 +4,41 @@ 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
+
+### Unreleased 2.x
+
 ### Fixed
 - Allow flag maps when submitting `NFTokenMint` and `NFTokenCreateOffer` transactions like others with flags
 

diff --git a/packages/xrpl/src/errors.ts b/packages/xrpl/src/errors.ts
@@ -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

diff --git a/packages/xrpl/test/client/errors.test.ts b/packages/xrpl/test/client/errors.test.ts
@@ -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 () {