Releases: Permissionless-Software-Foundation/minimal-slp-wallet
v5.0.0
v5.0.0 changes the initialization of the wallet. See examples in the README for code examples.
Before, it was necessary to await wallet.walletInfoPromise
after instantiating the Class. This is still needed. Waiting did two things:
- It waited for the cryptography to execute to create the wallet.
- It waited for the wallet to make a network call to get blockchain data about the wallet.
Those two steps have been separated in v5. It's still needed to await wallet.walletInfoPromise
in order to wait for the cryptography to finish and create the wallet. This makes no network calls.
But it is now necessary to call await wallet.initialize()
in order to make the network call to hydrate the wallet with blockchain info (UTXOs, tokens, etc).
Separating these calls makes it easier to test applications that depend on this wallet library. This is the primary reason for the change.
To expand: It is not necessary to mock the wallet's creation during tests, which is quite complex. Devs can simply mock the initialize()
function in unit tests, in order to prevent it from making network calls.
v4.0.0
v4 of minimal-slp-wallet uses v5 of bch-js, which phases out SLPDB in favor of psf-slp-indexer. In v4 of minimal-slp-wallet, a greater emphasis will be placed on using bch-consumer over bch-js.
v3.0.0
v3 is a heavy refactor. Functionality hasn't changed, but the code behind that functionality has changed greatly. The library now uses bchjs.Utxo.get() to handle BCH and token UTXOs.
v2.0.0
This major version to 2.0.0 makes the following changes:
- Bumps bch-js to v4.2.5 which includes breaking changes to tokenUtxoDetails() and hydrateUtxos().
- Deprecates minimal-slp-wallet-web as this base repository is now run through browserify to create a front end JS library.
- Adds Husky for pre-commit linting and compiling.
v1.0.0
Forked from minimal-bch-wallet v1.1.0. Kicking off Semantic Release.