Skip to content

Add splice-out support - #3979

Merged
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out
Aug 25, 2025
Merged

Add splice-out support#3979
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out

Conversation

@jkczyz

Copy link
Copy Markdown
Contributor

Splice-in support was added in #3736. This PR expands ChannelManager::splice_channel to support splice-out (i.e., removing funds from a channel). This is accomplished by adding a FundingTxContributions enum to cover both use cases.

Depends on #3736.

@ldk-reviews-bot

ldk-reviews-bot commented Jul 31, 2025

Copy link
Copy Markdown

👋 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.

@jkczyz
jkczyz requested a review from wpaulinoJuly 31, 2025 16:11
@jkczyz
jkczyz marked this pull request as draft July 31, 2025 16:11
@jkczyzjkczyz self-assigned this Jul 31, 2025
@codecov

codecovBot commented Jul 31, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 74.21053% with 49 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.76%. Comparing base (6d47f0a) to head (ce203f2).
⚠️ Report is 1400 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/msgs.rs29.41%15 Missing and 9 partials ⚠️
lightning/src/ln/funding.rs45.71%18 Missing and 1 partial ⚠️
lightning/src/ln/channel.rs91.93%1 Missing and 4 partials ⚠️
lightning/src/ln/interactivetxs.rs97.91%0 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3979 +/- ##
==========================================
+ Coverage 88.74% 88.76% +0.01% 
==========================================
Files 173 176 +3 Lines 124899 127944 +3045 Branches 124899 127944 +3045 ==========================================
+ Hits 110841 113564 +2723 - Misses 11631 11808 +177 - Partials 2427 2572 +145 
FlagCoverage Δ
fuzzing21.69% <2.34%> (?)
tests88.59% <73.15%> (-0.16%)⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 3 times, most recently from 2d39059 to 381fba6CompareAugust 1, 2025 00:23
@jkczyz
jkczyz marked this pull request as ready for review August 1, 2025 00:23
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
@ldk-reviews-bot

Copy link
Copy Markdown

👋 The first review has been submitted!

Do you think this PR is ready for a second reviewer? If so, click here to assign a second reviewer.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 396948e to 59fbd7eCompareAugust 7, 2025 23:38
@jkczyz
jkczyz requested a review from wpaulinoAugust 8, 2025 13:42
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from fde2f61 to f12c993CompareAugust 11, 2025 16:39
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Rebased to resolve merge conflicts.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f12c993 to 806220eCompareAugust 11, 2025 22:22
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
funding_feerate.to_sat_per_kwu() as u32,
));

