Skip to content

Commit 235a88a

Browse files
committed
f more info about upgrading in the changelog
1 parent b3b92a6 commit 235a88a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Backwards Compatibility
22

3-
* Monitors stored with [`MonitorUpdatingPersister`] have a prepended sentinel value that prevents them from being deserialized by previous [`Persist`] implementations. This is to ensure that they are not accidentally read and used while pending updates are still stored separately, as this could result in penalty transactions. Users who wish to downgrade should perform the following steps:
3+
* The [`MonitorUpdatingPersister`] can read monitors stored conventionally, such as with the [`KVStorePersister`]. You can to migrate _to_ the [`MonitorUpdatingPersister`]; just "point" [`MonitorUpdatingPersister`] to existing, fully updated [`ChannelMonitors`], and it will read them and work from there. However, downgrading is more complex. Monitors stored with [`MonitorUpdatingPersister`] have a prepended sentinel value that prevents them from being deserialized by previous [`Persist`] implementations. This is to ensure that they are not accidentally read and used while pending updates are still stored and not applied, as this could result in penalty transactions. Users who wish to downgrade should perform the following steps:
44
* Make a backup copy of all channel state.
5-
* Ensure all updates are applied to the monitors. This may be done by loading all the existing data with the [`MonitorUpdatingPersister::read_channel_monitors_with_updates`] function. You can then write the resulting [`ChannelMonitor`]s using your previous [`Persist`] implementation.
5+
* Ensure all updates are applied to the monitors. This may be done by loading all the existing data with the [`MonitorUpdatingPersister::read_all_channel_monitors_with_updates`] function. You can then write the resulting [`ChannelMonitor`]s using your previous [`Persist`] implementation.

0 commit comments

Comments
 (0)