feat: Support more operations with Ledger (#266)

Author: adamspofford-dfinity

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- Ledger support has been updated. Ledger devices can now be used to vote and follow, disburse neurons (but not neuron maturity), add hotkeys, and set neuron visibility; as well as stake new neurons or claim them from Genesis, and transfer to all types of NNS accounts.
 - Added command for disbursing maturity from neurons, `quill neuron-manage --disburse-maturity`, with optional parameters `--disburse-maturity-percentage` and `--disburse-maturity-to`.
 - Updated to rev c7993fa049275b6700df8dfcc02f90d0fca82f24, adding support for the `FulfillSubnetRentalRequest` proposal.
 - `--refresh-followers` has been renamed to the more accurate `--refresh-following`.

e2e/assets/sns_canister_ids.json

@@ -1,6 +1,6 @@
 {
-  "governance_canister_id": "rrkah-fqaaa-aaaaa-aaaaq-cai",
-  "ledger_canister_id": "ryjl3-tyaaa-aaaaa-aaaba-cai",
-  "root_canister_id": "r7inp-6aaaa-aaaaa-aaabq-cai",
-  "swap_canister_id": "rkp4c-7iaaa-aaaaa-aaaca-cai"
+  "governance_canister_id": "zqfso-syaaa-aaaaq-aaafq-cai",
+  "ledger_canister_id": "zfcdd-tqaaa-aaaaq-aaaga-cai",
+  "root_canister_id": "zxeu2-7aaaa-aaaaq-aaafa-cai",
+  "swap_canister_id": "zcdfx-6iaaa-aaaaq-aaagq-cai"
 }

src/commands/claim_neurons.rs

@@ -13,20 +13,37 @@ use k256::elliptic_curve::sec1::ToEncodedPoint;
 pub struct ClaimNeuronOpts;
 
 pub fn exec(auth: &AuthInfo) -> AnyhowResult<Vec<IngressWithRequestId>> {
-    if let AuthInfo::K256Key(pk) = auth {
-        let point = pk.public_key().to_encoded_point(false);
-        let sig = Encode!(&hex::encode(point.as_bytes()))?;
+    match auth {
+        AuthInfo::K256Key(pk) => {
+            let point = pk.public_key().to_encoded_point(false);
+            let sig = Encode!(&hex::encode(point.as_bytes()))?;
+            Ok(vec![sign_ingress_with_request_status_query(
+                auth,
+                genesis_token_canister_id(),
+                ROLE_NNS_GTC,
+                "claim_neurons",
+                sig,
+            )?])
+        }
+        #[cfg(feature = "ledger")]
+        AuthInfo::Ledger => {
+            use crate::lib::ledger::LedgerIdentity;
+            use k256::PublicKey;
+            use pkcs8::DecodePublicKey;
 
-        Ok(vec![sign_ingress_with_request_status_query(
-            auth,
-            genesis_token_canister_id(),
-            ROLE_NNS_GTC,
-            "claim_neurons",
-            sig,
-        )?])
-    } else {
-        Err(anyhow!(
+            let point = PublicKey::from_public_key_der(&LedgerIdentity::new()?.public_key()?.1)?
+                .to_encoded_point(false);
+            let sig = Encode!(&hex::encode(point.as_bytes()))?;
+            Ok(vec![sign_ingress_with_request_status_query(
+                auth,
+                genesis_token_canister_id(),
+                ROLE_NNS_GTC,
+                "claim_neurons",
+                sig,
+            )?])
+        }
+        _ => Err(anyhow!(
             "claim-neurons command requires --pem-file to be specified"
-        ))
+        )),
     }
 }

src/commands/neuron_manage.rs

@@ -167,13 +167,11 @@ enum NativeVisibility {
 pub fn exec(auth: &AuthInfo, opts: ManageOpts) -> AnyhowResult<Vec<IngressWithRequestId>> {
     if opts.ledger {
         ensure!(
-            opts.add_hot_key.is_none() && opts.remove_hot_key.is_none() && !opts.disburse && opts.disburse_amount.is_none() && opts.disburse_to.is_none()
-            && !opts.clear_manage_neuron_followees && !opts.join_community_fund && !opts.leave_community_fund
-            && opts.follow_topic.is_none() && opts.follow_neurons.is_none() && opts.register_vote.is_none() && !opts.reject
-            && opts.set_visibility.is_none() && !opts.refresh_following,
+            !opts.disburse_maturity && opts.disburse_maturity_to.is_none()
+            && opts.disburse_maturity_percentage.is_none(),
             "\
-Cannot use --ledger with these flags. This version of quill only supports the following neuron-manage operations with a Ledger device:
---additional-dissolve-delay-seconds, --start-dissolving, --stop-dissolving, --split, --merge-from-neuron, --spawn, --stake-maturity, --auto-stake-maturity"
+Cannot use --ledger with these flags. This version of quill does not support the --disburse-maturity, --disburse-maturity-to, \
+or --disburse-maturity-percentage flags with a Ledger device"
         );
     }
     let mut msgs = Vec::new();

src/commands/neuron_stake.rs

@@ -6,7 +6,7 @@ use crate::{
         AnyhowResult, AuthInfo, ParsedNnsAccount, ParsedSubaccount, ROLE_NNS_GOVERNANCE,
     },
 };
-use anyhow::{anyhow, ensure};
+use anyhow::anyhow;
 use candid::{Encode, Principal};
 use clap::Parser;
 use ic_nns_constants::GOVERNANCE_CANISTER_ID;
@@ -57,10 +57,6 @@ pub struct StakeOpts {
 }
 
 pub fn exec(auth: &AuthInfo, opts: StakeOpts) -> AnyhowResult<Vec<IngressWithRequestId>> {
-    ensure!(
-        !opts.ledger,
-        "Cannot use `--ledger` with this command. This version of Quill does not support staking new neurons with a Ledger device"
-    );
     let controller = crate::lib::get_principal(auth)?;
     let nonce = match (&opts.nonce, &opts.name) {
         (Some(nonce), _) => *nonce,

src/lib/ledger.rs

@@ -266,7 +266,7 @@ pub fn supported_transaction(canister_id: &Principal, method_name: &str) -> bool
             || method_name == "list_neurons_pb"
             || method_name == "update_node_provider"
     } else if *canister_id == ledger_canister_id() {
-        method_name == "send_pb" || method_name == "icrc1_transfer"
+        method_name == "send_pb" || method_name == "icrc1_transfer" || method_name == "transfer"
     } else {
         method_name == "icrc1_transfer"
             || method_name == "manage_neuron"

tests/output/ckbtc.rs

@@ -3,7 +3,13 @@ use crate::{
     PRINCIPAL,
 };
 
-ledger_compatible![balance, withdrawal_address, transfer];
+ledger_compatible![
+    balance,
+    withdrawal_address,
+    transfer,
+    // update_balance,
+    // retrieve_btc
+];
 
 #[test]
 fn balance() {

tests/output/default/ledger_incompatible/by_command.txt

@@ -1 +1 @@
-Error: Cannot use `--ledger` with this command. This version of Quill does not support staking new neurons with a Ledger device
+Error: Cannot use --ledger with this command. This version of Quill only supports transfers and certain neuron management operations with a Ledger device

tests/output/default/ledger_incompatible/by_flag.txt

@@ -1,2 +1 @@
-Error: Cannot use --ledger with these flags. This version of quill only supports the following neuron-manage operations with a Ledger device:
---additional-dissolve-delay-seconds, --start-dissolving, --stop-dissolving, --split, --merge-from-neuron, --spawn, --stake-maturity, --auto-stake-maturity
+Error: Cannot use --ledger with these flags. This version of quill does not support the --disburse-maturity, --disburse-maturity-to, or --disburse-maturity-percentage flags with a Ledger device

tests/output/default/sns/balance/simple.txt

@@ -2,7 +2,7 @@ Sending message with
 
   Call type:   update
   Sender:      2vxsx-fae
-  Canister id: ryjl3-tyaaa-aaaaa-aaaba-cai
+  Canister id: zfcdd-tqaaa-aaaaq-aaaga-cai
   Method name: icrc1_balance_of
   Arguments:   (
   record {