Merge branch '@anchpop/NNS1-2194' into 'master'

anchpop · anchpop · commit 359e24f6dee0 · 2023-05-22T16:36:24.000Z
Add CF to payment_flow_with_finalization_test

Adds the CF to the payment flow test in two steps (one per commit):

1. Allows the caller of `setup` to specify some NNS neurons to initialize the NNS with. I went this route instead of creating the neurons at runtime because I wanted to have exact control over the amount of maturity the NNS neurons would have. 
2. Modifies payment_flow_with_finalization_test to insert an NNS neuron that has joined the CF.

Closes NNS1-2194 

Closes NNS1-2194

See merge request dfinity-lab/public/ic!11858
diff --git a/rs/nns/governance/src/init.rs b/rs/nns/governance/src/init.rs
@@ -90,73 +90,70 @@ impl GovernanceCanisterInitPayloadBuilder {
             TEST_NEURON_1_OWNER_PRINCIPAL, TEST_NEURON_2_OWNER_PRINCIPAL,
             TEST_NEURON_3_OWNER_PRINCIPAL,
         };
-        let neuron_id = NeuronIdProto::from(self.new_neuron_id());
-        let subaccount = self.make_subaccount().into();
-        assert_eq!(
-            self.proto.neurons.insert(
-                neuron_id.id,
-                Neuron {
-                    id: Some(neuron_id),
-                    controller: Some(*TEST_NEURON_1_OWNER_PRINCIPAL),
-                    dissolve_state: Some(DissolveState::DissolveDelaySeconds(
-                        TWELVE_MONTHS_SECONDS
-                    )),
-                    cached_neuron_stake_e8s: 1_000_000_000, /* invariant: part of
-                                                             * TEST_NEURON_TOTAL_STAKE_E8S */
-                    account: subaccount,
-                    not_for_profit: true,
-                    ..Default::default()
-                }
-            ),
-            None,
-            "There is more than one neuron with the same id."
-        );
-        let neuron_id = NeuronIdProto::from(self.new_neuron_id());
-        let subaccount = self.make_subaccount().into();
-        assert_eq!(
-            self.proto.neurons.insert(
-                neuron_id.id,
-                Neuron {
-                    id: Some(neuron_id),
-                    controller: Some(*TEST_NEURON_2_OWNER_PRINCIPAL),
-                    dissolve_state: Some(DissolveState::DissolveDelaySeconds(
-                        TWELVE_MONTHS_SECONDS
-                    )),
-                    cached_neuron_stake_e8s: 100_000_000, /* invariant: part of
-                                                           * TEST_NEURON_TOTAL_STAKE_E8S */
-                    created_timestamp_seconds: 1,
-                    aging_since_timestamp_seconds: 1,
-                    account: subaccount,
-                    not_for_profit: false,
-                    ..Default::default()
-                }
-            ),
-            None,
-            "There is more than one neuron with the same id."
-        );
-        let neuron_id = NeuronIdProto::from(self.new_neuron_id());
-        let subaccount = self.make_subaccount().into();
-        assert_eq!(
-            self.proto.neurons.insert(
-                neuron_id.id,
-                Neuron {
-                    id: Some(neuron_id),
-                    controller: Some(*TEST_NEURON_3_OWNER_PRINCIPAL),
-                    dissolve_state: Some(DissolveState::DissolveDelaySeconds(
-                        TWELVE_MONTHS_SECONDS
-                    )),
-                    cached_neuron_stake_e8s: 10_000_000, /* invariant: part of
-                                                          * TEST_NEURON_TOTAL_STAKE_E8S */
-                    created_timestamp_seconds: 10,
-                    aging_since_timestamp_seconds: 10,
-                    account: subaccount,
-                    not_for_profit: false,
-                    ..Default::default()
-                }
-            ),
-            None,
-            "There is more than one neuron with the same id."
-        );
+
+        let neuron1 = {
+            let neuron_id = NeuronIdProto::from(self.new_neuron_id());
+            let subaccount = self.make_subaccount().into();
+            Neuron {
+                id: Some(neuron_id),
+                controller: Some(*TEST_NEURON_1_OWNER_PRINCIPAL),
+                dissolve_state: Some(DissolveState::DissolveDelaySeconds(TWELVE_MONTHS_SECONDS)),
+                cached_neuron_stake_e8s: 1_000_000_000, /* invariant: part of
+                                                         * TEST_NEURON_TOTAL_STAKE_E8S */
+                account: subaccount,
+                not_for_profit: true,
+                ..Default::default()
+            }
+        };
+
+        let neuron2 = {
+            let neuron_id = NeuronIdProto::from(self.new_neuron_id());
+            let subaccount = self.make_subaccount().into();
+            Neuron {
+                id: Some(neuron_id),
+                controller: Some(*TEST_NEURON_2_OWNER_PRINCIPAL),
+                dissolve_state: Some(DissolveState::DissolveDelaySeconds(TWELVE_MONTHS_SECONDS)),
+                cached_neuron_stake_e8s: 100_000_000, /* invariant: part of
+                                                       * TEST_NEURON_TOTAL_STAKE_E8S */
+                created_timestamp_seconds: 1,
+                aging_since_timestamp_seconds: 1,
+                account: subaccount,
+                not_for_profit: false,
+                ..Default::default()
+            }
+        };
+
+        let neuron3 = {
+            let neuron_id = NeuronIdProto::from(self.new_neuron_id());
+            let subaccount = self.make_subaccount().into();
+            Neuron {
+                id: Some(neuron_id),
+                controller: Some(*TEST_NEURON_3_OWNER_PRINCIPAL),
+                dissolve_state: Some(DissolveState::DissolveDelaySeconds(TWELVE_MONTHS_SECONDS)),
+                cached_neuron_stake_e8s: 10_000_000, /* invariant: part of
+                                                      * TEST_NEURON_TOTAL_STAKE_E8S */
+                created_timestamp_seconds: 10,
+                aging_since_timestamp_seconds: 10,
+                account: subaccount,
+                not_for_profit: false,
+                ..Default::default()
+            }
+        };
+        self.with_additional_neurons(vec![neuron1, neuron2, neuron3])
+    }
+
+    /// Initializes the governance canister with the given neurons.
+    #[cfg(not(target_arch = "wasm32"))]
+    pub fn with_additional_neurons(&mut self, neurons: Vec<Neuron>) -> &mut Self {
+        for neuron in neurons {
+            let id: u64 = neuron.id.as_ref().unwrap().id;
+            assert_eq!(
+                self.proto.neurons.insert(id, neuron),
+                None,
+                "There is more than one neuron with the same id ({:?}).",
+                id
+            );
+        }
         self
     }
 
