feat: print in Cardano DB v1 and v2 client-cli if ancillary files not included

Author: turmelclem

mithril-client-cli/src/commands/cardano_db/download.rs

@@ -13,8 +13,8 @@ use crate::{
     commands::{client_builder, SharedArgs},
     configuration::{ConfigError, ConfigSource},
     utils::{
-        self, CardanoDbDownloadChecker, CardanoDbUtils, ExpanderUtils, IndicatifFeedbackReceiver,
-        ProgressOutputType, ProgressPrinter,
+        self, AncillaryLogMessage, CardanoDbDownloadChecker, CardanoDbUtils, ExpanderUtils,
+        IndicatifFeedbackReceiver, ProgressOutputType, ProgressPrinter,
     },
     CommandContext,
 };
@@ -67,6 +67,12 @@ impl CardanoDbDownloadCommand {
 
     /// Command execution
     pub async fn execute(&self, context: CommandContext) -> MithrilResult<()> {
+        if self.include_ancillary {
+            AncillaryLogMessage::warn_ancillary_not_signed_by_mithril();
+        } else {
+            AncillaryLogMessage::warn_fast_bootstrap_not_available();
+        }
+
         let params = context.config_parameters()?.add_source(self)?;
         let download_dir: &String = &params.require("download_dir")?;
         let db_dir = Path::new(download_dir).join("db");

mithril-client-cli/src/commands/cardano_db_v2/download.rs

@@ -20,8 +20,8 @@ use crate::{
     commands::{client_builder, SharedArgs},
     configuration::{ConfigError, ConfigSource},
     utils::{
-        self, CardanoDbDownloadChecker, CardanoDbUtils, ExpanderUtils, IndicatifFeedbackReceiver,
-        ProgressOutputType, ProgressPrinter,
+        self, AncillaryLogMessage, CardanoDbDownloadChecker, CardanoDbUtils, ExpanderUtils,
+        IndicatifFeedbackReceiver, ProgressOutputType, ProgressPrinter,
     },
     CommandContext,
 };
@@ -107,6 +107,12 @@ impl CardanoDbV2DownloadCommand {
 
     /// Command execution
     pub async fn execute(&self, context: CommandContext) -> MithrilResult<()> {
+        if self.include_ancillary {
+            AncillaryLogMessage::warn_ancillary_not_signed_by_mithril();
+        } else {
+            AncillaryLogMessage::warn_fast_bootstrap_not_available();
+        }
+
         let params = context.config_parameters()?.add_source(self)?;
         let download_dir: &String = &params.require("download_dir")?;
         let restoration_options = RestorationOptions {

mithril-client-cli/src/utils/cardano_db.rs

@@ -47,6 +47,24 @@ impl CardanoDbUtils {
     }
 }
 
+pub struct AncillaryLogMessage {}
+
+impl AncillaryLogMessage {
+    /// This method provides guidance on how to enable fast bootstrap by including ancillary files
+    pub fn warn_fast_bootstrap_not_available() {
+        println!("The fast bootstrap of the Cardano node is not available with the current parameters used in this command: this means that the ledger state will be recomputed from genesis at startup of the Cardano node.
+
+    In order to activate the fast bootstrap of the Cardano node, add the following parameters to the command:
+
+        --include-ancillary
+        and --ancillary-verification-key (or environment variable ANCILLARY_VERIFICATION_KEY). Caution: The ancillary files, including the ledger state, are not currently signed by Mithril. As a mitigation, IOG owned keys are used to sign these files. For more information, please refer to the network configuration page of the documentation (https://mithril.network/doc/manual/getting-started/network-configurations).");
+    }
+
+    pub fn warn_ancillary_not_signed_by_mithril() {
+        println!("Ancillary verification does not use the Mithril certification: as a mitigation, IOG owned keys are used to sign these files.");
+    }
+}
+
 #[cfg(test)]
 mod test {
     use super::*;