Skip to content

Commit b6a9854

Browse files
committed
docs: add blog post for UTxO-HD ledger state snapshot conversion command in mithril-client CLI
1 parent ce42d51 commit b6a9854

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Mithril client CLI new 'tools utxo-hd snapshot-converter' command
3+
authors:
4+
- name: Mithril Team
5+
tags: [mithril client, cli, command, utxo-hd, conversion]
6+
---
7+
8+
### Introducing 'tools utxo-hd snapshot-converter' command
9+
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**.
11+
12+
Since the release of the Cardano node [10.1.4](https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1), the Cardano database restoration downloads an `InMemory` UTxO-HD ledger state snapshot. However, if your Cardano node is configured for an on-disk format (`LMDB`) or the `legacy` UTxO-HD format, you need to convert that snapshot before running it.
13+
14+
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`). It uses the `snapshot-converter` binary under the hood, bundled with the Cardano node distribution.
15+
16+
This conversion tool is `unstable` and is available for Linux, macOS and Windows.
17+
18+
Usage:
19+
20+
```bash
21+
mithril-client --unstable tools utxo-hd snapshot-converter --db-directory $DB_DIRECTORY --cardano-node-version latest --utxo-hd-flavor $UTXO_HD_FLAVOR --cardano-network $CARDANO_NETWORK
22+
```
23+
24+
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.
25+
26+
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).
27+
28+
For any inquiries or assistance, don't hesitate to reach out to the team on the [Discord channel](https://discord.gg/5kaErDKDRq).

0 commit comments

Comments
 (0)