feature(aggregator, common, openapi): improve protocol-configuration route with Cardano block and transaction signing configuration, put CardanoBlocksTransactions in SignedEntityTypeDiscriminants 'all' function

Author: turmelclem

mithril-aggregator/src/services/message.rs

@@ -225,9 +225,16 @@ impl MessageService for MithrilMessageService {
         let cardano_transactions_signing_config = cardano_transactions_discriminant
             .and(epoch_settings.cardano_transactions_signing_config);
 
+        let cardano_blocks_transactions_discriminant =
+            enabled_discriminants.get(&SignedEntityTypeDiscriminants::CardanoBlocksTransactions);
+
+        let cardano_blocks_transactions_signing_config = cardano_blocks_transactions_discriminant
+            .and(epoch_settings.cardano_blocks_transactions_signing_config);
+
         let protocol_configuration_message = ProtocolConfigurationMessage {
             protocol_parameters: epoch_settings.protocol_parameters,
             cardano_transactions_signing_config,
+            cardano_blocks_transactions_signing_config,
             available_signed_entity_types: enabled_discriminants,
         };
         Ok(Some(protocol_configuration_message))
@@ -696,7 +703,10 @@ mod tests {
     mod protocol_configuration {
         use super::*;
 
-        use mithril_common::entities::{CardanoTransactionsSigningConfig, ProtocolParameters};
+        use mithril_common::entities::{
+            CardanoBlocksTransactionsSigningConfig, CardanoTransactionsSigningConfig,
+            ProtocolParameters,
+        };
 
         use crate::entities::AggregatorEpochSettings;
 
@@ -706,9 +716,15 @@ mod tests {
             let aggregator_epoch_settings = AggregatorEpochSettings {
                 protocol_parameters: ProtocolParameters::new(5, 100, 0.65),
                 cardano_transactions_signing_config: Some(CardanoTransactionsSigningConfig {
-                    security_parameter: BlockNumber(0),
+                    security_parameter: BlockNumber(10),
                     step: BlockNumber(15),
                 }),
+                cardano_blocks_transactions_signing_config: Some(
+                    CardanoBlocksTransactionsSigningConfig {
+                        security_parameter: BlockNumber(20),
+                        step: BlockNumber(30),
+                    },
+                ),
             };
             let message_service = MessageServiceBuilder::new()
                 .with_epoch_settings(BTreeMap::from([(epoch, aggregator_epoch_settings)]))
@@ -728,10 +744,17 @@ mod tests {
             assert_eq!(
                 message.cardano_transactions_signing_config,
                 Some(CardanoTransactionsSigningConfig {
-                    security_parameter: BlockNumber(0),
+                    security_parameter: BlockNumber(10),
                     step: BlockNumber(15)
                 })
             );
+            assert_eq!(
+                message.cardano_blocks_transactions_signing_config,
+                Some(CardanoBlocksTransactionsSigningConfig {
+                    security_parameter: BlockNumber(20),
+                    step: BlockNumber(30)
+                })
+            );
             assert_eq!(
                 message.available_signed_entity_types,
                 SignedEntityTypeDiscriminants::all()

mithril-common/src/entities/signed_entity_type.rs

@@ -195,8 +195,7 @@ impl SignedEntityTypeDiscriminants {
     }
 
     fn iter_all() -> impl Iterator<Item = Self> {
-        // Temporarily exclude CardanoBlocksTransactions until it can be derived from a TimePoint in SignedEntityConfig
-        Self::iter().filter(|&d| d != Self::CardanoBlocksTransactions)
+        Self::iter()
     }
 
     /// Get the database value from enum's instance
@@ -570,6 +569,7 @@ mod tests {
                 SignedEntityTypeDiscriminants::CardanoImmutableFilesFull,
                 SignedEntityTypeDiscriminants::CardanoDatabase,
                 SignedEntityTypeDiscriminants::CardanoTransactions,
+                SignedEntityTypeDiscriminants::CardanoBlocksTransactions,
             ]
         );
     }

openapi.yaml

@@ -1035,6 +1035,7 @@ components:
         - CardanoStakeDistribution
         - CardanoImmutableFilesFull
         - CardanoTransactions
+        - CardanoBlocksTransactions
         - CardanoDatabase
 
     EpochSettingsMessage:
@@ -1116,6 +1117,8 @@ components:
           $ref: "#/components/schemas/ProtocolParameters"
         cardano_transactions_signing_config:
           $ref: "#/components/schemas/CardanoTransactionsSigningConfig"
+        cardano_blocks_transactions_signing_config:
+          $ref: "#/components/schemas/CardanoBlocksTransactionsSigningConfig"
         available_signed_entity_types:
           description: Available signed entity types that are signed by the aggregator
           type: array
@@ -1131,7 +1134,8 @@ components:
               [
                 "MithrilStakeDistribution",
                 "CardanoImmutableFilesFull",
-                "CardanoTransactions"
+                "CardanoTransactions",
+                "CardanoBlocksTransactions"
               ]
           }
 
@@ -1178,6 +1182,25 @@ components:
       examples:
         - { "security_parameter": 100, "step": 10 }
 
+    CardanoBlocksTransactionsSigningConfig:
+      description: Cardano blocks and 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 blocks and transactions
+          type: integer
+          format: int64
+        step:
+          description: Number of blocks between signature of Cardano blocks and transactions
+          type: integer
+          format: int64
+      examples:
+        - { "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