-
Notifications
You must be signed in to change notification settings - Fork 412
Closed
Description
Create a new minor release
Summary
This release introduces a block-by-block API to bdk::Wallet and adds a RPC wallet example, improves performance of bdk_file_store::EntryIter, and simplifies Esplora::update_local_chain with additional tests. See release notes for all the details.
Commit
Changelog
Fixed
InsertTxErrornow implementsstd::error::Error. Introduce block-by-block API tobdk::Walletand add RPC wallet example #1172- Simplified
EsploraExt::update_local_chainlogic. SimplifyEsplora::update_local_chainand add tests #1267
Changed
EntryIterperformance is improved by reducing syscalls. Improve performance ofbdk_file_store::EntryIter#1270- Changed to implement
ElectrumExtfor all that implementsElectrumApi. ImplementElectrumExtfor all that implementsElectrumApi#1306
Added
Walletmethods to apply full blocks (apply_blockandapply_block_connected_to) and a method to apply a batch of unconfirmed transactions (apply_unconfirmed_txs). Introduce block-by-block API tobdk::Walletand add RPC wallet example #1172CheckPoint::from_block_idsconvenience method. Introduce block-by-block API tobdk::Walletand add RPC wallet example #1172LocalChainmethods to apply a block header (apply_headerandapply_header_connected_to). Introduce block-by-block API tobdk::Walletand add RPC wallet example #1172- Test to show that
LocalChaincan apply updates that are shorter than original. This will happen during reorgs if we sync wallet withbdk_bitcoind_rpc::Emitter. Introduce block-by-block API tobdk::Walletand add RPC wallet example #1172
Checklist
Release numbering must follow Semantic Versioning. These steps assume the current master branch development version is 1.0.0-alpha.4.
On the day of the feature freeze
Change the master branch to the 1.0.0-alpha.5 version:
- Switch to the
masterbranch. - Create a new PR branch called
bump_dev_1.0.0_alpha.5. - Bump the
bump_dev_1.0.0_alpha.5branch to the next development MINOR+1 version.- Change the bdk
Cargo.tomlversion value to1.0.0-alpha.5. - Bump the other modified crates versions in their
Cargo.tomlfiles.- bdk_chain
- bdk_bitciond_rpc
- bdk_electrum
- bdk_esplora
- bdk_file_store
- The commit message should be:
Bump version to 1.0.0-alpha.5 bdk_chain to 0.9.0 bdk_bitcoind_rpc to 0.4.0 bdk_electrum to 0.7.0 bdk_esplora to 0.7.0 bdk_file_store to 0.5.0
- Change the bdk
- Create PR and merge the
bump_dev_1.0.0-alpha.5branch tomaster. Bump version to 1.0.0-alpha.5 #1307- Title PR "Bump bdk version to 1.0.0-alpha.5".
On the day of the release
Tag and publish new release:
- Add a tag to the
HEADcommit in themasterbranch.- The tag name should be
v1.0.0-alpha.5 - The first line of the tag message should be "Release 1.0.0-alpha.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
--signflag.
- The tag name should be
- Wait for the CI to finish one last time.
- Push the new tag to the
bitcoindevkit/bdkrepo. - Publish all the updated crates to crates.io.
- bdk_chain
- bdk_bitciond_rpc
- bdk_electrum
- bdk_esplora
- 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.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
1.0.0release 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 🎉
Metadata
Metadata
Assignees
Labels
releaseRelease related issue or PRRelease related issue or PR
Type
Projects
Status
Done