3.1.0

Summary

bdk_wallet v3.1.0 introduces the sign_with_signers method for Wallet giving callers more control over the signing process by accepting a custom list of SignersContainer, and LoadParams gains a convenient two_path_descriptor method for validating the wallet descriptors loaded from persistence. A SECURITY.md document has been added to the repository with instructions for reporting vulnerabilities. This release also includes several bug fixes and improvements.

What's Changed

• refactor: Delegate rusqlite::Connection persister to transaction persister by @shinigami-777 in #421
• feat(wallet): add LoadParams::two_path_descriptor method by @yukibtc in #418
• docs(wallet): fix misleading RBF comment in create_tx by @va-an in #422
• fix(coin_selection): calculate_cs_result returns the required UTXOs first by @ValuedMammal in #390
• chore(tests): replace deprecated FeeRate::from_sat_per_vb_unchecked by @none34829 in #455
• fix(descriptor): correct variable binding names in l: and u: fragment modifiers by @tnull in #454
• chore: allow local justfile overrides by @Shgit29 in #460
• chore: bump dev version to 3.1.0-alpha.0 by @ValuedMammal in #441
• fix(ci): pin idna_adapter to 1.2.1 by @oleonardolima in #466
• fix: always validate non_witness_utxo in add_foreign_utxo by @tnull in #461
• fix: handle MultiXPrv/MultiXPub in network kind detection and fixup by @tnull in #459
• Add SECURITY.md by @luisschwab in #437
• fix: avoid panic on hardened derivation paths in PSBT key origins by @tnull in #458
• fix(descriptor): correct index tracking in combinations() function by @tnull in #453
• fix(audit): add non-witness-utxo validation for psbt by @muhahahmad68 in #471
• fix(types): avoid reachable panics in Utxo::txout for Foreign variant by @muhahahmad68 in #487
• Fix wallet name generation to use explicit public descriptor checksum by @AmosOO7 in #482
• fix(coin_selection): avoid per-utxo fee rounding by @benthecarman in #479
• fix(signer): respect allow_all_sighashes in SignerWrapper::sign_input by @muhahahmad68 in #476
• docs: suggest moving most PR checklist items to contributing guide by @noahjoeris in #492
• feat(wallet): add Wallet::sign_with_signers by @noahjoeris in #490
• Release 3.1.0 by @ValuedMammal in #501

New Contributors

• @shinigami-777 made their first contribution in #421
• @yukibtc made their first contribution in #418
• @va-an made their first contribution in #422
• @none34829 made their first contribution in #455
• @Shgit29 made their first contribution in #460
• @muhahahmad68 made their first contribution in #471
• @benthecarman made their first contribution in #479
• @noahjoeris made their first contribution in #492

Full Changelog: v3.0.0...v3.1.0

Release wallet-2.4.0

Summary

This release focuses on back porting migration support and event system enhancements from the 3.0 release. Key additions include get_pre_v1_wallet_keychains migration helper for upgrading from pre-1.0 bdk sqlite databases, new event tracking methods (apply_unconfirmed_txs_events, apply_evicted_txs_events), and an events_helper function for advanced event handling. The wallet::signer module deprecation has been reverted until the new PSBT signer is ready.

Changelog

Added

• Add get_pre_v1_wallet_keychains migration helper to assist with migrating from pre-1.0 bdk sqlite databases #365, #415
• Add Wallet::apply_unconfirmed_txs_events method for tracking unconfirmed transaction events #399
• Add Wallet::apply_evicted_txs_events method for tracking evicted transaction events #399
• Add Wallet::events_helper method for advanced users to generate WalletEvents after custom operations #399

Reverted

• Un-deprecate wallet::signer module #405

What's Changed

• [backport] Add get_pre_1_wallet_keychains migration helper by @notmandatory in #365
• Backport: Add apply_unconfirmed_txs_events and apply_evicted_txs_events by @notmandatory in #399
• revert: "chore: deprecate wallet::signer mod" by @notmandatory in #405
• backport (2.x): fix sqlite pre1 migration helper by @notmandatory in #415
• Bump version to 2.4.0 by @notmandatory in #467

