Skip to content

[Splicing] Tx negotiation during splicing #3736

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.

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
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

optout21
Copy link
Contributor

@optout21 optout21 commented Apr 15, 2025

Implementation of transaction negotiation during splicing.
Builds on 3407 and 3443.

  • No new phase, Funded(FundedChannel) is used throughout splicing
  • Both FundedChannel and PendingV2Channel can act as a transaction constructor
  • PendingV2Channel logic is put behind a trait -- FundingTxConstructorV2
  • A RenegotiatingScope is used to store extra state during splicing
  • FundingChannel can act as a FundingTxConstructorV2, using the state from RenegotiatingScope (if present)
  • Since both FundedChannel and FundingTxConstructor has context(), context accessors are extracted into a common base trait, ChannelContextProvider (it is also shared by InitialRemoteCommitmentReceiver).

(Also relevant: #3444)

@ldk-reviews-bot
Copy link

ldk-reviews-bot commented Apr 15, 2025

👋 Thanks for assigning @wpaulino as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

@ldk-reviews-bot
Copy link

🔔 1st Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

1 similar comment
@ldk-reviews-bot
Copy link

🔔 1st Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@ldk-reviews-bot
Copy link

🔔 2nd Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

1 similar comment
@ldk-reviews-bot
Copy link

🔔 2nd Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@ldk-reviews-bot
Copy link

🔔 3rd Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

1 similar comment
@ldk-reviews-bot
Copy link

🔔 3rd Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@ldk-reviews-bot
Copy link

🔔 4th Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

1 similar comment
@ldk-reviews-bot
Copy link

🔔 4th Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@ldk-reviews-bot
Copy link

🔔 5th Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

1 similar comment
@ldk-reviews-bot
Copy link

🔔 5th Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@ldk-reviews-bot
Copy link

🔔 6th Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

1 similar comment
@ldk-reviews-bot
Copy link

🔔 6th Reminder

Hey @jkczyz @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

@@ -2414,6 +2414,7 @@ pub(super) trait FundingTxConstructorV2<SP: Deref>: ChannelContextProvider<SP> w
fn begin_interactive_funding_tx_construction<ES: Deref>(
&mut self, signer_provider: &SP, entropy_source: &ES, holder_node_id: PublicKey,
change_destination_opt: Option<ScriptBuf>,
_is_splice: bool, prev_funding_input: Option<(TxIn, TransactionU16LenLimited)>,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need is_splice if prev_funding_input being set implies we are splicing?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the prev. funding input is set only by the initiator, and this method is used on both side (initiator and acceptor).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The funding input still needs to be passed through to the interactive constructor though so we can make sure the counterparty adds it when we're not the initiator and we can check it's the same as we expect.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is, everything will go through it after begin_interactive_funding_tx_construction

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarified: the previous funding as an input is a shared input, and the splice-acceptor side also has to be aware of it, it has to check that it is being added by the initiator. So it has to provided as a special shared input, which is added during negotiation by the initiator, and checked by the acceptor.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tried to do it, but ran into a problem with the tests. Apparently on the acceptor side (v1 channel) the field funding.funding_transaction is never set.

Copy link
Contributor

@jkczyz jkczyz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about the late review. We were traveling to an off site last week. Just a high-level pass on the first four commits. Will need to take a closer look at the last one.

Copy link

codecov bot commented Apr 30, 2025

Codecov Report

Attention: Patch coverage is 56.30252% with 52 lines in your changes missing coverage. Please review.

Project coverage is 90.28%. Comparing base (8aae34e) to head (f1c280d).
Report is 15 commits behind head on main.

Files with missing lines Patch % Lines
lightning/src/ln/channel.rs 55.23% 46 Missing and 1 partial ⚠️
lightning/src/ln/channelmanager.rs 64.28% 4 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3736      +/-   ##
==========================================
+ Coverage   89.73%   90.28%   +0.55%     
==========================================
  Files         159      160       +1     
  Lines      128910   132032    +3122     
  Branches   128910   132032    +3122     
==========================================
+ Hits       115676   119207    +3531     
+ Misses      10536    10172     -364     
+ Partials     2698     2653      -45     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@optout21 optout21 force-pushed the splice-dual-tx4 branch 3 times, most recently from 88d2e83 to 866368d Compare May 5, 2025 11:59
@optout21
Copy link
Contributor Author

optout21 commented May 6, 2025

Ready for a new round of review. I have addressed the comments, applied most of them. There is still one to-do (update channel reserve values), that I will do, but the rest is ready for review.
I did the changes in separate 'fix' commits.

@optout21
Copy link
Contributor Author

Ready for a new round of review. All pending and newly raised comments addressed.

Comment on lines 8493 to 8522
try_channel_entry!(self, peer_state, Err(ChannelError::Close((
err.into(),
ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(false) },
))), chan_entry)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is closing the channel here a spec requirement? Seems like we could just drop the message or send a warning.

@@ -8649,9 +8980,20 @@ impl<SP: Deref> FundedChannel<SP> where
"Insufficient inputs for splicing; channel ID {}, err {}",
self.context.channel_id(), err,
)})?;
// Convert inputs
let mut funding_inputs = Vec::new();
for (tx_in, tx, _w) in our_funding_inputs.into_iter() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's just make our_funding_inputs an owned value

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, though an extra clone() is added in channelmanager.rs, due to optionally_notify closure.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm... that's unfortunate. It seems to stem form the fact that PersistenceNotifierGuard has an FnMut rather than an FnOnce. Might be able to fix that but probably better to save for a separate PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened #3835 to fix the root issue.

