Skip to content

Commit 72b7cb6

Browse files
committed
Merge #187: docs: update readme
96335ca docs: update readme (Vihiga Tyonum) Pull request description: <!-- You can erase any parts of this template not applicable to your Pull Request. --> ### Description Update readme document <!-- Describe the purpose of this PR, what's being adding and/or fixed --> <!-- In this section you can include notes directed to the reviewers, like explaining why some parts of the PR were done in a specific way --> <!-- Notice the release manager should include in the release tag message changelog --> <!-- See https://keepachangelog.com/en/1.0.0/ for examples --> ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk-cli/blob/master/CONTRIBUTING.md) * [x] I ran `cargo fmt` and `cargo clippy` before committing ACKs for top commit: notmandatory: ACK 96335ca Tree-SHA512: 9e13d2c322a3538406d07c752aa4a9391cd57670372b9f7ff9c16450629ee28edbf6a7380e61b9d539d2b384ebb4a4886b60deda3c48fe6fe074672fd64eba20
2 parents aec59ae + 96335ca commit 72b7cb6

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,24 +28,26 @@
2828
## About
2929

3030
**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.
3232

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.
3434
And yes, it can do Taproot!!
3535

3636
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.
3838
- 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).
3939
- (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.
4040

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)
4242

4343
bdk-cli can be compiled with different features to suit your experimental needs.
4444
- Database Options
4545
- `sqlite` : Sets the wallet database to a `sqlite3` db.
4646
- Blockchain Client Options
4747
- `esplora` : Connects the wallet to an esplora server.
4848
- `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.
4951
- Extra Utility Tools
5052
- `repl` : use bdk-cli as a [REPL](https://codewith.mu/en/tutorials/1.0/repl) shell (useful for quick manual testing of wallet operations).
5153
- `compiler` : opens up bdk-cli policy compiler commands.
@@ -68,14 +70,14 @@ bdk-cli help # to verify it worked
6870
If no blockchain client feature is enabled online wallet commands `sync` and `broadcast` will be
6971
disabled. To enable these commands a blockchain client feature such as `electrum` or another
7072
blockchain client feature must be enabled. Below is an example of how to run the `bdk-cli` binary with
71-
the `esplora` blockchain client feature.
73+
the `electrum` blockchain client feature.
7274

7375
```shell
74-
RUST_LOG=debug cargo run --features esplora -- wallet --client-type esplora --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
76+
RUST_LOG=debug cargo run --features electrum -- --network testnet4 wallet --wallet testnetwallet --ext-descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" --client-type electrum --database-type sqlite --url "ssl://mempool.space:40002" sync
7577
```
7678

7779
Available blockchain client features are:
78-
`electrum`, `esplora`.
80+
`electrum`, `esplora`, `kyoto`, `rpc`.
7981

8082
### From crates.io
8183
You can install the binary for the latest tag of `bdk-cli` with online wallet features
@@ -96,13 +98,13 @@ cargo run
9698
To sync a wallet to the default electrum server:
9799

98100
```shell
99-
cargo run --features electrum -- wallet -c electrum --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
101+
cargo run --features electrum -- --network testnet4 wallet --wallet sample_wallet --ext-descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" --database-type sqlite --client-type electrum --url "ssl://mempool.space:40002" sync
100102
```
101103

102104
To get a wallet balance with customized logging:
103105

104106
```shell
105-
RUST_LOG=debug,rusqlite=info,rustls=info cargo run -- wallet --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" get_balance
107+
RUST_LOG=debug,rusqlite=info,rustls=info cargo run -- wallet --external-descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" balance
106108
```
107109

108110
To generate a new extended master key, suitable for use in a descriptor:
@@ -114,8 +116,3 @@ cargo run -- key generate
114116
## Minimum Supported Rust Version (MSRV)
115117

116118
This library should always compile with any valid combination of features on Rust **1.75.0**.
117-
118-
## Resources
119-
Docs: [bitcoindevkit.org CLI Section](https://bitcoindevkit.org/bdk-cli/installation/)
120-
Episode on the _Bitcoin Developers Show_: [Youtube](https://www.youtube.com/watch?v=-Q8OD8NCEe4)
121-
Video Tutorials: [Youtube Playlist](https://www.youtube.com/playlist?list=PLmyfVqsSelG3jSobvpY3GoNKDtAumsrg3)

0 commit comments

Comments
 (0)