Skip to content

Include NegotiationFailureReason in InteractiveTxMsgError #4609

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 1 commit into
base: main
Choose a base branch
from
+62 −37
Open

Include NegotiationFailureReason in InteractiveTxMsgError #4609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
83 changes: 57 additions & 26 deletions lightning/src/ln/channel.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1187,6 +1187,35 @@ pub(super) struct InteractiveTxMsgError {
/// If a splice was in progress when processing the message, this contains the splice funding
/// information for emitting a `SpliceNegotiationFailed` event.
pub(super) splice_funding_failed: Option<SpliceFundingFailed>,
/// The event reason to use if this error causes a `SpliceNegotiationFailed` event.
pub(super) negotiation_failure_reason: Option<NegotiationFailureReason>,
}

impl InteractiveTxMsgError {
fn new(err: ChannelError, splice_funding_failed: Option<SpliceFundingFailed>) -> Self {
Self { err, splice_funding_failed, negotiation_failure_reason: None }
}

fn with_negotiation_failure_reason(mut self, reason: NegotiationFailureReason) -> Self {
self.negotiation_failure_reason = Some(reason);
self
}

pub(super) fn into_parts(
self,
) -> (ChannelError, Option<(SpliceFundingFailed, NegotiationFailureReason)>) {
let Self { err, splice_funding_failed, negotiation_failure_reason } = self;
let splice_failure = splice_funding_failed.map(|splice_funding_failed| {
let reason =
negotiation_failure_reason.unwrap_or_else(|| Self::reason_from_channel_error(&err));
(splice_funding_failed, reason)
});
(err, splice_failure)
}

fn reason_from_channel_error(err: &ChannelError) -> NegotiationFailureReason {
NegotiationFailureReason::NegotiationError { msg: format!("{:?}", err) }
}
}

/// The return value of `monitor_updating_restored`
Expand Down Expand Up @@ -1850,7 +1879,7 @@ where
},
};

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

pub fn tx_add_input<L: Logger>(
Expand All @@ -1860,12 +1889,12 @@ where
Some(interactive_tx_constructor) => interactive_tx_constructor
.handle_tx_add_input(msg)
.map_err(|reason| self.fail_interactive_tx_negotiation(reason, logger)),
None => Err(InteractiveTxMsgError {
err: ChannelError::WarnAndDisconnect(
None => Err(InteractiveTxMsgError::new(
ChannelError::WarnAndDisconnect(
"Received unexpected interactive transaction negotiation message".to_owned(),
),
splice_funding_failed: None,
}),
None,
)),
}
}

Expand All @@ -1876,12 +1905,12 @@ where
Some(interactive_tx_constructor) => interactive_tx_constructor
.handle_tx_add_output(msg)
.map_err(|reason| self.fail_interactive_tx_negotiation(reason, logger)),
None => Err(InteractiveTxMsgError {
err: ChannelError::WarnAndDisconnect(
None => Err(InteractiveTxMsgError::new(
ChannelError::WarnAndDisconnect(
"Received unexpected interactive transaction negotiation message".to_owned(),
),
splice_funding_failed: None,
}),
None,
)),
}
}

Expand All @@ -1892,12 +1921,12 @@ where
Some(interactive_tx_constructor) => interactive_tx_constructor
.handle_tx_remove_input(msg)
.map_err(|reason| self.fail_interactive_tx_negotiation(reason, logger)),
None => Err(InteractiveTxMsgError {
err: ChannelError::WarnAndDisconnect(
None => Err(InteractiveTxMsgError::new(
ChannelError::WarnAndDisconnect(
"Received unexpected interactive transaction negotiation message".to_owned(),
),
splice_funding_failed: None,
}),
None,
)),
}
}

Expand All @@ -1908,12 +1937,12 @@ where
Some(interactive_tx_constructor) => interactive_tx_constructor
.handle_tx_remove_output(msg)
.map_err(|reason| self.fail_interactive_tx_negotiation(reason, logger)),
None => Err(InteractiveTxMsgError {
err: ChannelError::WarnAndDisconnect(
None => Err(InteractiveTxMsgError::new(
ChannelError::WarnAndDisconnect(
"Received unexpected interactive transaction negotiation message".to_owned(),
),
splice_funding_failed: None,
}),
None,
)),
}
}

