Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update bdk 0.30.x README docs to deprecate the bdk library #1791

Merged
merged 2 commits into from
Jan 8, 2025
Merged

Update bdk 0.30.x README docs to deprecate the bdk library #1791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e52c911
docs: update README to deprecate the bdk lib
notmandatory Jan 6, 2025
6d2e243
release: bump version to 0.30.1
notmandatory Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [v0.30.1]

### Fixed

- Fix electrum conftime_req filter for needs_block_height #1782

## [v0.30.0]

### Summary
Expand Down Expand Up @@ -700,4 +706,5 @@ final transaction is created by calling `finish` on the builder.
[v0.28.2]: https://github.com/bitcoindevkit/bdk/compare/v0.28.1...v0.28.2
[v0.29.0]: https://github.com/bitcoindevkit/bdk/compare/v0.28.2...v0.29.0
[v0.30.0]: https://github.com/bitcoindevkit/bdk/compare/v0.29.0...v0.30.0
[Unreleased]: https://github.com/bitcoindevkit/bdk/compare/v0.30.0...HEAD
[v0.30.1]: https://github.com/bitcoindevkit/bdk/compare/v0.30.0...v0.30.1
[Unreleased]: https://github.com/bitcoindevkit/bdk/compare/v0.30.1...release/0.29
notmandatory marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "bdk"
version = "0.30.0"
version = "0.30.1"
authors = ["Alekos Filini <alekos.filini@gmail.com>", "Riccardo Casatta <riccardo@casatta.it>"]
homepage = "https://bitcoindevkit.org"
repository = "https://github.com/bitcoindevkit/bdk"
Expand Down
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@
</h4>
</div>

## !! DEPRECATED !!

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/).

The BDK team will continue to publish `bdk` `0.30.x` bug fix releases as needed, but only for a limited time.

## About

The `bdk` library aims to be the core building block for Bitcoin wallets of any kind.
Expand Down
11 changes: 11 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@

//! A modern, lightweight, descriptor-based wallet library written in Rust.
//!
//! ## !! DEPRECATED !!
//!
//! 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/).
//!
//! The BDK team will continue to publish `bdk` `0.30.x` bug fix releases as needed, but only for a
//! limited time.
//!
//! # About
//!
//! The BDK library aims to be the core building block for Bitcoin wallets of any kind.
Expand Down