Panic if we're running with outdated state instead of force-closing#1564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 2 commits into from
Jun 27, 2022
Merged

Panic if we're running with outdated state instead of force-closing #1564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ed3f25
Add ChannelManager methods to force close without broadcasting
TheBlueMatt Jun 23, 2022
caa2a9a
Panic if we're running with outdated state instead of force-closing
TheBlueMatt Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions fuzz/src/full_stack.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -252,7 +252,7 @@ impl<'a> Drop for MoneyLossDetector<'a> {
}

// Force all channels onto the chain (and time out claim txn)
self.manager.force_close_all_channels();
self.manager.force_close_all_channels_broadcasting_latest_txn();
}
}
}
Expand DownExpand Up@@ -624,7 +624,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
let channel_id = get_slice!(1)[0] as usize;
if channel_id >= channels.len() { return; }
channels.sort_by(|a, b| { a.channel_id.cmp(&b.channel_id) });
channelmanager.force_close_channel(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
channelmanager.force_close_broadcasting_latest_txn(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
},
// 15 is above
_ => return,
Expand Down
4 changes: 2 additions & 2 deletions lightning-background-processor/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -744,7 +744,7 @@ mod tests {
}

// Force-close the channel.
nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
nodes[0].node.force_close_broadcasting_latest_txn(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();

// Check that the force-close updates are persisted.
check_persisted_data!(nodes[0].node, filepath.clone());
Expand DownExpand Up@@ -880,7 +880,7 @@ mod tests {
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));

// Force close the channel and check that the SpendableOutputs event was handled.
nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
let event = receiver
Expand Down
6 changes: 3 additions & 3 deletions lightning-persister/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -213,7 +213,7 @@ mod tests {

// Force close because cooperative close doesn't result in any persisted
// updates.
nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
check_closed_broadcast!(nodes[0], true);
check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -247,7 +247,7 @@ mod tests {
let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand DownExpand Up@@ -286,7 +286,7 @@ mod tests {
let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/chanmon_update_fail_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
}

// ...and make sure we can force-close a frozen channel
nodes[0].node.force_close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
check_added_monitors!(nodes[0], 1);
check_closed_broadcast!(nodes[0], true);

Expand Down
26 changes: 20 additions & 6 deletions lightning/src/ln/channel.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -802,7 +802,6 @@ pub(super) enum ChannelError {
Ignore(String),
Warn(String),
Close(String),
CloseDelayBroadcast(String),
}

impl fmt::Debug for ChannelError {
Expand All@@ -811,7 +810,6 @@ impl fmt::Debug for ChannelError {
&ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
&ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
&ChannelError::Close(ref e) => write!(f, "Close : {}", e),
&ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
}
}
}
Expand DownExpand Up@@ -3799,6 +3797,11 @@ impl<Signer: Sign> Channel<Signer> {

/// May panic if some calls other than message-handling calls (which will all Err immediately)
/// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
///
/// Some links printed in log lines are included here to check them during build (when run with
/// `cargo doc --document-private-items`):
/// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
/// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L,
node_pk: PublicKey, genesis_block_hash: BlockHash, best_block: &BestBlock)
-> Result<ReestablishResponses, ChannelError> where L::Target: Logger {
Expand All@@ -3824,9 +3827,20 @@ impl<Signer: Sign> Channel<Signer> {
return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
}
if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
return Err(ChannelError::CloseDelayBroadcast(
"We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting".to_owned()
));
macro_rules! log_and_panic {

@jkczyzjkczyzJun 24, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is a macro needed? Could just use a variable for $err_msg.

@TheBlueMattTheBlueMattJun 24, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not directly - format strings have to be an explicit string, they can't be a &'static str or whatever, so I'm not sure how to do this without either repeating the whole string or a macro.

@jkczyzjkczyzJun 24, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you can format it first with let err_msg = format!("..", ..) and then use "{}", err_msg in each statement. Or maybe there is a more idiomatic way of using format_args!?

@TheBlueMattTheBlueMattJun 24, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, no, format_args doesn't seem to do it either. Do you find the current code particularly unreadable? It seems fine to me, given its the one way to do it without building the full string first.

@jkczyzjkczyzJun 24, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, just figured we could do it without using a macro. Given it's gonna panic there's not a huge argument for building the string. Fine either way.

($err_msg: expr) => {
log_error!(logger, $err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
panic!($err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
}
}
log_and_panic!("We have fallen behind - we have received proof that if we broadcast our counterparty is going to claim all our funds.\n\
This implies you have restarted with lost ChannelMonitor and ChannelManager state, the first of which is a violation of the LDK chain::Watch requirements.\n\
More specifically, this means you have a bug in your implementation that can cause loss of funds, or you are running with an old backup, which is unsafe.\n\
If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
Note that due to a long-standing bug in lnd you may have to reach out to peers running lnd-based nodes to ask them to manually force-close channels\n\
See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
}
},
OptionalField::Absent => {}
Expand DownExpand Up@@ -3933,7 +3947,7 @@ impl<Signer: Sign> Channel<Signer> {
// now!
match self.free_holding_cell_htlcs(logger) {
Err(ChannelError::Close(msg)) => Err(ChannelError::Close(msg)),
Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) =>
panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
Ok((Some((commitment_update, monitor_update)), holding_cell_failed_htlcs)) => {
Ok(ReestablishResponses {
Expand Down
66 changes: 37 additions & 29 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -369,15 +369,6 @@ impl MsgHandleErrInternal {
},
},
},
ChannelError::CloseDelayBroadcast(msg) => LightningError {
err: msg.clone(),
action: msgs::ErrorAction::SendErrorMessage {
msg: msgs::ErrorMessage {
channel_id,
data: msg
},
},
},
},
chan_id: None,
shutdown_finish: None,
Expand DownExpand Up@@ -1273,13 +1264,6 @@ macro_rules! convert_chan_err {
(true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
},
ChannelError::CloseDelayBroadcast(msg) => {
log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
update_maps_on_chan_removal!($self, $short_to_id, $channel);
let shutdown_res = $channel.force_shutdown(false);
(true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
}
}
}
}
Expand DownExpand Up@@ -1945,7 +1929,8 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana

/// `peer_msg` should be set when we receive a message from a peer, but not set when the
/// user closes, which will be re-exposed as the `ChannelClosed` reason.
fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>) -> Result<PublicKey, APIError> {
fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
-> Result<PublicKey, APIError> {
let mut chan = {
let mut channel_state_lock = self.channel_state.lock().unwrap();
let channel_state = &mut *channel_state_lock;
Expand All@@ -1964,7 +1949,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
}
};
log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
self.finish_force_close_channel(chan.force_shutdown(true));
self.finish_force_close_channel(chan.force_shutdown(broadcast));
if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
let mut channel_state = self.channel_state.lock().unwrap();
channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
Expand All@@ -1975,13 +1960,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
Ok(chan.get_counterparty_node_id())
}

/// Force closes a channel, immediately broadcasting the latest local commitment transaction to
/// the chain and rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
/// channel.
pub fn force_close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None) {
match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
Ok(counterparty_node_id) => {
self.channel_state.lock().unwrap().pending_msg_events.push(
events::MessageSendEvent::HandleError {
Expand All@@ -1997,11 +1978,39 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
}
}

/// Force closes a channel, immediately broadcasting the latest local transaction(s) and
/// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
/// channel.
pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
-> Result<(), APIError> {
self.force_close_sending_error(channel_id, counterparty_node_id, true)
}

/// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
/// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
/// `counterparty_node_id` isn't the counterparty of the corresponding channel.
///
/// You can always get the latest local transaction(s) to broadcast from
/// [`ChannelMonitor::get_latest_holder_commitment_txn`].
pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
-> Result<(), APIError> {
self.force_close_sending_error(channel_id, counterparty_node_id, false)
}

/// Force close all channels, immediately broadcasting the latest local commitment transaction
/// for each to the chain and rejecting new HTLCs on each.
pub fn force_close_all_channels(&self) {
pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
for chan in self.list_channels() {
let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
}
}

/// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
/// local transaction(s).
pub fn force_close_all_channels_without_broadcasting_txn(&self) {
for chan in self.list_channels() {
let _ = self.force_close_channel(&chan.channel_id, &chan.counterparty.node_id);
let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
}
}

Expand DownExpand Up@@ -3188,7 +3197,6 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
// ChannelClosed event is generated by handle_error for us.
Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel.channel_id(), channel.get_user_id(), channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
},
ChannelError::CloseDelayBroadcast(_) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
};
handle_errors.push((counterparty_node_id, err));
continue;
Expand DownExpand Up@@ -6058,7 +6066,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
for chan in self.list_channels() {
if chan.counterparty.node_id == *counterparty_node_id {
// Untrusted messages from peer, we throw away the error if id points to a non-existent channel
let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data));
let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
}
}
} else {
Expand All@@ -6080,7 +6088,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
}

