Skip to content

Commit 9b58a1a

Browse files
committed
Merge #300: docs: update cargo features in README to match Cargo.toml
047bbbe docs: update sp code key params in docs example (Vihiga Tyonum) 4a1ff1b docs: update cargo feature flags in README to match Cargo.toml (musab1258) Pull request description: <!-- You can erase any parts of this template not applicable to your Pull Request. --> ### Description The README referenced outdated cargo feature flags `kyoto` and `sp`, which will cause build failures for users following the instructions. This commit updates the documentation to use the correct flags `cbf` and `silent-payments` as defined in the current `Cargo.toml`. Fixes #299 ### Notes to the reviewers This is a documentation update to the `README.md`. I specifically left the reference to `Kyoto` in the "About" section intact, as it correctly refers to the underlying `bdk_kyoto` library/concept, and only updated the actual Cargo feature flags in the code blocks and feature lists. ## Changelog notice * Fixed outdated cargo feature flags (`kyoto` -> `cbf` and `sp` -> `silent-payments`) in the README instructions. ### 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 #### Bugfixes: * [ ] This pull request breaks the existing API * [ ] I've added tests to reproduce the issue which are now passing * [x] I'm linking the issue being fixed by this PR Top commit has no ACKs. Tree-SHA512: 680ff0f96eab3b28585beaf4d6be89c05985edaf61369207fe2d9ac3722a9d8b69fd898885e13847117f8b5481bbf16b0642506321558f08167c2f6f554bfd12
2 parents 32e6115 + 047bbbe commit 9b58a1a

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ bdk-cli can be compiled with different features to suit your experimental needs.
4747
- Blockchain Client Options
4848
- `esplora` : Connects the wallet to an esplora server.
4949
- `electrum` : Connects the wallet to an electrum server.
50-
- `kyoto`: Connects the wallet to a kyoto client and server.
50+
- `cbf`: Connects the wallet to a kyoto client and server.
5151
- `rpc`: Connects the wallet to Bitcoind server.
5252
- Extra Utility Tools
5353
- `repl` : use bdk-cli as a [REPL](https://codewith.mu/en/tutorials/1.0/repl) shell (useful for quick manual testing of wallet operations).
@@ -89,7 +89,7 @@ RUST_LOG=debug cargo run --features electrum -- wallet -w testnetwallet balance
8989
```
9090

9191
Available blockchain client features are:
92-
`electrum`, `esplora`, `kyoto`, `rpc`.
92+
`electrum`, `esplora`, `cbf`, `rpc`.
9393

9494
### From crates.io
9595

@@ -161,18 +161,18 @@ cargo run --features rpc -- wallet --wallet payjoin_wallet2 send_payjoin --ohttp
161161
162162
To experiment with silent payments, you can get two public keys in compressed or uncompressed format, `A1` and `A2`, and produce a silent payment code by calling:
163163
```shell
164-
cargo run --features sp -- --network signet silent_payment_code --scan_public_key '<A1>' --spend_public_key '<A2>'
164+
cargo run --features silent-payments -- --network signet silent_payment_code --scan_key '<A1>' --spend_key '<A2>'
165165
```
166166

167167
Once you have a silent payment code, `SP_CODE_1` and an amount `AMOUNT_1` to send, you can create a valid transaction locking funds to a silent payment code derived address with the following command:
168168

169169
```shell
170-
cargo run --features electrum,sp -- --network testnet4 wallet --wallet sample_wallet --ext-descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" --database-type sqlite --client-type electrum --url "ssl://mempool.space:40002" create_sp_tx --to-sp <SP_CODE_1>:<AMOUNT_1>
170+
cargo run --features electrum,silent-payments -- --network testnet4 wallet --wallet sample_wallet --ext-descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" --database-type sqlite --client-type electrum --url "ssl://mempool.space:40002" create_sp_tx --to-sp <SP_CODE_1>:<AMOUNT_1>
171171
```
172172

173173
It's also possible to drain all balance to a silent payment wallet by using the `--send_all` flag:
174174
```shell
175-
cargo run --features electrum,sp -- --network testnet4 wallet --wallet sample_wallet --ext-descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" --database-type sqlite --client-type electrum --url "ssl://mempool.space:40002" create_sp_tx --send_all --to-sp <SP_CODE_1>:0
175+
cargo run --features electrum,silent-payments -- --network testnet4 wallet --wallet sample_wallet --ext-descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" --database-type sqlite --client-type electrum --url "ssl://mempool.space:40002" create_sp_tx --send_all --to-sp <SP_CODE_1>:0
176176
```
177177

178178
### Payjoin

0 commit comments

Comments
 (0)