Full Changelog: wallet-2.3.0...wallet-2.4.0

Release 3.0.0

Summary

BDK Wallet 3.0.0 includes documentation enhancements and important updates to continuous integration and developer workflows. This is a major release that includes changes from the latest release candidates, summaries of which are also linked to below.

What's Changed

• Bump Rust compiler version to stable (1.94.0) by @thunderbiscuit in #407
• build(deps): bump actions/upload-artifact from 6 to 7 by @dependabot[bot] in #389
• build(deps): bump Swatinem/rust-cache from 2.8.2 to 2.9.1 by @dependabot[bot] in #406
• build(deps): bump codecov/codecov-action from 5.5.2 to 6.0.0 by @dependabot[bot] in #424
• ci: add docs check job by @oleonardolima in #416

Full Changelog: v3.0.0-rc.2...v3.0.0

---

3.0.0-rc.2

BDK Wallet 3.0.0-rc.2 features enhanced ergonomics and type safety of the pre version 1.0 wallet migration utility and fixes a panic in the descriptor! macro when provided with invalid locktime values. The macro now handles improperly constructed AbsLockTime and RelLockTime values by propagating an error back to the caller.

Release notes: https://github.com/bitcoindevkit/bdk_wallet/releases/tag/v3.0.0-rc.2

3.0.0-rc.1

BDK Wallet 3.0.0-rc.1 introduces major API changes including persistent UTXO locking, structured wallet events, and adopts NetworkKind throughout the codebase for improved network handling. This release also adds support for Caravan wallet format import/export and includes a special migration utility for SQLite databases existing prior to version 1.0. Documentation and test coverage have been expanded, along with several quality of life improvements.

Important

Changes to persisted data
This release includes a SQLite migration which adds a new table to the wallet database bdk_wallet_locked_outpoints used for tracking UTXO lock statuses. This change is backwards compatible.

Release notes: https://github.com/bitcoindevkit/bdk_wallet/releases/tag/v3.0.0-rc.1

Release 3.0.0-rc.2

Summary

BDK Wallet 3.0.0-rc.2 features enhanced ergonomics and type safety of the pre version 1.0 wallet migration utility and fixes a panic in the descriptor! macro when provided with invalid locktime values. The macro now handles improperly constructed AbsLockTime and RelLockTime values by propagating an error back to the caller.

What's Changed

• fix(dsl): handle invalid RelLockTime without panicking by @AmosOO7 in #404
• fix(dsl): handle invalid AbsLockTime without panicking by @AmosOO7 in #409
• fix(rusqlite): fix get_pre_v1_wallet_keychains migration helper by @notmandatory in #411
• chore: bump version to 3.0.0-rc.2 by @ValuedMammal in #417

New Contributors

• @AmosOO7 made their first contribution in #404

Full Changelog: v3.0.0-rc.1...v3.0.0-rc.2

Release 3.0.0-rc.1

Summary

BDK Wallet 3.0.0-rc.1 introduces major API changes including persistent UTXO locking, structured wallet events, and adopts NetworkKind throughout the codebase for improved network handling. This release also adds support for Caravan wallet format import/export and includes a special migration utility for SQLite databases existing prior to version 1.0. Documentation and test coverage have been expanded, along with several quality of life improvements.

Important

Changes to persisted data
This release includes a SQLite migration which adds a new table to the wallet database bdk_wallet_locked_outpoints used for tracking UTXO lock statuses. This change is backwards compatible.

What's Changed

