refactor(protocol-config, signer): rename EpochConfiguration to MithrilNetworkConfigurationForEpoch

Author: turmelclem

internal/mithril-protocol-config/src/http_client/http_impl.rs

@@ -9,7 +9,7 @@ use mithril_common::entities::Epoch;
 use mithril_common::messages::ProtocolConfigurationMessage;
 
 use crate::interface::MithrilNetworkConfigurationProvider;
-use crate::model::{EpochConfiguration, MithrilNetworkConfiguration};
+use crate::model::{MithrilNetworkConfiguration, MithrilNetworkConfigurationForEpoch};
 
 /// Trait to retrieve protocol configuration
 #[cfg_attr(test, mockall::automock)]
@@ -49,7 +49,7 @@ impl MithrilNetworkConfigurationProvider for HttpMithrilNetworkConfigurationProv
         let next_aggregation_epoch = epoch.offset_to_next_signer_retrieval_epoch();
         let registration_epoch = epoch.offset_to_next_signer_retrieval_epoch().next();
 
-        let configuration_for_aggregation: EpochConfiguration = self
+        let configuration_for_aggregation: MithrilNetworkConfigurationForEpoch = self
             .protocol_configuration_retriever
             .retrieve_protocol_configuration(aggregation_epoch)
             .await?

internal/mithril-protocol-config/src/model.rs

@@ -24,20 +24,20 @@ pub struct MithrilNetworkConfiguration {
     pub epoch: Epoch,
 
     /// Configuration for aggregation
-    pub configuration_for_aggregation: EpochConfiguration,
+    pub configuration_for_aggregation: MithrilNetworkConfigurationForEpoch,
 
     /// Configuration for next aggregation
-    pub configuration_for_next_aggregation: EpochConfiguration,
+    pub configuration_for_next_aggregation: MithrilNetworkConfigurationForEpoch,
 
     /// Configuration for registration
-    pub configuration_for_registration: EpochConfiguration,
+    pub configuration_for_registration: MithrilNetworkConfigurationForEpoch,
 }
 
 //A epoch configuration
 #[derive(PartialEq, Clone, Debug)]
 
 /// A network configuration available for an epoch
