Release 0.28.0

Summary

This is a maintenance release and includes changes from yanked version 0.27.2 including to disable default-features for rust-bitcoin and rust-miniscript dependencies, and for rust-esplora-client optional dependency. New default std feature must now be enabled unless building for wasm.

Changelog

• Bump bip39 crate to v2.0.0 #875
• Set default-features = false for rust-bitcoin and rust-miniscript #882
• Update esplora client dependency to version 0.4 #884
• Added new std feature as part of default features #930

What's Changed

• Set dev-dependency base64ct version to <1.6.0 by @notmandatory in #877
• Set default-features = false for rust-bitcoin and rust-miniscript by @benthecarman in #882
• Update esplora client dependency to version 0.4 by @notmandatory in #884
• Bump version to 0.27.2 by @notmandatory in #892
• Bump bip39 crate to v2.0.0 by @tnull in #875
• Add default std feature, prep for 0.28.0 release by @notmandatory in #930

Full Changelog: v0.27.1...v0.28.0

Release 1.0.0-alpha.0

Summary

The first "alpha" release of the new BDK 1.0 refactoring work. This is still a WIP and only meant to be used for testing and experimentation with downstream projects.

Also bumping below workspace crate versions:

bdk_chain to 0.4.0
bdk_electrum to 0.2.0
bdk_esplora to 0.2.0
bdk_file_store to 0.1.0

Changelog

Not updating the CHANGELOG file for alpha releases, just putting here for the record.

• bdk v1.0.0-alpha.0 #793
• Nit fixes on documentation #888
• Add docs for EsploraAsyncExt and make doctests runnable #889
• Simplify reveal_to_target logic #890

Release 0.27.2

RELEASE YANKED FROM CRATES.IO

See: #897

Summary

Disable default-features for rust-bitcoin and rust-miniscript dependencies, and for rust-esplora-client optional dependency.

Changelog

Changed

• Set default-features = false for rust-bitcoin and rust-miniscript #882
• Update esplora client dependency to version 0.4 #884

What's Changed

• Set dev-dependency base64ct version to <1.6.0 by @notmandatory in #877
• Set default-features = false for rust-bitcoin and rust-miniscript by @benthecarman in #882
• Update esplora client dependency to version 0.4 by @notmandatory in #884
• Bump version to 0.27.2 by @notmandatory in #892

Full Changelog: v0.27.1...v0.27.2

Release 0.27.1

Summary

Fixes RUSTSEC-2022-0090, this issue is only applicable if you are using the optional sqlite database feature.

Changelog

Changed

• Update optional sqlite dependency from 0.27.0 to 0.28.0. #867

Full Changelog: v0.27.0...v0.27.1

Release 0.27.0

Summary

A maintenance release with a bump in project MSRV to 1.57.0, updated dependence and a few developer oriented improvements. Improvements include better error formatting, don't default to async/await for wasm32 and adding derived PartialEq and Eq on SyncTime.

Changelog

Changed

• Improve display error formatting #814
• Don't default to use async/await on wasm32 #831
• Project MSRV changed from 1.56.1 to 1.57.0 #842
• Update rust-miniscript dependency to latest bug fix release 9.0 #844

Added

• Derive PartialEq, Eq on SyncTime #837

What's Changed

• Update esplora-client by @rajarshimaitra in #830
• Bump CI Rust stable version to 1.65.0 by @yukibtc in #815
• Bump project MSRV to 1.57.0 by @notmandatory in #842
• Improve display error formatting by @yukibtc in #814
• Don't default to use async/await on wasm32 by @tnull in #831
• Derive PartialEq, Eq on SyncTime by @MaxFangX in #837
• Document return type of sign method. by @Tibo-lg in #834
• Update CHANGELOG and release process by @notmandatory in #846
• Add small clarification to docs by @thunderbiscuit in #838
• Update rust-miniscript to 9.0 by @notmandatory in #844
• Update electrsd to version 0.22 by @notmandatory in #847
• Bump version to 0.27.0 by @notmandatory in #852

New Contributors

• @MaxFangX made their first contribution in #837
• @Tibo-lg made their first contribution in #834

Full Changelog: v0.26.0...v0.27.0

