You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-18Lines changed: 23 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -31,28 +31,33 @@ This project provides a command-line Bitcoin wallet application using the latest
31
31
And yes, it can do Taproot!!
32
32
33
33
This crate can be used for the following purposes:
34
-
- 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.
35
-
- 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).
36
-
- (Planned) Expose the basic command handler via `wasm` to integrate `bdk-cli` functionality natively into the web platform. See also the [playground](https://bitcoindevkit.org/bdk-cli/playground/) page.
34
+
35
+
- 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.
36
+
- 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).
37
+
- (Planned) Expose the basic command handler via `wasm` to integrate `bdk-cli` functionality natively into the web platform. See also the [playground](https://bitcoindevkit.org/bdk-cli/playground/) page.
37
38
38
39
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](https://bitcoindevkit.org/) and the [rust docs](https://docs.rs/bdk/latest/bdk/index.html)
39
40
40
41
bdk-cli can be compiled with different features to suit your experimental needs.
41
-
- Database Options
42
-
-`key-value-db` : Sets the wallet database to a `sled` db.
43
-
-`sqlite-db` : Sets the wallet database to a `sqlite3` db.
44
-
- Blockchain Options
45
-
-`rpc` : Connects the wallet to bitcoin core via RPC.
46
-
-`electrum` : Connects the wallet to an electrum server.
47
-
-`esplora-ureq` or `esplora-reqwest` : Connects the wallet to an esplora server synchronously or asynchronously.
48
-
- Extra Utility Tools
49
-
-`repl` : use bdk-cli as a [REPL](https://codewith.mu/en/tutorials/1.0/repl) shell (useful for quick manual testing of wallet operations).
50
-
-`compiler` : opens up bdk-cli policy compiler commands.
51
-
-`verify` : uses `bitcoinconsensus` to verify transactions at every `sync` call of the wallet.
52
-
-`reserves` : opens up bdk-cli **Proof of Reserves** operation commands using the [bdk-reserves plugin](https://github.com/bitcoindevkit/bdk-reserves). (requires the `electrum` feature)
53
-
- Automated Node Backend
54
-
-`regtest-bitcoin` : Auto deploys a regtest `bitcoind` node, connects the wallet, and exposes core rpc commands via `bdk-cli node` subcommands.
55
-
-`regtest-electrum` : Auto deploys `electrsd` and connected `bitcoind` nodes, exposes core rpc commands via `bdk-cli node` and provides a wallet connected to the local `electrsd`.
42
+
43
+
- Database Options
44
+
- `key-value-db` : Sets the wallet database to a `sled` db.
45
+
- `sqlite-db` : Sets the wallet database to a `sqlite3` db.
46
+
47
+
- Blockchain Options
48
+
- `rpc` : Connects the wallet to bitcoin core via RPC.
49
+
- `electrum` : Connects the wallet to an electrum server.
50
+
- `esplora-ureq` or `esplora-reqwest` : Connects the wallet to an esplora server synchronously or asynchronously.
51
+
52
+
- Extra Utility Tools
53
+
- `repl` : use bdk-cli as a [REPL](https://codewith.mu/en/tutorials/1.0/repl) shell (useful for quick manual testing of wallet operations).
54
+
- `compiler` : opens up bdk-cli policy compiler commands.
55
+
- `verify` : uses `bitcoinconsensus` to verify transactions at every `sync` call of the wallet.
56
+
- `reserves` : opens up bdk-cli **Proof of Reserves** operation commands using the [bdk-reserves plugin](https://github.com/bitcoindevkit/bdk-reserves). (requires the `electrum` feature)
57
+
58
+
- Automated Node Backend
59
+
- `regtest-bitcoin` : Auto deploys a regtest `bitcoind` node, connects the wallet, and exposes core rpc commands via `bdk-cli node` subcommands.
60
+
- `regtest-electrum` : Auto deploys `electrsd` and connected `bitcoind` nodes, exposes core rpc commands via `bdk-cli node` and provides a wallet connected to the local `electrsd`.
56
61
57
62
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.
0 commit comments