mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-25 15:20:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Rename ClosingMonitorUpdateRegeneratedOnStartup to Closed...

Browse source 
Now that we also use the "Closing" `BackgroundEvent` for
already-closed channels we need to rename it and tweak the docs.
This commit is contained in:
Matt Corallo 2023-07-07 15:01:05 +00:00
parent 345f8df28f
commit 9ce7e8e650
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
lightning/src/ln/channelmanager.rs
View file

@ -507,19 +507,19 @@ struct ClaimablePayments {
/// running normally, and specifically must be processed before any other non-background /// running normally, and specifically must be processed before any other non-background
/// [`ChannelMonitorUpdate`]s are applied. /// [`ChannelMonitorUpdate`]s are applied.
enum BackgroundEvent { enum BackgroundEvent {
/// Handle a ChannelMonitorUpdate which closes the channel. This is only separated from /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
/// [`Self::MonitorUpdateRegeneratedOnStartup`] as the maybe-non-closing variant needs a public /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
/// key to handle channel resumption, whereas if the channel has been force-closed we do not /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
/// need the counterparty node_id. /// channel has been force-closed we do not need the counterparty node_id.
/// ///
/// Note that any such events are lost on shutdown, so in general they must be updates which /// Note that any such events are lost on shutdown, so in general they must be updates which
/// are regenerated on startup. /// are regenerated on startup.
ClosingMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)), ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)),
/// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
/// channel to continue normal operation. /// channel to continue normal operation.
/// ///
/// In general this should be used rather than /// In general this should be used rather than
/// [`Self::ClosingMonitorUpdateRegeneratedOnStartup`], however in cases where the /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
/// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`] /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
/// error the other variant is acceptable. /// error the other variant is acceptable.
/// ///
@ -4103,7 +4103,7 @@ where
for event in background_events.drain(..) { for event in background_events.drain(..) {
match event { match event {
BackgroundEvent::ClosingMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => { BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
// The channel has already been closed, so no use bothering to care about the // The channel has already been closed, so no use bothering to care about the
// monitor updating completing. // monitor updating completing.
let _ = self.chain_monitor.update_channel(funding_txo, &update); let _ = self.chain_monitor.update_channel(funding_txo, &update);
@ -4763,7 +4763,7 @@ where
// If we're running during init we cannot update a monitor directly - they probably // If we're running during init we cannot update a monitor directly - they probably
// haven't actually been loaded yet. Instead, push the monitor update as a background // haven't actually been loaded yet. Instead, push the monitor update as a background
// event. // event.
// Note that while its safe to use `ClosingMonitorUpdateRegeneratedOnStartup` here (the // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
// channel is already closed) we need to ultimately handle the monitor update // channel is already closed) we need to ultimately handle the monitor update
// completion action only after we've completed the monitor update. This is the only // completion action only after we've completed the monitor update. This is the only
// way to guarantee this update *will* be regenerated on startup (otherwise if this was // way to guarantee this update *will* be regenerated on startup (otherwise if this was
@ -4771,7 +4771,7 @@ where
// upstream). Thus, we need to transition to some new `BackgroundEvent` type which will // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
// complete the monitor update completion action from `completion_action`. // complete the monitor update completion action from `completion_action`.
self.pending_background_events.lock().unwrap().push( self.pending_background_events.lock().unwrap().push(
BackgroundEvent::ClosingMonitorUpdateRegeneratedOnStartup(( BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
prev_hop.outpoint, preimage_update, prev_hop.outpoint, preimage_update,
))); )));
} }
@ -8262,7 +8262,7 @@ where
update_id: CLOSED_CHANNEL_UPDATE_ID, update_id: CLOSED_CHANNEL_UPDATE_ID,
updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }], updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
}; };
close_background_events.push(BackgroundEvent::ClosingMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update))); close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
} }
} }