Skip to content

Commit 7ccafd1

Browse files
TheBlueMattwaterson
authored andcommitted
Handle retrying sign_counterparty_commitment failures
If sign_counterparty_commitment fails (i.e. because the signer is temporarily disconnected), this really indicates that we should retry the message sending which required the signature later, rather than force-closing the channel (which probably won't even work if the signer is missing). This commit adds initial retrying of failures, specifically regenerating commitment updates, attempting to re-sign the `CommitmentSigned` message, and sending it to our peers if we succed.
1 parent 369cfdb commit 7ccafd1

File tree

2 files changed

+79
-0
lines changed

2 files changed

+79
-0
lines changed

lightning/src/ln/channel.rs

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -532,6 +532,13 @@ pub(super) struct MonitorRestoreUpdates {
532532
pub announcement_sigs: Option<msgs::AnnouncementSignatures>,
533533
}
534534

535+
/// The return value of `signer_maybe_unblocked`
536+
pub(super) struct SignerResumeUpdates {
537+
pub commitment_update: Option<msgs::CommitmentUpdate>,
538+
pub funding_signed: Option<msgs::FundingSigned>,
539+
pub funding_created: Option<msgs::FundingCreated>,
540+
}
541+
535542
/// The return value of `channel_reestablish`
536543
pub(super) struct ReestablishResponses {
537544
pub channel_ready: Option<msgs::ChannelReady>,
@@ -3895,6 +3902,21 @@ impl<SP: Deref> Channel<SP> where
38953902
Ok(())
38963903
}
38973904

3905+
/// Indicates that the signer may have some signatures for us, so we should retry if we're
3906+
/// blocked.
3907+
pub fn signer_maybe_unblocked<L: Deref>(&mut self, logger: &L) -> SignerResumeUpdates where L::Target: Logger {
3908+
let commitment_update = if self.context.signer_pending_commitment_update {
3909+
None
3910+
} else { None };
3911+
let funding_signed = None;
3912+
let funding_created = None;
3913+
SignerResumeUpdates {
3914+
commitment_update,
3915+
funding_signed,
3916+
funding_created,
3917+
}
3918+
}
3919+
38983920
fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
38993921
let next_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.cur_holder_commitment_transaction_number, &self.context.secp_ctx);
39003922
let per_commitment_secret = self.context.holder_signer.as_ref().release_commitment_secret(self.context.cur_holder_commitment_transaction_number + 2);

lightning/src/ln/channelmanager.rs

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6983,6 +6983,63 @@ where
69836983
has_update
69846984
}
69856985

6986+
/// When a call to a [`ChannelSigner`] method returns an error, this indicates that the signer
6987+
/// is (temporarily) unavailable, and the operation should be retried later.
6988+
///
6989+
/// This method allows for that retry - either checking for any signer-pending messages to be
6990+
/// attempted in every channel, or in the specifically provided channel.
6991+
///
6992+
/// [`ChannelSigner`]: crate::sign::ChannelSigner
6993+
#[cfg(test)] // This is only implemented for one signer method, and should be private until we
6994+
// actually finish implementing it fully.
6995+
pub fn signer_unblocked(&self, channel_opt: Option<(PublicKey, ChannelId)>) {
6996+
let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6997+
6998+
let unblock_chan = |phase: &mut ChannelPhase<SP>, pending_msg_events: &mut Vec<MessageSendEvent>| {
6999+
if let ChannelPhase::Funded(chan) = phase {
7000+
let msgs = chan.signer_maybe_unblocked(&self.logger);
7001+
let node_id = phase.context().get_counterparty_node_id();
7002+
if let Some(updates) = msgs.commitment_update {
7003+
pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
7004+
node_id,
7005+
updates,
7006+
});
7007+
}
7008+
if let Some(msg) = msgs.funding_signed {
7009+
pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
7010+
node_id,
7011+
msg,
7012+
});
7013+
}
7014+
if let Some(msg) = msgs.funding_created {
7015+
pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
7016+
node_id,
7017+
msg,
7018+
});
7019+
}
7020+
}
7021+
};
7022+
7023+
let per_peer_state = self.per_peer_state.read().unwrap();
7024+
if let Some((counterparty_node_id, channel_id)) = channel_opt {
7025+
if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7026+
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7027+
let peer_state = &mut *peer_state_lock;
7028+
if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
7029+
unblock_chan(chan, &mut peer_state.pending_msg_events);
7030+
}
7031+
}
7032+
} else {
7033+
for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7034+
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7035+
let peer_state = &mut *peer_state_lock;
7036+
for (_, chan) in peer_state.channel_by_id.iter_mut() {
7037+
unblock_chan(chan, &mut peer_state.pending_msg_events);
7038+
}
7039+
}
7040+
}
7041+
}
7042+
69867043
/// Check whether any channels have finished removing all pending updates after a shutdown
69877044
/// exchange and can now send a closing_signed.
69887045
/// Returns whether any closing_signed messages were generated.

0 commit comments

Comments
 (0)