Release 1.0.0-beta.5

[ValuedMammal]

Create a new major (beta) release

Summary

This release changes bdk_wallet transaction creation to enable RBF by default, it also updates the bdk_esplora client to retry server requests that fail due to rate limiting. The bdk_electrum crate now also offers a use-openssl feature.

Commit

Changelog

• doc(wallet): Add docs to explain the lookahead by @ValuedMammal in doc(wallet): Add docs to explain the lookahead #1596
• fix(RUSTSEC-2024-0370): proc-macro-error is unmaintained by @oleonardolima in https://github.com/bitcoindevkit/bdk/pull/
• fix(bdk_esplora, bdk_electrum): build and test with --no-default-features by @oleonardolima in fix(bdk_esplora, bdk_electrum): build and test with --no-default-features #1615
• fix!(wallet): ChangeSet should not be non-exhaustive by @evanlinjin in fix!(wallet): ChangeSet should not be non-exhaustive #1623
• feat(wallet)!: enable RBF by default on TxBuilder by @luisschwab in feat(wallet)!: enable RBF by default on TxBuilder #1616
• deps(esplora): bump esplora-client to 0.10.0 by @ValuedMammal in deps(esplora): bump esplora-client to 0.10.0 #1626
• feat(chain,core)!: move Merge to bdk_core by @evanlinjin in feat(chain,core)!: move Merge to bdk_core #1625
• Replace trait AnchorFromBlockPosition with new struct by @jirijakes in Replace trait AnchorFromBlockPosition with new struct #1594
• feat(bdk_electrum): add use-openssl as a feature by @oleonardolima in feat(bdk_electrum): add use-openssl as a feature #1620

Checklist

Release numbering must follow Semantic Versioning. These steps assume the current master
branch development version is v1.0.0-beta.4.

On the day of the feature freeze

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

• Ensure all alpha milestone issues and PRs closed, archive them on the project board.
• Switch to the master branch.
• Create a new PR branch called release/bump_dev_1.0.0_beta.5.
• Create a "draft" release page and release notes comparing master commmit with prior tag v1.0.0-beta.4
• Determine which crates need a major release bump and which only need a patch release by looking at the git log. cargo-semver-checks can also help with this
  cargo semver-checks --baseline-rev <last-tag>
• Bump the bump_dev_1.0.0_beta.5 branch to the next development version.

  • Bump the modified crates versions in their Cargo.toml files. [update this list with only changed crates]

    • bdk_core
    • bdk_chain
    • bdk_bitcoind_rpc
    • bdk_electrum
    • bdk_esplora
    • bdk_file_store
    • bdk_testenv
    • bdk_wallet

  • The commit message should be: [update this list with only changed crates]

    Bump bdk_wallet version to 1.0.0-beta.5
    
    bdk_core to 0.3.0
    bdk_chain to 0.20.0
    bdk_bitcoind_rpc to 0.16.0
    bdk_electrum to 0.19.0
    bdk_esplora to 0.19.0
    bdk_file_store to 0.17.0
    bdk_testenv to 0.10.0
    

• Create PR and merge the release/bump_dev_1.0.0_beta.5 branch to master. Bump bdk_wallet version to 1.0.0-beta.5 #1639
  • Title PR "Bump bdk_wallet version to 1.0.0-beta.5".

On the day of the release

Tag and publish new release:

• Add a tag to the HEAD commit in the master branch.
  • git tag v1.0.0-beta.5 --sign -e
  • The tag name should be v1.0.0-beta.5
  • The first line of the tag message should be "Release 1.0.0-beta.5".
  • 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.
• Verify the new tag with git tag -v v1.0.0-beta.5
• Wait for the CI to finish one last time.
• Push the new tag to the bitcoindevkit/bdk repo.
  • git push upstream --tag v1.0.0-beta.5
• Publish all the updated crates to crates.io. [update this list with only changed crates]
  • cargo publish -p <crate name>
  • bdk_core
  • bdk_chain
  • bdk_testenv
  • bdk_bitcoind_rpc
  • bdk_electrum
  • bdk_esplora
  • bdk_file_store
  • bdk_wallet
• 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-beta.5.
  • 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 final 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 🎉