Skip to content

Commit eda42f1

Browse files
committed
docs(website): add tools commands and parameters to Mithril client documentation
1 parent a52fc71 commit eda42f1

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,7 @@ Commands:
223223
cardano-transaction Cardano transactions management (alias: ctx)
224224
cardano-stake-distribution Cardano stake distribution management (alias: csd)
225225
cardano-db-v2 Deprecated, use `cardano-db` instead
226+
tools [unstable] Tools commands
226227
help Print this message or the help of the given subcommand(s)
227228

228229
Options:
@@ -523,6 +524,13 @@ Here are the subcommands available:
523524
| **snapshot list** | Lists available cardano-db v2 snapshots |
524525
| **snapshot show** | Shows information about a cardano-db v2 snapshot |
525526

527+
### Tools (`unstable`)
528+
529+
| Subcommand | Performed action |
530+
| ----------- | ------------------------------------------------------------------------------------- |
531+
| **utxo-hd** | UTxO-HD related commands (e.g., converting a ledger state snapshot to another flavor) |
532+
| **help** | Prints this message or the help for the given subcommand(s) |
533+
526534
## Configuration parameters
527535

528536
The configuration parameters can be set in either of the following ways:
@@ -670,3 +678,14 @@ Deprecated, use `cardano-db download` with option `--backend v2` instead
670678
| `include_ancillary` | `--include-ancillary` | - | - | Include ancillary files in the download, if set the `ancillary_verification_key` is required in order to verify the ancillary files | `false` | - | - |
671679
| `ancillary_verification_key` | `--ancillary-verification-key` | - | `ANCILLARY_VERIFICATION_KEY` | Ancillary verification key to verify the ancillary files | - | - | - |
672680
| `allow_override` | `--allow-override` | - | - | Allow existing files in the download directory to be overridden | `false` | - | - |
681+
682+
`tools utxo-hd snapshot-converter` command:
683+
684+
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
685+
| ---------------------- | ------------------------ | :------------------: | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | -------- | :----------------: |
686+
| `db_directory` | `--db-directory` | - | - | Path to the Cardano node database directory | - | - | :heavy_check_mark: |
687+
| `cardano_node_version` | `--cardano-node-version` | - | - | Cardano node version of the Mithril signed snapshot (`latest` and `pre-release` are also supported to download the latest or pre-release distribution.) | - | `10.4.1` | :heavy_check_mark: |
688+
| `cardano_network` | `--cardano-network` | - | - | Cardano network | - | - | :heavy_check_mark: |
689+
| `utxo_hd_flavor` | `--utxo-hd-flavor` | - | - | UTxO-HD flavor to convert the ledger snapshot to (`Legacy` or `LMDB`) | - | `LMDB` | :heavy_check_mark: |
690+
| `commit` | `--commit` | - | - | Replaces the current ledger state in the `db_directory` | `false` | - | - |
691+
| `github_token` | `--github-token` | - | `GITHUB_TOKEN` | GitHub token for authenticated API calls | - | - | - |

0 commit comments

Comments
 (0)