Skip to content

Free holding cell in remaining quiescence-exit code paths #4415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wpaulino wants to merge 6 commits into
base: main
Choose a base branch
from
+568 −303
Open

Free holding cell in remaining quiescence-exit code paths #4415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3e9a10d
Free holding cell upon handling an invalid interactive-tx message
wpaulino Feb 12, 2026
112522f
Free holding cell upon handling a counterparty tx_abort
wpaulino Feb 12, 2026
9855450
Free holding cell upon tx_signatures exchange
wpaulino Feb 12, 2026
a9eb571
Avoid persisting ChannelManager on handle_tx_* errors
wpaulino Feb 12, 2026
c2a6327
Inline unreachable debug assertion in MsgHandlErrInternal::no_such_peer
wpaulino Feb 12, 2026
826113b
Bind Channel::commitment_signed result in internal_commitment_signed
wpaulino Feb 12, 2026
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
96 changes: 61 additions & 35 deletions lightning/src/ln/channel.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1176,6 +1176,18 @@ pub enum UpdateFulfillCommitFetch {
DuplicateClaim {},
}

/// Error returned when processing an invalid interactive-tx message from our counterparty.
pub(super) struct InteractiveTxMsgError {
/// The underlying error.
pub(super) err: ChannelError,
/// If a splice was in progress when processing the message, this contains the splice funding
/// information for emitting a `SpliceFailed` event.
pub(super) splice_funding_failed: Option<SpliceFundingFailed>,
/// Whether we were quiescent when we received the message, and are no longer due to aborting
/// the session.
pub(super) exited_quiescence: bool,
}

