Add saving wallet config with `bdk-cli wallet config` #203

tvpeter · 2025-06-18T20:39:31Z

Description

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

Changelog notice

Add wallet subcommand config to save wallet configs
Add top-level wallets command to show all saved wallet configs

Checklists

Features

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>
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...
Repl uses the same wallet configs: repl [-w <name>]
command to list all saved wallet configs: wallets
throw warnings if using mainnet and saving a private descriptor in a config.

All Submissions:

I've signed all my commits
I followed the contribution guidelines
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

coveralls · 2025-06-18T20:41:57Z

Pull Request Test Coverage Report for Build 18853801376

Details

0 of 310 (0.0%) changed or added relevant lines in 3 files are covered.
1 unchanged line in 1 file lost coverage.
Overall coverage decreased (-1.5%) to 7.277%

Changes Missing Coverage	Changed/Added Lines	%
src/utils.rs	43	0.0%
src/config.rs	67	0.0%
src/handlers.rs	200	0.0%

Files with Coverage Reduction	New Missed Lines	%
src/handlers.rs	1	9.26%

Totals
Change from base Build 18520893551:	-1.5%
Covered Lines:	105
Relevant Lines:	1443

💛 - Coveralls

notmandatory · 2025-06-24T19:55:48Z

I like the approach for loading the config file parameters if the file exists, but is there a reason you didn't add a CLI bdk-cli wallet init ... command in rust to create the config file rather than using just ?

Creating the config file in rust should be easier to maintain/keep in sync than your just approach and shouldn't take too much more than adding the Serialize trait to WalletConfigInner. You should be able to reuse the WalletOpts to capture the values with clap that you need to put in the config file too.

tvpeter · 2025-06-24T20:11:06Z

I like the approach for loading the config file parameters if the file exists, but is there a reason you didn't add a CLI bdk-cli wallet init ... command in rust to create the config file rather than using just ?

Creating the config file in rust should be easier to maintain/keep in sync than your just approach and shouldn't take too much more than adding the Serialize trait to WalletConfigInner. You should be able to reuse the WalletOpts to capture the values with clap that you need to put in the config file too.

Alright, I will update.

tvpeter · 2025-06-27T11:18:13Z

Alright, I will update.

@notmandatory I have updated the PR

thunderbiscuit · 2025-09-03T15:00:11Z

I need to start keeping track of all these awesome new features I honestly see the PRs come in and can't keep up. This is super cool.

tvpeter · 2025-09-03T15:01:46Z

I need to start keeping track of all these awesome new features I honestly see the PRs come in and can't keep up. This is super cool.

Thank you @thunderbiscuit

notmandatory · 2025-09-06T04:16:04Z

I spent some time today reviewing and even though this looks like a workable way to do it and is based on my suggestion I'm afraid it's going to be a hassle to maintain. I've been experimenting with somehow using the different clap parsing functions (https://docs.rs/clap/latest/clap/trait.Parser.html) but so far haven't figured out a better way. I'd like to keep thinking about it. We might have to simplify the problem somehow such as by not trying to merge loaded and CLI args.

tvpeter · 2025-09-06T04:51:34Z

I'm afraid it's going to be a hassle to maintain. I've been experimenting with somehow using the different clap parsing functions (https://docs.rs/clap/latest/clap/trait.Parser.html) but so far haven't figured out a better way. I'd like to keep thinking about it. We might have to simplify the problem somehow such as by not trying to merge loaded and CLI args.

Thank you @notmandatory.
Yes, I agree that it will be challenging to maintain, as it involves two steps (pre clap parsing and after parsing) and even more difficult as they are in different locations in the codebase. I thought about moving everything to pre clap parsing based on the wallet sub-command the user has entered but that will clog the entry point as there will be lots of if...else checks.

Also, for the Parser trait, I read that it does not allow interacting with an external resource such as reading a file as I would want it.

I will also be trying out other approaches in case there is a cleaner way to handle it.

notmandatory · 2025-09-06T20:32:12Z

