feat: add completions subcommand

CHANGELOG.md

@@ -6,11 +6,12 @@ page. See [DEVELOPMENT_CYCLE.md](DEVELOPMENT_CYCLE.md) for more details.
 ## [Unreleased]
 - Add wallet subcommand `config` to save wallet configs
 - Add `wallets` command to list all wallets saved configs
+- Added `completions` subcommand to generate shell completions
 
 ## [2.0.0]
 
 - Removed MSRV and bumped Rust Edition to 2024
-- Add `--pretty` flag for formatting outputs in human-readable form
+- Added `--pretty` flag for formatting outputs in human-readable form
 - Updated `bdk_wallet ` to  `2.1.0`,  `bdk_bitcoind_rpc` to `0.21.0`, `bdk_esplora` to `0.22.1`, `bdk_kyoto` to `0.13.1` 
 - Updated `tracing-subscriber` to 0.3.20
 - Added `tr` script type to `compile` command to support creating taproot descriptors

Cargo.toml

@@ -14,6 +14,7 @@ license = "MIT"
 [dependencies]
 bdk_wallet = { version = "2.1.0", features = ["rusqlite", "keys-bip39", "compiler", "std"] }
 clap = { version = "4.5", features = ["derive","env"] }
+clap_complete = "4.5"
 dirs = {  version = "6.0.0" }
 env_logger = "0.11.6"
 log = "0.4"

README.md