Expand All @@ -1926,10 +1955,10 @@ where
.map_err(|reason| self.fail_interactive_tx_negotiation(reason, logger))?,
None => {
let err = "Received unexpected interactive transaction negotiation message";
return Err(InteractiveTxMsgError {
err: ChannelError::WarnAndDisconnect(err.to_owned()),
splice_funding_failed: None,
});
return Err(InteractiveTxMsgError::new(
ChannelError::WarnAndDisconnect(err.to_owned()),
None,
));
},
};

Expand Down Expand Up @@ -12797,7 +12826,8 @@ where
// quiescent for it.
ChannelError::Ignore(str.into())
};
return Ok(InteractiveTxMsgError { err, splice_funding_failed });
return Ok(InteractiveTxMsgError::new(err, splice_funding_failed)
.with_negotiation_failure_reason(NegotiationFailureReason::LocallyCanceled));
}

let funding_negotiation = self
Expand Down Expand Up @@ -12864,10 +12894,11 @@ where
debug_assert!(self.context.channel_state.is_quiescent());
let splice_funding_failed = self.reset_pending_splice_state();
debug_assert!(splice_funding_failed.is_some());
Ok(InteractiveTxMsgError {
err: ChannelError::Abort(AbortReason::ManualIntervention),
Ok(InteractiveTxMsgError::new(
ChannelError::Abort(AbortReason::ManualIntervention),
splice_funding_failed,
})
)
.with_negotiation_failure_reason(NegotiationFailureReason::LocallyCanceled))
}

/// Checks during handling splice_init
Expand Down Expand Up @@ -14520,7 +14551,7 @@ where
debug_assert!(self.context.channel_state.is_quiescent());
self.exit_quiescence();
}
InteractiveTxMsgError { err, splice_funding_failed: None }
InteractiveTxMsgError::new(err, None)
}

pub fn remove_legacy_scids_before_block(&mut self, height: u32) -> alloc::vec::Drain<'_, u64> {
Expand Down
16 changes: 5 additions & 11 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4982,7 +4982,6 @@ impl<
*channel_id,
counterparty_node_id,
user_channel_id,
Some(events::NegotiationFailureReason::LocallyCanceled),
);
let _ = self.handle_error(Err::<(), _>(err), *counterparty_node_id);
self.event_persist_notifier.notify();
Expand Down Expand Up @@ -11956,9 +11955,10 @@ This indicates a bug inside LDK. Please report this error at https://github.com/

fn handle_interactive_tx_msg_err(
&self, err: InteractiveTxMsgError, channel_id: ChannelId, counterparty_node_id: &PublicKey,
user_channel_id: u128, reason: Option<events::NegotiationFailureReason>,
user_channel_id: u128,
) -> MsgHandleErrInternal {
if let Some(splice_funding_failed) = err.splice_funding_failed {
let (err, splice_failure) = err.into_parts();
if let Some((splice_funding_failed, reason)) = splice_failure {
let (funding_info, contribution) = splice_funding_failed.into_parts();
let pending_events = &mut self.pending_events.lock().unwrap();
if let Some(funding_info) = funding_info {
Expand All @@ -11971,14 +11971,12 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
counterparty_node_id: *counterparty_node_id,
user_channel_id,
contribution,
reason: reason.unwrap_or(events::NegotiationFailureReason::NegotiationError {
msg: format!("{:?}", err.err),
}),
reason,
},
None,
));
}
MsgHandleErrInternal::from_chan_no_close(err.err, channel_id)
MsgHandleErrInternal::from_chan_no_close(err, channel_id)
}

fn internal_tx_msg<
Expand Down Expand Up @@ -12009,7 +12007,6 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
channel_id,
counterparty_node_id,
user_channel_id,
None,
))
},
}
Expand Down Expand Up @@ -12145,7 +12142,6 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
msg.channel_id,
&counterparty_node_id,
user_channel_id,
None,
))
},
}
Expand Down Expand Up @@ -13391,7 +13387,6 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
msg.channel_id,
counterparty_node_id,
user_channel_id,
None,
))
},
}
Expand Down Expand Up @@ -13449,7 +13444,6 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
msg.channel_id,
counterparty_node_id,
user_channel_id,
None,
))
},
}
Expand Down
Loading