Merge pull request #6666 from charans29/feature/add-current-epoch-6658

Feature/add current epoch 6658

Author: wileyj

docs/rpc/components/schemas/pox-info.schema.yaml

@@ -15,6 +15,7 @@ required:
   - reward_cycle_length
   - contract_versions
   - epochs
+  - current_epoch
 properties:
   contract_id:
     type: string
@@ -27,6 +28,10 @@ properties:
     type: integer
     minimum: 0
     description: The latest Bitcoin chain block height
+  current_epoch:
+    type: string
+    pattern: "^Epoch[0-9]+(_[0-9]+)?$"
+    description: The ID of the Stacks Epoch that the node is currently in.
   pox_activation_threshold_ustx:
     type: integer
     description:

stacks-signer/src/client/mod.rs

@@ -302,6 +302,7 @@ pub(crate) mod tests {
                     network_epoch: 0,
                 },
             ],
+            current_epoch: StacksEpochId::Epoch30,
             reward_cycle_length: thread_rng().next_u64(),
             rejection_votes_left_required: None,
             next_reward_cycle_in: thread_rng().next_u64(),

stacks-signer/src/client/stacks_client.rs

@@ -274,31 +274,7 @@ impl StacksClient {
     pub fn get_node_epoch(&self) -> Result<StacksEpochId, ClientError> {
         debug!("StacksClient: Getting node epoch");
         let pox_info = self.get_pox_data()?;
-        let burn_block_height = self.get_burn_block_height()?;
-
-        let epoch_25 = pox_info
-            .epochs
-            .iter()
-            .find(|epoch| epoch.epoch_id == StacksEpochId::Epoch25)
-            .ok_or(ClientError::UnsupportedStacksFeature(
-                "/v2/pox must report epochs".into(),
-            ))?;
-
-        let epoch_30 = pox_info
-            .epochs
-            .iter()
-            .find(|epoch| epoch.epoch_id == StacksEpochId::Epoch30)
-            .ok_or(ClientError::UnsupportedStacksFeature(
-                "/v2/pox mut report epochs".into(),
-            ))?;
-
-        if burn_block_height < epoch_25.start_height {
-            Ok(StacksEpochId::Epoch24)
-        } else if burn_block_height < epoch_30.start_height {
-            Ok(StacksEpochId::Epoch25)
-        } else {
-            Ok(StacksEpochId::Epoch30)
-        }
+        Ok(pox_info.current_epoch)
     }
 
     /// Submit the block proposal to the stacks node. The block will be validated and returned via the HTTP endpoint for Block events.
@@ -553,12 +529,6 @@ impl StacksClient {
         Ok(pox_info_data)
     }
 
-    /// Helper function to retrieve the burn tip height from the stacks node
-    fn get_burn_block_height(&self) -> Result<u64, ClientError> {
-        debug!("StacksClient: Getting burn block height");
-        self.get_peer_info().map(|info| info.burn_block_height)
-    }
-
     /// Get the current reward cycle info from the stacks node
     pub fn get_current_reward_cycle_info(&self) -> Result<RewardCycleInfo, ClientError> {
         debug!("StacksClient: Getting current reward cycle info");
@@ -914,17 +884,21 @@ mod tests {
     #[test]
     fn core_info_call_for_burn_block_height_should_succeed() {
         let mock = MockServerClient::new();
-        let h = spawn(move || mock.client.get_burn_block_height());
+        let h = spawn(move || mock.client.get_peer_info());
         let (response, peer_info) = build_get_peer_info_response(None, None);
         write_response(mock.server, response.as_bytes());
-        let burn_block_height = h.join().unwrap().expect("Failed to deserialize response");
+        let burn_block_height = h
+            .join()
+            .unwrap()
+            .expect("Failed to deserialize response")
+            .burn_block_height;
         assert_eq!(burn_block_height, peer_info.burn_block_height);
     }
 
     #[test]
     fn core_info_call_for_burn_block_height_should_fail() {
         let mock = MockServerClient::new();
-        let h = spawn(move || mock.client.get_burn_block_height());
+        let h = spawn(move || mock.client.get_peer_info());
         write_response(
             mock.server,
             b"HTTP/1.1 200 OK\n\n4e99f99bc4a05437abb8c7d0c306618f45b203196498e2ebe287f10497124958",
@@ -998,85 +972,17 @@ mod tests {
     #[test]
     fn get_node_epoch_should_succeed() {
         let mock = MockServerClient::new();
-        // The burn block height is one BEHIND the activation height of 2.5, therefore is 2.4
-        let burn_block_height: u64 = 100;
-        let pox_response = build_get_pox_data_response(
-            None,
-            None,
-            Some(burn_block_height.saturating_add(1)),
-            None,
-        )
-        .0;
-        let peer_response = build_get_peer_info_response(Some(burn_block_height), None).0;
-        let h = spawn(move || mock.client.get_node_epoch());
-        write_response(mock.server, pox_response.as_bytes());
-        let mock = MockServerClient::from_config(mock.config);
-        write_response(mock.server, peer_response.as_bytes());
-        let epoch = h.join().unwrap().expect("Failed to deserialize response");
-        assert_eq!(epoch, StacksEpochId::Epoch24);
 
-        // The burn block height is the same as the activation height of 2.5, therefore is 2.5
-        let pox_response = build_get_pox_data_response(None, None, Some(burn_block_height), None).0;
-        let peer_response = build_get_peer_info_response(Some(burn_block_height), None).0;
-        let mock = MockServerClient::from_config(mock.config);
-        let h = spawn(move || mock.client.get_node_epoch());
-        write_response(mock.server, pox_response.as_bytes());
-        let mock = MockServerClient::from_config(mock.config);
-        write_response(mock.server, peer_response.as_bytes());
-        let epoch = h.join().unwrap().expect("Failed to deserialize response");
-        assert_eq!(epoch, StacksEpochId::Epoch25);
-
-        // The burn block height is the AFTER as the activation height of 2.5 but BEFORE the activation height of 3.0, therefore is 2.5
-        let pox_response = build_get_pox_data_response(
-            None,
-            None,
-            Some(burn_block_height.saturating_sub(1)),
-            Some(burn_block_height.saturating_add(1)),
-        )
-        .0;
-        let peer_response = build_get_peer_info_response(Some(burn_block_height), None).0;
-        let mock = MockServerClient::from_config(mock.config);
-        let h = spawn(move || mock.client.get_node_epoch());
-        write_response(mock.server, pox_response.as_bytes());
-        let mock = MockServerClient::from_config(mock.config);
-        write_response(mock.server, peer_response.as_bytes());
-        let epoch = h.join().unwrap().expect("Failed to deserialize response");
-        assert_eq!(epoch, StacksEpochId::Epoch25);
-
-        // The burn block height is the AFTER as the activation height of 2.5 and the SAME as the activation height of 3.0, therefore is 3.0
-        let pox_response = build_get_pox_data_response(
-            None,
-            None,
-            Some(burn_block_height.saturating_sub(1)),
-            Some(burn_block_height),
-        )
-        .0;
-        let peer_response = build_get_peer_info_response(Some(burn_block_height), None).0;
-        let mock = MockServerClient::from_config(mock.config);
-        let h = spawn(move || mock.client.get_node_epoch());
-        write_response(mock.server, pox_response.as_bytes());
-        let mock = MockServerClient::from_config(mock.config);
-        write_response(mock.server, peer_response.as_bytes());
-        let epoch = h.join().unwrap().expect("Failed to deserialize response");
-        assert_eq!(epoch, StacksEpochId::Epoch30);
-
-        // The burn block height is the AFTER as the activation height of 2.5 and AFTER the activation height of 3.0, therefore is 3.0
-        let pox_response = build_get_pox_data_response(
-            None,
-            None,
-            Some(burn_block_height.saturating_sub(1)),
-            Some(burn_block_height),
-        )
-        .0;
-        let peer_response =
-            build_get_peer_info_response(Some(burn_block_height.saturating_add(1)), None).0;
-        let mock = MockServerClient::from_config(mock.config);
+        let expected_epoch = StacksEpochId::Epoch30;
+
+        let (pox_response, _) = build_get_pox_data_response(None, None, None, None);
+
         let h = spawn(move || mock.client.get_node_epoch());
+
         write_response(mock.server, pox_response.as_bytes());
-        let mock = MockServerClient::from_config(mock.config);
-        write_response(mock.server, peer_response.as_bytes());
+
         let epoch = h.join().unwrap().expect("Failed to deserialize response");
-        assert_eq!(epoch, StacksEpochId::Epoch30);
+        assert_eq!(epoch, expected_epoch);
     }
 
     #[test]

stackslib/src/net/api/getpoxinfo.rs

@@ -111,6 +111,7 @@ pub struct RPCPoxInfoData {
     pub current_cycle: RPCPoxCurrentCycleInfo,
     pub next_cycle: RPCPoxNextCycleInfo,
     pub epochs: Vec<RPCPoxEpoch>,
+    pub current_epoch: StacksEpochId,
 
     // below are included for backwards-compatibility
     pub min_amount_ustx: u64,
@@ -354,11 +355,21 @@ impl RPCPoxInfoData {
             as u64;
 
         let cur_cycle_pox_active = sortdb.is_pox_active(burnchain, &burnchain_tip)?;
-        let epochs = SortitionDB::get_stacks_epochs(sortdb.conn())?
+        let epochs: Vec<RPCPoxEpoch> = SortitionDB::get_stacks_epochs(sortdb.conn())?
             .to_vec()
             .into_iter()
             .map(RPCPoxEpoch::from)
             .collect();
+        let burn_height = burnchain_tip.block_height;
+        let current_epoch = epochs
+            .iter()
+            .fold(StacksEpochId::Epoch10, |acc, epoch_data| {
+                if burn_height >= epoch_data.start_height {
+                    epoch_data.epoch_id
+                } else {
+                    acc
+                }
+            });
 
         Ok(RPCPoxInfoData {
             contract_id: boot_code_id(cur_block_pox_contract, chainstate.mainnet).to_string(),
@@ -388,6 +399,7 @@ impl RPCPoxInfoData {
                 ustx_until_pox_rejection: rejection_votes_left_required,
             },
             epochs,
+            current_epoch,
             min_amount_ustx: next_threshold,
             prepare_cycle_length,
             reward_cycle_id,