Skip to content

Commit 9df9827

Browse files
committed
Merge #1791: Update bdk 0.30.x README docs to deprecate the bdk library
6d2e243 release: bump version to 0.30.1 (Steve Myers) e52c911 docs: update README to deprecate the bdk lib (Steve Myers) Pull request description: ### Description This is needed to direct new and existing users to upgrade to the new `bdk_wallet`1.0 library. I also used this PR to bump the version and changelog to v0.30.1 so we're ready to publish the fix in #1782. ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) * [x] I ran `cargo fmt` and `cargo clippy` before committing ACKs for top commit: thunderbiscuit: ACK 6d2e243. Tree-SHA512: b5d5eb8ae2df719e18430a7629970f0ec06e023d07a7ff1ea03bb7fb43b5bcb27d5975473cc2c1a310afe16b64263551ce2d25c2a44a0302cfdacd9a41f597d7
2 parents 68c78e4 + 6d2e243 commit 9df9827

File tree

4 files changed

+26
-2
lines changed

4 files changed

+26
-2
lines changed

CHANGELOG.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
## [Unreleased]
1111

12+
## [v0.30.1]
13+
14+
### Fixed
15+
16+
- Fix electrum conftime_req filter for needs_block_height #1782
17+
1218
## [v0.30.0]
1319

1420
### Summary
@@ -700,4 +706,5 @@ final transaction is created by calling `finish` on the builder.
700706
[v0.28.2]: https://github.com/bitcoindevkit/bdk/compare/v0.28.1...v0.28.2
701707
[v0.29.0]: https://github.com/bitcoindevkit/bdk/compare/v0.28.2...v0.29.0
702708
[v0.30.0]: https://github.com/bitcoindevkit/bdk/compare/v0.29.0...v0.30.0
703-
[Unreleased]: https://github.com/bitcoindevkit/bdk/compare/v0.30.0...HEAD
709+
[v0.30.1]: https://github.com/bitcoindevkit/bdk/compare/v0.30.0...v0.30.1
710+
[Unreleased]: https://github.com/bitcoindevkit/bdk/compare/v0.30.1...release/0.29

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "bdk"
3-
version = "0.30.0"
3+
version = "0.30.1"
44
authors = ["Alekos Filini <[email protected]>", "Riccardo Casatta <[email protected]>"]
55
homepage = "https://bitcoindevkit.org"
66
repository = "https://github.com/bitcoindevkit/bdk"

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@
2424
</h4>
2525
</div>
2626

27+
## !! DEPRECATED !!
28+
29+
The [bdk](https://crates.io/crates/bdk) library is now deprecated and replaced by [bdk_wallet](https://crates.io/crates/bdk_wallet). All projects should migrate to [bdk_wallet 1.0.0](https://crates.io/crates/bdk_wallet/1.0.0) or newer as soon as possible. For migration instructions see the ["Book of BDK"](https://bitcoindevkit.github.io/book-of-bdk/) chapter on ["Migrating from 0.x"](https://bitcoindevkit.github.io/book-of-bdk/getting-started/migrating/).
30+
31+
The BDK team will continue to publish `bdk` `0.30.x` bug fix releases as needed, but only for a limited time.
32+
2733
## About
2834

2935
The `bdk` library aims to be the core building block for Bitcoin wallets of any kind.

src/lib.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,17 @@
2121

2222
//! A modern, lightweight, descriptor-based wallet library written in Rust.
2323
//!
24+
//! ## !! DEPRECATED !!
25+
//!
26+
//! The [bdk](https://crates.io/crates/bdk) library is now deprecated and replaced by
27+
//! [bdk_wallet](https://crates.io/crates/bdk_wallet). All projects should migrate to
28+
//! [bdk_wallet 1.0.0](https://crates.io/crates/bdk_wallet/1.0.0) or newer as soon as possible. For
29+
//! migration instructions see the ["Book of BDK"](https://bitcoindevkit.github.io/book-of-bdk/)
30+
//! chapter on ["Migrating from 0.x"](https://bitcoindevkit.github.io/book-of-bdk/getting-started/migrating/).
31+
//!
32+
//! The BDK team will continue to publish `bdk` `0.30.x` bug fix releases as needed, but only for a
33+
//! limited time.
34+
//!
2435
//! # About
2536
//!
2637
//! The BDK library aims to be the core building block for Bitcoin wallets of any kind.

0 commit comments

Comments
 (0)