// Untrusted messages from peer, we throw away the error if id points to a non-existent channel
let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data));
let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
}
}
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Panic if we're running with outdated state instead of force-closing#1564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Jun 27, 2022
 Merged


Panic if we're running with outdated state instead of force-closing
#1564
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ed3f25

Add ChannelManager methods to force close without broadcasting


TheBlueMatt Jun 23, 2022
caa2a9a

Panic if we're running with outdated state instead of force-closing


TheBlueMatt Jun 23, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -252,7 +252,7 @@ impl<'a> Drop for MoneyLossDetector<'a> {
 }

 // Force all channels onto the chain (and time out claim txn)
 self.manager.force_close_all_channels();
 self.manager.force_close_all_channels_broadcasting_latest_txn();
 }
	}
}
Expand DownExpand Up@@ -624,7 +624,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let channel_id = get_slice!(1)[0] as usize;
 if channel_id >= channels.len() { return; }
 channels.sort_by(|a, b| { a.channel_id.cmp(&b.channel_id) });
 channelmanager.force_close_channel(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 channelmanager.force_close_broadcasting_latest_txn(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 },
 // 15 is above
 _ => return,
Expand Down

4 changes: 2 additions & 2 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -744,7 +744,7 @@ mod tests {
 }

 // Force-close the channel.
 nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();

 // Check that the force-close updates are persisted.
 check_persisted_data!(nodes[0].node, filepath.clone());
Expand DownExpand Up@@ -880,7 +880,7 @@ mod tests {
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
 let event = receiver
Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,7 +213,7 @@ mod tests {

 // Force close because cooperative close doesn't result in any persisted
 // updates.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
 check_closed_broadcast!(nodes[0], true);
 check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -247,7 +247,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand DownExpand Up@@ -286,7 +286,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
	}

	// ...and make sure we can force-close a frozen channel
	nodes[0].node.force_close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors!(nodes[0], 1);
	check_closed_broadcast!(nodes[0], true);

Expand Down

26 changes: 20 additions & 6 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -802,7 +802,6 @@ pub(super) enum ChannelError {
	Ignore(String),
	Warn(String),
	Close(String),
	CloseDelayBroadcast(String),
}

impl fmt::Debug for ChannelError {
Expand All@@ -811,7 +810,6 @@ impl fmt::Debug for ChannelError {
 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
 &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
 }
	}
}
Expand DownExpand Up@@ -3799,6 +3797,11 @@ impl<Signer: Sign> Channel<Signer> {

	/// May panic if some calls other than message-handling calls (which will all Err immediately)
	/// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
	///
	/// Some links printed in log lines are included here to check them during build (when run with
	/// `cargo doc --document-private-items`):
	/// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
	/// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
	pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L,
 node_pk: PublicKey, genesis_block_hash: BlockHash, best_block: &BestBlock)
	-> Result<ReestablishResponses, ChannelError> where L::Target: Logger {
Expand All@@ -3824,9 +3827,20 @@ impl<Signer: Sign> Channel<Signer> {
 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
 }
 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
 return Err(ChannelError::CloseDelayBroadcast(
 "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting".to_owned()
 ));
 macro_rules! log_and_panic {
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is a macro needed? Could just use a variable for $err_msg.
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not directly - format strings have to be an explicit string, they can't be a &'static str or whatever, so I'm not sure how to do this without either repeating the whole string or a macro.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you can format it first with let err_msg = format!("..", ..) and then use "{}", err_msg in each statement. Or maybe there is a more idiomatic way of using format_args!?
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, no, format_args doesn't seem to do it either. Do you find the current code particularly unreadable? It seems fine to me, given its the one way to do it without building the full string first.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, just figured we could do it without using a macro. Given it's gonna panic there's not a huge argument for building the string. Fine either way.
 ($err_msg: expr) => {
 log_error!(logger, $err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 panic!($err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 }
 }
 log_and_panic!("We have fallen behind - we have received proof that if we broadcast our counterparty is going to claim all our funds.\n\
 This implies you have restarted with lost ChannelMonitor and ChannelManager state, the first of which is a violation of the LDK chain::Watch requirements.\n\
 More specifically, this means you have a bug in your implementation that can cause loss of funds, or you are running with an old backup, which is unsafe.\n\
 If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
 ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
 ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
 Note that due to a long-standing bug in lnd you may have to reach out to peers running lnd-based nodes to ask them to manually force-close channels\n\
 See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
 }
 },
 OptionalField::Absent => {}
Expand DownExpand Up@@ -3933,7 +3947,7 @@ impl<Signer: Sign> Channel<Signer> {
 // now!
 match self.free_holding_cell_htlcs(logger) {
 Err(ChannelError::Close(msg)) => Err(ChannelError::Close(msg)),
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) =>
 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
 Ok((Some((commitment_update, monitor_update)), holding_cell_failed_htlcs)) => {
 Ok(ReestablishResponses {
Expand Down

66 changes: 37 additions & 29 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,15 +369,6 @@ impl MsgHandleErrInternal {
 },
 },
 },
 ChannelError::CloseDelayBroadcast(msg) => LightningError {
 err: msg.clone(),
 action: msgs::ErrorAction::SendErrorMessage {
 msg: msgs::ErrorMessage {
 channel_id,
 data: msg
 },
 },
 },
 },
 chan_id: None,
 shutdown_finish: None,
Expand DownExpand Up@@ -1273,13 +1264,6 @@ macro_rules! convert_chan_err {
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(msg) => {
 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
 update_maps_on_chan_removal!($self, $short_to_id, $channel);
 let shutdown_res = $channel.force_shutdown(false);
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 }
 }
	}
}
Expand DownExpand Up@@ -1945,7 +1929,8 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana

	/// `peer_msg` should be set when we receive a message from a peer, but not set when the
	/// user closes, which will be re-exposed as the `ChannelClosed` reason.
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>) -> Result<PublicKey, APIError> {
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
	-> Result<PublicKey, APIError> {
 let mut chan = {
 let mut channel_state_lock = self.channel_state.lock().unwrap();
 let channel_state = &mut *channel_state_lock;
Expand All@@ -1964,7 +1949,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
 };
 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
 self.finish_force_close_channel(chan.force_shutdown(true));
 self.finish_force_close_channel(chan.force_shutdown(broadcast));
 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
 let mut channel_state = self.channel_state.lock().unwrap();
 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
Expand All@@ -1975,13 +1960,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 Ok(chan.get_counterparty_node_id())
	}

	/// Force closes a channel, immediately broadcasting the latest local commitment transaction to
	/// the chain and rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
	fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None) {
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
 Ok(counterparty_node_id) => {
 self.channel_state.lock().unwrap().pending_msg_events.push(
 events::MessageSendEvent::HandleError {
Expand All@@ -1997,11 +1978,39 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
	}

	/// Force closes a channel, immediately broadcasting the latest local transaction(s) and
	/// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, true)
	}

	/// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
	/// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
	/// `counterparty_node_id` isn't the counterparty of the corresponding channel.
	///
	/// You can always get the latest local transaction(s) to broadcast from
	/// [`ChannelMonitor::get_latest_holder_commitment_txn`].
	pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, false)
	}

	/// Force close all channels, immediately broadcasting the latest local commitment transaction
	/// for each to the chain and rejecting new HTLCs on each.
	pub fn force_close_all_channels(&self) {
	pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

	/// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
	/// local transaction(s).
	pub fn force_close_all_channels_without_broadcasting_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_channel(&chan.channel_id, &chan.counterparty.node_id);
 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

Expand DownExpand Up@@ -3188,7 +3197,6 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 // ChannelClosed event is generated by handle_error for us.
 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel.channel_id(), channel.get_user_id(), channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(_) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
 };
 handle_errors.push((counterparty_node_id, err));
 continue;
Expand DownExpand Up@@ -6058,7 +6066,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 for chan in self.list_channels() {
 if chan.counterparty.node_id == *counterparty_node_id {
 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
 }
 } else {
Expand All@@ -6080,7 +6088,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 }

 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
	}
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Panic if we're running with outdated state instead of force-closing#1564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Jun 27, 2022
 Merged


