Summary

This release of bdk_chain v0.23.3 brings a new list_ordered_canonical_txs method, and SpkTxOutIndex and KeychainTxOutIndex now expose spent and created TxOut's. It also includes bug fixes: a panic in the scan loop, incorrect ChainPosition ordering, assumed canonical transactions always being reported as unconfirmed, and confirmation_height_upper_bound not being correctly forwarded in the Anchor implementation for &A.

Commit

d9aa92b

Changelog

• fix(ci): backport webpki-roots pinned version and clippy fixes #2061
• chore(ci): pin proptest to 1.8.0 on 1.75.0 MSRV #2075
• feat(chain): add new list_ordered_canonical_txs method #2027
• chain 0.23.x: Fix panic in scan loop and update msrv and esplora-client #2148
• fix(ci): pin toolchain, and switch to actions-rust-lang/setup-rust-toolchain #2151
• chain 0.23.x: Fix ChainPosition ordering #2146
• chain 0.23.x: forward confirmation_height_upper_bound in Anchor implementation for &A #2149
• chain 0.23.x: Fix assumed canonical tx always being unconfirmed #2150

Checklist

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

On the day of the feature freeze

Change the release/chain-0.23.x branch to the next MINOR+1 version:

• Switch to the release/chain-0.23.x branch.
• Create a new PR branch called release/chain-0.23.3.
• Bump the release/chain-0.23.3 branch to the next development MINOR+1 version.
  • Change the Cargo.toml version value to 0.23.3.
  • Update the CHANGELOG.md file.
  • The commit message should be "chore(release): bump bdk_chain to 0.23.3".
• Create PR and merge the release/chain-0.23.3 branch to master.
  • Title PR "chore(release): bump bdk_chain to 0.23.3".

Create a new release branch and release candidate tag:

• Double check that your local release/chain-0.23.x is up-to-date with the upstream repo.
• Create a new branch called release/chain-0.23.3 from release/chain-0.23.x.
• Bump the release/chain-0.23.x branch to 0.23.3 version.
  • Change the Cargo.toml version value to 0.23.3.
  • The commit message should be "chore(release): bump bdk_chain to 0.23.3".
• Add a tag to the HEAD commit in the release/chain-0.23.x branch.
  • The tag name should be chain-0.23.3
  • Use message "Release chain-0.23.3".
  • Make sure the tag is signed, for extra safety use the explicit --sign flag.
• Push the release/chain-0.23.3 branch and new tag to the bitcoindevkit/bdk repo.
  • Use git push --tags option to push the new chain-0.23.3 tag.

On the day of the release

Tag and publish new release:

• Bump the release/chain-0.23.x branch to 0.23.3 version.
  • Change the Cargo.toml version value to 0.23.3.
  • The commit message should be "chore(release): bump bdk_chain to 0.23.3".
• Add a tag to the HEAD commit in the release/chain-0.23.x branch.
  • The tag name should be chain-0.23.x
  • The first line of the tag message should be "Release chain-0.23.3".
  • 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.
• 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 🎉