Re-organize wallet sub-commands and add `key` sub-commands #14

notmandatory · 2021-02-03T07:18:43Z

Description

Depends on bitcoindevkit/bdk#274

Added in Lib

CliOpts struct and CliSubCommand enum representing top level cli options and commands
KeySubCommand enum
handle_key_subcommand function

Changed in Lib

Renamed WalletOpt struct to WalletOpts
WalletSubCommand enum split into OfflineWalletSubCommand and OnlineWalletSubCommand
Split handle_wallet_subcommand into two functions, handle_offline_wallet_subcommand and handle_online_wallet_subcommand
A wallet without a Blockchain is used when handling offline wallet sub-commands

Added in bdk-cli

Top level commands "wallet", "key", and "repl"
"key" command has sub-commands to "generate" and "restore" a master extended key
"repl" command now has an "exit" sub-command, fixes Add subcommand to break out of the repl #12

Changed in bdk-cli

"wallet" sub-commands and options must be proceeded by "wallet" command
"repl" command loop now includes both "wallet" and "key" sub-commands

Notes to the reviewers

There's a little bug in the help / about info while in REPL mode. ~~I don't think there's a way to work around it but there is a structopt issue for it.~~ I found a workaround for this issue.

Checklists

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

…ubcommand

…and handle_online_wallet_subcommand, Add KeySubCommand and handle_key_subcommand

… commands

thunderbiscuit · 2021-02-04T15:15:40Z

ACK.

I have tested this locally and everything works well! I have not reviewed the code, however.

notmandatory · 2021-02-05T01:07:44Z

I added a small change to bdk_cli.rs to remove the unneeded ReplOpt struct.

afilini · 2021-02-08T14:35:04Z

Reviewing it now :)

src/bdk_cli.rs

afilini · 2021-02-08T15:46:30Z

src/bdk_cli.rs

-                        let repl_subcommand: Result<ReplOpt, clap::Error> =
-                            ReplOpt::from_iter_safe(split_line);
+                        let split_line: Vec<&str> =
+                            split_regex.find_iter(&line).map(|m| m.as_str()).collect();


... then here you can iterate over the captured groups and remove the quotes at the same time:

Suggested change

split_regex.find_iter(&line).map(|m| m.as_str()).collect();

split_regex.captures_iter(&line).map(|c| c.get(1).or(c.get(2)).unwrap().as_str()).collect();

The c.get(1).or(c.get(2)) is necessary because sometimes it's the first capture group that matches and sometimes the second, but since there are only two of them you can safely unwrap() later because either one or the other always matches.

oh cool, I'll give it a try!

