Self describing action for ApproveGenesisKyc

Author: jasonz-dfinity

rs/nns/governance/src/proposals/self_describing.rs

@@ -1,8 +1,8 @@
 use std::collections::HashMap;
 
 use crate::pb::v1::{
-    Motion, SelfDescribingProposalAction, Value, ValueMap,
-    value::Value::{Map, Text},
+    ApproveGenesisKyc, Motion, SelfDescribingProposalAction, Value, ValueArray, ValueMap,
+    value::Value::{Array, Map, Text},
 };
 
 /// A proposal action that can be described locally, without having to call `canister_metadata`
@@ -37,6 +37,28 @@ impl LocallyDescribableProposalAction for Motion {
     }
 }
 
+impl LocallyDescribableProposalAction for ApproveGenesisKyc {
+    const TYPE_NAME: &'static str = "Approve Genesis KYC";
+    const TYPE_DESCRIPTION: &'static str = "When new neurons are created at Genesis, they have \
+    GenesisKYC=false. This restricts what actions they can perform. Specifically, they cannot spawn \
+    new neurons, and once their dissolve delays are zero, they cannot be disbursed and their balances \
+    unlocked to new accounts. This proposal sets GenesisKYC=true for batches of principals. \
+    (Special note: The Genesis event disburses all ICP in the form of neurons, whose principals \
+    must be KYCed. Consequently, all neurons created after Genesis have GenesisKYC=true set \
+    automatically since they must have been derived from balances that have already been KYCed.)";
+
+    fn to_value(&self) -> Value {
+        ValueBuilder::new()
+            .add_array_field(
+                "principals".to_string(),
+                self.principals
+                    .iter()
+                    .map(|principal| string_to_value(principal.to_string()))
+                    .collect(),
+            )
+            .build()
+    }
+}
 /// A builder for `Value` objects.
 pub(crate) struct ValueBuilder {
     fields: HashMap<String, Value>,
@@ -56,6 +78,15 @@ impl ValueBuilder {
                 value: Some(Text(value.to_string())),
             },
         );
+    }
+
+    pub fn add_array_field(mut self, key: impl ToString, values: Vec<Value>) -> Self {
+        self.fields.insert(
+            key,
+            Value {
+                value: Some(Array(ValueArray { values })),
+            },
+        );
         self
     }
 
@@ -67,6 +98,13 @@ impl ValueBuilder {
     }
 }
 
+/// Converts a string to a `Value` object.
+fn string_to_value(value: String) -> Value {
+    Value {
+        value: Some(Text(value)),
+    }
+}
+
 #[path = "self_describing_tests.rs"]
 #[cfg(test)]
 pub mod tests;

rs/nns/governance/src/proposals/self_describing_tests.rs

@@ -1,5 +1,6 @@
 use super::*;
 
+use ic_base_types::PrincipalId;
 use ic_nns_governance_api::Value as ApiValue;
 use maplit::hashmap;
 
@@ -27,3 +28,22 @@ fn test_motion_to_self_describing() {
         }),
     );
 }
+
+#[test]
+fn test_approve_genesis_kyc_to_self_describing() {
+    let approve_genesis_kyc = ApproveGenesisKyc {
+        principals: vec![
+            PrincipalId::new_user_test_id(1),
+            PrincipalId::new_user_test_id(2),
+        ],
+    };
+    assert_self_describing_value_is(
+        approve_genesis_kyc,
+        ApiValue::Map(hashmap! {
+            "principals".to_string() => ApiValue::Array(vec![
+                ApiValue::Text("6fyp7-3ibaa-aaaaa-aaaap-4ai".to_string()),
+                ApiValue::Text("djduj-3qcaa-aaaaa-aaaap-4ai".to_string()),
+            ]),
+        }),
+    );
+}