Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stabilize namings cardano transactions #1542

Merged
merged 12 commits into from
Feb 29, 2024
Merged

Stabilize namings cardano transactions #1542

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
26c7f4e
refactor: rename `commitment` into `snapshot` in `mithril-client-cli`
dlachaume Feb 27, 2024
cefe2f7
docs: adapt Mithril client CLI doc after renaming
dlachaume Feb 27, 2024
19af5f7
refactor: rename `snapshot` command into `cardano-db`
dlachaume Feb 27, 2024
164d0fe
docs: adapt Mithril client CLI doc after renaming snapshot into carda…
dlachaume Feb 28, 2024
485d5c7
Rename ctx `commitment` to `snapshot` in fake aggregator script & data
Alenar Feb 28, 2024
e2114c8
Rename ctx `commitment` to `snapshot` in code & openapi
Alenar Feb 28, 2024
83e6b54
Rename ctx `commitment` to `snapshot` in doc website
Alenar Feb 28, 2024
10e1898
Rename ctx `commitment` to `snapshot` in client test ci workflow
Alenar Feb 28, 2024
cb5a01a
Rename `snapshot` command to `cardano-db` in client test ci workflow
Alenar Feb 28, 2024
0fb61aa
Put cli list & show cdb commands in a `snapshot` subcommand
Alenar Feb 29, 2024
8d72a65
Make `test-client` ci workflow check old `snapshot` cli commands avai…
Alenar Feb 29, 2024
8c6d72c
Upgrade crates and openapi versions
Alenar Feb 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 22 additions & 16 deletions docs/website/root/manual/developer-docs/nodes/mithril-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ This program shows, downloads and verifies certified blockchain artifacts.
Usage: mithril-client [OPTIONS] <COMMAND>

Commands:
snapshot Snapshot management
snapshot Deprecated, use `cardano-db` instead
cardano-db Cardano db management (alias: cdb)
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)
Expand All @@ -139,13 +140,13 @@ Options:
--config-directory <CONFIG_DIRECTORY>
Directory where configuration file is located [default: ./config]
--aggregator-endpoint <AGGREGATOR_ENDPOINT>
Override configuration Aggregator endpoint URL [env: AGGREGATOR_ENDPOINT=]
Override configuration Aggregator endpoint URL [env: AGGREGATOR_ENDPOINT=https://aggregator.testing-sanchonet.api.mithril.network/aggregator]
Alenar marked this conversation as resolved.
Show resolved Hide resolved
--log-format-json
Enable JSON output for logs displayed according to verbosity level
--log-output <LOG_OUTPUT>
Redirect the logs to a file
--unstable
Enable unstable commands (such as Cardano Transactions)
Enable unstable commands (Such as Cardano Transactions)
Alenar marked this conversation as resolved.
Show resolved Hide resolved
-h, --help
Print help
-V, --version
Expand Down Expand Up @@ -237,14 +238,14 @@ Now you can use the `mithril_client` functions:
# 1- Help
mithril_client help

# 2- List snapshots
mithril_client snapshot list
# 2- List cardano db
mithril_client cardano-db list

# 3- Show detailed information about a snapshot
mithril_client snapshot show $SNAPSHOT_DIGEST
# 3- Show detailed information about a cardano db
mithril_client cardano-db show $CARDANO_DB_DIGEST

# 4- Download the given snapshot and verify the certificate
mithril_client snapshot download $SNAPSHOT_DIGEST
# 4- Download the given cardano db and verify the certificate
mithril_client cardano-db download $CARDANO_DB_DIGEST

# 5- List Mithril stake distributions
mithril_client mithril-stake-distribution list
Expand Down Expand Up @@ -280,7 +281,12 @@ make docker-run

Here are the subcommands available:

### Snapshot
### Cardano DB (previously: Snapshot)

:::warning
For backward compatibility a `snapshot` alias is available but is deprecated, as it will be removed in the near future please replace
it in your commands with `cardano-db`.
Alenar marked this conversation as resolved.
Show resolved Hide resolved
:::

| Subcommand | Performed action |
|------------|------------------|
Expand Down Expand Up @@ -328,25 +334,25 @@ Here is a list of the available parameters:
| `log_format_json` | `--log-format-json` | - | - | Enable JSON output for logs | - | - | - |
| `log_output` | `--log-output` | `-o` | - | Redirect the logs to a file | - | `./mithril-client.log` | - |

`snapshot show` command:
`cardano-db show` command:

| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
|-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
| `digest` | `--digest` | - | `DIGEST` | Snapshot digest or `latest` for the latest digest | - | - | :heavy_check_mark: |
| `digest` | `--digest` | - | `DIGEST` | Cardano DB digest or `latest` for the latest digest | - | - | :heavy_check_mark: |
| `json` | `--json` | - | - | Enable JSON output for command results | - | - | - |

`snapshot list` command:
`cardano-db list` command:

| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
|-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
| `json` | `--json` | - | - | Enable JSON output for command results | - | - | - |

`snapshot download` command:
`cardano-db download` command:

| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
|-----------|---------------------|:---------------------:|----------------------|-------------|---------------|---------|:---------:|
| `digest` | `--digest` | - | `DIGEST` | Snapshot digest or `latest` for the latest digest | - | - | :heavy_check_mark: |
| `download_dir` | `--download-dir` | - | - | Directory where the snapshot will be downloaded | . | - | - |
| `digest` | `--digest` | - | `DIGEST` | Cardano DB digest or `latest` for the latest digest | - | - | :heavy_check_mark: |
| `download_dir` | `--download-dir` | - | - | Directory where the Cardano DB will be downloaded | . | - | - |
| `json` | `--json` | - | - | Enable JSON output for progress logs | - | - | - |

`mithril-stake-distribution list` command:
Expand Down