Move asserts about nakamoto boot state to a helper function that can be called elsewhere

Signed-off-by: Jacinta Ferrant <[email protected]>

Author: jacinta-stacks

stackslib/src/chainstate/tests/consensus.rs

@@ -399,38 +399,6 @@ impl ConsensusChain<'_> {
             });
             current_height = end_height;
         }
-        // Validate Epoch 2.5 and 3.0 constraints
-        if let Some(epoch_3_0) = epochs.iter().find(|e| e.epoch_id == StacksEpochId::Epoch30) {
-            let epoch_2_5 = epochs
-                .iter()
-                .find(|e| e.epoch_id == StacksEpochId::Epoch25)
-                .expect("Epoch 2.5 not found");
-            let epoch_2_5_start = epoch_2_5.start_height;
-            let epoch_3_0_start = epoch_3_0.start_height;
-            let epoch_2_5_end = epoch_2_5.end_height;
-
-            let epoch_2_5_reward_cycle = epoch_2_5_start / reward_cycle_length;
-            let epoch_3_0_reward_cycle = epoch_3_0_start / reward_cycle_length;
-            let prior_cycle = epoch_3_0_reward_cycle.saturating_sub(1);
-            let epoch_3_0_prepare_phase =
-                prior_cycle * reward_cycle_length + (reward_cycle_length - prepare_length);
-            assert!(
-                epoch_2_5_start < epoch_3_0_prepare_phase,
-                "Epoch 2.5 must start before the prepare phase of the cycle prior to Epoch 3.0. (Epoch 2.5 activation height: {epoch_2_5_start}. Epoch 3.0 prepare phase start: {epoch_3_0_prepare_phase})"
-            );
-            assert_eq!(
-                epoch_2_5_end, epoch_3_0.start_height,
-                "Epoch 2.5 end must equal Epoch 3.0 start (epoch_2_5_end: {epoch_2_5_end}, epoch_3_0_start: {epoch_3_0_start})"
-            );
-            assert_ne!(
-                epoch_2_5_reward_cycle, epoch_3_0_reward_cycle,
-                "Epoch 2.5 and Epoch 3.0 must not be in the same reward cycle (epoch_2_5_reward_cycle: {epoch_2_5_reward_cycle}, epoch_3_0_reward_cycle: {epoch_3_0_reward_cycle})"
-            );
-            assert!(
-                !is_reward_cycle_boundary(epoch_3_0_start, reward_cycle_length),
-                "Epoch 3.0 must not start at a reward cycle boundary (epoch_3_0_start: {epoch_3_0_start})"
-            );
-        }
         // Validate test vector block counts
         for (epoch_id, num_blocks) in num_blocks_per_epoch {
             let epoch = epochs

stackslib/src/config/mod.rs

@@ -684,6 +684,16 @@ impl Config {
                 "FATAL: v1 unlock height is at a reward cycle boundary\nburnchain: {burnchain:?}"
             );
         }
+        if epochs
+            .iter()
+            .any(|epoch| epoch.epoch_id == StacksEpochId::Epoch30)
+        {
+            StacksEpoch::assert_valid_epoch_3_0_activation(
+                epochs,
+                burnchain.pox_constants.reward_cycle_length as u64,
+                burnchain.pox_constants.prepare_length as u64,
+            );
+        }
     }
 
     // TODO: add tests from mutation testing results #4866

stackslib/src/core/mod.rs

@@ -883,6 +883,12 @@ pub trait StacksEpochExtension {
         bitcoin_network: BitcoinNetworkType,
         configured_epochs: Option<&EpochList>,
     ) -> EpochList;
+    /// Assert that the epochs list will satisfy the Epoch 3.0 activation requirements given the reward cycle length and prepare phase length
+    fn assert_valid_epoch_3_0_activation(
+        epochs: &[StacksEpoch],
+        reward_cycle_length: u64,
+        prepare_length: u64,
+    );
 }
 
 impl StacksEpochExtension for StacksEpoch {
@@ -2347,6 +2353,48 @@ impl StacksEpochExtension for StacksEpoch {
         }
 
         assert_eq!(epoch_end_height, STACKS_EPOCH_MAX);
+
         EpochList::new(&epochs)
     }
