Releases: XRPLF/xrpl.js
[email protected]
[email protected]
[email protected]
What's Changed
Migration Guide
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
andbip39
in favor of@scure/bip32
and@scure/bip39
- Remove
assert
dependency. If you were catchingAssertionError
you need to change toError
- Configuring a proxy:
- Instead of passing various parameters on the
ConnectionsOptions
you know specify theagent
parameter. This object can use be created by libraries such ashttps-proxy-agent
or any that implements thehttp.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 usinghttps-proxy-agent
and only tested in a node environment which was the only way it was previously supported anyway
- Instead of passing various parameters on the
- Remove
BroadcastClient
which was deprecated - Uses
@xrplf/secret-numbers
instead ofxrpl-secret-numbers
- Improve key algorithm detection. It will now throw Errors with helpful messages
- Move
authorizeChannel
fromwallet/signer
towallet/authorizeChannel
to solve a circular dependency issue. - When using a bundler you must remove the mapping of
ws
toWSWrapper
. 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 andSubmittableTransaction
was created to define the old value. The following functions which only handle transactions to be submitted now useSubmittableTransaction
:Client.autofill
Client.submit
Client.submitAndWait
Client.prepareTransaction
getSignedTx
isAccountDelete
dropsToXRP
andClient.getXrpBalance
now return anumber
instead of astring
Buffer
has been replaced withUInt8Array
for both params and return values.Buffer
may continue to work with params since they extendUInt8Arrays
.
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 bywebpack
events
- previously added automatically bywebpack
but manual forvite
**
- Removed mappings for:
ws
toWsWrapper
- Excluding
https-proxy-agent
Non-Breaking Changes
- Deprecated:
convertHexToString
in favor of@xrplf/isomorphic/utils
'shexToString
convertStringToHex
in favor of@xrplf/isomorphic/utils
'sstringToHex
Full Changelog: https://github.com/XRPLF/xrpl.js/compare/[email protected]@3.0.0
[email protected]
What's Changed
- build(deps): bump ws from 8.14.2 to 8.16.0 by @dependabot in #2610
- fix AMM ledger object's LPTokenBalance type to IssuedCurrencyAmount by @khancode in #2621
Full Changelog: https://github.com/XRPLF/xrpl.js/compare/[email protected]@2.14.1
[email protected]
What's Changed
Migration Guide: https://github.com/XRPLF/xrpl.js/blob/3.0/MIGRATION.md
BREAKING CHANGES
- Bump typescript to 5.x
- Remove Node 14 support
- Remove
assert
dependency. If you were catchingAssertionError
you need to change toError
. - Fix
deriveKeypair
ignoring manual decoding algorithm. (Specifying algorithm=ed25519
inopts
now works on secrets likesNa1...
) - Remove
crypto
polyfills,create-hash
,elliptic
,hash.js
, and their many dependencies in favor of@noble/hashes
and@nobel/curves
- Remove
bytesToHex
andhexToBytes
. 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 withUInt8Array
for both params and return values.Buffer
may continue to work with params since they extendUInt8Arrays
.
Non-Breaking Changes
- Remove
brorand
as a dependency and use@xrplf/isomorphic
instead. - Eliminates 4 runtime dependencies:
base-x
,base64-js
,buffer
, andieee754
.
Full Changelog: https://github.com/XRPLF/xrpl.js/compare/[email protected]@2.0.0
[email protected]
What's Changed
Migration Guide: https://github.com/XRPLF/xrpl.js/blob/3.0/MIGRATION.md
BREAKING CHANGES
- Bump typescript to 5.x
- Remove Node 14 support
- Remove decimal.js and big-integer. Use
BigNumber
frombignumber.js
instead ofDecimal
and the nativeBigInt
instead ofbigInt
. - Remove
assert
dependency. If you were catchingAssertionError
you need to change toError
. - Remove
create-hash
in favor of@noble/hashes
Buffer
has been replaced withUInt8Array
for both params and return values.Buffer
may continue to work with params since they extendUInt8Arrays
.
Non-Breaking Changes
- Update type definitions which causing errors in tests that the code already supported
makeParser
to accept aBuffer
in addition tostring
SerializedType
constructor allows not passing in a byte arrayComparable
is now a generic type so that it allowscompareTo
methods to take more that the type itself.
- Eliminates 4 runtime dependencies:
base-x
,base64-js
,buffer
, andieee754
.
Full Changelog: https://github.com/XRPLF/xrpl.js/compare/[email protected]@2.0.0
[email protected]
What's Changed
Migration Guide: https://github.com/XRPLF/xrpl.js/blob/3.0/MIGRATION.md
BREAKING CHANGES
- Bump typescript to 5.x
- Remove Node 14 support
- Remove
assert
dependency. If you were catchingAssertionError
you need to change toError
. - Remove
create-hash
in favor of@noble/hashes
Buffer
has been replaced withUInt8Array
for both params and return values.Buffer
may continue to work with params since they extendUInt8Arrays
.
Non-Breaking Changes
- Eliminates 4 runtime dependencies:
base-x
,base64-js
,buffer
, andieee754
. - Execute test in a browser in addition to node
Full Changelog: https://github.com/XRPLF/xrpl.js/compare/[email protected]@5.0.0
@xrplf/[email protected]
What's Changed
Migration Guide: https://github.com/XRPLF/xrpl.js/blob/3.0/MIGRATION.md
BREAKING CHANGES:
xrpl-secret-numbers
is now@xrplf/secret-numbers
.- The bundled file produced changed from
dist/browerified.js
tobuild/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.
- Moved all methods that were on
Buffer
has been replaced withUInt8Array
for both params and return values.Buffer
may continue to work with params since they extendUInt8Arrays
.
Non-Breaking Changes
- Add
xrpl-secret-numbers
by @WietseWind to the mono repo. unpkg
andjsdelivr
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
, andieee754
.
Full Changelog: https://github.com/XRPLF/xrpl.js/compare/[email protected]...@xrplf/[email protected]
@xrplf/[email protected]
Related to xrpl.js 3.0.0 migration guide: https://github.com/XRPLF/xrpl.js/blob/3.0/MIGRATION.md
Initial release providing isomorphic and tree-shakable implementations of:
- ripemd160
- sha256
- sha512
- bytesToHash
- hashToBytes
- hexToString
- stringToHex
- randomBytes
- stringToHex
- ws
Full Changelog: https://github.com/XRPLF/xrpl.js/compare/[email protected]...@xrplf/[email protected]
[email protected]
What's Changed
- feat: add support for
server_definitions
RPC by @mvadari in #2535 - feat: add support for XLS-40d + add script to auto-generate models from rippled code by @mvadari in #2491
- fix: add DID ledger object + ledger_entry support by @mvadari in #2576
- build(deps): bump big-integer from 1.6.51 to 1.6.52 by @dependabot in #2581
- feat: remove AMM devnet by @ckniffen in #2587
- chore: fix nftoken taxon calculation by @ildaruz in #2590
- feat: Add optional CTID field to Tx by @JST5000 in #2477
New Contributors
Full Changelog: https://github.com/XRPLF/xrpl.js/compare/[email protected]@2.14.0