Merge pull request #1516 from input-output-hk/ensemble/1469/enhance-cli-standard-output

Enhance client-cli standard output

Author: Alenar

Cargo.lock

@@ -15,9 +15,11 @@ Mithril client is responsible for restoring the **Cardano** blockchain on an emp
 
 :::tip
 
-* For more information about the **Mithril network**, please see the [architecture](../../../mithril/mithril-network/architecture.md) overview.
+* For more information about the **Mithril network**, please see
+  the [architecture](../../../mithril/mithril-network/architecture.md) overview.
 
-* For more information about the **Mithril client** node, please see [this overview](../../../mithril/mithril-network/client.md).
+* For more information about the **Mithril client** node, please
+  see [this overview](../../../mithril/mithril-network/client.md).
 
 * Check out the [`Bootstrap a Cardano node`](../../getting-started/bootstrap-cardano-node.md) guide.
 
@@ -29,7 +31,6 @@ Mithril client is responsible for restoring the **Cardano** blockchain on an emp
 
 :::
 
-
 ## Resources
 
 | Node | Source repository | Rust documentation | Docker packages |
@@ -38,7 +39,8 @@ Mithril client is responsible for restoring the **Cardano** blockchain on an emp
 
 ## Pre-requisites
 
-* Install the latest stable version of the [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain.
+* Install the latest stable version of the [correctly configured](https://www.rust-lang.org/learn/get-started) Rust
+  toolchain.
 
 * Install OpenSSL development libraries. For example, on Ubuntu/Debian/Mint, run `apt install libssl-dev`
 
@@ -64,7 +66,7 @@ Switch to the desired branch/tag:
 git checkout **YOUR_BUILD_BRANCH_OR_TAG**
 ```
 
-Change the directory: 
+Change the directory:
 
 ```bash
 cd mithril/mithril-client-cli
@@ -198,7 +200,8 @@ If you wish to delve deeper and access several levels of logs from the Mithril c
 
 ### Registry image
 
-A list of available images on the registry can be found [here](https://github.com/input-output-hk/mithril/pkgs/container/mithril-client).
+A list of available images on the registry can be
+found [here](https://github.com/input-output-hk/mithril/pkgs/container/mithril-client).
 
 To prepare the environment variables, retrieve the values from the above **Mithril networks** table.
 
@@ -249,11 +252,11 @@ mithril_client mithril-stake-distribution list
 # 6- Download and verify the given Mithril stake distribution
 mithril_client mithril-stake-distribution download $MITHRIL_STAKE_DISTRIBUTION_ARTIFACT_HASH
 
-# 7- List Cardano transaction sets
-mithril_client --unstable cardano-transaction sets list
+# 7- List Cardano transaction commitments
+mithril_client --unstable cardano-transaction commitment list
 
-# 8- Show detailed information about a Cardano transaction sets
-mithril_client --unstable cardano-transaction sets show $CARDANO_TRANSACTION_SETS_HASH 
+# 8- Show detailed information about a Cardano transaction commitment
+mithril_client --unstable cardano-transaction commitment show $CARDANO_TRANSACTION_COMMITMENT_HASH
 
 # 9- Certify that given list of transactions hashes are included in the Cardano transactions set
 mithril_client --unstable cardano-transaction certify $TRANSACTION_HASH_1,$TRANSACTION_HASH_2
@@ -299,15 +302,16 @@ Here are the subcommands available:
 | Subcommand | Performed action |
 |------------|------------------|
 | **certify** | Certifies that given list of transactions hashes are included in the Cardano transactions set|
+| **commitment list** | Lists available Cardano transactions commitments|
+| **commitment show** | Shows information about a Cardano transactions commitment|
 | **help** | Prints this message or the help for the given subcommand(s)|
-| **sets list** | Lists available Cardano transactions sets|
-| **sets show** | Shows information about a Cardano transaction sets|
 
 ## Configuration parameters
 
 The configuration parameters can be set in either of the following ways:
 
-1. In a configuration file, depending on the `--run-mode` parameter. If the runtime mode is `testnet`, the file is located in `./conf/testnet.json`.
+1. In a configuration file, depending on the `--run-mode` parameter. If the runtime mode is `testnet`, the file is
+   located in `./conf/testnet.json`.
 
 2. The value can be overridden by an environment variable with the parameter name in uppercase.
 
@@ -358,20 +362,20 @@ Here is a list of the available parameters:
 | `artifact_hash` | `--artifact-hash` | - | - | Hash of the Mithril stake distribution artifact or `latest` for the latest artifact | - | - | :heavy_check_mark: |
 | `download_dir` | `--download-dir` | - | - | Directory where the Mithril stake distribution will be downloaded | . | - | - |
 
-`cardano-transaction --unstable sets show` command:
+`cardano-transaction commitment show` command:
 
 | Parameter | Command line (long) |  Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
 |-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
-| `hash` | `--hash` | - | `HASH` | Cardano transaction sets hash or `latest` for the latest Cardano transaction sets | - | - | :heavy_check_mark: |
+| `hash` | `--hash` | - | `HASH` | Cardano transaction commitment hash or `latest` for the latest Cardano transaction commitment | - | - | :heavy_check_mark: |
 | `json` | `--json` | - | - | Enable JSON output for command results | - | - | - |
 
-`cardano-transaction --unstable sets list` command:
+`cardano-transaction commitment list` command:
 
 | Parameter | Command line (long) |  Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
 |-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
 | `json` | `--json` | - | - | Enable JSON output for command results | - | - | - |
 
-`cardano-transaction --unstable download` command:
+`cardano-transaction certify` command:
 
 | Parameter | Command line (long) |  Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
 |-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|

docs/website/root/manual/developer-docs/nodes/mithril-client.md

@@ -1,7 +1,7 @@
 [package]
 name = "client-cardano-transaction"
 description = "Mithril client cardano-transaction example"
-version = "0.1.0"
+version = "0.1.1"
 authors = ["[email protected]", "[email protected]"]
 documentation = "https://mithril.network/doc"
 edition = "2021"

examples/client-cardano-transaction/Cargo.toml

@@ -50,7 +50,7 @@ async fn main() -> MithrilResult<()> {
 
     info!(logger, "Fetching a proof for the given transactions...",);
     let cardano_transaction_proof = client
-        .cardano_transaction_proof()
+        .cardano_transaction()
         .get_proofs(transactions_hashes)
         .await
         .unwrap();

examples/client-cardano-transaction/src/main.rs

@@ -1,7 +1,7 @@
 [package]
 name = "client-mithril-stake-distribution"
 description = "Mithril client stake distribution example"
-version = "0.1.7"
+version = "0.1.8"
 authors = ["[email protected]", "[email protected]"]
 documentation = "https://mithril.network/doc"
 edition = "2021"

examples/client-mithril-stake-distribution/Cargo.toml

@@ -1,8 +1,6 @@
 //! This example shows how to implement a Mithril client and use its features.
 //!
 //! In this example, the client interacts by default with a real aggregator (`testing-preview`) to get the data.
-//!
-//! The [SlogFeedbackReceiver] is used to report the progress to the console.
 
 use anyhow::anyhow;
 use clap::Parser;

examples/client-mithril-stake-distribution/src/main.rs

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

mithril-client-cli/Cargo.toml

@@ -1,12 +1,13 @@
 use anyhow::{anyhow, Context};
 use clap::Parser;
+use cli_table::{print_stdout, Cell, Table};
 use config::{builder::DefaultState, ConfigBuilder, Map, Source, Value, ValueKind};
 use slog_scope::debug;
 use std::{collections::HashMap, sync::Arc};
 
 use mithril_client::{
-    common::TransactionHash, MessageBuilder, MithrilCertificate, MithrilResult,
-    VerifiedCardanoTransactions,
+    common::TransactionHash, CardanoTransactionsProofs, MessageBuilder, MithrilCertificate,
+    MithrilResult, VerifiedCardanoTransactions, VerifyCardanoTransactionsProofsError,
 };
 
 use crate::utils::{IndicatifFeedbackReceiver, ProgressOutputType, ProgressPrinter};
@@ -48,7 +49,7 @@ impl CardanoTransactionsCertifyCommand {
 
         progress_printer.report_step(1, "Fetching a proof for the given transactions…")?;
         let cardano_transaction_proof = client
-            .cardano_transaction_proof()
+            .cardano_transaction()
             .get_proofs(&self.transactions_hashes)
             .await
             .with_context(|| {
@@ -62,11 +63,8 @@ impl CardanoTransactionsCertifyCommand {
             cardano_transaction_proof
         );
 
-        progress_printer.report_step(2, "Verifying the proof…")?;
-        let verified_transactions = cardano_transaction_proof
-            .verify()
-            .with_context(|| "Proof verification failed")?;
-        debug!("Verified Transactions: {:?}", verified_transactions);
+        let verified_transactions =
+            Self::verify_proof_validity(2, &progress_printer, &cardano_transaction_proof)?;
 
         progress_printer.report_step(
             3,
@@ -97,6 +95,23 @@ impl CardanoTransactionsCertifyCommand {
         )
     }
 
+    fn verify_proof_validity(
+        step_number: u16,
+        progress_printer: &ProgressPrinter,
+        cardano_transaction_proof: &CardanoTransactionsProofs,
+    ) -> MithrilResult<VerifiedCardanoTransactions> {
+        progress_printer.report_step(step_number, "Verifying the proof…")?;
+        match cardano_transaction_proof.verify() {
+            Ok(verified_transactions) => Ok(verified_transactions),
+            Err(VerifyCardanoTransactionsProofsError::NoCertifiedTransaction) => Err(anyhow!(
+                "Mithril could not certify any of the given transactions.
+
+Mithril may not have signed those transactions yet, please try again later."
+            )),
+            err => err.with_context(|| "Proof verification failed"),
+        }
+    }
+
     fn verify_proof_match_certificate(
         step_number: u16,
         progress_printer: &ProgressPrinter,
@@ -132,18 +147,35 @@ impl CardanoTransactionsCertifyCommand {
             );
         } else {
             println!(
-                r###"Cardano transactions with hashes "'{}'" have been successfully checked against Mithril multi-signature contained in the certificate."###,
-                verified_transactions.certified_transactions().join(","),
+                r###"Cardano transactions proof has been successfully signed in the associated Mithril certificate."###,
             );
 
             if !non_certified_transactions.is_empty() {
                 println!(
-                    r###"No proof could be computed for Cardano transactions with hashes "'{}'".
-                    
-                    Mithril may not have signed those transactions yet, please try again later."###,
-                    non_certified_transactions.join(","),
+                    r###"
+No proof could be computed for some Cardano transactions. Mithril may not have signed those transactions yet, please try again later."###,
                 );
             }
+
+            let result_table = verified_transactions
+                .certified_transactions()
+                .iter()
+                .map(|tx| {
+                    vec![
+                        tx.cell(),
+                        "✅".cell().justify(cli_table::format::Justify::Center),
+                    ]
+                })
+                .chain(non_certified_transactions.iter().map(|tx| {
+                    vec![
+                        tx.cell(),
+                        "❌".cell().justify(cli_table::format::Justify::Center),
+                    ]
+                }))
+                .table()
+                .title(vec!["Transaction Hash", "Certified"]);
+
+            print_stdout(result_table)?
         }
 
         Ok(())

mithril-client-cli/src/commands/cardano_transaction/certify.rs

@@ -8,21 +8,21 @@ use crate::commands::client_builder_with_fallback_genesis_key;
 use crate::configuration::ConfigParameters;
 use mithril_client::MithrilResult;
 
-/// Cardano transaction commitment LIST command
+/// Cardano transaction commitment list command
 #[derive(Parser, Debug, Clone)]
-pub struct CardanoTransactionSetsListCommand {
+pub struct CardanoTransactionCommitmentListCommand {
     /// Enable JSON output.
     #[clap(long)]
     json: bool,
 }
 
-impl CardanoTransactionSetsListCommand {
+impl CardanoTransactionCommitmentListCommand {
     /// Main command execution
     pub async fn execute(&self, config_builder: ConfigBuilder<DefaultState>) -> MithrilResult<()> {
         let config = config_builder.build()?;
         let params = ConfigParameters::new(config.try_deserialize::<HashMap<String, String>>()?);
         let client = client_builder_with_fallback_genesis_key(&params)?.build()?;
-        let lines = client.cardano_transaction_proof().list().await?;
+        let lines = client.cardano_transaction().list_commitments().await?;
 
         if self.json {
             println!("{}", serde_json::to_string(&lines)?);