Skip to content

Commit 97ffbeb

Browse files
committed
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 ec9ac9b commit 97ffbeb

File tree

2 files changed

+74
-0
lines changed

2 files changed

+74
-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>,
@@ -3792,6 +3799,21 @@ impl<SP: Deref> Channel<SP> where
37923799
Ok(())
37933800
}
37943801

3802+
/// Indicates that the signer may have some signatures for us, so we should retry if we're
3803+
/// blocked.
3804+
pub fn signer_maybe_unblocked<L: Deref>(&mut self, logger: &L) -> SignerResumeUpdates where L::Target: Logger {
3805+
let commitment_update = if self.context.signer_pending_commitment_update {
3806+
None
3807+
} else { None };
3808+
let funding_signed = None;
3809+
let funding_created = None;
3810+
SignerResumeUpdates {
3811+
commitment_update,
3812+
funding_signed,
3813+
funding_created,
3814+
}
3815+
}
3816+
37953817
fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
37963818
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);
37973819
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: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6479,6 +6479,58 @@ where
64796479
has_update
64806480
}
64816481

6482+
/// When a call to a [`ChannelSigner`] method returns an error, this indicates that the signer
6483+
/// is (temporarily) unavailable, and the operation should be retried later.
6484+
///
6485+
/// This method allows for that retry - either checking for any signer-pending messages to be
6486+
/// attempted in every channel, or in the specifically provided channel.
6487+
#[cfg(test)] // This is only implemented for one signer method, and should be private until we
6488+
// actually finish implementing it fully.
6489+
pub fn signer_unblocked(&self, channel_opt: Option<(PublicKey, ChannelId)>) {
6490+
let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6491+
6492+
let unblock_chan = |chan: &mut Channel<SP>, pending_msg_events: &mut Vec<MessageSendEvent>| {
6493+
let msgs = chan.signer_maybe_unblocked(&self.logger);
6494+
if let Some(updates) = msgs.commitment_update {
6495+
pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
6496+
node_id: chan.context.get_counterparty_node_id(),
6497+
updates,
6498+
});
6499+
}
6500+
if let Some(msg) = msgs.funding_signed {
6501+
pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
6502+
node_id: chan.context.get_counterparty_node_id(),
6503+
msg,
6504+
});
6505+
}
6506+
if let Some(msg) = msgs.funding_created {
6507+
pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
6508+
node_id: chan.context.get_counterparty_node_id(),
6509+
msg,
6510+
});
6511+
}
6512+
};
6513+
6514+
let per_peer_state = self.per_peer_state.read().unwrap();
6515+
if let Some((counterparty_node_id, channel_id)) = channel_opt {
6516+
if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6517+
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6518+
let peer_state = &mut *peer_state_lock;
6519+
if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
6520+
unblock_chan(chan, &mut peer_state.pending_msg_events);
6521+
}
6522+
}
6523+
} else {
6524+
for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6525+
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6526+
let peer_state = &mut *peer_state_lock;
6527+
for (_, chan) in peer_state.channel_by_id.iter_mut() {
6528+
unblock_chan(chan, &mut peer_state.pending_msg_events);
6529+
}
6530+
}
6531+
}
6532+
}
6533+
64826534
/// Check whether any channels have finished removing all pending updates after a shutdown
64836535
/// exchange and can now send a closing_signed.
64846536
/// Returns whether any closing_signed messages were generated.

0 commit comments

Comments
 (0)