Add a command to merge maturity (#48)

* Add a command to merge maturity

* test added

* wording

* fix test

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

Cargo.toml

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

src/commands/neuron_manage.rs

@@ -64,12 +64,18 @@ pub struct Split {
     pub amount_e8s: u64,
 }
 
+#[derive(candid::CandidType)]
+pub struct MergeMaturity {
+    pub percentage_to_merge: u32,
+}
+
 #[derive(CandidType)]
 pub enum Command {
     Configure(Configure),
     Disburse(Disburse),
     Spawn(Spawn),
     Split(Split),
+    MergeMaturity(MergeMaturity),
 }
 
 #[derive(CandidType)]
@@ -112,9 +118,13 @@ pub struct ManageOpts {
     #[clap(long)]
     spawn: bool,
 
-    /// Split off the given number of ICP from a neuron
+    /// Split off the given number of ICP from a neuron.
     #[clap(long)]
     split: Option<u64>,
+
+    /// Merge the percentage (between 1 and 100) of the maturity of a neuron into the current stake.
+    #[clap(long)]
+    merge_maturity: Option<u32>,
 }
 
 pub async fn exec(
@@ -211,6 +221,21 @@ pub async fn exec(
         msgs.push(args);
     };
 
+    if let Some(percentage_to_merge) = opts.merge_maturity {
+        if percentage_to_merge == 0 || percentage_to_merge > 100 {
+            return Err(anyhow!(
+                "Percentage to merge must be a number from 1 to 100"
+            ));
+        }
+        let args = Encode!(&ManageNeuron {
+            id,
+            command: Some(Command::MergeMaturity(MergeMaturity {
+                percentage_to_merge
+            }))
+        })?;
+        msgs.push(args);
+    };
+
     if msgs.is_empty() {
         return Err(anyhow!("No instructions provided"));
     }

tests/commands/neuron-manage-merge-maturity.sh

@@ -0,0 +1 @@
+../target/debug/quill --pem-file - neuron-manage 65 --merge-maturity 100 |  ../target/debug/quill send --dry-run -

tests/outputs/neuron-manage-merge-maturity.txt

@@ -0,0 +1,15 @@
+Sending message with
+
+  Call type:   update
+  Sender:      fdsgv-62ihb-nbiqv-xgic5-iefsv-3cscz-tmbzv-63qd5-vh43v-dqfrt-pae
+  Canister id: rrkah-fqaaa-aaaaa-aaaaq-cai
+  Method name: manage_neuron
+  Arguments:   (
+  record {
+    id = opt record { id = 65 };
+    command = opt variant {
+      MergeMaturity = record { percentage_to_merge = 100 }
+    };
+    neuron_id_or_subaccount = null;
+  },
+)

tests/run.sh

@@ -12,8 +12,10 @@ for f in `ls -1 ./commands/| sort -n`; do
         >&2 echo "Test case $f failed." 
         >&2 echo "Expected output:"
         >&2 cat "$expected"
+        >&2 echo
         >&2 echo "Generated output:"
         >&2 cat "$out"
+        >&2 echo
         exit 1
     fi
     tests=$((tests + 1))