From 222c5a976d60ce2de3e1f1b6e23725b5d9490df1 Mon Sep 17 00:00:00 2001 From: DJO <790521+Alenar@users.noreply.github.com> Date: Tue, 13 Feb 2024 11:26:26 +0100 Subject: [PATCH] Update client-cli page in docsite --- .../developer-docs/nodes/mithril-client.md | 55 ++++++++++++++++--- 1 file changed, 48 insertions(+), 7 deletions(-) diff --git a/docs/website/root/manual/developer-docs/nodes/mithril-client.md b/docs/website/root/manual/developer-docs/nodes/mithril-client.md index 9646844ef43..8b21eaf9c20 100644 --- a/docs/website/root/manual/developer-docs/nodes/mithril-client.md +++ b/docs/website/root/manual/developer-docs/nodes/mithril-client.md @@ -119,14 +119,15 @@ Display the help menu: You should see: ```bash -This program shows, downloads, and verifies certified blockchain artifacts. +This program shows, downloads and verifies certified blockchain artifacts. -Usage: mithril-client-cli [OPTIONS] +Usage: mithril-client [OPTIONS] Commands: - snapshot Snapshot commands - mithril-stake-distribution Mithril stake distribution management (alias: msd) - help Print this message or the help for the given subcommand(s) + snapshot Snapshot management + mithril-stake-distribution Mithril Stake Distribution management (alias: msd) + cardano-transaction [unstable] Cardano transactions management (alias: ctx) + help Print this message or the help of the given subcommand(s) Options: --run-mode @@ -136,17 +137,18 @@ Options: --config-directory Directory where configuration file is located [default: ./config] --aggregator-endpoint - Override configuration Aggregator endpoint URL + Override configuration Aggregator endpoint URL [env: AGGREGATOR_ENDPOINT=] --log-format-json Enable JSON output for logs displayed according to verbosity level --log-output Redirect the logs to a file + --unstable + Enable unstable commands (Such as Cardano Transactions) -h, --help Print help -V, --version Print version - ``` Run in release mode with the default configuration: @@ -246,6 +248,15 @@ 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 + +# 8- Show detailed information about a Cardano transaction sets +mithril_client --unstable cardano-transaction sets show $CARDANO_TRANSACTION_SETS_HASH + +# 9- Certify that given list of transactions hashes are included in the global Cardano transactions set +mithril_client --unstable cardano-transaction certify $TRANSACTION_HASH_1,$TRANSACTION_HASH_2 ``` ### Local image @@ -283,6 +294,15 @@ Here are the subcommands available: | **help** | Prints this message or the help for the given subcommand(s)| | **list** | Lists available Mithril stake distributions| +### Cardano transactions + +| Subcommand | Performed action | +|------------|------------------| +| **certify** | Certifies that given list of transactions hashes are included in the global Cardano transactions set| +| **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: @@ -296,6 +316,7 @@ Here is a list of the available parameters: | Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | |-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:| | `verbose` | `--verbose` | `-v` | `VERBOSE` | Verbosity level | - | Parsed from the number of occurrences: `-v` for `Warning`, `-vv` for `Info`, `-vvv` for `Debug` and `-vvvv` for `Trace` | :heavy_check_mark: | +| `unstable` | `--unstable` | - | - | Enable unstable commands | - | - | - | | `run_mode` | `--run-mode` | - | `RUN_MODE` | Runtime mode | `dev` | - | :heavy_check_mark: | | `network` | - | - | `NETWORK` | Cardano network | - | `testnet` or `mainnet` or `devnet` | :heavy_check_mark: | | `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Aggregator node endpoint | - | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` | :heavy_check_mark: | @@ -336,3 +357,23 @@ 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: + +| 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: | +| `json` | `--json` | - | - | Enable JSON output for command results | - | - | - | + +`cardano-transaction --unstable sets 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: + +| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | +|-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:| +| `transactions_hashes` | `--transactions_hashes` | - | `TRANSACTIONS_HASHES` | Cardano transactions hashes separated by commas | - | - | :heavy_check_mark: | +| `json` | `--json` | - | - | Enable JSON output for progress logs | - | - | - |