Panic if we're running with outdated state instead of force-closing
#1564
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ed3f25

Add ChannelManager methods to force close without broadcasting


TheBlueMatt Jun 23, 2022
caa2a9a

Panic if we're running with outdated state instead of force-closing


TheBlueMatt Jun 23, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -252,7 +252,7 @@ impl<'a> Drop for MoneyLossDetector<'a> {
 }

 // Force all channels onto the chain (and time out claim txn)
 self.manager.force_close_all_channels();
 self.manager.force_close_all_channels_broadcasting_latest_txn();
 }
	}
}
Expand DownExpand Up@@ -624,7 +624,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let channel_id = get_slice!(1)[0] as usize;
 if channel_id >= channels.len() { return; }
 channels.sort_by(|a, b| { a.channel_id.cmp(&b.channel_id) });
 channelmanager.force_close_channel(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 channelmanager.force_close_broadcasting_latest_txn(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 },
 // 15 is above
 _ => return,
Expand Down

4 changes: 2 additions & 2 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -744,7 +744,7 @@ mod tests {
 }

 // Force-close the channel.
 nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();

 // Check that the force-close updates are persisted.
 check_persisted_data!(nodes[0].node, filepath.clone());
Expand DownExpand Up@@ -880,7 +880,7 @@ mod tests {
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
 let event = receiver
Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,7 +213,7 @@ mod tests {

 // Force close because cooperative close doesn't result in any persisted
 // updates.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
 check_closed_broadcast!(nodes[0], true);
 check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -247,7 +247,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand DownExpand Up@@ -286,7 +286,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
	}

	// ...and make sure we can force-close a frozen channel
	nodes[0].node.force_close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors!(nodes[0], 1);
	check_closed_broadcast!(nodes[0], true);

Expand Down

26 changes: 20 additions & 6 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -802,7 +802,6 @@ pub(super) enum ChannelError {
	Ignore(String),
	Warn(String),
	Close(String),
	CloseDelayBroadcast(String),
}

impl fmt::Debug for ChannelError {
Expand All@@ -811,7 +810,6 @@ impl fmt::Debug for ChannelError {
 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
 &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
 }
	}
}
Expand DownExpand Up@@ -3799,6 +3797,11 @@ impl<Signer: Sign> Channel<Signer> {

	/// May panic if some calls other than message-handling calls (which will all Err immediately)
	/// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
	///
	/// Some links printed in log lines are included here to check them during build (when run with
	/// `cargo doc --document-private-items`):
	/// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
	/// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
	pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L,
 node_pk: PublicKey, genesis_block_hash: BlockHash, best_block: &BestBlock)
	-> Result<ReestablishResponses, ChannelError> where L::Target: Logger {
Expand All@@ -3824,9 +3827,20 @@ impl<Signer: Sign> Channel<Signer> {
 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
 }
 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
 return Err(ChannelError::CloseDelayBroadcast(
 "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting".to_owned()
 ));
 macro_rules! log_and_panic {
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is a macro needed? Could just use a variable for $err_msg.
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not directly - format strings have to be an explicit string, they can't be a &'static str or whatever, so I'm not sure how to do this without either repeating the whole string or a macro.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you can format it first with let err_msg = format!("..", ..) and then use "{}", err_msg in each statement. Or maybe there is a more idiomatic way of using format_args!?
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, no, format_args doesn't seem to do it either. Do you find the current code particularly unreadable? It seems fine to me, given its the one way to do it without building the full string first.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, just figured we could do it without using a macro. Given it's gonna panic there's not a huge argument for building the string. Fine either way.
 ($err_msg: expr) => {
 log_error!(logger, $err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 panic!($err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 }
 }
 log_and_panic!("We have fallen behind - we have received proof that if we broadcast our counterparty is going to claim all our funds.\n\
 This implies you have restarted with lost ChannelMonitor and ChannelManager state, the first of which is a violation of the LDK chain::Watch requirements.\n\
 More specifically, this means you have a bug in your implementation that can cause loss of funds, or you are running with an old backup, which is unsafe.\n\
 If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
 ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
 ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
 Note that due to a long-standing bug in lnd you may have to reach out to peers running lnd-based nodes to ask them to manually force-close channels\n\
 See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
 }
 },
 OptionalField::Absent => {}
Expand DownExpand Up@@ -3933,7 +3947,7 @@ impl<Signer: Sign> Channel<Signer> {
 // now!
 match self.free_holding_cell_htlcs(logger) {
 Err(ChannelError::Close(msg)) => Err(ChannelError::Close(msg)),
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) =>
 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
 Ok((Some((commitment_update, monitor_update)), holding_cell_failed_htlcs)) => {
 Ok(ReestablishResponses {
Expand Down

66 changes: 37 additions & 29 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,15 +369,6 @@ impl MsgHandleErrInternal {
 },
 },
 },
 ChannelError::CloseDelayBroadcast(msg) => LightningError {
 err: msg.clone(),
 action: msgs::ErrorAction::SendErrorMessage {
 msg: msgs::ErrorMessage {
 channel_id,
 data: msg
 },
 },
 },
 },
 chan_id: None,
 shutdown_finish: None,
Expand DownExpand Up@@ -1273,13 +1264,6 @@ macro_rules! convert_chan_err {
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(msg) => {
 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
 update_maps_on_chan_removal!($self, $short_to_id, $channel);
 let shutdown_res = $channel.force_shutdown(false);
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 }
 }
	}
}
Expand DownExpand Up@@ -1945,7 +1929,8 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana

	/// `peer_msg` should be set when we receive a message from a peer, but not set when the
	/// user closes, which will be re-exposed as the `ChannelClosed` reason.
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>) -> Result<PublicKey, APIError> {
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
	-> Result<PublicKey, APIError> {
 let mut chan = {
 let mut channel_state_lock = self.channel_state.lock().unwrap();
 let channel_state = &mut *channel_state_lock;
Expand All@@ -1964,7 +1949,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
 };
 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
 self.finish_force_close_channel(chan.force_shutdown(true));
 self.finish_force_close_channel(chan.force_shutdown(broadcast));
 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
 let mut channel_state = self.channel_state.lock().unwrap();
 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
Expand All@@ -1975,13 +1960,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 Ok(chan.get_counterparty_node_id())
	}

	/// Force closes a channel, immediately broadcasting the latest local commitment transaction to
	/// the chain and rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
	fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None) {
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
 Ok(counterparty_node_id) => {
 self.channel_state.lock().unwrap().pending_msg_events.push(
 events::MessageSendEvent::HandleError {
Expand All@@ -1997,11 +1978,39 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
	}

	/// Force closes a channel, immediately broadcasting the latest local transaction(s) and
	/// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, true)
	}

	/// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
	/// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
	/// `counterparty_node_id` isn't the counterparty of the corresponding channel.
	///
	/// You can always get the latest local transaction(s) to broadcast from
	/// [`ChannelMonitor::get_latest_holder_commitment_txn`].
	pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, false)
	}

	/// Force close all channels, immediately broadcasting the latest local commitment transaction
	/// for each to the chain and rejecting new HTLCs on each.
	pub fn force_close_all_channels(&self) {
	pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

	/// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
	/// local transaction(s).
	pub fn force_close_all_channels_without_broadcasting_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_channel(&chan.channel_id, &chan.counterparty.node_id);
 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

Expand DownExpand Up@@ -3188,7 +3197,6 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 // ChannelClosed event is generated by handle_error for us.
 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel.channel_id(), channel.get_user_id(), channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(_) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
 };
 handle_errors.push((counterparty_node_id, err));
 continue;
Expand DownExpand Up@@ -6058,7 +6066,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 for chan in self.list_channels() {
 if chan.counterparty.node_id == *counterparty_node_id {
 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
 }
 } else {
Expand All@@ -6080,7 +6088,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 }

 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
	}
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Panic if we're running with outdated state instead of force-closing#1564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Jun 27, 2022
 Merged


