Skip to content

Commit d7f163e

Browse files
committed
Clarify how should snapshots be upgraded in 10.4 -> 10.5
1 parent 09e91f2 commit d7f163e

File tree

1 file changed

+24
-3
lines changed
  • docs/website/contents/references/miscellaneous/utxo-hd

1 file changed

+24
-3
lines changed

docs/website/contents/references/miscellaneous/utxo-hd/migrating.mdx

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ follows:
142142
</Tabs>
143143
</div>
144144

145-
## Convert the existing Ledger snapshots with `snapshot-converter`
145+
## Upgrading a Ledger snapshots from 10.4.x to 10.5.x
146146

147147
:::warning
148148

@@ -157,8 +157,29 @@ chain from Genesis, however this can take some hours.
157157

158158
We provide the `snapshot-converter` tool which can load a snapshot in the Legacy
159159
format and write it either in the in-memory or on-disk formats for
160-
UTxO-HD. Supposing you have copied a legacy snapshot to
161-
`<tmpdir>/snapshots/<slotno>` you can run the following command:
160+
UTxO-HD.
161+
162+
:::info
163+
164+
On cardano-node 10.6 there was a change in serialization unrelated to the
165+
UTxO-HD changes. This means that going from 10.4.x to 10.5.x can benefit from
166+
this doing a quick conversion using `snapshot-converter` as explained here, but
167+
it won't work when the target is 10.6 or newer. Such an update on the format can
168+
only be done via a replay of the chain.
169+
170+
The `snapshot-converter` tool still exists in the repository and will convert
171+
between the different UTxO-HD formats but it will no longer be able to load a
172+
snapshot older than 10.6, and therefore it won't be able to "upgrade" a Legacy
173+
snapshot to a UTxO-HD snapshot anymore.
174+
175+
For this reason, the process below is only useful for upgrading from 10.4.x to
176+
10.5.x, and **it must be performed with the `snapshot-converter` version that
177+
was released with nodes 10.5.x**.
178+
179+
:::
180+
181+
Supposing you have copied a legacy snapshot to `<tmpdir>/snapshots/<slotno>` you
182+
can run the following command:
162183

163184
<div class="tabsblock">
164185
<Tabs>

0 commit comments

Comments
 (0)