]> Untitled Git - bdk-cli/commitdiff
Update README
authorrajarshimaitra <rajarshi149@gmail.com>
Thu, 7 Oct 2021 15:41:10 +0000 (21:11 +0530)
committerrajarshimaitra <rajarshi149@gmail.com>
Thu, 7 Oct 2021 15:41:10 +0000 (21:11 +0530)
README.md

index cbb9d427dc72e6bce5792850476e32cdb4ca3bb9..b0bfeb00e88dbc41ee04a2d06bc7df093509a7d3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@ RUST_LOG=debug cargo run --features esplora-ureq -- wallet --descriptor "wpkh(tp
 ```
 
 At most one blockchain feature can be enabled, available blockchain client features are:
-`electrum`, `esplora-ureq` (blocking), `esplora-reqwest` (async), and `compact_filters`.
+`electrum`, `esplora-ureq` (blocking), `esplora-reqwest` (async), `compact_filters` and `rpc`.
 
 ### From crates.io
 You can the install the binaries for the latest tag of `bdk-cli` with online wallet features 
@@ -52,6 +52,12 @@ To sync a wallet to the default electrum server:
 cargo run --features electrum -- wallet --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
 ```
 
+To sync a wallet to Bitcoin Core node (assuming a regtest node at 127.0.0.1:18443) using the core rpc:
+
+```shell
+cargo run --features rpc -- --network regtest wallet --node 127.0.0.1:18443 --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
+```
+
 To sync a wallet to Bitcoin Core node (assuming a regtest node at 127.0.0.1:18444) serving compact filters:
 Note: 
 - This will increase build time by few minutes for the binaries because of `librocksdb`.