A suite of libraries for building modern, lightweight, descriptor-based wallets written in Rust!
The bdk libraries aim to provide well engineered and reviewed components for Bitcoin wallets and other applications.
They are built upon the excellent rust-bitcoin and rust-miniscript crates.
The workspace in this repository contains several crates in the /crates directory:
| Sub-Directory | Description | Badges |
|---|---|---|
chain | Tools for storing and indexing chain data. |   |
core | A collection of core structures used by the bdk_chain, bdk_wallet, and BDK's chain data source crates. |   |
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. |   |
bitcoind_rpc | Extends bitcoincore-rpc for emitting blockchain data from the bitcoind RPC interface in the form that bdk_chain and Wallet can consume. |   |
file_store | Persistence backend for storing chain data in a single file. Intended for testing and development purposes, not for production. |   |
The bdk_wallet repository and crate contains a higher level Wallet type that depends on the above lower-level mechanism crates.
To report a security issue, please refer to the security policy.
The following BDK crates maintains a MSRV of 1.85.0. To build these crates with the MSRV of 1.85.0 you will need to pin dependencies by running the pin-msrv.sh script.
bdk_corebdk_chainbdk_bitcoind_rpcbdk_esplorabdk_file_storebdk_electrum
This project has a justfile for easy command running. You must have just installed.
To see a list of available recipes: just
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.