Panic if we're running with outdated state instead of force-closing
#1564
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ed3f25

Add ChannelManager methods to force close without broadcasting


TheBlueMatt Jun 23, 2022
caa2a9a

Panic if we're running with outdated state instead of force-closing


TheBlueMatt Jun 23, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -252,7 +252,7 @@ impl<'a> Drop for MoneyLossDetector<'a> {
 }

 // Force all channels onto the chain (and time out claim txn)
 self.manager.force_close_all_channels();
 self.manager.force_close_all_channels_broadcasting_latest_txn();
 }
	}
}
Expand DownExpand Up@@ -624,7 +624,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let channel_id = get_slice!(1)[0] as usize;
 if channel_id >= channels.len() { return; }
 channels.sort_by(|a, b| { a.channel_id.cmp(&b.channel_id) });
 channelmanager.force_close_channel(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 channelmanager.force_close_broadcasting_latest_txn(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 },
 // 15 is above
 _ => return,
Expand Down

4 changes: 2 additions & 2 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -744,7 +744,7 @@ mod tests {
 }

 // Force-close the channel.
 nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();

 // Check that the force-close updates are persisted.
 check_persisted_data!(nodes[0].node, filepath.clone());
Expand DownExpand Up@@ -880,7 +880,7 @@ mod tests {
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
 let event = receiver
Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,7 +213,7 @@ mod tests {

 // Force close because cooperative close doesn't result in any persisted
 // updates.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
 check_closed_broadcast!(nodes[0], true);
 check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -247,7 +247,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand DownExpand Up@@ -286,7 +286,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
	}

	// ...and make sure we can force-close a frozen channel
	nodes[0].node.force_close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors!(nodes[0], 1);
	check_closed_broadcast!(nodes[0], true);

Expand Down

26 changes: 20 additions & 6 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -802,7 +802,6 @@ pub(super) enum ChannelError {
	Ignore(String),
	Warn(String),
	Close(String),
	CloseDelayBroadcast(String),
}

impl fmt::Debug for ChannelError {
Expand All@@ -811,7 +810,6 @@ impl fmt::Debug for ChannelError {
 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
 &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
 }
	}
}
Expand DownExpand Up@@ -3799,6 +3797,11 @@ impl<Signer: Sign> Channel<Signer> {

	/// May panic if some calls other than message-handling calls (which will all Err immediately)
	/// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
	///
	/// Some links printed in log lines are included here to check them during build (when run with
	/// `cargo doc --document-private-items`):
	/// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
	/// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
	pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L,
 node_pk: PublicKey, genesis_block_hash: BlockHash, best_block: &BestBlock)
	-> Result<ReestablishResponses, ChannelError> where L::Target: Logger {
Expand All@@ -3824,9 +3827,20 @@ impl<Signer: Sign> Channel<Signer> {
 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
 }
 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
 return Err(ChannelError::CloseDelayBroadcast(
 "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting".to_owned()
 ));
 macro_rules! log_and_panic {
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is a macro needed? Could just use a variable for $err_msg.
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not directly - format strings have to be an explicit string, they can't be a &'static str or whatever, so I'm not sure how to do this without either repeating the whole string or a macro.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you can format it first with let err_msg = format!("..", ..) and then use "{}", err_msg in each statement. Or maybe there is a more idiomatic way of using format_args!?
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, no, format_args doesn't seem to do it either. Do you find the current code particularly unreadable? It seems fine to me, given its the one way to do it without building the full string first.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, just figured we could do it without using a macro. Given it's gonna panic there's not a huge argument for building the string. Fine either way.
 ($err_msg: expr) => {
 log_error!(logger, $err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 panic!($err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 }
 }
 log_and_panic!("We have fallen behind - we have received proof that if we broadcast our counterparty is going to claim all our funds.\n\
 This implies you have restarted with lost ChannelMonitor and ChannelManager state, the first of which is a violation of the LDK chain::Watch requirements.\n\
 More specifically, this means you have a bug in your implementation that can cause loss of funds, or you are running with an old backup, which is unsafe.\n\
 If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
 ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
 ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
 Note that due to a long-standing bug in lnd you may have to reach out to peers running lnd-based nodes to ask them to manually force-close channels\n\
 See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
 }
 },
 OptionalField::Absent => {}
Expand DownExpand Up@@ -3933,7 +3947,7 @@ impl<Signer: Sign> Channel<Signer> {
 // now!
 match self.free_holding_cell_htlcs(logger) {
 Err(ChannelError::Close(msg)) => Err(ChannelError::Close(msg)),
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) =>
 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
 Ok((Some((commitment_update, monitor_update)), holding_cell_failed_htlcs)) => {
 Ok(ReestablishResponses {
Expand Down

66 changes: 37 additions & 29 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,15 +369,6 @@ impl MsgHandleErrInternal {
 },
 },
 },
 ChannelError::CloseDelayBroadcast(msg) => LightningError {
 err: msg.clone(),
 action: msgs::ErrorAction::SendErrorMessage {
 msg: msgs::ErrorMessage {
 channel_id,
 data: msg
 },
 },
 },
 },
 chan_id: None,
 shutdown_finish: None,
Expand DownExpand Up@@ -1273,13 +1264,6 @@ macro_rules! convert_chan_err {
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(msg) => {
 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
 update_maps_on_chan_removal!($self, $short_to_id, $channel);
 let shutdown_res = $channel.force_shutdown(false);
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 }
 }
	}
}
Expand DownExpand Up@@ -1945,7 +1929,8 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana

	/// `peer_msg` should be set when we receive a message from a peer, but not set when the
	/// user closes, which will be re-exposed as the `ChannelClosed` reason.
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>) -> Result<PublicKey, APIError> {
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
	-> Result<PublicKey, APIError> {
 let mut chan = {
 let mut channel_state_lock = self.channel_state.lock().unwrap();
 let channel_state = &mut *channel_state_lock;
Expand All@@ -1964,7 +1949,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
 };
 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
 self.finish_force_close_channel(chan.force_shutdown(true));
 self.finish_force_close_channel(chan.force_shutdown(broadcast));
 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
 let mut channel_state = self.channel_state.lock().unwrap();
 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
Expand All@@ -1975,13 +1960,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 Ok(chan.get_counterparty_node_id())
	}

	/// Force closes a channel, immediately broadcasting the latest local commitment transaction to
	/// the chain and rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
	fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None) {
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
 Ok(counterparty_node_id) => {
 self.channel_state.lock().unwrap().pending_msg_events.push(
 events::MessageSendEvent::HandleError {
Expand All@@ -1997,11 +1978,39 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
	}

	/// Force closes a channel, immediately broadcasting the latest local transaction(s) and
	/// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, true)
	}

	/// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
	/// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
	/// `counterparty_node_id` isn't the counterparty of the corresponding channel.
	///
	/// You can always get the latest local transaction(s) to broadcast from
	/// [`ChannelMonitor::get_latest_holder_commitment_txn`].
	pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, false)
	}

	/// Force close all channels, immediately broadcasting the latest local commitment transaction
	/// for each to the chain and rejecting new HTLCs on each.
	pub fn force_close_all_channels(&self) {
	pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

	/// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
	/// local transaction(s).
	pub fn force_close_all_channels_without_broadcasting_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_channel(&chan.channel_id, &chan.counterparty.node_id);
 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

Expand DownExpand Up@@ -3188,7 +3197,6 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 // ChannelClosed event is generated by handle_error for us.
 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel.channel_id(), channel.get_user_id(), channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(_) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
 };
 handle_errors.push((counterparty_node_id, err));
 continue;
Expand DownExpand Up@@ -6058,7 +6066,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 for chan in self.list_channels() {
 if chan.counterparty.node_id == *counterparty_node_id {
 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
 }
 } else {
Expand All@@ -6080,7 +6088,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 }

 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
	}
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Panic if we're running with outdated state instead of force-closing#1564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Jun 27, 2022
 Merged


