Release 1.0.0-alpha.12

[notmandatory]

Create a new minor release

Summary

This bi-weekly release fixes an electrum syncing bug when calculating fees and adds the bdk_sqlite crate for storing wallet data in a SQLite tables. The Wallet::allow_shrinking function was also remove because it was too easy to misuse. Also the bdk crate was renamed to bdk_wallet. See the changelog for all the details.

Commit

4a8452f

Changelog

Fixed

• Fixed calculate_fee result when syncing with electrum. fix(electrum): Fix fetch_prev_txout #1443

Changed

• Removed TxBuilder::allow_shrinking() function. Remove TxBuilder allow_shrinking() and unneeded context param #1386
• Renamed bdk crate to bdk_wallet. chore: rename bdk crate to bdk_wallet #1326
• Update Wallet to use CombinedChangeSet for persistence. feat: add bdk_sqlite crate implementing PersistBackend #1128

Added

• Add CombinedChangeSet in bdk_persist crate. feat: add bdk_sqlite crate implementing PersistBackend #1128
• Add bdk_sqlite crate implementing SQLite based wallet data storage. feat: add bdk_sqlite crate implementing PersistBackend #1128
• Update bdk_wallet export feature to support taproot descriptors. fix(export): add tr descriptor #1393

Checklist

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

On the day of the feature freeze

Change the master branch to the 1.0.0-alpha.12 version:

• Switch to the master branch.
• Create a new PR branch called release/bump_dev_1.0.0_alpha.12.
• Create a "draft" release page and release notes comparing master commmit with prior tag v1.0.0-alpha.11
• Bump the bump_dev_1.0.0_alpha.12 branch to the next development MINOR+1 version.
  • Bump the modified crates versions in their Cargo.toml files. [update this list with only changed crates]
    • bdk_chain
    • bdk_bitcoind_rpc
    • bdk_electrum
    • bdk_esplora
    • bdk_persist
    • bdk_file_store
    • bdk_sqlite
    • bdk_testenv
    • bdk_hwi (use changes from bdk_hwi, set cargo bdk version to 1.0.0-alpha.8 #1392)
    • bdk_wallet
  • The commit message should be: [update this list with only changed crates]

    bdk_chain to 0.15.0
    bdk_bitcoind_rpc to 0.11.0
    bdk_electrum to 0.14.0
    bdk_esplora to 0.14.0
    bdk_persist to 0.3.0
    bdk_file_store to 0.12.0
    bdk_sqlite keep at 0.1.0
    bdk_testenv to 0.5.0
    bdk_wallet to 1.0.0-alpha.12
    bdk_hwi to 0.1.0
    

• Create PR and merge the release/bump_dev_1.0.0-alpha.12 branch to master. Bump bdk version to 1.0.0-alpha.12 #1450
  • Title PR "Bump bdk version to 1.0.0-alpha.12".

On the day of the release

Tag and publish new release:

• Add a tag to the HEAD commit in the master branch.
  • The tag name should be v1.0.0-alpha.12
  • The first line of the tag message should be "Release 1.0.0-alpha.12".
  • 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 repo.
• Publish all the updated crates to crates.io. [update this list with only changed crates]
  • bdk_chain
  • bdk_testenv
  • bdk_bitcoind_rpc
  • bdk_electrum
  • bdk_esplora
  • bdk_persist
  • bdk_file_store
  • bdk_sqlite
  • bdk_wallet
  • bdk_hwi
• Create the release on GitHub.
  • Go to "tags", click on the dots on the right and select "Create Release".
  • Set the title to Release 1.0.0-alpha.12.
  • 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 Nostr.
• Celebrate 🎉

[notmandatory]

I forgot to publish the bdk_sqlite crate. @thunderbiscuit reminded me and I published it to crates.io today (and updated the above checklist so I won't forget next time).