mithril_client_cli/commands/cardano_db/
mod.rs

1//! Commands for the Cardano db artifact
2mod download;
3mod list;
4mod shared_steps;
5mod show;
6mod verify;
7
8pub use download::*;
9pub use list::*;
10pub use show::*;
11pub use verify::*;
12
13use crate::CommandContext;
14use clap::{Subcommand, ValueEnum};
15use mithril_client::MithrilResult;
16
17/// Backend to use for Cardano Database commands
18#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Default, ValueEnum)]
19pub enum CardanoDbCommandsBackend {
20    /// Legacy backend
21    #[clap(help = "Legacy backend, full database restoration only")]
22    V1,
23    /// V2 backend
24    #[default]
25    #[clap(help = "[default] V2 backend, full or partial database restoration")]
26    V2,
27}
28
29/// Cardano db management (alias: cdb)
30#[derive(Subcommand, Debug, Clone)]
31pub enum CardanoDbCommands {
32    /// Cardano db snapshot commands
33    #[clap(subcommand)]
34    Snapshot(CardanoDbSnapshotCommands),
35
36    /// Download a Cardano db snapshot and verify its associated certificate
37    #[clap(arg_required_else_help = true)]
38    Download(CardanoDbDownloadCommand),
39
40    /// Verify a Cardano database content
41    #[clap(arg_required_else_help = true)]
42    Verify(CardanoDbVerifyCommand),
43}
44
45/// Cardano db snapshots
46#[derive(Subcommand, Debug, Clone)]
47pub enum CardanoDbSnapshotCommands {
48    /// List available Cardano db snapshots
49    #[clap(arg_required_else_help = false)]
50    List(CardanoDbListCommand),
51
52    /// Show detailed information about a Cardano db snapshot
53    #[clap(arg_required_else_help = true)]
54    Show(CardanoDbShowCommand),
55}
56
57impl CardanoDbCommands {
58    /// Execute Cardano db command
59    pub async fn execute(&self, context: CommandContext) -> MithrilResult<()> {
60        match self {
61            Self::Download(cmd) => cmd.execute(context).await,
62            Self::Snapshot(cmd) => cmd.execute(context).await,
63            Self::Verify(cmd) => cmd.execute(context).await,
64        }
65    }
66}
67
68impl CardanoDbSnapshotCommands {
69    /// Execute Cardano db snapshot command
70    pub async fn execute(&self, config_builder: CommandContext) -> MithrilResult<()> {
71        match self {
72            Self::List(cmd) => cmd.execute(config_builder).await,
73            Self::Show(cmd) => cmd.execute(config_builder).await,
74        }
75    }
76}
77
78/// Print in stderr that the given parameters are not available with the v1 backend and will be ignored
79pub fn warn_unused_parameter_with_v1_backend<const N: usize>(
80    context: &CommandContext,
81    v2_only_parameters: [&str; N],
82) {
83    use crate::utils::JSON_CAUTION_KEY;
84
85    let message = format_unused_parameter_with_v1_backend(v2_only_parameters);
86    if context.is_json_output_enabled() {
87        eprintln!(r#"{{"{JSON_CAUTION_KEY}":"{message}"}}"#);
88    } else {
89        eprintln!("{message}");
90        // Add a blank line to separate this message from the one related to the fast bootstrap that comes next.
91        eprintln!();
92    }
93}
94
95fn format_unused_parameter_with_v1_backend<const N: usize>(
96    v2_only_parameters: [&str; N],
97) -> String {
98    match v2_only_parameters.len() {
99        0 => String::new(),
100        1 => format!(
101            "`{}` is only available with the `v2` backend. It will be ignored.",
102            v2_only_parameters[0]
103        ),
104        n => {
105            format!(
106                "`{}`, and `{}` are only available with the `v2` backend. They will be ignored.",
107                v2_only_parameters[..n - 1].join("`, `"),
108                v2_only_parameters[n - 1]
109            )
110        }
111    }
112}
113
114#[cfg(test)]
115mod tests {
116    use super::*;
117
118    #[test]
119    fn test_format_unused_parameter_with_v1_backend() {
120        assert_eq!(format_unused_parameter_with_v1_backend([]), String::new());
121
122        assert_eq!(
123            format_unused_parameter_with_v1_backend(["--test"]),
124            "`--test` is only available with the `v2` backend. It will be ignored.".to_string()
125        );
126
127        assert_eq!(
128            format_unused_parameter_with_v1_backend(["--foo", "--bar"]),
129            "`--foo`, and `--bar` are only available with the `v2` backend. They will be ignored."
130                .to_string()
131        );
132
133        assert_eq!(
134            format_unused_parameter_with_v1_backend(["--test", "--foo", "--bar"]),
135            "`--test`, `--foo`, and `--bar` are only available with the `v2` backend. They will be ignored.".to_string()
136        );
137    }
138}
mithril_client_cli/commands/cardano_db/mod.rs

mithril_client_cli/commands/cardano_db/
mod.rs
