Package org.ldk.structs
Interface Persist.PersistInterface
-
- Enclosing class:
- Persist
public static interface Persist.PersistInterface
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ChannelMonitorUpdateStatus
persist_new_channel(OutPoint channel_id, ChannelMonitor data, MonitorUpdateId update_id)
Persist a new channel's data in response to a [`chain::Watch::watch_channel`] call.ChannelMonitorUpdateStatus
update_persisted_channel(OutPoint channel_id, ChannelMonitorUpdate update, ChannelMonitor data, MonitorUpdateId update_id)
Update one channel's data.
-
-
-
Method Detail
-
persist_new_channel
ChannelMonitorUpdateStatus persist_new_channel(OutPoint channel_id, ChannelMonitor data, MonitorUpdateId update_id)
Persist a new channel's data in response to a [`chain::Watch::watch_channel`] call. This is called by [`ChannelManager`] for new channels, or may be called directly, e.g. on startup. The data can be stored any way you want, but the identifier provided by LDK is the channel's outpoint (and it is up to you to maintain a correct mapping between the outpoint and the stored channel data). Note that you **must** persist every new monitor to disk. The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`], if you return [`ChannelMonitorUpdateStatus::InProgress`]. See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor` and [`ChannelMonitorUpdateStatus`] for requirements when returning errors. [`ChannelManager`]: crate::ln::channelmanager::ChannelManager [`Writeable::write`]: crate::util::ser::Writeable::write
-
update_persisted_channel
ChannelMonitorUpdateStatus update_persisted_channel(OutPoint channel_id, ChannelMonitorUpdate update, ChannelMonitor data, MonitorUpdateId update_id)
Update one channel's data. The provided [`ChannelMonitor`] has already applied the given update. Note that on every update, you **must** persist either the [`ChannelMonitorUpdate`] or the updated monitor itself to disk/backups. See the [`Persist`] trait documentation for more details. During blockchain synchronization operations, this may be called with no [`ChannelMonitorUpdate`], in which case the full [`ChannelMonitor`] needs to be persisted. Note that after the full [`ChannelMonitor`] is persisted any previous [`ChannelMonitorUpdate`]s which were persisted should be discarded - they can no longer be applied to the persisted [`ChannelMonitor`] as they were already applied. If an implementer chooses to persist the updates only, they need to make sure that all the updates are applied to the `ChannelMonitors` *before the set of channel monitors is given to the `ChannelManager` deserialization routine. See [`ChannelMonitor::update_monitor`] for applying a monitor update to a monitor. If full `ChannelMonitors` are persisted, then there is no need to persist individual updates. Note that there could be a performance tradeoff between persisting complete channel monitors on every update vs. persisting only updates and applying them in batches. The size of each monitor grows `O(number of state updates)` whereas updates are small and `O(1)`. The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`], if you return [`ChannelMonitorUpdateStatus::InProgress`]. See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`, [`Writeable::write`] on [`ChannelMonitorUpdate`] for writing out an update, and [`ChannelMonitorUpdateStatus`] for requirements when returning errors. [`Writeable::write`]: crate::util::ser::Writeable::write Note that update (or a relevant inner pointer) may be NULL or all-0s to represent None
-
-