Merge pull request #425 from input-output-hk/lowhung/add-global-config

feat: add global startup method configuration for snapshot and mithril

Author: lowhung

Cargo.lock

@@ -41,11 +41,11 @@ members = [
 resolver = "2"
 
 [workspace.dependencies]
-caryatid_sdk = "0.13"
-caryatid_process = "0.13"
-caryatid_module_rest_server = "0.15"
-caryatid_module_clock = "0.13"
-caryatid_module_spy = "0.13"
+caryatid_sdk = "0.14.0"
+caryatid_process = "0.13.1"
+caryatid_module_rest_server = "0.15.1"
+caryatid_module_clock = "0.13.1"
+caryatid_module_spy = "0.13.1"
 anyhow = "1.0"
 chrono = "0.4"
 clap = { version = "4.5", features = ["derive", "string"] }

Cargo.toml

@@ -14,6 +14,7 @@ caryatid_module_clock = { workspace = true }
 caryatid_module_rest_server = { workspace = true }
 
 anyhow = { workspace = true }
+config = { workspace = true }
 bech32 = "0.11"
 bigdecimal = "0.4.8"
 bitmask-enum = "2.2"

common/Cargo.toml

@@ -0,0 +1,35 @@
+use config::Config;
+use serde::Deserialize;
+use std::fmt::{Display, Formatter, Result};
+
+pub const CONFIG_KEY_STARTUP_METHOD: &str = "startup.method";
+
+#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
+#[serde(rename_all = "lowercase")]
+pub enum StartupMethod {
+    Mithril,
+    Snapshot,
+}
+
+impl StartupMethod {
+    pub fn from_config(config: &Config) -> Self {
+        config.get::<StartupMethod>(CONFIG_KEY_STARTUP_METHOD).unwrap_or(StartupMethod::Mithril)
+    }
+
+    pub fn is_mithril(&self) -> bool {
+        matches!(self, StartupMethod::Mithril)
+    }
+
+    pub fn is_snapshot(&self) -> bool {
+        matches!(self, StartupMethod::Snapshot)
+    }
+}
+
+impl Display for StartupMethod {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
+        match self {
+            StartupMethod::Mithril => write!(f, "mithril"),
+            StartupMethod::Snapshot => write!(f, "snapshot"),
+        }
+    }
+}

common/src/configuration.rs

@@ -6,6 +6,7 @@ pub mod caryatid;
 pub mod cbor;
 pub mod cip19;
 pub mod commands;
+pub mod configuration;
 pub mod crypto;
 pub mod genesis_values;
 pub mod hash;

common/src/lib.rs

