Skip to content

Commit 4e7c168

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 8ac4804 commit 4e7c168

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

lightning/src/ln/channel.rs

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

536+
/// The return value of `signer_maybe_unblocked`
537+
#[allow(unused)]
538+
pub(super) struct SignerResumeUpdates {
539+
pub commitment_update: Option<msgs::CommitmentUpdate>,
540+
pub funding_signed: Option<msgs::FundingSigned>,
541+
pub funding_created: Option<msgs::FundingCreated>,
542+
}
543+
536544
/// The return value of `channel_reestablish`
537545
pub(super) struct ReestablishResponses {
538546
pub channel_ready: Option<msgs::ChannelReady>,
@@ -3909,6 +3917,22 @@ impl<SP: Deref> Channel<SP> where
39093917
Ok(())
39103918
}
39113919

3920+
/// Indicates that the signer may have some signatures for us, so we should retry if we're
3921+
/// blocked.
3922+
#[allow(unused)]
3923+
pub fn signer_maybe_unblocked<L: Deref>(&mut self, logger: &L) -> SignerResumeUpdates where L::Target: Logger {
3924+
let commitment_update = if self.context.signer_pending_commitment_update {
3925+
self.get_last_commitment_update_for_send(logger).ok()
3926+
} else { None };
3927+
let funding_signed = None;
3928+
let funding_created = None;
3929+
SignerResumeUpdates {
3930+
commitment_update,
3931+
funding_signed,
3932+
funding_created,
3933+
}
3934+
}
3935+
39123936
fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
39133937
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);
39143938
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
@@ -7231,6 +7231,63 @@ where
72317231
has_update
72327232
}
72337233

7234+
/// When a call to a [`ChannelSigner`] method returns an error, this indicates that the signer
7235+
/// is (temporarily) unavailable, and the operation should be retried later.
7236+
///
7237+
/// This method allows for that retry - either checking for any signer-pending messages to be
7238+
/// attempted in every channel, or in the specifically provided channel.
7239+
///
7240+
/// [`ChannelSigner`]: crate::sign::ChannelSigner
7241+
#[cfg(test)] // This is only implemented for one signer method, and should be private until we
7242+
// actually finish implementing it fully.
7243+
pub fn signer_unblocked(&self, channel_opt: Option<(PublicKey, ChannelId)>) {
7244+
let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7245+
7246+
let unblock_chan = |phase: &mut ChannelPhase<SP>, pending_msg_events: &mut Vec<MessageSendEvent>| {
7247+
if let ChannelPhase::Funded(chan) = phase {
7248+
let msgs = chan.signer_maybe_unblocked(&self.logger);
7249+
let node_id = phase.context().get_counterparty_node_id();
7250+
if let Some(updates) = msgs.commitment_update {
7251+
pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
7252+
node_id,
7253+
updates,
7254+
});
7255+
}
7256+
if let Some(msg) = msgs.funding_signed {
7257+
pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
7258+
node_id,
7259+
msg,
7260+
});
7261+
}
7262+
if let Some(msg) = msgs.funding_created {
7263+
pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
7264+
node_id,
7265+
msg,
7266+
});
7267+
}
7268+
}
7269+
};
7270+
7271+
let per_peer_state = self.per_peer_state.read().unwrap();
7272+
if let Some((counterparty_node_id, channel_id)) = channel_opt {
7273+
if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7274+
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7275+
let peer_state = &mut *peer_state_lock;
7276+
if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
7277+
unblock_chan(chan, &mut peer_state.pending_msg_events);
7278+
}
7279+
}
7280+
} else {
7281+
for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7282+
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7283+
let peer_state = &mut *peer_state_lock;
7284+
for (_, chan) in peer_state.channel_by_id.iter_mut() {
7285+
unblock_chan(chan, &mut peer_state.pending_msg_events);
7286+
}
7287+
}
7288+
}
7289+
}
7290+
72347291
/// Check whether any channels have finished removing all pending updates after a shutdown
72357292
/// exchange and can now send a closing_signed.
72367293
/// Returns whether any closing_signed messages were generated.

0 commit comments

Comments
 (0)