How about something like:

One 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>
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...
Repl uses the same wallet configs:
repl [-w <name>]
Add a command to list all available config names with summary of configured options:
wallet list
Should throw warnings if using mainnet and saving a private descriptor in a config.

tvpeter · 2025-10-04T05:55:42Z

How about something like:

One 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>

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...

Repl uses the same wallet configs:
repl [-w <name>]

Add a command to list all available config names with summary of configured options:
wallet list

Should throw warnings if using mainnet and saving a private descriptor in a config.

Hi @notmandatory, there is an issues that we did not envisage and discuss on this PR that came up during implementation:
The wallet [-w <name>] config <wallet opts> command introduced a wallet name parameter that has to be supplied whenever the wallet command is used. This means that the list subcommand that should not require a wallet name has to accept the wallet name. If we make the wallet name optional above, we will have to do manual validation for the name.

notmandatory · 2025-10-04T12:27:07Z

Good point. Yes I agree a new top level command makes sense to list the wallets. Either "wallets" as you suggest or "list" makes sense to me.

- 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: bitcoindevkit#192]

- rename init to config and move walletopts as config options

notmandatory

I found an error when testing with testnet4, and a couple small nits should be fixed too. Otherwise this looks good.

In the future if everyone prefers the config approach it should probably become the only way to use the wallet features.

notmandatory · 2025-10-27T16:30:49Z

README.md

+
+
+```shell
+cargo run --features electrum wallet -w my_wallet  new_address


⛏️ nit, has extra space:

Suggested change

cargo run --features electrum wallet -w my_wallet new_address

cargo run --features electrum wallet -w my_wallet new_address

notmandatory · 2025-10-27T16:31:46Z

src/commands.rs

-    #[arg(env = "WALLET_NAME", short = 'w', long = "wallet")]
+    #[arg(skip)]
    pub wallet: Option<String>,
+    // #[arg(env = "WALLET_NAME", short = 'w', long = "wallet", required = true)]


Commented out line should be removed.

Suggested change

// #[arg(env = "WALLET_NAME", short = 'w', long = "wallet", required = true)]

notmandatory · 2025-10-27T18:51:24Z

src/utils.rs

+        "bitcoin" => Ok(Network::Bitcoin),
+        "testnet" => Ok(Network::Testnet),
+        "regtest" => Ok(Network::Regtest),
+        "signet" => Ok(Network::Signet),


🔨 need to add Testnet4:

Suggested change

"signet" => Ok(Network::Signet),

"signet" => Ok(Network::Signet),

"testnet4" => Ok(Network::Testnet4),

- add wallets command - add warning for using priv descriptors - update readme - add loading network from config - fix review comments

tvpeter · 2025-10-27T20:01:28Z

I found an error when testing with testnet4, and a couple small nits should be fixed too. Otherwise this looks good.

Thank you for catching all these.
I have updated.

In the future if everyone prefers the config approach it should probably become the only way to use the wallet features.

Yes, I agree.

github-project-automation bot added this to BDK-CLI Jun 18, 2025

tvpeter force-pushed the feat/init-wallet-support branch from 9e56084 to b3966e3 Compare June 18, 2025 20:41

tvpeter force-pushed the feat/init-wallet-support branch from b3966e3 to bf14df8 Compare June 19, 2025 04:32

tvpeter requested a review from notmandatory June 19, 2025 04:33

notmandatory assigned tvpeter Jun 24, 2025

notmandatory moved this to Ready to Review in BDK-CLI Jun 24, 2025

notmandatory added this to the CLI 1.1.0 milestone Jun 24, 2025

notmandatory added the enhancement New feature or request label Jun 24, 2025

tvpeter force-pushed the feat/init-wallet-support branch from bf14df8 to 36ee973 Compare June 27, 2025 04:04

tvpeter changed the title ~~Add initializing wallet configuration with Justfile~~ Add initializing wallet configuration with bdk-cli wallet init Jun 27, 2025

tvpeter force-pushed the feat/init-wallet-support branch 4 times, most recently from 5125cf8 to fcf7ce8 Compare June 27, 2025 10:03

tvpeter mentioned this pull request Aug 1, 2025

Consider enabling a config file for each wallet #209

Closed

tvpeter force-pushed the feat/init-wallet-support branch 2 times, most recently from f77b1da to 70a5390 Compare August 25, 2025 19:26

tvpeter force-pushed the feat/init-wallet-support branch 2 times, most recently from 9461e85 to 5d9feb0 Compare September 1, 2025 04:20

tvpeter force-pushed the feat/init-wallet-support branch 2 times, most recently from 9549e09 to 0f6b320 Compare September 3, 2025 15:45

notmandatory mentioned this pull request Sep 8, 2025

Socratic Seminar #35 Topics NashBitDevs/nashbitdevs.org#105

Closed

tvpeter force-pushed the feat/init-wallet-support branch from 0f6b320 to 30fa3a0 Compare October 4, 2025 01:45

tvpeter force-pushed the feat/init-wallet-support branch 2 times, most recently from 512b4b5 to ea0315c Compare October 4, 2025 09:18

tvpeter changed the title ~~Add initializing wallet configuration with bdk-cli wallet init~~ Add initializing wallet configuration with bdk-cli wallet config Oct 4, 2025

tvpeter changed the title ~~Add initializing wallet configuration with bdk-cli wallet config~~ Add saving wallet config with bdk-cli wallet config Oct 4, 2025

tvpeter force-pushed the feat/init-wallet-support branch 3 times, most recently from 7cd062b to 28796ca Compare October 5, 2025 03:50

tvpeter added 2 commits October 15, 2025 14:08

feat(init-wallet): rename init & add walletopts

424b9f5

- rename init to config and move walletopts as config options

tvpeter force-pushed the feat/init-wallet-support branch 2 times, most recently from 77864b4 to c5c4fdb Compare October 15, 2025 13:17

notmandatory requested changes Oct 27, 2025

View reviewed changes

feat(wallet-init): add wallets command

7be9a30

- add wallets command - add warning for using priv descriptors - update readme - add loading network from config - fix review comments

tvpeter force-pushed the feat/init-wallet-support branch from c5c4fdb to 7be9a30 Compare October 27, 2025 19:41



		```shell
		cargo run --features electrum wallet -w my_wallet new_address

	"signet" => Ok(Network::Signet),
	"signet" => Ok(Network::Signet),
	"testnet4" => Ok(Network::Testnet4),