@@ -2,6 +2,7 @@
 //! Fetches a snapshot from Mithril and replays all the blocks in it
 
 use acropolis_common::{
+    configuration::StartupMethod,
     genesis_values::GenesisValues,
     messages::{CardanoMessage, Message, RawBlockMessage},
     BlockHash, BlockInfo, BlockStatus, Era,
@@ -395,6 +396,16 @@ impl MithrilSnapshotFetcher {
 
     /// Main init function
     pub async fn init(&self, context: Arc<Context<Message>>, config: Arc<Config>) -> Result<()> {
+        // Check if this module is the selected startup method
+        let startup_method = StartupMethod::from_config(&config);
+        if !startup_method.is_mithril() {
+            info!(
+                "Mithril Snapshot Fetcher not enabled (startup.method = '{}')",
+                startup_method
+            );
+            return Ok(());
+        }
+
         let bootstrapped_subscribe_topic = config
             .get_string(DEFAULT_BOOTSTRAPPED_SUBSCRIBE_TOPIC.0)
             .unwrap_or(DEFAULT_BOOTSTRAPPED_SUBSCRIBE_TOPIC.1.to_string());

modules/mithril_snapshot_fetcher/src/mithril_snapshot_fetcher.rs

@@ -6,10 +6,11 @@ mod publisher;
 use crate::configuration::{ConfigError, NetworkConfig, SnapshotConfig, SnapshotFileMetadata};
 use crate::downloader::{DownloadError, SnapshotDownloader};
 use crate::publisher::SnapshotPublisher;
-use acropolis_common::genesis_values::GenesisValues;
-use acropolis_common::snapshot::streaming_snapshot::StreamingSnapshotParser;
 use acropolis_common::{
+    configuration::StartupMethod,
+    genesis_values::GenesisValues,
     messages::{CardanoMessage, Message},
+    snapshot::streaming_snapshot::StreamingSnapshotParser,
     BlockHash, BlockInfo, BlockStatus, Era,
 };
 use anyhow::{bail, Result};
@@ -48,6 +49,16 @@ pub struct SnapshotBootstrapper;
 impl SnapshotBootstrapper {
     /// Initializes the snapshot bootstrapper.
     pub async fn init(&self, context: Arc<Context<Message>>, config: Arc<Config>) -> Result<()> {
+        // Check if this module is the selected startup method
+        let startup_method = StartupMethod::from_config(&config);
+        if !startup_method.is_snapshot() {
+            info!(
+                "Snapshot bootstrapper not enabled (startup.method = '{}')",
+                startup_method
+            );
+            return Ok(());
+        }
+
         let cfg = SnapshotConfig::try_load(&config)?;
 
         info!("Snapshot bootstrapper initializing");

modules/snapshot_bootstrapper/src/bootstrapper.rs

@@ -3,7 +3,7 @@
 # ============================================================================
 # Startup Configuration
 # ============================================================================
-[startup]
+[global.startup]
 method = "mithril"  # Options: "mithril" | "snapshot"
 topic = "cardano.sequence.start"
 

processes/omnibus/omnibus.toml

@@ -45,10 +45,6 @@ use tracing_opentelemetry::OpenTelemetryLayer;
 use tracing_subscriber::prelude::*;
 use tracing_subscriber::{filter, fmt, EnvFilter, Registry};
 
-const STARTUP_METHOD_MITHRIL: &str = "mithril";
-const STARTUP_METHOD_SNAPSHOT: &str = "snapshot";
-const CONFIG_KEY_STARTUP_METHOD: &str = "startup.method";
-
 #[cfg(not(target_env = "msvc"))]
 use tikv_jemallocator::Jemalloc;
 #[cfg(not(target_env = "msvc"))]
@@ -102,35 +98,12 @@ pub async fn main() -> Result<()> {
     );
 
     // Create the process
-    let mut process = Process::<Message>::create(config.clone()).await;
-
-    // Get startup method from config
-    let startup_method = config
-        .get_string(CONFIG_KEY_STARTUP_METHOD)
-        .unwrap_or_else(|_| STARTUP_METHOD_MITHRIL.to_string());
-
-    info!("Using startup method: {}", startup_method);
-
-    // Register bootstrap modules based on the startup method
-    match startup_method.as_str() {
-        STARTUP_METHOD_MITHRIL => {
-            info!("Registering MithrilSnapshotFetcher");
-            MithrilSnapshotFetcher::register(&mut process);
-        }
-        STARTUP_METHOD_SNAPSHOT => {
-            info!("Registering SnapshotBootstrapper");
-            SnapshotBootstrapper::register(&mut process);
-        }
-        _ => {
-            panic!(
-                "Invalid startup method: {}. Must be one of: mithril, snapshot",
-                startup_method
-            );
-        }
-    }
+    let mut process = Process::<Message>::create(config).await;
 
     // Register modules
     GenesisBootstrapper::register(&mut process);
+    SnapshotBootstrapper::register(&mut process);
+    MithrilSnapshotFetcher::register(&mut process);
     BlockUnpacker::register(&mut process);
     PeerNetworkInterface::register(&mut process);
     TxUnpacker::register(&mut process);