feature(aggretor, protocol-config): cleanning builder adapter mecanism, and rework protocol-configuration command parameters

Author: turmelclem

internal/mithril-protocol-config/src/adapters/builder.rs

@@ -1,12 +1,7 @@
 //! Module dedicated to ProtocolConfigurationReaderAdapter implementations.
 
-mod builder;
 mod cardano_chain;
 
-pub use builder::{
-    AdapterBuilder as ProtocolConfigurationReaderAdapterBuilder,
-    AdapterType as ProtocolConfigurationReaderAdapterType,
-};
 pub use cardano_chain::{
     CardanoChainAdapter as ProtocolConfigurationReaderCardanoChainAdapter,
     ProtocolConfigurationMarkersPayload as ProtocolConfigurationMarkersPayloadCardanoChain,

internal/mithril-protocol-config/src/adapters/mod.rs

@@ -13,6 +13,7 @@ use std::{
 use thiserror::Error;
 
 use mithril_cardano_node_chain::chain_observer::ChainObserverType;
+use mithril_cli_helper::serde_deserialization;
 use mithril_common::StdResult;
 use mithril_common::crypto_helper::{
     ProtocolConfigurationMarkersSigner, ProtocolConfigurationMarkersVerifierSecretKey,
@@ -24,7 +25,10 @@ use mithril_common::entities::{
 };
 use mithril_doc::{Documenter, StructDoc};
 
-use crate::{ConfigurationSource, ExecutionEnvironment, extract_all};
+use crate::{
+    ConfigurationSource, ExecutionEnvironment,
+    configuration::ProtocolConfigurationReaderParameters, extract_all,
+};
 use crate::{dependency_injection::DependenciesBuilder, tools::ProtocolConfigurationTools};
 
 #[derive(Debug, Error)]
@@ -38,27 +42,32 @@ pub enum UserConfImportVerificationError {
 
 #[derive(Debug, Clone, Deserialize, Documenter)]
 pub struct ProtocolConfigurationParametersConfiguration {
-    /// Cardano Network Magic number
-    ///
-    /// useful for TestNet & DevNet
-    #[example = "`1097911063` or `42`"]
-    pub network_magic: Option<u64>,
+    /// Path of the socket opened by the Cardano node
+    #[example = "`/ipc/node.socket`"]
+    pub cardano_node_socket_path: PathBuf,
 
     /// Cardano network
     #[example = "`mainnet` or `preprod` or `devnet`"]
     network: String,
 
     /// Cardano chain observer type
     pub chain_observer_type: ChainObserverType,
+
+    /// Protocol configuration Reader Adapter Parameters
+    #[example = "\
+    `{ \"address\": \"address\", \"verification_key\": \"key\" }`\
+    "]
+    #[serde(deserialize_with = "serde_deserialization::string_or_struct")]
+    pub protocol_configuration_reader_adapter_params: ProtocolConfigurationReaderParameters,
 }
 
 impl ConfigurationSource for ProtocolConfigurationParametersConfiguration {
     fn environment(&self) -> ExecutionEnvironment {
         ExecutionEnvironment::Production
     }
 
-    fn network_magic(&self) -> Option<u64> {
-        self.network_magic
+    fn cardano_node_socket_path(&self) -> PathBuf {
+        self.cardano_node_socket_path.clone()
     }
 
     fn network(&self) -> String {
@@ -69,8 +78,8 @@ impl ConfigurationSource for ProtocolConfigurationParametersConfiguration {
         self.chain_observer_type.clone()
     }
 
-    fn store_retention_limit(&self) -> Option<usize> {
-        None
+    fn protocol_configuration_reader_parameters(&self) -> ProtocolConfigurationReaderParameters {
+        self.protocol_configuration_reader_adapter_params.clone()
     }
 }
 
@@ -103,15 +112,6 @@ impl HumanReadableProtocolConfiguration {
 
 #[derive(Parser, Debug, Clone)]
 pub struct ProtocolConfigurationCommand {
-    /// Protocol configuration reader adapter type
-    #[clap(long, env = "PROTOCOL_CONFIGURATION_READER_ADAPTER_TYPE")]
-    pub protocol_configuration_reader_adapter_type: String,
-
-    /// Protocol configation reader adapter parameters
-    /// example {"address":"your-address","verification_key":"your-verification-key"}
-    #[clap(long, env = "PROTOCOL_CONFIGURATION_READER_ADAPTER_PARAMS")]
-    pub protocol_configuration_reader_adapter_params: String,
-
     /// commands
     #[clap(subcommand)]
     pub protocol_configuration_sub_command: ProtocolConfigurationSubCommand,
@@ -243,7 +243,6 @@ impl ImportProtocolConfigurationSubCommand {
         let tools = ProtocolConfigurationTools::from_dependencies(dependencies)
             .await
             .with_context(|| "protocol-configuration-tools: initialization error")?;
-
         tools.verify_configurations_against_chain(protocol_configurations.clone())?;
 
         //4 - Generate Tx datum
@@ -410,7 +409,7 @@ mod tests {
         ImportProtocolConfigurationSubCommand::try_parse_from([
             "import-markers",
             "--import-path",
-            "tests/human_readable_protocol_configuration.json",
+            "tests/human_readable_protocol_configuration_toto.json",
             "--target-path",
             "/tests/protocol_configuration_tx_datum",
             "--protocol-configuration-markers-secret-key",

mithril-aggregator/src/commands/protocol_configuration_command.rs

@@ -4,13 +4,14 @@ use std::str::FromStr;
 
 use anyhow::Context;
 use config::{ConfigError, Map, Source, Value, ValueKind};
-use mithril_protocol_config::adapters::ProtocolConfigurationReaderAdapterType;
 use semver::Version;
 use serde::Deserialize;
 
 use mithril_cardano_node_chain::chain_observer::ChainObserverType;
 use mithril_cli_helper::{register_config_value, serde_deserialization};
-use mithril_common::crypto_helper::{GenesisEd25519Signer, ManifestSigner};
+use mithril_common::crypto_helper::{
+    GenesisEd25519Signer, ManifestSigner, ProtocolConfigurationMarkersVerifierVerificationKey,
+};
 use mithril_common::entities::{
     BlockNumber, BlockNumberOffset, CardanoBlocksTransactionsSigningConfig,
     CardanoTransactionsSigningConfig, CompressionAlgorithm, ConfigSecret,
@@ -197,14 +198,9 @@ pub trait ConfigurationSource {
         panic!("era_reader_adapter_params is not implemented.");
     }
 
-    /// Protocol configuration reader adapter type
-    fn protocol_configuration_reader_adapter_type(&self) -> ProtocolConfigurationReaderAdapterType {
-        panic!("protocol_configuration_reader_adapter_type is not implemented.");
-    }
-
     /// Protocol configuration reader adapter parameters
-    fn protocol_configuration_reader_adapter_params(&self) -> Option<String> {
-        panic!("protocol_configuration_reader_adapter_params is not implemented.");
+    fn protocol_configuration_reader_parameters(&self) -> ProtocolConfigurationReaderParameters {
+        panic!("protocol_configuration_reader_parameters is not implemented.");
     }
 
     /// Configuration of the ancillary files signer
@@ -783,6 +779,24 @@ impl FromStr for AncillaryFilesSignerConfig {
     }
 }
 
+/// Configuration of the protocol Configuration Reader
+#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
+pub struct ProtocolConfigurationReaderParameters {
+    /// Address
+    pub address: String,
+
+    /// Verification key
+    pub verification_key: ProtocolConfigurationMarkersVerifierVerificationKey,
+}
+
+impl FromStr for ProtocolConfigurationReaderParameters {
+    type Err = serde_json::Error;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        serde_json::from_str(s)
+    }
+}
+
 impl ServeCommandConfiguration {
     /// Create a sample configuration mainly for tests
     pub fn new_sample(tmp_path: PathBuf) -> Self {

mithril-aggregator/src/configuration.rs

@@ -410,7 +410,6 @@ impl DependenciesBuilder {
             signer_registration_round_opener: self.get_signer_registration_round_opener().await?,
             era_checker: self.get_era_checker().await?,
             era_reader: self.get_era_reader().await?,
-            protocol_configuration_reader: self.get_protocol_configuration_reader().await?,
             event_transmitter: self.get_event_transmitter().await?,
             api_version_provider: self.get_api_version_provider().await?,
             stake_distribution_service: self.get_stake_distribution_service().await?,

mithril-aggregator/src/dependency_injection/builder/mod.rs

@@ -4,7 +4,7 @@ use mithril_common::api_version::APIVersionProvider;
 use mithril_common::entities::{Epoch, SupportedEra};
 use mithril_era::adapters::{EraReaderAdapterBuilder, EraReaderDummyAdapter};
 use mithril_era::{EraChecker, EraMarker, EraReader, EraReaderAdapter};
-use mithril_protocol_config::adapters::ProtocolConfigurationReaderAdapterBuilder;
+use mithril_protocol_config::adapters::ProtocolConfigurationReaderCardanoChainAdapter;
 use mithril_protocol_config::test::double::ProtocolConfigurationReaderDummyAdapter;
 use mithril_protocol_config::{ProtocolConfigurationReader, ProtocolConfigurationReaderAdapter};
 
@@ -91,16 +91,14 @@ impl DependenciesBuilder {
     ) -> Result<Arc<ProtocolConfigurationReader>> {
         let protocol_configuration_adapter: Arc<dyn ProtocolConfigurationReaderAdapter> =
             match self.configuration.environment() {
-                ExecutionEnvironment::Production => ProtocolConfigurationReaderAdapterBuilder::new(
-                    &self.configuration.protocol_configuration_reader_adapter_type(),
-                    &self.configuration.protocol_configuration_reader_adapter_params(),
-                )
-                .build(self.get_chain_observer().await?)
-                .map_err(|e| DependenciesBuilderError::Initialization {
-                    message: "Could not build ProtocolConfigurationReader as dependency."
-                        .to_string(),
-                    error: Some(e.into()),
-                })?,
+                ExecutionEnvironment::Production => {
+                    let parameters = self.configuration.protocol_configuration_reader_parameters();
+                    Arc::new(ProtocolConfigurationReaderCardanoChainAdapter::new(
+                        parameters.address,
+                        self.get_chain_observer().await?,
+                        parameters.verification_key,
+                    ))
+                }
                 _ => Arc::new(ProtocolConfigurationReaderDummyAdapter::from_markers(
                     vec![], //TODO
                 )),

mithril-aggregator/src/dependency_injection/builder/support/compatibility.rs

@@ -1,4 +1,3 @@
-use mithril_protocol_config::ProtocolConfigurationReader;
 use slog::Logger;
 use std::sync::Arc;
 use tokio::sync::RwLock;
@@ -69,9 +68,6 @@ pub struct ServeCommandDependenciesContainer {
     /// Era reader service
     pub(crate) era_reader: Arc<EraReader>,
 
-    /// Protocol configuration service
-    pub(crate) protocol_configuration_reader: Arc<ProtocolConfigurationReader>,
-
     /// Event Transmitter Service
     pub(crate) event_transmitter: Arc<TransmitterService<EventMessage>>,