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.

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

Conversation

notmandatory
Copy link
Member

@notmandatory notmandatory commented Jan 6, 2025

Description

This is needed to direct new and existing users to upgrade to the new bdk_wallet1.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:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

@notmandatory notmandatory changed the base branch from master to release/0.29 January 6, 2025 21:16
@notmandatory notmandatory self-assigned this Jan 7, 2025
@notmandatory notmandatory added the documentation Improvements or additions to documentation label Jan 7, 2025
Copy link
Contributor

@oleonardolima oleonardolima left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cACK f549745

@oleonardolima
Copy link
Contributor

Should another mention of the latest bdk_wallet be added to docs, so it appears on docs.rs too?

bdk/src/lib.rs

Lines 22 to 33 in f549745

//! A modern, lightweight, descriptor-based wallet library written in Rust.
//!
//! # About
//!
//! The BDK library aims to be the core building block for Bitcoin wallets of any kind.
//!
//! * It uses [Miniscript](https://github.com/rust-bitcoin/rust-miniscript) to support descriptors with generalized conditions. This exact same library can be used to build
//! single-sig wallets, multisigs, timelocked contracts and more.
//! * It supports multiple blockchain backends and databases, allowing developers to choose exactly what's right for their projects.
//! * It is built to be cross-platform: the core logic works on desktop, mobile, and even WebAssembly.
//! * It is very easy to extend: developers can implement customized logic for blockchain backends, databases, signers, coin selection, and more, without having to fork and modify this library.
//!

@notmandatory
Copy link
Member Author

notmandatory commented Jan 8, 2025

This needs to be rebased after #1782 is merged (and fixes CI issues). Done.

Copy link
Member

@thunderbiscuit thunderbiscuit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 6d2e243.

CHANGELOG.md Show resolved Hide resolved
@notmandatory notmandatory merged commit 9df9827 into bitcoindevkit:release/0.29 Jan 8, 2025
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants