feat: add next_cardano_transactions_signing_config to EpochSettingsMessage and rename current_cardano_transactions_signing_config to cardano_transactions_signing_config

dlachaume · dlachaume · commit 48c511595d14 · 2024-09-19T18:30:37.000+02:00
- refactor backward compatibility tests with the latest OpenAPI version supported by each structure
- update OpenAPI specifications with `next_cardano_transactions_signing_config` and refactor by extracting to a dedicated 'CardanoTransactionsSigningConfig' component
- make the '/epoch-settings' HTTP route return the correct data
diff --git a/mithril-aggregator/src/http_server/routes/epoch_routes.rs b/mithril-aggregator/src/http_server/routes/epoch_routes.rs
@@ -46,7 +46,7 @@ mod handlers {
         debug!("⇄ HTTP SERVER: epoch_settings");
         let epoch_service = epoch_service.read().await;
 
-        let current_cardano_transactions_signing_config = signed_entity_config
+        let cardano_transactions_signing_config = signed_entity_config
             .list_allowed_signed_entity_types_discriminants()
             .contains(&SignedEntityTypeDiscriminants::CardanoTransactions)
             .then_some(configuration.cardano_transactions_signing_config);
@@ -71,7 +71,9 @@ mod handlers {
                     next_protocol_parameters: next_protocol_parameters.clone(),
                     current_signers: SignerMessagePart::from_signers(current_signers.to_vec()),
                     next_signers: SignerMessagePart::from_signers(next_signers.to_vec()),
-                    current_cardano_transactions_signing_config,
+                    cardano_transactions_signing_config: cardano_transactions_signing_config
+                        .clone(),
+                    next_cardano_transactions_signing_config: cardano_transactions_signing_config,
                 };
                 Ok(reply::json(&epoch_settings_message, StatusCode::OK))
             }
diff --git a/mithril-common/src/messages/epoch_settings.rs b/mithril-common/src/messages/epoch_settings.rs
@@ -24,7 +24,11 @@ pub struct EpochSettingsMessage {
 
     /// Cardano transactions signing configuration for the current epoch
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub current_cardano_transactions_signing_config: Option<CardanoTransactionsSigningConfig>,
+    pub cardano_transactions_signing_config: Option<CardanoTransactionsSigningConfig>,
+
+    /// Cardano transactions signing configuration for the next epoch
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub next_cardano_transactions_signing_config: Option<CardanoTransactionsSigningConfig>,
 }
 
 impl EpochSettingsMessage {
@@ -45,7 +49,8 @@ impl EpochSettingsMessage {
                 },
                 current_signers: [SignerMessagePart::dummy()].to_vec(),
                 next_signers: [SignerMessagePart::dummy()].to_vec(),
-                current_cardano_transactions_signing_config: Some(CardanoTransactionsSigningConfig::dummy()),
+                cardano_transactions_signing_config: Some(CardanoTransactionsSigningConfig::dummy()),
+                next_cardano_transactions_signing_config: Some(CardanoTransactionsSigningConfig::dummy()),
             }
         }
     }
@@ -76,15 +81,20 @@ mod tests {
             "operational_certificate":"certificate_456",
             "kes_period":45
         }],
-        "current_cardano_transactions_signing_config": {
+        "cardano_transactions_signing_config": {
             "security_parameter": 70,
             "step": 20
+        },
+        "next_cardano_transactions_signing_config": {
+            "security_parameter": 50,
+            "step": 10
         }
         
         }"#;
 
+    // Supported structure until OpenAPI version 0.1.28.
     #[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