diff --git a/rs/nns/test_utils/src/common.rs b/rs/nns/test_utils/src/common.rs
@@ -10,7 +10,10 @@ use ic_nns_common::init::{LifelineCanisterInitPayload, LifelineCanisterInitPaylo
 use ic_nns_constants::{
     ALL_NNS_CANISTER_IDS, GOVERNANCE_CANISTER_ID, LEDGER_CANISTER_ID, ROOT_CANISTER_ID,
 };
-use ic_nns_governance::{init::GovernanceCanisterInitPayloadBuilder, pb::v1::Governance};
+use ic_nns_governance::{
+    init::GovernanceCanisterInitPayloadBuilder,
+    pb::v1::{Governance, Neuron},
+};
 use ic_nns_gtc::{init::GenesisTokenCanisterInitPayloadBuilder, pb::v1::Gtc};
 use ic_nns_gtc_accounts::{ECT_ACCOUNTS, SEED_ROUND_ACCOUNTS};
 use ic_nns_handler_root::init::{RootCanisterInitPayload, RootCanisterInitPayloadBuilder};
@@ -126,6 +129,11 @@ impl NnsInitPayloadsBuilder {
         self
     }
 
+    pub fn with_additional_neurons(&mut self, neurons: Vec<Neuron>) -> &mut Self {
+        self.governance.with_additional_neurons(neurons);
+        self
+    }
+
     pub fn with_governance_init_payload(
         &mut self,
         governance_init_payload_builder: GovernanceCanisterInitPayloadBuilder,
diff --git a/rs/tests/nns/sns/payment_flow_with_finalization_test.rs b/rs/tests/nns/sns/payment_flow_with_finalization_test.rs
@@ -1,8 +1,14 @@
 use std::time::Duration;
 
 use anyhow::Result;
+use ic_nns_common::pb::v1::NeuronId;
+use ic_nns_governance::pb::v1::{neuron::DissolveState, Neuron};
 use ic_sns_init::pb::v1::SnsInitPayload;
 use ic_tests::driver::test_env_api::NnsCanisterWasmStrategy;
+use icp_ledger::Subaccount;
+use rand::RngCore;
+use rand_chacha::rand_core::SeedableRng;
+use rand_chacha::ChaChaRng;
 use rust_decimal::prelude::ToPrimitive;
 
 use ic_nervous_system_common::{i2d, E8};
@@ -20,7 +26,9 @@ use ic_tests::sns_client::{
     SNS_SALE_PARAM_MIN_PARTICIPANT_ICP_E8S,
 };
 use ic_tests::systest;
-use ic_tests::util::block_on;
+use ic_tests::util::{block_on, generate_identity};
+
+const CF_CONTRIBUTION: u64 = 100 * E8;
 
 fn sale_params() -> Params {
     Params {
@@ -39,6 +47,34 @@ fn sale_params() -> Params {
     }
 }
 
+/// Deterministically generates a neuron that's joined the community fund (CF).
+/// As long as at least one neuron is in the CF, the CF will contribute to the SNS.
+fn nns_cf_neuron() -> Neuron {
+    const TWELVE_MONTHS_SECONDS: u64 = 12 * 30 * 24 * 60 * 60;
+
+    let (_keypair, _pubkey, principal) = generate_identity(2000);
+
+    let mut rng = ChaChaRng::seed_from_u64(2000_u64);
+
+    let id = Some(NeuronId { id: rng.next_u64() });
+    let account = {
+        let mut bytes = [0u8; 32];
+        rng.fill_bytes(&mut bytes);
+        Subaccount(bytes)
+    };
+    Neuron {
+        id,
+        account: account.into(),
+        maturity_e8s_equivalent: CF_CONTRIBUTION,
+        cached_neuron_stake_e8s: E8,
+        controller: Some(principal),
+        dissolve_state: Some(DissolveState::DissolveDelaySeconds(TWELVE_MONTHS_SECONDS)),
+        not_for_profit: false,
+        joined_community_fund_timestamp_seconds: Some(1000), // should be a long time ago
+        ..Default::default()
+    }
+}
+
 fn init_payload() -> SnsInitPayload {
     oc_sns_init_payload()
 }
@@ -47,6 +83,7 @@ fn sns_setup_fast(env: TestEnv) {
     sns_deployment::setup(
         env,
         vec![],
+        vec![nns_cf_neuron()],
         init_payload(),
         NnsCanisterWasmStrategy::TakeBuiltFromSources,
         true,
@@ -55,9 +92,7 @@ fn sns_setup_fast(env: TestEnv) {
 
 fn initiate_token_swap_with_custom_parameters(env: TestEnv) {
     let params = sale_params();
-    // TODO: NNS1-2194: Add community fund investment and verify that it works as intended.
-    let community_fund_investment_e8s = 0;
-    initiate_token_swap(env, params, community_fund_investment_e8s);
+    initiate_token_swap(env, params, CF_CONTRIBUTION);
 }
 
 /// Creates ticket participants and has them contribute in such a way that they'll hit max_icp_e8s with min_participants.
@@ -73,10 +108,10 @@ fn multiple_ticket_participants(env: TestEnv) {
     let num_participants = params.min_participants as u64;
 
     // Calculate a value for `contribution_per_user` that will cause the icp
-    // raised by the swap to exactly equal `params.max_participant_icp_e8s`.
+    // raised by the swap to exactly equal `params.max_icp_e8s - CF_CONTRIBUTION`.
     let contribution_per_user = ic_tests::util::divide_perfectly(
-        "max_participant_icp_e8s",
-        params.max_participant_icp_e8s,
+        "max_icp_e8s",
+        params.max_icp_e8s - CF_CONTRIBUTION,
         num_participants,
     )
     .unwrap();
@@ -103,8 +138,8 @@ fn finalize_swap(env: TestEnv) {
 
     let expected_derived_swap_state = DerivedState {
         direct_participant_count: Some(params.min_participants as u64),
-        cf_participant_count: Some(0),
-        cf_neuron_count: Some(0),
+        cf_participant_count: Some(1),
+        cf_neuron_count: Some(1),
         buyer_total_icp_e8s: params.max_icp_e8s,
         sns_tokens_per_icp,
     };
diff --git a/rs/tests/src/driver/test_env_api.rs b/rs/tests/src/driver/test_env_api.rs
@@ -152,6 +152,7 @@ use ic_nervous_system_common_test_keys::TEST_USER1_PRINCIPAL;
 use ic_nns_constants::{
     CYCLES_MINTING_CANISTER_ID, GOVERNANCE_CANISTER_ID, LIFELINE_CANISTER_ID, REGISTRY_CANISTER_ID,
 };
+use ic_nns_governance::pb::v1::Neuron;
 use ic_nns_init::read_initial_mutations_from_local_store_dir;
 use ic_nns_test_utils::{common::NnsInitPayloadsBuilder, itest_helpers::NnsCanisters};
 use ic_prep_lib::prep_state_directory::IcPrepStateDir;
@@ -1336,6 +1337,7 @@ pub trait NnsInstallationExt {
 pub struct NnsCustomizations {
     /// Summarizes the custom parameters that a newly installed NNS should have.
     pub ledger_balances: Option<HashMap<AccountIdentifier, Tokens>>,
+    pub neurons: Option<Vec<Neuron>>,
 }
 
 #[derive(Clone, Copy, Debug)]
@@ -1393,6 +1395,7 @@ where
             true,
             false,
             customizations.ledger_balances,
+            customizations.neurons,
         );
         Ok(())
     }
@@ -1430,7 +1433,7 @@ where
         };
         info!(log, "Wait for node reporting healthy status");
         self.await_status_is_healthy().unwrap();
-        install_nns_canisters(&log, url, &prep_dir, true, true, None);
+        install_nns_canisters(&log, url, &prep_dir, true, true, None, None);
         Ok(())
     }
 }
@@ -1794,6 +1797,7 @@ pub fn install_nns_canisters(
     nns_test_neurons_present: bool,
     install_at_ids: bool,
     ledger_balances: Option<HashMap<AccountIdentifier, Tokens>>,
+    neurons: Option<Vec<Neuron>>,
 ) {
     let rt = Rt::new().expect("Could not create tokio runtime.");
     info!(
@@ -1808,6 +1812,11 @@ pub fn install_nns_canisters(
             } else {
                 HashMap::new()
             };
+            let neurons = if let Some(neurons) = neurons {
+                neurons
+            } else {
+                Vec::new()
+            };
             ledger_balances.insert(
                 LIFELINE_CANISTER_ID.get().into(),
                 Tokens::from_tokens(10_000).unwrap(),
@@ -1838,6 +1847,7 @@ pub fn install_nns_canisters(
 
             init_payloads
                 .with_test_neurons()
+                .with_additional_neurons(neurons)
                 .with_ledger_init_state(ledger_init_payload);
         }
         let registry_local_store = ic_prep_state_dir.registry_local_store_path();
diff --git a/rs/tests/src/nns_dapp.rs b/rs/tests/src/nns_dapp.rs
@@ -44,6 +44,7 @@ pub fn nns_dapp_customizations() -> NnsCustomizations {
     );
     NnsCustomizations {
         ledger_balances: Some(ledger_balances),
+        neurons: None,
     }
 }
 
diff --git a/rs/tests/src/nns_tests/sns_deployment.rs b/rs/tests/src/nns_tests/sns_deployment.rs
@@ -267,6 +267,9 @@ pub fn workload_static_testnet_sale_bot(env: TestEnv) {
 ///
 /// This function should be the one used "by default" for most tests, to ensure
 /// that the tests are using realistic parameters.
+///
+/// The NNS will be initialized with only the "test" neurons.
+/// (See [`ic_nns_governance::init::GovernanceCanisterInitPayloadBuilder::with_test_neurons`].)
 pub fn setup_with_oc_init_payload(
     env: TestEnv,
     sale_participants: Vec<SaleParticipant>,
@@ -277,6 +280,7 @@ pub fn setup_with_oc_init_payload(
     setup(
         env,
         sale_participants,
+        vec![], // no neurons
         sns_init_payload,
         canister_wasm_strategy,
         fast_test_setup,
@@ -286,6 +290,7 @@ pub fn setup_with_oc_init_payload(
 pub fn setup(
     env: TestEnv,
     sale_participants: Vec<SaleParticipant>,
+    neurons: Vec<ic_nns_governance::pb::v1::Neuron>, // NNS Neurons to add in addition to the "test" neurons
     sns_init_payload: SnsInitPayload,
     canister_wasm_strategy: NnsCanisterWasmStrategy,
     fast_test_setup: bool,
@@ -337,6 +342,7 @@ pub fn setup(
     }
     let nns_customizations = NnsCustomizations {
         ledger_balances: Some(ledger_balances),
+        neurons: Some(neurons),
     };
 
     // Install NNS with ledger customizations
diff --git a/rs/tests/src/util.rs b/rs/tests/src/util.rs

Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@ pub fn nns_dapp_customizations() -> NnsCustomizations {`
`44`	`44`	`);`
`45`	`45`	`NnsCustomizations {`
`46`	`46`	`ledger_balances: Some(ledger_balances),`
	`47`	`+ neurons: None,`
`47`	`48`	`}`
`48`	`49`	`}`
`49`	`50`