• ci: bump rust-cache to 2.8.0 by @ValuedMammal in #305
• Add docs + test on required use of xpub for multipath constructor by @thunderbiscuit in #306
• Add utilities to test persistence by @110CodingP in #300
• chore: bump dev version to 3.0.0-alpha.0 by @ValuedMammal in #308
• refactor: have a structured IndexOutOfBoundsError type by @chaitika in #302
• chore(just): add a _default recipe by @luisschwab in #313
• chore: bump MSRV to 1.85.0 by @ValuedMammal in #317
• Add rust-toolchain.toml file by @thunderbiscuit in #315
• feat!: use NetworkKind by @luisschwab in #250
• build(deps): bump actions/upload-artifact from 4 to 5 by @dependabot[bot] in #333
• Replace Coveralls with Codecov for coverage reporting by @GideonBature in #327
• build(deps): bump actions/checkout from 5 to 6 by @dependabot[bot] in #346
• build(deps): bump Swatinem/rust-cache from 2.7.8 to 2.8.2 by @dependabot[bot] in #347
• fix(wallet): Don't fail in build_fee_bump for missing parent txid by @ValuedMammal in #337
• build(deps): bump github/codeql-action from 3 to 4 by @dependabot[bot] in #329
• Update README with new codecov badge by @notmandatory in #341
• Bump Rust compiler version to stable (1.91.1) by @thunderbiscuit in #350
• Bump Rust compiler version to stable (1.92.0) by @thunderbiscuit in #356
• feat!: Persist utxo lock status by @ValuedMammal in #259
• chore: Update example links in README by @Randy808 in #363
• chore(descriptor): justify ignored tests and add missing assertions by @luisschwab in #369
• Make FutureResult non-Send when no-std by @Fedeparma74 in #335
• fix(doc): fix TxOrdering::Untouched doc comment by @luisschwab in #372
• build(deps): bump actions/upload-artifact from 5 to 6 by @dependabot[bot] in #354
• Return wallet events when applying updates and blocks (3.0 milestone) by @notmandatory in #319
• Bump Rust compiler version to stable (1.93.0) by @thunderbiscuit in #377
• Refactor: Move Wallet errors into their dedicated file by @thunderbiscuit in #378
• refactor: rename Wallet::indexed_graph field by @110CodingP in #373
• refactor(wallet)!: Remove unused ApplyBlockError by @thunderbiscuit in #382
• Pass bitcoind_rpc example name on the run recipe by @luisschwab in #384
• feature: Add Caravan wallet format import/export support by @vkprogrammer-001 in #205
• chore: update CODEOWNERS with ValuedMammal and oleonardolima by @notmandatory in #385
• build(deps): bump codecov/codecov-action from 5.5.1 to 5.5.2 by @dependabot[bot] in #353
• Switch to cargo-llvm-cov for code coverage by @Copilot in #371
• Add get_pre_1_wallet_keychains migration helper by @notmandatory in #364
• fix(tx_builder)!: Remove include_output_redeem_witness_script by @Dmenec in #392
• refactor(wallet)!: Remove Wallet::cancel_tx function by @notmandatory in #393
• Add apply_unconfirmed_txs_events and apply_evicted_txs_events by @notmandatory in #388
• docs(changeset): Add section on version compatibility by @ValuedMammal in #391
• Replace std::error::Error with core::error::Error by @luisschwab in #397
• Release 3.0.0-rc.1 by @ValuedMammal in #398

New Contributors

• @110CodingP made their first contribution in #300
• @chaitika made their first contribution in #302
• @GideonBature made their first contribution in #327
• @Randy808 made their first contribution in #363
• @Fedeparma74 made their first contribution in #335
• @Dmenec made their first contribution in #392

Full Changelog: wallet-2.3.0...v3.0.0-rc.1

Release wallet-2.3.0

Summary

This minor release of BDK Wallet v2.3.0 includes a new feature for returning events upon applying blocks to the Wallet. It also fixes a TxBuilder::build_fee_bump error when a parent of the transaction being fee-bumped isn't found in the wallet.

Changelog

Added

• feat: add apply_block_events and apply_block_connected_to_events #336

Fixed