-pub struct EpochConfiguration {
+pub struct MithrilNetworkConfigurationForEpoch {
     /// Cryptographic protocol parameters (`k`, `m` and `phi_f`)
     pub protocol_parameters: ProtocolParameters,
 
@@ -48,9 +48,9 @@ pub struct EpochConfiguration {
     pub signed_entity_types_config: SignedEntityTypeConfiguration,
 }
 
-impl From<ProtocolConfigurationMessage> for EpochConfiguration {
+impl From<ProtocolConfigurationMessage> for MithrilNetworkConfigurationForEpoch {
     fn from(message: ProtocolConfigurationMessage) -> Self {
-        EpochConfiguration {
+        MithrilNetworkConfigurationForEpoch {
             protocol_parameters: message.protocol_parameters,
             enabled_signed_entity_types: message.available_signed_entity_types,
             signed_entity_types_config: SignedEntityTypeConfiguration {

internal/mithril-protocol-config/src/test/double/configuration_provider.rs

@@ -4,29 +4,29 @@ use tokio::sync::RwLock;
 
 use crate::{
     interface::MithrilNetworkConfigurationProvider,
-    model::{EpochConfiguration, MithrilNetworkConfiguration},
+    model::{MithrilNetworkConfigurationForEpoch, MithrilNetworkConfiguration},
 };
 use async_trait::async_trait;
 use mithril_common::{StdResult, entities::Epoch};
 
 /// A fake [MithrilNetworkConfigurationProvider] that return [MithrilNetworkConfiguration]
 pub struct FakeMithrilNetworkConfigurationProvider {
     /// Configuration for aggregation
-    pub configuration_for_aggregation: RwLock<EpochConfiguration>,
+    pub configuration_for_aggregation: RwLock<MithrilNetworkConfigurationForEpoch>,
 
     /// Configuration for next aggregation
-    pub configuration_for_next_aggregation: RwLock<EpochConfiguration>,
+    pub configuration_for_next_aggregation: RwLock<MithrilNetworkConfigurationForEpoch>,
 
     /// Configuration for registration
-    pub configuration_for_registration: RwLock<EpochConfiguration>,
+    pub configuration_for_registration: RwLock<MithrilNetworkConfigurationForEpoch>,
 }
 
 impl FakeMithrilNetworkConfigurationProvider {
     /// FakeMithrilNetworkConfigurationProvider factory
     pub fn new(
-        configuration_for_aggregation: EpochConfiguration,
-        configuration_for_next_aggregation: EpochConfiguration,
-        configuration_for_registration: EpochConfiguration,
+        configuration_for_aggregation: MithrilNetworkConfigurationForEpoch,
+        configuration_for_next_aggregation: MithrilNetworkConfigurationForEpoch,
+        configuration_for_registration: MithrilNetworkConfigurationForEpoch,
     ) -> Self {
         Self {
             configuration_for_aggregation: RwLock::new(configuration_for_aggregation),
@@ -36,7 +36,7 @@ impl FakeMithrilNetworkConfigurationProvider {
     }
 
     ///Change the configuration of the aggregation
-    pub async fn change_aggregation_configuration(&self, conf: EpochConfiguration) {
+    pub async fn change_aggregation_configuration(&self, conf: MithrilNetworkConfigurationForEpoch) {
         let mut configuration_for_aggregation = self.configuration_for_aggregation.write().await;
         *configuration_for_aggregation = conf;
     }
@@ -75,13 +75,13 @@ mod tests {
 
     use crate::{
         interface::MithrilNetworkConfigurationProvider,
-        model::{EpochConfiguration, SignedEntityTypeConfiguration},
+        model::{MithrilNetworkConfigurationForEpoch, SignedEntityTypeConfiguration},
         test::double::configuration_provider::FakeMithrilNetworkConfigurationProvider,
     };
 
     #[tokio::test]
     async fn test_get_network_configuration() {
-        let configuration_for_aggregation = EpochConfiguration {
+        let configuration_for_aggregation = MithrilNetworkConfigurationForEpoch {
             protocol_parameters: ProtocolParameters {
                 k: 1,
                 m: 11,
@@ -96,7 +96,7 @@ mod tests {
             },
         };
 
-        let configuration_for_next_aggregation = EpochConfiguration {
+        let configuration_for_next_aggregation = MithrilNetworkConfigurationForEpoch {
             protocol_parameters: ProtocolParameters {
                 k: 2,
                 m: 22,
@@ -111,7 +111,7 @@ mod tests {
             },
         };
 
-        let configuration_for_registration = EpochConfiguration {
+        let configuration_for_registration = MithrilNetworkConfigurationForEpoch {
             protocol_parameters: ProtocolParameters {
                 k: 3,
                 m: 33,

internal/mithril-protocol-config/src/test/double/dummies.rs

@@ -6,7 +6,7 @@ use mithril_common::{
 };
 
 use crate::model::{
-    EpochConfiguration, MithrilNetworkConfiguration, SignedEntityTypeConfiguration,
+    MithrilNetworkConfigurationForEpoch, MithrilNetworkConfiguration, SignedEntityTypeConfiguration,
 };
 
 impl Dummy for MithrilNetworkConfiguration {
@@ -16,14 +16,14 @@ impl Dummy for MithrilNetworkConfiguration {
 
         Self {
             epoch: beacon.epoch,
-            configuration_for_aggregation: EpochConfiguration::dummy(),
-            configuration_for_next_aggregation: EpochConfiguration::dummy(),
-            configuration_for_registration: EpochConfiguration::dummy(),
+            configuration_for_aggregation: MithrilNetworkConfigurationForEpoch::dummy(),
+            configuration_for_next_aggregation: MithrilNetworkConfigurationForEpoch::dummy(),
+            configuration_for_registration: MithrilNetworkConfigurationForEpoch::dummy(),
         }
     }
 }
 
-impl Dummy for EpochConfiguration {
+impl Dummy for MithrilNetworkConfigurationForEpoch {
     /// Return a dummy for [EpochConfiguration] (test-only).
     fn dummy() -> Self {
         Self {

mithril-signer/src/runtime/runner.rs

@@ -372,7 +372,7 @@ impl Runner for SignerRunner {
 
 #[cfg(test)]
 mod tests {
-    use mithril_protocol_config::model::EpochConfiguration;
+    use mithril_protocol_config::model::MithrilNetworkConfigurationForEpoch;
     use mockall::mock;
     use mockall::predicate::eq;
     use std::collections::BTreeSet;
@@ -557,9 +557,9 @@ mod tests {
         ));
         let kes_signer = None;
 
-        let configuration_for_aggregation = EpochConfiguration::dummy();
-        let configuration_for_next_aggregation = EpochConfiguration::dummy();
-        let configuration_for_registration = EpochConfiguration::dummy();
+        let configuration_for_aggregation = MithrilNetworkConfigurationForEpoch::dummy();
+        let configuration_for_next_aggregation = MithrilNetworkConfigurationForEpoch::dummy();
+        let configuration_for_registration = MithrilNetworkConfigurationForEpoch::dummy();
 
         let network_configuration_service = Arc::new(FakeMithrilNetworkConfigurationProvider::new(
             configuration_for_aggregation,
@@ -776,7 +776,7 @@ mod tests {
 
         let mithril_network_configuration = MithrilNetworkConfiguration {
             epoch,
-            configuration_for_aggregation: EpochConfiguration {
+            configuration_for_aggregation: MithrilNetworkConfigurationForEpoch {
                 enabled_signed_entity_types: BTreeSet::from([
                     SignedEntityTypeDiscriminants::MithrilStakeDistribution,
                     SignedEntityTypeDiscriminants::CardanoTransactions,

mithril-signer/src/services/cardano_transactions/preloader_checker.rs

@@ -55,7 +55,9 @@ mod tests {
         entities::{Epoch, SignedEntityTypeDiscriminants, TimePoint},
         test::double::Dummy,
     };
-    use mithril_protocol_config::model::{EpochConfiguration, MithrilNetworkConfiguration};
+    use mithril_protocol_config::model::{
+        MithrilNetworkConfiguration, MithrilNetworkConfigurationForEpoch,
+    };
     use mockall::mock;
     use std::collections::BTreeSet;
 
@@ -88,7 +90,7 @@ mod tests {
             .times(1)
             .returning(|_| {
                 Ok(MithrilNetworkConfiguration {
-                    configuration_for_aggregation: EpochConfiguration {
+                    configuration_for_aggregation: MithrilNetworkConfigurationForEpoch {
                         enabled_signed_entity_types: BTreeSet::from([
                             SignedEntityTypeDiscriminants::MithrilStakeDistribution,
                         ]),
@@ -122,7 +124,7 @@ mod tests {
             .times(1)
             .returning(|_| {
                 Ok(MithrilNetworkConfiguration {
-                    configuration_for_aggregation: EpochConfiguration {
+                    configuration_for_aggregation: MithrilNetworkConfigurationForEpoch {
                         enabled_signed_entity_types: BTreeSet::from([
                             SignedEntityTypeDiscriminants::CardanoTransactions,
                         ]),

mithril-signer/src/services/epoch_service.rs

@@ -437,7 +437,7 @@ mod tests {
         double::{Dummy, fake_data},
     };
 
-    use mithril_protocol_config::model::{EpochConfiguration, SignedEntityTypeConfiguration};
+    use mithril_protocol_config::model::{MithrilNetworkConfigurationForEpoch, SignedEntityTypeConfiguration};
 
     use crate::database::repository::{ProtocolInitializerRepository, StakePoolStore};
     use crate::database::test_helper::main_db_connection;
@@ -486,7 +486,7 @@ mod tests {
         let epoch = Epoch(12);
         let mithril_network_configuration = MithrilNetworkConfiguration {
             epoch,
-            configuration_for_aggregation: EpochConfiguration {
+            configuration_for_aggregation: MithrilNetworkConfigurationForEpoch {
                 enabled_signed_entity_types: BTreeSet::new(),
                 ..Dummy::dummy()
             },
@@ -673,7 +673,7 @@ mod tests {
         let epoch = Epoch(12);
         let mithril_network_configuration = MithrilNetworkConfiguration {
             epoch,
-            configuration_for_aggregation: EpochConfiguration {
+            configuration_for_aggregation: MithrilNetworkConfigurationForEpoch {
                 enabled_signed_entity_types: BTreeSet::from([
                     SignedEntityTypeDiscriminants::CardanoImmutableFilesFull,
                 ]),
@@ -790,7 +790,7 @@ mod tests {
         // MithrilNetworkConfiguration
         let mithril_network_configuration = MithrilNetworkConfiguration {
             epoch,
-            configuration_for_aggregation: EpochConfiguration {
+            configuration_for_aggregation: MithrilNetworkConfigurationForEpoch {
                 enabled_signed_entity_types: BTreeSet::new(),
                 ..Dummy::dummy()
             },
@@ -863,7 +863,7 @@ mod tests {
 
         let mithril_network_configuration = MithrilNetworkConfiguration {
             epoch,
-            configuration_for_aggregation: EpochConfiguration {
+            configuration_for_aggregation: MithrilNetworkConfigurationForEpoch {
                 enabled_signed_entity_types: BTreeSet::new(),
                 ..Dummy::dummy()
             },
@@ -909,14 +909,14 @@ mod tests {
             let current_signers = signers[1..3].to_vec();
             let next_signers = signers[2..5].to_vec();
 
-            let configuration_for_aggregation = EpochConfiguration {
+            let configuration_for_aggregation = MithrilNetworkConfigurationForEpoch {
                 signed_entity_types_config: SignedEntityTypeConfiguration {
                     cardano_transactions: None,
                 },
                 enabled_signed_entity_types: BTreeSet::new(),
                 ..Dummy::dummy()
             };
-            let configuration_for_next_aggregation = EpochConfiguration::dummy();
+            let configuration_for_next_aggregation = MithrilNetworkConfigurationForEpoch::dummy();
 
             epoch_service
                 .write()
@@ -944,7 +944,7 @@ mod tests {
             let allowed_discriminants =
                 BTreeSet::from([SignedEntityTypeDiscriminants::CardanoImmutableFilesFull]);
 
-            let configuration_for_aggregation = EpochConfiguration {
+            let configuration_for_aggregation = MithrilNetworkConfigurationForEpoch {
                 enabled_signed_entity_types: allowed_discriminants.clone(),
                 ..Dummy::dummy()
             };

mithril-signer/tests/test_extensions/state_machine_tester.rs

@@ -2,7 +2,7 @@
 use anyhow::anyhow;
 use mithril_metric::{MetricCollector, MetricsServiceExporter};
 use mithril_protocol_config::{
-    model::{EpochConfiguration, SignedEntityTypeConfiguration},
+    model::{MithrilNetworkConfigurationForEpoch, SignedEntityTypeConfiguration},
     test::double::configuration_provider::FakeMithrilNetworkConfigurationProvider,
 };
 use prometheus_parse::Value;
@@ -175,17 +175,17 @@ impl StateMachineTester {
             ticker_service.clone(),
         ));
 
-        let configuration_for_aggregation = EpochConfiguration {
+        let configuration_for_aggregation = MithrilNetworkConfigurationForEpoch {
             signed_entity_types_config: SignedEntityTypeConfiguration {
                 cardano_transactions: Some(cardano_transactions_signing_config.clone()),
             },
             enabled_signed_entity_types: SignedEntityTypeDiscriminants::all(),
             ..Dummy::dummy()
         };
 
-        let configuration_for_next_aggregation = EpochConfiguration::dummy();
+        let configuration_for_next_aggregation = MithrilNetworkConfigurationForEpoch::dummy();
 
-        let configuration_for_registration = EpochConfiguration {
+        let configuration_for_registration = MithrilNetworkConfigurationForEpoch {
             protocol_parameters: fake_data::protocol_parameters(),
             ..Dummy::dummy()
         };
@@ -486,7 +486,7 @@ impl StateMachineTester {
         &mut self,
         discriminants: &[SignedEntityTypeDiscriminants],
     ) -> &mut Self {
-        let config = EpochConfiguration {
+        let config = MithrilNetworkConfigurationForEpoch {
             enabled_signed_entity_types: BTreeSet::from_iter(discriminants.iter().cloned()),
             ..self
                 .network_configuration_service