Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 17 additions & 6 deletions lightning/src/ln/async_signer_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -596,7 +596,7 @@ fn do_test_async_raa_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(revoke_and_ack.is_none());
Expand All@@ -612,14 +612,15 @@ fn do_test_async_raa_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
assert!(commitment_signed.is_some());
assert!(resend_order == RAACommitmentOrder::RevokeAndACKFirst);
} else {
// Make sure we don't double send the RAA.
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_none());
assert!(commitment_signed.is_none());
}
Expand DownExpand Up@@ -745,7 +746,7 @@ fn do_test_async_commitment_signature_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(commitment_signed.is_none());
Expand All@@ -758,11 +759,11 @@ fn do_test_async_commitment_signature_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_some());
} else {
// Make sure we don't double send the CS.
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_none());
}
}
Expand DownExpand Up@@ -877,6 +878,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

if monitor_update_failure {
chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
Expand All@@ -896,6 +899,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

nodes[0].enable_channel_signer_op(&node_b_id, &chan_id, SignerOp::SignCounterpartyCommitment);
nodes[0].node.signer_unblocked(Some((node_b_id, chan_id)));
Expand All@@ -912,6 +917,12 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {

assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);

assert!(as_resp.4.is_none());
assert!(bs_resp.4.is_none());

assert!(as_resp.5.is_none());
assert!(bs_resp.5.is_none());

// Now that everything is restored, get the CS + RAA and handle them.
nodes[1]
.node
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/chanmon_update_fail_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
nodes[1].node.peer_disconnected(node_a_id);
let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
reconnect_args.send_channel_ready = (true, true);
reconnect_args.send_announcement_sigs = (true, true);
reconnect_nodes(reconnect_args);
}