Panic if we're running with outdated state instead of force-closing
#1564
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ed3f25

Add ChannelManager methods to force close without broadcasting


TheBlueMatt Jun 23, 2022
caa2a9a

Panic if we're running with outdated state instead of force-closing


TheBlueMatt Jun 23, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -252,7 +252,7 @@ impl<'a> Drop for MoneyLossDetector<'a> {
 }

 // Force all channels onto the chain (and time out claim txn)
 self.manager.force_close_all_channels();
 self.manager.force_close_all_channels_broadcasting_latest_txn();
 }
	}
}
Expand DownExpand Up@@ -624,7 +624,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let channel_id = get_slice!(1)[0] as usize;
 if channel_id >= channels.len() { return; }
 channels.sort_by(|a, b| { a.channel_id.cmp(&b.channel_id) });
 channelmanager.force_close_channel(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 channelmanager.force_close_broadcasting_latest_txn(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 },
 // 15 is above
 _ => return,
Expand Down

4 changes: 2 additions & 2 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -744,7 +744,7 @@ mod tests {
 }

 // Force-close the channel.
 nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();

 // Check that the force-close updates are persisted.
 check_persisted_data!(nodes[0].node, filepath.clone());
Expand DownExpand Up@@ -880,7 +880,7 @@ mod tests {
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
 let event = receiver
Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,7 +213,7 @@ mod tests {

 // Force close because cooperative close doesn't result in any persisted
 // updates.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
 check_closed_broadcast!(nodes[0], true);
 check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -247,7 +247,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand DownExpand Up@@ -286,7 +286,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
	}

	// ...and make sure we can force-close a frozen channel
	nodes[0].node.force_close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors!(nodes[0], 1);
	check_closed_broadcast!(nodes[0], true);

Expand Down

26 changes: 20 additions & 6 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -802,7 +802,6 @@ pub(super) enum ChannelError {
	Ignore(String),
	Warn(String),
	Close(String),
	CloseDelayBroadcast(String),
}

impl fmt::Debug for ChannelError {
Expand All@@ -811,7 +810,6 @@ impl fmt::Debug for ChannelError {
 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
 &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
 }
	}
}
Expand DownExpand Up@@ -3799,6 +3797,11 @@ impl<Signer: Sign> Channel<Signer> {

	/// May panic if some calls other than message-handling calls (which will all Err immediately)
	/// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
	///
	/// Some links printed in log lines are included here to check them during build (when run with
	/// `cargo doc --document-private-items`):
	/// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
	/// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
	pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L,
 node_pk: PublicKey, genesis_block_hash: BlockHash, best_block: &BestBlock)
	-> Result<ReestablishResponses, ChannelError> where L::Target: Logger {
Expand All@@ -3824,9 +3827,20 @@ impl<Signer: Sign> Channel<Signer> {
 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
 }
 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
 return Err(ChannelError::CloseDelayBroadcast(
 "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting".to_owned()
 ));
 macro_rules! log_and_panic {
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is a macro needed? Could just use a variable for $err_msg.
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not directly - format strings have to be an explicit string, they can't be a &'static str or whatever, so I'm not sure how to do this without either repeating the whole string or a macro.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you can format it first with let err_msg = format!("..", ..) and then use "{}", err_msg in each statement. Or maybe there is a more idiomatic way of using format_args!?
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, no, format_args doesn't seem to do it either. Do you find the current code particularly unreadable? It seems fine to me, given its the one way to do it without building the full string first.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, just figured we could do it without using a macro. Given it's gonna panic there's not a huge argument for building the string. Fine either way.
 ($err_msg: expr) => {
 log_error!(logger, $err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 panic!($err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 }
 }
 log_and_panic!("We have fallen behind - we have received proof that if we broadcast our counterparty is going to claim all our funds.\n\
 This implies you have restarted with lost ChannelMonitor and ChannelManager state, the first of which is a violation of the LDK chain::Watch requirements.\n\
 More specifically, this means you have a bug in your implementation that can cause loss of funds, or you are running with an old backup, which is unsafe.\n\
 If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
 ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
 ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
 Note that due to a long-standing bug in lnd you may have to reach out to peers running lnd-based nodes to ask them to manually force-close channels\n\
 See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
 }
 },
 OptionalField::Absent => {}
Expand DownExpand Up@@ -3933,7 +3947,7 @@ impl<Signer: Sign> Channel<Signer> {
 // now!
 match self.free_holding_cell_htlcs(logger) {
 Err(ChannelError::Close(msg)) => Err(ChannelError::Close(msg)),
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) =>
 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
 Ok((Some((commitment_update, monitor_update)), holding_cell_failed_htlcs)) => {
 Ok(ReestablishResponses {
Expand Down

66 changes: 37 additions & 29 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,15 +369,6 @@ impl MsgHandleErrInternal {
 },
 },
 },
 ChannelError::CloseDelayBroadcast(msg) => LightningError {
 err: msg.clone(),
 action: msgs::ErrorAction::SendErrorMessage {
 msg: msgs::ErrorMessage {
 channel_id,
 data: msg
 },
 },
 },
 },
 chan_id: None,
 shutdown_finish: None,
Expand DownExpand Up@@ -1273,13 +1264,6 @@ macro_rules! convert_chan_err {
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(msg) => {
 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
 update_maps_on_chan_removal!($self, $short_to_id, $channel);
 let shutdown_res = $channel.force_shutdown(false);
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 }
 }
	}
}
Expand DownExpand Up@@ -1945,7 +1929,8 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana

	/// `peer_msg` should be set when we receive a message from a peer, but not set when the
	/// user closes, which will be re-exposed as the `ChannelClosed` reason.
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>) -> Result<PublicKey, APIError> {
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
	-> Result<PublicKey, APIError> {
 let mut chan = {
 let mut channel_state_lock = self.channel_state.lock().unwrap();
 let channel_state = &mut *channel_state_lock;
Expand All@@ -1964,7 +1949,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
 };
 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
 self.finish_force_close_channel(chan.force_shutdown(true));
 self.finish_force_close_channel(chan.force_shutdown(broadcast));
 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
 let mut channel_state = self.channel_state.lock().unwrap();
 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
Expand All@@ -1975,13 +1960,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 Ok(chan.get_counterparty_node_id())
	}

	/// Force closes a channel, immediately broadcasting the latest local commitment transaction to
	/// the chain and rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
	fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None) {
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
 Ok(counterparty_node_id) => {
 self.channel_state.lock().unwrap().pending_msg_events.push(
 events::MessageSendEvent::HandleError {
Expand All@@ -1997,11 +1978,39 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
	}

	/// Force closes a channel, immediately broadcasting the latest local transaction(s) and
	/// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, true)
	}

	/// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
	/// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
	/// `counterparty_node_id` isn't the counterparty of the corresponding channel.
	///
	/// You can always get the latest local transaction(s) to broadcast from
	/// [`ChannelMonitor::get_latest_holder_commitment_txn`].
	pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, false)
	}

	/// Force close all channels, immediately broadcasting the latest local commitment transaction
	/// for each to the chain and rejecting new HTLCs on each.
	pub fn force_close_all_channels(&self) {
	pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

	/// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
	/// local transaction(s).
	pub fn force_close_all_channels_without_broadcasting_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_channel(&chan.channel_id, &chan.counterparty.node_id);
 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

Expand DownExpand Up@@ -3188,7 +3197,6 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 // ChannelClosed event is generated by handle_error for us.
 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel.channel_id(), channel.get_user_id(), channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(_) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
 };
 handle_errors.push((counterparty_node_id, err));
 continue;
Expand DownExpand Up@@ -6058,7 +6066,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 for chan in self.list_channels() {
 if chan.counterparty.node_id == *counterparty_node_id {
 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
 }
 } else {
Expand All@@ -6080,7 +6088,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 }

 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
	}
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Panic if we're running with outdated state instead of force-closing#1564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Jun 27, 2022
 Merged