Uh oh!

Add saving wallet config with bdk-cli wallet config #203

Are you sure you want to change the base?

Add saving wallet config with bdk-cli wallet config #203

Uh oh!

Conversation

tvpeter commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Notes to the reviewers

Changelog notice

Checklists

Features

All Submissions:

New Features:

Uh oh!

coveralls commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 18853801376

Details

💛 - Coveralls

Uh oh!

notmandatory commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tvpeter commented Jun 24, 2025

Uh oh!

tvpeter commented Jun 27, 2025

Uh oh!

thunderbiscuit commented Sep 3, 2025

Uh oh!

tvpeter commented Sep 3, 2025

Uh oh!

notmandatory commented Sep 6, 2025

Uh oh!

tvpeter commented Sep 6, 2025

Uh oh!

notmandatory commented Sep 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tvpeter commented Oct 4, 2025

Uh oh!

notmandatory commented Oct 4, 2025

Uh oh!

notmandatory left a comment

Choose a reason for hiding this comment

Uh oh!

notmandatory Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

notmandatory Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

notmandatory Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

tvpeter commented Oct 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Add saving wallet config with `bdk-cli wallet config` #203

Add saving wallet config with `bdk-cli wallet config` #203

tvpeter commented Jun 18, 2025 •

edited

Loading

coveralls commented Jun 18, 2025 •

edited

Loading

notmandatory commented Jun 24, 2025 •

edited

Loading

notmandatory commented Sep 6, 2025 •

edited

Loading