Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 480
Split DiscardFunding from SpliceFailed event#4388
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
TheBlueMatt
merged 6 commits into
lightningdevkit:main
from
jkczyz:2026-02-splice-discard-fundingFeb 24, 2026
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7e413a7
Fix silent merge conflict
jkczyz 9c7783b
Add expect_splice_failed_events helper
jkczyz a4f2ea2
Extract contributed_{inputs|outputs} iterators
jkczyz 9901ee9
Split DiscardFunding from SpliceFailed event
jkczyz c9c0159
Print unexpected events upon assertion failure
jkczyz 24062c0
Add pending changelog for SpliceFailed / DiscardFunding split
jkczyz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -3050,6 +3050,35 @@ pub(crate) enum QuiescentAction { | ||
| DoNothing, | ||
| } | ||
| pub(super) enum QuiescentError { | ||
| DoNothing, | ||
| DiscardFunding { inputs: Vec<bitcoin::OutPoint>, outputs: Vec<bitcoin::TxOut> }, | ||
| FailSplice(SpliceFundingFailed), | ||
| } | ||
| impl From<QuiescentAction> for QuiescentError { | ||
| fn from(action: QuiescentAction) -> Self { | ||
| match action { | ||
| QuiescentAction::LegacySplice(_) => { | ||
| debug_assert!(false); | ||
| QuiescentError::DoNothing | ||
| }, | ||
| QuiescentAction::Splice { contribution, .. } => { | ||
| let (contributed_inputs, contributed_outputs) = | ||
| contribution.into_contributed_inputs_and_outputs(); | ||
| return QuiescentError::FailSplice(SpliceFundingFailed { | ||
| funding_txo: None, | ||
| channel_type: None, | ||
| contributed_inputs, | ||
| contributed_outputs, | ||
| }); | ||
| }, | ||
| #[cfg(any(test, fuzzing, feature = "_test_utils"))] | ||
| QuiescentAction::DoNothing => QuiescentError::DoNothing, | ||
| } | ||
| } | ||
| } | ||
| pub(crate) enum StfuResponse { | ||
| Stfu(msgs::Stfu), | ||
| SpliceInit(msgs::SpliceInit), | ||
| @@ -6833,11 +6862,16 @@ impl FundingNegotiationContext { | ||
| (contributed_inputs, contributed_outputs) | ||
| } | ||
| fn contributed_inputs(&self) -> impl Iterator<Item = bitcoin::OutPoint> + '_ { | ||
| self.our_funding_inputs.iter().map(|input| input.utxo.outpoint) | ||
| } | ||
| fn contributed_outputs(&self) -> impl Iterator<Item = &TxOut> + '_ { | ||
| self.our_funding_outputs.iter() | ||
| } | ||
| fn to_contributed_inputs_and_outputs(&self) -> (Vec<bitcoin::OutPoint>, Vec<TxOut>) { | ||
| let contributed_inputs = | ||
| self.our_funding_inputs.iter().map(|input| input.utxo.outpoint).collect(); | ||
| let contributed_outputs = self.our_funding_outputs.clone(); | ||
| (contributed_inputs, contributed_outputs) | ||
| (self.contributed_inputs().collect(), self.contributed_outputs().cloned().collect()) | ||
| } | ||
| } | ||
| @@ -12210,9 +12244,58 @@ where | ||
| pub fn funding_contributed<L: Logger>( | ||
| &mut self, contribution: FundingContribution, locktime: LockTime, logger: &L, | ||
| ) -> Result<Option<msgs::Stfu>, SpliceFundingFailed> { | ||
| ) -> Result<Option<msgs::Stfu>, QuiescentError> { | ||
| debug_assert!(contribution.is_splice()); | ||
| if let Some(QuiescentAction::Splice { contribution: existing, .. }) = &self.quiescent_action | ||
wpaulino marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| { | ||
| return match contribution.into_unique_contributions( | ||
| existing.contributed_inputs(), | ||
| existing.contributed_outputs(), | ||
| ) { | ||
| None => Err(QuiescentError::DoNothing), | ||
| Some((inputs, outputs)) => Err(QuiescentError::DiscardFunding { inputs, outputs }), | ||
| }; | ||
| } | ||
| let initiated_funding_negotiation = self | ||
| .pending_splice | ||
| .as_ref() | ||
| .and_then(|pending_splice| pending_splice.funding_negotiation.as_ref()) | ||
| .filter(|funding_negotiation| funding_negotiation.is_initiator()); | ||
| if let Some(funding_negotiation) = initiated_funding_negotiation { | ||
| let unique_contributions = match funding_negotiation { | ||
| FundingNegotiation::AwaitingAck { context, .. } => contribution | ||
| .into_unique_contributions( | ||
| context.contributed_inputs(), | ||
| context.contributed_outputs(), | ||
| ), | ||
| FundingNegotiation::ConstructingTransaction { | ||
| interactive_tx_constructor, .. | ||
| } => contribution.into_unique_contributions( | ||
| interactive_tx_constructor.contributed_inputs(), | ||
| interactive_tx_constructor.contributed_outputs(), | ||
| ), | ||
| FundingNegotiation::AwaitingSignatures { .. } => { | ||
| let session = self | ||
| .context | ||
| .interactive_tx_signing_session | ||
| .as_ref() | ||
| .expect("pending splice awaiting signatures"); | ||
| contribution.into_unique_contributions( | ||
| session.contributed_inputs(), | ||
| session.contributed_outputs(), | ||
| ) | ||
| }, | ||
| }; | ||
| return match unique_contributions { | ||
| None => Err(QuiescentError::DoNothing), | ||
| Some((inputs, outputs)) => Err(QuiescentError::DiscardFunding { inputs, outputs }), | ||
| }; | ||
| } | ||
| if let Err(e) = contribution.validate().and_then(|()| { | ||
| // For splice-out, our_funding_contribution is adjusted to cover fees if there | ||
| // aren't any inputs. | ||
| @@ -12224,37 +12307,15 @@ where | ||
| let (contributed_inputs, contributed_outputs) = | ||
| contribution.into_contributed_inputs_and_outputs(); | ||
| return Err(SpliceFundingFailed { | ||
| return Err(QuiescentError::FailSplice(SpliceFundingFailed { | ||
wpaulino marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| funding_txo: None, | ||
| channel_type: None, | ||
| contributed_inputs, | ||
| contributed_outputs, | ||
| }); | ||
| })); | ||
| } | ||
| self.propose_quiescence(logger, QuiescentAction::Splice { contribution, locktime }).map_err( | ||
| |action| { | ||
| // FIXME: Any better way to do this? | ||
| if let QuiescentAction::Splice { contribution, .. } = action { | ||
| let (contributed_inputs, contributed_outputs) = | ||
| contribution.into_contributed_inputs_and_outputs(); | ||
| SpliceFundingFailed { | ||
| funding_txo: None, | ||
| channel_type: None, | ||
| contributed_inputs, | ||
| contributed_outputs, | ||
| } | ||
| } else { | ||
| debug_assert!(false); | ||
| SpliceFundingFailed { | ||
| funding_txo: None, | ||
| channel_type: None, | ||
| contributed_inputs: vec![], | ||
| contributed_outputs: vec![], | ||
| } | ||
| } | ||
| }, | ||
| ) | ||
| self.propose_quiescence(logger, QuiescentAction::Splice { contribution, locktime }) | ||
| } | ||
| fn send_splice_init(&mut self, instructions: SpliceInstructions) -> msgs::SpliceInit { | ||
| @@ -13377,19 +13438,19 @@ where | ||
| #[rustfmt::skip] | ||
| pub fn propose_quiescence<L: Logger>( | ||
| &mut self, logger: &L, action: QuiescentAction, | ||
| ) -> Result<Option<msgs::Stfu>, QuiescentAction> { | ||
| ) -> Result<Option<msgs::Stfu>, QuiescentError> { | ||
| log_debug!(logger, "Attempting to initiate quiescence"); | ||
| if !self.context.is_usable() { | ||
| log_debug!(logger, "Channel is not in a usable state to propose quiescence"); | ||
| return Err(action); | ||
| return Err(action.into()); | ||
| } | ||
| if self.quiescent_action.is_some() { | ||
| log_debug!( | ||
| logger, | ||
| "Channel already has a pending quiescent action and cannot start another", | ||
| ); | ||
| return Err(action); | ||
| return Err(action.into()); | ||
| } | ||
| // Since we don't have a pending quiescent action, we should never be in a state where we | ||
| // sent `stfu` without already having become quiescent. | ||
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.