Panic if we're running with outdated state instead of force-closing
#1564
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ed3f25

Add ChannelManager methods to force close without broadcasting


TheBlueMatt Jun 23, 2022
caa2a9a

Panic if we're running with outdated state instead of force-closing


TheBlueMatt Jun 23, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -252,7 +252,7 @@ impl<'a> Drop for MoneyLossDetector<'a> {
 }

 // Force all channels onto the chain (and time out claim txn)
 self.manager.force_close_all_channels();
 self.manager.force_close_all_channels_broadcasting_latest_txn();
 }
	}
}
Expand DownExpand Up@@ -624,7 +624,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let channel_id = get_slice!(1)[0] as usize;
 if channel_id >= channels.len() { return; }
 channels.sort_by(|a, b| { a.channel_id.cmp(&b.channel_id) });
 channelmanager.force_close_channel(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 channelmanager.force_close_broadcasting_latest_txn(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 },
 // 15 is above
 _ => return,
Expand Down

4 changes: 2 additions & 2 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -744,7 +744,7 @@ mod tests {
 }

 // Force-close the channel.
 nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();

 // Check that the force-close updates are persisted.
 check_persisted_data!(nodes[0].node, filepath.clone());
Expand DownExpand Up@@ -880,7 +880,7 @@ mod tests {
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
 let event = receiver
Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,7 +213,7 @@ mod tests {

 // Force close because cooperative close doesn't result in any persisted
 // updates.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
 check_closed_broadcast!(nodes[0], true);
 check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -247,7 +247,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand DownExpand Up@@ -286,7 +286,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
	}

	// ...and make sure we can force-close a frozen channel
	nodes[0].node.force_close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors!(nodes[0], 1);
	check_closed_broadcast!(nodes[0], true);

Expand Down

26 changes: 20 additions & 6 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -802,7 +802,6 @@ pub(super) enum ChannelError {
	Ignore(String),
	Warn(String),
	Close(String),
	CloseDelayBroadcast(String),
}

impl fmt::Debug for ChannelError {
Expand All@@ -811,7 +810,6 @@ impl fmt::Debug for ChannelError {
 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
 &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
 }
	}
}
Expand DownExpand Up@@ -3799,6 +3797,11 @@ impl<Signer: Sign> Channel<Signer> {

	/// May panic if some calls other than message-handling calls (which will all Err immediately)
	/// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
	///
	/// Some links printed in log lines are included here to check them during build (when run with
	/// `cargo doc --document-private-items`):
	/// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
	/// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
	pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L,
 node_pk: PublicKey, genesis_block_hash: BlockHash, best_block: &BestBlock)
	-> Result<ReestablishResponses, ChannelError> where L::Target: Logger {
Expand All@@ -3824,9 +3827,20 @@ impl<Signer: Sign> Channel<Signer> {
 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
 }
 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
 return Err(ChannelError::CloseDelayBroadcast(
 "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting".to_owned()
 ));
 macro_rules! log_and_panic {
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is a macro needed? Could just use a variable for $err_msg.
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not directly - format strings have to be an explicit string, they can't be a &'static str or whatever, so I'm not sure how to do this without either repeating the whole string or a macro.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you can format it first with let err_msg = format!("..", ..) and then use "{}", err_msg in each statement. Or maybe there is a more idiomatic way of using format_args!?
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, no, format_args doesn't seem to do it either. Do you find the current code particularly unreadable? It seems fine to me, given its the one way to do it without building the full string first.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, just figured we could do it without using a macro. Given it's gonna panic there's not a huge argument for building the string. Fine either way.
 ($err_msg: expr) => {
 log_error!(logger, $err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 panic!($err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 }
 }
 log_and_panic!("We have fallen behind - we have received proof that if we broadcast our counterparty is going to claim all our funds.\n\
 This implies you have restarted with lost ChannelMonitor and ChannelManager state, the first of which is a violation of the LDK chain::Watch requirements.\n\
 More specifically, this means you have a bug in your implementation that can cause loss of funds, or you are running with an old backup, which is unsafe.\n\
 If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
 ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
 ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
 Note that due to a long-standing bug in lnd you may have to reach out to peers running lnd-based nodes to ask them to manually force-close channels\n\
 See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
 }
 },
 OptionalField::Absent => {}
Expand DownExpand Up@@ -3933,7 +3947,7 @@ impl<Signer: Sign> Channel<Signer> {
 // now!
 match self.free_holding_cell_htlcs(logger) {
 Err(ChannelError::Close(msg)) => Err(ChannelError::Close(msg)),
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) =>
 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
 Ok((Some((commitment_update, monitor_update)), holding_cell_failed_htlcs)) => {
 Ok(ReestablishResponses {
Expand Down

66 changes: 37 additions & 29 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,15 +369,6 @@ impl MsgHandleErrInternal {
 },
 },
 },
 ChannelError::CloseDelayBroadcast(msg) => LightningError {
 err: msg.clone(),
 action: msgs::ErrorAction::SendErrorMessage {
 msg: msgs::ErrorMessage {
 channel_id,
 data: msg
 },
 },
 },
 },
 chan_id: None,
 shutdown_finish: None,
Expand DownExpand Up@@ -1273,13 +1264,6 @@ macro_rules! convert_chan_err {
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(msg) => {
 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
 update_maps_on_chan_removal!($self, $short_to_id, $channel);
 let shutdown_res = $channel.force_shutdown(false);
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 }
 }
	}
}
Expand DownExpand Up@@ -1945,7 +1929,8 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana

	/// `peer_msg` should be set when we receive a message from a peer, but not set when the
	/// user closes, which will be re-exposed as the `ChannelClosed` reason.
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>) -> Result<PublicKey, APIError> {
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
	-> Result<PublicKey, APIError> {
 let mut chan = {
 let mut channel_state_lock = self.channel_state.lock().unwrap();
 let channel_state = &mut *channel_state_lock;
Expand All@@ -1964,7 +1949,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
 };
 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
 self.finish_force_close_channel(chan.force_shutdown(true));
 self.finish_force_close_channel(chan.force_shutdown(broadcast));
 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
 let mut channel_state = self.channel_state.lock().unwrap();
 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
Expand All@@ -1975,13 +1960,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 Ok(chan.get_counterparty_node_id())
	}

	/// Force closes a channel, immediately broadcasting the latest local commitment transaction to
	/// the chain and rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
	fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None) {
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
 Ok(counterparty_node_id) => {
 self.channel_state.lock().unwrap().pending_msg_events.push(
 events::MessageSendEvent::HandleError {
Expand All@@ -1997,11 +1978,39 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
	}

	/// Force closes a channel, immediately broadcasting the latest local transaction(s) and
	/// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, true)
	}

	/// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
	/// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
	/// `counterparty_node_id` isn't the counterparty of the corresponding channel.
	///
	/// You can always get the latest local transaction(s) to broadcast from
	/// [`ChannelMonitor::get_latest_holder_commitment_txn`].
	pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, false)
	}

	/// Force close all channels, immediately broadcasting the latest local commitment transaction
	/// for each to the chain and rejecting new HTLCs on each.
	pub fn force_close_all_channels(&self) {
	pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

	/// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
	/// local transaction(s).
	pub fn force_close_all_channels_without_broadcasting_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_channel(&chan.channel_id, &chan.counterparty.node_id);
 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

Expand DownExpand Up@@ -3188,7 +3197,6 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 // ChannelClosed event is generated by handle_error for us.
 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel.channel_id(), channel.get_user_id(), channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(_) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
 };
 handle_errors.push((counterparty_node_id, err));
 continue;
Expand DownExpand Up@@ -6058,7 +6066,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 for chan in self.list_channels() {
 if chan.counterparty.node_id == *counterparty_node_id {
 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
 }
 } else {
Expand All@@ -6080,7 +6088,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 }

 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
	}
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Panic if we're running with outdated state instead of force-closing#1564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Jun 27, 2022
 Merged


Panic if we're running with outdated state instead of force-closing
#1564
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ed3f25

Add ChannelManager methods to force close without broadcasting