Release 0.26.0

Summary

This release improves Fulcrum electrum server compatibility and fixes public descriptor template key origin paths. We also snuck in small enhancements to configure the electrum client to validate the domain using SSL and sort TransactionDetails by block height and timestamp.

Changelog

Fixed

• Make electrum blockchain client save_tx function order independent to work with Fulcrum servers. #808
• Fix wrong testnet key origin path in public descriptor templates. #818
• Make README.md code examples compile without errors. #820

Added

• For electrum blockchain client, allow user to configure whether to validate the domain using SSL. #805
• Implement ordering for TransactionDetails. #812

Changed

• Bump hwi dependency to 0.4.0. #825
• Bump esplora-client dependency to 0.3 #830

What's Changed

• Downgrade ubuntu to 20.04 for test_hardware_wallet CI job by @notmandatory in #811
• Update ci nightly-docs workflow to use nightly-2022-12-14 by @notmandatory in #822
• Make README.md code examples compile without errors by @petertodd in #820
• fix: make save_tx order independent by @bodymindarts in #808
• Fix wrong key origin path in public descriptor templates by @yukibtc in #818
• Implement ordering for TransactionDetails by @benthecarman in #812
• electrum: add validate_domain to ElectrumBlockchainConfig by @icota in #805
• Bump hwi to 0.4.0 by @danielabrozzoni in #825
• [#344] Add assert_matches by @Synesso in #821
• Bump version to 0.26.0 by @notmandatory in #828

New Contributors

• @petertodd made their first contribution in #820
• @bodymindarts made their first contribution in #808
• @yukibtc made their first contribution in #818
• @benthecarman made their first contribution in #812
• @icota made their first contribution in #805
• @Synesso made their first contribution in #821

Full Changelog: v0.25.0...v0.26.0

Release 0.25.0

Summary

This release fixes slow sync time and big script_pubkeys table with SQLite, the wallet rescan height for the FullyNodedExport and setting the network for keys in the KeyMap when using descriptor templates. Also added are new blockchain and mnemonic examples.

Changelog

Fixed

• Slow sync time and big script_pubkeys table with SQLite.
• Wallet rescan height for the FullyNodedExport.
• Setting the network for keys in the KeyMap when using descriptor templates.

Added

• Examples for connecting to Esplora, Electrum Server, Neutrino and Bitcoin Core.
• Example for using a mnemonic in a descriptors.

What's Changed

• Fix wallet export rescan height by @LLFourn in #785
• Add code example for each supported backend by @w0xlt in #526
• fix: ensure the key network is updated in the KeyMap as well by @afilini in #800
• Add mnemonic_to_descriptors example by @vladimirfomene in #746
• Bump version to 0.25.0 by @notmandatory in #803
• Ensure there are no duplicated script_pubkeys in sqlite by @afilini in #806

Full Changelog: v0.24.0...v0.25.0

Release 0.24.0

Summary

This release contains important dependency updates for rust-bitcoin to 0.29 and rust-miniscript to 8.0, plus related crates that also depend on the latest version of rust-bitcoin. The release also includes a breaking change to the BDK signer which now produces low-R signatures by default, saving one byte. A bug was found in the get_checksum and get_checksum_bytes functions, which are now deprecated in favor of fixed versions called calc_checksum and calc_checksum_bytes. And finally a new hardware-signer features was added that re-exports the hwi crate, along with a new hardware_signers.rs example file.

Changelog

Changed

• Updated dependency versions for rust-bitcoin to 0.29 and rust-miniscript to 8.0, plus all related crates. @afilini #770
• BDK Signer now produces low-R signatures by default, saving one byte. If you want to preserve the original behavior, set allow_grinding in the SignOptions to false. @vladimirfomene #779
• Deprecated get_checksumand get_checksum_bytes due to bug where they calculates the checksum of a descriptor that already has a checksum. Use calc_checksum and calc_checksum_bytes instead. @evanlinjin #765
• Remove deprecated "address validators". @afilini #770

Added

• New calc_checksum and calc_checksum_bytes, replace deprecated get_checksum and get_checksum_bytes. @evanlinjin #765
• Re-export the hwi crate when the feature hardware-signer is on. @danielabrozzoni #758
• New examples/hardware_signer.rs. @danielabrozzoni #758
• Make psbt module public to expose PsbtUtils trait to downstream projects. @notmandatory #782

What's Changed

• Bump version to 0.23.0 by @afilini in #768
• Add enhancement request github issue template by @notmandatory in #772
• Update psbt_signer example to use descriptor! macro by @notmandatory in #780
• Add signature grinding for ECDSA signatures by @vladimirfomene in #779
• Make psbt mod public and add required docs by @notmandatory in #782
• Add HWI example in docs by @danielabrozzoni in #758
• Upgrade to rust-bitcoin 0.29 by @afilini in #770
• Fix how descriptor checksums are calculated by @evanlinjin in #765
• Bump version to 0.24.0 by @notmandatory in #788

Full Changelog: v0.23.0...v0.24.0

v0.23.0

What's Changed

• Update electrum-client to 0.11.0 by @afilini in #737
• Change configs for source-base code coverage by @wszdexdrf in #708
• Run code coverage on every PR by @danielabrozzoni in #747
• Add psbt_signer.rs example by @notmandatory in #744
• Add fee_amount() and fee_rate() functions to PsbtUtils trait by @notmandatory in #728
• Improve docs regarding PSBT finalization by @tnull in #753
• Add tests to improve coverage by @vladimirfomene in #745
• Enable signing taproot transactions with only non_witness_utxos by @afilini in #757
• Add datatype for is_spent sqlite column by @vladimirfomene in #713
• Update compiler example to a Policy example by @rajarshimaitra in #730
• Remove redundant duplicated keys check by @afilini in #761
• Fix the release process by @afilini in #754
• Remove genesis_block lazy initialization by @shobitb in #756
• Add vscode filter to gitignore by @evanlinjin in #762
• Fix Wallet::descriptor_checksum to actually return the checksum by @evanlinjin in #763
• Use the esplora client crate by @afilini in #764

New Contributors

• @tnull made their first contribution in #753
• @shobitb made their first contribution in #756

Full Changelog: v0.22.0...v0.23.0

v0.22.0

Summary

This release brings support for hardware signers on desktop through the HWI library.

It also includes fixes and improvements which are part of our ongoing effort of integrating BDK and LDK together.

Changelog

Added

• Functions to create FeeRate from sats/kvbytes and sats/kwu. #678
• Custom hardware wallet signer HwiSigner in wallet::hardwaresigner module. #682
• Function allow_dust on TxBuilder. #689
• Implementation of Deref<Target=UrlClient> for EsploraBlockchain. #722
• Implementation of Deref<Target=Client> for ElectrumBlockchain #705
• Implementation of Deref<Target=Client> for RpcBlockchain. #731

Changed

• FeeRate function name as_sat_vb to as_sat_per_vb. #678
• Verify signatures after signing. #718
• Dependency electrum-client to 0.11.0. #737

All Changes

• Fix rpc::CoreTxIter logic. by @evanlinjin in #704
• Fix minor typos in docs by @thunderbiscuit in #703
• Release/0.21.0 by @afilini in #711
• Fix P2WPKH_SATISFACTION_SIZE in CS tests by @danielabrozzoni in #723
• Implement Deref<Target=Client> for RpcBlockchain by @rajarshimaitra in #731
• Implement Deref<Target=Client> for ElectrumBlockchain by @afilini in #705
• Implement Deref<Target=UrlClient> for EsploraBlockchain by @vladimirfomene in #722
• Verify signatures after signing by @quad in #718
• Implement conversion for Lightning fee rate by @vladimirfomene in #678
• [bug-fix] Set the db sync height by @rajarshimaitra in #726
• Add a custom signer for hardware wallets by @wszdexdrf in #682
• Add allow_dust method to TxBuilder by @terror in #689
• Update DEVELOPMENT_CYCLE.md to work with [patch.crates-io] by @notmandatory in #544
• Fix docs.rs features by @afilini in #738
• Bump master version to 0.22.0 by @afilini in #743

New Contributors

• @quad made their first contribution in #718
• @terror made their first contribution in #689

Full Changelog: v0.21.0...v0.22.0