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

[Issue: #192]

Author: tvpeter

Cargo.lock

@@ -20,6 +20,8 @@ log = "0.4"
 serde_json = "1.0"
 thiserror = "2.0.11"
 tokio = { version = "1", features = ["full"] }
+toml = "0.8.23"
+serde= {version = "1.0", features = ["derive"]}
 
 # Optional dependencies
 bdk_bitcoind_rpc = { version = "0.20.0", optional = true }

Cargo.toml

@@ -99,4 +99,31 @@ descriptors private wallet=default_wallet:
 # run any bitcoin-cli rpc command
 [group('rpc')]
 rpc command wallet=default_wallet:
-    bitcoin-cli -datadir={{default_datadir}} -regtest -rpcwallet={{wallet}} -rpcuser={{rpc_user}} -rpcpassword={{rpc_password}} {{command}}
+    bitcoin-cli -datadir={{default_datadir}} -regtest -rpcwallet={{wallet}} -rpcuser={{rpc_user}} -rpcpassword={{rpc_password}} {{command}}
+
+[group('wallet')]
+init wallet_name ext_descriptor int_descriptor client_type url database_type='sqlite' rpc_user='user' rpc_password='password' force='false':
+    mkdir -p {{default_datadir}}
+    # Check if wallet configuration exists
+    if [ "{{force}}" = "false" ] && grep -Fx "[wallets.{{wallet_name}}]" {{default_datadir}}/config.toml > /dev/null; then \
+        echo "Error: Wallet '{{wallet_name}}' already configured in {{default_datadir}}/config.toml. Use --force to overwrite."; \
+        exit 1; \
+    fi
+    # Remove existing configuration if --force is true
+    if [ "{{force}}" = "true" ] && grep -Fx "[wallets.{{wallet_name}}]" {{default_datadir}}/config.toml > /dev/null; then \
+        sed -i.bak '/^\[wallets\.{{wallet_name}}\]/,/^\[/d' {{default_datadir}}/config.toml; \
+        sed -i.bak '/^\[wallets\.{{wallet_name}}\]/d' {{default_datadir}}/config.toml; \
+        rm {{default_datadir}}/config.toml.bak; \
+    fi
+    # Append new configuration
+    echo "" >> {{default_datadir}}/config.toml || touch {{default_datadir}}/config.toml
+    echo "[wallets.{{wallet_name}}]" >> {{default_datadir}}/config.toml
+    echo "name = \"{{wallet_name}}\"" >> {{default_datadir}}/config.toml
+    echo "ext_descriptor = \"{{ext_descriptor}}\"" >> {{default_datadir}}/config.toml
+    echo "int_descriptor = \"{{int_descriptor}}\"" >> {{default_datadir}}/config.toml
+    echo "database_type = \"sqlite\"" >> {{default_datadir}}/config.toml
+    echo "client_type = \"{{client_type}}\"" >> {{default_datadir}}/config.toml
+    echo "server_url = \"{{url}}\"" >> {{default_datadir}}/config.toml
+    echo "rpc_user = \"{{rpc_user}}\"" >> {{default_datadir}}/config.toml
+    echo "rpc_password = \"{{rpc_password}}\"" >> {{default_datadir}}/config.toml
+    echo "Wallet configuration for {{wallet_name}} added to {{default_datadir}}/config.toml"

Justfile

@@ -193,3 +193,70 @@ Note: You can modify the `Justfile` to reflect your nodes' configuration values.
    cargo run --features rpc -- wallet -u "127.0.0.1:18443" -c rpc -a user:password sync
    cargo run --features rpc -- wallet -u "127.0.0.1:18443" -c rpc -a user:password balance
    ```
+
+### Initializing a Wallet with `just`
+
+When using `bdk-cli`, repeatedly specifying parameter values for each command can be tedious. The `just` command allows you to initialize a wallet with configuration values once, saving them for reuse in subsequent `bdk-cli` commands. 
+This eliminate the need to provide repetitive arguments. To set up a wallet with persistent configuration values, use the following just command:
+
+```shell
+just init <wallet_name> <ext_descriptor> <int_descriptor> <database_type> <client_type> <url> <rpc_user> <rpc_password> [--force]
+```
+The arguments must be provided in the order shown above. Replace each placeholder with the corresponding value:
+
+> * `wallet_name`: The unique name for your wallet (e.g., my_wallet)
+> * `ext_descriptor`: The external descriptor for generating receiving addresses (e.g., tr(tprv.../0/*)#checksum)
+> * `int_descriptor`: The internal descriptor for generating change addresses (e.g., tr(tprv.../1/*)#checksum)
+> * `database_type`: The database type for wallet persistence (e.g., sqlite). Defaults to `sqlite` if omitted
+> * `client_type`: The blockchain backend (e.g., electrum, esplora, rpc, cbf)
+> * `url`: The server URL for the blockchain backend (e.g., ssl://mempool.space:60602 for Electrum).
+> * `rpc_user`: The RPC username for rpc client type (e.g., user). Defaults to user if omitted.
+> * `rpc_password`: The RPC password for rpc client type (e.g., password). Defaults to password if omitted.
+> * `--force`: Optional. Overwrites existing configuration for the specified <wallet_name> if set. By default, `just init` fails if the wallet config values already exists.
+
+#### Example
+
+To initialize a wallet named `my_wallet` with `electrum` as the backend:
+
+```shell
+just init my_wallet "tr(tprv8Z.../0/*)#dtdqk3dx" "tr(tprv8Z.../1/*)#ulgptya7" sqlite electrum "ssl://mempool.space:60602" user password
+```
+
+To overwrite an existing wallet configuration:
+
+```shell
+just init-wallet my_wallet "tr(tprv8Z.../0/*)#dtdqk3dx" "tr(tprv8Z.../1/*)#ulgptya7" sqlite electrum "ssl://mempool.space:60602" user password --force
+```
+
+You can omit the following arguments to use their default values:
+
+`database_type`: Defaults to sqlite.
+`rpc_user`: Defaults to user.
+`rpc_password`: Defaults to password.
+
+For example, to initialize a wallet with default database_type, rpc_user, and rpc_password:
+
+```shell
+just init-wallet my_wallet "tr(tprv8Z.../0/*)#dtdqk3dx" "tr(tprv8Z.../1/*)#ulgptya7" electrum "ssl://mempool.space:60602"
+```
+
+#### Using Saved Configuration
+
+After initializing a wallet with `just init`, the configuration is saved in `~/.bdk-bitcoin/config.toml`. You can then run `bdk-cli` wallet commands without specifying the parameters, referencing only the wallet name and network.
+
+With the wallet `my_wallet` initialized, generate a new address and sync the wallet as follow:
+
+```shell
+cargo run --features electrum,sqlite -- -n signet wallet -w my_wallet new_address
+
+cargo run --features electrum,sqlite -- -n signet wallet -w my_wallet sync
+```
+
+#### Notes:
+
+* Each wallet has its own configuration, allowing multiple wallets with different settings (e.g., different descriptors or backends). 
+* You can override saved configuration values for a single command by specifying them explicitly (e.g., `--client-type esplora` or `--url https://mempool.space/signet/api`).
+
+## Minimum Supported Rust Version (MSRV)
+
+This library should always compile with any valid combination of features on Rust **1.75.0**.

README.md

@@ -14,11 +14,14 @@
 
 #![allow(clippy::large_enum_variant)]
 
+use crate::config::WalletConfig;
+use crate::error::BDKCliError as Error;
 use bdk_wallet::bitcoin::{
     Address, Network, OutPoint, ScriptBuf,
     bip32::{DerivationPath, Xpriv},
 };
-use clap::{Args, Parser, Subcommand, ValueEnum, value_parser};
+use clap::{value_parser, Args, Parser, Subcommand, ValueEnum};
+use std::path::Path;
 
 #[cfg(any(feature = "electrum", feature = "esplora", feature = "rpc"))]
 use crate::utils::parse_proxy_auth;
@@ -167,15 +170,21 @@ pub struct WalletOpts {
         feature = "rpc",
         feature = "cbf"
     ))]
