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
+11-14Lines changed: 11 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,24 +28,26 @@
28
28
## About
29
29
30
30
**EXPERIMENTAL**
31
-
This crate is in to process of being updated to `bdk_wallet` 1.x. Only use with for testing on test networks.
31
+
This crate has been updated to use `bdk_wallet` 1.x. Only use for testing on test networks.
32
32
33
-
This project provides a command-line Bitcoin wallet application using the latest [BDK APIs](https://docs.rs/bdk/latest/bdk/wallet/struct.Wallet.html). This might look tiny and innocent, but by harnessing the power of BDK it provides a powerful generic descriptor based command line wallet tool.
33
+
This project provides a command-line Bitcoin wallet application using the latest [BDK Wallet APIs](https://docs.rs/bdk_wallet/1.0.0/bdk_wallet/index.html) and chain sources ([RPC](https://docs.rs/bdk_bitcoind_rpc/0.18.0/bdk_bitcoind_rpc/index.html), [Electrum](https://docs.rs/bdk_electrum/0.21.0/bdk_electrum/index.html), [Esplora](https://docs.rs/bdk_esplora/0.21.0/bdk_esplora/), [Kyoto](https://docs.rs/bdk_kyoto/0.9.0/bdk_kyoto/)). This might look tiny and innocent, but by harnessing the power of BDK it provides a powerful generic descriptor based command line wallet tool.
34
34
And yes, it can do Taproot!!
35
35
36
36
This crate can be used for the following purposes:
37
-
- 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.
37
+
- Instantly create a miniscript based wallet and connect to your backend of choice (Electrum, Esplora, Core RPC, Kyoto etc) and quickly play around with your own complex bitcoin scripting workflow. With one or many wallets, connected with one or many backends.
38
38
- 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).
39
39
- (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.
40
40
41
-
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)
41
+
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_wallet/1.0.0/bdk_wallet/index.html)
42
42
43
43
bdk-cli can be compiled with different features to suit your experimental needs.
44
44
- Database Options
45
45
-`sqlite` : Sets the wallet database to a `sqlite3` db.
46
46
- Blockchain Client Options
47
47
-`esplora` : Connects the wallet to an esplora server.
48
48
-`electrum` : Connects the wallet to an electrum server.
49
+
-`kyoto`: Connects the wallet to a kyoto client and server.
50
+
-`rpc`: Connects the wallet to Bitcoind server.
49
51
- Extra Utility Tools
50
52
-`repl` : use bdk-cli as a [REPL](https://codewith.mu/en/tutorials/1.0/repl) shell (useful for quick manual testing of wallet operations).
51
53
-`compiler` : opens up bdk-cli policy compiler commands.
@@ -68,14 +70,14 @@ bdk-cli help # to verify it worked
68
70
If no blockchain client feature is enabled online wallet commands `sync` and `broadcast` will be
69
71
disabled. To enable these commands a blockchain client feature such as `electrum` or another
70
72
blockchain client feature must be enabled. Below is an example of how to run the `bdk-cli` binary with
0 commit comments