[DRAFT] Implement Ledger Support

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
     "rust-analyzer.diagnostics.disabled": [
         "unresolved-macro-call"
-    ]
+    ],
+    "rust-analyzer.cargo.features": "all"
 }

libtonode-tests/Cargo.toml

@@ -6,6 +6,7 @@ edition = "2021"
 [features]
 chain_generic_tests = []
 ci = ["zingolib/ci"]
+ledger-support = []
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [dependencies]

libtonode-tests/tests/concrete.rs

@@ -1290,6 +1290,8 @@ mod slow {
             Some(client_builder.zingo_datadir),
             ChainType::Regtest(regtest_network),
             true,
+            #[cfg(feature = "ledger-support")]
+            false,
         )
         .unwrap();
 

libtonode-tests/tests/sync.rs

@@ -26,6 +26,8 @@ async fn sync_mainnet_test() {
         Some(temp_path),
         zingolib::config::ChainType::Mainnet,
         true,
+        #[cfg(feature = "ledger-support")]
+        false,
     )
     .unwrap();
     let mut lightclient = LightClient::create_from_wallet_base_async(

zingocli/Cargo.toml

@@ -15,3 +15,6 @@ rustyline = { workspace = true }
 shellwords = { workspace = true }
 
 rustls.workspace = true
+
+[features]
+ledger-support = []

zingocli/src/lib.rs

@@ -20,60 +20,63 @@ pub mod version;
 
 /// TODO: Add Doc Comment Here!
 pub fn build_clap_app() -> clap::ArgMatches {
-    clap::Command::new("Zingo CLI").version(version::VERSION)
-            .arg(Arg::new("nosync")
-                .help("By default, zingo-cli will sync the wallet at startup. Pass --nosync to prevent the automatic sync at startup.")
-                .long("nosync")
-                .short('n')
-                .action(clap::ArgAction::SetTrue))
-            .arg(Arg::new("regtest")
-                .long("regtest")
-                .help("Regtest mode")
-                .action(clap::ArgAction::SetTrue) )
-            .arg(Arg::new("no-clean")
-                .long("no-clean")
-                .help("Don't clean regtest state before running. Regtest mode only")
-                .action(clap::ArgAction::SetTrue))
-            .arg(Arg::new("chain")
-                .long("chain").short('c')
-                .help(r#"What chain to expect, if it's not inferable from the server URI. One of "mainnet", "testnet", or "regtest""#))
-            .arg(Arg::new("seed")
-                .short('s')
-                .long("seed")
-                .value_name("SEED PHRASE")
-                .value_parser(parse_seed)
-                .help("Create a new wallet with the given 24-word seed phrase. Will fail if wallet already exists"))
-            .arg(Arg::new("viewkey")
-                .long("viewkey")
-                .value_name("UFVK")
-                .value_parser(parse_ufvk)
-                .help("Create a new wallet with the given encoded unified full viewing key. Will fail if wallet already exists"))
-            .arg(Arg::new("birthday")
-                .long("birthday")
-                .value_name("birthday")
-                .value_parser(clap::value_parser!(u32))
-                .help("Specify wallet birthday when restoring from seed. This is the earliest block height where the wallet has a transaction."))
-            .arg(Arg::new("server")
-                .long("server")
-                .value_name("server")
-                .help("Lightwalletd server to connect to.")
-                .value_parser(parse_uri)
-                .default_value(zingolib::config::DEFAULT_LIGHTWALLETD_SERVER))
-            .arg(Arg::new("data-dir")
-                .long("data-dir")
-                .value_name("data-dir")
-                .help("Absolute path to use as data directory"))
-            .arg(Arg::new("COMMAND")
-                .help("Command to execute. If a command is not specified, zingo-cli will start in interactive mode.")
-                .required(false)
-                .index(1))
-            .arg(Arg::new("extra_args")
-                .help("Params to execute command with. Run the 'help' command to get usage help.")
-                .required(false)
-                .num_args(1..)
-                .index(2)
-                .action(clap::ArgAction::Append)
-        ).get_matches()
+    let cmd = clap::Command::new("Zingo CLI").version(version::VERSION)
+        .arg(Arg::new("nosync")
+            .help("By default, zingo-cli will sync the wallet at startup. Pass --nosync to prevent the automatic sync at startup.")
+            .long("nosync")
+            .short('n')
+            .action(clap::ArgAction::SetTrue))
+        .arg(Arg::new("regtest")
+            .long("regtest")
+            .help("Regtest mode")
+            .action(clap::ArgAction::SetTrue) )
+        .arg(Arg::new("no-clean")
+            .long("no-clean")
+            .help("Don't clean regtest state before running. Regtest mode only")
+            .action(clap::ArgAction::SetTrue))
+        .arg(Arg::new("chain")
+            .long("chain").short('c')
+            .help(r#"What chain to expect, if it's not inferable from the server URI. One of "mainnet", "testnet", or "regtest""#))
+        .arg(Arg::new("seed")
+            .short('s')
+            .long("seed")
+            .value_name("SEED PHRASE")
+            .value_parser(parse_seed)
+            .help("Create a new wallet with the given 24-word seed phrase. Will fail if wallet already exists"))
+        .arg(Arg::new("viewkey")
+            .long("viewkey")
+            .value_name("UFVK")
+            .value_parser(parse_ufvk)
+            .help("Create a new wallet with the given encoded unified full viewing key. Will fail if wallet already exists"))
+        .arg(Arg::new("birthday")
+            .long("birthday")
+            .value_name("birthday")
+            .value_parser(clap::value_parser!(u32))
+            .help("Specify wallet birthday when restoring from seed. This is the earliest block height where the wallet has a transaction."))
+        .arg(Arg::new("server")
+            .long("server")
+            .value_name("server")
+            .help("Lightwalletd server to connect to.")
+            .value_parser(parse_uri)
+            .default_value(zingolib::config::DEFAULT_LIGHTWALLETD_SERVER))
+        .arg(Arg::new("data-dir")
+            .long("data-dir")
+            .value_name("data-dir")
+            .help("Absolute path to use as data directory"))
+        .arg(Arg::new("COMMAND")
+            .help("Command to execute. If a command is not specified, zingo-cli will start in interactive mode.")
+            .required(false)
+            .index(1))
+        .arg(Arg::new("extra_args")
+            .help("Params to execute command with. Run the 'help' command to get usage help.")
+            .required(false)
+            .num_args(1..)
+            .index(2)
+            .action(clap::ArgAction::Append)
+    );
+
+    add_if_ledger(cmd)
+        .get_matches()
 }
 
 /// Custom function to parse a string into an http::Uri
@@ -280,6 +283,8 @@ pub struct ConfigTemplate {
     #[allow(dead_code)] // This field is defined so that it can be used in Drop::drop
     child_process_handler: Option<regtest::ChildProcessHandler>,
     chaintype: ChainType,
+    #[cfg(feature = "ledger-support")]
+    ledger: bool,
 }
 use commands::ShortCircuitedCommand;
 fn short_circuit_on_help(params: Vec<String>) {
@@ -354,6 +359,10 @@ If you don't remember the block height, you can pass '--birthday 0' to scan from
         };
 
         let clean_regtest_data = !matches.get_flag("no-clean");
+
+        #[cfg(feature = "ledger-support")]
+        let ledger = matches.get_flag("ledger");
+
         let data_dir = if let Some(dir) = matches.get_one::<String>("data-dir") {
             PathBuf::from(dir.clone())
         } else if is_regtest {
@@ -412,6 +421,8 @@ If you don't remember the block height, you can pass '--birthday 0' to scan from
             regtest_manager,
             child_process_handler,
             chaintype,
+            #[cfg(feature = "ledger-support")]
+            ledger,
         })
     }
 }
@@ -439,6 +450,8 @@ pub fn startup(
         Some(data_dir),
         filled_template.chaintype,
         true,
+        #[cfg(feature = "ledger-support")]
+        filled_template.ledger,
     )
     .unwrap();
     regtest_config_check(&filled_template.regtest_manager, &config.chain);
@@ -551,3 +564,18 @@ pub fn run_cli() {
         Err(e) => eprintln!("Error filling config template: {:?}", e),
     }
 }
+
+
+fn add_if_ledger(cmd: clap::Command) -> clap::Command {
+
+    #[cfg(feature = "ledger-support")]
+    return cmd
+    .arg(Arg::new("ledger")
+                .long("ledger")
+                .value_name("ledger")
+                .help("Create a new wallet by connecting to a ledger")
+                .action(clap::ArgAction::SetTrue));
+
+    #[cfg(not(feature = "ledger-support"))]
+    return cmd;
+}

zingolib/Cargo.toml

@@ -17,6 +17,7 @@ tempfile = ["dep:tempfile"]
 default = ["sync"]
 sync = ['dep:zingo-sync']
 zaino-test = ['test-elevation']
+ledger-support = []
 
 [dependencies]
 zingo-memo = { path = "../zingo-memo" }

zingolib/src/config.rs

@@ -69,6 +69,8 @@ pub fn load_clientconfig(
     data_dir: Option<PathBuf>,
     chain: ChainType,
     monitor_mempool: bool,
+    #[cfg(feature = "ledger-support")]
+    ledger: bool,
 ) -> std::io::Result<ZingoConfig> {
     use std::net::ToSocketAddrs;
     format!(
@@ -93,6 +95,8 @@ pub fn load_clientconfig(
         wallet_name: DEFAULT_WALLET_NAME.into(),
         logfile_name: DEFAULT_LOGFILE_NAME.into(),
         accept_server_txids: false,
+        #[cfg(feature = "ledger-support")]
+        use_ledger: ledger,
     };
 
     Ok(config)
@@ -138,6 +142,9 @@ pub struct ZingoConfigBuilder {
     pub logfile_name: Option<PathBuf>,
     /// If this option is enabled, the LightClient will replace outgoing TxId records with the TxId picked by the server. necessary for darkside.
     pub accept_server_txids: bool,
+    /// set to true if you will use a ledger hw wallet
+    #[cfg(feature = "ledger-support")]
+    pub use_ledger: bool,
 }
 
 /// Configuration data that is necessary? and sufficient? for the creation of a LightClient.
@@ -159,6 +166,9 @@ pub struct ZingoConfig {
     pub logfile_name: PathBuf,
     /// If this option is enabled, the LightClient will replace outgoing TxId records with the TxId picked by the server. necessary for darkside.
     pub accept_server_txids: bool,
+    #[cfg(feature = "ledger-support")]
+    /// if this option is enabled, the LightClient will look for a ledger device to initialize or resume the wallet
+    pub use_ledger: bool,
 }
 
 impl ZingoConfigBuilder {
@@ -203,6 +213,13 @@ impl ZingoConfigBuilder {
         self
     }
 
+    #[cfg(feature = "ledger-support")]
+    /// set to true to use a ledger hardware wallet
+    pub fn set_use_ledger(&mut self, ledger: bool) -> &mut Self {
+        self.use_ledger = ledger;
+        self
+    }
+
     /// TODO: Add Doc Comment Here!
     pub fn create(&self) -> ZingoConfig {
         let lightwalletd_uri = self.lightwalletd_uri.clone().unwrap_or_default();
@@ -215,6 +232,8 @@ impl ZingoConfigBuilder {
             wallet_name: DEFAULT_WALLET_NAME.into(),
             logfile_name: DEFAULT_LOGFILE_NAME.into(),
             accept_server_txids: self.accept_server_txids,
+            #[cfg(feature = "ledger-support")]
+            use_ledger: false,
         }
     }
 }
@@ -230,6 +249,8 @@ impl Default for ZingoConfigBuilder {
             logfile_name: None,
             chain: ChainType::Mainnet,
             accept_server_txids: false,
+            #[cfg(feature = "ledger-support")]
+            use_ledger: false,
         }
     }
 }

zingolib/src/testutils.rs

@@ -814,6 +814,8 @@ pub mod scenarios {
                     Some(conf_path),
                     crate::config::ChainType::Regtest(regtest_network),
                     true,
+                    #[cfg(feature = "ledger-support")]
+                    false,
                 )
                 .unwrap()
             }

zingolib/src/wallet.rs

@@ -174,6 +174,9 @@ pub enum WalletBase {
     Ufvk(String),
     /// Unified spending key
     Usk(Vec<u8>),
+    #[cfg(feature = "ledger-support")]
+    /// A hardware wallet
+    Ledger
 }
 
 impl WalletBase {
@@ -378,6 +381,18 @@ impl LightWallet {
                 )?;
                 (wc, None)
             }
+            #[cfg(feature = "ledger-support")]
+            WalletBase::Ledger => {
+                let wc = WalletCapability::new_with_ledger(&config).map_err(
+                    |e| {
+                        Error::new(
+                            ErrorKind::Other,
+                            format!("Error initilizing Ledger Device: {}", e),
+                        )
+                    },
+                )?;
+                (wc, None)
+            }
         };
 
         if let Err(e) = wc.new_address(wc.can_view(), false) {

zingolib/src/wallet/disk/testing.rs

@@ -20,6 +20,8 @@ impl LightWallet {
             None,
             crate::config::ChainType::Regtest(crate::config::RegtestNetwork::all_upgrades_active()),
             true,
+            #[cfg(feature = "ledger-support")]
+            false,
         )
         .unwrap();
         Self::read_internal(data, &config)