]> Untitled Git - bdk-cli/commitdiff
Update Changelog and Readme file
authorcodeShark149 <rajarshi149@gmail.com>
Sun, 16 May 2021 10:56:04 +0000 (16:26 +0530)
committercodeShark149 <rajarshi149@gmail.com>
Sat, 22 May 2021 16:37:51 +0000 (22:07 +0530)
CHANGELOG.md
README.md

index f54bfe4d69847d2434521bb3be3c857fc3c01a36..a3591057bb050ed41cbde093f3d88cf9a24b9df6 100644 (file)
@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 #### Added
 - New top level command "Compile" which compiles a miniscript policy to an output descriptor
+- `CompactFilterOpts` to `WalletOpts` to enable compact-filter blockchain configuration 
 
 ## [0.2.0]
 
@@ -42,7 +43,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - "key" sub-commands to "generate" and "restore" a master private key
 - "key" sub-command to "derive" an extended public key from a master private key
 - "repl" command now has an "exit" sub-command
-- `CompactFilterOpts` to `WalletOpts` to enable compact-filter blockchain configuration 
 
 #### Changed
 - "wallet" sub-commands and options must be proceeded by "wallet" command
index 81263edba0fbd151f4ac19948faca88b5c5faec6..75e71b99fb3b6d0b7db7e5ed0107e1f6d3d82406 100644 (file)
--- a/README.md
+++ b/README.md
@@ -24,15 +24,12 @@ cargo run -- wallet --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN
 ```
 
 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`.
+- Bitcoin Core v0.21.0 or higher is required to serve compact filters.  
 
-Update `Cargo.toml`
-```
-[features]
-default = ["repl", "electrum", "compact_filters"]
-```
-Then run:
 ```shell
-cargo run -- --network regtest wallet --node 127.0.0.1:18444 --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
+cargo run --features compact_filters -- --network regtest wallet --node 127.0.0.1:18444 --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
 ```
 
 To get a wallet balance with customized logging: