Merge pull request #1905 from input-output-hk/djo/1898/aggregator_root_route-cardano_transactions_signing_config

Add Cardano transactions signing configuration in Aggregator '/' route

Author: Alenar

.prettierignore

@@ -1,5 +1,6 @@
 demo/protocol-demo/artifacts/
 docs/website/.docusaurus/
+docs/website/build/
 mithril-client-wasm/pkg/
 mithril-explorer/font.css.hbs
 mithril-explorer/out/

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.5.56"
+version = "0.5.57"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-aggregator/Cargo.toml

@@ -53,24 +53,32 @@ mod handlers {
             "root::error"
         );
 
-        let signed_entity_types =
-            signed_entity_config.list_allowed_signed_entity_types_discriminants();
-
-        let cardano_transactions_prover_capabilities = signed_entity_types
+        let mut capabilities = AggregatorCapabilities {
+            signed_entity_types: signed_entity_config
+                .list_allowed_signed_entity_types_discriminants(),
+            cardano_transactions_prover: None,
+            cardano_transactions_signing_config: None,
+        };
+
+        if capabilities
+            .signed_entity_types
             .contains(&SignedEntityTypeDiscriminants::CardanoTransactions)
-            .then_some(CardanoTransactionsProverCapabilities {
-                max_hashes_allowed_by_request: configuration
-                    .cardano_transactions_prover_max_hashes_allowed_by_request,
-            });
+        {
+            capabilities.cardano_transactions_prover =
+                Some(CardanoTransactionsProverCapabilities {
+                    max_hashes_allowed_by_request: configuration
+                        .cardano_transactions_prover_max_hashes_allowed_by_request,
+                });
+
+            capabilities.cardano_transactions_signing_config =
+                Some(configuration.cardano_transactions_signing_config.clone());
+        }
 
         Ok(json(
             &AggregatorFeaturesMessage {
                 open_api_version: open_api_version.to_string(),
                 documentation_url: env!("CARGO_PKG_HOMEPAGE").to_string(),
-                capabilities: AggregatorCapabilities {
-                    signed_entity_types,
-                    cardano_transactions_prover: cardano_transactions_prover_capabilities,
-                },
+                capabilities,
             },
             StatusCode::OK,
         ))
@@ -81,7 +89,9 @@ mod handlers {
 mod tests {
     use crate::http_server::SERVER_BASE_PATH;
     use crate::{initialize_dependencies, DependencyContainer};
-    use mithril_common::entities::SignedEntityTypeDiscriminants;
+    use mithril_common::entities::{
+        BlockNumber, CardanoTransactionsSigningConfig, SignedEntityTypeDiscriminants,
+    };
     use mithril_common::messages::{
         AggregatorCapabilities, AggregatorFeaturesMessage, CardanoTransactionsProverCapabilities,
     };
@@ -150,7 +160,8 @@ mod tests {
                         SignedEntityTypeDiscriminants::CardanoImmutableFilesFull,
                         SignedEntityTypeDiscriminants::MithrilStakeDistribution,
                     ]),
-                    cardano_transactions_prover: None
+                    cardano_transactions_prover: None,
+                    cardano_transactions_signing_config: None,
                 },
             }
         );
@@ -168,7 +179,7 @@ mod tests {
     }
 
     #[tokio::test]
-    async fn test_root_route_ok_with_cardano_transactions_prover_capabilities() {
+    async fn test_root_route_ok_with_cardano_transactions_enabled() {
         let method = Method::GET.as_str();
         let path = "/";
         let mut dependency_manager = initialize_dependencies().await;
@@ -179,6 +190,13 @@ mod tests {
         dependency_manager
             .config
             .cardano_transactions_prover_max_hashes_allowed_by_request = 99;
+        let signing_config = CardanoTransactionsSigningConfig {
+            security_parameter: BlockNumber(70),
+            step: BlockNumber(15),
+        };
+        dependency_manager
+            .config
+            .cardano_transactions_signing_config = signing_config.clone();
 
         let response = request()
             .method(method)
@@ -197,6 +215,12 @@ mod tests {
                 max_hashes_allowed_by_request: 99
             })
         );
+        assert_eq!(
+            response_body
+                .capabilities
+                .cardano_transactions_signing_config,
+            Some(signing_config)
+        );
 
         APISpec::verify_conformity(
             APISpec::get_all_spec_files(),

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

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.4.46"
+version = "0.4.47"
 description = "Common types, interfaces, and utilities for Mithril nodes."
 authors = { workspace = true }
 edition = { workspace = true }

mithril-common/Cargo.toml

@@ -2,7 +2,7 @@ use std::collections::BTreeSet;
 
 use serde::{Deserialize, Serialize};
 
-use crate::entities::SignedEntityTypeDiscriminants;
+use crate::entities::{CardanoTransactionsSigningConfig, SignedEntityTypeDiscriminants};
 
 /// Message advertised by an Aggregator to inform about its features
 #[derive(Debug, Serialize, Deserialize, PartialEq)]
@@ -28,6 +28,7 @@ impl AggregatorFeaturesMessage {
                     SignedEntityTypeDiscriminants::MithrilStakeDistribution,
                 ]),
                 cardano_transactions_prover: None,
+                cardano_transactions_signing_config: None,
             },
         }
     }
@@ -42,6 +43,10 @@ pub struct AggregatorCapabilities {
     /// Cardano transactions prover capabilities
     #[serde(skip_serializing_if = "Option::is_none")]
     pub cardano_transactions_prover: Option<CardanoTransactionsProverCapabilities>,
+
+    /// Cardano transactions signing configuration
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub cardano_transactions_signing_config: Option<CardanoTransactionsSigningConfig>,
 }
 
 /// Cardano transactions prover capabilities
@@ -53,9 +58,40 @@ pub struct CardanoTransactionsProverCapabilities {
 
 #[cfg(test)]
 mod tests {
+    use crate::entities::BlockNumber;
+
     use super::*;
 
-    fn golden_message() -> AggregatorFeaturesMessage {
+    #[derive(Debug, Serialize, Deserialize, PartialEq)]
+    struct AggregatorFeaturesMessagePrevious {
+        pub open_api_version: String,
+        pub documentation_url: String,
+        pub capabilities: AggregatorCapabilitiesPrevious,
+    }
+
+    #[derive(Debug, Serialize, Deserialize, PartialEq)]
+    struct AggregatorCapabilitiesPrevious {
+        pub signed_entity_types: BTreeSet<SignedEntityTypeDiscriminants>,
+        #[serde(skip_serializing_if = "Option::is_none")]
+        pub cardano_transactions_prover: Option<CardanoTransactionsProverCapabilities>,
+    }
+
+    fn golden_message_previous() -> AggregatorFeaturesMessagePrevious {
+        AggregatorFeaturesMessagePrevious {
+            open_api_version: "0.0.1".to_string(),
+            documentation_url: "https://example.com".to_string(),
+            capabilities: AggregatorCapabilitiesPrevious {
+                signed_entity_types: BTreeSet::from([
+                    SignedEntityTypeDiscriminants::CardanoTransactions,
+                ]),
+                cardano_transactions_prover: Some(CardanoTransactionsProverCapabilities {
+                    max_hashes_allowed_by_request: 100,
+                }),
+            },
+        }
+    }
+
+    fn golden_message_actual() -> AggregatorFeaturesMessage {
         AggregatorFeaturesMessage {
             open_api_version: "0.0.1".to_string(),
             documentation_url: "https://example.com".to_string(),
@@ -66,26 +102,43 @@ mod tests {
                 cardano_transactions_prover: Some(CardanoTransactionsProverCapabilities {
                     max_hashes_allowed_by_request: 100,
                 }),
+                cardano_transactions_signing_config: Some(CardanoTransactionsSigningConfig {
+                    security_parameter: BlockNumber(70),
+                    step: BlockNumber(20),
+                }),
             },
         }
     }
 
+    const ACTUAL_JSON: &str = r#"{
+        "open_api_version": "0.0.1",
+        "documentation_url": "https://example.com",
+        "capabilities": {
+            "signed_entity_types": ["CardanoTransactions"],
+            "cardano_transactions_prover": {
+                "max_hashes_allowed_by_request": 100
+            },
+            "cardano_transactions_signing_config": {
+                "security_parameter": 70,
+                "step": 20
+            }
+        }
+    }"#;
+
     // Test the retro compatibility with possible future upgrades.
     #[test]
-    fn test_v1() {
-        let json = r#"{
-            "open_api_version": "0.0.1",
-            "documentation_url": "https://example.com",
-            "capabilities": {
-                "signed_entity_types": ["CardanoTransactions"],
-                "cardano_transactions_prover": {
-                    "max_hashes_allowed_by_request": 100
-                }
-            }
-        }"#;
+    fn test_actual_json_deserialized_into_previous_message() {
+        let json = ACTUAL_JSON;
+        let message: AggregatorFeaturesMessagePrevious = serde_json::from_str(json).unwrap();
 
+        assert_eq!(golden_message_previous(), message);
+    }
+
+    #[test]
+    fn test_actual_json_deserialized_into_actual_message() {
+        let json = ACTUAL_JSON;
         let message: AggregatorFeaturesMessage = serde_json::from_str(json).unwrap();
 
-        assert_eq!(golden_message(), message);
+        assert_eq!(golden_message_actual(), message);
     }
 }

mithril-common/src/messages/aggregator_features.rs

@@ -4,7 +4,7 @@ info:
   # `mithril-common/src/lib.rs` file. If you plan to update it
   # here to reflect changes in the API, please also update the constant in the
   # Rust file.
-  version: 0.1.27
+  version: 0.1.28
   title: Mithril Aggregator Server
   description: |
     The REST API provided by a Mithril Aggregator Node in a Mithril network.
@@ -663,6 +663,25 @@ components:
                   description: Maximum number of hashes allowed for a single request
                   type: integer
                   format: int64
+            cardano_transactions_signing_config:
+              description: |
+                Cardano transactions signing configuration
+
+                Mandatory if `signed_entity_types` 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
       example:
         {
           "open_api_version": "0.1.17",
@@ -676,7 +695,9 @@ components:
                   "CardanoTransactions"
                 ],
               "cardano_transactions_prover":
-                { "max_hashes_allowed_by_request": 100 }
+                { "max_hashes_allowed_by_request": 100 },
+              "cardano_transactions_signing_config":
+                { "security_parameter": 100, "step": 10 }
             }
         }