Release 3.0.0-rc.1

[ValuedMammal]

Summary

BDK Wallet 3.0.0 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.

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.

Commit

fca6523

Changelog

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

Checklist

Release numbering must follow Semantic Versioning. These steps assume the current master branch development version is 3.0.0-alpha.0.

• Create new release issue; label and triage
• Archive done PRs on the project board
• Write the Summary and Release Notes
• Create PR bumping the version and update CHANGELOG.md Release 3.0.0-rc.1 #398
• Wait for CI, review, and merge
• Tag the merge commit (--sign --edit)
• git push --tags
• cargo publish
• Publish GitHub release page
• Announce on discord, social media
• Open follow-up PR to bump the master dev version