feat: use Ledger as signer via --ledger-path

Makes Ledger available as signer for any command expecting a signer by simply setting the `--ledger-path` option with an EIP-2645 compliant HD wallet path, or using the `STARKNET_LEDGER_PATH` environment variable.
xJonathanLEI · Jun 29, 2024 · 0c1627c · 0c1627c
1 parent 825adea
commit 0c1627c
Show file tree

Hide file tree

Showing 8 changed files with 111 additions and 27 deletions.
diff --git a/src/account.rs b/src/account.rs
@@ -347,7 +347,7 @@ impl AccountArgs {
                 ExecutionEncoding::New,
             )
         } else {
-            let signer = signer.resolve()?;
+            let signer = signer.resolve().await?;
             let account = PathBuf::from(shellexpand::tilde(&self.account).into_owned());
 
             if !account.exists() {

diff --git a/src/signer.rs b/src/signer.rs
@@ -6,24 +6,27 @@ use clap::Parser;
 use colored::Colorize;
 use starknet::{
     core::{crypto::Signature, types::Felt},
-    signers::{LocalWallet, Signer, SigningKey, VerifyingKey},
+    signers::{DerivationPath, LedgerSigner, LocalWallet, Signer, SigningKey, VerifyingKey},
 };
 
 #[derive(Debug)]
 pub enum AnySigner {
     LocalWallet(LocalWallet),
+    Ledger(LedgerSigner),
 }
 
 #[derive(Debug, thiserror::Error)]
 #[error(transparent)]
 pub enum AnySignerGetPublicKeyError {
     LocalWallet(<LocalWallet as Signer>::GetPublicKeyError),
+    Ledger(<LedgerSigner as Signer>::GetPublicKeyError),
 }
 
 #[derive(Debug, thiserror::Error)]
 #[error(transparent)]
 pub enum AnySignerSignError {
     LocalWallet(<LocalWallet as Signer>::SignError),
+    Ledger(<LedgerSigner as Signer>::SignError),
 }
 
 #[derive(Debug, Clone, Parser)]
@@ -37,6 +40,8 @@ pub struct SignerArgs {
     keystore_password: Option<String>,
     #[clap(long, help = private_key_help())]
     private_key: Option<String>,
+    #[clap(long, help = ledger_path_help())]
+    ledger_path: Option<DerivationPath>,
 }
 
 #[derive(Debug)]
@@ -53,6 +58,7 @@ pub enum SignerResolutionTask {
 pub enum SignerResolutionTaskContent {
     Keystore(KeystoreTaskContent),
     PrivateKey(PrivateKeyTaskContent),
+    Ledger(LedgerTaskContent),
 }
 
 #[derive(Debug)]
@@ -66,11 +72,21 @@ pub struct PrivateKeyTaskContent {
     key: String,
 }
 
+#[derive(Debug)]
+pub struct LedgerTaskContent {
+    path: DerivationPath,
+}
+
 enum StringValue {
     FromCommandLine(String),
     FromEnvVar(String),
 }
 
+enum DerivationPathValue {
+    FromCommandLine(DerivationPath),
+    FromEnvVar(DerivationPath),
+}
+
 #[cfg_attr(not(target_arch = "wasm32"), async_trait)]
 #[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
 impl Signer for AnySigner {
@@ -82,6 +98,9 @@ impl Signer for AnySigner {
             Self::LocalWallet(inner) => Ok(<LocalWallet as Signer>::get_public_key(inner)
                 .await
                 .map_err(Self::GetPublicKeyError::LocalWallet)?),
+            Self::Ledger(inner) => Ok(<LedgerSigner as Signer>::get_public_key(inner)
+                .await
+                .map_err(Self::GetPublicKeyError::Ledger)?),
         }
     }
 
@@ -90,19 +109,26 @@ impl Signer for AnySigner {
             Self::LocalWallet(inner) => Ok(<LocalWallet as Signer>::sign_hash(inner, hash)
                 .await
                 .map_err(Self::SignError::LocalWallet)?),
+            Self::Ledger(inner) => {
+                eprintln!("Please confirm the signing operation on your Ledger");
+                Ok(<LedgerSigner as Signer>::sign_hash(inner, hash)
+                    .await
+                    .map_err(Self::SignError::Ledger)?)
+            }
         }
     }
 
     fn is_interactive(&self) -> bool {
         match self {
             Self::LocalWallet(inner) => <LocalWallet as Signer>::is_interactive(inner),
+            Self::Ledger(inner) => <LedgerSigner as Signer>::is_interactive(inner),
         }
     }
 }
 
 impl SignerArgs {
-    pub fn into_signer(self) -> Result<AnySigner> {
-        self.into_task()?.resolve()
+    pub async fn into_signer(self) -> Result<AnySigner> {
+        self.into_task()?.resolve().await
     }
 
     /// Parses the options into a resolution task without immediately performing the resolution.
@@ -129,17 +155,25 @@ impl SignerArgs {
                 Err(_) => None,
             },
         };
+        let ledger_path = match self.ledger_path {
+            Some(value) => Some(DerivationPathValue::FromCommandLine(value)),
+            None => match std::env::var("STARKNET_LEDGER_PATH") {
+                Ok(value) => Some(DerivationPathValue::FromEnvVar(value.parse()?)),
+                Err(_) => None,
+            },
+        };
 
-        let task = match (keystore, self.keystore_password, private_key) {
+        let task = match (keystore, self.keystore_password, private_key, ledger_path) {
             // Options:
             //   Keystore: from command line
             //   Private key: from env var or not supplied at all
+            //   Ledger path: from env var or not supplied at all
             // Resolution: use keystore
-            (Some(StringValue::FromCommandLine(keystore)), keystore_password, None)
-            | (
+            (
                 Some(StringValue::FromCommandLine(keystore)),
                 keystore_password,
-                Some(StringValue::FromEnvVar(_)),
+                Some(StringValue::FromEnvVar(_)) | None,
+                Some(DerivationPathValue::FromEnvVar(_)) | None,
             ) => SignerResolutionTask::Strong(SignerResolutionTaskContent::Keystore(
                 KeystoreTaskContent {
                     keystore,
@@ -149,20 +183,35 @@ impl SignerArgs {
             // Options:
             //   Keystore: from env var or not supplied at all
             //   Private key: from command line
+            //   Ledger path: from env var or not supplied at all
             // Resolution: use private key
-            (None, None, Some(StringValue::FromCommandLine(private_key)))
-            | (
-                Some(StringValue::FromEnvVar(_)),
+            (
+                Some(StringValue::FromEnvVar(_)) | None,
                 None,
                 Some(StringValue::FromCommandLine(private_key)),
+                Some(DerivationPathValue::FromEnvVar(_)) | None,
             ) => SignerResolutionTask::Strong(SignerResolutionTaskContent::PrivateKey(
                 PrivateKeyTaskContent { key: private_key },
             )),
             // Options:
+            //   Keystore: from env var or not supplied at all
+            //   Private key: from env var or not supplied at all
+            //   Ledger path: from command line
+            // Resolution: use Ledger
+            (
+                Some(StringValue::FromEnvVar(_)) | None,
+                None,
+                Some(StringValue::FromEnvVar(_)) | None,
+                Some(DerivationPathValue::FromCommandLine(ledger_path)),
+            ) => SignerResolutionTask::Strong(SignerResolutionTaskContent::Ledger(
+                LedgerTaskContent { path: ledger_path },
+            )),
+            // Options:
             //   Keystore: from env var
             //   Private key: not supplied at all
+            //   Ledger path: not supplied at all
             // Resolution: use keystore (weak)
-            (Some(StringValue::FromEnvVar(keystore)), keystore_password, None) => {
+            (Some(StringValue::FromEnvVar(keystore)), keystore_password, None, None) => {
                 SignerResolutionTask::Weak(SignerResolutionTaskContent::Keystore(
                     KeystoreTaskContent {
                         keystore,
@@ -173,22 +222,41 @@ impl SignerArgs {
             // Options:
             //   Keystore: not supplied at all
             //   Private key: from env var
+            //   Ledger path: not supplied at all
             // Resolution: use private key (weak)
-            (None, None, Some(StringValue::FromEnvVar(private_key))) => SignerResolutionTask::Weak(
-                SignerResolutionTaskContent::PrivateKey(PrivateKeyTaskContent { key: private_key }),
-            ),
+            (None, None, Some(StringValue::FromEnvVar(private_key)), None) => {
+                SignerResolutionTask::Weak(SignerResolutionTaskContent::PrivateKey(
+                    PrivateKeyTaskContent { key: private_key },
+                ))
+            }
+            // Options:
+            //   Keystore: not supplied at all
+            //   Private key: not supplied at all
+            //   Ledger path: from env var
+            // Resolution: use Ledger (weak)
+            (None, None, None, Some(DerivationPathValue::FromEnvVar(ledger_path))) => {
+                SignerResolutionTask::Weak(SignerResolutionTaskContent::Ledger(LedgerTaskContent {
+                    path: ledger_path,
+                }))
+            }
             // Options:
             //   Keystore: from env var
             //   Private key: from env var
+            //   Ledger path: from env var
             // Resolution: conflict
             // (We don't really need this branch, but it's nice to show a case-specific warning.)
-            (Some(StringValue::FromEnvVar(_)), _, Some(StringValue::FromEnvVar(_))) => {
+            (
+                Some(StringValue::FromEnvVar(_)),
+                _,
+                Some(StringValue::FromEnvVar(_)),
+                Some(DerivationPathValue::FromEnvVar(_)),
+            ) => {
                 return Err(anyhow::anyhow!(
-                    "using STARKNET_KEYSTORE and STARKNET_PRIVATE_KEY \
+                    "using STARKNET_KEYSTORE, STARKNET_PRIVATE_KEY, STARKNET_LEDGER_PATH \
                     at the same time is not allowed"
                 ))
             }
-            (None, None, None) => SignerResolutionTask::None,
+            (None, None, None, None) => SignerResolutionTask::None,
             _ => {
                 return Err(anyhow::anyhow!(
                     "invalid signer option combination. \
@@ -202,11 +270,12 @@ impl SignerArgs {
 }
 
 impl SignerResolutionTask {
-    pub fn resolve(self) -> Result<AnySigner> {
+    pub async fn resolve(self) -> Result<AnySigner> {
         match self {
             Self::Strong(task) | Self::Weak(task) => match task {
                 SignerResolutionTaskContent::Keystore(inner) => inner.resolve(),
                 SignerResolutionTaskContent::PrivateKey(inner) => inner.resolve(),
+                SignerResolutionTaskContent::Ledger(inner) => inner.resolve().await,
             },
             Self::None => Err(anyhow::anyhow!(
                 "no valid signer option provided. \
@@ -258,12 +327,12 @@ impl PrivateKeyTaskContent {
             Err(_) => true,
         };
 
-        // TODO: change to recommend hardware wallets when they become available
         if print_warning {
             eprintln!(
                 "{}",
                 "WARNING: using private key in plain text is highly insecure, and you should \
-                ONLY do this for development. Consider using an encrypted keystore instead. \
+                ONLY do this for development. Consider using an encrypted keystore instead, \
+                or better yet, Ledger hardware wallets. \
                 (Check out https://book.starkli.rs/signers on how to suppress this warning)"
                     .bright_magenta()
             );
@@ -276,6 +345,12 @@ impl PrivateKeyTaskContent {
     }
 }
 
+impl LedgerTaskContent {
+    pub async fn resolve(self) -> Result<AnySigner> {
+        Ok(AnySigner::Ledger(LedgerSigner::new(self.path).await?))
+    }
+}
+
 fn keystore_help() -> String {
     format!(
         "Path to keystore JSON file [env: STARKNET_KEYSTORE={}]",
@@ -289,3 +364,12 @@ fn private_key_help() -> String {
         std::env::var("STARKNET_PRIVATE_KEY").unwrap_or_default()
     )
 }
+
+fn ledger_path_help() -> String {
+    format!(
+        "For using Ledger hardware wallets, an HD wallet derivation path with EIP-2645 \
+        standard, such as \"m/2645'/1195502025'/1470455285'/0'/0'/0\" \
+        [env: STARKNET_LEDGER_PATH={}]",
+        std::env::var("STARKNET_LEDGER_PATH").unwrap_or_default()
+    )
+}
diff --git a/src/subcommands/account/argent/init.rs b/src/subcommands/account/argent/init.rs
@@ -45,7 +45,7 @@ impl Init {
             anyhow::bail!("account config file already exists");
         }
 
-        let signer = self.signer.into_signer()?;
+        let signer = self.signer.into_signer().await?;
 
         // Too lazy to write random salt generation
         let salt = SigningKey::from_random().secret_scalar();

diff --git a/src/subcommands/account/braavos/init.rs b/src/subcommands/account/braavos/init.rs
@@ -49,7 +49,7 @@ impl Init {
             anyhow::bail!("account config file already exists");
         }
 
-        let signer = self.signer.into_signer()?;
+        let signer = self.signer.into_signer().await?;
 
         // Too lazy to write random salt generation
         let salt = SigningKey::from_random().secret_scalar();

diff --git a/src/subcommands/account/deploy.rs b/src/subcommands/account/deploy.rs
@@ -75,7 +75,7 @@ impl Deploy {
         }
 
         let provider = Arc::new(self.provider.into_provider()?);
-        let signer = Arc::new(self.signer.into_signer()?);
+        let signer = Arc::new(self.signer.into_signer().await?);
 
         if !self.file.exists() {
             anyhow::bail!("account config file not found");

diff --git a/src/subcommands/account/oz/init.rs b/src/subcommands/account/oz/init.rs
@@ -43,7 +43,7 @@ impl Init {
             anyhow::bail!("account config file already exists");
         }
 
-        let signer = self.signer.into_signer()?;
+        let signer = self.signer.into_signer().await?;
 
         // Too lazy to write random salt generation
         let salt = SigningKey::from_random().secret_scalar();

diff --git a/src/subcommands/signer/ledger/get_public_key.rs b/src/subcommands/signer/ledger/get_public_key.rs
@@ -9,7 +9,7 @@ pub struct GetPublicKey {
         help = "Display the public key on Ledger's screen for extra security"
     )]
     display: bool,
-    #[clap(help = "A HD wallet derivation path with EIP-2645 standard, such as \
+    #[clap(help = "An HD wallet derivation path with EIP-2645 standard, such as \
         \"m/2645'/1195502025'/1470455285'/0'/0'/0\"")]
     path: DerivationPath,
 }

diff --git a/src/subcommands/signer/ledger/sign_hash.rs b/src/subcommands/signer/ledger/sign_hash.rs
@@ -10,7 +10,7 @@ use starknet::{
 pub struct SignHash {
     #[clap(
         long,
-        help = "A HD wallet derivation path with EIP-2645 standard, such as \
+        help = "An HD wallet derivation path with EIP-2645 standard, such as \
         \"m/2645'/1195502025'/1470455285'/0'/0'/0\""
     )]
     path: DerivationPath,