Release 4.0.0

[tvpeter]

Summary

This release introduces experimental support for creating silent payment transactions and adds support for BIP-353 DNS payment instructions. It also adds UTXO locking through new wallet commands. Async payjoin sessions are now persisted to SQLite, so interrupted payjoin sessions can be resumed rather than lost. The release also includes internal refactoring that improves readability and makes adding new commands easier. It also updates the Wallet API to v3.1.0.

Commit

<--latest commit ID to include in this release-->

Changelog

• Add payjoin persistence by @Mshehu5 in Payjoin persistence #242
• Add experimental silent payment transaction creation support by @nymius in Add experimental silent payment transaction creation support #220
• Add BIP353 DNS payment instruction support by @sdmg15 in feat: add BIP353 DNS payment instructions #236
• Add UTXO locking/unlocking by @tvpeter in Add Lock/Unlock UTXO Commands #293
• Refactor project structure by @tvpeter in Refactor bdk-cli structure  #278
• Add integration tests by @tvpeter in test: Implement integration tests  #289
• Update features list in README.md by @Musab1258 in docs: update cargo features in README to match Cargo.toml #300
• Rename bip322 feature to message_signer by @aagbotemi
• Enforce single recipient for send_all by @1estart in fix(create_tx): enforce single recipient for send_all #291
• Add randomization of the unspendable internal key for taproot descriptors by @va-an in feat(compile): compile taproot descriptor with randomized unspendable internal key #225

Checklist

Release numbering must follow Semantic Versioning. These steps assume the current master
branch development version is MAJOR.MINOR.0.

On the day of the feature freeze

Change the master branch to the next MINOR+1 version:

• Switch to the master branch.
• Create a new PR branch called bump_dev_MAJOR_MINOR+1, eg. bump_dev_0_22.
• Bump the bump_dev_MAJOR_MINOR+1 branch to the next development MINOR+1 version.
  • Change the Cargo.toml version value to MAJOR.MINOR+1.0.
  • The commit message should be "Bump version to MAJOR.MINOR+1.0".
• Create PR and merge the bump_dev_MAJOR_MINOR+1 branch to master.
  • Title PR "Bump version to MAJOR.MINOR+1.0".

On the day of the release

Tag and publish new release:

• Double check that your local master is up-to-date with the upstream repo.
• Create a new branch called release/MAJOR.MINOR+1 from master.
• Add a tag to the HEAD commit in the release/MAJOR.MINOR+1 branch.
  • The tag name should be vMAJOR.MINOR+1.0
  • The first line of the tag message should be "Release MAJOR.MINOR+1.0".
  • In the body of the tag message put a copy of the Summary and Changelog for the release.
  • Make sure the tag is signed, for extra safety use the explicit --sign flag.
• Wait for the CI to finish one last time.
• Push the new tag to the bitcoindevkit/bdk-cli repo.
• Publish all the updated crates to crates.io.
• Create the release on GitHub.
  • Go to "tags", click on the dots on the right and select "Create Release".
  • Set the title to Release MAJOR.MINOR+1.0.
  • In the release notes body put the Summary and Changelog.
  • Use the "+ Auto-generate release notes" button to add details from included PRs.
  • Until we reach a 1.0.0 release check the "Pre-release" box.
• Make sure the new release shows up on crates.io and that the docs are built correctly on docs.rs.
• Announce the release, using the Summary, on Discord, Twitter and Mastodon.
• Celebrate 🎉