Skip to content

Commit 6dc50fc

Browse files
Merge #136: Remove mention of compact_filters from README until it can be re-enabled
c6f6a07 Remove mention of compact_filters from README until it can be re-enabled (Steve Myers) Pull request description: ### Description Remove mention of compact_filters from README until it can be re-enabled ### Notes to the reviewers I didn't notice this before I merged #125. ### 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: rajarshimaitra: ACK c6f6a07 Tree-SHA512: 218e98d98af55f99ae77c88a75d74868b6503d8894ec8bcd508b3eec457d8a6bfe446d7fee637225ce2667bfdef472cbfd5a0fe54730d49ae1d84a0d560ad9f4
2 parents a968341 + c6f6a07 commit 6dc50fc

File tree

1 file changed

+2
-12
lines changed

1 file changed

+2
-12
lines changed

README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This project provides a command-line Bitcoin wallet application using the latest
3131
And yes, it can do Taproot!!
3232

3333
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, CBF etc) and quickly play around with your own complex bitcoin scripting workflow. With one or many wallets, connected with one or many backends.
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.
3535
- 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).
3636
- (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.
3737

@@ -44,7 +44,6 @@ bdk-cli can be compiled with different features to suit your experimental needs.
4444
- Blockchain Options
4545
- `rpc` : Connects the wallet to bitcoin core via RPC.
4646
- `electrum` : Connects the wallet to an electrum server.
47-
- `compact_filters` : Deploy a BIP157 node to get blockchain data from the bitcoin p2p network.
4847
- `esplora-ureq` or `esplora-reqwest` : Connects the wallet to an esplora server synchronously or asynchronously.
4948
- Extra Utility Tools
5049
- `repl` : use bdk-cli as a [REPL](https://codewith.mu/en/tutorials/1.0/repl) shell (useful for quick manual testing of wallet operations).
@@ -78,7 +77,7 @@ RUST_LOG=debug cargo run --features esplora-ureq -- wallet --descriptor "wpkh(tp
7877
```
7978

8079
At most one blockchain feature can be enabled, available blockchain client features are:
81-
`electrum`, `esplora-ureq` (blocking), `esplora-reqwest` (async), `compact_filters` and `rpc`.
80+
`electrum`, `esplora-ureq` (blocking), `esplora-reqwest` (async) and `rpc`.
8281

8382
### From crates.io
8483
You can install the binary for the latest tag of `bdk-cli` with online wallet features
@@ -108,15 +107,6 @@ To sync a wallet to a Bitcoin Core node (assuming a regtest node at 127.0.0.1:18
108107
cargo run --features rpc -- --network regtest wallet --node 127.0.0.1:18443 --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
109108
```
110109

111-
To sync a wallet to a Bitcoin Core node (assuming a regtest node at 127.0.0.1:18444) serving compact filters:
112-
Note:
113-
- This will increase build time by few minutes for the binaries because of `librocksdb`.
114-
- Bitcoin Core v0.21.0 or higher is required to serve compact filters.
115-
116-
```shell
117-
cargo run --features compact_filters -- --network regtest wallet --node 127.0.0.1:18444 --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
118-
```
119-
120110
To get a wallet balance with customized logging:
121111

122112
```shell

0 commit comments

Comments
 (0)