-    #[arg(env = "CLIENT_TYPE", short = 'c', long, value_enum, required = true)]
-    pub client_type: ClientType,
+    #[arg(env = "CLIENT_TYPE", short = 'c', long, value_enum)]
+    pub client_type: Option<ClientType>,
     #[cfg(feature = "sqlite")]
-    #[arg(env = "DATABASE_TYPE", short = 'd', long, value_enum, required = true)]
-    pub database_type: DatabaseType,
+    #[arg(
+        env = "DATABASE_TYPE",
+        short = 'd',
+        long,
+        value_enum,
+        default_value = "sqlite"
+    )]
+    pub database_type: Option<DatabaseType>,
     /// Sets the server url.
     #[cfg(any(feature = "electrum", feature = "esplora", feature = "rpc"))]
-    #[arg(env = "SERVER_URL", short = 'u', long, required = true)]
-    pub url: String,
+    #[arg(env = "SERVER_URL", short = 'u', long)]
+    pub url: Option<String>,
     /// Electrum batch size.
     #[cfg(feature = "electrum")]
     #[arg(env = "ELECTRUM_BATCH_SIZE", short = 'b', long, default_value = "10")]
@@ -198,7 +207,7 @@ pub struct WalletOpts {
         value_parser = parse_proxy_auth,
         default_value = "user:password",
     )]