if channel_balance > contribution_amount.unsigned_abs() + estimated_fee {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This isn't enough, we need to make sure the balance is still above the reserve and has enough to pay for fees on the commitment transaction if they're the channel initiator

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right, the reserve check will be at the call site as a separate check. I hadn't considered the fees for the commitment transaction. For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Most likely yeah, but it's better to be safe than sorry. We already need to always check it for the counterparty and for our splice-outs, so might as well always do it for splice-ins.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Leaving this for @tankyleo.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See other comments.

Comment threadlightning/src/ln/channel.rs
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 806220e to 9c2f266CompareAugust 13, 2025 23:58
@jkczyz
jkczyz requested a review from wpaulinoAugust 13, 2025 23:58
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 9c2f266 to ef1aee7CompareAugust 14, 2025 22:19
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should also make sure a FundingTransactionReadyForSigning event gets pushed when doing splice outs

Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
/// When funds are added to a channel.
SpliceIn {
/// The amount to contribute to the splice.
value: Amount,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Another variant could be to consume the full input set, but we can revisit that later

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I was thinking we could have a constructor that took inputs and gave back a SpliceContribution::SpliceIn with amount. However, we'd need to provide information about the balance in order to compute that. So maybe best to use a dedicated variant as you said.

@wpaulino
wpaulino requested a review from tankyleoAugust 14, 2025 23:24
TransactionU16LenLimited was used to limit Transaction serialization
size to u16::MAX. This was because messages can not be longer than
u16::MAX bytes when serialized for the transport layer. However, this
limit doesn't take into account other fields in a message containing a
Transaction, including the length of the transaction itself.
Remove TransactionU16LenLimited and instead check any user supplied
transactions in the context of the enclosing message (e.g. TxAddInput).
ChannelManager::splice_channel takes witness weights with the funding
inputs. Storing these in FundingNegotiationContext allows us to use them
when calculating the change output and include them in a common struct
used for initiating a splice-in.
In preparation for having ChannelManager::splice_channel take
FundingTxContributions, add a weight to the
FundingTxContributions::InputsOnly, which supports the splice-in use
case.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 7a38617 to 29c61bdCompareAugust 20, 2025 19:37

ghost left a comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Fixed CI and squashed commits as requested.

@jkczyz
jkczyz requested a review from tankyleoAugust 20, 2025 19:38
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 29c61bd to f2aa7feCompareAugust 20, 2025 21:57
@jkczyz

ghost commented Aug 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Pushed a fix for CI.

When splicing a channel, the previous funding output is spent and fees
for it are paid by the splice initiator. However, the witness weight was
not including EMPTY_SCRIPT_SIG_WEIGHT. Fix this and update the variable
name to make clear the weight needed is the input satisfaction.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f2aa7fe to 8a596fbCompareAugust 21, 2025 16:05
@jkczyz

ghost commented Aug 21, 2025

Copy link
Copy Markdown
ContributorAuthor

Sorry, early CI failures were masking another one. Think it should be fixed in latest push. Also, pulled out the EMPTY_SCRIPT_SIG_WEIGHT into a separate commit.

Comment threadlightning/src/ln/funding.rs Outdated

impl FundingTxInput {
fn new<F: FnOnce(&bitcoin::Script) -> bool>(
prevtx: Transaction, vout: u32, sequence: Sequence, witness_weight: Weight,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: sequence could be made optional with a default value of ENABLE_RBF_NO_LOCKTIME

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

What do you think about always setting it to ENABLE_RBF_NO_LOCKTIME and providing a mutator to override it? Would be nice to avoid passing an Option here if possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sure, let's link to it in the FundingTxInput::new docs though

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

That's private, so will need to link each of the four public functions.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channel.rs Outdated
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 567442d to ef24de4CompareAugust 22, 2025 21:06
@jkczyz
jkczyz requested a review from wpaulinoAugust 22, 2025 21:07
@ldk-reviews-bot

ghost commented Aug 23, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 2nd Reminder

Hey @wpaulino@tankyleo! 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.

@wpaulino

ghost commented Aug 25, 2025

Copy link
Copy Markdown
Contributor

Feel free to squash on your next push

Jeffrey Czyz added 4 commits August 25, 2025 12:20
The funding inputs used for splicing and v2 channel establishment are
passed as a tuple of txin, prevtx, and witness weight. Add a struct so
that the items included can be better documented.
ChannelManager::splice_channel takes individual parameters to support
splice-in. Change these to an enum such that it can be used for
splice-out as well.
Update SpliceContribution with a variant used to support splice-out
(i.e., removing funds from a channel). The TxOut values must not exceed
the users channel balance after accounting for fees and the reserve
requirement.
When a counterparty sends splice_init with a negative contribution, they
are requesting to remove funds from a channel. Remove conditions
guarding against this and check that they have enough channel balance to
cover the removed funds.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from ef24de4 to ce203f2CompareAugust 25, 2025 17:32
@jkczyz

ghost commented Aug 25, 2025

Copy link
Copy Markdown
ContributorAuthor

Feel free to squash on your next push

Done. PTAL

ghost left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Three small nits we can take care of in followups

funding_negotiation_context.our_funding_contribution_satoshis;
let their_funding_contribution_satoshis = msg.funding_contribution_satoshis;
let our_funding_contribution = funding_negotiation_context.our_funding_contribution;
debug_assert!(our_funding_contribution <= SignedAmount::MAX_MONEY);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Check that the abs is smaller than MAX_MONEY ?

Comment on lines +37 to +38
/// The outputs to include in the splice's funding transaction. The total value of all
/// outputs will be the amount that is removed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"We will remove the total value of the outputs plus the transaction fees" ?

/// The amount to contribute to the splice.
value: Amount,

/// The inputs included in the splice's funding transaction to meet the contributed amount.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"to meet the contributed amount plus the fees" ?

@wpaulino
wpaulino merged commit 5f73b70 into lightningdevkit:mainAug 25, 2025
@jkczyzjkczyz mentioned this pull request Aug 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants

@jkczyz@ldk-reviews-bot@wpaulino@tankyleo
, '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" + '
Add splice-out support by jkczyz · Pull Request #3979 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add splice-out support - #3979

Merged
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out
Aug 25, 2025
Merged

Add splice-out support#3979
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out

Conversation

@jkczyz

Copy link
Copy Markdown
Contributor

Splice-in support was added in #3736. This PR expands ChannelManager::splice_channel to support splice-out (i.e., removing funds from a channel). This is accomplished by adding a FundingTxContributions enum to cover both use cases.

Depends on #3736.

@ldk-reviews-bot

ldk-reviews-bot commented Jul 31, 2025

Copy link
Copy Markdown

👋 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.

@jkczyz
jkczyz requested a review from wpaulinoJuly 31, 2025 16:11
@jkczyz
jkczyz marked this pull request as draft July 31, 2025 16:11
@jkczyzjkczyz self-assigned this Jul 31, 2025
@codecov

codecovBot commented Jul 31, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 74.21053% with 49 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.76%. Comparing base (6d47f0a) to head (ce203f2).
⚠️ Report is 1400 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/msgs.rs29.41%15 Missing and 9 partials ⚠️
lightning/src/ln/funding.rs45.71%18 Missing and 1 partial ⚠️
lightning/src/ln/channel.rs91.93%1 Missing and 4 partials ⚠️
lightning/src/ln/interactivetxs.rs97.91%0 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3979 +/- ##
==========================================
+ Coverage 88.74% 88.76% +0.01% 
==========================================
Files 173 176 +3 Lines 124899 127944 +3045 Branches 124899 127944 +3045 ==========================================
+ Hits 110841 113564 +2723 - Misses 11631 11808 +177 - Partials 2427 2572 +145 
FlagCoverage Δ
fuzzing21.69% <2.34%> (?)
tests88.59% <73.15%> (-0.16%)⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 3 times, most recently from 2d39059 to 381fba6CompareAugust 1, 2025 00:23
@jkczyz
jkczyz marked this pull request as ready for review August 1, 2025 00:23
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
@ldk-reviews-bot

Copy link
Copy Markdown

👋 The first review has been submitted!

Do you think this PR is ready for a second reviewer? If so, click here to assign a second reviewer.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 396948e to 59fbd7eCompareAugust 7, 2025 23:38
@jkczyz
jkczyz requested a review from wpaulinoAugust 8, 2025 13:42
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from fde2f61 to f12c993CompareAugust 11, 2025 16:39
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Rebased to resolve merge conflicts.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f12c993 to 806220eCompareAugust 11, 2025 22:22
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
funding_feerate.to_sat_per_kwu() as u32,
));

if channel_balance > contribution_amount.unsigned_abs() + estimated_fee {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This isn't enough, we need to make sure the balance is still above the reserve and has enough to pay for fees on the commitment transaction if they're the channel initiator

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right, the reserve check will be at the call site as a separate check. I hadn't considered the fees for the commitment transaction. For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Most likely yeah, but it's better to be safe than sorry. We already need to always check it for the counterparty and for our splice-outs, so might as well always do it for splice-ins.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Leaving this for @tankyleo.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See other comments.

Comment threadlightning/src/ln/channel.rs
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 806220e to 9c2f266CompareAugust 13, 2025 23:58
@jkczyz
jkczyz requested a review from wpaulinoAugust 13, 2025 23:58
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 9c2f266 to ef1aee7CompareAugust 14, 2025 22:19
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should also make sure a FundingTransactionReadyForSigning event gets pushed when doing splice outs

Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
/// When funds are added to a channel.
SpliceIn {
/// The amount to contribute to the splice.
value: Amount,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Another variant could be to consume the full input set, but we can revisit that later

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I was thinking we could have a constructor that took inputs and gave back a SpliceContribution::SpliceIn with amount. However, we'd need to provide information about the balance in order to compute that. So maybe best to use a dedicated variant as you said.

@wpaulino
wpaulino requested a review from tankyleoAugust 14, 2025 23:24
TransactionU16LenLimited was used to limit Transaction serialization
size to u16::MAX. This was because messages can not be longer than
u16::MAX bytes when serialized for the transport layer. However, this
limit doesn't take into account other fields in a message containing a
Transaction, including the length of the transaction itself.
Remove TransactionU16LenLimited and instead check any user supplied
transactions in the context of the enclosing message (e.g. TxAddInput).
ChannelManager::splice_channel takes witness weights with the funding
inputs. Storing these in FundingNegotiationContext allows us to use them
when calculating the change output and include them in a common struct
used for initiating a splice-in.
In preparation for having ChannelManager::splice_channel take
FundingTxContributions, add a weight to the
FundingTxContributions::InputsOnly, which supports the splice-in use
case.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 7a38617 to 29c61bdCompareAugust 20, 2025 19:37

ghost left a comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Fixed CI and squashed commits as requested.

@jkczyz
jkczyz requested a review from tankyleoAugust 20, 2025 19:38
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 29c61bd to f2aa7feCompareAugust 20, 2025 21:57
@jkczyz

ghost commented Aug 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Pushed a fix for CI.

When splicing a channel, the previous funding output is spent and fees
for it are paid by the splice initiator. However, the witness weight was
not including EMPTY_SCRIPT_SIG_WEIGHT. Fix this and update the variable
name to make clear the weight needed is the input satisfaction.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f2aa7fe to 8a596fbCompareAugust 21, 2025 16:05
@jkczyz

ghost commented Aug 21, 2025

Copy link
Copy Markdown
ContributorAuthor

Sorry, early CI failures were masking another one. Think it should be fixed in latest push. Also, pulled out the EMPTY_SCRIPT_SIG_WEIGHT into a separate commit.

Comment threadlightning/src/ln/funding.rs Outdated

impl FundingTxInput {
fn new<F: FnOnce(&bitcoin::Script) -> bool>(
prevtx: Transaction, vout: u32, sequence: Sequence, witness_weight: Weight,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: sequence could be made optional with a default value of ENABLE_RBF_NO_LOCKTIME

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

What do you think about always setting it to ENABLE_RBF_NO_LOCKTIME and providing a mutator to override it? Would be nice to avoid passing an Option here if possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sure, let's link to it in the FundingTxInput::new docs though

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

That's private, so will need to link each of the four public functions.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channel.rs Outdated
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 567442d to ef24de4CompareAugust 22, 2025 21:06
@jkczyz
jkczyz requested a review from wpaulinoAugust 22, 2025 21:07
@ldk-reviews-bot

ghost commented Aug 23, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 2nd Reminder

Hey @wpaulino@tankyleo! 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.

@wpaulino

ghost commented Aug 25, 2025

Copy link
Copy Markdown
Contributor

Feel free to squash on your next push

Jeffrey Czyz added 4 commits August 25, 2025 12:20
The funding inputs used for splicing and v2 channel establishment are
passed as a tuple of txin, prevtx, and witness weight. Add a struct so
that the items included can be better documented.
ChannelManager::splice_channel takes individual parameters to support
splice-in. Change these to an enum such that it can be used for
splice-out as well.
Update SpliceContribution with a variant used to support splice-out
(i.e., removing funds from a channel). The TxOut values must not exceed
the users channel balance after accounting for fees and the reserve
requirement.
When a counterparty sends splice_init with a negative contribution, they
are requesting to remove funds from a channel. Remove conditions
guarding against this and check that they have enough channel balance to
cover the removed funds.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from ef24de4 to ce203f2CompareAugust 25, 2025 17:32
@jkczyz

ghost commented Aug 25, 2025

Copy link
Copy Markdown
ContributorAuthor

Feel free to squash on your next push

Done. PTAL

ghost left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Three small nits we can take care of in followups

funding_negotiation_context.our_funding_contribution_satoshis;
let their_funding_contribution_satoshis = msg.funding_contribution_satoshis;
let our_funding_contribution = funding_negotiation_context.our_funding_contribution;
debug_assert!(our_funding_contribution <= SignedAmount::MAX_MONEY);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Check that the abs is smaller than MAX_MONEY ?

Comment on lines +37 to +38
/// The outputs to include in the splice's funding transaction. The total value of all
/// outputs will be the amount that is removed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"We will remove the total value of the outputs plus the transaction fees" ?

/// The amount to contribute to the splice.
value: Amount,

/// The inputs included in the splice's funding transaction to meet the contributed amount.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"to meet the contributed amount plus the fees" ?

@wpaulino
wpaulino merged commit 5f73b70 into lightningdevkit:mainAug 25, 2025
@jkczyzjkczyz mentioned this pull request Aug 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants

@jkczyz@ldk-reviews-bot@wpaulino@tankyleo
, '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('^' + ".*" + ' Add splice-out support by jkczyz · Pull Request #3979 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add splice-out support - #3979

Merged
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out
Aug 25, 2025
Merged

Add splice-out support#3979
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out

Conversation

@jkczyz

Copy link
Copy Markdown
Contributor

Splice-in support was added in #3736. This PR expands ChannelManager::splice_channel to support splice-out (i.e., removing funds from a channel). This is accomplished by adding a FundingTxContributions enum to cover both use cases.

Depends on #3736.

@ldk-reviews-bot

ldk-reviews-bot commented Jul 31, 2025

Copy link
Copy Markdown

👋 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.

@jkczyz
jkczyz requested a review from wpaulinoJuly 31, 2025 16:11
@jkczyz
jkczyz marked this pull request as draft July 31, 2025 16:11
@jkczyzjkczyz self-assigned this Jul 31, 2025
@codecov

codecovBot commented Jul 31, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 74.21053% with 49 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.76%. Comparing base (6d47f0a) to head (ce203f2).
⚠️ Report is 1400 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/msgs.rs29.41%15 Missing and 9 partials ⚠️
lightning/src/ln/funding.rs45.71%18 Missing and 1 partial ⚠️
lightning/src/ln/channel.rs91.93%1 Missing and 4 partials ⚠️
lightning/src/ln/interactivetxs.rs97.91%0 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3979 +/- ##
==========================================
+ Coverage 88.74% 88.76% +0.01% 
==========================================
Files 173 176 +3 Lines 124899 127944 +3045 Branches 124899 127944 +3045 ==========================================
+ Hits 110841 113564 +2723 - Misses 11631 11808 +177 - Partials 2427 2572 +145 
FlagCoverage Δ
fuzzing21.69% <2.34%> (?)
tests88.59% <73.15%> (-0.16%)⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 3 times, most recently from 2d39059 to 381fba6CompareAugust 1, 2025 00:23
@jkczyz
jkczyz marked this pull request as ready for review August 1, 2025 00:23
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
@ldk-reviews-bot

Copy link
Copy Markdown

👋 The first review has been submitted!

Do you think this PR is ready for a second reviewer? If so, click here to assign a second reviewer.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 396948e to 59fbd7eCompareAugust 7, 2025 23:38
@jkczyz
jkczyz requested a review from wpaulinoAugust 8, 2025 13:42
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from fde2f61 to f12c993CompareAugust 11, 2025 16:39
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Rebased to resolve merge conflicts.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f12c993 to 806220eCompareAugust 11, 2025 22:22
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
funding_feerate.to_sat_per_kwu() as u32,
));

if channel_balance > contribution_amount.unsigned_abs() + estimated_fee {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This isn't enough, we need to make sure the balance is still above the reserve and has enough to pay for fees on the commitment transaction if they're the channel initiator

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right, the reserve check will be at the call site as a separate check. I hadn't considered the fees for the commitment transaction. For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Most likely yeah, but it's better to be safe than sorry. We already need to always check it for the counterparty and for our splice-outs, so might as well always do it for splice-ins.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Leaving this for @tankyleo.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See other comments.

Comment threadlightning/src/ln/channel.rs
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 806220e to 9c2f266CompareAugust 13, 2025 23:58
@jkczyz
jkczyz requested a review from wpaulinoAugust 13, 2025 23:58
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 9c2f266 to ef1aee7CompareAugust 14, 2025 22:19
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should also make sure a FundingTransactionReadyForSigning event gets pushed when doing splice outs

Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
/// When funds are added to a channel.
SpliceIn {
/// The amount to contribute to the splice.
value: Amount,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Another variant could be to consume the full input set, but we can revisit that later

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I was thinking we could have a constructor that took inputs and gave back a SpliceContribution::SpliceIn with amount. However, we'd need to provide information about the balance in order to compute that. So maybe best to use a dedicated variant as you said.

@wpaulino
wpaulino requested a review from tankyleoAugust 14, 2025 23:24
TransactionU16LenLimited was used to limit Transaction serialization
size to u16::MAX. This was because messages can not be longer than
u16::MAX bytes when serialized for the transport layer. However, this
limit doesn't take into account other fields in a message containing a
Transaction, including the length of the transaction itself.
Remove TransactionU16LenLimited and instead check any user supplied
transactions in the context of the enclosing message (e.g. TxAddInput).
ChannelManager::splice_channel takes witness weights with the funding
inputs. Storing these in FundingNegotiationContext allows us to use them
when calculating the change output and include them in a common struct
used for initiating a splice-in.
In preparation for having ChannelManager::splice_channel take
FundingTxContributions, add a weight to the
FundingTxContributions::InputsOnly, which supports the splice-in use
case.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 7a38617 to 29c61bdCompareAugust 20, 2025 19:37

ghost left a comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Fixed CI and squashed commits as requested.

@jkczyz
jkczyz requested a review from tankyleoAugust 20, 2025 19:38
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 29c61bd to f2aa7feCompareAugust 20, 2025 21:57
@jkczyz

ghost commented Aug 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Pushed a fix for CI.

When splicing a channel, the previous funding output is spent and fees
for it are paid by the splice initiator. However, the witness weight was
not including EMPTY_SCRIPT_SIG_WEIGHT. Fix this and update the variable
name to make clear the weight needed is the input satisfaction.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f2aa7fe to 8a596fbCompareAugust 21, 2025 16:05
@jkczyz

ghost commented Aug 21, 2025

Copy link
Copy Markdown
ContributorAuthor

Sorry, early CI failures were masking another one. Think it should be fixed in latest push. Also, pulled out the EMPTY_SCRIPT_SIG_WEIGHT into a separate commit.

Comment threadlightning/src/ln/funding.rs Outdated

impl FundingTxInput {
fn new<F: FnOnce(&bitcoin::Script) -> bool>(
prevtx: Transaction, vout: u32, sequence: Sequence, witness_weight: Weight,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: sequence could be made optional with a default value of ENABLE_RBF_NO_LOCKTIME

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

What do you think about always setting it to ENABLE_RBF_NO_LOCKTIME and providing a mutator to override it? Would be nice to avoid passing an Option here if possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sure, let's link to it in the FundingTxInput::new docs though

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

That's private, so will need to link each of the four public functions.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channel.rs Outdated
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 567442d to ef24de4CompareAugust 22, 2025 21:06
@jkczyz
jkczyz requested a review from wpaulinoAugust 22, 2025 21:07
@ldk-reviews-bot

ghost commented Aug 23, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 2nd Reminder

Hey @wpaulino@tankyleo! 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.

@wpaulino

ghost commented Aug 25, 2025

Copy link
Copy Markdown
Contributor

Feel free to squash on your next push

Jeffrey Czyz added 4 commits August 25, 2025 12:20
The funding inputs used for splicing and v2 channel establishment are
passed as a tuple of txin, prevtx, and witness weight. Add a struct so
that the items included can be better documented.
ChannelManager::splice_channel takes individual parameters to support
splice-in. Change these to an enum such that it can be used for
splice-out as well.
Update SpliceContribution with a variant used to support splice-out
(i.e., removing funds from a channel). The TxOut values must not exceed
the users channel balance after accounting for fees and the reserve
requirement.
When a counterparty sends splice_init with a negative contribution, they
are requesting to remove funds from a channel. Remove conditions
guarding against this and check that they have enough channel balance to
cover the removed funds.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from ef24de4 to ce203f2CompareAugust 25, 2025 17:32
@jkczyz

ghost commented Aug 25, 2025

Copy link
Copy Markdown
ContributorAuthor

Feel free to squash on your next push

Done. PTAL

ghost left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Three small nits we can take care of in followups

funding_negotiation_context.our_funding_contribution_satoshis;
let their_funding_contribution_satoshis = msg.funding_contribution_satoshis;
let our_funding_contribution = funding_negotiation_context.our_funding_contribution;
debug_assert!(our_funding_contribution <= SignedAmount::MAX_MONEY);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Check that the abs is smaller than MAX_MONEY ?

Comment on lines +37 to +38
/// The outputs to include in the splice's funding transaction. The total value of all
/// outputs will be the amount that is removed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"We will remove the total value of the outputs plus the transaction fees" ?

/// The amount to contribute to the splice.
value: Amount,

/// The inputs included in the splice's funding transaction to meet the contributed amount.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"to meet the contributed amount plus the fees" ?

@wpaulino
wpaulino merged commit 5f73b70 into lightningdevkit:mainAug 25, 2025
@jkczyzjkczyz mentioned this pull request Aug 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants

@jkczyz@ldk-reviews-bot@wpaulino@tankyleo
, '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('^' + ".*" + ' Add splice-out support by jkczyz · Pull Request #3979 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add splice-out support - #3979

Merged
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out
Aug 25, 2025
Merged

Add splice-out support#3979
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out

Conversation

@jkczyz

Copy link
Copy Markdown
Contributor

Splice-in support was added in #3736. This PR expands ChannelManager::splice_channel to support splice-out (i.e., removing funds from a channel). This is accomplished by adding a FundingTxContributions enum to cover both use cases.

Depends on #3736.

@ldk-reviews-bot

ldk-reviews-bot commented Jul 31, 2025

Copy link
Copy Markdown

👋 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.

@jkczyz
jkczyz requested a review from wpaulinoJuly 31, 2025 16:11
@jkczyz
jkczyz marked this pull request as draft July 31, 2025 16:11
@jkczyzjkczyz self-assigned this Jul 31, 2025
@codecov

codecovBot commented Jul 31, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 74.21053% with 49 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.76%. Comparing base (6d47f0a) to head (ce203f2).
⚠️ Report is 1400 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/msgs.rs29.41%15 Missing and 9 partials ⚠️
lightning/src/ln/funding.rs45.71%18 Missing and 1 partial ⚠️
lightning/src/ln/channel.rs91.93%1 Missing and 4 partials ⚠️
lightning/src/ln/interactivetxs.rs97.91%0 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3979 +/- ##
==========================================
+ Coverage 88.74% 88.76% +0.01% 
==========================================
Files 173 176 +3 Lines 124899 127944 +3045 Branches 124899 127944 +3045 ==========================================
+ Hits 110841 113564 +2723 - Misses 11631 11808 +177 - Partials 2427 2572 +145 
FlagCoverage Δ
fuzzing21.69% <2.34%> (?)
tests88.59% <73.15%> (-0.16%)⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 3 times, most recently from 2d39059 to 381fba6CompareAugust 1, 2025 00:23
@jkczyz
jkczyz marked this pull request as ready for review August 1, 2025 00:23
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
@ldk-reviews-bot

Copy link
Copy Markdown

👋 The first review has been submitted!

Do you think this PR is ready for a second reviewer? If so, click here to assign a second reviewer.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 396948e to 59fbd7eCompareAugust 7, 2025 23:38
@jkczyz
jkczyz requested a review from wpaulinoAugust 8, 2025 13:42
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from fde2f61 to f12c993CompareAugust 11, 2025 16:39
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Rebased to resolve merge conflicts.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f12c993 to 806220eCompareAugust 11, 2025 22:22
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
funding_feerate.to_sat_per_kwu() as u32,
));

if channel_balance > contribution_amount.unsigned_abs() + estimated_fee {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This isn't enough, we need to make sure the balance is still above the reserve and has enough to pay for fees on the commitment transaction if they're the channel initiator

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right, the reserve check will be at the call site as a separate check. I hadn't considered the fees for the commitment transaction. For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Most likely yeah, but it's better to be safe than sorry. We already need to always check it for the counterparty and for our splice-outs, so might as well always do it for splice-ins.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Leaving this for @tankyleo.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See other comments.

Comment threadlightning/src/ln/channel.rs
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 806220e to 9c2f266CompareAugust 13, 2025 23:58
@jkczyz
jkczyz requested a review from wpaulinoAugust 13, 2025 23:58
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 9c2f266 to ef1aee7CompareAugust 14, 2025 22:19
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should also make sure a FundingTransactionReadyForSigning event gets pushed when doing splice outs

Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
/// When funds are added to a channel.
SpliceIn {
/// The amount to contribute to the splice.
value: Amount,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Another variant could be to consume the full input set, but we can revisit that later

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I was thinking we could have a constructor that took inputs and gave back a SpliceContribution::SpliceIn with amount. However, we'd need to provide information about the balance in order to compute that. So maybe best to use a dedicated variant as you said.

@wpaulino
wpaulino requested a review from tankyleoAugust 14, 2025 23:24
TransactionU16LenLimited was used to limit Transaction serialization
size to u16::MAX. This was because messages can not be longer than
u16::MAX bytes when serialized for the transport layer. However, this
limit doesn't take into account other fields in a message containing a
Transaction, including the length of the transaction itself.
Remove TransactionU16LenLimited and instead check any user supplied
transactions in the context of the enclosing message (e.g. TxAddInput).
ChannelManager::splice_channel takes witness weights with the funding
inputs. Storing these in FundingNegotiationContext allows us to use them
when calculating the change output and include them in a common struct
used for initiating a splice-in.
In preparation for having ChannelManager::splice_channel take
FundingTxContributions, add a weight to the
FundingTxContributions::InputsOnly, which supports the splice-in use
case.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 7a38617 to 29c61bdCompareAugust 20, 2025 19:37

ghost left a comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Fixed CI and squashed commits as requested.

@jkczyz
jkczyz requested a review from tankyleoAugust 20, 2025 19:38
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 29c61bd to f2aa7feCompareAugust 20, 2025 21:57
@jkczyz

ghost commented Aug 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Pushed a fix for CI.

When splicing a channel, the previous funding output is spent and fees
for it are paid by the splice initiator. However, the witness weight was
not including EMPTY_SCRIPT_SIG_WEIGHT. Fix this and update the variable
name to make clear the weight needed is the input satisfaction.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f2aa7fe to 8a596fbCompareAugust 21, 2025 16:05
@jkczyz

ghost commented Aug 21, 2025

Copy link
Copy Markdown
ContributorAuthor

Sorry, early CI failures were masking another one. Think it should be fixed in latest push. Also, pulled out the EMPTY_SCRIPT_SIG_WEIGHT into a separate commit.

Comment threadlightning/src/ln/funding.rs Outdated

impl FundingTxInput {
fn new<F: FnOnce(&bitcoin::Script) -> bool>(
prevtx: Transaction, vout: u32, sequence: Sequence, witness_weight: Weight,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: sequence could be made optional with a default value of ENABLE_RBF_NO_LOCKTIME

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

What do you think about always setting it to ENABLE_RBF_NO_LOCKTIME and providing a mutator to override it? Would be nice to avoid passing an Option here if possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sure, let's link to it in the FundingTxInput::new docs though

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

That's private, so will need to link each of the four public functions.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channel.rs Outdated
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 567442d to ef24de4CompareAugust 22, 2025 21:06
@jkczyz
jkczyz requested a review from wpaulinoAugust 22, 2025 21:07
@ldk-reviews-bot

ghost commented Aug 23, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 2nd Reminder

Hey @wpaulino@tankyleo! 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.

@wpaulino

ghost commented Aug 25, 2025

Copy link
Copy Markdown
Contributor

Feel free to squash on your next push

Jeffrey Czyz added 4 commits August 25, 2025 12:20
The funding inputs used for splicing and v2 channel establishment are
passed as a tuple of txin, prevtx, and witness weight. Add a struct so
that the items included can be better documented.
ChannelManager::splice_channel takes individual parameters to support
splice-in. Change these to an enum such that it can be used for
splice-out as well.
Update SpliceContribution with a variant used to support splice-out
(i.e., removing funds from a channel). The TxOut values must not exceed
the users channel balance after accounting for fees and the reserve
requirement.
When a counterparty sends splice_init with a negative contribution, they
are requesting to remove funds from a channel. Remove conditions
guarding against this and check that they have enough channel balance to
cover the removed funds.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from ef24de4 to ce203f2CompareAugust 25, 2025 17:32
@jkczyz

ghost commented Aug 25, 2025

Copy link
Copy Markdown
ContributorAuthor

Feel free to squash on your next push

Done. PTAL

ghost left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Three small nits we can take care of in followups

funding_negotiation_context.our_funding_contribution_satoshis;
let their_funding_contribution_satoshis = msg.funding_contribution_satoshis;
let our_funding_contribution = funding_negotiation_context.our_funding_contribution;
debug_assert!(our_funding_contribution <= SignedAmount::MAX_MONEY);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Check that the abs is smaller than MAX_MONEY ?

Comment on lines +37 to +38
/// The outputs to include in the splice's funding transaction. The total value of all
/// outputs will be the amount that is removed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"We will remove the total value of the outputs plus the transaction fees" ?

/// The amount to contribute to the splice.
value: Amount,

/// The inputs included in the splice's funding transaction to meet the contributed amount.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"to meet the contributed amount plus the fees" ?

@wpaulino
wpaulino merged commit 5f73b70 into lightningdevkit:mainAug 25, 2025
@jkczyzjkczyz mentioned this pull request Aug 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants

@jkczyz@ldk-reviews-bot@wpaulino@tankyleo
, '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" + ' Add splice-out support by jkczyz · Pull Request #3979 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add splice-out support - #3979

Merged
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out
Aug 25, 2025
Merged

Add splice-out support#3979
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out

Conversation

@jkczyz

Copy link
Copy Markdown
Contributor

Splice-in support was added in #3736. This PR expands ChannelManager::splice_channel to support splice-out (i.e., removing funds from a channel). This is accomplished by adding a FundingTxContributions enum to cover both use cases.

Depends on #3736.

@ldk-reviews-bot

ldk-reviews-bot commented Jul 31, 2025

Copy link
Copy Markdown

👋 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.

@jkczyz
jkczyz requested a review from wpaulinoJuly 31, 2025 16:11
@jkczyz
jkczyz marked this pull request as draft July 31, 2025 16:11
@jkczyzjkczyz self-assigned this Jul 31, 2025
@codecov

codecovBot commented Jul 31, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 74.21053% with 49 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.76%. Comparing base (6d47f0a) to head (ce203f2).
⚠️ Report is 1400 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/msgs.rs29.41%15 Missing and 9 partials ⚠️
lightning/src/ln/funding.rs45.71%18 Missing and 1 partial ⚠️
lightning/src/ln/channel.rs91.93%1 Missing and 4 partials ⚠️
lightning/src/ln/interactivetxs.rs97.91%0 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3979 +/- ##
==========================================
+ Coverage 88.74% 88.76% +0.01% 
==========================================
Files 173 176 +3 Lines 124899 127944 +3045 Branches 124899 127944 +3045 ==========================================
+ Hits 110841 113564 +2723 - Misses 11631 11808 +177 - Partials 2427 2572 +145 
FlagCoverage Δ
fuzzing21.69% <2.34%> (?)
tests88.59% <73.15%> (-0.16%)⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 3 times, most recently from 2d39059 to 381fba6CompareAugust 1, 2025 00:23
@jkczyz
jkczyz marked this pull request as ready for review August 1, 2025 00:23
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
@ldk-reviews-bot

Copy link
Copy Markdown

👋 The first review has been submitted!

Do you think this PR is ready for a second reviewer? If so, click here to assign a second reviewer.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 396948e to 59fbd7eCompareAugust 7, 2025 23:38
@jkczyz
jkczyz requested a review from wpaulinoAugust 8, 2025 13:42
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from fde2f61 to f12c993CompareAugust 11, 2025 16:39
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Rebased to resolve merge conflicts.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f12c993 to 806220eCompareAugust 11, 2025 22:22
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
funding_feerate.to_sat_per_kwu() as u32,
));

if channel_balance > contribution_amount.unsigned_abs() + estimated_fee {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This isn't enough, we need to make sure the balance is still above the reserve and has enough to pay for fees on the commitment transaction if they're the channel initiator

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right, the reserve check will be at the call site as a separate check. I hadn't considered the fees for the commitment transaction. For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Most likely yeah, but it's better to be safe than sorry. We already need to always check it for the counterparty and for our splice-outs, so might as well always do it for splice-ins.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Leaving this for @tankyleo.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See other comments.

Comment threadlightning/src/ln/channel.rs
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 806220e to 9c2f266CompareAugust 13, 2025 23:58
@jkczyz
jkczyz requested a review from wpaulinoAugust 13, 2025 23:58
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 9c2f266 to ef1aee7CompareAugust 14, 2025 22:19
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should also make sure a FundingTransactionReadyForSigning event gets pushed when doing splice outs

Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
/// When funds are added to a channel.
SpliceIn {
/// The amount to contribute to the splice.
value: Amount,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Another variant could be to consume the full input set, but we can revisit that later

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I was thinking we could have a constructor that took inputs and gave back a SpliceContribution::SpliceIn with amount. However, we'd need to provide information about the balance in order to compute that. So maybe best to use a dedicated variant as you said.

@wpaulino
wpaulino requested a review from tankyleoAugust 14, 2025 23:24
TransactionU16LenLimited was used to limit Transaction serialization
size to u16::MAX. This was because messages can not be longer than
u16::MAX bytes when serialized for the transport layer. However, this
limit doesn't take into account other fields in a message containing a
Transaction, including the length of the transaction itself.
Remove TransactionU16LenLimited and instead check any user supplied
transactions in the context of the enclosing message (e.g. TxAddInput).
ChannelManager::splice_channel takes witness weights with the funding
inputs. Storing these in FundingNegotiationContext allows us to use them
when calculating the change output and include them in a common struct
used for initiating a splice-in.
In preparation for having ChannelManager::splice_channel take
FundingTxContributions, add a weight to the
FundingTxContributions::InputsOnly, which supports the splice-in use
case.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 7a38617 to 29c61bdCompareAugust 20, 2025 19:37

ghost left a comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Fixed CI and squashed commits as requested.

@jkczyz
jkczyz requested a review from tankyleoAugust 20, 2025 19:38
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 29c61bd to f2aa7feCompareAugust 20, 2025 21:57
@jkczyz

ghost commented Aug 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Pushed a fix for CI.

When splicing a channel, the previous funding output is spent and fees
for it are paid by the splice initiator. However, the witness weight was
not including EMPTY_SCRIPT_SIG_WEIGHT. Fix this and update the variable
name to make clear the weight needed is the input satisfaction.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f2aa7fe to 8a596fbCompareAugust 21, 2025 16:05
@jkczyz

ghost commented Aug 21, 2025

Copy link
Copy Markdown
ContributorAuthor

Sorry, early CI failures were masking another one. Think it should be fixed in latest push. Also, pulled out the EMPTY_SCRIPT_SIG_WEIGHT into a separate commit.

Comment threadlightning/src/ln/funding.rs Outdated

impl FundingTxInput {
fn new<F: FnOnce(&bitcoin::Script) -> bool>(
prevtx: Transaction, vout: u32, sequence: Sequence, witness_weight: Weight,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: sequence could be made optional with a default value of ENABLE_RBF_NO_LOCKTIME

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

What do you think about always setting it to ENABLE_RBF_NO_LOCKTIME and providing a mutator to override it? Would be nice to avoid passing an Option here if possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sure, let's link to it in the FundingTxInput::new docs though

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

That's private, so will need to link each of the four public functions.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channel.rs Outdated
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 567442d to ef24de4CompareAugust 22, 2025 21:06
@jkczyz
jkczyz requested a review from wpaulinoAugust 22, 2025 21:07
@ldk-reviews-bot

ghost commented Aug 23, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 2nd Reminder

Hey @wpaulino@tankyleo! 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.

@wpaulino

ghost commented Aug 25, 2025

Copy link
Copy Markdown
Contributor

Feel free to squash on your next push

Jeffrey Czyz added 4 commits August 25, 2025 12:20
The funding inputs used for splicing and v2 channel establishment are
passed as a tuple of txin, prevtx, and witness weight. Add a struct so
that the items included can be better documented.
ChannelManager::splice_channel takes individual parameters to support
splice-in. Change these to an enum such that it can be used for
splice-out as well.
Update SpliceContribution with a variant used to support splice-out
(i.e., removing funds from a channel). The TxOut values must not exceed
the users channel balance after accounting for fees and the reserve
requirement.
When a counterparty sends splice_init with a negative contribution, they
are requesting to remove funds from a channel. Remove conditions
guarding against this and check that they have enough channel balance to
cover the removed funds.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from ef24de4 to ce203f2CompareAugust 25, 2025 17:32
@jkczyz

ghost commented Aug 25, 2025

Copy link
Copy Markdown
ContributorAuthor

Feel free to squash on your next push

Done. PTAL

ghost left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Three small nits we can take care of in followups

funding_negotiation_context.our_funding_contribution_satoshis;
let their_funding_contribution_satoshis = msg.funding_contribution_satoshis;
let our_funding_contribution = funding_negotiation_context.our_funding_contribution;
debug_assert!(our_funding_contribution <= SignedAmount::MAX_MONEY);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Check that the abs is smaller than MAX_MONEY ?

Comment on lines +37 to +38
/// The outputs to include in the splice's funding transaction. The total value of all
/// outputs will be the amount that is removed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"We will remove the total value of the outputs plus the transaction fees" ?

/// The amount to contribute to the splice.
value: Amount,

/// The inputs included in the splice's funding transaction to meet the contributed amount.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"to meet the contributed amount plus the fees" ?

@wpaulino
wpaulino merged commit 5f73b70 into lightningdevkit:mainAug 25, 2025
@jkczyzjkczyz mentioned this pull request Aug 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants

@jkczyz@ldk-reviews-bot@wpaulino@tankyleo
, '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('^' + ".*" + ' Add splice-out support by jkczyz · Pull Request #3979 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add splice-out support - #3979

Merged
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out
Aug 25, 2025
Merged

Add splice-out support#3979
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out

Conversation

@jkczyz

Copy link
Copy Markdown
Contributor

Splice-in support was added in #3736. This PR expands ChannelManager::splice_channel to support splice-out (i.e., removing funds from a channel). This is accomplished by adding a FundingTxContributions enum to cover both use cases.

Depends on #3736.

@ldk-reviews-bot

ldk-reviews-bot commented Jul 31, 2025

Copy link
Copy Markdown

👋 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.

@jkczyz
jkczyz requested a review from wpaulinoJuly 31, 2025 16:11
@jkczyz
jkczyz marked this pull request as draft July 31, 2025 16:11
@jkczyzjkczyz self-assigned this Jul 31, 2025
@codecov

codecovBot commented Jul 31, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 74.21053% with 49 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.76%. Comparing base (6d47f0a) to head (ce203f2).
⚠️ Report is 1400 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/msgs.rs29.41%15 Missing and 9 partials ⚠️
lightning/src/ln/funding.rs45.71%18 Missing and 1 partial ⚠️
lightning/src/ln/channel.rs91.93%1 Missing and 4 partials ⚠️
lightning/src/ln/interactivetxs.rs97.91%0 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3979 +/- ##
==========================================
+ Coverage 88.74% 88.76% +0.01% 
==========================================
Files 173 176 +3 Lines 124899 127944 +3045 Branches 124899 127944 +3045 ==========================================
+ Hits 110841 113564 +2723 - Misses 11631 11808 +177 - Partials 2427 2572 +145 
FlagCoverage Δ
fuzzing21.69% <2.34%> (?)
tests88.59% <73.15%> (-0.16%)⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 3 times, most recently from 2d39059 to 381fba6CompareAugust 1, 2025 00:23
@jkczyz
jkczyz marked this pull request as ready for review August 1, 2025 00:23
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
@ldk-reviews-bot

Copy link
Copy Markdown

👋 The first review has been submitted!

Do you think this PR is ready for a second reviewer? If so, click here to assign a second reviewer.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 396948e to 59fbd7eCompareAugust 7, 2025 23:38
@jkczyz
jkczyz requested a review from wpaulinoAugust 8, 2025 13:42
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from fde2f61 to f12c993CompareAugust 11, 2025 16:39
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Rebased to resolve merge conflicts.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f12c993 to 806220eCompareAugust 11, 2025 22:22
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
funding_feerate.to_sat_per_kwu() as u32,
));

if channel_balance > contribution_amount.unsigned_abs() + estimated_fee {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This isn't enough, we need to make sure the balance is still above the reserve and has enough to pay for fees on the commitment transaction if they're the channel initiator

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right, the reserve check will be at the call site as a separate check. I hadn't considered the fees for the commitment transaction. For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Most likely yeah, but it's better to be safe than sorry. We already need to always check it for the counterparty and for our splice-outs, so might as well always do it for splice-ins.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Leaving this for @tankyleo.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See other comments.

Comment threadlightning/src/ln/channel.rs
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 806220e to 9c2f266CompareAugust 13, 2025 23:58
@jkczyz
jkczyz requested a review from wpaulinoAugust 13, 2025 23:58
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 9c2f266 to ef1aee7CompareAugust 14, 2025 22:19
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should also make sure a FundingTransactionReadyForSigning event gets pushed when doing splice outs

Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
/// When funds are added to a channel.
SpliceIn {
/// The amount to contribute to the splice.
value: Amount,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Another variant could be to consume the full input set, but we can revisit that later

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I was thinking we could have a constructor that took inputs and gave back a SpliceContribution::SpliceIn with amount. However, we'd need to provide information about the balance in order to compute that. So maybe best to use a dedicated variant as you said.

@wpaulino
wpaulino requested a review from tankyleoAugust 14, 2025 23:24
TransactionU16LenLimited was used to limit Transaction serialization
size to u16::MAX. This was because messages can not be longer than
u16::MAX bytes when serialized for the transport layer. However, this
limit doesn't take into account other fields in a message containing a
Transaction, including the length of the transaction itself.
Remove TransactionU16LenLimited and instead check any user supplied
transactions in the context of the enclosing message (e.g. TxAddInput).
ChannelManager::splice_channel takes witness weights with the funding
inputs. Storing these in FundingNegotiationContext allows us to use them
when calculating the change output and include them in a common struct
used for initiating a splice-in.
In preparation for having ChannelManager::splice_channel take
FundingTxContributions, add a weight to the
FundingTxContributions::InputsOnly, which supports the splice-in use
case.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 7a38617 to 29c61bdCompareAugust 20, 2025 19:37

ghost left a comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Fixed CI and squashed commits as requested.

@jkczyz
jkczyz requested a review from tankyleoAugust 20, 2025 19:38
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 29c61bd to f2aa7feCompareAugust 20, 2025 21:57
@jkczyz

ghost commented Aug 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Pushed a fix for CI.

When splicing a channel, the previous funding output is spent and fees
for it are paid by the splice initiator. However, the witness weight was
not including EMPTY_SCRIPT_SIG_WEIGHT. Fix this and update the variable
name to make clear the weight needed is the input satisfaction.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f2aa7fe to 8a596fbCompareAugust 21, 2025 16:05
@jkczyz

ghost commented Aug 21, 2025

Copy link
Copy Markdown
ContributorAuthor

Sorry, early CI failures were masking another one. Think it should be fixed in latest push. Also, pulled out the EMPTY_SCRIPT_SIG_WEIGHT into a separate commit.

Comment threadlightning/src/ln/funding.rs Outdated

impl FundingTxInput {
fn new<F: FnOnce(&bitcoin::Script) -> bool>(
prevtx: Transaction, vout: u32, sequence: Sequence, witness_weight: Weight,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: sequence could be made optional with a default value of ENABLE_RBF_NO_LOCKTIME

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

What do you think about always setting it to ENABLE_RBF_NO_LOCKTIME and providing a mutator to override it? Would be nice to avoid passing an Option here if possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sure, let's link to it in the FundingTxInput::new docs though

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

That's private, so will need to link each of the four public functions.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channel.rs Outdated
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 567442d to ef24de4CompareAugust 22, 2025 21:06
@jkczyz
jkczyz requested a review from wpaulinoAugust 22, 2025 21:07
@ldk-reviews-bot

ghost commented Aug 23, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 2nd Reminder

Hey @wpaulino@tankyleo! 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.

@wpaulino

ghost commented Aug 25, 2025

Copy link
Copy Markdown
Contributor

Feel free to squash on your next push

Jeffrey Czyz added 4 commits August 25, 2025 12:20
The funding inputs used for splicing and v2 channel establishment are
passed as a tuple of txin, prevtx, and witness weight. Add a struct so
that the items included can be better documented.
ChannelManager::splice_channel takes individual parameters to support
splice-in. Change these to an enum such that it can be used for
splice-out as well.
Update SpliceContribution with a variant used to support splice-out
(i.e., removing funds from a channel). The TxOut values must not exceed
the users channel balance after accounting for fees and the reserve
requirement.
When a counterparty sends splice_init with a negative contribution, they
are requesting to remove funds from a channel. Remove conditions
guarding against this and check that they have enough channel balance to
cover the removed funds.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from ef24de4 to ce203f2CompareAugust 25, 2025 17:32
@jkczyz

ghost commented Aug 25, 2025

Copy link
Copy Markdown
ContributorAuthor

Feel free to squash on your next push

Done. PTAL

ghost left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Three small nits we can take care of in followups

funding_negotiation_context.our_funding_contribution_satoshis;
let their_funding_contribution_satoshis = msg.funding_contribution_satoshis;
let our_funding_contribution = funding_negotiation_context.our_funding_contribution;
debug_assert!(our_funding_contribution <= SignedAmount::MAX_MONEY);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Check that the abs is smaller than MAX_MONEY ?

Comment on lines +37 to +38
/// The outputs to include in the splice's funding transaction. The total value of all
/// outputs will be the amount that is removed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"We will remove the total value of the outputs plus the transaction fees" ?

/// The amount to contribute to the splice.
value: Amount,

/// The inputs included in the splice's funding transaction to meet the contributed amount.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"to meet the contributed amount plus the fees" ?

@wpaulino
wpaulino merged commit 5f73b70 into lightningdevkit:mainAug 25, 2025
@jkczyzjkczyz mentioned this pull request Aug 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants

@jkczyz@ldk-reviews-bot@wpaulino@tankyleo
, '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('^' + ".*" + ' Add splice-out support by jkczyz · Pull Request #3979 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add splice-out support - #3979

Merged
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out
Aug 25, 2025
Merged

Add splice-out support#3979
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out

Conversation

@jkczyz

Copy link
Copy Markdown
Contributor

Splice-in support was added in #3736. This PR expands ChannelManager::splice_channel to support splice-out (i.e., removing funds from a channel). This is accomplished by adding a FundingTxContributions enum to cover both use cases.

Depends on #3736.

@ldk-reviews-bot

ldk-reviews-bot commented Jul 31, 2025

Copy link
Copy Markdown

👋 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.

@jkczyz
jkczyz requested a review from wpaulinoJuly 31, 2025 16:11
@jkczyz
jkczyz marked this pull request as draft July 31, 2025 16:11
@jkczyzjkczyz self-assigned this Jul 31, 2025
@codecov

codecovBot commented Jul 31, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 74.21053% with 49 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.76%. Comparing base (6d47f0a) to head (ce203f2).
⚠️ Report is 1400 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/msgs.rs29.41%15 Missing and 9 partials ⚠️
lightning/src/ln/funding.rs45.71%18 Missing and 1 partial ⚠️
lightning/src/ln/channel.rs91.93%1 Missing and 4 partials ⚠️
lightning/src/ln/interactivetxs.rs97.91%0 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3979 +/- ##
==========================================
+ Coverage 88.74% 88.76% +0.01% 
==========================================
Files 173 176 +3 Lines 124899 127944 +3045 Branches 124899 127944 +3045 ==========================================
+ Hits 110841 113564 +2723 - Misses 11631 11808 +177 - Partials 2427 2572 +145 
FlagCoverage Δ
fuzzing21.69% <2.34%> (?)
tests88.59% <73.15%> (-0.16%)⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 3 times, most recently from 2d39059 to 381fba6CompareAugust 1, 2025 00:23
@jkczyz
jkczyz marked this pull request as ready for review August 1, 2025 00:23
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
@ldk-reviews-bot

Copy link
Copy Markdown

👋 The first review has been submitted!

Do you think this PR is ready for a second reviewer? If so, click here to assign a second reviewer.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 396948e to 59fbd7eCompareAugust 7, 2025 23:38
@jkczyz
jkczyz requested a review from wpaulinoAugust 8, 2025 13:42
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from fde2f61 to f12c993CompareAugust 11, 2025 16:39
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Rebased to resolve merge conflicts.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f12c993 to 806220eCompareAugust 11, 2025 22:22
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
funding_feerate.to_sat_per_kwu() as u32,
));

if channel_balance > contribution_amount.unsigned_abs() + estimated_fee {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This isn't enough, we need to make sure the balance is still above the reserve and has enough to pay for fees on the commitment transaction if they're the channel initiator

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right, the reserve check will be at the call site as a separate check. I hadn't considered the fees for the commitment transaction. For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Most likely yeah, but it's better to be safe than sorry. We already need to always check it for the counterparty and for our splice-outs, so might as well always do it for splice-ins.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Leaving this for @tankyleo.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See other comments.

Comment threadlightning/src/ln/channel.rs
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 806220e to 9c2f266CompareAugust 13, 2025 23:58
@jkczyz
jkczyz requested a review from wpaulinoAugust 13, 2025 23:58
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 9c2f266 to ef1aee7CompareAugust 14, 2025 22:19
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should also make sure a FundingTransactionReadyForSigning event gets pushed when doing splice outs

Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
/// When funds are added to a channel.
SpliceIn {
/// The amount to contribute to the splice.
value: Amount,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Another variant could be to consume the full input set, but we can revisit that later

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I was thinking we could have a constructor that took inputs and gave back a SpliceContribution::SpliceIn with amount. However, we'd need to provide information about the balance in order to compute that. So maybe best to use a dedicated variant as you said.

@wpaulino
wpaulino requested a review from tankyleoAugust 14, 2025 23:24
TransactionU16LenLimited was used to limit Transaction serialization
size to u16::MAX. This was because messages can not be longer than
u16::MAX bytes when serialized for the transport layer. However, this
limit doesn't take into account other fields in a message containing a
Transaction, including the length of the transaction itself.
Remove TransactionU16LenLimited and instead check any user supplied
transactions in the context of the enclosing message (e.g. TxAddInput).
ChannelManager::splice_channel takes witness weights with the funding
inputs. Storing these in FundingNegotiationContext allows us to use them
when calculating the change output and include them in a common struct
used for initiating a splice-in.
In preparation for having ChannelManager::splice_channel take
FundingTxContributions, add a weight to the
FundingTxContributions::InputsOnly, which supports the splice-in use
case.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 7a38617 to 29c61bdCompareAugust 20, 2025 19:37

ghost left a comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Fixed CI and squashed commits as requested.

@jkczyz
jkczyz requested a review from tankyleoAugust 20, 2025 19:38
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 29c61bd to f2aa7feCompareAugust 20, 2025 21:57
@jkczyz

ghost commented Aug 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Pushed a fix for CI.

When splicing a channel, the previous funding output is spent and fees
for it are paid by the splice initiator. However, the witness weight was
not including EMPTY_SCRIPT_SIG_WEIGHT. Fix this and update the variable
name to make clear the weight needed is the input satisfaction.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f2aa7fe to 8a596fbCompareAugust 21, 2025 16:05
@jkczyz

ghost commented Aug 21, 2025

Copy link
Copy Markdown
ContributorAuthor

Sorry, early CI failures were masking another one. Think it should be fixed in latest push. Also, pulled out the EMPTY_SCRIPT_SIG_WEIGHT into a separate commit.

Comment threadlightning/src/ln/funding.rs Outdated

impl FundingTxInput {
fn new<F: FnOnce(&bitcoin::Script) -> bool>(
prevtx: Transaction, vout: u32, sequence: Sequence, witness_weight: Weight,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: sequence could be made optional with a default value of ENABLE_RBF_NO_LOCKTIME

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

What do you think about always setting it to ENABLE_RBF_NO_LOCKTIME and providing a mutator to override it? Would be nice to avoid passing an Option here if possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sure, let's link to it in the FundingTxInput::new docs though

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

That's private, so will need to link each of the four public functions.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channel.rs Outdated
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 567442d to ef24de4CompareAugust 22, 2025 21:06
@jkczyz
jkczyz requested a review from wpaulinoAugust 22, 2025 21:07
@ldk-reviews-bot

ghost commented Aug 23, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 2nd Reminder

Hey @wpaulino@tankyleo! 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.

@wpaulino

ghost commented Aug 25, 2025

Copy link
Copy Markdown
Contributor

Feel free to squash on your next push

Jeffrey Czyz added 4 commits August 25, 2025 12:20
The funding inputs used for splicing and v2 channel establishment are
passed as a tuple of txin, prevtx, and witness weight. Add a struct so
that the items included can be better documented.
ChannelManager::splice_channel takes individual parameters to support
splice-in. Change these to an enum such that it can be used for
splice-out as well.
Update SpliceContribution with a variant used to support splice-out
(i.e., removing funds from a channel). The TxOut values must not exceed
the users channel balance after accounting for fees and the reserve
requirement.
When a counterparty sends splice_init with a negative contribution, they
are requesting to remove funds from a channel. Remove conditions
guarding against this and check that they have enough channel balance to
cover the removed funds.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from ef24de4 to ce203f2CompareAugust 25, 2025 17:32
@jkczyz

ghost commented Aug 25, 2025

Copy link
Copy Markdown
ContributorAuthor

Feel free to squash on your next push

Done. PTAL

ghost left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Three small nits we can take care of in followups

funding_negotiation_context.our_funding_contribution_satoshis;
let their_funding_contribution_satoshis = msg.funding_contribution_satoshis;
let our_funding_contribution = funding_negotiation_context.our_funding_contribution;
debug_assert!(our_funding_contribution <= SignedAmount::MAX_MONEY);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Check that the abs is smaller than MAX_MONEY ?

Comment on lines +37 to +38
/// The outputs to include in the splice's funding transaction. The total value of all
/// outputs will be the amount that is removed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"We will remove the total value of the outputs plus the transaction fees" ?

/// The amount to contribute to the splice.
value: Amount,

/// The inputs included in the splice's funding transaction to meet the contributed amount.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"to meet the contributed amount plus the fees" ?

@wpaulino
wpaulino merged commit 5f73b70 into lightningdevkit:mainAug 25, 2025
@jkczyzjkczyz mentioned this pull request Aug 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants

@jkczyz@ldk-reviews-bot@wpaulino@tankyleo
, '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); } })(); })(); Add splice-out support by jkczyz · Pull Request #3979 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add splice-out support - #3979

Merged
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out
Aug 25, 2025
Merged

Add splice-out support#3979
wpaulino merged 9 commits into
lightningdevkit:mainfrom
jkczyz:2025-07-splice-out

Conversation

@jkczyz

Copy link
Copy Markdown
Contributor

Splice-in support was added in #3736. This PR expands ChannelManager::splice_channel to support splice-out (i.e., removing funds from a channel). This is accomplished by adding a FundingTxContributions enum to cover both use cases.

Depends on #3736.

@ldk-reviews-bot

ldk-reviews-bot commented Jul 31, 2025

Copy link
Copy Markdown

👋 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.

@jkczyz
jkczyz requested a review from wpaulinoJuly 31, 2025 16:11
@jkczyz
jkczyz marked this pull request as draft July 31, 2025 16:11
@jkczyzjkczyz self-assigned this Jul 31, 2025
@codecov

codecovBot commented Jul 31, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 74.21053% with 49 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.76%. Comparing base (6d47f0a) to head (ce203f2).
⚠️ Report is 1400 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/msgs.rs29.41%15 Missing and 9 partials ⚠️
lightning/src/ln/funding.rs45.71%18 Missing and 1 partial ⚠️
lightning/src/ln/channel.rs91.93%1 Missing and 4 partials ⚠️
lightning/src/ln/interactivetxs.rs97.91%0 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3979 +/- ##
==========================================
+ Coverage 88.74% 88.76% +0.01% 
==========================================
Files 173 176 +3 Lines 124899 127944 +3045 Branches 124899 127944 +3045 ==========================================
+ Hits 110841 113564 +2723 - Misses 11631 11808 +177 - Partials 2427 2572 +145 
FlagCoverage Δ
fuzzing21.69% <2.34%> (?)
tests88.59% <73.15%> (-0.16%)⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 3 times, most recently from 2d39059 to 381fba6CompareAugust 1, 2025 00:23
@jkczyz
jkczyz marked this pull request as ready for review August 1, 2025 00:23
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
@ldk-reviews-bot

Copy link
Copy Markdown

👋 The first review has been submitted!

Do you think this PR is ready for a second reviewer? If so, click here to assign a second reviewer.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 396948e to 59fbd7eCompareAugust 7, 2025 23:38
@jkczyz
jkczyz requested a review from wpaulinoAugust 8, 2025 13:42
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 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.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from fde2f61 to f12c993CompareAugust 11, 2025 16:39
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Rebased to resolve merge conflicts.

@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f12c993 to 806220eCompareAugust 11, 2025 22:22
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
funding_feerate.to_sat_per_kwu() as u32,
));

if channel_balance > contribution_amount.unsigned_abs() + estimated_fee {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This isn't enough, we need to make sure the balance is still above the reserve and has enough to pay for fees on the commitment transaction if they're the channel initiator

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Right, the reserve check will be at the call site as a separate check. I hadn't considered the fees for the commitment transaction. For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For the splice-in case, is it assumed it is sufficient because it was sufficient with the previous funding contributions?

Most likely yeah, but it's better to be safe than sorry. We already need to always check it for the counterparty and for our splice-outs, so might as well always do it for splice-ins.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Leaving this for @tankyleo.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See other comments.

Comment threadlightning/src/ln/channel.rs
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 806220e to 9c2f266CompareAugust 13, 2025 23:58
@jkczyz
jkczyz requested a review from wpaulinoAugust 13, 2025 23:58
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 9c2f266 to ef1aee7CompareAugust 14, 2025 22:19
@jkczyz

Copy link
Copy Markdown
ContributorAuthor

Squashed as requested.

@wpaulinowpaulino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should also make sure a FundingTransactionReadyForSigning event gets pushed when doing splice outs

Comment threadlightning/src/ln/channelmanager.rs Outdated
Comment threadlightning/src/ln/interactivetxs.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
/// When funds are added to a channel.
SpliceIn {
/// The amount to contribute to the splice.
value: Amount,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Another variant could be to consume the full input set, but we can revisit that later

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I was thinking we could have a constructor that took inputs and gave back a SpliceContribution::SpliceIn with amount. However, we'd need to provide information about the balance in order to compute that. So maybe best to use a dedicated variant as you said.

@wpaulino
wpaulino requested a review from tankyleoAugust 14, 2025 23:24
TransactionU16LenLimited was used to limit Transaction serialization
size to u16::MAX. This was because messages can not be longer than
u16::MAX bytes when serialized for the transport layer. However, this
limit doesn't take into account other fields in a message containing a
Transaction, including the length of the transaction itself.
Remove TransactionU16LenLimited and instead check any user supplied
transactions in the context of the enclosing message (e.g. TxAddInput).
ChannelManager::splice_channel takes witness weights with the funding
inputs. Storing these in FundingNegotiationContext allows us to use them
when calculating the change output and include them in a common struct
used for initiating a splice-in.
In preparation for having ChannelManager::splice_channel take
FundingTxContributions, add a weight to the
FundingTxContributions::InputsOnly, which supports the splice-in use
case.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 7a38617 to 29c61bdCompareAugust 20, 2025 19:37

ghost left a comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Fixed CI and squashed commits as requested.

@jkczyz
jkczyz requested a review from tankyleoAugust 20, 2025 19:38
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from 29c61bd to f2aa7feCompareAugust 20, 2025 21:57
@jkczyz

ghost commented Aug 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Pushed a fix for CI.

When splicing a channel, the previous funding output is spent and fees
for it are paid by the splice initiator. However, the witness weight was
not including EMPTY_SCRIPT_SIG_WEIGHT. Fix this and update the variable
name to make clear the weight needed is the input satisfaction.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from f2aa7fe to 8a596fbCompareAugust 21, 2025 16:05
@jkczyz

ghost commented Aug 21, 2025

Copy link
Copy Markdown
ContributorAuthor

Sorry, early CI failures were masking another one. Think it should be fixed in latest push. Also, pulled out the EMPTY_SCRIPT_SIG_WEIGHT into a separate commit.

Comment threadlightning/src/ln/funding.rs Outdated

impl FundingTxInput {
fn new<F: FnOnce(&bitcoin::Script) -> bool>(
prevtx: Transaction, vout: u32, sequence: Sequence, witness_weight: Weight,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: sequence could be made optional with a default value of ENABLE_RBF_NO_LOCKTIME

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

What do you think about always setting it to ENABLE_RBF_NO_LOCKTIME and providing a mutator to override it? Would be nice to avoid passing an Option here if possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sure, let's link to it in the FundingTxInput::new docs though

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

That's private, so will need to link each of the four public functions.

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channel.rs Outdated
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch 2 times, most recently from 567442d to ef24de4CompareAugust 22, 2025 21:06
@jkczyz
jkczyz requested a review from wpaulinoAugust 22, 2025 21:07
@ldk-reviews-bot

ghost commented Aug 23, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 1st Reminder

Hey @wpaulino@tankyleo! 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

ghost commented Aug 25, 2025

Copy link
Copy Markdown

🔔 2nd Reminder

Hey @wpaulino@tankyleo! 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.

@wpaulino

ghost commented Aug 25, 2025

Copy link
Copy Markdown
Contributor

Feel free to squash on your next push

Jeffrey Czyz added 4 commits August 25, 2025 12:20
The funding inputs used for splicing and v2 channel establishment are
passed as a tuple of txin, prevtx, and witness weight. Add a struct so
that the items included can be better documented.
ChannelManager::splice_channel takes individual parameters to support
splice-in. Change these to an enum such that it can be used for
splice-out as well.
Update SpliceContribution with a variant used to support splice-out
(i.e., removing funds from a channel). The TxOut values must not exceed
the users channel balance after accounting for fees and the reserve
requirement.
When a counterparty sends splice_init with a negative contribution, they
are requesting to remove funds from a channel. Remove conditions
guarding against this and check that they have enough channel balance to
cover the removed funds.
@jkczyz
jkczyzforce-pushed the 2025-07-splice-out branch from ef24de4 to ce203f2CompareAugust 25, 2025 17:32
@jkczyz

ghost commented Aug 25, 2025

Copy link
Copy Markdown
ContributorAuthor

Feel free to squash on your next push

Done. PTAL

ghost left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Three small nits we can take care of in followups

funding_negotiation_context.our_funding_contribution_satoshis;
let their_funding_contribution_satoshis = msg.funding_contribution_satoshis;
let our_funding_contribution = funding_negotiation_context.our_funding_contribution;
debug_assert!(our_funding_contribution <= SignedAmount::MAX_MONEY);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Check that the abs is smaller than MAX_MONEY ?

Comment on lines +37 to +38
/// The outputs to include in the splice's funding transaction. The total value of all
/// outputs will be the amount that is removed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"We will remove the total value of the outputs plus the transaction fees" ?

/// The amount to contribute to the splice.
value: Amount,

/// The inputs included in the splice's funding transaction to meet the contributed amount.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"to meet the contributed amount plus the fees" ?

@wpaulino
wpaulino merged commit 5f73b70 into lightningdevkit:mainAug 25, 2025
@jkczyzjkczyz mentioned this pull request Aug 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants

@jkczyz@ldk-reviews-bot@wpaulino@tankyleo