+
+    fn assert_valid_epoch_3_0_activation(
+        epochs: &[StacksEpoch],
+        reward_cycle_length: u64,
+        prepare_length: u64,
+    ) {
+        // Validate Epoch 2.5 and 3.0 constraints
+        let epoch_3_0 = epochs
+            .iter()
+            .find(|e| e.epoch_id == StacksEpochId::Epoch30)
+            .expect("Cannot activate Epoch 3.0 without specifying its activation height");
+        let epoch_2_5 = epochs
+            .iter()
+            .find(|e| e.epoch_id == StacksEpochId::Epoch25)
+            .expect("Epoch 2.5 not found");
+        let epoch_2_5_start = epoch_2_5.start_height;
+        let epoch_3_0_start = epoch_3_0.start_height;
+        let epoch_2_5_end = epoch_2_5.end_height;
+
+        let epoch_2_5_reward_cycle = epoch_2_5_start / reward_cycle_length;
+        let epoch_3_0_reward_cycle = epoch_3_0_start / reward_cycle_length;
+        let prior_cycle = epoch_3_0_reward_cycle.saturating_sub(1);
+        let epoch_3_0_prepare_phase =
+            prior_cycle * reward_cycle_length + (reward_cycle_length - prepare_length);
+        assert!(
+            epoch_2_5_start < epoch_3_0_prepare_phase,
+            "Epoch 2.5 must start before the prepare phase of the cycle prior to Epoch 3.0. (Epoch 2.5 activation height: {epoch_2_5_start}. Epoch 3.0 prepare phase start: {epoch_3_0_prepare_phase})"
+        );
+        assert_eq!(
+            epoch_2_5_end, epoch_3_0.start_height,
+            "Epoch 2.5 end must equal Epoch 3.0 start (epoch_2_5_end: {epoch_2_5_end}, epoch_3_0_start: {epoch_3_0_start})"
+        );
+        assert_ne!(
+            epoch_2_5_reward_cycle, epoch_3_0_reward_cycle,
+            "Epoch 2.5 and Epoch 3.0 must not be in the same reward cycle (epoch_2_5_reward_cycle: {epoch_2_5_reward_cycle}, epoch_3_0_reward_cycle: {epoch_3_0_reward_cycle})"
+        );
+        assert!(
+            epoch_3_0_start % reward_cycle_length > 1,
+            "Epoch 3.0 must not start at a reward cycle boundary (epoch_3_0_start: {epoch_3_0_start})"
+        );
+    }
 }

stackslib/src/net/tests/mod.rs

@@ -437,6 +437,13 @@ impl NakamotoBootPlan {
         if let Some(current_block) = current_block {
             chainstate_config.current_block = current_block;
         }
+        if let Some(epochs) = self.epochs.as_ref() {
+            StacksEpoch::assert_valid_epoch_3_0_activation(
+                epochs,
+                self.pox_constants.reward_cycle_length as u64,
+                self.pox_constants.prepare_length as u64,
+            );
+        }
         let mut chain = TestChainstate::new_with_observer(chainstate_config, observer);
         chain.mine_malleablized_blocks = self.malleablized_blocks;
         chain
@@ -449,6 +456,13 @@ impl NakamotoBootPlan {
         self,
         observer: Option<&TestEventObserver>,
     ) -> (TestPeer<'_>, Vec<TestPeer<'_>>) {
+        if let Some(epochs) = self.epochs.as_ref() {
+            StacksEpoch::assert_valid_epoch_3_0_activation(
+                epochs,
+                self.pox_constants.reward_cycle_length as u64,
+                self.pox_constants.prepare_length as u64,
+            );
+        }
         let mut peer_config = TestPeerConfig::new(&self.test_name, 0, 0);
         peer_config.chain_config = self.build_nakamoto_chainstate_config();
         peer_config.private_key = self.private_key.clone();