From 4a1ff1b4a52ab4b83ad7193cb67a5bebb2339d16 Mon Sep 17 00:00:00 2001 From: musab1258 Date: Fri, 10 Jul 2026 15:05:19 +0100 Subject: [PATCH 1/2] docs: update cargo feature flags in README to match Cargo.toml The README referenced outdated compile-time feature flags `kyoto` and `sp`, which caused 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. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 006a5663..7d15de93 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ bdk-cli can be compiled with different features to suit your experimental needs. - Blockchain Client Options - `esplora` : Connects the wallet to an esplora server. - `electrum` : Connects the wallet to an electrum server. - - `kyoto`: Connects the wallet to a kyoto client and server. + - `cbf`: Connects the wallet to a kyoto client and server. - `rpc`: Connects the wallet to Bitcoind server. - 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). @@ -89,7 +89,7 @@ RUST_LOG=debug cargo run --features electrum -- wallet -w testnetwallet balance ``` Available blockchain client features are: -`electrum`, `esplora`, `kyoto`, `rpc`. +`electrum`, `esplora`, `cbf`, `rpc`. ### From crates.io @@ -161,18 +161,18 @@ cargo run --features rpc -- wallet --wallet payjoin_wallet2 send_payjoin --ohttp 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: ```shell -cargo run --features sp -- --network signet silent_payment_code --scan_public_key '' --spend_public_key '' +cargo run --features silent-payments -- --network signet silent_payment_code --scan_public_key '' --spend_public_key '' ``` 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: ```shell -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 : +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 : ``` It's also possible to drain all balance to a silent payment wallet by using the `--send_all` flag: ```shell -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 :0 +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 :0 ``` ### Payjoin From 047bbbe106d485da4d7d9e6fa7e06220b3876b93 Mon Sep 17 00:00:00 2001 From: Vihiga Tyonum Date: Sat, 11 Jul 2026 04:30:11 +0100 Subject: [PATCH 2/2] docs: update sp code key params in docs example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d15de93..330a73b3 100644 --- a/README.md +++ b/README.md @@ -161,7 +161,7 @@ cargo run --features rpc -- wallet --wallet payjoin_wallet2 send_payjoin --ohttp 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: ```shell -cargo run --features silent-payments -- --network signet silent_payment_code --scan_public_key '' --spend_public_key '' +cargo run --features silent-payments -- --network signet silent_payment_code --scan_key '' --spend_key '' ``` 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: