chore: apply review comments

Author: jpraynaud

mithril-signer/src/configuration.rs

@@ -61,6 +61,7 @@ pub struct Configuration {
     pub network_magic: Option<u64>,
 
     /// DMQ network magic number
+    ///
     /// useful for TestNet & DevNet
     #[example = "`1097911063` or `42`"]
     pub dmq_network_magic: Option<u64>,

mithril-test-lab/mithril-devnet/mkfiles/mkfiles-dmq.sh

@@ -19,4 +19,4 @@ for NODE in ${ALL_NODES}; do
 }
 
 EOF
-done
+done

mithril-test-lab/mithril-end-to-end/src/lib.rs

@@ -10,3 +10,10 @@ pub use devnet::*;
 pub use end_to_end_spec::Spec;
 pub use mithril::*;
 pub use run_only::RunOnly;
+
+use clap::ValueEnum;
+#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, ValueEnum)]
+pub enum DmqNodeFlavor {
+    Haskell,
+    Fake,
+}

mithril-test-lab/mithril-end-to-end/src/main.rs

@@ -19,7 +19,7 @@ use tokio::{
 use mithril_common::StdResult;
 use mithril_doc::GenerateDocCommands;
 use mithril_end_to_end::{
-    Devnet, DevnetBootstrapArgs, MithrilInfrastructure, MithrilInfrastructureConfig,
+    Devnet, DevnetBootstrapArgs, DmqNodeFlavor, MithrilInfrastructure, MithrilInfrastructureConfig,
     RetryableDevnetError, RunOnly, Spec,
 };
 
@@ -141,8 +141,8 @@ pub struct Args {
     ///
     /// 'haskell': will use the DMQ network created within the 'mithril-devnet'
     /// 'fake': will use a fake DMQ network within created with the Mithril relay
-    #[clap(long, default_value = "haskell")]
-    dmq_node_flavor: Option<String>,
+    #[arg(long, value_enum, default_value = "haskell")]
+    dmq_node_flavor: Option<DmqNodeFlavor>,
 
     /// Skip cardano binaries download
     #[clap(long)]

mithril-test-lab/mithril-end-to-end/src/mithril/aggregator.rs

@@ -15,9 +15,9 @@ use mithril_common::{CardanoNetwork, StdResult, entities};
 
 use crate::utils::MithrilCommand;
 use crate::{
-    ANCILLARY_MANIFEST_SECRET_KEY, DEVNET_DMQ_MAGIC_ID, DEVNET_MAGIC_ID, ERA_MARKERS_SECRET_KEY,
-    ERA_MARKERS_VERIFICATION_KEY, FullNode, GENESIS_SECRET_KEY, GENESIS_VERIFICATION_KEY,
-    RetryableDevnetError,
+    ANCILLARY_MANIFEST_SECRET_KEY, DEVNET_DMQ_MAGIC_ID, DEVNET_MAGIC_ID, DmqNodeFlavor,
+    ERA_MARKERS_SECRET_KEY, ERA_MARKERS_VERIFICATION_KEY, FullNode, GENESIS_SECRET_KEY,
+    GENESIS_VERIFICATION_KEY, RetryableDevnetError,
 };
 
 #[derive(Debug)]
@@ -41,7 +41,7 @@ pub struct AggregatorConfig<'a> {
     pub chain_observer_type: &'a str,
     pub leader_aggregator_endpoint: &'a Option<String>,
     pub use_dmq: bool,
-    pub dmq_node_flavor: &'a Option<String>,
+    pub dmq_node_flavor: &'a Option<DmqNodeFlavor>,
 }
 
 pub struct Aggregator {
@@ -140,13 +140,13 @@ impl Aggregator {
         }
         let dmq_node_socket_path = if aggregator_config.use_dmq {
             match aggregator_config.dmq_node_flavor {
-                Some(flavor) if flavor == "haskell" => aggregator_config
+                Some(DmqNodeFlavor::Haskell) => aggregator_config
                     .full_node
                     .dmq_socket_path
                     .to_str()
                     .unwrap()
                     .to_string(),
-                Some(flavor) if flavor == "fake" => aggregator_config
+                Some(DmqNodeFlavor::Fake) => aggregator_config
                     .work_dir
                     .join(format!("dmq-aggregator-{}.socket", aggregator_config.index))
                     .to_str()

mithril-test-lab/mithril-end-to-end/src/mithril/infrastructure.rs

@@ -10,8 +10,8 @@ use mithril_common::{CardanoNetwork, StdResult};
 
 use crate::mithril::relay_signer::RelaySignerConfiguration;
 use crate::{
-    Aggregator, AggregatorConfig, Client, DEVNET_MAGIC_ID, Devnet, FullNode, PoolNode,
-    RelayAggregator, RelayPassive, RelaySigner, Signer, assertions,
+    Aggregator, AggregatorConfig, Client, DEVNET_MAGIC_ID, Devnet, DmqNodeFlavor, FullNode,
+    PoolNode, RelayAggregator, RelayPassive, RelaySigner, Signer, assertions,
 };
 
 use super::signer::SignerConfig;
@@ -38,7 +38,7 @@ pub struct MithrilInfrastructureConfig {
     pub use_p2p_passive_relays: bool,
     pub skip_signature_delayer: bool,
     pub use_dmq: bool,
-    pub dmq_node_flavor: Option<String>,
+    pub dmq_node_flavor: Option<DmqNodeFlavor>,
     pub use_era_specific_work_dir: bool,
 }
 
@@ -75,7 +75,7 @@ impl MithrilInfrastructureConfig {
             use_p2p_passive_relays: false,
             skip_signature_delayer: false,
             use_dmq: false,
-            dmq_node_flavor: Some("fake".to_string()),
+            dmq_node_flavor: Some(DmqNodeFlavor::Fake),
             use_era_specific_work_dir: false,
         }
     }
@@ -101,7 +101,7 @@ impl MithrilInfrastructure {
     pub async fn start(config: &MithrilInfrastructureConfig) -> StdResult<Self> {
         let chain_observer_type = "pallas";
         config.devnet.run().await?;
-        if config.use_dmq && config.dmq_node_flavor == Some("haskell".to_string()) {
+        if config.use_dmq && config.dmq_node_flavor == Some(DmqNodeFlavor::Haskell) {
             config.devnet.run_dmq().await?;
         }
         let devnet_topology = config.devnet.topology();

mithril-test-lab/mithril-end-to-end/src/mithril/signer.rs

@@ -11,7 +11,7 @@ use tokio::sync::RwLock;
 
 use crate::devnet::PoolNode;
 use crate::utils::MithrilCommand;
-use crate::{DEVNET_DMQ_MAGIC_ID, DEVNET_MAGIC_ID, ERA_MARKERS_VERIFICATION_KEY};
+use crate::{DEVNET_DMQ_MAGIC_ID, DEVNET_MAGIC_ID, DmqNodeFlavor, ERA_MARKERS_VERIFICATION_KEY};
 
 #[derive(Debug)]
 pub struct SignerConfig<'a> {
@@ -29,7 +29,7 @@ pub struct SignerConfig<'a> {
     pub enable_certification: bool,
     pub skip_signature_delayer: bool,
     pub use_dmq: bool,
-    pub dmq_node_flavor: &'a Option<String>,
+    pub dmq_node_flavor: &'a Option<DmqNodeFlavor>,
 }
 
 #[derive(Debug)]
@@ -112,10 +112,10 @@ impl Signer {
         }
         let dmq_node_socket_path = if signer_config.use_dmq {
             match signer_config.dmq_node_flavor {
-                Some(flavor) if flavor == "haskell" => {
+                Some(DmqNodeFlavor::Haskell) => {
                     signer_config.pool_node.dmq_socket_path.to_str().unwrap().to_string()
                 }
-                Some(flavor) if flavor == "fake" => signer_config
+                Some(DmqNodeFlavor::Fake) => signer_config
                     .work_dir
                     .join(format!("dmq-signer-{}.socket", signer_config.signer_number))
                     .to_str()