release: xrpl.js 3.0 (#2633)

- @xrplf/isomorphic@1.0.0
 - ripple-address-codec@5.0.0
 - ripple-binary-codec@2.0.0
 - ripple-keypairs@2.0.0
 - @xrplf/secret-numbers@1.0.0
 - xrpl@3.0.0
This commit is contained in:
Caleb Kniffen
2024-02-01 15:48:48 -06:00
committed by GitHub
parent a58bf2663b
commit a09084289b
334 changed files with 2728 additions and 2594 deletions

View File

@@ -1,21 +1,34 @@
# @xrplf/isomorphic Release History
## Unreleased
## 1.0.0 (2024-02-01)
Initial release providing isomorphic and tree-shakable implementations of:
* ripemd160
* sha256
* sha512
* bytesToHash
* hashToBytes
* hexToString
* stringToHex
* randomBytes
* stringToHex
* ws
## 1.0.0 Beta 1 (2023-11-30)
## Added
- hexToString
- stringToHex
* hexToString
* stringToHex
## 1.0.0 Beta 0 (2023-10-19)
Initial release providing isomorphic and tree-shakable implementations of:
- ripemd160
- sha256
- sha512
- bytesToHash
- hashToBytes
- randomBytes
- ws
* ripemd160
* sha256
* sha512
* bytesToHash
* hashToBytes
* randomBytes
* ws_

View File

@@ -1,6 +1,6 @@
{
"name": "@xrplf/isomorphic",
"version": "1.0.0-beta.1",
"version": "1.0.0",
"description": "A collection of isomorphic and tree-shakeable crypto hashes and utils for xrpl.js",
"keywords": [
"crypto",

View File

@@ -2,6 +2,19 @@
## Unreleased
## 5.0.0 (2024-02-01)
### 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`.
* Remove `create-hash` in favor of `@noble/hashes`
* `Buffer` has been replaced with `UInt8Array` for both params and return values. `Buffer` may continue to work with params since they extend `UInt8Arrays`.
### Non-Breaking Changes
* Eliminates 4 runtime dependencies: `base-x`, `base64-js`, `buffer`, and `ieee754`.
* Execute test in a browser in addition to node
## 5.0.0 Beta 1 (2023-11-30)
### Breaking Changes

View File

@@ -1,6 +1,6 @@
{
"name": "ripple-address-codec",
"version": "5.0.0-beta.1",
"version": "5.0.0",
"description": "encodes/decodes base58 encoded XRP Ledger identifiers",
"files": [
"dist/*",
@@ -11,7 +11,7 @@
"license": "ISC",
"dependencies": {
"@scure/base": "^1.1.3",
"@xrplf/isomorphic": "^1.0.0-beta.1"
"@xrplf/isomorphic": "^1.0.0"
},
"keywords": [
"ripple",

View File

@@ -2,6 +2,23 @@
## Unreleased
## 2.0.0 (2024-02-01)
### 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`.
* Remove `create-hash` in favor of `@noble/hashes`
* `Buffer` has been replaced with `UInt8Array` for both params and return values. `Buffer` may continue to work with params since they extend `UInt8Arrays`.
### Non-Breaking Changes
* Update type definitions which causing errors in tests that the code already supported
* `makeParser` to accept a `Buffer` in addition to `string`
* `SerializedType` constructor allows not passing in a byte array
* `Comparable` is now a generic type so that it allows `compareTo` methods to take more that the type itself.
* Eliminates 4 runtime dependencies: `base-x`, `base64-js`, `buffer`, and `ieee754`.
## 2.0.0 Beta 1 (2023-11-30)
### Breaking Changes

View File

@@ -1,6 +1,6 @@
{
"name": "ripple-binary-codec",
"version": "2.0.0-beta.1",
"version": "2.0.0",
"description": "XRP Ledger binary codec",
"files": [
"dist/*",
@@ -11,9 +11,9 @@
"test": "test"
},
"dependencies": {
"@xrplf/isomorphic": "^1.0.0-beta.1",
"@xrplf/isomorphic": "^1.0.0",
"bignumber.js": "^9.0.0",
"ripple-address-codec": "^5.0.0-beta.1"
"ripple-address-codec": "^5.0.0"
},
"scripts": {
"build": "tsc --build tsconfig.build.json && copyfiles ./src/enums/definitions.json ./dist/enums/",

View File

@@ -2,6 +2,23 @@
## Unreleased
## 2.0.0 (2024-02-01)
### 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...`)
* Remove `crypto` polyfills, `create-hash`, `elliptic`, `hash.js`, and their many dependencies in favor of `@noble/hashes` and `@nobel/curves`
* Remove `bytesToHex` and `hexToBytes`. They can now be found in `@xrplf/isomorphic/utils`
* `verifyTransaction` will throw an error if there is no signature
* Improved key algorithm detection. It will now throw Errors with helpful messages
* `Buffer` has been replaced with `UInt8Array` for both params and return values. `Buffer` may continue to work with params since they extend `UInt8Arrays`.
### Non-Breaking Changes
* Remove `brorand` as a dependency and use `@xrplf/isomorphic` instead.
* Eliminates 4 runtime dependencies: `base-x`, `base64-js`, `buffer`, and `ieee754`.
## 2.0.0 Beta 1 (2023-11-30)
### Breaking Changes

View File

@@ -1,6 +1,6 @@
{
"name": "ripple-keypairs",
"version": "2.0.0-beta.1",
"version": "2.0.0",
"description": "Cryptographic key pairs for the XRP Ledger",
"scripts": {
"build": "tsc --build tsconfig.build.json",
@@ -20,8 +20,8 @@
},
"dependencies": {
"@noble/curves": "^1.0.0",
"@xrplf/isomorphic": "^1.0.0-beta.1",
"ripple-address-codec": "^5.0.0-beta.1"
"@xrplf/isomorphic": "^1.0.0",
"ripple-address-codec": "^5.0.0"
},
"keywords": [
"ripple",

View File

@@ -4,6 +4,22 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
## Unreleased
## 1.0.0 (2024-02-01)
### BREAKING CHANGES:
* `xrpl-secret-numbers` is now `@xrplf/secret-numbers`.
* The bundled file produced changed from `dist/browerified.js` to `build/xrplf-secret-numbers-latest.js`.
* Bundle variable is `xrplf_secret_numbers` instead of using browserify's loader.
* * Moved all methods that were on `Utils` are now individually exported.
* `Buffer` has been replaced with `UInt8Array` for both params and return values. `Buffer` may continue to work with params since they extend `UInt8Arrays`.
### Non-Breaking Changes
* Add `xrpl-secret-numbers` by @WietseWind to the mono repo.
* `unpkg` and `jsdelivr` support was simplified.
* Unit tests run in a browser and node.
* Remove `brorand` as a dependency and use `@xrplf/isomorphic` instead.
* Eliminates 4 runtime dependencies: `base-x`, `base64-js`, `buffer`, and `ieee754`.
## 1.0.0 Beta 1 (2023-11-30)
### BREAKING CHANGES:

View File

@@ -1,6 +1,6 @@
{
"name": "@xrplf/secret-numbers",
"version": "1.0.0-beta.1",
"version": "1.0.0",
"description": "Generate XRPL Accounts with a number-based secret: 8 chunks of 6 digits",
"main": "dist/index.js",
"unpkg": "build/xrplf-secret-numbers-latest-min.js",
@@ -29,8 +29,8 @@
"test": "test"
},
"dependencies": {
"@xrplf/isomorphic": "^1.0.0-beta.1",
"ripple-keypairs": "^2.0.0-beta.1"
"@xrplf/isomorphic": "^1.0.0",
"ripple-keypairs": "^2.0.0"
},
"prettier": "@xrplf/prettier-config",
"repository": {

View File

@@ -4,6 +4,55 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
## Unreleased
## 3.0.0 (2024-02-01)
### BREAKING CHANGES
* Bump typescript to 5.x
* Remove Node 14 support
* Remove `crypto` polyfills, `create-hash`, `elliptic`, `hash.js`, and their many dependencies in favor of `@noble/hashes` and `@nobel/curves`
* Remove `bip32` and `bip39` in favor of `@scure/bip32` and `@scure/bip39`
* 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
* Uses `@xrplf/secret-numbers` instead of `xrpl-secret-numbers`
* Improve key algorithm detection. It will now throw Errors with helpful messages
* Move `authorizeChannel` from `wallet/signer` to `wallet/authorizeChannel` to solve a circular dependency issue.
* When using a bundler you must remove the mapping of `ws` to `WSWrapper`. ex. `ws: 'xrpl/dist/npm/client/WSWrapper'`. See [../UNIQUE_STEPS](Unique Steps) for the new, much smaller, configs.
* `Transaction` type has been redefined to include all transactions and `SubmittableTransaction` was created to define the old value. The following functions which only handle transactions to be submitted now use `SubmittableTransaction`:
* `Client.autofill`
* `Client.submit`
* `Client.submitAndWait`
* `Client.prepareTransaction`
* `getSignedTx`
* `isAccountDelete`
* `dropsToXRP` and `Client.getXrpBalance` now return a `number` instead of a `string`
* `Buffer` has been replaced with `UInt8Array` for both params and return values. `Buffer` may continue to work with params since they extend `UInt8Arrays`.
### Bundling Changes
Bundler configurations are much more simplified. See [../UNIQUE_STEPS](Unique Steps) for the new, much smaller, configs.
* removed the following polyfills:
* `buffer`
* `assert`
* `crypto-browserify`
* `https-browserify`
* `os-browserify`
* `process`
* `stream-browserify`
* `stream-http`
* `url`
* `util` - previously added automatically by `webpack`
* `events` - previously added automatically by `webpack` but manual for `vite`**
* Removed mappings for:
* `ws` to `WsWrapper`
* Excluding `https-proxy-agent`
### Non-Breaking Changes
* Deprecated:
* `convertHexToString` in favor of `@xrplf/isomorphic/utils`'s `hexToString`
* `convertStringToHex` in favor of `@xrplf/isomorphic/utils`'s `stringToHex`
## 3.0.0 Beta 1 (2023-11-30)
### Breaking Changes
@@ -24,6 +73,15 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
* Deprecated:
* `convertHexToString` in favor of `@xrplf/isomorphic/utils`'s `hexToString`
* `convertStringToHex` in favor of `@xrplf/isomorphic/utils`'s `stringToHex`
* 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`
* Add type for metadata for specific transactions(`Payment`, `NFTokenMint`, `NFTokenCreateOffer`, `NFTokenAcceptOffer`, `NFTokenCancelOffer`)
### 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
* Added pseudo-transaction support to hash functions and response types
## 3.0.0 Beta 0 (2023-10-19)

View File

@@ -1,6 +1,6 @@
{
"name": "xrpl",
"version": "3.0.0-beta.1",
"version": "3.0.0",
"license": "ISC",
"description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
"files": [
@@ -24,14 +24,14 @@
"dependencies": {
"@scure/bip32": "^1.3.1",
"@scure/bip39": "^1.2.1",
"@xrplf/isomorphic": "^1.0.0-beta.1",
"@xrplf/secret-numbers": "^1.0.0-beta.1",
"@xrplf/isomorphic": "^1.0.0",
"@xrplf/secret-numbers": "^1.0.0",
"bignumber.js": "^9.0.0",
"cross-fetch": "^4.0.0",
"eventemitter3": "^5.0.1",
"ripple-address-codec": "^5.0.0-beta.1",
"ripple-binary-codec": "^2.0.0-beta.1",
"ripple-keypairs": "^2.0.0-beta.1"
"ripple-address-codec": "^5.0.0",
"ripple-binary-codec": "^2.0.0",
"ripple-keypairs": "^2.0.0"
},
"devDependencies": {
"@types/node": "^16.18.38",