• fix: (backport #337) - don't fail in build_fee_bump for missing parent txid #349
• ci: pin syn crate to 2.0.106 #338

What's Changed

• ci(msrv): pin syn crate to 2.0.106 by @notmandatory in #338
• Add apply_block_events and apply_block_connected_to_events by @tnull in #336
• Backport #337 - fix(wallet): Don't fail in build_fee_bump for missing parent txid by @ValuedMammal in #349
• Bump version to 2.3.0 by @notmandatory in #351

Full Changelog: wallet-2.2.0...wallet-2.3.0

Release wallet-2.2.0

Summary

This minor release of BDK Wallet v2.2.0 includes a new feature for returning events upon applying an update to the Wallet. It also includes new test facilities for testing persistence, as well as documentation improvements.

Important

Note that the signer module has been deprecated and is planned to be removed in a future release.

The current PSBT signing logic can be found in bitcoin::psbt module, most notably Psbt::sign.

What's Changed

• docs: add metadata fields to issue templates for triage by @LagginTimes in #296
• ci: automated update to rustc 1.89.0 by @create-pr-actions[bot] in #298
• docs: (Backport #306) - add wording on required use of xpub for multipath constructor by @thunderbiscuit in #309
• feat: (Backport #300) - Add utilities to test persistence by @ValuedMammal in #311
• feat: Return wallet events when applying updates by @notmandatory in #310

New Contributors

• @LagginTimes made their first contribution in #296
• @110CodingP made their first contribution in #300

Full Changelog: wallet-2.1.0...wallet-2.2.0

Release wallet-2.1.0

Summary

This release of bdk_wallet v2.1.0 introduces two significant features: comprehensive support for BIP-389 two-path multipath descriptors with automatic receive/change separation through new Wallet::create_from_two_path_descriptor, and enhanced transaction building capabilities with TxBuilder::exclude_unconfirmed and TxBuilder::exclude_below_confirmations for filtering UTXOs by confirmation status. The release also includes important fixes related to coin selection and script pubkey (SPK) cache recovery.

What's Changed

• chore: bump dev version to 2.1.0-alpha.0 by @ValuedMammal in #256
• ci: automated update to rustc 1.87.0 by @create-pr-actions[bot] in #242
• Bump bitcoin dependency requirement to v0.32.6 to reflect used API by @tnull in #266
• feat: add justfile by @luisschwab in #268
• Prefer Utxo::Local over Utxo::Foreign in OldestFirstCoinSelection by @nymius in #265
• Preserve insertion order of manually selected utxos if TxOrdering::Untouched by @nymius in #262
• feat: Add exclude_unconfirmed and exclude_below_confirmations by @evanlinjin in #258
• test: Move bump fee + foreign utxo tests by @ValuedMammal in #199
• chore: add CODEOWNERS file by @luisschwab in #233
• Multipath descriptor support (BIP 389) by @schjonhaug in #275
• clippy: fix uninlined format args by @ValuedMammal in #287
• docs(wallet): expand docs for apply_evicted_txs by @ValuedMammal in #270
• Fix KeychainTxOutIndex recovery logic when spk-cache is enabled by @evanlinjin in #288
• docs(wallet): add sync operation to bdk_wallet examples by @tvpeter in #274
• chore(deps): bump bdk-chain to 0.23.1 by @oleonardolima in #292
• Release 2.1.0 by @oleonardolima in #293

New Contributors

• @create-pr-actions[bot] made their first contribution in #242
• @tnull made their first contribution in #266
• @nymius made their first contribution in #265
• @schjonhaug made their first contribution in #275
• @tvpeter made their first contribution in #274
• @oleonardolima made their first contribution in #292

Full Changelog: wallet-2.0.0...wallet-2.1.0

Release wallet-2.0.0

Summary

This release includes a bug fix for handling stuck or evicted transactions, performance enhancements for large wallets, more extensive test coverage, and the return of TxDetails. This is the first stable release since the bdk_wallet crate moved to a new repository.

The below bdk chain client crate versions are compatible with this bdk_wallet release:

• bdk_bitcoind_rpc 0.20.0
• bdk_electrum 0.23.0
• bdk_esplora 0.22.0
• bdk_kyoto 0.11.0

Changes to persisted data

The wallet ChangeSet is extended to include the following (sub-)fields. This change is backwards compatible.

• tx_graph::ChangeSet::first_seen
• tx_graph::ChangeSet::last_evicted
• keychain_txout::ChangeSet::spk_cache

What's Changed

• chore: split bdk_wallet into it's own repository by @notmandatory in #2
• chore: remove lazy_static from Cargo.toml by @luisschwab in #218
• chore(example_wallet_rpc): bump ctrlc to 3.4.6 by @luisschwab in #217
• chore(example_wallet_esplora_async): bump tokio to 1.38.1 by @luisschwab in #219
• deps!: update bdk_chain to 0.22.0 by @ValuedMammal in #208
• Chore: migrate library version naming convention on master by @thunderbiscuit in #215
• docs(wallet): provide guidance on use of ChangeSet by @ValuedMammal in #198
• ci: Add Ubuntu 24.04 ARM support for build-test job by @vkprogrammer-001 in #200
• Add zizmor github actions security analysis workflow by @notmandatory in #8
• fix: no Debug on Display implementations by @luisschwab in #12
• chore: create and apply rustfmt.toml by @luisschwab in #213
• feat(test): add legacy descriptor tests by @luisschwab in #214
• feat(test-utils)!: use bitcoin::Amount instead of u64 on tests by @luisschwab in #223
• fix(wallet): fix into_descriptor_key for DescriptorPublicKey by @ValuedMammal in #241
• fix: Validate prevouts in get_psbt_input by @evanlinjin in #232
• Bring back TxDetails by @thunderbiscuit in #201
• deps: Update bdk_chain to 0.23.0 by @ValuedMammal in #247

Full Changelog: wallet-1.2.0...wallet-2.0.0

Release wallet-2.0.0-beta.0

Summary

This is a beta release in preparation for a final v2.0.0 of BDK wallet. We encourage users to test the release and report any issues.

The release includes a bug fix for handling stuck or evicted transactions, performance enhancements for large wallets, more extensive test coverage, and the return of TxDetails. This is the first release since the bdk_wallet crate moved to a new repository.

Changes to persisted data

The wallet ChangeSet is extended to include the following (sub-)fields. This change is backwards compatible.

• tx_graph::ChangeSet::first_seen
• tx_graph::ChangeSet::last_evicted
• keychain_txout::ChangeSet::spk_cache

What's Changed

• chore: split bdk_wallet into it's own repository by @notmandatory in #2
• chore: remove lazy_static from Cargo.toml by @luisschwab in #218
• chore(example_wallet_rpc): bump ctrlc to 3.4.6 by @luisschwab in #217
• chore(example_wallet_esplora_async): bump tokio to 1.38.1 by @luisschwab in #219
• deps!: update bdk_chain to 0.22.0 by @ValuedMammal in #208
• Chore: migrate library version naming convention on master by @thunderbiscuit in #215
• docs(wallet): provide guidance on use of ChangeSet by @ValuedMammal in #198
• ci: Add Ubuntu 24.04 ARM support for build-test job by @vkprogrammer-001 in #200
• Add zizmor github actions security analysis workflow by @notmandatory in #8
• fix: no Debug on Display implementations by @luisschwab in #12
• chore: create and apply rustfmt.toml by @luisschwab in #213
• feat(test): add legacy descriptor tests by @luisschwab in #214
• feat(test-utils)!: use bitcoin::Amount instead of u64 on tests by @luisschwab in #223
• fix(wallet): fix into_descriptor_key for DescriptorPublicKey by @ValuedMammal in #241
• fix: Validate prevouts in get_psbt_input by @evanlinjin in #232
• Bring back TxDetails by @thunderbiscuit in #201
• deps: Update bdk_chain to 0.23.0 by @ValuedMammal in #247

New Contributors

• @notmandatory made their first contribution in #2
• @luisschwab made their first contribution in #218
• @ValuedMammal made their first contribution in #208
• @thunderbiscuit made their first contribution in #215
• @vkprogrammer-001 made their first contribution in #200
• @evanlinjin made their first contribution in #232

Full Changelog: wallet-1.2.0...wallet-2.0.0-beta.0