@optout21 optout21 force-pushed the splice-dual-tx4 branch 2 times, most recently from 5a18b43 to f1c280d Compare June 3, 2025 10:43
@optout21
Copy link
Contributor Author

optout21 commented Jun 3, 2025

I have rearranged the commits in this PR (there were some reverted changes, many fixes, etc.), into these 4:

  • preparation: Rename DualFundingContext
  • partial: Extend begin_interactive_...() with splicing-specific parameters
  • partial: Introduce NegotiatingV2ChannelView to bridge Funded and PendingV2
  • main logic: Implement transaction negotiation during splicing

Otherwise, no change applied this time.
I'd appreciate a new round of review.

(Note: the old commits are available on branch splice-dual-tx4-save)

@optout21
Copy link
Contributor Author

optout21 commented Jun 3, 2025

For reference, summary of NOT-included changes:

  • Always pass previous funding TX to begin_interactive_funding_tx_construction(), not only in the splice initiator case, but in the splice acceptor case as well. The initiator should add it as an input to the interactive contructor. The acceptor should also add it as a Shared Input (this is TODO in IATX), to be able to verify, that initiator has added it.
    Reason for being deferred: on the acceptor side (v1 channel) the field funding.funding_transaction is currently never set. Set to be addressed in PR Exchange splice_locked messages #3741.
  • Method internal_splice_channel takes owned input (not a reference). The drawback is that splice_channel needs to clone, due to optionally_notify. Could be solved by changing the FnMut in optionally_notify to FnOnce.

@optout21 optout21 requested review from jkczyz and wpaulino June 3, 2025 21:00
pub our_funding_inputs: Vec<(TxIn, TransactionU16LenLimited)>,
/// Set when splice_ack has been processed (on the initiator side),
/// used to prevent processing of multiple splice_ack's.
awaiting_splice_ack: bool,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Un-resolving to see if this is a viable approach.

optout21 added 7 commits June 4, 2025 22:25
This is a simple rename, DualFundingContext to FundingNegotiationContext,
to suggest that this is use not only in dual-funded channel open.
Also rename the field dual_funding_context to funding_negotiation_context.
The begin_interactive_funding_tx_construction() method is extended with the
prev_funding_input optional parameter, containing the previous funding
transaction, which will be added to the negotiation as an input by the
initiator.
Introduce struct NegotiatingChannelView to perform transaction negotiation
logic, on top of both PendingV2Channel (dual-funded channel open) and
FundedChannel (splicing).
Fill the logic for including transaction negotiation during splicing,
implement the functions:
splice_channel, splice_init, splice_ack, funding_tx_constructed.
Also extend the test case test_v1_splice_in with the steps for
funding negotiation during splicing.
In begin_interactive_funding_tx_construction(), rename is_outbound to is_initiator,
to prevent confusion with earlier the role at channel open.
ChannelTransactionParameters: clone only unchanged members.
Optimize checking twice for pending_splice in splice_ack.
@jkczyz
Copy link
Contributor

jkczyz commented Jun 5, 2025

  • Always pass previous funding TX to begin_interactive_funding_tx_construction(), not only in the splice initiator case, but in the splice acceptor case as well. The initiator should add it as an input to the interactive contructor. The acceptor should also add it as a Shared Input (this is TODO in IATX), to be able to verify, that initiator has added it.
    Reason for being deferred: on the acceptor side (v1 channel) the field funding.funding_transaction is currently never set. Set to be addressed in PR Exchange splice_locked messages #3741.

We had some discussion on #3741 (comment) and on the spec PR (lightning/bolts#1160 (comment)) about this. Turns out we need to make TxAddInput::prevtx optional or possible an enum with TxAddInput::shared_input_txid. We'll avoid storing the funding transaction.

