Skip to content

Introduce interactive signing state flags for funded states. #3637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

dunxen
Copy link
Contributor

@dunxen dunxen commented Mar 3, 2025

This PR includes some deferred follow-ups extracted from #3423 and introduces new state flags to track interactive signing along with persistence of the minimum information needed from a signing session to reconstruct it.

A top-level state flag was avoided so that this work is compatible with splicing as well as V2 channel establishment (dual-funding).

@ldk-reviews-bot
Copy link

ldk-reviews-bot commented Mar 3, 2025

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

@dunxen dunxen marked this pull request as draft March 3, 2025 18:50
@dunxen dunxen force-pushed the 2025-02-interactivesigningstate branch 2 times, most recently from 4c6b6ab to c1f430a Compare March 4, 2025 09:02
@dunxen dunxen changed the title DRAFT: Introduce interactive signing state flags for funded states. Introduce interactive signing state flags for funded states. Mar 4, 2025
@dunxen dunxen marked this pull request as ready for review March 4, 2025 09:03
@dunxen dunxen force-pushed the 2025-02-interactivesigningstate branch from c1f430a to e89ba58 Compare March 4, 2025 11:09
Copy link
Collaborator

@TheBlueMatt TheBlueMatt left a comment

Choose a reason for hiding this comment

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

Did you want to include test coverage for restarts here?

@dunxen
Copy link
Contributor Author

dunxen commented Mar 4, 2025

Did you want to include test coverage for restarts here?

Not yet. Tracked in #3636. Will need to be able to contribute inputs first to test a useful order of message exchange + restart.

@dunxen dunxen force-pushed the 2025-02-interactivesigningstate branch from e89ba58 to 3b2ac55 Compare March 5, 2025 10:05
Copy link

codecov bot commented Mar 5, 2025

Codecov Report

Attention: Patch coverage is 64.55026% with 67 lines in your changes missing coverage. Please review.

Project coverage is 90.01%. Comparing base (89f5217) to head (fb00cb6).
Report is 19 commits behind head on main.

Files with missing lines Patch % Lines
lightning/src/ln/channel.rs 59.55% 49 Missing and 6 partials ⚠️
lightning/src/ln/interactivetxs.rs 46.66% 8 Missing ⚠️
lightning/src/ln/channelmanager.rs 90.90% 1 Missing and 1 partial ⚠️
lightning/src/ln/dual_funding_tests.rs 87.50% 1 Missing ⚠️
lightning/src/util/ser.rs 85.71% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3637      +/-   ##
==========================================
+ Coverage   89.37%   90.01%   +0.63%     
==========================================
  Files         157      157              
  Lines      124095   129376    +5281     
  Branches   124095   129376    +5281     
==========================================
+ Hits       110915   116452    +5537     
+ Misses      10469    10187     -282     
- Partials     2711     2737      +26     

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

@dunxen dunxen force-pushed the 2025-02-interactivesigningstate branch from 3b2ac55 to 5110ecc Compare March 5, 2025 14:20
@wpaulino
Copy link
Contributor

wpaulino commented Mar 5, 2025

@dunxen re-request when this is ready for review again, feel free to squash as well

@dunxen dunxen force-pushed the 2025-02-interactivesigningstate branch from 5110ecc to 1d96044 Compare March 6, 2025 12:43
@dunxen dunxen requested review from TheBlueMatt and wpaulino March 6, 2025 12:44
@ldk-reviews-bot
Copy link

🔔 1st Reminder

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

@dunxen dunxen added weekly goal Someone wants to land this this week Dual-funding labels Mar 6, 2025
@@ -6924,11 +6933,72 @@ impl<SP: Deref> FundedChannel<SP> where
log_debug!(logger, "Reconnected channel {} with no loss", &self.context.channel_id());
}

// if next_funding_txid is set:
Copy link
Contributor

Choose a reason for hiding this comment

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

If possible, would be nice to get some test coverage in now for this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Might be tricky at the moment, but makes sense to try do that now 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Still tricky, but working on this now currently. I'll let you know if we'll have to defer this to a PR after "create outbound dual-funded channel" is complete.

@TheBlueMatt TheBlueMatt removed their request for review March 6, 2025 23:01
@TheBlueMatt
Copy link
Collaborator

Taking myself off since @wpaulino and @jkczyz are on this one. Aside from my first comment I don't have any more high-level feedback.

