Skip to content

Commit 55eadee

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 da88aa1 commit 55eadee

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
@@ -515,6 +515,13 @@ pub(super) struct MonitorRestoreUpdates {
515515
pub announcement_sigs: Option<msgs::AnnouncementSignatures>,
516516
}
517517

518+
/// The return value of `signer_maybe_unblocked`
519+
pub(super) struct SignerResumeUpdates {
520+
pub commitment_update: Option<msgs::CommitmentUpdate>,
521+
pub funding_signed: Option<msgs::FundingSigned>,
522+
pub funding_created: Option<msgs::FundingCreated>,
523+
}
524+
518525
/// The return value of `channel_reestablish`
519526
pub(super) struct ReestablishResponses {
520527
pub channel_ready: Option<msgs::ChannelReady>,
@@ -3816,6 +3823,21 @@ impl<SP: Deref> Channel<SP> where
38163823
Ok(())
38173824
}
38183825

3826+
/// Indicates that the signer may have some signatures for us, so we should retry if we're
3827+
/// blocked.
3828+
pub fn signer_maybe_unblocked<L: Deref>(&mut self, logger: &L) -> SignerResumeUpdates where L::Target: Logger {
3829+
let commitment_update = if self.context.signer_pending_commitment_update {
3830+
None
3831+
} else { None };
3832+
let funding_signed = None;
3833+
let funding_created = None;
3834+
SignerResumeUpdates {
3835+
commitment_update,
3836+
funding_signed,
3837+
funding_created,
3838+
}
3839+
}
3840+
38193841
fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
38203842
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);
38213843
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
@@ -6737,6 +6737,63 @@ where
67376737
has_update
67386738
}
67396739

6740+
/// When a call to a [`ChannelSigner`] method returns an error, this indicates that the signer
6741+
/// is (temporarily) unavailable, and the operation should be retried later.
6742+
///
6743+
/// This method allows for that retry - either checking for any signer-pending messages to be
6744+
/// attempted in every channel, or in the specifically provided channel.
6745+
///
6746+
/// [`ChannelSigner`]: crate::sign::ChannelSigner
6747+
#[cfg(test)] // This is only implemented for one signer method, and should be private until we
6748+
// actually finish implementing it fully.
6749+
pub fn signer_unblocked(&self, channel_opt: Option<(PublicKey, ChannelId)>) {
6750+
let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6751+
6752+
let unblock_chan = |phase: &mut ChannelPhase<SP>, pending_msg_events: &mut Vec<MessageSendEvent>| {
6753+
if let ChannelPhase::Funded(chan) = phase {
6754+
let msgs = chan.signer_maybe_unblocked(&self.logger);
6755+
let node_id = phase.context().get_counterparty_node_id();
6756+
if let Some(updates) = msgs.commitment_update {
6757+
pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
6758+
node_id,
6759+
updates,
6760+
});
6761+
}
6762+
if let Some(msg) = msgs.funding_signed {
6763+
pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
6764+
node_id,
6765+
msg,
6766+
});
6767+
}
6768+
if let Some(msg) = msgs.funding_created {
6769+
pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
6770+
node_id,
6771+
msg,
6772+
});
6773+
}
6774+
}
6775+
};
6776+
6777+
let per_peer_state = self.per_peer_state.read().unwrap();
6778+
if let Some((counterparty_node_id, channel_id)) = channel_opt {
6779+
if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6780+
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6781+
let peer_state = &mut *peer_state_lock;
6782+
if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
6783+
unblock_chan(chan, &mut peer_state.pending_msg_events);
6784+
}
6785+
}
6786+
} else {
6787+
for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6788+
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6789+
let peer_state = &mut *peer_state_lock;
6790+
for (_, chan) in peer_state.channel_by_id.iter_mut() {
6791+
unblock_chan(chan, &mut peer_state.pending_msg_events);
6792+
}
6793+
}
6794+
}
6795+
}
6796+
67406797
/// Check whether any channels have finished removing all pending updates after a shutdown
67416798
/// exchange and can now send a closing_signed.
67426799
/// Returns whether any closing_signed messages were generated.

0 commit comments

Comments
 (0)