Skip to content

Commit 15d8026

Browse files
committed
docs: apply suggestions from PR review
1 parent 06c1b3e commit 15d8026

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed
Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
2-
title: Mithril client CLI new UTxO snapshot converter command
2+
title: Introducing the UTXO snapshot converter command in the Mithril client CLI
33
authors:
44
- name: Mithril Team
55
tags: [mithril client, cli, command, utxo-hd, conversion]
66
---
77

8-
### Introducing UTxO snapshot converter command in client CLI
8+
### Introducing the UTXO snapshot converter command in the Mithril client CLI
99

10-
With the release of the new distribution [2524](https://github.com/input-output-hk/mithril/releases/tag/2524.0), we have added the **tools** command in the **client CLI**.
10+
With the release of the new [2524](https://github.com/input-output-hk/mithril/releases/tag/2524.0) distribution, the **tools** command has been added to the **Mithril client CLI**.
1111

12-
Since the release of the Cardano node [10.1.4](https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1), the Mithril aggregator node produces snapshots of the Cardano database with `InMemory` UTxO-HD flavor.
12+
Since the release of Cardano node [v.10.4.1](https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1), the Mithril aggregator node has been producing snapshots of the Cardano database using the `InMemory` UTXO-HD flavor.
1313

14-
When restoring a Cardano database snapshot, if your Cardano node is configured for an on-disk format (`LMDB`) or the `legacy` format (Cardano node `10.3` and previous versions), you will need to convert that snapshot before restarting your Cardano node.
14+
When restoring a Cardano database snapshot, if the Cardano node is configured to use the on-disk (LMDB) or `Legacy` format (as in Cardano node v.10.3 and earlier), the snapshot must be converted before restarting the node.
1515

16-
The new `utxo-hd snapshot-converter` subcommand streamlines the Cardano node bootstrapping process by converting the restored ledger state snapshot into the expected flavor (on-disk `LMDB` or `Legacy`).
16+
The new `utxo-hd snapshot-converter` subcommand simplifies node bootstrapping by converting the restored ledger state snapshot into the required format (`LMDB` or `Legacy`).
1717

18-
This conversion tool is `unstable` and is available for Linux, macOS and Windows.
18+
This conversion tool is currently marked as `unstable` and is available on Linux, macOS, and Windows.
1919

20-
It uses the `snapshot-converter` binary under the hood, bundled with the Cardano node distribution.
20+
It operates using the `snapshot-converter` binary included with the Cardano node distribution.
2121

2222
Usage:
2323

@@ -27,13 +27,13 @@ mithril-client --unstable tools utxo-hd snapshot-converter --db-directory $DB_DI
2727

2828
Parameters:
2929

30-
- `--db-directory`: Path to the Cardano database directory.
31-
- `--cardano-node-version`: Version used to download the `snapshot-converter` binary (specific version eg. `10.1.4`, `latest` or `prerelease`).
32-
- `--utxo-hd-flavor`: Target UTxO-HD flavor (`LMDB` or `Legacy`).
33-
- `--cardano-network`: Cardano network (`preview`, `preprod` or `mainnet`)
30+
- `--db-directory`: path to the Cardano database directory
31+
- `--cardano-node-version`: version used to download the `snapshot-converter` binary (specific version, eg, `10.1.4`, `latest`, or `prerelease`)
32+
- `--utxo-hd-flavor`: target UTXO-HD flavor (`LMDB` or `Legacy`)
33+
- `--cardano-network`: Cardano network (`preview`, `preprod` or `mainnet`).
3434

35-
A new optional [step](https://mithril.network/doc/manual/getting-started/bootstrap-cardano-node#step-5-optional-convert-the-ledger-state-snapshot-to-another-flavor) has been added to the 'Bootstrap a Cardano node' guide, describing how to use the command.
35+
The 'Bootstrap a Cardano node' guide now includes a new optional [step](https://mithril.network/doc/manual/getting-started/bootstrap-cardano-node#step-5-optional-convert-the-ledger-state-snapshot-to-another-flavor) that describes how to use the command.
3636

37-
The documentation of the **client CLI** has been updated accordingly and can be found [here](https://mithril.network/doc/manual/developer-docs/nodes/mithril-client#tools-unstable).
37+
The documentation for the **client CLI** has been updated accordingly and is available [here](https://mithril.network/doc/manual/developer-docs/nodes/mithril-client#tools-unstable).
3838

39-
For any inquiries or assistance, don't hesitate to reach out to the team on the [Discord channel](https://discord.gg/5kaErDKDRq).
39+
For any inquiries or assistance, contact the team on the [Discord channel](https://discord.gg/5kaErDKDRq).

0 commit comments

Comments
 (0)