BDK

A modern, lightweight, descriptor-based wallet library written in Rust!

Project Homepage | Documentation

The bdk libraries aims to provide well engineered and reviewed components for Bitcoin based applications. It is built upon the excellent rust-bitcoin and rust-miniscript crates.

The project is split up into several crates in the /crates directory:

• wallet: Contains the central high level Wallet type that is built from the low-level mechanisms provided by the other components
• chain: Tools for storing and indexing chain data
• file_store: Persistence backend for storing chain data in a single file. Intended for testing and development purposes, not for production.
• esplora: Extends the esplora-client crate with methods to fetch chain data from an esplora HTTP server in the form that bdk_chain and Wallet can consume.
• electrum: Extends the electrum-client crate with methods to fetch chain data from an electrum server in the form that bdk_chain and Wallet can consume.

Fully working examples of how to use these components are in /example-crates:

• example_cli: Library used by the example_* crates. Provides utilities for syncing, showing the balance, generating addresses and creating transactions without using the bdk_wallet Wallet.
• example_electrum: A command line Bitcoin wallet application built on top of example_cli and the electrum crate. It shows the power of the bdk tools (chain + file_store + electrum), without depending on the main bdk_wallet library.
• example_esplora: A command line Bitcoin wallet application built on top of example_cli and the esplora crate. It shows the power of the bdk tools (chain + file_store + esplora), without depending on the main bdk_wallet library.
• example_bitcoind_rpc_polling: A command line Bitcoin wallet application built on top of example_cli and the bitcoind_rpc crate. It shows the power of the bdk tools (chain + file_store + bitcoind_rpc), without depending on the main bdk_wallet library.
• example_wallet_esplora_blocking: Uses the Wallet to sync and spend using the Esplora blocking interface.
• example_wallet_esplora_async: Uses the Wallet to sync and spend using the Esplora asynchronous interface.
• example_wallet_electrum: Uses the Wallet to sync and spend using Electrum.

The BDK library maintains a MSRV of 1.63.0. This includes the following crates:

• bdk_core
• bdk_chain
• bdk_bitcoind_rpc.
• bdk_esplora.
• bdk_wallet.

The MSRV of bdk_electrum is 1.75.0.

To build with the MSRV of 1.63.0 you will need to pin dependencies by running the pin-msrv.sh script.

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.