Support manually selecting inputs consuming their entire value#4575
Support manually selecting inputs consuming their entire value#4575wpaulino wants to merge 3 commits intolightningdevkit:mainfrom
Conversation
|
👋 Thanks for assigning @TheBlueMatt as a reviewer! |
| ); | ||
|
|
||
| if !self.inputs.is_empty() { | ||
| if !self.inputs.is_empty() && self.input_mode == Some(FundingInputMode::CoinSelected) { |
There was a problem hiding this comment.
Bug: Backwards compatibility issue with persisted FundingContribution objects.
FundingContribution is persisted in PendingFunding.contributions (channel.rs:2917). When deserializing contributions created before this PR, input_mode will be None (it's a new option TLV field). Old coin-selected contributions with inputs will have input_mode == None, causing this condition to be false even though they should take the coin-selected branch.
This causes two problems for old persisted coin-selected contributions:
- Wrong fee buffer calculation: Uses
holder_balance + net_value_without_feeinstead ofestimated_fee + change_value, potentially allowing or rejecting feerate adjustments incorrectly. - Change output silently dropped:
compute_feerate_adjustmentreturnsNonefor change, andat_feeratesetschange_output = None, losing the change value.
This is reachable via for_acceptor_at_feerate / for_initiator_at_feerate called on contributions loaded from pending_splice.contributions (channel.rs lines 12504, 12944, 13127, 13145).
Fix: use self.input_mode != Some(FundingInputMode::Manual) instead of self.input_mode == Some(FundingInputMode::CoinSelected) to preserve old behavior for contributions where input_mode is None:
| if !self.inputs.is_empty() && self.input_mode == Some(FundingInputMode::CoinSelected) { | |
| if !self.inputs.is_empty() && self.input_mode != Some(FundingInputMode::Manual) { |
There was a problem hiding this comment.
There is no backwards compatibility concern because the serialized object has not been included in a release yet.
| if let Some(PriorContribution { contribution: prior_contribution, .. }) = | ||
| self.prior_contribution.as_ref() | ||
| { | ||
| if prior_contribution.input_mode == Some(FundingInputMode::CoinSelected) |
There was a problem hiding this comment.
Minor: Same backwards-compat pattern as line 880. Old persisted coin-selected contributions will have input_mode == None, so this guard won't fire for them. In practice this is mostly mitigated by the check at line 1309 (value_added > 0 && manually_selected_inputs non-empty), but it could miss edge cases where the old prior had value_added() == 0 (inputs exactly covered outputs + fees).
Consider using != Some(FundingInputMode::Manual) combined with a non-empty inputs check:
| if prior_contribution.input_mode == Some(FundingInputMode::CoinSelected) | |
| if prior_contribution.input_mode != Some(FundingInputMode::Manual) | |
| && !prior_contribution.inputs.is_empty() |
Review SummaryNew Issue
Previously Flagged Issues (still open)
|
12e5994 to
412ec3d
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4575 +/- ##
==========================================
- Coverage 86.22% 86.16% -0.07%
==========================================
Files 159 157 -2
Lines 109170 109318 +148
Branches 109170 109318 +148
==========================================
+ Hits 94136 94191 +55
- Misses 12424 12498 +74
- Partials 2610 2629 +19
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
TheBlueMatt
left a comment
There was a problem hiding this comment.
All LGTM. One question.
|
🔔 1st Reminder Hey @jkczyz! This PR has been waiting for your review. |
412ec3d to
228cae8
Compare
|
🔔 2nd Reminder Hey @jkczyz! This PR has been waiting for your review. |
elnosh
left a comment
There was a problem hiding this comment.
Not that familiar with splicing-related code in the codebase but looking at this for learning purposes. After much staring, changes make sense although agree with @jkczyz comment on making an enum since those fields (value_added and manually_selected_inputs) are mutually exclusive in the ways inputs can be provided.
| /// used if the request cannot be satisfied by reusing a prior contribution, by using only | ||
| /// manually selected inputs, or by building a pure splice-out directly. |
There was a problem hiding this comment.
I'm not sure I follow this comment. If we have a builder with either sync or async CoinSelectionSource then manually added inputs are not allowed.
There was a problem hiding this comment.
Manually selected inputs are still allowed as long as the added_value is 0.
17c864b to
c3da7fe
Compare
This commit introduces an alternative way of splicing in funds without coin selection by requiring the full UTXO to be provided. Each UTXO's entire value (minus fees) is allocated towards the channel, which provides unified balance wallets a more intuitive API when splicing funds into the channel, as they don't particularly care about maintaining a portion of their balance onchain. To simplify the implementation, we require that contributions are not allowed to mix coin-selected inputs with manually-selected ones. Users will need to start a fresh contribution if they want to change the funding input mode.
There's no reason not to do so, and it allows us to fail earlier when the user's net contribution exceeds their spliceable balance.
While this is already enforced when we get to the interactive negotiation phase, we choose to fail early anyway.
c3da7fe to
6e16493
Compare
| return contribution | ||
| .amend_without_coin_selection( | ||
| funding_inputs, | ||
| self.funding_inputs.take(), |
There was a problem hiding this comment.
Bug: self.funding_inputs.take() destroys the requested value_added, causing the coin selection fallback to request 0 sats.
When amend_without_coin_selection returns None (prior's inputs can't satisfy the amended request), this method returns Err(MissingCoinSelectionSource). At that point self.funding_inputs is None because of .take(). The AsyncFundingBuilder::build / SyncFundingBuilder::build fallback then reads:
let value_added =
inner.funding_inputs.as_ref().map_or(Amount::ZERO, FundingInputs::value_added);
let (must_spend, must_pay_to) = inner.prepare_coin_selection_request(value_added)?;Since funding_inputs is None, value_added is 0, and coin selection runs asking for 0 sats added instead of the user's requested amount.
Scenario: User has a prior coin-selected contribution adding 50k sats with a 100k input. They call add_value(100k) to increase to 150k total. request_matches_prior is false (values differ). amend_without_coin_selection fails because the 100k input can't cover 150k. The fallback runs coin selection with value_added = 0 instead of 150k.
This is a regression — the pre-PR code used self.value_added (a Copy field) which was never consumed.
Fix: use .clone() instead of .take() so funding_inputs is preserved for the fallback path:
| self.funding_inputs.take(), | |
| self.funding_inputs.clone(), |
There was a problem hiding this comment.
Hmmm.. could we get around this by taking self instead of &mut self in build_from_prior_contribution and try_build_without_coin_selection?
There was a problem hiding this comment.
No because we first call build_without_coin_selection (which calls try_build_without_coin_selection) in AsyncFundingBuilder::build so we need to keep the state around for when we fall back to coin selection.
There was a problem hiding this comment.
Ah right. Is this an actual bug then?
There was a problem hiding this comment.
It is yeah, don't see a nice way of fixing this aside from just restoring the value_added if we fall back to coin selection.
This commit introduces an alternative way of splicing in funds without coin selection by requiring the full UTXO to be provided. Each UTXO's entire value (minus fees) is allocated towards the channel, which provides unified balance wallets a more intuitive API when splicing funds into the channel, as they don't particularly care about maintaining a portion of their balance onchain.
To simplify the implementation, we require that contributions are not allowed to mix coin-selected inputs with manually-selected ones. Users will need to start a fresh contribution if they want to change the funding input mode.