-    pub struct EpochSettingsMessageLegacyVersion {
+    pub struct EpochSettingsMessageUntilV0_1_28 {
         /// Current Epoch
         pub epoch: Epoch,
 
@@ -97,8 +107,9 @@ mod tests {
         pub next_protocol_parameters: ProtocolParameters,
     }
 
+    // Supported structure until OpenAPI version 0.1.29.
     #[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
-    pub struct EpochSettingsMessagePreviousVersion {
+    pub struct EpochSettingsMessageUntilV0_1_29 {
         /// Current Epoch
         pub epoch: Epoch,
 
@@ -117,8 +128,8 @@ mod tests {
         pub next_signers: Vec<SignerMessagePart>,
     }
 
-    fn golden_legacy_message() -> EpochSettingsMessageLegacyVersion {
-        EpochSettingsMessageLegacyVersion {
+    fn golden_message_until_open_api_0_1_28() -> EpochSettingsMessageUntilV0_1_28 {
+        EpochSettingsMessageUntilV0_1_28 {
             epoch: Epoch(10),
             protocol_parameters: ProtocolParameters {
                 k: 5,
@@ -133,8 +144,8 @@ mod tests {
         }
     }
 
-    fn golden_previous_message() -> EpochSettingsMessagePreviousVersion {
-        EpochSettingsMessagePreviousVersion {
+    fn golden_message_until_open_api_0_1_29() -> EpochSettingsMessageUntilV0_1_29 {
+        EpochSettingsMessageUntilV0_1_29 {
             epoch: Epoch(10),
             protocol_parameters: ProtocolParameters {
                 k: 5,
@@ -190,33 +201,37 @@ mod tests {
                 operational_certificate: Some("certificate_456".to_string()),
                 kes_period: Some(45),
             }],
-            current_cardano_transactions_signing_config: Some(CardanoTransactionsSigningConfig {
+            cardano_transactions_signing_config: Some(CardanoTransactionsSigningConfig {
                 security_parameter: BlockNumber(70),
                 step: BlockNumber(20),
             }),
+            next_cardano_transactions_signing_config: Some(CardanoTransactionsSigningConfig {
+                security_parameter: BlockNumber(50),
+                step: BlockNumber(10),
+            }),
         }
     }
 
-    // Test the backward compatibility with legacy structure.
+    // Test the backward compatibility with the structure supported until OpenAPI version 0.1.28.
     #[test]
-    fn test_actual_json_deserialized_into_legacy_message() {
+    fn test_actual_json_deserialized_into_message_supported_until_open_api_0_1_28() {
         let json = ACTUAL_JSON;
-        let message: EpochSettingsMessageLegacyVersion = serde_json::from_str(json).expect(
-            "This JSON is expected to be successfully parsed into a EpochSettingsMessageLegacyVersion instance.",
+        let message: EpochSettingsMessageUntilV0_1_28 = serde_json::from_str(json).expect(
+            "This JSON is expected to be successfully parsed into a EpochSettingsMessageUntilVersion0_1_28 instance.",
         );
 
-        assert_eq!(golden_legacy_message(), message);
+        assert_eq!(golden_message_until_open_api_0_1_28(), message);
     }
 
-    // Test the backward compatibility with previous structure.
+    // Test the backward compatibility with the structure supported until OpenAPI version 0.1.29.
     #[test]
-    fn test_actual_json_deserialized_into_previous_message() {
+    fn test_actual_json_deserialized_into_message_supported_until_open_api_0_1_29() {
         let json = ACTUAL_JSON;
-        let message: EpochSettingsMessagePreviousVersion = serde_json::from_str(json).expect(
-            "This JSON is expected to be successfully parsed into a EpochSettingsMessagePreviousVersion instance.",
+        let message: EpochSettingsMessageUntilV0_1_29 = serde_json::from_str(json).expect(
+            "This JSON is expected to be successfully parsed into a EpochSettingsMessageUntilVersion0_1_29 instance.",
         );
 
-        assert_eq!(golden_previous_message(), message);
+        assert_eq!(golden_message_until_open_api_0_1_29(), message);
     }
 
     // Test the compatibility with current structure.
diff --git a/openapi.yaml b/openapi.yaml
@@ -55,6 +55,10 @@ paths:
         Returns the information related to the current epoch:
           * protocol parameters for current epoch
           * protocol parameters for next epoch (to setup cryptography, allowing signers to register)
+          * signers for current epoch
+          * signers for next epoch
+          * cardano transactions signing configuration for current epoch
+          * cardano transactions signing configuration for next epoch
       responses:
         "200":
           description: epoch settings found
@@ -733,25 +737,10 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/Signer"
-        current_cardano_transactions_signing_config:
-          description: |
-            Cardano transactions signing configuration for the current epoch
-
-            Mandatory if `signed_entity_types` from the Aggregator configuration contains `CardanoTransactions`.
-          type: object
-          additionalProperties: false
-          required:
-            - security_parameter
-            - step
-          properties:
-            security_parameter:
-              description: Number of blocks to discard from the tip of the chain when importing Cardano transactions
-              type: integer
-              format: int64
-            step:
-              description: Number of blocks between signature of Cardano transactions
-              type: integer
-              format: int64
+        cardano_transactions_signing_config:
+          $ref: "#/components/schemas/CardanoTransactionsSigningConfig"
+        next_cardano_transactions_signing_config:
+          $ref: "#/components/schemas/CardanoTransactionsSigningConfig"
       example:
         {
           "epoch": 329,
@@ -791,8 +780,10 @@ components:
                 "kes_period": 876
               }
             ],
-          "current_cardano_transactions_signing_config":
-            { "security_parameter": 100, "step": 10 }
+          "cardano_transactions_signing_config":
+            { "security_parameter": 100, "step": 10 },
+          "next_cardano_transactions_signing_config":
+            { "security_parameter": 50, "step": 5 }
         }
 
     ProtocolParameters:
@@ -818,6 +809,24 @@ components:
           format: double
       example: { "k": 857, "m": 6172, "phi_f": 0.2 }
 
+    CardanoTransactionsSigningConfig:
+      description: Cardano transactions signing configuration
+      type: object
+      additionalProperties: false
+      required:
+        - security_parameter
+        - step
+      properties:
+        security_parameter:
+          description: Number of blocks to discard from the tip of the chain when importing Cardano transactions
+          type: integer
+          format: int64
+        step:
+          description: Number of blocks between signature of Cardano transactions
+          type: integer
+          format: int64
+      example: { "security_parameter": 100, "step": 10 }
+
     CardanoDbBeacon:
       description: A point in the Cardano chain at which a Mithril certificate of the Cardano Database should be produced
       type: object