/// The return value of `monitor_updating_restored`
pub(super) struct MonitorRestoreUpdates {
pub raa: Option<msgs::RevokeAndACK>,
Expand Down Expand Up @@ -1818,104 +1830,118 @@ where

fn fail_interactive_tx_negotiation<L: Logger>(
&mut self, reason: AbortReason, logger: &L,
) -> (ChannelError, Option<SpliceFundingFailed>) {
) -> InteractiveTxMsgError {
let logger = WithChannelContext::from(logger, &self.context(), None);
log_info!(logger, "Failed interactive transaction negotiation: {reason}");

let splice_funding_failed = match &mut self.phase {
let (splice_funding_failed, exited_quiescence) = match &mut self.phase {
ChannelPhase::Undefined => unreachable!(),
ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => None,
ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
(None, false)
},
ChannelPhase::UnfundedV2(pending_v2_channel) => {
pending_v2_channel.interactive_tx_constructor.take();
None
(None, false)
},
ChannelPhase::Funded(funded_channel) => {
if funded_channel.should_reset_pending_splice_state(false) {
funded_channel.reset_pending_splice_state()
(funded_channel.reset_pending_splice_state(), true)
} else {
debug_assert!(false, "We should never fail an interactive funding negotiation once we're exchanging tx_signatures");
None
(None, false)
}
},
};

(ChannelError::Abort(reason), splice_funding_failed)
InteractiveTxMsgError {
err: ChannelError::Abort(reason),
splice_funding_failed,
exited_quiescence,
}
}

pub fn tx_add_input<L: Logger>(
&mut self, msg: &msgs::TxAddInput, logger: &L,
) -> Result<InteractiveTxMessageSend, (ChannelError, Option<SpliceFundingFailed>)> {
) -> Result<InteractiveTxMessageSend, InteractiveTxMsgError> {
match self.interactive_tx_constructor_mut() {
Some(interactive_tx_constructor) => interactive_tx_constructor
.handle_tx_add_input(msg)
.map_err(|reason| self.fail_interactive_tx_negotiation(reason, logger)),
None => Err((
ChannelError::WarnAndDisconnect(
None => Err(InteractiveTxMsgError {
err: ChannelError::WarnAndDisconnect(
"Received unexpected interactive transaction negotiation message".to_owned(),
),
None,
)),
splice_funding_failed: None,
exited_quiescence: false,
}),
}
}

pub fn tx_add_output<L: Logger>(
&mut self, msg: &msgs::TxAddOutput, logger: &L,
) -> Result<InteractiveTxMessageSend, (ChannelError, Option<SpliceFundingFailed>)> {
) -> Result<InteractiveTxMessageSend, InteractiveTxMsgError> {
match self.interactive_tx_constructor_mut() {
Some(interactive_tx_constructor) => interactive_tx_constructor
.handle_tx_add_output(msg)
.map_err(|reason| self.fail_interactive_tx_negotiation(reason, logger)),
None => Err((
ChannelError::WarnAndDisconnect(
None => Err(InteractiveTxMsgError {
err: ChannelError::WarnAndDisconnect(
"Received unexpected interactive transaction negotiation message".to_owned(),
),
None,
)),
splice_funding_failed: None,
exited_quiescence: false,
}),
}
}

pub fn tx_remove_input<L: Logger>(
&mut self, msg: &msgs::TxRemoveInput, logger: &L,
) -> Result<InteractiveTxMessageSend, (ChannelError, Option<SpliceFundingFailed>)> {
) -> Result<InteractiveTxMessageSend, InteractiveTxMsgError> {
match self.interactive_tx_constructor_mut() {
Some(interactive_tx_constructor) => interactive_tx_constructor
.handle_tx_remove_input(msg)
.map_err(|reason| self.fail_interactive_tx_negotiation(reason, logger)),
None => Err((
ChannelError::WarnAndDisconnect(
None => Err(InteractiveTxMsgError {
err: ChannelError::WarnAndDisconnect(
"Received unexpected interactive transaction negotiation message".to_owned(),
),
None,
)),
splice_funding_failed: None,
exited_quiescence: false,
}),
}
}

pub fn tx_remove_output<L: Logger>(
&mut self, msg: &msgs::TxRemoveOutput, logger: &L,
) -> Result<InteractiveTxMessageSend, (ChannelError, Option<SpliceFundingFailed>)> {
) -> Result<InteractiveTxMessageSend, InteractiveTxMsgError> {
match self.interactive_tx_constructor_mut() {
Some(interactive_tx_constructor) => interactive_tx_constructor
.handle_tx_remove_output(msg)
.map_err(|reason| self.fail_interactive_tx_negotiation(reason, logger)),
None => Err((
ChannelError::WarnAndDisconnect(
None => Err(InteractiveTxMsgError {
err: ChannelError::WarnAndDisconnect(
"Received unexpected interactive transaction negotiation message".to_owned(),
),
None,
)),
splice_funding_failed: None,
exited_quiescence: false,
}),
}
}

pub fn tx_complete<F: FeeEstimator, L: Logger>(
&mut self, msg: &msgs::TxComplete, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L,
) -> Result<TxCompleteResult, (ChannelError, Option<SpliceFundingFailed>)> {
) -> Result<TxCompleteResult, InteractiveTxMsgError> {
let tx_complete_action = match self.interactive_tx_constructor_mut() {
Some(interactive_tx_constructor) => interactive_tx_constructor
.handle_tx_complete(msg)
.map_err(|reason| self.fail_interactive_tx_negotiation(reason, logger))?,
None => {
let err = "Received unexpected interactive transaction negotiation message";
return Err((ChannelError::WarnAndDisconnect(err.to_owned()), None));
return Err(InteractiveTxMsgError {
err: ChannelError::WarnAndDisconnect(err.to_owned()),
splice_funding_failed: None,
exited_quiescence: false,
});
},
};

Expand Down Expand Up @@ -1975,13 +2001,13 @@ where

pub fn tx_abort<L: Logger>(
&mut self, msg: &msgs::TxAbort, logger: &L,
) -> Result<(Option<msgs::TxAbort>, Option<SpliceFundingFailed>), ChannelError> {
) -> Result<(Option<msgs::TxAbort>, Option<SpliceFundingFailed>, bool), ChannelError> {
// If we have not sent a `tx_abort` message for this negotiation previously, we need to echo
// back a tx_abort message according to the spec:
// https://github.com/lightning/bolts/blob/247e83d/02-peer-protocol.md?plain=1#L560-L561
// For rationale why we echo back `tx_abort`:
// https://github.com/lightning/bolts/blob/247e83d/02-peer-protocol.md?plain=1#L578-L580
let (should_ack, splice_funding_failed) = match &mut self.phase {
let (should_ack, splice_funding_failed, exited_quiescence) = match &mut self.phase {
ChannelPhase::Undefined => unreachable!(),
ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
let err = "Got an unexpected tx_abort message: This is an unfunded channel created with V1 channel establishment";
Expand All @@ -1990,7 +2016,7 @@ where
ChannelPhase::UnfundedV2(pending_v2_channel) => {
let had_constructor =
pending_v2_channel.interactive_tx_constructor.take().is_some();
(had_constructor, None)
(had_constructor, None, false)
},
ChannelPhase::Funded(funded_channel) => {
if funded_channel.has_pending_splice_awaiting_signatures()
Expand Down Expand Up @@ -2018,11 +2044,11 @@ where
.unwrap_or(false);
debug_assert!(has_funding_negotiation);
let splice_funding_failed = funded_channel.reset_pending_splice_state();
(true, splice_funding_failed)
(true, splice_funding_failed, 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`.
(false, None)
(false, None, false)
}
},
};
Expand All @@ -2038,7 +2064,7 @@ where
}
});

Ok((tx_abort, splice_funding_failed))
Ok((tx_abort, splice_funding_failed, exited_quiescence))
}

#[rustfmt::skip]
Expand Down
Loading
Loading