Add a list-neurons subcommand (#34)

* Begin implementing a list-neurons subcommand

* fix queries

* implements query response parsing

* reduce the scope to the list of controller's neurons

* version bump

* clippy

Co-authored-by: Christian Müller <[email protected]>

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "quill"
-version = "0.2.3"
+version = "0.2.4"
 authors = ["DFINITY Team"]
 edition = "2018"
 

src/commands/list_neurons.rs

@@ -0,0 +1,22 @@
+use crate::{
+    commands::sign::sign_ingress,
+    lib::{governance_canister_id, sign::signed_message::Ingress, AnyhowResult},
+};
+use candid::{CandidType, Encode};
+
+#[derive(CandidType)]
+pub struct ListNeurons {
+    pub neuron_ids: Vec<u64>,
+    pub include_neurons_readable_by_caller: bool,
+}
+
+// We currently only support a subset of the functionality.
+pub async fn exec(pem: &Option<String>) -> AnyhowResult<Vec<Ingress>> {
+    let args = Encode!(&ListNeurons {
+        neuron_ids: Vec::new(),
+        include_neurons_readable_by_caller: true,
+    })?;
+    Ok(vec![
+        sign_ingress(pem, governance_canister_id(), "list_neurons", args).await?,
+    ])
+}

src/commands/mod.rs

@@ -5,6 +5,7 @@ use clap::Clap;
 use std::io::{self, Write};
 use tokio::runtime::Runtime;
 
+mod list_neurons;
 mod neuron_manage;
 mod neuron_stake;
 mod public;
@@ -23,6 +24,8 @@ pub enum Command {
     Transfer(transfer::TransferOpts),
     NeuronStake(neuron_stake::StakeOpts),
     NeuronManage(neuron_manage::ManageOpts),
+    /// Signs the query for all neurons belonging to the signin principal.
+    ListNeurons,
 }
 
 pub fn exec(pem: &Option<String>, cmd: Command) -> AnyhowResult {
@@ -43,6 +46,9 @@ pub fn exec(pem: &Option<String>, cmd: Command) -> AnyhowResult {
                 .and_then(|out| print(&out))
         }),
         Command::Send(opts) => runtime.block_on(async { send::exec(pem, opts).await }),
+        Command::ListNeurons => {
+            runtime.block_on(async { list_neurons::exec(pem).await.and_then(|out| print(&out)) })
+        }
     }
 }
 

src/commands/send.rs

@@ -1,7 +1,7 @@
 use crate::commands::request_status;
 use crate::lib::{
     read_from_file,
-    sign::signed_message::{Ingress, IngressWithRequestId},
+    sign::signed_message::{parse_query_response, Ingress, IngressWithRequestId},
     AnyhowResult, IC_URL,
 };
 use anyhow::anyhow;
@@ -58,6 +58,10 @@ pub async fn exec(pem: &Option<String>, opts: SendOpts) -> AnyhowResult {
     let json = read_from_file(&opts.file_name)?;
     if let Ok(val) = serde_json::from_str::<Ingress>(&json) {
         send(&val, &opts).await?;
+    } else if let Ok(vals) = serde_json::from_str::<Vec<Ingress>>(&json) {
+        for msg in vals {
+            send(&msg, &opts).await?;
+        }
     } else if let Ok(vals) = serde_json::from_str::<Vec<IngressWithRequestId>>(&json) {
         for tx in vals {
             submit_ingress_and_check_status(pem, &tx, &opts).await?;
@@ -114,9 +118,12 @@ async fn send(message: &Ingress, opts: &SendOpts) -> AnyhowResult {
 
     match message.call_type.as_str() {
         "query" => {
-            let response = transport.query(canister_id, content).await?;
-            print!("Response: ");
-            println!("{}", hex::encode(response));
+            let response = parse_query_response(
+                transport.query(canister_id, content).await?,
+                canister_id,
+                &method_name,
+            )?;
+            println!("Response: {}", response);
         }
         "update" => {
             let request_id = RequestId::from_str(

src/commands/sign.rs

@@ -2,7 +2,7 @@ use crate::commands::request_status;
 use crate::lib::{
     get_agent, get_candid_type, get_local_candid,
     sign::sign_transport::{SignReplicaV2Transport, SignedMessageWithRequestId},
-    sign::signed_message::IngressWithRequestId,
+    sign::signed_message::{Ingress, IngressWithRequestId},
     AnyhowResult,
 };
 use anyhow::anyhow;
@@ -81,3 +81,14 @@ pub async fn sign_ingress_with_request_status_query(
     };
     Ok(message)
 }
+
+/// Generates a signed ingress message.
+pub async fn sign_ingress(
+    pem: &Option<String>,
+    canister_id: Principal,
+    method_name: &str,
+    args: Vec<u8>,
+) -> AnyhowResult<Ingress> {
+    let msg = sign(pem, canister_id, method_name, args).await?;
+    Ok(msg.message.try_into()?)
+}

src/lib/sign/signed_message.rs

@@ -89,3 +89,36 @@ impl Ingress {
         Err(anyhow!("Invalid cbor content"))
     }
 }
+
+pub fn parse_query_response(
+    response: Vec<u8>,
+    canister_id: Principal,
+    method_name: &str,
+) -> AnyhowResult<String> {
+    let cbor: Value = serde_cbor::from_slice(&response)
+        .map_err(|_| anyhow!("Invalid cbor data in the content of the message."))?;
+    if let Value::Map(m) = cbor {
+        // Try to decode a rejected response.
+        if let (_, Some(Value::Integer(reject_code)), Some(Value::Text(reject_message))) = (
+            m.get(&Value::Text("status".to_string())),
+            m.get(&Value::Text("reject_code".to_string())),
+            m.get(&Value::Text("reject_message".to_string())),
+        ) {
+            return Ok(format!(
+                "Rejected (code {}): {}",
+                reject_code, reject_message
+            ));
+        }
+
+        // Try to decode a successful response.
+        if let (_, Some(Value::Map(m))) = (
+            m.get(&Value::Text("status".to_string())),
+            m.get(&Value::Text("reply".to_string())),
+        ) {
+            if let Some(Value::Bytes(reply)) = m.get(&Value::Text("arg".to_string())) {
+                return get_idl_string(reply, canister_id, method_name, "rets");
+            }
+        }
+    }
+    Err(anyhow!("Invalid cbor content"))
+}

tests/commands/list-neurons.sh

@@ -0,0 +1 @@
+../target/debug/quill --pem-file - list-neurons | ../target/debug/quill send --dry-run -

tests/fix_outputs.sh

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 PEM=`cat ./identity.pem`
 
 for f in `ls -1 ./commands/`; do

tests/outputs/list-neurons.txt

@@ -0,0 +1,7 @@
+Sending message with
+
+  Call type:   query
+  Sender:      fdsgv-62ihb-nbiqv-xgic5-iefsv-3cscz-tmbzv-63qd5-vh43v-dqfrt-pae
+  Canister id: rrkah-fqaaa-aaaaa-aaaaq-cai
+  Method name: list_neurons
+  Arguments:   (record { neuron_ids = vec {}; include_neurons_readable_by_caller = true })