Expand Down
135 changes: 72 additions & 63 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1694,8 +1694,7 @@ where
pending_v2_channel.interactive_tx_constructor.take();
},
ChannelPhase::Funded(funded_channel) => {
if funded_channel.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
{
if funded_channel.should_reset_pending_splice_state() {
funded_channel.reset_pending_splice_state();
} else {
debug_assert!(false, "We should never fail an interactive funding negotiation once we're exchanging tx_signatures");
Expand DownExpand Up@@ -1829,18 +1828,15 @@ where
pending_v2_channel.interactive_tx_constructor.take().is_some()
},
ChannelPhase::Funded(funded_channel) => {
if let Some(should_reset) =
funded_channel.should_reset_pending_splice_funding_negotiation()
{
if should_reset {
// We may have still tracked the pending funding negotiation state, so we
// should ack with our own `tx_abort`.
funded_channel.reset_pending_splice_state()
} else {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.has_pending_splice_awaiting_signatures() {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.should_reset_pending_splice_state() {
let has_funding_negotiation = funded_channel.reset_pending_splice_state();
debug_assert!(has_funding_negotiation);
true
} else {
// We were not tracking the pending funding negotiation state anymore, likely
// due to a disconnection or already having sent our own `tx_abort`.
Expand DownExpand Up@@ -2583,13 +2579,17 @@ impl FundingNegotiation {
}

impl PendingFunding {
fn can_abandon_funding_negotiation(&self) -> bool {
fn can_abandon_state(&self) -> bool {
self.funding_negotiation
.as_ref()
.map(|funding_negotiation| {
!matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(true)
.unwrap_or_else(|| {
let has_negotiated_candidates = !self.negotiated_candidates.is_empty();
debug_assert!(has_negotiated_candidates);
!has_negotiated_candidates
})
}

fn check_get_splice_locked<SP: Deref>(
Expand DownExpand Up@@ -6773,40 +6773,35 @@ where
)
}

/// Returns `None` if there is no [`FundedChannel::pending_splice`], otherwise a boolean
/// indicating whether we should reset the splice's [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_funding_negotiation(&self) -> Option<bool> {
self.pending_splice.as_ref().map(|pending_splice| {
if pending_splice.can_abandon_funding_negotiation() {
true
} else {
self.context
.interactive_tx_signing_session
.as_ref()
.map(|signing_session| !signing_session.has_received_commitment_signed())
.unwrap_or_else(|| {
debug_assert!(false);
false
})
}
})
fn has_pending_splice_awaiting_signatures(&self) -> bool {
self.pending_splice
.as_ref()
.and_then(|pending_splice| pending_splice.funding_negotiation.as_ref())
.map(|funding_negotiation| {
matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(false)
}

/// Returns a boolean indicating whether we should reset the splice's
/// [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_state(&self) -> bool {
self.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
&& self.pending_funding().is_empty()
self.pending_splice
.as_ref()
.map(|pending_splice| pending_splice.can_abandon_state())
.unwrap_or(false)
}

fn reset_pending_splice_state(&mut self) -> bool {
debug_assert!(self.should_reset_pending_splice_funding_negotiation().unwrap_or(true));
debug_assert!(self.should_reset_pending_splice_state());
debug_assert!(self.context.interactive_tx_signing_session.is_none());
self.context.channel_state.clear_quiescent();
self.context.interactive_tx_signing_session.take();
let has_funding_negotiation = self
.pending_splice
.as_mut()
.and_then(|pending_splice| pending_splice.funding_negotiation.take())
.is_some();
if self.should_reset_pending_splice_state() {
if self.pending_funding().is_empty() {
self.pending_splice.take();
}
has_funding_negotiation
Expand DownExpand Up@@ -8678,8 +8673,19 @@ where
.unwrap_or(false));
}

if signing_session.holder_tx_signatures().is_some() {
// Our `tx_signatures` either should've been the first time we processed them,
// or we're waiting for our counterparty to send theirs first.
return Ok((None, None));
}
Comment thread
wpaulino marked this conversation as resolved.

signing_session
} else {
if Some(funding_txid_signed) == self.funding.get_funding_txid() {
// We may be handling a duplicate call and the funding was already locked so we
// no longer have the signing session present.
return Ok((None, None));
}
let err =
format!("Channel {} not expecting funding signatures", self.context.channel_id);
return Err(APIError::APIMisuseError { err });
Expand DownExpand Up@@ -8937,13 +8943,16 @@ where
}
self.context.channel_state.clear_local_stfu_sent();
self.context.channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the negotiation
// failed due to disconnecting, we shouldn't be quiescent anymore upon reconnecting.
// If there was a pending splice negotiation that has failed due to disconnecting,
// we also take the opportunity to clean up our state.
if self.should_reset_pending_splice_state() {
// If there was a pending splice negotiation that failed due to disconnecting, we
// also take the opportunity to clean up our state.
self.reset_pending_splice_state();
debug_assert!(!self.context.channel_state.is_quiescent());
} else if !self.has_pending_splice_awaiting_signatures() {
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to disconnecting
self.context.channel_state.clear_quiescent();
}
}

Expand DownExpand Up@@ -9682,12 +9691,18 @@ where

// A node:
// - if `next_commitment_number` is 1 in both the `channel_reestablish` it
// sent and received:
// sent and received, and none of those `channel_reestablish` messages
// contain `my_current_funding_locked` or `next_funding` for a splice transaction:
// - MUST retransmit `channel_ready`.
// - otherwise:
// - MUST NOT retransmit `channel_ready`, but MAY send `channel_ready` with
// a different `short_channel_id` `alias` field.
let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1 {
let both_sides_on_initial_commitment_number = msg.next_local_commitment_number == 1
&& INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1;
let channel_ready = if both_sides_on_initial_commitment_number
&& self.pending_splice.is_none()
&& self.funding.channel_transaction_parameters.splice_parent_funding_txid.is_none()
{
// We should never have to worry about MonitorUpdateInProgress resending ChannelReady
self.get_channel_ready(logger)
} else { None };
Expand DownExpand Up@@ -13976,10 +13991,13 @@ where
}
channel_state.clear_local_stfu_sent();
channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the
// negotiation failed due to disconnecting, we shouldn't be quiescent
// anymore upon reconnecting.
if self.should_reset_pending_splice_state()
|| !self.has_pending_splice_awaiting_signatures()
{
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to
// disconnecting
channel_state.clear_quiescent();
}
},
Expand DownExpand Up@@ -14344,19 +14362,10 @@ where
let holder_commitment_point_next = self.holder_commitment_point.next_point();
let holder_commitment_point_pending_next = self.holder_commitment_point.pending_next_point;

let interactive_tx_signing_session =
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(false) {
None
} else {
self.context.interactive_tx_signing_session.as_ref()
};
let pending_splice = if self.should_reset_pending_splice_state() {
None
} else {
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
self.pending_splice.as_ref()
};
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
let pending_splice =
self.pending_splice.as_ref().filter(|_| !self.should_reset_pending_splice_state());

write_tlv_fields!(writer, {
(0, self.context.announcement_sigs, option),
Expand DownExpand Up@@ -14401,7 +14410,7 @@ where
(53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
(55, removed_htlc_attribution_data, optional_vec), // Added in 0.2
(57, holding_cell_attribution_data, optional_vec), // Added in 0.2
(58, interactive_tx_signing_session, option), // Added in 0.2
(58, self.context.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec), // Added in 0.2
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -9391,6 +9391,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
if let Some(signing_session) = (!channel.is_awaiting_monitor_update())
.then(|| ())
.and_then(|_| channel.context.interactive_tx_signing_session.as_mut())
.filter(|signing_session| signing_session.has_received_commitment_signed())
.filter(|signing_session| signing_session.holder_tx_signatures().is_none())
{
if signing_session.has_local_contribution() {
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" + '
Test channel reestablish during splice lifecycle by wpaulino · Pull Request #4079 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 17 additions & 6 deletions lightning/src/ln/async_signer_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -596,7 +596,7 @@ fn do_test_async_raa_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(revoke_and_ack.is_none());
Expand All@@ -612,14 +612,15 @@ fn do_test_async_raa_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
assert!(commitment_signed.is_some());
assert!(resend_order == RAACommitmentOrder::RevokeAndACKFirst);
} else {
// Make sure we don't double send the RAA.
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_none());
assert!(commitment_signed.is_none());
}
Expand DownExpand Up@@ -745,7 +746,7 @@ fn do_test_async_commitment_signature_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(commitment_signed.is_none());
Expand All@@ -758,11 +759,11 @@ fn do_test_async_commitment_signature_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_some());
} else {
// Make sure we don't double send the CS.
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_none());
}
}
Expand DownExpand Up@@ -877,6 +878,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

if monitor_update_failure {
chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
Expand All@@ -896,6 +899,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

nodes[0].enable_channel_signer_op(&node_b_id, &chan_id, SignerOp::SignCounterpartyCommitment);
nodes[0].node.signer_unblocked(Some((node_b_id, chan_id)));
Expand All@@ -912,6 +917,12 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {

assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);

assert!(as_resp.4.is_none());
assert!(bs_resp.4.is_none());

assert!(as_resp.5.is_none());
assert!(bs_resp.5.is_none());

// Now that everything is restored, get the CS + RAA and handle them.
nodes[1]
.node
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/chanmon_update_fail_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
nodes[1].node.peer_disconnected(node_a_id);
let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
reconnect_args.send_channel_ready = (true, true);
reconnect_args.send_announcement_sigs = (true, true);
reconnect_nodes(reconnect_args);
}

Expand Down
135 changes: 72 additions & 63 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1694,8 +1694,7 @@ where
pending_v2_channel.interactive_tx_constructor.take();
},
ChannelPhase::Funded(funded_channel) => {
if funded_channel.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
{
if funded_channel.should_reset_pending_splice_state() {
funded_channel.reset_pending_splice_state();
} else {
debug_assert!(false, "We should never fail an interactive funding negotiation once we're exchanging tx_signatures");
Expand DownExpand Up@@ -1829,18 +1828,15 @@ where
pending_v2_channel.interactive_tx_constructor.take().is_some()
},
ChannelPhase::Funded(funded_channel) => {
if let Some(should_reset) =
funded_channel.should_reset_pending_splice_funding_negotiation()
{
if should_reset {
// We may have still tracked the pending funding negotiation state, so we
// should ack with our own `tx_abort`.
funded_channel.reset_pending_splice_state()
} else {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.has_pending_splice_awaiting_signatures() {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.should_reset_pending_splice_state() {
let has_funding_negotiation = funded_channel.reset_pending_splice_state();
debug_assert!(has_funding_negotiation);
true
} else {
// We were not tracking the pending funding negotiation state anymore, likely
// due to a disconnection or already having sent our own `tx_abort`.
Expand DownExpand Up@@ -2583,13 +2579,17 @@ impl FundingNegotiation {
}

impl PendingFunding {
fn can_abandon_funding_negotiation(&self) -> bool {
fn can_abandon_state(&self) -> bool {
self.funding_negotiation
.as_ref()
.map(|funding_negotiation| {
!matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(true)
.unwrap_or_else(|| {
let has_negotiated_candidates = !self.negotiated_candidates.is_empty();
debug_assert!(has_negotiated_candidates);
!has_negotiated_candidates
})
}

fn check_get_splice_locked<SP: Deref>(
Expand DownExpand Up@@ -6773,40 +6773,35 @@ where
)
}

/// Returns `None` if there is no [`FundedChannel::pending_splice`], otherwise a boolean
/// indicating whether we should reset the splice's [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_funding_negotiation(&self) -> Option<bool> {
self.pending_splice.as_ref().map(|pending_splice| {
if pending_splice.can_abandon_funding_negotiation() {
true
} else {
self.context
.interactive_tx_signing_session
.as_ref()
.map(|signing_session| !signing_session.has_received_commitment_signed())
.unwrap_or_else(|| {
debug_assert!(false);
false
})
}
})
fn has_pending_splice_awaiting_signatures(&self) -> bool {
self.pending_splice
.as_ref()
.and_then(|pending_splice| pending_splice.funding_negotiation.as_ref())
.map(|funding_negotiation| {
matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(false)
}

/// Returns a boolean indicating whether we should reset the splice's
/// [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_state(&self) -> bool {
self.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
&& self.pending_funding().is_empty()
self.pending_splice
.as_ref()
.map(|pending_splice| pending_splice.can_abandon_state())
.unwrap_or(false)
}

fn reset_pending_splice_state(&mut self) -> bool {
debug_assert!(self.should_reset_pending_splice_funding_negotiation().unwrap_or(true));
debug_assert!(self.should_reset_pending_splice_state());
debug_assert!(self.context.interactive_tx_signing_session.is_none());
self.context.channel_state.clear_quiescent();
self.context.interactive_tx_signing_session.take();
let has_funding_negotiation = self
.pending_splice
.as_mut()
.and_then(|pending_splice| pending_splice.funding_negotiation.take())
.is_some();
if self.should_reset_pending_splice_state() {
if self.pending_funding().is_empty() {
self.pending_splice.take();
}
has_funding_negotiation
Expand DownExpand Up@@ -8678,8 +8673,19 @@ where
.unwrap_or(false));
}

if signing_session.holder_tx_signatures().is_some() {
// Our `tx_signatures` either should've been the first time we processed them,
// or we're waiting for our counterparty to send theirs first.
return Ok((None, None));
}
Comment thread
wpaulino marked this conversation as resolved.

signing_session
} else {
if Some(funding_txid_signed) == self.funding.get_funding_txid() {
// We may be handling a duplicate call and the funding was already locked so we
// no longer have the signing session present.
return Ok((None, None));
}
let err =
format!("Channel {} not expecting funding signatures", self.context.channel_id);
return Err(APIError::APIMisuseError { err });
Expand DownExpand Up@@ -8937,13 +8943,16 @@ where
}
self.context.channel_state.clear_local_stfu_sent();
self.context.channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the negotiation
// failed due to disconnecting, we shouldn't be quiescent anymore upon reconnecting.
// If there was a pending splice negotiation that has failed due to disconnecting,
// we also take the opportunity to clean up our state.
if self.should_reset_pending_splice_state() {
// If there was a pending splice negotiation that failed due to disconnecting, we
// also take the opportunity to clean up our state.
self.reset_pending_splice_state();
debug_assert!(!self.context.channel_state.is_quiescent());
} else if !self.has_pending_splice_awaiting_signatures() {
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to disconnecting
self.context.channel_state.clear_quiescent();
}
}

Expand DownExpand Up@@ -9682,12 +9691,18 @@ where

// A node:
// - if `next_commitment_number` is 1 in both the `channel_reestablish` it
// sent and received:
// sent and received, and none of those `channel_reestablish` messages
// contain `my_current_funding_locked` or `next_funding` for a splice transaction:
// - MUST retransmit `channel_ready`.
// - otherwise:
// - MUST NOT retransmit `channel_ready`, but MAY send `channel_ready` with
// a different `short_channel_id` `alias` field.
let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1 {
let both_sides_on_initial_commitment_number = msg.next_local_commitment_number == 1
&& INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1;
let channel_ready = if both_sides_on_initial_commitment_number
&& self.pending_splice.is_none()
&& self.funding.channel_transaction_parameters.splice_parent_funding_txid.is_none()
{
// We should never have to worry about MonitorUpdateInProgress resending ChannelReady
self.get_channel_ready(logger)
} else { None };
Expand DownExpand Up@@ -13976,10 +13991,13 @@ where
}
channel_state.clear_local_stfu_sent();
channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the
// negotiation failed due to disconnecting, we shouldn't be quiescent
// anymore upon reconnecting.
if self.should_reset_pending_splice_state()
|| !self.has_pending_splice_awaiting_signatures()
{
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to
// disconnecting
channel_state.clear_quiescent();
}
},
Expand DownExpand Up@@ -14344,19 +14362,10 @@ where
let holder_commitment_point_next = self.holder_commitment_point.next_point();
let holder_commitment_point_pending_next = self.holder_commitment_point.pending_next_point;

let interactive_tx_signing_session =
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(false) {
None
} else {
self.context.interactive_tx_signing_session.as_ref()
};
let pending_splice = if self.should_reset_pending_splice_state() {
None
} else {
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
self.pending_splice.as_ref()
};
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
let pending_splice =
self.pending_splice.as_ref().filter(|_| !self.should_reset_pending_splice_state());

write_tlv_fields!(writer, {
(0, self.context.announcement_sigs, option),
Expand DownExpand Up@@ -14401,7 +14410,7 @@ where
(53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
(55, removed_htlc_attribution_data, optional_vec), // Added in 0.2
(57, holding_cell_attribution_data, optional_vec), // Added in 0.2
(58, interactive_tx_signing_session, option), // Added in 0.2
(58, self.context.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec), // Added in 0.2
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -9391,6 +9391,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
if let Some(signing_session) = (!channel.is_awaiting_monitor_update())
.then(|| ())
.and_then(|_| channel.context.interactive_tx_signing_session.as_mut())
.filter(|signing_session| signing_session.has_received_commitment_signed())
.filter(|signing_session| signing_session.holder_tx_signatures().is_none())
{
if signing_session.has_local_contribution() {
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('^' + ".*" + ' Test channel reestablish during splice lifecycle by wpaulino · Pull Request #4079 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 17 additions & 6 deletions lightning/src/ln/async_signer_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -596,7 +596,7 @@ fn do_test_async_raa_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(revoke_and_ack.is_none());
Expand All@@ -612,14 +612,15 @@ fn do_test_async_raa_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
assert!(commitment_signed.is_some());
assert!(resend_order == RAACommitmentOrder::RevokeAndACKFirst);
} else {
// Make sure we don't double send the RAA.
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_none());
assert!(commitment_signed.is_none());
}
Expand DownExpand Up@@ -745,7 +746,7 @@ fn do_test_async_commitment_signature_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(commitment_signed.is_none());
Expand All@@ -758,11 +759,11 @@ fn do_test_async_commitment_signature_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_some());
} else {
// Make sure we don't double send the CS.
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_none());
}
}
Expand DownExpand Up@@ -877,6 +878,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

if monitor_update_failure {
chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
Expand All@@ -896,6 +899,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

nodes[0].enable_channel_signer_op(&node_b_id, &chan_id, SignerOp::SignCounterpartyCommitment);
nodes[0].node.signer_unblocked(Some((node_b_id, chan_id)));
Expand All@@ -912,6 +917,12 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {

assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);

assert!(as_resp.4.is_none());
assert!(bs_resp.4.is_none());

assert!(as_resp.5.is_none());
assert!(bs_resp.5.is_none());

// Now that everything is restored, get the CS + RAA and handle them.
nodes[1]
.node
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/chanmon_update_fail_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
nodes[1].node.peer_disconnected(node_a_id);
let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
reconnect_args.send_channel_ready = (true, true);
reconnect_args.send_announcement_sigs = (true, true);
reconnect_nodes(reconnect_args);
}

Expand Down
135 changes: 72 additions & 63 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1694,8 +1694,7 @@ where
pending_v2_channel.interactive_tx_constructor.take();
},
ChannelPhase::Funded(funded_channel) => {
if funded_channel.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
{
if funded_channel.should_reset_pending_splice_state() {
funded_channel.reset_pending_splice_state();
} else {
debug_assert!(false, "We should never fail an interactive funding negotiation once we're exchanging tx_signatures");
Expand DownExpand Up@@ -1829,18 +1828,15 @@ where
pending_v2_channel.interactive_tx_constructor.take().is_some()
},
ChannelPhase::Funded(funded_channel) => {
if let Some(should_reset) =
funded_channel.should_reset_pending_splice_funding_negotiation()
{
if should_reset {
// We may have still tracked the pending funding negotiation state, so we
// should ack with our own `tx_abort`.
funded_channel.reset_pending_splice_state()
} else {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.has_pending_splice_awaiting_signatures() {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.should_reset_pending_splice_state() {
let has_funding_negotiation = funded_channel.reset_pending_splice_state();
debug_assert!(has_funding_negotiation);
true
} else {
// We were not tracking the pending funding negotiation state anymore, likely
// due to a disconnection or already having sent our own `tx_abort`.
Expand DownExpand Up@@ -2583,13 +2579,17 @@ impl FundingNegotiation {
}

impl PendingFunding {
fn can_abandon_funding_negotiation(&self) -> bool {
fn can_abandon_state(&self) -> bool {
self.funding_negotiation
.as_ref()
.map(|funding_negotiation| {
!matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(true)
.unwrap_or_else(|| {
let has_negotiated_candidates = !self.negotiated_candidates.is_empty();
debug_assert!(has_negotiated_candidates);
!has_negotiated_candidates
})
}

fn check_get_splice_locked<SP: Deref>(
Expand DownExpand Up@@ -6773,40 +6773,35 @@ where
)
}

/// Returns `None` if there is no [`FundedChannel::pending_splice`], otherwise a boolean
/// indicating whether we should reset the splice's [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_funding_negotiation(&self) -> Option<bool> {
self.pending_splice.as_ref().map(|pending_splice| {
if pending_splice.can_abandon_funding_negotiation() {
true
} else {
self.context
.interactive_tx_signing_session
.as_ref()
.map(|signing_session| !signing_session.has_received_commitment_signed())
.unwrap_or_else(|| {
debug_assert!(false);
false
})
}
})
fn has_pending_splice_awaiting_signatures(&self) -> bool {
self.pending_splice
.as_ref()
.and_then(|pending_splice| pending_splice.funding_negotiation.as_ref())
.map(|funding_negotiation| {
matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(false)
}

/// Returns a boolean indicating whether we should reset the splice's
/// [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_state(&self) -> bool {
self.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
&& self.pending_funding().is_empty()
self.pending_splice
.as_ref()
.map(|pending_splice| pending_splice.can_abandon_state())
.unwrap_or(false)
}

fn reset_pending_splice_state(&mut self) -> bool {
debug_assert!(self.should_reset_pending_splice_funding_negotiation().unwrap_or(true));
debug_assert!(self.should_reset_pending_splice_state());
debug_assert!(self.context.interactive_tx_signing_session.is_none());
self.context.channel_state.clear_quiescent();
self.context.interactive_tx_signing_session.take();
let has_funding_negotiation = self
.pending_splice
.as_mut()
.and_then(|pending_splice| pending_splice.funding_negotiation.take())
.is_some();
if self.should_reset_pending_splice_state() {
if self.pending_funding().is_empty() {
self.pending_splice.take();
}
has_funding_negotiation
Expand DownExpand Up@@ -8678,8 +8673,19 @@ where
.unwrap_or(false));
}

if signing_session.holder_tx_signatures().is_some() {
// Our `tx_signatures` either should've been the first time we processed them,
// or we're waiting for our counterparty to send theirs first.
return Ok((None, None));
}
Comment thread
wpaulino marked this conversation as resolved.

signing_session
} else {
if Some(funding_txid_signed) == self.funding.get_funding_txid() {
// We may be handling a duplicate call and the funding was already locked so we
// no longer have the signing session present.
return Ok((None, None));
}
let err =
format!("Channel {} not expecting funding signatures", self.context.channel_id);
return Err(APIError::APIMisuseError { err });
Expand DownExpand Up@@ -8937,13 +8943,16 @@ where
}
self.context.channel_state.clear_local_stfu_sent();
self.context.channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the negotiation
// failed due to disconnecting, we shouldn't be quiescent anymore upon reconnecting.
// If there was a pending splice negotiation that has failed due to disconnecting,
// we also take the opportunity to clean up our state.
if self.should_reset_pending_splice_state() {
// If there was a pending splice negotiation that failed due to disconnecting, we
// also take the opportunity to clean up our state.
self.reset_pending_splice_state();
debug_assert!(!self.context.channel_state.is_quiescent());
} else if !self.has_pending_splice_awaiting_signatures() {
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to disconnecting
self.context.channel_state.clear_quiescent();
}
}

Expand DownExpand Up@@ -9682,12 +9691,18 @@ where

// A node:
// - if `next_commitment_number` is 1 in both the `channel_reestablish` it
// sent and received:
// sent and received, and none of those `channel_reestablish` messages
// contain `my_current_funding_locked` or `next_funding` for a splice transaction:
// - MUST retransmit `channel_ready`.
// - otherwise:
// - MUST NOT retransmit `channel_ready`, but MAY send `channel_ready` with
// a different `short_channel_id` `alias` field.
let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1 {
let both_sides_on_initial_commitment_number = msg.next_local_commitment_number == 1
&& INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1;
let channel_ready = if both_sides_on_initial_commitment_number
&& self.pending_splice.is_none()
&& self.funding.channel_transaction_parameters.splice_parent_funding_txid.is_none()
{
// We should never have to worry about MonitorUpdateInProgress resending ChannelReady
self.get_channel_ready(logger)
} else { None };
Expand DownExpand Up@@ -13976,10 +13991,13 @@ where
}
channel_state.clear_local_stfu_sent();
channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the
// negotiation failed due to disconnecting, we shouldn't be quiescent
// anymore upon reconnecting.
if self.should_reset_pending_splice_state()
|| !self.has_pending_splice_awaiting_signatures()
{
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to
// disconnecting
channel_state.clear_quiescent();
}
},
Expand DownExpand Up@@ -14344,19 +14362,10 @@ where
let holder_commitment_point_next = self.holder_commitment_point.next_point();
let holder_commitment_point_pending_next = self.holder_commitment_point.pending_next_point;

let interactive_tx_signing_session =
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(false) {
None
} else {
self.context.interactive_tx_signing_session.as_ref()
};
let pending_splice = if self.should_reset_pending_splice_state() {
None
} else {
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
self.pending_splice.as_ref()
};
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
let pending_splice =
self.pending_splice.as_ref().filter(|_| !self.should_reset_pending_splice_state());

write_tlv_fields!(writer, {
(0, self.context.announcement_sigs, option),
Expand DownExpand Up@@ -14401,7 +14410,7 @@ where
(53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
(55, removed_htlc_attribution_data, optional_vec), // Added in 0.2
(57, holding_cell_attribution_data, optional_vec), // Added in 0.2
(58, interactive_tx_signing_session, option), // Added in 0.2
(58, self.context.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec), // Added in 0.2
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -9391,6 +9391,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
if let Some(signing_session) = (!channel.is_awaiting_monitor_update())
.then(|| ())
.and_then(|_| channel.context.interactive_tx_signing_session.as_mut())
.filter(|signing_session| signing_session.has_received_commitment_signed())
.filter(|signing_session| signing_session.holder_tx_signatures().is_none())
{
if signing_session.has_local_contribution() {
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('^' + ".*" + ' Test channel reestablish during splice lifecycle by wpaulino · Pull Request #4079 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 17 additions & 6 deletions lightning/src/ln/async_signer_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -596,7 +596,7 @@ fn do_test_async_raa_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(revoke_and_ack.is_none());
Expand All@@ -612,14 +612,15 @@ fn do_test_async_raa_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
assert!(commitment_signed.is_some());
assert!(resend_order == RAACommitmentOrder::RevokeAndACKFirst);
} else {
// Make sure we don't double send the RAA.
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_none());
assert!(commitment_signed.is_none());
}
Expand DownExpand Up@@ -745,7 +746,7 @@ fn do_test_async_commitment_signature_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(commitment_signed.is_none());
Expand All@@ -758,11 +759,11 @@ fn do_test_async_commitment_signature_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_some());
} else {
// Make sure we don't double send the CS.
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_none());
}
}
Expand DownExpand Up@@ -877,6 +878,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

if monitor_update_failure {
chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
Expand All@@ -896,6 +899,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

nodes[0].enable_channel_signer_op(&node_b_id, &chan_id, SignerOp::SignCounterpartyCommitment);
nodes[0].node.signer_unblocked(Some((node_b_id, chan_id)));
Expand All@@ -912,6 +917,12 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {

assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);

assert!(as_resp.4.is_none());
assert!(bs_resp.4.is_none());

assert!(as_resp.5.is_none());
assert!(bs_resp.5.is_none());

// Now that everything is restored, get the CS + RAA and handle them.
nodes[1]
.node
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/chanmon_update_fail_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
nodes[1].node.peer_disconnected(node_a_id);
let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
reconnect_args.send_channel_ready = (true, true);
reconnect_args.send_announcement_sigs = (true, true);
reconnect_nodes(reconnect_args);
}

Expand Down
135 changes: 72 additions & 63 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1694,8 +1694,7 @@ where
pending_v2_channel.interactive_tx_constructor.take();
},
ChannelPhase::Funded(funded_channel) => {
if funded_channel.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
{
if funded_channel.should_reset_pending_splice_state() {
funded_channel.reset_pending_splice_state();
} else {
debug_assert!(false, "We should never fail an interactive funding negotiation once we're exchanging tx_signatures");
Expand DownExpand Up@@ -1829,18 +1828,15 @@ where
pending_v2_channel.interactive_tx_constructor.take().is_some()
},
ChannelPhase::Funded(funded_channel) => {
if let Some(should_reset) =
funded_channel.should_reset_pending_splice_funding_negotiation()
{
if should_reset {
// We may have still tracked the pending funding negotiation state, so we
// should ack with our own `tx_abort`.
funded_channel.reset_pending_splice_state()
} else {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.has_pending_splice_awaiting_signatures() {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.should_reset_pending_splice_state() {
let has_funding_negotiation = funded_channel.reset_pending_splice_state();
debug_assert!(has_funding_negotiation);
true
} else {
// We were not tracking the pending funding negotiation state anymore, likely
// due to a disconnection or already having sent our own `tx_abort`.
Expand DownExpand Up@@ -2583,13 +2579,17 @@ impl FundingNegotiation {
}

impl PendingFunding {
fn can_abandon_funding_negotiation(&self) -> bool {
fn can_abandon_state(&self) -> bool {
self.funding_negotiation
.as_ref()
.map(|funding_negotiation| {
!matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(true)
.unwrap_or_else(|| {
let has_negotiated_candidates = !self.negotiated_candidates.is_empty();
debug_assert!(has_negotiated_candidates);
!has_negotiated_candidates
})
}

fn check_get_splice_locked<SP: Deref>(
Expand DownExpand Up@@ -6773,40 +6773,35 @@ where
)
}

/// Returns `None` if there is no [`FundedChannel::pending_splice`], otherwise a boolean
/// indicating whether we should reset the splice's [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_funding_negotiation(&self) -> Option<bool> {
self.pending_splice.as_ref().map(|pending_splice| {
if pending_splice.can_abandon_funding_negotiation() {
true
} else {
self.context
.interactive_tx_signing_session
.as_ref()
.map(|signing_session| !signing_session.has_received_commitment_signed())
.unwrap_or_else(|| {
debug_assert!(false);
false
})
}
})
fn has_pending_splice_awaiting_signatures(&self) -> bool {
self.pending_splice
.as_ref()
.and_then(|pending_splice| pending_splice.funding_negotiation.as_ref())
.map(|funding_negotiation| {
matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(false)
}

/// Returns a boolean indicating whether we should reset the splice's
/// [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_state(&self) -> bool {
self.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
&& self.pending_funding().is_empty()
self.pending_splice
.as_ref()
.map(|pending_splice| pending_splice.can_abandon_state())
.unwrap_or(false)
}

fn reset_pending_splice_state(&mut self) -> bool {
debug_assert!(self.should_reset_pending_splice_funding_negotiation().unwrap_or(true));
debug_assert!(self.should_reset_pending_splice_state());
debug_assert!(self.context.interactive_tx_signing_session.is_none());
self.context.channel_state.clear_quiescent();
self.context.interactive_tx_signing_session.take();
let has_funding_negotiation = self
.pending_splice
.as_mut()
.and_then(|pending_splice| pending_splice.funding_negotiation.take())
.is_some();
if self.should_reset_pending_splice_state() {
if self.pending_funding().is_empty() {
self.pending_splice.take();
}
has_funding_negotiation
Expand DownExpand Up@@ -8678,8 +8673,19 @@ where
.unwrap_or(false));
}

if signing_session.holder_tx_signatures().is_some() {
// Our `tx_signatures` either should've been the first time we processed them,
// or we're waiting for our counterparty to send theirs first.
return Ok((None, None));
}
Comment thread
wpaulino marked this conversation as resolved.

signing_session
} else {
if Some(funding_txid_signed) == self.funding.get_funding_txid() {
// We may be handling a duplicate call and the funding was already locked so we
// no longer have the signing session present.
return Ok((None, None));
}
let err =
format!("Channel {} not expecting funding signatures", self.context.channel_id);
return Err(APIError::APIMisuseError { err });
Expand DownExpand Up@@ -8937,13 +8943,16 @@ where
}
self.context.channel_state.clear_local_stfu_sent();
self.context.channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the negotiation
// failed due to disconnecting, we shouldn't be quiescent anymore upon reconnecting.
// If there was a pending splice negotiation that has failed due to disconnecting,
// we also take the opportunity to clean up our state.
if self.should_reset_pending_splice_state() {
// If there was a pending splice negotiation that failed due to disconnecting, we
// also take the opportunity to clean up our state.
self.reset_pending_splice_state();
debug_assert!(!self.context.channel_state.is_quiescent());
} else if !self.has_pending_splice_awaiting_signatures() {
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to disconnecting
self.context.channel_state.clear_quiescent();
}
}

Expand DownExpand Up@@ -9682,12 +9691,18 @@ where

// A node:
// - if `next_commitment_number` is 1 in both the `channel_reestablish` it
// sent and received:
// sent and received, and none of those `channel_reestablish` messages
// contain `my_current_funding_locked` or `next_funding` for a splice transaction:
// - MUST retransmit `channel_ready`.
// - otherwise:
// - MUST NOT retransmit `channel_ready`, but MAY send `channel_ready` with
// a different `short_channel_id` `alias` field.
let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1 {
let both_sides_on_initial_commitment_number = msg.next_local_commitment_number == 1
&& INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1;
let channel_ready = if both_sides_on_initial_commitment_number
&& self.pending_splice.is_none()
&& self.funding.channel_transaction_parameters.splice_parent_funding_txid.is_none()
{
// We should never have to worry about MonitorUpdateInProgress resending ChannelReady
self.get_channel_ready(logger)
} else { None };
Expand DownExpand Up@@ -13976,10 +13991,13 @@ where
}
channel_state.clear_local_stfu_sent();
channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the
// negotiation failed due to disconnecting, we shouldn't be quiescent
// anymore upon reconnecting.
if self.should_reset_pending_splice_state()
|| !self.has_pending_splice_awaiting_signatures()
{
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to
// disconnecting
channel_state.clear_quiescent();
}
},
Expand DownExpand Up@@ -14344,19 +14362,10 @@ where
let holder_commitment_point_next = self.holder_commitment_point.next_point();
let holder_commitment_point_pending_next = self.holder_commitment_point.pending_next_point;

let interactive_tx_signing_session =
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(false) {
None
} else {
self.context.interactive_tx_signing_session.as_ref()
};
let pending_splice = if self.should_reset_pending_splice_state() {
None
} else {
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
self.pending_splice.as_ref()
};
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
let pending_splice =
self.pending_splice.as_ref().filter(|_| !self.should_reset_pending_splice_state());

write_tlv_fields!(writer, {
(0, self.context.announcement_sigs, option),
Expand DownExpand Up@@ -14401,7 +14410,7 @@ where
(53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
(55, removed_htlc_attribution_data, optional_vec), // Added in 0.2
(57, holding_cell_attribution_data, optional_vec), // Added in 0.2
(58, interactive_tx_signing_session, option), // Added in 0.2
(58, self.context.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec), // Added in 0.2
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -9391,6 +9391,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
if let Some(signing_session) = (!channel.is_awaiting_monitor_update())
.then(|| ())
.and_then(|_| channel.context.interactive_tx_signing_session.as_mut())
.filter(|signing_session| signing_session.has_received_commitment_signed())
.filter(|signing_session| signing_session.holder_tx_signatures().is_none())
{
if signing_session.has_local_contribution() {
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" + ' Test channel reestablish during splice lifecycle by wpaulino · Pull Request #4079 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 17 additions & 6 deletions lightning/src/ln/async_signer_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -596,7 +596,7 @@ fn do_test_async_raa_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(revoke_and_ack.is_none());
Expand All@@ -612,14 +612,15 @@ fn do_test_async_raa_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
assert!(commitment_signed.is_some());
assert!(resend_order == RAACommitmentOrder::RevokeAndACKFirst);
} else {
// Make sure we don't double send the RAA.
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_none());
assert!(commitment_signed.is_none());
}
Expand DownExpand Up@@ -745,7 +746,7 @@ fn do_test_async_commitment_signature_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(commitment_signed.is_none());
Expand All@@ -758,11 +759,11 @@ fn do_test_async_commitment_signature_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_some());
} else {
// Make sure we don't double send the CS.
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_none());
}
}
Expand DownExpand Up@@ -877,6 +878,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

if monitor_update_failure {
chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
Expand All@@ -896,6 +899,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

nodes[0].enable_channel_signer_op(&node_b_id, &chan_id, SignerOp::SignCounterpartyCommitment);
nodes[0].node.signer_unblocked(Some((node_b_id, chan_id)));
Expand All@@ -912,6 +917,12 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {

assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);

assert!(as_resp.4.is_none());
assert!(bs_resp.4.is_none());

assert!(as_resp.5.is_none());
assert!(bs_resp.5.is_none());

// Now that everything is restored, get the CS + RAA and handle them.
nodes[1]
.node
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/chanmon_update_fail_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
nodes[1].node.peer_disconnected(node_a_id);
let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
reconnect_args.send_channel_ready = (true, true);
reconnect_args.send_announcement_sigs = (true, true);
reconnect_nodes(reconnect_args);
}

Expand Down
135 changes: 72 additions & 63 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1694,8 +1694,7 @@ where
pending_v2_channel.interactive_tx_constructor.take();
},
ChannelPhase::Funded(funded_channel) => {
if funded_channel.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
{
if funded_channel.should_reset_pending_splice_state() {
funded_channel.reset_pending_splice_state();
} else {
debug_assert!(false, "We should never fail an interactive funding negotiation once we're exchanging tx_signatures");
Expand DownExpand Up@@ -1829,18 +1828,15 @@ where
pending_v2_channel.interactive_tx_constructor.take().is_some()
},
ChannelPhase::Funded(funded_channel) => {
if let Some(should_reset) =
funded_channel.should_reset_pending_splice_funding_negotiation()
{
if should_reset {
// We may have still tracked the pending funding negotiation state, so we
// should ack with our own `tx_abort`.
funded_channel.reset_pending_splice_state()
} else {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.has_pending_splice_awaiting_signatures() {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.should_reset_pending_splice_state() {
let has_funding_negotiation = funded_channel.reset_pending_splice_state();
debug_assert!(has_funding_negotiation);
true
} else {
// We were not tracking the pending funding negotiation state anymore, likely
// due to a disconnection or already having sent our own `tx_abort`.
Expand DownExpand Up@@ -2583,13 +2579,17 @@ impl FundingNegotiation {
}

impl PendingFunding {
fn can_abandon_funding_negotiation(&self) -> bool {
fn can_abandon_state(&self) -> bool {
self.funding_negotiation
.as_ref()
.map(|funding_negotiation| {
!matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(true)
.unwrap_or_else(|| {
let has_negotiated_candidates = !self.negotiated_candidates.is_empty();
debug_assert!(has_negotiated_candidates);
!has_negotiated_candidates
})
}

fn check_get_splice_locked<SP: Deref>(
Expand DownExpand Up@@ -6773,40 +6773,35 @@ where
)
}

/// Returns `None` if there is no [`FundedChannel::pending_splice`], otherwise a boolean
/// indicating whether we should reset the splice's [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_funding_negotiation(&self) -> Option<bool> {
self.pending_splice.as_ref().map(|pending_splice| {
if pending_splice.can_abandon_funding_negotiation() {
true
} else {
self.context
.interactive_tx_signing_session
.as_ref()
.map(|signing_session| !signing_session.has_received_commitment_signed())
.unwrap_or_else(|| {
debug_assert!(false);
false
})
}
})
fn has_pending_splice_awaiting_signatures(&self) -> bool {
self.pending_splice
.as_ref()
.and_then(|pending_splice| pending_splice.funding_negotiation.as_ref())
.map(|funding_negotiation| {
matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(false)
}

/// Returns a boolean indicating whether we should reset the splice's
/// [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_state(&self) -> bool {
self.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
&& self.pending_funding().is_empty()
self.pending_splice
.as_ref()
.map(|pending_splice| pending_splice.can_abandon_state())
.unwrap_or(false)
}

fn reset_pending_splice_state(&mut self) -> bool {
debug_assert!(self.should_reset_pending_splice_funding_negotiation().unwrap_or(true));
debug_assert!(self.should_reset_pending_splice_state());
debug_assert!(self.context.interactive_tx_signing_session.is_none());
self.context.channel_state.clear_quiescent();
self.context.interactive_tx_signing_session.take();
let has_funding_negotiation = self
.pending_splice
.as_mut()
.and_then(|pending_splice| pending_splice.funding_negotiation.take())
.is_some();
if self.should_reset_pending_splice_state() {
if self.pending_funding().is_empty() {
self.pending_splice.take();
}
has_funding_negotiation
Expand DownExpand Up@@ -8678,8 +8673,19 @@ where
.unwrap_or(false));
}

if signing_session.holder_tx_signatures().is_some() {
// Our `tx_signatures` either should've been the first time we processed them,
// or we're waiting for our counterparty to send theirs first.
return Ok((None, None));
}
Comment thread
wpaulino marked this conversation as resolved.

signing_session
} else {
if Some(funding_txid_signed) == self.funding.get_funding_txid() {
// We may be handling a duplicate call and the funding was already locked so we
// no longer have the signing session present.
return Ok((None, None));
}
let err =
format!("Channel {} not expecting funding signatures", self.context.channel_id);
return Err(APIError::APIMisuseError { err });
Expand DownExpand Up@@ -8937,13 +8943,16 @@ where
}
self.context.channel_state.clear_local_stfu_sent();
self.context.channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the negotiation
// failed due to disconnecting, we shouldn't be quiescent anymore upon reconnecting.
// If there was a pending splice negotiation that has failed due to disconnecting,
// we also take the opportunity to clean up our state.
if self.should_reset_pending_splice_state() {
// If there was a pending splice negotiation that failed due to disconnecting, we
// also take the opportunity to clean up our state.
self.reset_pending_splice_state();
debug_assert!(!self.context.channel_state.is_quiescent());
} else if !self.has_pending_splice_awaiting_signatures() {
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to disconnecting
self.context.channel_state.clear_quiescent();
}
}

Expand DownExpand Up@@ -9682,12 +9691,18 @@ where

// A node:
// - if `next_commitment_number` is 1 in both the `channel_reestablish` it
// sent and received:
// sent and received, and none of those `channel_reestablish` messages
// contain `my_current_funding_locked` or `next_funding` for a splice transaction:
// - MUST retransmit `channel_ready`.
// - otherwise:
// - MUST NOT retransmit `channel_ready`, but MAY send `channel_ready` with
// a different `short_channel_id` `alias` field.
let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1 {
let both_sides_on_initial_commitment_number = msg.next_local_commitment_number == 1
&& INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1;
let channel_ready = if both_sides_on_initial_commitment_number
&& self.pending_splice.is_none()
&& self.funding.channel_transaction_parameters.splice_parent_funding_txid.is_none()
{
// We should never have to worry about MonitorUpdateInProgress resending ChannelReady
self.get_channel_ready(logger)
} else { None };
Expand DownExpand Up@@ -13976,10 +13991,13 @@ where
}
channel_state.clear_local_stfu_sent();
channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the
// negotiation failed due to disconnecting, we shouldn't be quiescent
// anymore upon reconnecting.
if self.should_reset_pending_splice_state()
|| !self.has_pending_splice_awaiting_signatures()
{
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to
// disconnecting
channel_state.clear_quiescent();
}
},
Expand DownExpand Up@@ -14344,19 +14362,10 @@ where
let holder_commitment_point_next = self.holder_commitment_point.next_point();
let holder_commitment_point_pending_next = self.holder_commitment_point.pending_next_point;

let interactive_tx_signing_session =
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(false) {
None
} else {
self.context.interactive_tx_signing_session.as_ref()
};
let pending_splice = if self.should_reset_pending_splice_state() {
None
} else {
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
self.pending_splice.as_ref()
};
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
let pending_splice =
self.pending_splice.as_ref().filter(|_| !self.should_reset_pending_splice_state());

write_tlv_fields!(writer, {
(0, self.context.announcement_sigs, option),
Expand DownExpand Up@@ -14401,7 +14410,7 @@ where
(53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
(55, removed_htlc_attribution_data, optional_vec), // Added in 0.2
(57, holding_cell_attribution_data, optional_vec), // Added in 0.2
(58, interactive_tx_signing_session, option), // Added in 0.2
(58, self.context.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec), // Added in 0.2
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -9391,6 +9391,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
if let Some(signing_session) = (!channel.is_awaiting_monitor_update())
.then(|| ())
.and_then(|_| channel.context.interactive_tx_signing_session.as_mut())
.filter(|signing_session| signing_session.has_received_commitment_signed())
.filter(|signing_session| signing_session.holder_tx_signatures().is_none())
{
if signing_session.has_local_contribution() {
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('^' + ".*" + ' Test channel reestablish during splice lifecycle by wpaulino · Pull Request #4079 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 17 additions & 6 deletions lightning/src/ln/async_signer_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -596,7 +596,7 @@ fn do_test_async_raa_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(revoke_and_ack.is_none());
Expand All@@ -612,14 +612,15 @@ fn do_test_async_raa_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
assert!(commitment_signed.is_some());
assert!(resend_order == RAACommitmentOrder::RevokeAndACKFirst);
} else {
// Make sure we don't double send the RAA.
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_none());
assert!(commitment_signed.is_none());
}
Expand DownExpand Up@@ -745,7 +746,7 @@ fn do_test_async_commitment_signature_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(commitment_signed.is_none());
Expand All@@ -758,11 +759,11 @@ fn do_test_async_commitment_signature_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_some());
} else {
// Make sure we don't double send the CS.
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_none());
}
}
Expand DownExpand Up@@ -877,6 +878,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

if monitor_update_failure {
chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
Expand All@@ -896,6 +899,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

nodes[0].enable_channel_signer_op(&node_b_id, &chan_id, SignerOp::SignCounterpartyCommitment);
nodes[0].node.signer_unblocked(Some((node_b_id, chan_id)));
Expand All@@ -912,6 +917,12 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {

assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);

assert!(as_resp.4.is_none());
assert!(bs_resp.4.is_none());

assert!(as_resp.5.is_none());
assert!(bs_resp.5.is_none());

// Now that everything is restored, get the CS + RAA and handle them.
nodes[1]
.node
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/chanmon_update_fail_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
nodes[1].node.peer_disconnected(node_a_id);
let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
reconnect_args.send_channel_ready = (true, true);
reconnect_args.send_announcement_sigs = (true, true);
reconnect_nodes(reconnect_args);
}

Expand Down
135 changes: 72 additions & 63 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1694,8 +1694,7 @@ where
pending_v2_channel.interactive_tx_constructor.take();
},
ChannelPhase::Funded(funded_channel) => {
if funded_channel.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
{
if funded_channel.should_reset_pending_splice_state() {
funded_channel.reset_pending_splice_state();
} else {
debug_assert!(false, "We should never fail an interactive funding negotiation once we're exchanging tx_signatures");
Expand DownExpand Up@@ -1829,18 +1828,15 @@ where
pending_v2_channel.interactive_tx_constructor.take().is_some()
},
ChannelPhase::Funded(funded_channel) => {
if let Some(should_reset) =
funded_channel.should_reset_pending_splice_funding_negotiation()
{
if should_reset {
// We may have still tracked the pending funding negotiation state, so we
// should ack with our own `tx_abort`.
funded_channel.reset_pending_splice_state()
} else {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.has_pending_splice_awaiting_signatures() {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.should_reset_pending_splice_state() {
let has_funding_negotiation = funded_channel.reset_pending_splice_state();
debug_assert!(has_funding_negotiation);
true
} else {
// We were not tracking the pending funding negotiation state anymore, likely
// due to a disconnection or already having sent our own `tx_abort`.
Expand DownExpand Up@@ -2583,13 +2579,17 @@ impl FundingNegotiation {
}

impl PendingFunding {
fn can_abandon_funding_negotiation(&self) -> bool {
fn can_abandon_state(&self) -> bool {
self.funding_negotiation
.as_ref()
.map(|funding_negotiation| {
!matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(true)
.unwrap_or_else(|| {
let has_negotiated_candidates = !self.negotiated_candidates.is_empty();
debug_assert!(has_negotiated_candidates);
!has_negotiated_candidates
})
}

fn check_get_splice_locked<SP: Deref>(
Expand DownExpand Up@@ -6773,40 +6773,35 @@ where
)
}

/// Returns `None` if there is no [`FundedChannel::pending_splice`], otherwise a boolean
/// indicating whether we should reset the splice's [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_funding_negotiation(&self) -> Option<bool> {
self.pending_splice.as_ref().map(|pending_splice| {
if pending_splice.can_abandon_funding_negotiation() {
true
} else {
self.context
.interactive_tx_signing_session
.as_ref()
.map(|signing_session| !signing_session.has_received_commitment_signed())
.unwrap_or_else(|| {
debug_assert!(false);
false
})
}
})
fn has_pending_splice_awaiting_signatures(&self) -> bool {
self.pending_splice
.as_ref()
.and_then(|pending_splice| pending_splice.funding_negotiation.as_ref())
.map(|funding_negotiation| {
matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(false)
}

/// Returns a boolean indicating whether we should reset the splice's
/// [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_state(&self) -> bool {
self.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
&& self.pending_funding().is_empty()
self.pending_splice
.as_ref()
.map(|pending_splice| pending_splice.can_abandon_state())
.unwrap_or(false)
}

fn reset_pending_splice_state(&mut self) -> bool {
debug_assert!(self.should_reset_pending_splice_funding_negotiation().unwrap_or(true));
debug_assert!(self.should_reset_pending_splice_state());
debug_assert!(self.context.interactive_tx_signing_session.is_none());
self.context.channel_state.clear_quiescent();
self.context.interactive_tx_signing_session.take();
let has_funding_negotiation = self
.pending_splice
.as_mut()
.and_then(|pending_splice| pending_splice.funding_negotiation.take())
.is_some();
if self.should_reset_pending_splice_state() {
if self.pending_funding().is_empty() {
self.pending_splice.take();
}
has_funding_negotiation
Expand DownExpand Up@@ -8678,8 +8673,19 @@ where
.unwrap_or(false));
}

if signing_session.holder_tx_signatures().is_some() {
// Our `tx_signatures` either should've been the first time we processed them,
// or we're waiting for our counterparty to send theirs first.
return Ok((None, None));
}
Comment thread
wpaulino marked this conversation as resolved.

signing_session
} else {
if Some(funding_txid_signed) == self.funding.get_funding_txid() {
// We may be handling a duplicate call and the funding was already locked so we
// no longer have the signing session present.
return Ok((None, None));
}
let err =
format!("Channel {} not expecting funding signatures", self.context.channel_id);
return Err(APIError::APIMisuseError { err });
Expand DownExpand Up@@ -8937,13 +8943,16 @@ where
}
self.context.channel_state.clear_local_stfu_sent();
self.context.channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the negotiation
// failed due to disconnecting, we shouldn't be quiescent anymore upon reconnecting.
// If there was a pending splice negotiation that has failed due to disconnecting,
// we also take the opportunity to clean up our state.
if self.should_reset_pending_splice_state() {
// If there was a pending splice negotiation that failed due to disconnecting, we
// also take the opportunity to clean up our state.
self.reset_pending_splice_state();
debug_assert!(!self.context.channel_state.is_quiescent());
} else if !self.has_pending_splice_awaiting_signatures() {
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to disconnecting
self.context.channel_state.clear_quiescent();
}
}

Expand DownExpand Up@@ -9682,12 +9691,18 @@ where

// A node:
// - if `next_commitment_number` is 1 in both the `channel_reestablish` it
// sent and received:
// sent and received, and none of those `channel_reestablish` messages
// contain `my_current_funding_locked` or `next_funding` for a splice transaction:
// - MUST retransmit `channel_ready`.
// - otherwise:
// - MUST NOT retransmit `channel_ready`, but MAY send `channel_ready` with
// a different `short_channel_id` `alias` field.
let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1 {
let both_sides_on_initial_commitment_number = msg.next_local_commitment_number == 1
&& INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1;
let channel_ready = if both_sides_on_initial_commitment_number
&& self.pending_splice.is_none()
&& self.funding.channel_transaction_parameters.splice_parent_funding_txid.is_none()
{
// We should never have to worry about MonitorUpdateInProgress resending ChannelReady
self.get_channel_ready(logger)
} else { None };
Expand DownExpand Up@@ -13976,10 +13991,13 @@ where
}
channel_state.clear_local_stfu_sent();
channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the
// negotiation failed due to disconnecting, we shouldn't be quiescent
// anymore upon reconnecting.
if self.should_reset_pending_splice_state()
|| !self.has_pending_splice_awaiting_signatures()
{
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to
// disconnecting
channel_state.clear_quiescent();
}
},
Expand DownExpand Up@@ -14344,19 +14362,10 @@ where
let holder_commitment_point_next = self.holder_commitment_point.next_point();
let holder_commitment_point_pending_next = self.holder_commitment_point.pending_next_point;

let interactive_tx_signing_session =
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(false) {
None
} else {
self.context.interactive_tx_signing_session.as_ref()
};
let pending_splice = if self.should_reset_pending_splice_state() {
None
} else {
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
self.pending_splice.as_ref()
};
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
let pending_splice =
self.pending_splice.as_ref().filter(|_| !self.should_reset_pending_splice_state());

write_tlv_fields!(writer, {
(0, self.context.announcement_sigs, option),
Expand DownExpand Up@@ -14401,7 +14410,7 @@ where
(53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
(55, removed_htlc_attribution_data, optional_vec), // Added in 0.2
(57, holding_cell_attribution_data, optional_vec), // Added in 0.2
(58, interactive_tx_signing_session, option), // Added in 0.2
(58, self.context.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec), // Added in 0.2
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -9391,6 +9391,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
if let Some(signing_session) = (!channel.is_awaiting_monitor_update())
.then(|| ())
.and_then(|_| channel.context.interactive_tx_signing_session.as_mut())
.filter(|signing_session| signing_session.has_received_commitment_signed())
.filter(|signing_session| signing_session.holder_tx_signatures().is_none())
{
if signing_session.has_local_contribution() {
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('^' + ".*" + ' Test channel reestablish during splice lifecycle by wpaulino · Pull Request #4079 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 17 additions & 6 deletions lightning/src/ln/async_signer_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -596,7 +596,7 @@ fn do_test_async_raa_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(revoke_and_ack.is_none());
Expand All@@ -612,14 +612,15 @@ fn do_test_async_raa_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
assert!(commitment_signed.is_some());
assert!(resend_order == RAACommitmentOrder::RevokeAndACKFirst);
} else {
// Make sure we don't double send the RAA.
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_none());
assert!(commitment_signed.is_none());
}
Expand DownExpand Up@@ -745,7 +746,7 @@ fn do_test_async_commitment_signature_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(commitment_signed.is_none());
Expand All@@ -758,11 +759,11 @@ fn do_test_async_commitment_signature_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_some());
} else {
// Make sure we don't double send the CS.
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_none());
}
}
Expand DownExpand Up@@ -877,6 +878,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

if monitor_update_failure {
chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
Expand All@@ -896,6 +899,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

nodes[0].enable_channel_signer_op(&node_b_id, &chan_id, SignerOp::SignCounterpartyCommitment);
nodes[0].node.signer_unblocked(Some((node_b_id, chan_id)));
Expand All@@ -912,6 +917,12 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {

assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);

assert!(as_resp.4.is_none());
assert!(bs_resp.4.is_none());

assert!(as_resp.5.is_none());
assert!(bs_resp.5.is_none());

// Now that everything is restored, get the CS + RAA and handle them.
nodes[1]
.node
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/chanmon_update_fail_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
nodes[1].node.peer_disconnected(node_a_id);
let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
reconnect_args.send_channel_ready = (true, true);
reconnect_args.send_announcement_sigs = (true, true);
reconnect_nodes(reconnect_args);
}

Expand Down
135 changes: 72 additions & 63 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1694,8 +1694,7 @@ where
pending_v2_channel.interactive_tx_constructor.take();
},
ChannelPhase::Funded(funded_channel) => {
if funded_channel.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
{
if funded_channel.should_reset_pending_splice_state() {
funded_channel.reset_pending_splice_state();
} else {
debug_assert!(false, "We should never fail an interactive funding negotiation once we're exchanging tx_signatures");
Expand DownExpand Up@@ -1829,18 +1828,15 @@ where
pending_v2_channel.interactive_tx_constructor.take().is_some()
},
ChannelPhase::Funded(funded_channel) => {
if let Some(should_reset) =
funded_channel.should_reset_pending_splice_funding_negotiation()
{
if should_reset {
// We may have still tracked the pending funding negotiation state, so we
// should ack with our own `tx_abort`.
funded_channel.reset_pending_splice_state()
} else {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.has_pending_splice_awaiting_signatures() {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.should_reset_pending_splice_state() {
let has_funding_negotiation = funded_channel.reset_pending_splice_state();
debug_assert!(has_funding_negotiation);
true
} else {
// We were not tracking the pending funding negotiation state anymore, likely
// due to a disconnection or already having sent our own `tx_abort`.
Expand DownExpand Up@@ -2583,13 +2579,17 @@ impl FundingNegotiation {
}

impl PendingFunding {
fn can_abandon_funding_negotiation(&self) -> bool {
fn can_abandon_state(&self) -> bool {
self.funding_negotiation
.as_ref()
.map(|funding_negotiation| {
!matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(true)
.unwrap_or_else(|| {
let has_negotiated_candidates = !self.negotiated_candidates.is_empty();
debug_assert!(has_negotiated_candidates);
!has_negotiated_candidates
})
}

fn check_get_splice_locked<SP: Deref>(
Expand DownExpand Up@@ -6773,40 +6773,35 @@ where
)
}

/// Returns `None` if there is no [`FundedChannel::pending_splice`], otherwise a boolean
/// indicating whether we should reset the splice's [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_funding_negotiation(&self) -> Option<bool> {
self.pending_splice.as_ref().map(|pending_splice| {
if pending_splice.can_abandon_funding_negotiation() {
true
} else {
self.context
.interactive_tx_signing_session
.as_ref()
.map(|signing_session| !signing_session.has_received_commitment_signed())
.unwrap_or_else(|| {
debug_assert!(false);
false
})
}
})
fn has_pending_splice_awaiting_signatures(&self) -> bool {
self.pending_splice
.as_ref()
.and_then(|pending_splice| pending_splice.funding_negotiation.as_ref())
.map(|funding_negotiation| {
matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(false)
}

/// Returns a boolean indicating whether we should reset the splice's
/// [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_state(&self) -> bool {
self.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
&& self.pending_funding().is_empty()
self.pending_splice
.as_ref()
.map(|pending_splice| pending_splice.can_abandon_state())
.unwrap_or(false)
}

fn reset_pending_splice_state(&mut self) -> bool {
debug_assert!(self.should_reset_pending_splice_funding_negotiation().unwrap_or(true));
debug_assert!(self.should_reset_pending_splice_state());
debug_assert!(self.context.interactive_tx_signing_session.is_none());
self.context.channel_state.clear_quiescent();
self.context.interactive_tx_signing_session.take();
let has_funding_negotiation = self
.pending_splice
.as_mut()
.and_then(|pending_splice| pending_splice.funding_negotiation.take())
.is_some();
if self.should_reset_pending_splice_state() {
if self.pending_funding().is_empty() {
self.pending_splice.take();
}
has_funding_negotiation
Expand DownExpand Up@@ -8678,8 +8673,19 @@ where
.unwrap_or(false));
}

if signing_session.holder_tx_signatures().is_some() {
// Our `tx_signatures` either should've been the first time we processed them,
// or we're waiting for our counterparty to send theirs first.
return Ok((None, None));
}
Comment thread
wpaulino marked this conversation as resolved.

signing_session
} else {
if Some(funding_txid_signed) == self.funding.get_funding_txid() {
// We may be handling a duplicate call and the funding was already locked so we
// no longer have the signing session present.
return Ok((None, None));
}
let err =
format!("Channel {} not expecting funding signatures", self.context.channel_id);
return Err(APIError::APIMisuseError { err });
Expand DownExpand Up@@ -8937,13 +8943,16 @@ where
}
self.context.channel_state.clear_local_stfu_sent();
self.context.channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the negotiation
// failed due to disconnecting, we shouldn't be quiescent anymore upon reconnecting.
// If there was a pending splice negotiation that has failed due to disconnecting,
// we also take the opportunity to clean up our state.
if self.should_reset_pending_splice_state() {
// If there was a pending splice negotiation that failed due to disconnecting, we
// also take the opportunity to clean up our state.
self.reset_pending_splice_state();
debug_assert!(!self.context.channel_state.is_quiescent());
} else if !self.has_pending_splice_awaiting_signatures() {
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to disconnecting
self.context.channel_state.clear_quiescent();
}
}

Expand DownExpand Up@@ -9682,12 +9691,18 @@ where

// A node:
// - if `next_commitment_number` is 1 in both the `channel_reestablish` it
// sent and received:
// sent and received, and none of those `channel_reestablish` messages
// contain `my_current_funding_locked` or `next_funding` for a splice transaction:
// - MUST retransmit `channel_ready`.
// - otherwise:
// - MUST NOT retransmit `channel_ready`, but MAY send `channel_ready` with
// a different `short_channel_id` `alias` field.
let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1 {
let both_sides_on_initial_commitment_number = msg.next_local_commitment_number == 1
&& INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1;
let channel_ready = if both_sides_on_initial_commitment_number
&& self.pending_splice.is_none()
&& self.funding.channel_transaction_parameters.splice_parent_funding_txid.is_none()
{
// We should never have to worry about MonitorUpdateInProgress resending ChannelReady
self.get_channel_ready(logger)
} else { None };
Expand DownExpand Up@@ -13976,10 +13991,13 @@ where
}
channel_state.clear_local_stfu_sent();
channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the
// negotiation failed due to disconnecting, we shouldn't be quiescent
// anymore upon reconnecting.
if self.should_reset_pending_splice_state()
|| !self.has_pending_splice_awaiting_signatures()
{
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to
// disconnecting
channel_state.clear_quiescent();
}
},
Expand DownExpand Up@@ -14344,19 +14362,10 @@ where
let holder_commitment_point_next = self.holder_commitment_point.next_point();
let holder_commitment_point_pending_next = self.holder_commitment_point.pending_next_point;

let interactive_tx_signing_session =
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(false) {
None
} else {
self.context.interactive_tx_signing_session.as_ref()
};
let pending_splice = if self.should_reset_pending_splice_state() {
None
} else {
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
self.pending_splice.as_ref()
};
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
let pending_splice =
self.pending_splice.as_ref().filter(|_| !self.should_reset_pending_splice_state());

write_tlv_fields!(writer, {
(0, self.context.announcement_sigs, option),
Expand DownExpand Up@@ -14401,7 +14410,7 @@ where
(53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
(55, removed_htlc_attribution_data, optional_vec), // Added in 0.2
(57, holding_cell_attribution_data, optional_vec), // Added in 0.2
(58, interactive_tx_signing_session, option), // Added in 0.2
(58, self.context.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec), // Added in 0.2
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -9391,6 +9391,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
if let Some(signing_session) = (!channel.is_awaiting_monitor_update())
.then(|| ())
.and_then(|_| channel.context.interactive_tx_signing_session.as_mut())
.filter(|signing_session| signing_session.has_received_commitment_signed())
.filter(|signing_session| signing_session.holder_tx_signatures().is_none())
{
if signing_session.has_local_contribution() {
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); } })(); })(); Test channel reestablish during splice lifecycle by wpaulino · Pull Request #4079 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 17 additions & 6 deletions lightning/src/ln/async_signer_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -596,7 +596,7 @@ fn do_test_async_raa_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(revoke_and_ack.is_none());
Expand All@@ -612,14 +612,15 @@ fn do_test_async_raa_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, revoke_and_ack, commitment_signed, resend_order) =
let (_, revoke_and_ack, commitment_signed, resend_order, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
assert!(commitment_signed.is_some());
assert!(resend_order == RAACommitmentOrder::RevokeAndACKFirst);
} else {
// Make sure we don't double send the RAA.
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) =
handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_none());
assert!(commitment_signed.is_none());
}
Expand DownExpand Up@@ -745,7 +746,7 @@ fn do_test_async_commitment_signature_peer_disconnect(
}

// Expect the RAA
let (_, revoke_and_ack, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, revoke_and_ack, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(revoke_and_ack.is_some());
if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
assert!(commitment_signed.is_none());
Expand All@@ -758,11 +759,11 @@ fn do_test_async_commitment_signature_peer_disconnect(
dst.node.signer_unblocked(Some((src_node_id, chan_id)));

if test_case == UnblockSignerAcrossDisconnectCase::AtEnd {
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_some());
} else {
// Make sure we don't double send the CS.
let (_, _, commitment_signed, _) = handle_chan_reestablish_msgs!(dst, src);
let (_, _, commitment_signed, _, _, _) = handle_chan_reestablish_msgs!(dst, src);
assert!(commitment_signed.is_none());
}
}
Expand DownExpand Up@@ -877,6 +878,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

if monitor_update_failure {
chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
Expand All@@ -896,6 +899,8 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {
assert!(as_resp.0.is_none());
assert!(as_resp.1.is_none());
assert!(as_resp.2.is_none());
assert!(as_resp.4.is_none());
assert!(as_resp.5.is_none());

nodes[0].enable_channel_signer_op(&node_b_id, &chan_id, SignerOp::SignCounterpartyCommitment);
nodes[0].node.signer_unblocked(Some((node_b_id, chan_id)));
Expand All@@ -912,6 +917,12 @@ fn do_test_async_commitment_signature_ordering(monitor_update_failure: bool) {

assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);

assert!(as_resp.4.is_none());
assert!(bs_resp.4.is_none());

assert!(as_resp.5.is_none());
assert!(bs_resp.5.is_none());

// Now that everything is restored, get the CS + RAA and handle them.
nodes[1]
.node
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/chanmon_update_fail_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
nodes[1].node.peer_disconnected(node_a_id);
let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
reconnect_args.send_channel_ready = (true, true);
reconnect_args.send_announcement_sigs = (true, true);
reconnect_nodes(reconnect_args);
}

Expand Down
135 changes: 72 additions & 63 deletions lightning/src/ln/channel.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1694,8 +1694,7 @@ where
pending_v2_channel.interactive_tx_constructor.take();
},
ChannelPhase::Funded(funded_channel) => {
if funded_channel.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
{
if funded_channel.should_reset_pending_splice_state() {
funded_channel.reset_pending_splice_state();
} else {
debug_assert!(false, "We should never fail an interactive funding negotiation once we're exchanging tx_signatures");
Expand DownExpand Up@@ -1829,18 +1828,15 @@ where
pending_v2_channel.interactive_tx_constructor.take().is_some()
},
ChannelPhase::Funded(funded_channel) => {
if let Some(should_reset) =
funded_channel.should_reset_pending_splice_funding_negotiation()
{
if should_reset {
// We may have still tracked the pending funding negotiation state, so we
// should ack with our own `tx_abort`.
funded_channel.reset_pending_splice_state()
} else {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.has_pending_splice_awaiting_signatures() {
return Err(ChannelError::close(
"Received tx_abort while awaiting tx_signatures exchange".to_owned(),
));
}
if funded_channel.should_reset_pending_splice_state() {
let has_funding_negotiation = funded_channel.reset_pending_splice_state();
debug_assert!(has_funding_negotiation);
true
} else {
// We were not tracking the pending funding negotiation state anymore, likely
// due to a disconnection or already having sent our own `tx_abort`.
Expand DownExpand Up@@ -2583,13 +2579,17 @@ impl FundingNegotiation {
}

impl PendingFunding {
fn can_abandon_funding_negotiation(&self) -> bool {
fn can_abandon_state(&self) -> bool {
self.funding_negotiation
.as_ref()
.map(|funding_negotiation| {
!matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(true)
.unwrap_or_else(|| {
let has_negotiated_candidates = !self.negotiated_candidates.is_empty();
debug_assert!(has_negotiated_candidates);
!has_negotiated_candidates
})
}

fn check_get_splice_locked<SP: Deref>(
Expand DownExpand Up@@ -6773,40 +6773,35 @@ where
)
}

/// Returns `None` if there is no [`FundedChannel::pending_splice`], otherwise a boolean
/// indicating whether we should reset the splice's [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_funding_negotiation(&self) -> Option<bool> {
self.pending_splice.as_ref().map(|pending_splice| {
if pending_splice.can_abandon_funding_negotiation() {
true
} else {
self.context
.interactive_tx_signing_session
.as_ref()
.map(|signing_session| !signing_session.has_received_commitment_signed())
.unwrap_or_else(|| {
debug_assert!(false);
false
})
}
})
fn has_pending_splice_awaiting_signatures(&self) -> bool {
self.pending_splice
.as_ref()
.and_then(|pending_splice| pending_splice.funding_negotiation.as_ref())
.map(|funding_negotiation| {
matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. })
})
.unwrap_or(false)
}

/// Returns a boolean indicating whether we should reset the splice's
/// [`PendingFunding::funding_negotiation`].
fn should_reset_pending_splice_state(&self) -> bool {
self.should_reset_pending_splice_funding_negotiation().unwrap_or(true)
&& self.pending_funding().is_empty()
self.pending_splice
.as_ref()
.map(|pending_splice| pending_splice.can_abandon_state())
.unwrap_or(false)
}

fn reset_pending_splice_state(&mut self) -> bool {
debug_assert!(self.should_reset_pending_splice_funding_negotiation().unwrap_or(true));
debug_assert!(self.should_reset_pending_splice_state());
debug_assert!(self.context.interactive_tx_signing_session.is_none());
self.context.channel_state.clear_quiescent();
self.context.interactive_tx_signing_session.take();
let has_funding_negotiation = self
.pending_splice
.as_mut()
.and_then(|pending_splice| pending_splice.funding_negotiation.take())
.is_some();
if self.should_reset_pending_splice_state() {
if self.pending_funding().is_empty() {
self.pending_splice.take();
}
has_funding_negotiation
Expand DownExpand Up@@ -8678,8 +8673,19 @@ where
.unwrap_or(false));
}

if signing_session.holder_tx_signatures().is_some() {
// Our `tx_signatures` either should've been the first time we processed them,
// or we're waiting for our counterparty to send theirs first.
return Ok((None, None));
}
Comment thread
wpaulino marked this conversation as resolved.

signing_session
} else {
if Some(funding_txid_signed) == self.funding.get_funding_txid() {
// We may be handling a duplicate call and the funding was already locked so we
// no longer have the signing session present.
return Ok((None, None));
}
let err =
format!("Channel {} not expecting funding signatures", self.context.channel_id);
return Err(APIError::APIMisuseError { err });
Expand DownExpand Up@@ -8937,13 +8943,16 @@ where
}
self.context.channel_state.clear_local_stfu_sent();
self.context.channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the negotiation
// failed due to disconnecting, we shouldn't be quiescent anymore upon reconnecting.
// If there was a pending splice negotiation that has failed due to disconnecting,
// we also take the opportunity to clean up our state.
if self.should_reset_pending_splice_state() {
// If there was a pending splice negotiation that failed due to disconnecting, we
// also take the opportunity to clean up our state.
self.reset_pending_splice_state();
debug_assert!(!self.context.channel_state.is_quiescent());
} else if !self.has_pending_splice_awaiting_signatures() {
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to disconnecting
self.context.channel_state.clear_quiescent();
}
}

Expand DownExpand Up@@ -9682,12 +9691,18 @@ where

// A node:
// - if `next_commitment_number` is 1 in both the `channel_reestablish` it
// sent and received:
// sent and received, and none of those `channel_reestablish` messages
// contain `my_current_funding_locked` or `next_funding` for a splice transaction:
// - MUST retransmit `channel_ready`.
// - otherwise:
// - MUST NOT retransmit `channel_ready`, but MAY send `channel_ready` with
// a different `short_channel_id` `alias` field.
let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1 {
let both_sides_on_initial_commitment_number = msg.next_local_commitment_number == 1
&& INITIAL_COMMITMENT_NUMBER - self.holder_commitment_point.next_transaction_number() == 1;
let channel_ready = if both_sides_on_initial_commitment_number
&& self.pending_splice.is_none()
&& self.funding.channel_transaction_parameters.splice_parent_funding_txid.is_none()
{
// We should never have to worry about MonitorUpdateInProgress resending ChannelReady
self.get_channel_ready(logger)
} else { None };
Expand DownExpand Up@@ -13976,10 +13991,13 @@ where
}
channel_state.clear_local_stfu_sent();
channel_state.clear_remote_stfu_sent();
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(true) {
// If we were in quiescence but a splice was never negotiated, or the
// negotiation failed due to disconnecting, we shouldn't be quiescent
// anymore upon reconnecting.
if self.should_reset_pending_splice_state()
|| !self.has_pending_splice_awaiting_signatures()
{
// We shouldn't be quiescent anymore upon reconnecting if:
// - We were in quiescence but a splice/RBF was never negotiated or
// - We were in quiescence but the splice negotiation failed due to
// disconnecting
channel_state.clear_quiescent();
}
},
Expand DownExpand Up@@ -14344,19 +14362,10 @@ where
let holder_commitment_point_next = self.holder_commitment_point.next_point();
let holder_commitment_point_pending_next = self.holder_commitment_point.pending_next_point;

let interactive_tx_signing_session =
if self.should_reset_pending_splice_funding_negotiation().unwrap_or(false) {
None
} else {
self.context.interactive_tx_signing_session.as_ref()
};
let pending_splice = if self.should_reset_pending_splice_state() {
None
} else {
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
self.pending_splice.as_ref()
};
// We don't have to worry about resetting the pending `FundingNegotiation` because we
// can only read `FundingNegotiation::AwaitingSignatures` variants anyway.
let pending_splice =
self.pending_splice.as_ref().filter(|_| !self.should_reset_pending_splice_state());

write_tlv_fields!(writer, {
(0, self.context.announcement_sigs, option),
Expand DownExpand Up@@ -14401,7 +14410,7 @@ where
(53, funding_tx_broadcast_safe_event_emitted, option), // Added in 0.0.124
(55, removed_htlc_attribution_data, optional_vec), // Added in 0.2
(57, holding_cell_attribution_data, optional_vec), // Added in 0.2
(58, interactive_tx_signing_session, option), // Added in 0.2
(58, self.context.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec), // Added in 0.2
Expand Down
1 change: 1 addition & 0 deletions lightning/src/ln/channelmanager.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -9391,6 +9391,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
if let Some(signing_session) = (!channel.is_awaiting_monitor_update())
.then(|| ())
.and_then(|_| channel.context.interactive_tx_signing_session.as_mut())
.filter(|signing_session| signing_session.has_received_commitment_signed())
.filter(|signing_session| signing_session.holder_tx_signatures().is_none())
{
if signing_session.has_local_contribution() {
Expand Down
Loading