refactor(aggregator) move HumanReadableProtocolConfiguration into tools

Author: turmelclem

mithril-aggregator/src/commands/mod.rs

@@ -15,8 +15,6 @@ use mithril_doc::{Documenter, GenerateDocCommands, StructDoc};
 use slog::{Level, Logger, debug};
 use std::{collections::HashMap, path::PathBuf};
 
-pub use protocol_configuration_command::*;
-
 use crate::{DefaultConfiguration, extract_all};
 
 /// Main command selector

mithril-aggregator/src/commands/protocol_configuration_command.rs

@@ -1,7 +1,7 @@
 use anyhow::Context;
 use clap::{Parser, Subcommand};
 use config::{ConfigBuilder, Map, Value, builder::DefaultState};
-use serde::{Deserialize, Serialize};
+use serde::Deserialize;
 use slog::{Logger, debug};
 use std::{
     collections::{BTreeMap, BTreeSet, HashMap},
@@ -26,7 +26,7 @@ use mithril_common::{
         SignedEntityConfigValidator,
         SignedEntityTypeDiscriminants::{self},
     },
-    messages::SignedEntityTypeDiscriminantsMessage::{self, Known},
+    messages::SignedEntityTypeDiscriminantsMessage::Known,
 };
 use mithril_doc::{Documenter, StructDoc};
 use mithril_protocol_config::model::{
@@ -36,6 +36,7 @@ use mithril_protocol_config::model::{
 use crate::{
     ConfigurationSource, ExecutionEnvironment,
     configuration::ProtocolConfigurationReaderParameters, extract_all,
+    tools::HumanReadableProtocolConfiguration,
 };
 use crate::{dependency_injection::DependenciesBuilder, tools::ProtocolConfigurationTools};
 
@@ -92,65 +93,6 @@ impl ConfigurationSource for ProtocolConfigurationParametersConfiguration {
     }
 }
 
-/// Human readable protocol configuration
-#[derive(Serialize, Deserialize, Clone, PartialEq, Debug)]
-pub struct HumanReadableProtocolConfiguration {
-    pub epoch: Epoch,
-    pub protocol_parameters: ProtocolParameters,
-    pub cardano_transaction_signing_config: Option<CardanoTransactionsSigningConfig>,
-    pub cardano_blocks_transactions_signing_config: Option<CardanoBlocksTransactionsSigningConfig>,
-    pub enabled_signed_entity_types: BTreeSet<SignedEntityTypeDiscriminantsMessage>,
-}
-
-impl HumanReadableProtocolConfiguration {
-    pub fn new(
-        epoch: Epoch,
-        protocol_parameters: ProtocolParameters,
-        cardano_transaction_signing_config: Option<CardanoTransactionsSigningConfig>,
-        cardano_blocks_transactions_signing_config: Option<CardanoBlocksTransactionsSigningConfig>,
-        enabled_signed_entity_types: BTreeSet<SignedEntityTypeDiscriminantsMessage>,
-    ) -> Self {
-        HumanReadableProtocolConfiguration {
-            epoch,
-            protocol_parameters,
-            cardano_transaction_signing_config,
-            cardano_blocks_transactions_signing_config,
-            enabled_signed_entity_types,
-        }
-    }
-
-    pub fn to_vec_human_readable_protocol_configuration(
-        configs: ConfigurationResolverFromMarkers,
-    ) -> Vec<HumanReadableProtocolConfiguration> {
-        let mut human_readable_protocol_configurations = Vec::new();
-        for (epoch, config) in configs.markers {
-            human_readable_protocol_configurations.push(
-                HumanReadableProtocolConfiguration::from_protocol_configuration_for_epoch(
-                    epoch, config,
-                ),
-            );
-        }
-        human_readable_protocol_configurations
-    }
-
-    fn from_protocol_configuration_for_epoch(
-        epoch: Epoch,
-        config: ProtocolConfigurationForEpoch,
-    ) -> HumanReadableProtocolConfiguration {
-        HumanReadableProtocolConfiguration {
-            epoch,
-            protocol_parameters: config.protocol_parameters,
-            enabled_signed_entity_types: config
-                .enabled_signed_entity_types
-                .into_iter()
-                .map(Into::into)
-                .collect(),
-            cardano_transaction_signing_config: config.cardano_transactions,
-            cardano_blocks_transactions_signing_config: config.cardano_blocks_transactions,
-        }
-    }
-}
-
 /// Protocol configuration command
 #[derive(Parser, Debug, Clone)]
 pub struct ProtocolConfigurationCommand {

mithril-aggregator/src/test/double/dummies.rs

@@ -10,7 +10,7 @@ use mithril_common::{
     test::double::{Dummy, fake_data},
 };
 
-use crate::commands::HumanReadableProtocolConfiguration;
+use crate::tools::HumanReadableProtocolConfiguration;
 
 mod record {
     use mithril_common::entities::{ProtocolMessage, SignedEntityType};

mithril-aggregator/src/tools/mod.rs

@@ -14,7 +14,7 @@ pub use era::EraTools;
 #[cfg(feature = "future_snark")]
 pub use genesis::GenesisSignedPayload;
 pub use genesis::GenesisTools;
-pub use protocol_configuration::ProtocolConfigurationTools;
+pub use protocol_configuration::{HumanReadableProtocolConfiguration, ProtocolConfigurationTools};
 pub use single_signature_authenticator::*;
 pub use vacuum_tracker::VacuumTracker;
 

mithril-aggregator/src/tools/protocol_configuration.rs

@@ -1,9 +1,14 @@
-use std::collections::BTreeMap;
+use std::collections::{BTreeMap, BTreeSet};
 
 use anyhow::Context;
 use mithril_cardano_node_chain::entities::{TxDatumBuilder, TxDatumFieldValue};
 use mithril_common::{
-    StdResult, crypto_helper::ProtocolConfigurationMarkersSigner, entities::Epoch,
+    StdResult,
+    crypto_helper::ProtocolConfigurationMarkersSigner,
+    entities::{
+        CardanoBlocksTransactionsSigningConfig, CardanoTransactionsSigningConfig, Epoch,
+        ProtocolParameters,
+    },
     messages::SignedEntityTypeDiscriminantsMessage,
 };
 
@@ -14,13 +19,11 @@ use mithril_protocol_config::{
     },
     model::{ConfigurationResolverFromMarkers, ProtocolConfigurationForEpoch},
 };
+use serde::{Deserialize, Serialize};
 use slog::{Logger, info, warn};
 use thiserror::Error;
 
-use crate::{
-    commands::HumanReadableProtocolConfiguration,
-    dependency_injection::ProtocolConfigurationCommandDependenciesContainer,
-};
+use crate::dependency_injection::ProtocolConfigurationCommandDependenciesContainer;
 
 const EPOCH_OFFSET: u64 = 3;
 const DATUM_MAX_SIZE_KB: usize = 10;
@@ -51,6 +54,65 @@ pub struct ProtocolConfigurationTools {
     logger: Logger,
 }
 
+/// Human readable protocol configuration
+#[derive(Serialize, Deserialize, Clone, PartialEq, Debug)]
+pub struct HumanReadableProtocolConfiguration {
+    pub epoch: Epoch,
+    pub protocol_parameters: ProtocolParameters,
+    pub cardano_transaction_signing_config: Option<CardanoTransactionsSigningConfig>,
+    pub cardano_blocks_transactions_signing_config: Option<CardanoBlocksTransactionsSigningConfig>,
+    pub enabled_signed_entity_types: BTreeSet<SignedEntityTypeDiscriminantsMessage>,
+}
+
+impl HumanReadableProtocolConfiguration {
+    pub fn new(
+        epoch: Epoch,
+        protocol_parameters: ProtocolParameters,
+        cardano_transaction_signing_config: Option<CardanoTransactionsSigningConfig>,
+        cardano_blocks_transactions_signing_config: Option<CardanoBlocksTransactionsSigningConfig>,
+        enabled_signed_entity_types: BTreeSet<SignedEntityTypeDiscriminantsMessage>,
+    ) -> Self {
+        HumanReadableProtocolConfiguration {
+            epoch,
+            protocol_parameters,
+            cardano_transaction_signing_config,
+            cardano_blocks_transactions_signing_config,
+            enabled_signed_entity_types,
+        }
+    }
+
+    pub fn to_vec_human_readable_protocol_configuration(
+        configs: ConfigurationResolverFromMarkers,
+    ) -> Vec<HumanReadableProtocolConfiguration> {
+        let mut human_readable_protocol_configurations = Vec::new();
+        for (epoch, config) in configs.markers {
+            human_readable_protocol_configurations.push(
+                HumanReadableProtocolConfiguration::from_protocol_configuration_for_epoch(
+                    epoch, config,
+                ),
+            );
+        }
+        human_readable_protocol_configurations
+    }
+
+    fn from_protocol_configuration_for_epoch(
+        epoch: Epoch,
+        config: ProtocolConfigurationForEpoch,
+    ) -> HumanReadableProtocolConfiguration {
+        HumanReadableProtocolConfiguration {
+            epoch,
+            protocol_parameters: config.protocol_parameters,
+            enabled_signed_entity_types: config
+                .enabled_signed_entity_types
+                .into_iter()
+                .map(Into::into)
+                .collect(),
+            cardano_transaction_signing_config: config.cardano_transactions,
+            cardano_blocks_transactions_signing_config: config.cardano_blocks_transactions,
+        }
+    }
+}
+
 impl ProtocolConfigurationTools {
     /// Create a new instance of the ProtocolConfigurationTools.
     pub fn new(configuration: ProtocolConfigurationToolsConfiguration, logger: Logger) -> Self {