Skip to content

Commit

Permalink
README.md:use bdk-cli for all instances
Browse files Browse the repository at this point in the history
  • Loading branch information
RandyMcMillan committed Nov 28, 2023
1 parent 6d84b96 commit 854f072
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This crate can be used for the following purposes:

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)

bdk-cli can be compiled with different features to suit your experimental needs.
`bdk-cli` can be compiled with different features to suit your experimental needs.

- Database Options
- `key-value-db` : Sets the wallet database to a `sled` db.
Expand All @@ -50,10 +50,10 @@ bdk-cli can be compiled with different features to suit your experimental needs.
- `esplora-ureq` or `esplora-reqwest` : Connects the wallet to an esplora server synchronously or asynchronously.

- Extra Utility Tools
- `repl` : use bdk-cli as a [REPL](https://codewith.mu/en/tutorials/1.0/repl) shell (useful for quick manual testing of wallet operations).
- `compiler` : opens up bdk-cli policy compiler commands.
- `repl` : use `bdk-cli` as a [REPL](https://codewith.mu/en/tutorials/1.0/repl) shell (useful for quick manual testing of wallet operations).
- `compiler` : opens up `bdk-cli` policy compiler commands.
- `verify` : uses `bitcoinconsensus` to verify transactions at every `sync` call of the wallet.
- `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)
- `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)

- Automated Node Backend
- `regtest-bitcoin` : Auto deploys a regtest `bitcoind` node, connects the wallet, and exposes core rpc commands via `bdk-cli node` subcommands.
Expand Down

0 comments on commit 854f072

Please sign in to comment.