TheBlueMatt Jun 23, 2022
caa2a9a

Panic if we're running with outdated state instead of force-closing


TheBlueMatt Jun 23, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -252,7 +252,7 @@ impl<'a> Drop for MoneyLossDetector<'a> {
 }

 // Force all channels onto the chain (and time out claim txn)
 self.manager.force_close_all_channels();
 self.manager.force_close_all_channels_broadcasting_latest_txn();
 }
	}
}
Expand DownExpand Up@@ -624,7 +624,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let channel_id = get_slice!(1)[0] as usize;
 if channel_id >= channels.len() { return; }
 channels.sort_by(|a, b| { a.channel_id.cmp(&b.channel_id) });
 channelmanager.force_close_channel(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 channelmanager.force_close_broadcasting_latest_txn(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 },
 // 15 is above
 _ => return,
Expand Down

4 changes: 2 additions & 2 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -744,7 +744,7 @@ mod tests {
 }

 // Force-close the channel.
 nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();

 // Check that the force-close updates are persisted.
 check_persisted_data!(nodes[0].node, filepath.clone());
Expand DownExpand Up@@ -880,7 +880,7 @@ mod tests {
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
 let event = receiver
Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,7 +213,7 @@ mod tests {

 // Force close because cooperative close doesn't result in any persisted
 // updates.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
 check_closed_broadcast!(nodes[0], true);
 check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -247,7 +247,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand DownExpand Up@@ -286,7 +286,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
	}

	// ...and make sure we can force-close a frozen channel
	nodes[0].node.force_close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors!(nodes[0], 1);
	check_closed_broadcast!(nodes[0], true);

Expand Down

26 changes: 20 additions & 6 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -802,7 +802,6 @@ pub(super) enum ChannelError {
	Ignore(String),
	Warn(String),
	Close(String),
	CloseDelayBroadcast(String),
}

impl fmt::Debug for ChannelError {
Expand All@@ -811,7 +810,6 @@ impl fmt::Debug for ChannelError {
 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
 &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
 }
	}
}
Expand DownExpand Up@@ -3799,6 +3797,11 @@ impl<Signer: Sign> Channel<Signer> {

	/// May panic if some calls other than message-handling calls (which will all Err immediately)
	/// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
	///
	/// Some links printed in log lines are included here to check them during build (when run with
	/// `cargo doc --document-private-items`):
	/// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
	/// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
	pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L,
 node_pk: PublicKey, genesis_block_hash: BlockHash, best_block: &BestBlock)
	-> Result<ReestablishResponses, ChannelError> where L::Target: Logger {
Expand All@@ -3824,9 +3827,20 @@ impl<Signer: Sign> Channel<Signer> {
 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
 }
 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
 return Err(ChannelError::CloseDelayBroadcast(
 "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting".to_owned()
 ));
 macro_rules! log_and_panic {
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is a macro needed? Could just use a variable for $err_msg.
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not directly - format strings have to be an explicit string, they can't be a &'static str or whatever, so I'm not sure how to do this without either repeating the whole string or a macro.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you can format it first with let err_msg = format!("..", ..) and then use "{}", err_msg in each statement. Or maybe there is a more idiomatic way of using format_args!?
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, no, format_args doesn't seem to do it either. Do you find the current code particularly unreadable? It seems fine to me, given its the one way to do it without building the full string first.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, just figured we could do it without using a macro. Given it's gonna panic there's not a huge argument for building the string. Fine either way.
 ($err_msg: expr) => {
 log_error!(logger, $err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 panic!($err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 }
 }
 log_and_panic!("We have fallen behind - we have received proof that if we broadcast our counterparty is going to claim all our funds.\n\
 This implies you have restarted with lost ChannelMonitor and ChannelManager state, the first of which is a violation of the LDK chain::Watch requirements.\n\
 More specifically, this means you have a bug in your implementation that can cause loss of funds, or you are running with an old backup, which is unsafe.\n\
 If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
 ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
 ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
 Note that due to a long-standing bug in lnd you may have to reach out to peers running lnd-based nodes to ask them to manually force-close channels\n\
 See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
 }
 },
 OptionalField::Absent => {}
Expand DownExpand Up@@ -3933,7 +3947,7 @@ impl<Signer: Sign> Channel<Signer> {
 // now!
 match self.free_holding_cell_htlcs(logger) {
 Err(ChannelError::Close(msg)) => Err(ChannelError::Close(msg)),
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) =>
 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
 Ok((Some((commitment_update, monitor_update)), holding_cell_failed_htlcs)) => {
 Ok(ReestablishResponses {
Expand Down

66 changes: 37 additions & 29 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,15 +369,6 @@ impl MsgHandleErrInternal {
 },
 },
 },
 ChannelError::CloseDelayBroadcast(msg) => LightningError {
 err: msg.clone(),
 action: msgs::ErrorAction::SendErrorMessage {
 msg: msgs::ErrorMessage {
 channel_id,
 data: msg
 },
 },
 },
 },
 chan_id: None,
 shutdown_finish: None,
Expand DownExpand Up@@ -1273,13 +1264,6 @@ macro_rules! convert_chan_err {
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(msg) => {
 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
 update_maps_on_chan_removal!($self, $short_to_id, $channel);
 let shutdown_res = $channel.force_shutdown(false);
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 }
 }
	}
}
Expand DownExpand Up@@ -1945,7 +1929,8 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana

	/// `peer_msg` should be set when we receive a message from a peer, but not set when the
	/// user closes, which will be re-exposed as the `ChannelClosed` reason.
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>) -> Result<PublicKey, APIError> {
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
	-> Result<PublicKey, APIError> {
 let mut chan = {
 let mut channel_state_lock = self.channel_state.lock().unwrap();
 let channel_state = &mut *channel_state_lock;
Expand All@@ -1964,7 +1949,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
 };
 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
 self.finish_force_close_channel(chan.force_shutdown(true));
 self.finish_force_close_channel(chan.force_shutdown(broadcast));
 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
 let mut channel_state = self.channel_state.lock().unwrap();
 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
Expand All@@ -1975,13 +1960,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 Ok(chan.get_counterparty_node_id())
	}

	/// Force closes a channel, immediately broadcasting the latest local commitment transaction to
	/// the chain and rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
	fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None) {
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
 Ok(counterparty_node_id) => {
 self.channel_state.lock().unwrap().pending_msg_events.push(
 events::MessageSendEvent::HandleError {
Expand All@@ -1997,11 +1978,39 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
	}

	/// Force closes a channel, immediately broadcasting the latest local transaction(s) and
	/// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, true)
	}

	/// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
	/// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
	/// `counterparty_node_id` isn't the counterparty of the corresponding channel.
	///
	/// You can always get the latest local transaction(s) to broadcast from
	/// [`ChannelMonitor::get_latest_holder_commitment_txn`].
	pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, false)
	}

	/// Force close all channels, immediately broadcasting the latest local commitment transaction
	/// for each to the chain and rejecting new HTLCs on each.
	pub fn force_close_all_channels(&self) {
	pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

	/// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
	/// local transaction(s).
	pub fn force_close_all_channels_without_broadcasting_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_channel(&chan.channel_id, &chan.counterparty.node_id);
 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

Expand DownExpand Up@@ -3188,7 +3197,6 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 // ChannelClosed event is generated by handle_error for us.
 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel.channel_id(), channel.get_user_id(), channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(_) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
 };
 handle_errors.push((counterparty_node_id, err));
 continue;
Expand DownExpand Up@@ -6058,7 +6066,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 for chan in self.list_channels() {
 if chan.counterparty.node_id == *counterparty_node_id {
 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
 }
 } else {
Expand All@@ -6080,7 +6088,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 }

 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
	}
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Panic if we're running with outdated state instead of force-closing#1564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Jun 27, 2022
 Merged


Panic if we're running with outdated state instead of force-closing
#1564
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
5ed3f25

Add ChannelManager methods to force close without broadcasting


TheBlueMatt Jun 23, 2022
caa2a9a

Panic if we're running with outdated state instead of force-closing


