Release 0.10.0

[notmandatory]

Create a new minor release

Summary

This release updates BDK to 0.23 and has a number of breaking changes and new apis. See changelog for all the details.

Commit

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

Changelog

• Update BDK to latest version 0.23.0 Bump bdk depencency to 0.23.0 #204

• Update uniffi-rs to latest version 0.21.0 Update uniffi dependencies to 0.21.0 #216

• Breaking Changes

  • Changed TxBuilder.finish() to return new TxBuilderResult Change TxBuilder.finish() to return new TxBuilderResult #209
  • TxBuilder.add_recipient() now takes a Script instead of an Address Make add_recipient() take any ScriptPubKey  #192
  • AddressAmount is now ScriptAmount Make add_recipient() take any ScriptPubKey  #192

• APIs Added

  • Added TxBuilderResult with PSBT and TransactionDetails Change TxBuilder.finish() to return new TxBuilderResult #209
  • Address and Script structs have been added Make add_recipient() take any ScriptPubKey  #192
  • Add PartiallySignedBitcoinTransaction.extract_tx() function Make add_recipient() take any ScriptPubKey  #192
  • Add secret_key_bytes() method on the DescriptorSecretKey Add ability to retrieve private keys as bytes #199
  • Add PartiallySignedBitcoinTransaction.combine() method Add combine() method on PSBT #200

Checklist

Release numbering must follow Semantic Versioning. These steps assume the current master
branch development version is 0.9.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".

Create a new release branch:

• 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.

On the day of the release

Tag and publish new release:

• Bump the release/MAJOR.MINOR+1 branch to MAJOR.MINOR+1.0 version.
  • Change the Cargo.toml version value to MAJOR.MINOR+1.0.
  • The commit message should be "Bump version to MAJOR.MINOR+1.0".
• 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 repo.
• 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.
• After downstream language repos are also updated announce the release, using the Summary,
  on Discord, Twitter and Mastodon.
• Celebrate 🎉