@@ -228,6 +228,14 @@ cargo run -- --pretty -n signet wallet -w {wallet_name} balance
 ```
 This is available for wallet, key, repl and compile features. When ommitted, outputs default to `JSON`.
 
+## Shell Completions
+
+`bdk-cli` supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell. For setup instructions, run:
+
+```shell
+bdk-cli completions --help
+```
+
 ## Saving and using wallet configurations
 
 The `wallet config` sub-command allows you to save wallet settings to a `config.toml` file in the default directory (`~/.bdk-bitcoin/`) or custom directory specified with the `--datadir` flag. This eliminate the need to repeatedly specify descriptors, client types, and other parameters for each command. Once configured, you can use any wallet command by simply specifying the wallet name. All other parameters are automatically loaded from the saved configuration.

src/commands.rs

@@ -18,6 +18,7 @@ use bdk_wallet::bitcoin::{
     bip32::{DerivationPath, Xpriv},
 };
 use clap::{Args, Parser, Subcommand, ValueEnum, value_parser};
+use clap_complete::Shell;
 
 #[cfg(any(feature = "electrum", feature = "esplora", feature = "rpc"))]
 use crate::utils::parse_proxy_auth;
@@ -127,7 +128,62 @@ pub enum CliSubCommand {
     },
     /// List all saved wallet configurations.
     Wallets,
+    /// Generate tab-completion scripts for your shell.
+    ///
+    /// The completion script is output on stdout, allowing you to redirect
+    /// it to a file of your choosing. Where you place the file will depend
+    /// on your shell and operating system.
+    ///
+    /// Here are common setups for supported shells:
+    ///
+    /// Bash:
+    ///
+    ///     Completion files are commonly stored in
+    ///     `~/.local/share/bash-completion/completions` for user-specific commands.
+    ///     Run the commands:
+    ///
+    ///         $ mkdir -p ~/.local/share/bash-completion/completions
+    ///         $ bdk-cli completions bash > ~/.local/share/bash-completion/completions/bdk-cli
+    ///
+    /// Zsh:
+    ///
+    ///     Completion files are commonly stored in a directory listed in your `fpath`.
+    ///     Run the commands:
+    ///
+    ///         $ mkdir -p ~/.zfunc
+    ///         $ bdk-cli completions zsh > ~/.zfunc/_bdk-cli
+    ///
+    ///     Make sure `~/.zfunc` is in your fpath by adding to your `.zshrc`:
+    ///
+    ///         fpath=(~/.zfunc $fpath)
+    ///         autoload -Uz compinit && compinit
+    ///
+    /// Fish:
+    ///
+    ///     Completion files are commonly stored in
+    ///     `~/.config/fish/completions`. Run the commands:
+    ///
+    ///         $ mkdir -p ~/.config/fish/completions
+    ///         $ bdk-cli completions fish > ~/.config/fish/completions/bdk-cli.fish
+    ///
+    /// PowerShell:
+    ///
+    ///         $ bdk-cli completions powershell >> $PROFILE
+    ///
+    /// Elvish:
+    ///
+    ///         $ bdk-cli completions elvish >> ~/.elvish/rc.elv
+    ///
+    /// After installing the completion script, restart your shell or source
+    /// the configuration file for the changes to take effect.
+    #[command(verbatim_doc_comment)]
+    Completions {
+        /// Target shell syntax
+        #[arg(value_enum)]
+        shell: Shell,
+    },
 }
+
 /// Wallet operation subcommands.
 #[derive(Debug, Subcommand, Clone, PartialEq)]
 pub enum WalletSubCommand {

src/error.rs

@@ -63,7 +63,7 @@ pub enum BDKCliError {
 
     #[cfg(feature = "redb")]
     #[error("Redb StoreError: {0}")]
-    RedbStoreError(#[from] bdk_redb::error::StoreError),
+    RedbStoreError(Box<bdk_redb::error::StoreError>),
 
     #[cfg(feature = "redb")]
     #[error("Redb dabtabase error: {0}")]
@@ -119,3 +119,10 @@ impl From<ExtractTxError> for BDKCliError {
         BDKCliError::PsbtExtractTxError(Box::new(value))
     }
 }
+
+#[cfg(feature = "redb")]
+impl From<bdk_redb::error::StoreError> for BDKCliError {
+    fn from(err: bdk_redb::error::StoreError) -> Self {
+        BDKCliError::RedbStoreError(Box::new(err))
+    }
+}

src/handlers.rs

@@ -44,6 +44,7 @@ use bdk_wallet::{
     descriptor::{Descriptor, Legacy, Miniscript},
     miniscript::{Tap, descriptor::TapTree, policy::Concrete},
 };
+use clap::CommandFactory;
 use cli_table::{Cell, CellStruct, Style, Table, format::Justify};
 use serde_json::json;
 #[cfg(feature = "cbf")]
@@ -1422,6 +1423,16 @@ pub(crate) async fn handle_command(cli_opts: CliOpts) -> Result<String, Error> {
             let descriptor = handle_descriptor_command(cli_opts.network, desc_type, key, pretty)?;
             Ok(descriptor)
         }
+        CliSubCommand::Completions { shell } => {
+            clap_complete::generate(
+                shell,
+                &mut CliOpts::command(),
+                "bdk-cli",
+                &mut std::io::stdout(),
+            );
+
+            Ok("".to_string())
+        }
     };
     result
 }

src/payjoin/mod.rs

@@ -75,7 +75,7 @@ impl<'a> PayjoinManager<'a> {
         let persister = payjoin::persist::NoopSessionPersister::<ReceiverSessionEvent>::default();
 
         let checked_max_fee_rate = max_fee_rate
-            .map(|rate| FeeRate::from_sat_per_kwu(rate))
+            .map(FeeRate::from_sat_per_kwu)
             .unwrap_or(FeeRate::BROADCAST_MIN);
 
         let receiver = payjoin::receive::v2::ReceiverBuilder::new(
@@ -296,7 +296,7 @@ impl<'a> PayjoinManager<'a> {
                     .await
             }
             ReceiveSession::HasReplyableError(error) => self.handle_error(error, persister).await,
-            ReceiveSession::Closed(_) => return Err(Error::Generic("Session closed".to_string())),
+            ReceiveSession::Closed(_) => Err(Error::Generic("Session closed".to_string())),
         }
     }
 
@@ -334,7 +334,7 @@ impl<'a> PayjoinManager<'a> {
                 Err(e) => {
                     return Err(Error::Generic(format!(
                         "Error occurred when polling for Payjoin proposal from the directory: {}",
-                        e.to_string()
+                        e
                     )));
                 }
             }
@@ -637,16 +637,15 @@ impl<'a> PayjoinManager<'a> {
                         return Err(ImplementationError::from("Cannot find the transaction in the mempool or the blockchain"));
                     };
 
-                    let is_seen = match tx_details.chain_position {
-                        bdk_wallet::chain::ChainPosition::Confirmed { .. } => true,
-                        bdk_wallet::chain::ChainPosition::Unconfirmed { first_seen: Some(_), .. } => true,
-                        _ => false
-                    };
+                    let is_seen = matches!(
+                        tx_details.chain_position, bdk_wallet::chain::ChainPosition::Confirmed { .. }
+                        | bdk_wallet::chain::ChainPosition::Unconfirmed { first_seen: Some(_), .. }
+                    );
 
                     if is_seen {
                         return Ok(Some(tx_details.tx.as_ref().clone()));
                     }
-                    return Err(ImplementationError::from("Cannot find the transaction in the mempool or the blockchain"));
+                    Err(ImplementationError::from("Cannot find the transaction in the mempool or the blockchain"))
                 },
                 |outpoint| {
                     let utxo = self.wallet.get_utxo(outpoint);

src/utils.rs

@@ -187,7 +187,7 @@ pub(crate) fn new_blockchain_client(
         }
         #[cfg(feature = "esplora")]
         ClientType::Esplora => {
-            let client = bdk_esplora::esplora_client::Builder::new(&url).build_async()?;
+            let client = bdk_esplora::esplora_client::Builder::new(url).build_async()?;
             BlockchainClient::Esplora {
                 client: Box::new(client),
                 parallel_requests: wallet_opts.parallel_requests,