Uh oh!
There was an error while loading. Please reload this page.
Allow cancellation of pending splice funding negotiations#4490
Uh oh!
There was an error while loading. Please reload this page.
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 |
|---|---|---|
| @@ -1724,7 +1724,7 @@ where | ||
| if matches!(chan.context.channel_state, ChannelState::ChannelReady(_)) { | ||
| chan.context.channel_state.clear_local_stfu_sent(); | ||
| chan.context.channel_state.clear_remote_stfu_sent(); | ||
| if chan.should_reset_pending_splice_state(true) { | ||
| // If there was a pending splice negotiation that failed due to disconnecting, we | ||
| // also take the opportunity to clean up our state. | ||
| let splice_funding_failed = chan.reset_pending_splice_state(); | ||
| @@ -1841,7 +1841,7 @@ where | ||
| None | ||
| }, | ||
| ChannelPhase::Funded(funded_channel) => { | ||
| if funded_channel.should_reset_pending_splice_state(true) { | ||
| funded_channel.reset_pending_splice_state() | ||
| } else { | ||
| debug_assert!(false, "We should never fail an interactive funding negotiation once we're exchanging tx_signatures"); | ||
| @@ -2024,7 +2024,7 @@ where | ||
| "Received tx_abort while awaiting tx_signatures exchange".to_owned(), | ||
| )); | ||
| } | ||
| if funded_channel.should_reset_pending_splice_state(false) { | ||
| let has_funding_negotiation = funded_channel | ||
| .pending_splice | ||
| .as_ref() | ||
| @@ -7159,7 +7159,7 @@ where | ||
| fn maybe_fail_splice_negotiation(&mut self) -> Option<SpliceFundingFailed> { | ||
| if matches!(self.context.channel_state, ChannelState::ChannelReady(_)) { | ||
| if self.should_reset_pending_splice_state(true) { | ||
| self.reset_pending_splice_state() | ||
| } else { | ||
| self.abandon_quiescent_action() | ||
| @@ -7216,7 +7216,7 @@ where | ||
| /// Returns a boolean indicating whether we should reset the splice's | ||
| /// [`PendingFunding::funding_negotiation`]. | ||
| fn should_reset_pending_splice_state(&self, allow_resumption: bool) -> bool { | ||
| self.pending_splice | ||
| .as_ref() | ||
| .map(|pending_splice| { | ||
| @@ -7228,16 +7228,18 @@ where | ||
| funding_negotiation, | ||
| FundingNegotiation::AwaitingSignatures { .. } | ||
| ); | ||
| if allow_resumption { | ||
| // If we want to resume the negotiation after reconnecting, we must be | ||
| // in [`FundingNegotiation::AwaitingSignatures`] to not reset our state. | ||
| !is_awaiting_signatures | ||
| } else { | ||
| !is_awaiting_signatures | ||
| || !self | ||
| .context() | ||
| .interactive_tx_signing_session | ||
| .as_ref() | ||
| .expect("We have a pending splice awaiting signatures") | ||
| .has_received_commitment_signed() | ||
| } | ||
| }) | ||
| .unwrap_or_else(|| { | ||
| @@ -7251,7 +7253,7 @@ where | ||
| } | ||
| fn reset_pending_splice_state(&mut self) -> Option<SpliceFundingFailed> { | ||
| debug_assert!(self.should_reset_pending_splice_state(false)); | ||
| // Only clear the signing session if the current round is mid-signing. When an earlier | ||
| // round completed signing and a later RBF round is in AwaitingAck or | ||
| @@ -7325,7 +7327,7 @@ where | ||
| } | ||
| pub(super) fn maybe_splice_funding_failed(&self) -> Option<SpliceFundingFailed> { | ||
| if !self.should_reset_pending_splice_state(true) { | ||
| return None; | ||
| } | ||
| @@ -12779,30 +12781,93 @@ where | ||
| } | ||
| } | ||
| pub fn cancel_funding_contributed(&mut self) -> Result<InteractiveTxMsgError, APIError> { | ||
| if matches!(self.quiescent_action, Some(QuiescentAction::Splice { .. })) { | ||
| let splice_funding_failed = self.abandon_quiescent_action(); | ||
| debug_assert!(splice_funding_failed.is_some()); | ||
| let str = "Manually canceled funding contribution"; | ||
| let err = if self.context.channel_state.is_local_stfu_sent() | ||
| && !self.context.channel_state.is_remote_stfu_sent() | ||
| { | ||
| // If we've already sent `stfu` and haven't received the counterparty's yet, we know | ||
| // it corresponds to our action. | ||
| ChannelError::WarnAndDisconnect(str.into()) | ||
| } else { | ||
| // We don't need to send `tx_abort` because our action still pending means we're not | ||
| // quiescent for it. | ||
| ChannelError::Ignore(str.into()) | ||
| }; | ||
| return Ok(InteractiveTxMsgError { err, splice_funding_failed }); | ||
| } | ||
| let funding_negotiation = self | ||
| .pending_splice | ||
| .as_ref() | ||
| .and_then(|pending_splice| pending_splice.funding_negotiation.as_ref()); | ||
| let Some(funding_negotiation) = funding_negotiation else { | ||
| return Err(APIError::APIMisuseError { | ||
| err: format!( | ||
| "Channel {} does not have a pending splice negotiation", | ||
| self.context.channel_id() | ||
| ), | ||
wpaulino marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| }); | ||
| }; | ||
| let made_contribution = match funding_negotiation { | ||
| FundingNegotiation::AwaitingAck { context, .. } => { | ||
| context.contributed_inputs().next().is_some() | ||
| || context.contributed_outputs().next().is_some() | ||
| }, | ||
| FundingNegotiation::ConstructingTransaction { interactive_tx_constructor, .. } => { | ||
| interactive_tx_constructor.contributed_inputs().next().is_some() | ||
| || interactive_tx_constructor.contributed_outputs().next().is_some() | ||
| }, | ||
wpaulino marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| FundingNegotiation::AwaitingSignatures { .. } => self | ||
| .context | ||
| .interactive_tx_signing_session | ||
| .as_ref() | ||
| .expect("We have a pending splice awaiting signatures") | ||
| .has_local_contribution(), | ||
wpaulino marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| }; | ||
| if !made_contribution { | ||
| return Err(APIError::APIMisuseError { | ||
| err: format!( | ||
| "Channel {} has a pending splice negotiation with no contribution made", | ||
| self.context.channel_id() | ||
| ), | ||
| }); | ||
| } | ||
| // We typically don't reset the pending funding negotiation when we're in | ||
| // [`FundingNegotiation::AwaitingSignatures`] since we're able to resume it on | ||
| // re-establishment, so we still need to handle this case separately if the user wishes to | ||
| // cancel. If they've yet to call [`Channel::funding_transaction_signed`], then we can | ||
| // guarantee to never have sent any signatures to the counterparty, or have processed any | ||
| // signatures from them. | ||
| if matches!(funding_negotiation, FundingNegotiation::AwaitingSignatures { .. }) { | ||
| let already_signed = self | ||
| .context | ||
| .interactive_tx_signing_session | ||
| .as_ref() | ||
| .expect("We have a pending splice awaiting signatures") | ||
| .has_holder_tx_signatures(); | ||
| if already_signed { | ||
Collaborator There was a problem hiding this comment. Does this suffice? We call ContributorAuthor There was a problem hiding this comment. We can only process the counterparty's initial | ||
| return Err(APIError::APIMisuseError { | ||
| err: format!( | ||
| "Channel {} has pending splice negotiation that was already signed", | ||
| self.context.channel_id(), | ||
| ), | ||
| }); | ||
| } | ||
| } | ||
| debug_assert!(self.context.channel_state.is_quiescent()); | ||
| let splice_funding_failed = self.reset_pending_splice_state(); | ||
wpaulino marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. Contributor There was a problem hiding this comment. Do we need to worry about updating | ||
| debug_assert!(splice_funding_failed.is_some()); | ||
| Ok(InteractiveTxMsgError { | ||
| err: ChannelError::Abort(AbortReason::ManualIntervention), | ||
| splice_funding_failed, | ||
| }) | ||
| } | ||
| /// Checks during handling splice_init | ||
| @@ -15584,7 +15649,7 @@ impl<SP: SignerProvider> Writeable for FundedChannel<SP> { | ||
| ChannelState::ChannelReady(_) => { | ||
| channel_state.clear_local_stfu_sent(); | ||
| channel_state.clear_remote_stfu_sent(); | ||
| if self.should_reset_pending_splice_state(true) | ||
| || !self.has_pending_splice_awaiting_signatures() | ||
| { | ||
| // We shouldn't be quiescent anymore upon reconnecting if: | ||
| @@ -15974,7 +16039,7 @@ impl<SP: SignerProvider> Writeable for FundedChannel<SP> { | ||
| // We don't have to worry about resetting the pending `FundingNegotiation` because we | ||
| // can only read `FundingNegotiation::AwaitingSignatures` variants anyway. | ||
| let pending_splice = | ||
| self.pending_splice.as_ref().filter(|_| !self.should_reset_pending_splice_state(true)); | ||
| let monitor_pending_tx_signatures = | ||
| self.context.monitor_pending_tx_signatures.then_some(()); | ||
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.