About
This project provides a command-line Bitcoin wallet application using the latest BDK APIs. This might look tiny and innocent, but by harnessing the power of BDK it provides a powerful generic descriptor based command line wallet tool. And yes, it can do Taproot!!
This crate can be used for the following purposes:
- Instantly create a miniscript based wallet and connect to your backend of choice (Electrum, Esplora, Core RPC, etc) and quickly play around with your own complex bitcoin scripting workflow. With one or many wallets, connected with one or many backends.
- The
tests/integration.rs
module is used to document high level complex workflows between BDK and different Bitcoin infrastructure systems, like Core, Electrum and Lightning(soon TM). - (Planned) Expose the basic command handler via
wasm
to integratebdk-cli
functionality natively into the web platform. See also the playground page.
If you are considering using BDK in your own wallet project bdk-cli is a nice playground to get started with. It allows easy testnet and regtest wallet operations, to try out what's possible with descriptors, miniscript, and BDK APIs. For more information on BDK refer to the website and the rust docs
bdk-cli can be compiled with different features to suit your experimental needs.
- Database Options
key-value-db
: Sets the wallet database to asled
db.sqlite-db
: Sets the wallet database to asqlite3
db.
- Blockchain Options
rpc
: Connects the wallet to bitcoin core via RPC.electrum
: Connects the wallet to an electrum server.esplora-ureq
oresplora-reqwest
: Connects the wallet to an esplora server synchronously or asynchronously.
- Extra Utility Tools
repl
: use bdk-cli as a REPL shell (useful for quick manual testing of wallet operations).compiler
: opens up bdk-cli policy compiler commands.verify
: usesbitcoinconsensus
to verify transactions at everysync
call of the wallet.reserves
: opens up bdk-cli Proof of Reserves operation commands using the bdk-reserves plugin. (requires theelectrum
feature)
- Automated Node Backend
regtest-bitcoin
: Auto deploys a regtestbitcoind
node, connects the wallet, and exposes core rpc commands viabdk-cli node
subcommands.regtest-electrum
: Auto deployselectrsd
and connectedbitcoind
nodes, exposes core rpc commands viabdk-cli node
and provides a wallet connected to the localelectrsd
.
The default
feature set is repl
and sqlite-db
. With the default
features, bdk-cli
can be used as an air-gapped wallet, and can do everything that doesn't require a network connection.
Install bdk-cli
From source
To install a dev version of bdk-cli
from a local git repo with the electrum
blockchain client enabled:
cd <bdk-cli git repo directory>
cargo install --path . --features electrum
bdk-cli help # to verify it worked
If no blockchain client feature is enabled online wallet commands sync
and broadcast
will be
disabled. To enable these commands a blockchain client feature such as electrum
or another
blockchain client feature must be enabled. Below is an example of how to run the bdk-cli
binary with
the esplora-ureq
blockchain client feature.
RUST_LOG=debug cargo run --features esplora-ureq -- wallet --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
At most one blockchain feature can be enabled, available blockchain client features are:
electrum
, esplora-ureq
(blocking), esplora-reqwest
(async) and rpc
.
From crates.io
You can install the binary for the latest tag of bdk-cli
with online wallet features
directly from crates.io with a command as below:
bdk-cli bin usage examples
To get usage information for the bdk-cli
binary use the below command which returns a list of
available wallet options and commands:
cargo run
To sync a wallet to the default electrum server:
cargo run --features electrum -- wallet --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
To sync a wallet to a Bitcoin Core node (assuming a regtest node at 127.0.0.1:18443) using the core rpc:
cargo run --features rpc -- --network regtest wallet --node 127.0.0.1:18443 --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
To get a wallet balance with customized logging:
RUST_LOG=debug,sled=info,rustls=info cargo run -- wallet --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" get_balance
To generate a new extended master key, suitable for use in a descriptor:
cargo run -- key generate
Resources
Docs: bitcoindevkit.org CLI Section
Episode on the Bitcoin Developers Show: Youtube
Video Tutorials: Youtube Playlist