feat(aggregator): return cardano network in status route

Author: Alenar

mithril-aggregator/src/http_server/routes/status.rs

@@ -24,12 +24,16 @@ fn status(
         .and(middlewares::extract_config(router_state, |config| {
             config.cardano_node_version.clone()
         }))
+        .and(middlewares::extract_config(router_state, |config| {
+            config.network.to_string()
+        }))
         .and_then(handlers::status)
 }
 
 async fn get_aggregator_status_message(
     epoch_service: EpochServiceWrapper,
     cardano_node_version: String,
+    cardano_network: String,
 ) -> StdResult<AggregatorStatusMessage> {
     let epoch_service = epoch_service.read().await;
 
@@ -49,6 +53,7 @@ async fn get_aggregator_status_message(
     let message = AggregatorStatusMessage {
         epoch,
         cardano_era,
+        cardano_network,
         mithril_era,
         cardano_node_version,
         aggregator_node_version,
@@ -81,9 +86,11 @@ mod handlers {
         logger: Logger,
         epoch_service: EpochServiceWrapper,
         cardano_node_version: String,
+        cardano_network: String,
     ) -> Result<impl warp::Reply, Infallible> {
         let aggregator_status_message =
-            get_aggregator_status_message(epoch_service, cardano_node_version).await;
+            get_aggregator_status_message(epoch_service, cardano_node_version, cardano_network)
+                .await;
 
         match aggregator_status_message {
             Ok(message) => Ok(reply::json(&message, StatusCode::OK)),
@@ -211,11 +218,11 @@ mod tests {
             ..FakeEpochServiceBuilder::dummy(Epoch(3))
         }
         .build();
+        let epoch_service = Arc::new(RwLock::new(epoch_service));
 
-        let message =
-            get_aggregator_status_message(Arc::new(RwLock::new(epoch_service)), String::new())
-                .await
-                .unwrap();
+        let message = get_aggregator_status_message(epoch_service, String::new(), String::new())
+            .await
+            .unwrap();
 
         assert_eq!(
             message.protocol_parameters,
@@ -240,7 +247,7 @@ mod tests {
         .build();
         let epoch_service = Arc::new(RwLock::new(epoch_service));
 
-        let message = get_aggregator_status_message(epoch_service.clone(), String::new())
+        let message = get_aggregator_status_message(epoch_service, String::new(), String::new())
             .await
             .unwrap();
 
@@ -266,11 +273,28 @@ mod tests {
         .build();
         let epoch_service = Arc::new(RwLock::new(epoch_service));
 
-        let message = get_aggregator_status_message(epoch_service.clone(), String::new())
+        let message = get_aggregator_status_message(epoch_service, String::new(), String::new())
             .await
             .unwrap();
 
         assert_eq!(message.total_stakes_signers, total_stakes_signers);
         assert_eq!(message.total_next_stakes_signers, total_next_stakes_signers);
     }
+
+    #[tokio::test]
+    async fn retrieves_node_version_and_network_from_parameters() {
+        let epoch_service = FakeEpochServiceBuilder::dummy(Epoch(3)).build();
+        let epoch_service = Arc::new(RwLock::new(epoch_service));
+
+        let message = get_aggregator_status_message(
+            epoch_service,
+            "1.0.4".to_string(),
+            "network".to_string(),
+        )
+        .await
+        .unwrap();
+
+        assert_eq!(message.cardano_node_version, "1.0.4");
+        assert_eq!(message.cardano_network, "network");
+    }
 }

mithril-common/src/messages/aggregator_status.rs

@@ -14,6 +14,9 @@ pub struct AggregatorStatusMessage {
     /// Current Cardano era
     pub cardano_era: CardanoEra,
 
+    /// Cardano network
+    pub cardano_network: String,
+
     /// Current Mithril era
     pub mithril_era: SupportedEra,
 
@@ -57,6 +60,7 @@ mod tests {
     const ACTUAL_JSON: &str = r#"{
         "epoch": 48,
         "cardano_era": "conway",
+        "cardano_network": "mainnet",
         "mithril_era": "pythagoras",
         "cardano_node_version": "1.2.3",
         "aggregator_node_version": "4.5.6",
@@ -70,10 +74,56 @@ mod tests {
         "total_cardano_stake": 888888888
         }"#;
 
+    #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+    pub struct AggregatorStatusMessageUntilV0_1_37 {
+        pub epoch: Epoch,
+        pub cardano_era: CardanoEra,
+        pub mithril_era: SupportedEra,
+        pub cardano_node_version: String,
+        pub aggregator_node_version: String,
+        #[serde(rename = "protocol")]
+        pub protocol_parameters: ProtocolParameters,
+        #[serde(rename = "next_protocol")]
+        pub next_protocol_parameters: ProtocolParameters,
+        pub total_signers: usize,
+        pub total_next_signers: usize,
+        pub total_stakes_signers: Stake,
+        pub total_next_stakes_signers: Stake,
+        pub total_cardano_spo: TotalSPOs,
+        pub total_cardano_stake: Stake,
+    }
+
+    fn golden_message_until_open_api_0_1_37() -> AggregatorStatusMessageUntilV0_1_37 {
+        AggregatorStatusMessageUntilV0_1_37 {
+            epoch: Epoch(48),
+            cardano_era: "conway".to_string(),
+            mithril_era: SupportedEra::Pythagoras,
+            cardano_node_version: "1.2.3".to_string(),
+            aggregator_node_version: "4.5.6".to_string(),
+            protocol_parameters: ProtocolParameters {
+                k: 5,
+                m: 100,
+                phi_f: 0.65,
+            },
+            next_protocol_parameters: ProtocolParameters {
+                k: 50,
+                m: 1000,
+                phi_f: 0.65,
+            },
+            total_signers: 1234,
+            total_next_signers: 56789,
+            total_stakes_signers: 123456789,
+            total_next_stakes_signers: 987654321,
+            total_cardano_spo: 7777,
+            total_cardano_stake: 888888888,
+        }
+    }
+
     fn golden_actual_message() -> AggregatorStatusMessage {
         AggregatorStatusMessage {
             epoch: Epoch(48),
             cardano_era: "conway".to_string(),
+            cardano_network: "mainnet".to_string(),
             mithril_era: SupportedEra::Pythagoras,
             cardano_node_version: "1.2.3".to_string(),
             aggregator_node_version: "4.5.6".to_string(),
@@ -96,6 +146,14 @@ mod tests {
         }
     }
 
+    #[test]
+    fn test_actual_json_deserialized_into_message_supported_until_open_api_0_1_37() {
+        let json = ACTUAL_JSON;
+        let message: AggregatorStatusMessageUntilV0_1_37 = serde_json::from_str(json).unwrap();
+
+        assert_eq!(golden_message_until_open_api_0_1_37(), message);
+    }
+
     // Test the compatibility with current structure.
     #[test]
     fn test_actual_json_deserialized_into_actual_message() {