-    pub basic_auth: (String, String),
+    pub basic_auth: Option<(String, String)>,
     #[cfg(feature = "rpc")]
     /// Sets an optional cookie authentication.
     #[arg(env = "COOKIE")]
@@ -208,6 +217,64 @@ pub struct WalletOpts {
     pub compactfilter_opts: CompactFilterOpts,
 }
 
+impl WalletOpts {
+    /// Load configuration from TOML file and merge with CLI options
+    pub fn load_config(&mut self, wallet_name: &str, datadir: &Path) -> Result<(), Error> {
+        if let Some(config) = WalletConfig::load(datadir)? {
+            if let Ok(config_opts) = config.get_wallet_opts(wallet_name) {
+                self.wallet = self.wallet.take().or(config_opts.wallet);
+                self.verbose = self.verbose || config_opts.verbose;
+                self.ext_descriptor = self.ext_descriptor.take().or(config_opts.ext_descriptor);
+                self.int_descriptor = self.int_descriptor.take().or(config_opts.int_descriptor);
+                #[cfg(any(
+                    feature = "electrum",
+                    feature = "esplora",
+                    feature = "rpc",
+                    feature = "cbf"
+                ))]
+                {
+                    self.client_type = self.client_type.clone().or(config_opts.client_type);
+                }
+                #[cfg(feature = "sqlite")]
+                {
+                    // prioritizing the config.toml value for database type as it has a default value
+                    self.database_type = config_opts.database_type.or(self.database_type.clone());
+                }
+                #[cfg(any(feature = "electrum", feature = "esplora", feature = "rpc"))]
+                {
+                    self.url = self.url.take().or(config_opts.url);
+                }
+                #[cfg(feature = "electrum")]
+                {
+                    self.batch_size = if self.batch_size != 10 {
+                        config_opts.batch_size
+                    } else {
+                        self.batch_size
+                    };
+                }
+                #[cfg(feature = "esplora")]
+                {
+                    self.parallel_requests = if self.parallel_requests != 5 {
+                        config_opts.parallel_requests
+                    } else {
+                        self.parallel_requests
+                    };
+                }
+                #[cfg(feature = "rpc")]
+                {
+                    self.basic_auth = self.basic_auth.take().or(config_opts.basic_auth);
+                    self.cookie = self.cookie.take().or(config_opts.cookie);
+                }
+                #[cfg(feature = "cbf")]
+                {
+                    self.compactfilter_opts = config_opts.compactfilter_opts;
+                }
+            }
+        }
+        Ok(())
+    }
+}
+
 /// Options to configure a SOCKS5 proxy for a blockchain client connection.
 #[cfg(any(feature = "electrum", feature = "esplora"))]
 #[derive(Debug, Args, Clone, PartialEq, Eq)]