TheBlueMatt Jun 23, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -252,7 +252,7 @@ impl<'a> Drop for MoneyLossDetector<'a> {
 }

 // Force all channels onto the chain (and time out claim txn)
 self.manager.force_close_all_channels();
 self.manager.force_close_all_channels_broadcasting_latest_txn();
 }
	}
}
Expand DownExpand Up@@ -624,7 +624,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let channel_id = get_slice!(1)[0] as usize;
 if channel_id >= channels.len() { return; }
 channels.sort_by(|a, b| { a.channel_id.cmp(&b.channel_id) });
 channelmanager.force_close_channel(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 channelmanager.force_close_broadcasting_latest_txn(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
 },
 // 15 is above
 _ => return,
Expand Down

4 changes: 2 additions & 2 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -744,7 +744,7 @@ mod tests {
 }

 // Force-close the channel.
 nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();

 // Check that the force-close updates are persisted.
 check_persisted_data!(nodes[0].node, filepath.clone());
Expand DownExpand Up@@ -880,7 +880,7 @@ mod tests {
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
 let event = receiver
Expand Down

6 changes: 3 additions & 3 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -213,7 +213,7 @@ mod tests {

 // Force close because cooperative close doesn't result in any persisted
 // updates.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
 check_closed_broadcast!(nodes[0], true);
 check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -247,7 +247,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand DownExpand Up@@ -286,7 +286,7 @@ mod tests {
 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 nodes[1].node.force_close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/chanmon_update_fail_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
	}

	// ...and make sure we can force-close a frozen channel
	nodes[0].node.force_close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
	check_added_monitors!(nodes[0], 1);
	check_closed_broadcast!(nodes[0], true);

Expand Down

26 changes: 20 additions & 6 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -802,7 +802,6 @@ pub(super) enum ChannelError {
	Ignore(String),
	Warn(String),
	Close(String),
	CloseDelayBroadcast(String),
}

impl fmt::Debug for ChannelError {
Expand All@@ -811,7 +810,6 @@ impl fmt::Debug for ChannelError {
 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
 &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
 }
	}
}
Expand DownExpand Up@@ -3799,6 +3797,11 @@ impl<Signer: Sign> Channel<Signer> {

	/// May panic if some calls other than message-handling calls (which will all Err immediately)
	/// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
	///
	/// Some links printed in log lines are included here to check them during build (when run with
	/// `cargo doc --document-private-items`):
	/// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
	/// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
	pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L,
 node_pk: PublicKey, genesis_block_hash: BlockHash, best_block: &BestBlock)
	-> Result<ReestablishResponses, ChannelError> where L::Target: Logger {
Expand All@@ -3824,9 +3827,20 @@ impl<Signer: Sign> Channel<Signer> {
 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
 }
 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
 return Err(ChannelError::CloseDelayBroadcast(
 "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting".to_owned()
 ));
 macro_rules! log_and_panic {
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is a macro needed? Could just use a variable for $err_msg.
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not directly - format strings have to be an explicit string, they can't be a &'static str or whatever, so I'm not sure how to do this without either repeating the whole string or a macro.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you can format it first with let err_msg = format!("..", ..) and then use "{}", err_msg in each statement. Or maybe there is a more idiomatic way of using format_args!?
@TheBlueMattTheBlueMattJun 24, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, no, format_args doesn't seem to do it either. Do you find the current code particularly unreadable? It seems fine to me, given its the one way to do it without building the full string first.
@jkczyzjkczyzJun 24, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, just figured we could do it without using a macro. Given it's gonna panic there's not a huge argument for building the string. Fine either way.
 ($err_msg: expr) => {
 log_error!(logger, $err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 panic!($err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
 }
 }
 log_and_panic!("We have fallen behind - we have received proof that if we broadcast our counterparty is going to claim all our funds.\n\
 This implies you have restarted with lost ChannelMonitor and ChannelManager state, the first of which is a violation of the LDK chain::Watch requirements.\n\
 More specifically, this means you have a bug in your implementation that can cause loss of funds, or you are running with an old backup, which is unsafe.\n\
 If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
 ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
 ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
 Note that due to a long-standing bug in lnd you may have to reach out to peers running lnd-based nodes to ask them to manually force-close channels\n\
 See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
 }
 },
 OptionalField::Absent => {}
Expand DownExpand Up@@ -3933,7 +3947,7 @@ impl<Signer: Sign> Channel<Signer> {
 // now!
 match self.free_holding_cell_htlcs(logger) {
 Err(ChannelError::Close(msg)) => Err(ChannelError::Close(msg)),
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) =>
 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
 Ok((Some((commitment_update, monitor_update)), holding_cell_failed_htlcs)) => {
 Ok(ReestablishResponses {
Expand Down

66 changes: 37 additions & 29 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,15 +369,6 @@ impl MsgHandleErrInternal {
 },
 },
 },
 ChannelError::CloseDelayBroadcast(msg) => LightningError {
 err: msg.clone(),
 action: msgs::ErrorAction::SendErrorMessage {
 msg: msgs::ErrorMessage {
 channel_id,
 data: msg
 },
 },
 },
 },
 chan_id: None,
 shutdown_finish: None,
Expand DownExpand Up@@ -1273,13 +1264,6 @@ macro_rules! convert_chan_err {
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(msg) => {
 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
 update_maps_on_chan_removal!($self, $short_to_id, $channel);
 let shutdown_res = $channel.force_shutdown(false);
 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
 }
 }
	}
}
Expand DownExpand Up@@ -1945,7 +1929,8 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana

	/// `peer_msg` should be set when we receive a message from a peer, but not set when the
	/// user closes, which will be re-exposed as the `ChannelClosed` reason.
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>) -> Result<PublicKey, APIError> {
	fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
	-> Result<PublicKey, APIError> {
 let mut chan = {
 let mut channel_state_lock = self.channel_state.lock().unwrap();
 let channel_state = &mut *channel_state_lock;
Expand All@@ -1964,7 +1949,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
 };
 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
 self.finish_force_close_channel(chan.force_shutdown(true));
 self.finish_force_close_channel(chan.force_shutdown(broadcast));
 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
 let mut channel_state = self.channel_state.lock().unwrap();
 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
Expand All@@ -1975,13 +1960,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 Ok(chan.get_counterparty_node_id())
	}

	/// Force closes a channel, immediately broadcasting the latest local commitment transaction to
	/// the chain and rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
	fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None) {
 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
 Ok(counterparty_node_id) => {
 self.channel_state.lock().unwrap().pending_msg_events.push(
 events::MessageSendEvent::HandleError {
Expand All@@ -1997,11 +1978,39 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 }
	}

	/// Force closes a channel, immediately broadcasting the latest local transaction(s) and
	/// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
	/// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
	/// channel.
	pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, true)
	}

	/// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
	/// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
	/// `counterparty_node_id` isn't the counterparty of the corresponding channel.
	///
	/// You can always get the latest local transaction(s) to broadcast from
	/// [`ChannelMonitor::get_latest_holder_commitment_txn`].
	pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
	-> Result<(), APIError> {
 self.force_close_sending_error(channel_id, counterparty_node_id, false)
	}

	/// Force close all channels, immediately broadcasting the latest local commitment transaction
	/// for each to the chain and rejecting new HTLCs on each.
	pub fn force_close_all_channels(&self) {
	pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

	/// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
	/// local transaction(s).
	pub fn force_close_all_channels_without_broadcasting_txn(&self) {
 for chan in self.list_channels() {
 let _ = self.force_close_channel(&chan.channel_id, &chan.counterparty.node_id);
 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
 }
	}

Expand DownExpand Up@@ -3188,7 +3197,6 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 // ChannelClosed event is generated by handle_error for us.
 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel.channel_id(), channel.get_user_id(), channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
 },
 ChannelError::CloseDelayBroadcast(_) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
 };
 handle_errors.push((counterparty_node_id, err));
 continue;
Expand DownExpand Up@@ -6058,7 +6066,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 for chan in self.list_channels() {
 if chan.counterparty.node_id == *counterparty_node_id {
 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
 }
 } else {
Expand All@@ -6080,7 +6088,7 @@ impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
 }

 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data));
 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
 }
	}
}
Expand Down
Loading