optout21 added 2 commits June 5, 2025 22:43
Instead, rely on the presense of the funding_scope and
interactive_tx_constructor optional fields.
@ldk-reviews-bot
Copy link

🔔 1st Reminder

Hey @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

Simplify handling of pending_splice field check, get rid of one unwrap().
@optout21
Copy link
Contributor Author

optout21 commented Jun 5, 2025

We had some discussion on #3741 (comment) and on the spec PR (lightning/bolts#1160 (comment)) about this. Turns out we need to make TxAddInput::prevtx optional or possible an enum with TxAddInput::shared_input_txid. We'll avoid storing the funding transaction.

Getting closer :) As I see the changes needed:

  • make TxAddInput::prevtx Optional
  • Enhance InteractiveConstructor to differentiate non-shared and shared inputs. For shared inputs set shared_input_txid (only the initiator). The acceptor should check if shared input was added.
  • To begin_interactive_... we should supply the prev_funding_txo, in both inititator&acceptor case. Both would add it to InteractiveConstructor as shared input.

In this PR or another one? Probably best would be to include these into this PR (causing some further processing time).

@jkczyz
Copy link
Contributor

jkczyz commented Jun 5, 2025

In this PR or another one? Probably best would be to include these into this PR (causing some further processing time).

Yeah, I think we need to do it in this PR.

Copy link
Contributor

@wpaulino wpaulino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When using fixup commits, please keep each one grouped under the relevant commit it should be applied to. You already have the context as to what commit the fix belongs to, and you won't have to reload that context when it's time to squash them (it also makes review easier).

peer_state.pending_msg_events.push(MessageSendEvent::SendSpliceAck {
node_id: *counterparty_node_id,
msg: splice_ack_msg,
});
} else {
return Err(MsgHandleErrInternal::send_err_msg_no_close("Channel is not funded, cannot be spliced".to_owned(), msg.channel_id));
return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Channel is not funded, cannot be spliced"), msg.channel_id));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to close the channel with Err(ChannelError::Close) to try_channel_entry!

} else {
return Err(MsgHandleErrInternal::send_err_msg_no_close("Channel is not funded, cannot splice".to_owned(), msg.channel_id));
return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Channel is not funded, cannot be spliced"), msg.channel_id));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

@@ -1385,7 +1387,10 @@ impl<SP: Deref> Channel<SP> where
pub fn unfunded_context_mut(&mut self) -> Option<&mut UnfundedChannelContext> {
match &mut self.phase {
ChannelPhase::Undefined => unreachable!(),
ChannelPhase::Funded(_) => { debug_assert!(false); None },
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't look like this needed to change

Ok((commitment_signed, event))
}
#[cfg(splicing)]
ChannelPhase::Funded(ref mut chan) => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like we can bypass this match by using Channel::as_negotiating_channel

holder_pubkeys,
holder_selected_contest_delay: prev_funding.channel_transaction_parameters.holder_selected_contest_delay,
// The 'outbound' attribute may change, if the the splice is being initiated by the previous acceptor
is_outbound_from_holder: is_initiator,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is now changing the meaning of is_outbound_from_holder, it should always represent the opener of the channel regardless of splicing.

#[cfg(splicing)]
pub fn splice_init(&mut self, msg: &msgs::SpliceInit) -> Result<msgs::SpliceAck, ChannelError> {
pub fn splice_init_checks(&self, msg: &msgs::SpliceInit) -> Result<(), ChannelError> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
pub fn splice_init_checks(&self, msg: &msgs::SpliceInit) -> Result<(), ChannelError> {
pub fn validate_splice_init(&self, msg: &msgs::SpliceInit) -> Result<(), ChannelError> {

is_splice: true,
};

// Start interactive funding negotiation. No extra input, as we are not the splice initiator
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to change

Comment on lines +9322 to +9323
pending_splice.interactive_tx_constructor = None;
pending_splice.interactive_tx_signing_session = None;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we doing this? Shouldn't they already be none?


let post_channel_value = PendingSplice::compute_post_value(pre_channel_value, our_funding_contribution, their_funding_contribution);

let (our_funding_satoshis, their_funding_satoshis) = calculate_funding_values(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs a better name, it's quite ambiguous and error-prone what this is and how it should be used. It seems it's already being used incorrectly in below in FundingScope::for_splice, where we add it to the post_value_to_self_msat, but that value shouldn't include the previous funding amount.


let splice_ack_msg = self.get_splice_ack(our_funding_contribution);

// Build NegotiatingChannelView lcoally, simmilar to Channel::as_renegotiating_channel()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why can't we use FundedChannel::as_renegotiating_channel?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change was a result of #3736 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants