Release 1.0.0-alpha.11

[notmandatory]

Create a new minor release

Summary

This incremental bi-weekly release includes three big improvements. New electrum full_scan and sync APIs were added for more efficiently querying blockchain data. And the keychain::Changeset now includes public key descriptors and keychain::Balance uses bitcoin::Amount instead of u32 sats amounts. See the changelog for all the details.

Commit

TBD

Changelog

Changed

• Include the descriptor in keychain::Changeset Include the descriptor in keychain::Changeset #1203
• Update bdk_electrum crate to use sync/full-scan structs Update bdk_electrum crate to use sync/full-scan structs #1403
• Update keychain::Balance to use bitcoin::Amount feat: update keychain::Balance to use bitcoin::Amount #1411
• Change bdk_testenv to re-export internally used crates. chore: clean up electrsd and anyhow dev dependencies #1414
• Updated documentation for full_scan and sync in bdk_esplora. docs(esplora): fixed full_scan and sync documentation #1427

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.11 version:

• Switch to the master branch.
• Create a new PR branch called bump_dev_1.0.0_alpha.11.
• Bump the bump_dev_1.0.0_alpha.11 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
    • bdk_chain
    • bdk_bitcoind_rpc
    • bdk_electrum
    • bdk_esplora
    • bdk_file_store
    • bdk_testenv
    • bdk_persist
  • The commit message should be: [update this list with only changed crates]

    Bump bdk version to 1.0.0-alpha.11
    
    bdk_chain to 0.14.0
    bdk_bitcoind_rpc to 0.10.0
    bdk_electrum to 0.13.0
    bdk_esplora to 0.13.0
    bdk_file_store to 0.11.0
    bdk_testenv to 0.4.0
    bdk_persist to 0.2.0
    

• Create PR and merge the bump_dev_1.0.0-alpha.11 branch to master.
  • Title PR "Bump bdk version to 1.0.0-alpha.11".

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.11
  • The first line of the tag message should be "Release 1.0.0-alpha.11".
  • 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
• 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.11.
  • 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 🎉

[ValuedMammal]

Some versions in the issue template appear off. bdk_persist is ahead by one again. Electrum and esplora should have same version?

I'm not sure the above changelog reflects what ultimately ended up in 1203

[notmandatory]

Thanks for double checking the versions bumps, they should be correct now. For #1203, #1403, #1411 I simplified the changelog by only using the PR titles, anyone who needs details can do the diffs.