@dunxen dunxen force-pushed the 2025-02-interactivesigningstate branch from 1d96044 to 55e5f6f Compare March 11, 2025 11:42
@ldk-reviews-bot
Copy link

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

@ldk-reviews-bot
Copy link

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

@ldk-reviews-bot
Copy link

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

@ldk-reviews-bot
Copy link

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

@ldk-reviews-bot
Copy link

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

@dunxen dunxen force-pushed the 2025-02-interactivesigningstate branch from 21d3c78 to 692d59b Compare April 29, 2025 11:45
@dunxen dunxen requested a review from wpaulino April 29, 2025 13:02
@ldk-reviews-bot
Copy link

🔔 1st Reminder

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

@ldk-reviews-bot
Copy link

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

Instead of having an explicit `ChannelContext::next_funding_txid` to set
and read, we can get this value on the fly when it is appropriate to do
so.
@dunxen dunxen force-pushed the 2025-02-interactivesigningstate branch from 692d59b to 9ca7d03 Compare May 5, 2025 10:27
@ldk-reviews-bot
Copy link

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

This follows the the specification closely in branching without being
too verbose, so that it should be easy to follow the logic.

See: https://github.com/lightning/bolts/blob/aa5207a/02-peer-protocol.md?plain=1#L2520-L2531
@dunxen dunxen force-pushed the 2025-02-interactivesigningstate branch from 9ca7d03 to b3c4f18 Compare May 6, 2025 07:55
@dunxen
Copy link
Contributor Author

dunxen commented May 6, 2025

Changes:

git diff-tree -U1 9ca7d03 b3c4f18
diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs
index 1eeca4aee..5111a5060 100644
--- a/lightning/src/ln/channel.rs
+++ b/lightning/src/ln/channel.rs
@@ -6600,6 +6600,5 @@ impl<SP: Deref> FundedChannel<SP> where
        {
-               if !matches!(
-                       self.context.channel_state,
-                       ChannelState::FundingNegotiated(flags) if flags.is_interactive_signing() || !flags.is_their_tx_signatures_sent()
-               ) {
+               if self.interactive_tx_signing_session.is_none() ||
+                       matches!(self.context.channel_state, ChannelState::FundingNegotiated(flags) if flags.is_their_tx_signatures_sent())
+               {
                        return Err(ChannelError::Ignore("Ignoring tx_signatures received outside of interactive signing".to_owned()));

@dunxen dunxen requested review from wpaulino and jkczyz May 6, 2025 08:10
dunxen added 3 commits May 7, 2025 08:17
This intoduces the INTERACTIVE_SIGNING, THEIR_TX_SIGNATURES_SENT, and
OUR_TX_SIGNATURES_SENT funded state flags.

A top-level state flag for INTERACTIVE_SIGNING was avoided so that this
work is compatible with splicing as well as V2 channel establishment
(dual-funding).

This commit also ensures that `ChannelPending` is only emitted after
peers exchange `tx_signatures`.
We fully persist `InteractiveTxSigningSession` as it provides the full
context of the constructed transaction which is still needed for signing.
When this config field is enabled, the dual_fund feature bit will be
set which determines support when receiving `open_channel2` messages.
@dunxen dunxen force-pushed the 2025-02-interactivesigningstate branch from b3c4f18 to fb00cb6 Compare May 7, 2025 06:17
@dunxen
Copy link
Contributor Author

dunxen commented May 7, 2025

Changes:

git diff-tree -U1 b3c4f18 fb00cb6
diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs
index 5111a5060..66305c042 100644
--- a/lightning/src/ln/channel.rs
+++ b/lightning/src/ln/channel.rs
@@ -6600,4 +6600,4 @@ impl<SP: Deref> FundedChannel<SP> where
        {
-               if self.interactive_tx_signing_session.is_none() ||
-                       matches!(self.context.channel_state, ChannelState::FundingNegotiated(flags) if flags.is_their_tx_signatures_sent())
+               if !self.context.channel_state.is_interactive_signing()
+                       || self.context.channel_state.is_their_tx_signatures_sent()
                {

@dunxen dunxen requested a review from wpaulino May 7, 2025 06:21
@ldk-reviews-bot
Copy link

🔔 1st Reminder

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dual-funding weekly goal Someone wants to land this this week
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants