Merge pull request #2852 from input-output-hk/djo/2823/snapshot-converter_add-cardano-docker-cmd

feat(client-cli): add cardano docker run command to snapshot converter output

Author: Alenar

CHANGELOG.md

@@ -16,6 +16,13 @@ As a minor extension, we have adopted a slightly different versioning convention
 
   - **DEPRECATED**: The flag `--backend v1` of the `cardano-db` command has been deprecated CLI, use the `--backend v2` instead.
 
+  - Reworked the client CLI `snapshot-converter` command outputs:
+    - Print all progress messages to stderr instead of stdout.
+    - Add support for `--json` parameter
+    - Add a docker run command in the final output that can be used to start the Cardano node with the converted ledger
+
+  - **BREAKING**: Progress bars and spinners of the client CLI are now outputted to stderr instead of stdout.
+
 - Support for removal of `cardano_transactions_signing_config` from the diffused mithril network configuration.
 
 - Decentralization of the configuration parameters of Mithril networks:

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client-cli"
-version = "0.12.35"
+version = "0.12.36"
 description = "A Mithril Client"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-client-cli/Cargo.toml

@@ -7,13 +7,14 @@ use v2::PreparedCardanoDbV2Download;
 use clap::Parser;
 use std::{collections::HashMap, path::PathBuf};
 
+use mithril_client::{MithrilResult, common::ImmutableFileNumber};
+
 use crate::{
     CommandContext,
     commands::cardano_db::{CardanoDbCommandsBackend, warn_unused_parameter_with_v1_backend},
     configuration::{ConfigError, ConfigSource},
-    utils::{self, JSON_CAUTION_KEY},
+    utils::{self, JSON_CAUTION_KEY, print_simple_warning},
 };
-use mithril_client::{MithrilResult, common::ImmutableFileNumber};
 
 const DB_DIRECTORY_NAME: &str = "db";
 
@@ -161,11 +162,8 @@ For more information, please refer to the network configuration page of the docu
 
     fn warn_ancillary_not_signed_by_mithril(&self, context: &CommandContext) {
         let message = "Ancillary verification does not use the Mithril certification: as a mitigation, IOG owned keys are used to sign these files.";
-        if context.is_json_output_enabled() {
-            eprintln!(r#"{{"{JSON_CAUTION_KEY}":"{message}"}}"#);
-        } else {
-            eprintln!("{message}");
-        }
+
+        print_simple_warning(message, context.is_json_output_enabled());
     }
 }
 

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

@@ -10,10 +10,12 @@ pub use list::*;
 pub use show::*;
 pub use verify::*;
 
-use crate::CommandContext;
 use clap::{Subcommand, ValueEnum};
+
 use mithril_client::MithrilResult;
 
+use crate::{CommandContext, utils::print_simple_warning};
+
 /// Backend to use for Cardano Database commands
 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Default, ValueEnum)]
 pub enum CardanoDbCommandsBackend {
@@ -77,31 +79,22 @@ impl CardanoDbSnapshotCommands {
 
 /// Print in stderr a warning about the deprecation of the v1 backend and its scheduled removal in 2026
 pub fn warn_deprecated_v1_backend(context: &CommandContext) {
-    use crate::utils::JSON_CAUTION_KEY;
-
     let message = "The `v1` backend is deprecated and is scheduled to be removed early 2026. \
     Please use the `v2` backend instead. \
     No other change is required in your command line.";
 
-    if context.is_json_output_enabled() {
-        eprintln!(r#"{{"{JSON_CAUTION_KEY}":"{message}"}}"#);
-    } else {
-        eprintln!("Warning: {message}");
-    }
+    print_simple_warning(message, context.is_json_output_enabled());
 }
 
 /// Print in stderr that the given parameters are not available with the v1 backend and will be ignored
 pub fn warn_unused_parameter_with_v1_backend<const N: usize>(
     context: &CommandContext,
     v2_only_parameters: [&str; N],
 ) {
-    use crate::utils::JSON_CAUTION_KEY;
-
     let message = format_unused_parameter_with_v1_backend(v2_only_parameters);
-    if context.is_json_output_enabled() {
-        eprintln!(r#"{{"{JSON_CAUTION_KEY}":"{message}"}}"#);
-    } else {
-        eprintln!("{message}");
+    print_simple_warning(&message, context.is_json_output_enabled());
+
+    if !context.is_json_output_enabled() {
         // Add a blank line to separate this message from the one related to the fast bootstrap that comes next.
         eprintln!();
     }

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

@@ -9,7 +9,7 @@ use mithril_client::{
     common::{ImmutableFileNumber, MKProof, ProtocolMessage},
 };
 
-use crate::utils::{CardanoDbUtils, ProgressPrinter};
+use crate::utils::{CardanoDbUtils, LedgerFormat, ProgressPrinter};
 
 pub struct ComputeCardanoDatabaseMessageOptions {
     pub db_dir: PathBuf,
@@ -163,11 +163,12 @@ pub fn log_download_information(
         .canonicalize()
         .with_context(|| format!("Could not get canonical filepath of '{}'", db_dir.display()))?;
 
-    let docker_cmd = format!(
-        "docker run -v cardano-node-ipc:/ipc -v cardano-node-data:/data --mount type=bind,source=\"{}\",target=/data/db/ -e NETWORK={} ghcr.io/intersectmbo/cardano-node:{}",
-        canonical_filepath.display(),
+    let docker_cmd = CardanoDbUtils::get_docker_run_command(
+        canonical_filepath,
         cardano_network,
-        cardano_node_version
+        cardano_node_version,
+        // Aggregators are only using UTxO-HD in memory format as other format are deprecated or non portable
+        LedgerFormat::InMemory,
     );
 
     let snapshot_converter_cmd = |flavor| {

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

@@ -20,15 +20,15 @@ pub enum UTxOHDCommands {
 
 impl UTxOHDCommands {
     /// Execute UTxO-HD command
-    pub async fn execute(&self, _context: CommandContext) -> MithrilResult<()> {
+    pub async fn execute(&self, context: CommandContext) -> MithrilResult<()> {
         match self {
             Self::SnapshotConverter(cmd) => {
                 if cfg!(target_os = "linux") && cfg!(target_arch = "aarch64") {
                     return Err(anyhow!(
                         "'snapshot-converter' command is not supported on Linux ARM"
                     ));
                 }
-                cmd.execute().await
+                cmd.execute(context).await
             }
         }
     }