yes this is much better, I also added the capture group you suggested for single quotes, and fixed it so the double quote and single quote capture groups can take non-alphanumeric characters (other than " or ')

afilini · 2021-02-08T15:52:04Z

src/lib.rs

+///                     #[cfg(feature = "electrum")]
+///                     proxy: None,
+///                     #[cfg(feature = "electrum")]
+///                     retries: 5,
+///                     #[cfg(feature = "electrum")]
+///                     timeout: None,
+///                     #[cfg(feature = "electrum")]
+///                     electrum: "ssl://electrum.blockstream.info:60002".to_string(),
+///                     #[cfg(feature = "esplora")]
+///                     esplora: None,
+///                     #[cfg(feature = "esplora")]
+///                     esplora_concurrency: 4,


Maybe you could add another enum called ElectrumOpts/EsploraOpts and then use #[structopt(flatten)]? I think it would keep the same "public" interface, but internally it would be a bit more organized

Yes good call, much cleaner this way. I originally had these two structs but took them out when I was trouble shooting some structopt help issues. Back in now.

afilini · 2021-02-08T16:14:12Z

src/lib.rs

+pub fn handle_offline_wallet_subcommand<D>(
+    wallet: &Wallet<(), D>,


You could change this to take a generic type T instead of just (), which would allow you to call this with a ref to an online wallet

Suggested change

pub fn handle_offline_wallet_subcommand<D>(

wallet: &Wallet<(), D>,

pub fn handle_offline_wallet_subcommand<T, D>(

wallet: &Wallet<T, D>,

afilini · 2021-02-08T16:14:56Z

src/bdk_cli.rs

+            let offline_wallet = new_offline_wallet(network, &wallet_opts, database).unwrap();
+            let offline_wallet = Arc::new(offline_wallet);


... then you could remove this and just use the online_wallet everywhere

I added the generic type to allow handle_offline_wallet_subcommand to accept an online wallet and works great, removed the offline_wallet for REPL mode.

I'm going to keep the offline_wallet for the offline commands when not in REPL mode. My goal is to eventually make offline, online, and repl optional cargo features. So someone could make a bdk-cli build to only do offline CLI commands. Or maybe only offline via CLI or REPL, etc.

Yes, sounds good!

afilini · 2021-02-08T16:18:45Z

src/bdk_cli.rs

+                        let result = match repl_subcommand {
+                            ReplSubCommand::OnlineWalletSubCommand(online_subcommand) => {
+                                bdk_cli::handle_online_wallet_subcommand(
+                                    &Arc::clone(&online_wallet),


I think you could just use &online_wallet here and in all the other places

Actually, I think you could remove the Arc stuff entirely.. I don't think we are using them anymore, we are just passing normal references around

I removed the Arc and it works fine.

afilini · 2021-02-08T16:23:15Z

Cargo.toml

@@ -12,8 +12,8 @@ readme = "README.md"
 license = "MIT"

 [dependencies]
-bdk = { version = "^0.3", default-features = false }
-bdk-macros = "^0.2"
+bdk = { git = "https://github.com/bitcoindevkit/bdk.git", rev = "c4f2179", features = ["all-keys"]}


Needs default-features = false, otherwise it'll include electrum by default which can't be compiled under wasm32

Fixed. Had to tweek docs tests a bit but should all work now.

src/lib.rs

notmandatory added 8 commits February 2, 2021 23:09

Add regex dependency, remove esplora from default feature

2f5f766

Add CliOpts, CliSubCommand, WalletSubCommand, WalletOpts

5cd79bd

Split WalletSubCommand into OfflineWalletSubCommand and OnlineWalletS…

df6e081

…ubcommand

Split handle_wallet_subcommand into handle_offline_wallet_subcommand …

ca8ea93

…and handle_online_wallet_subcommand, Add KeySubCommand and handle_key_subcommand

Update tests

51a2f42

Add ReplOpt and ReplSubCommand

0ed2219

Create online and offline wallets, use regex to split and filter repl…

0d3e641

… commands

Update CHANGELOG

6601ed4

notmandatory added the enhancement New feature or request label Feb 3, 2021

notmandatory changed the title ~~Feat/key cmds~~ Re-organize wallet sub-commands and add key sub-commands Feb 3, 2021

notmandatory added 2 commits February 3, 2021 10:55

Update to current bdk rev with new 'DerivableKey' and 'TxBuilder' APIs

0bed7e9

Add key subcommand tests

a64086e

notmandatory force-pushed the feat/key_cmds branch from e92fcaa to 9a2c4c2 Compare February 3, 2021 23:11

Cleanup cli help messages

adbc3b6

notmandatory force-pushed the feat/key_cmds branch from 9a2c4c2 to adbc3b6 Compare February 3, 2021 23:12

Update README.md

616f180

notmandatory marked this pull request as ready for review February 4, 2021 07:03

Remove ReplOpt

503095c

Add workaround for 'structopt' about issue

c96bf2a

notmandatory force-pushed the feat/key_cmds branch 2 times, most recently from 2b67326 to e64696d Compare February 6, 2021 18:14

Update to latest 'bdk' commit

1cec709

notmandatory force-pushed the feat/key_cmds branch from e64696d to 1cec709 Compare February 6, 2021 21:51

afilini reviewed Feb 8, 2021

View reviewed changes

src/bdk_cli.rs Outdated Show resolved Hide resolved

afilini requested changes Feb 8, 2021

View reviewed changes

notmandatory force-pushed the feat/key_cmds branch from 16f80cb to 7ab78fd Compare February 8, 2021 21:57

Simplify repl line parsing regex

dc00b80

notmandatory force-pushed the feat/key_cmds branch from 7ab78fd to dc00b80 Compare February 8, 2021 22:15

notmandatory added 2 commits February 8, 2021 19:22

Add ElectrumOpts and EsploraOpts structops; set no default dependencies

3211af0

Update handle offline fn and repl to work with online wallets

9fb50b1

afilini approved these changes Feb 10, 2021

View reviewed changes

afilini merged commit 9fb50b1 into bitcoindevkit:master Feb 10, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Re-organize wallet sub-commands and add `key` sub-commands #14

Re-organize wallet sub-commands and add `key` sub-commands #14

notmandatory commented Feb 3, 2021 •

edited

thunderbiscuit commented Feb 4, 2021

notmandatory commented Feb 5, 2021

afilini commented Feb 8, 2021

afilini Feb 8, 2021

notmandatory Feb 8, 2021

notmandatory Feb 8, 2021

afilini Feb 8, 2021

notmandatory Feb 9, 2021

afilini Feb 8, 2021

afilini Feb 8, 2021

notmandatory Feb 9, 2021

afilini Feb 10, 2021

afilini Feb 8, 2021

afilini Feb 8, 2021

notmandatory Feb 9, 2021

afilini Feb 8, 2021

notmandatory Feb 9, 2021

	split_regex.find_iter(&line).map(\|m\| m.as_str()).collect();
	split_regex.captures_iter(&line).map(\|c\| c.get(1).or(c.get(2)).unwrap().as_str()).collect();

		pub fn handle_offline_wallet_subcommand<D>(
		wallet: &Wallet<(), D>,

		let offline_wallet = new_offline_wallet(network, &wallet_opts, database).unwrap();
		let offline_wallet = Arc::new(offline_wallet);

Re-organize wallet sub-commands and add key sub-commands #14

Re-organize wallet sub-commands and add key sub-commands #14

Conversation

notmandatory commented Feb 3, 2021 • edited

Description

Notes to the reviewers

Checklists

All Submissions:

New Features:

thunderbiscuit commented Feb 4, 2021

notmandatory commented Feb 5, 2021

afilini commented Feb 8, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Re-organize wallet sub-commands and add `key` sub-commands #14

Re-organize wallet sub-commands and add `key` sub-commands #14

notmandatory commented Feb 3, 2021 •

edited