Vihiga Tyonum [Mon, 22 Jun 2026 15:07:28 +0000 (16:07 +0100)]
refactor(runtime): Add address and createtx to db
- Add new address, unused address and createtx
commands to list of commands that require
loading existing db
- adding persisting changes in offline and online
commands
Vihiga Tyonum [Fri, 29 May 2026 03:17:56 +0000 (04:17 +0100)]
Refactor(handlers): Define app context states
- Define Init state for when an execution does
not need either the wallet or client for execution
- Define the Offline wallet operations state
for app context when an execution envt needs
a wallet
- Define the online wallet operations state for
appcontext when an execution needs both the
wallet and client
- make app context generic over the state
- make the app command and async app command
generic over the execution context
- deleted shorten fn as it was applicable to the
pretty flag
- removed tests for pretty flag
This PR adds experimental support for creating silent payment transactions through a new `CreateSpTx` command. The implementation integrates the `bdk_sp` crate to enable sending Bitcoin to silent payment addresses.
Key changes:
- Adds `bdk_sp` dependency as an optional feature
- Implements `CreateSpTx` command with support for silent payment recipients
- Includes parser for silent payment `address:amount` pairs
- Returns signed transactions ready for broadcast (not PSBTs due to silent payment derivation constraints)
**Notes to the reviewers**
- This feature is marked as **EXPERIMENTAL** and includes warnings against mainnet use
- The command returns signed transactions directly rather than PSBTs because silent payment script pubkey derivation cannot be performed securely in a trustless manner with standard PSBT workflows
- RBF is disabled for silent payment transactions (sequence set to MAX)
- The implementation handles both single key and extended key signers
- Error handling uses temporary `.expect()` calls that should be addressed in future iterations
* [x] I've signed all my commits
* [x] I followed the [conventional commit guidelines](https://www.conventionalcommits.org/en/v1.0.0/)
* [x] I ran cargo fmt, clippy and test before committing
**New Features**
~~* [ ] I've added tests for the new feature~~
* [x] I've added docs for the new feature
nymius [Wed, 20 Aug 2025 16:42:12 +0000 (13:42 -0300)]
feat(silentpayments): add experimental silent-payments sending support
- Adds CreateSpTx command to create transactions with silent payment
outputs: this command creates signed transactions directly rather than
PSBTs due to current limitations in secure shared derivation.
It supports mixed recipients: regular addresses + silent payments.
It DOES NOT support RBF for the created transactions.
It generates signed transactions ready for broadcasting.
- Adds SilentPaymentCode command to create silent payment codes from
public keys and network: the silent payment code generated is
independent from any of the other stateful features of bdk-cli.
This command is mainly intended for experimental use, do not lock any
funds to the generated code if you don't know what you are doing and
don't have the keys matching the public keys used.
- Adds bdk_sp dependency with "silent-payments" feature flag.
- Adds silent payment recipient parsing utility.
- Add README section for new silent payment commands.
Note: This is experimental functionality for testing only, not
recommended for mainnet use.
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
### Description
This PR added [BIP322](https://bips.xyz/322) feature into BDK CLI.
It also has a usage file for testing purposes
### Notes to the reviewers
<!-- In this section you can include notes directed to the reviewers, like explaining why some parts
of the PR were done in a specific way -->
## Changelog notice
<!-- Notice the release manager should include in the release tag message changelog -->
<!-- See https://keepachangelog.com/en/1.0.0/ for examples -->
### 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
#### New Features:
* [x] I've added docs for the new feature
* [x] I've updated `CHANGELOG.md`
Update transitive dependency `rand` from 0.9.2 to 0.9.3 via `cargo update -p rand@0.9.2` to resolve RUSTSEC-2026-0097.
Note: #268 (`rand 0.8.5` via `secp256k1` and others) remains unaffected by this change and needs to be fixed upstream.
### 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
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
### Description
This PR bumps the crate version to 3.0.0
Closes #257
<!-- Describe the purpose of this PR, what's being adding and/or fixed -->
### 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
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
### Description
This PR updates transitive dependencies `quinn-proto` and `aws-lc-sys` to fix identified vulnerabilities.
Other `aws-lc-sys` linked vulnerabilities fixed by this update include:
- AWS-LC has Timing Side-Channel in AES-CCM Tag Verification
- AWS-LC has PKCS7_verify Signature Validation Bypass
- CRLs not considered authorative by Distribution Point due to faulty matching logic in `rustls-webpki` v0.103.8
This PR also update:
- clap to v4.6
- clap_complete to v4.6
- env_logger to v0.11.10
- thiserror to v2.0.18
- tracing to v0.1.44
- toml to v1.1.0
- bdk_electrum to v0.23.2
- bdk_kyoto to v0.15.4
- bdk_redb to v0.1.1
- reqwest to v0.13.2
- url to v2.5.8
Fixes #249, #250, #258, #259, #260, #261, #262 and #264
<!-- Describe the purpose of this PR, what's being adding and/or fixed -->
#### 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
Vihiga Tyonum [Wed, 25 Mar 2026 05:34:44 +0000 (06:34 +0100)]
chore: update project deps
This PR also update:
- clap to v4.6
- clap_complete to v4.6
- env_logger to v0.11.10
- thiserror to v2.0.18
- tracing to v0.1.44
- toml to v1.1.0
- bdk_electrum to v0.23.2
- bdk_kyoto to v0.15.4
- bdk_redb to v0.1.1
- reqwest to v0.13.2
- url to v2.5.8
See how to install completions for your shell:
```bash
bdk-cli completions --help
```
For example, to install completions for zsh:
```bash
bdk-cli completions zsh > ~/.zfunc/_bdk-cli
```
After restarting the shell, completions should work with Tab.
### 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
#### New Features:
* [ ] I've added tests for the new feature
* [x] I've added docs for the new feature
* [x] I've updated `CHANGELOG.md`
As pointed out in issue #255, whenever Esplora was configured out, the config test will fail because Esplora was used as the client.
This fix addresses the above issue by adding other client types in the test.
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
Fixes #255
### 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
* [x] I've added tests to reproduce the issue which are now passing
* [x] I'm linking the issue being fixed by this PR
I noticed that we still have mentions of MSRV, despite the fact that MSRV was removed in #211.
In this PR I'm removing the found mentions.
### 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
Cargo's version resolution always updates to the latest patch version. If that patch introduces breaking changes, it breaks your application.
This happened after Payjoin released version 1.0.0-rc.2. Because the version specified for bdk-cli was 1.0.0-rc.1, a fresh install automatically updated to the newer patch.
To resolve this without migrating to the latest Payjoin API, and to prevent future breakages from subsequent 1.0.0-rc.x releases, this commit pins the Payjoin version strictly to =1.0.0-rc.1.
This happened before in another project: rust-bitcoin/rust-bitcoin#5358
**Changelog notice**
```text
fix: enforce `1.0.0-rc.1` payjoin version and avoid automatic patch updates
```
A missing slash was preventing the `receive_payjoin` command from displaying its documentation string:
```bash
Wallet operations.
...
sync Syncs with the chosen blockchain server
broadcast Broadcasts a transaction to the network. Takes either a raw transaction or a PSBT to extract
receive_payjoin
send_payjoin Sends an original PSBT to a BIP 21 URI and broadcasts the returned Payjoin PSBT
new_address Get a new external address
...
```
This change adds the additional slash to make a proper doc string, so clap displays it.
nymius [Tue, 17 Mar 2026 14:15:48 +0000 (11:15 -0300)]
fix(dependencies): change payjoin version specifier `1.0.0-rc.1` to `=1.0.0-rc.1`
Cargo's version resolution always updates to the latest patch version.
If that patch introduces breaking changes, it breaks your application.
This happened after Payjoin released version 1.0.0-rc.2. Because the
version specified for bdk-cli was 1.0.0-rc.1, a fresh install
automatically updated to the newer patch.
To resolve this without migrating to the latest Payjoin API, and to
prevent future breakages from subsequent 1.0.0-rc.x releases, this
commit pins the Payjoin version strictly to =1.0.0-rc.1.
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
### Description
This PR updates the code_coverage workflow by replacing the Coveralls code coverage reports with codecov. It also updates the checkout, rust-lang toolchain setup actions.
Fixes #245
<!-- Describe the purpose of this PR, what's being adding and/or fixed -->
### Notes to the reviewers
<!-- In this section you can include notes directed to the reviewers, like explaining why some parts
of the PR were done in a specific way -->
## Changelog notice
<!-- Notice the release manager should include in the release tag message changelog -->
<!-- See https://keepachangelog.com/en/1.0.0/ for examples -->
### 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
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
### Description
This is a continuation of #221
<!-- Describe the purpose of this PR, what's being adding and/or fixed -->
### Notes to the reviewers
<!-- In this section you can include notes directed to the reviewers, like explaining why some parts
of the PR were done in a specific way -->
- Update the stated `bdk_wallet` to 2.x.x
- Addressed review comments on #221
## Changelog notice
<!-- Notice the release manager should include in the release tag message changelog -->
<!-- See https://keepachangelog.com/en/1.0.0/ for examples -->
### 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
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
### Description
This PR updates the continuous integration workflow and fixes some Clippy issues.
Also fixes #239
<!-- Describe the purpose of this PR, what's being adding and/or fixed -->
### Notes to the reviewers
<!-- In this section you can include notes directed to the reviewers, like explaining why some parts
of the PR were done in a specific way -->
- update `actions/checkout` to v6
- add a separate job for Clippy
- automate manual caching in the `build-test` job
- replace `actions-r/toolchain` with `actions-rust-
lang/setup-rust-toolchain` for toolchain setup
-fix clippy warnings
- add prepush command to Justfile
- Add `tool-version` parameter in audit workflow that forces the `actions-rust-lang/audit` to use a version that supports CVSS 4.0
- update transitive dependency `bytes` to v1.11.1
## Changelog notice
<!-- Notice the release manager should include in the release tag message changelog -->
<!-- See https://keepachangelog.com/en/1.0.0/ for examples -->
### 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
Vihiga Tyonum [Sun, 8 Feb 2026 04:45:21 +0000 (05:45 +0100)]
ci: Update audit workflow and `bytes` dependency
- Add `tool-version` parameter in audit workflow
that forces the `actions-rust-lang/audit` to
download and use a version that supports CVSS 4.0.
- update a transitive dependency `bytes` to v1.11.
1 that fixes `RUSTSEC-2026-0007` security
vulnerability
Vihiga Tyonum [Tue, 6 Jan 2026 10:10:25 +0000 (11:10 +0100)]
ci: update cont_integration workflow
- update actions/checkout to v6
- add separate job for clippy
- automate manual caching in the build-test job
- replace actions-r/toolchain with actions-rust-
lang/setup-rust-toolchain for toolchain setup
- update wasm job and replace build with check
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
### Description
<!-- Describe the purpose of this PR, what's being adding and/or fixed -->
This PR addresses issues encountered while implementing persistence for Payjoin specifically around the BlockchainClient only being an owned variable rather than being able to be borrowed/referenced as &Blockchainclient.
While working on persistence I ran into problems while working on resume command which needs a blockchain client to resume states such as monitor_payjoin_proposal (receiver) and process_payjoin_proposal (sender)
Because BlockchainClient can only be owned the current design will require a function signature of passing two separate clients to resume sender and receiver states. I initially considered splitting the command into resume_send and resume_receive but this does not fully solve the issue. In particular the sender’s process_payjoin_proposal may call broadcast_transaction and potentially broadcast multiple transactions for persisted send entries stored in the database which still requires reusable access to the client.
This Ownership issue was previously mentioned in #200 and is also noted in a comment at the top of monitor_payjoin_proposal. It prevents the function from being able to resync multiple times and reliably detect when a transaction appears in the mempool. The root cause is that the Kyoto client Box<LightClient> is destructured and spawned into other tasks when passed through sync_kyoto_client making it unusable afterward.
What this PR changes
This PR fixes the issue by refactoring sync_kyoto_client
- The logic responsible for running the Kyoto node and logger is moved into new_blockchain_client. This makes it that node is started at start of command and not during every sync
- Instead of returning a Box<lightClient> the function now returns a KyotoClientHandle. Previously the boxed client takes ownership when destructured inside sync_kyoto_client, preventing reuse/reference.
With the new design sync_kyoto_client takes &KyotoClientHandle, allowing the client to be Refrenced which can be used for syncing and broadcasting transactions without being owned
- Additionally monitor_payjoin_proposal is refactored to support resyncing demonstrating that the Kyoto client refactor successfully resolves the original limitations
### Notes to the reviewers
<!-- In this section you can include notes directed to the reviewers, like explaining why some parts
of the PR were done in a specific way -->
After refactor I tested the kyoto client on regtest (Cause I do not have access to a signet) I had to set a trusted peer in the code to connect with a cbf count of 1 this worked and I also made transaction using the steps below:
N.B Payjoin was also tested for the monitor_payjoin_proposal refactor using steps in project readme
```
bitcoin.conf
* [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
Mshehu5 [Mon, 2 Feb 2026 08:52:19 +0000 (09:52 +0100)]
refactor(payjoin): add payjoin error variants to BDKCliError
Replace Error::Generic with specific Payjoin error variants using #[from] derives for applicable places, enabling automatic conversion and eliminating verbose .map_err() calls.
Mshehu5 [Sun, 21 Dec 2025 10:50:12 +0000 (11:50 +0100)]
refactor(payjoin): implement polling-based monitoring with timeout
Replace single sync-and-check with periodic polling loop.
This allows multiple sync operations since sync_wallet now accepts
a reference to BlockchainClient, enabling proper long-running
monitoring instead of a one-time check.
Mshehu5 [Sat, 20 Dec 2025 22:54:46 +0000 (23:54 +0100)]
refactor: use BlockchainClient as references
Update function signatures to accept &BlockchainClient instead of taking
ownership. This refactoring to allow the client to be Referenced across
multiple operations including repeated calls to sync_kyoto_client.
- Update handle_online_wallet_subcommand signature
- Update all PayjoinManager methods to use &BlockchainClient
- Fix parameter dereferencing in full_scan calls
- Update all call sites to pass references
Mshehu5 [Sat, 20 Dec 2025 22:53:14 +0000 (23:53 +0100)]
refactor: use handle pattern for Kyoto client
Refactor KyotoClient to use a KyotoClientHandle struct instead of
Box<LightClient>. Previously, the Box<LightClient> was consumed
when destructured in sync_kyoto_client, preventing the function
from being called multiple times or borrowed. With the handle
pattern, sync_kyoto_client now takes &mut KyotoClientHandle,
allowing it to be borrowed and reused.
This also allows the node to be started at creation time in
new_blockchain_client rather than during sync, making the client
ready for use immediately after creation.
- Add KyotoClientHandle struct containing requester and
update_subscriber
- Move node startup and logger spawning to new_blockchain_client
- Update sync_kyoto_client to accept &mut KyotoClientHandle
instead of consuming Box<LightClient>
<!-- Describe the purpose of this PR, what's being adding and/or fixed -->
This PR adds `bdk-cli wallet config` command to save wallet configuration information to `config.toml` file in the data directory.
Fixes #192
### Notes to the reviewers
- Reusing the exported `serde` crate from `bdk_wallet` did not offer the `derive` feature
- Fix out-of-bound error for `shorten` fn
## Changelog notice
- Add wallet subcommand `config` to save wallet configs
- Add top-level `wallets` command to show all saved wallet configs
<!-- Notice the release manager should include in the release tag message changelog -->
### Checklists
#### Features
* [x] command to save a wallet config, give wallet name or a default name is used, clap enforces required options; optional -f to override existing config: `wallet [-f] [-w <name>] config <wallet opts>`
* [x] All other wallet commands require that a config exists, use wallet name or the default is used. Give error if config is missing: `wallet [-w <name>] sync | balance | new_address |` etc...
* [x] Repl uses the same wallet configs: `repl [-w <name>]`
* [x] command to list all saved wallet configs: `wallets`
* [x] throw warnings if using mainnet and saving a private descriptor in a config.
#### 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
#### New Features:
* [ ] I've added tests for the new feature
* [x] I've added docs for the new feature
* [x] I've updated `CHANGELOG.md`
Vihiga Tyonum [Wed, 18 Jun 2025 08:01:44 +0000 (09:01 +0100)]
feat: add initializing wallet config
- add config.rs to store and retrieve
values
- add toml and serde crates for desearilizing and
reading values
- update utils, commands and handlers files
to use values from config.toml
-refactor prepare_wallet_db fn
- fix clippy issues
<!-- Describe the purpose of this PR, what's being adding and/or fixed -->
The non-persistent wallet path (when sqlite/redb features are disabled) was creating the wallet twice: first as immutable to create the blockchain_client, then again as mutable. This caused the blockchain_client to be initialized with the first wallet instance, but then used with the second wallet instance, creating a mismatch.
#### 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:
* [x] I'm linking the issue being fixed by this PR
The PR addresses https://github.com/bitcoindevkit/bdk-cli/issues/232
Mshehu5 [Thu, 1 Jan 2026 21:13:01 +0000 (22:13 +0100)]
Fix duplicate wallet creation in non-persistent path
The non-persistent wallet path (when sqlite/redb features are
disabled) was creating the wallet twice: first as immutable to
create the blockchain_client, then again as mutable. This caused
the blockchain_client to be initialized with the first wallet
instance, but then used with the second wallet instance, creating
a mismatch.
This change implements the online commands for both sending and receiving a Payjoin. Note that this PR does not implement Payjoin persistence.
### Notes to the reviewers
Tested on my local regtest with rpc using the OHTTP relays and directories in the [payjoin-cli README](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-cli). Feel free to do the same, and let me know if there are comments, documentation, etc. which should be changed with this. I was not able to find any...
Here are the sample command you can use to test on regtest:
* [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
#### New Features:
* [] I've added tests for the new feature <--- There is no testing suite for this.
* [X] I've added docs for the new feature
* [N/A] I've updated `CHANGELOG.md`
#### Bugfixes:
* [ ] This pull request breaks the existing API
* [ ] I've added tests to reproduce the issue which are now passing
* [ ] I'm linking the issue being fixed by this PR
Mehmet Efe Umit [Wed, 19 Nov 2025 06:18:38 +0000 (22:18 -0800)]
refactor: move broadcast to a helper function
Prior to the Payjoin integration, we need to have the broadcast logic
outside the broadcast command so that it can be shared between the
existing online command and the Payjoin sender.
Mehmet Efe Umit [Wed, 19 Nov 2025 06:14:22 +0000 (22:14 -0800)]
refactor: move sync to a helper function
This is a pre-requisite for adding Payjoin support. When the receiver
sends the Payjoin proposal to the sender to be broadcasted, they need to
sync the blockchain before checking if the Payjoin has indeed been
broadcasted. To do that, the sync function will need to be shared
between the two online commands.
This PR introduces a new `descriptor` subcommand to the BDK CLI that enable users to generate and inspect **Bitcoin wallet descriptors** for internal and external paths, supporting common types (pkh, sh, wpkh, wsh, tr). It includes support for both **single-path** descriptors from extended keys (`xprv`/`xpub` or `tprv`/`tpub`).
This resolves issue https://github.com/bitcoindevkit/bdk-cli/issues/175
## Features Implemented
- Adds new `descriptor` subcommand with:
- `generate` – generate new descriptors
- Supports BIP44, BIP49, BIP84, and BIP86 script types
- Generates **internal and external descriptors**
- Reasonable defaults:
- `--type` defaults to `wsh` and a short `t`
- `--network` default `testnet`
---
## Usage Examples
### 1. Generate Descriptors from an Extended Private Key
```bash
cargo run -- --network testnet descriptor generate --type wsh <XPRV>
```
### 2. Generate Descriptors from a Mnemonic (no key provided)
```bash
cargo run -- --network testnet descriptor generate --type tr
```
* [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
#### New Features:
* [ ] I've added tests for the new feature
* [ ] I've added docs for the new feature
* [ ] I've updated `CHANGELOG.md`
projects / bdk-cli / log