Interactive TX negotiation tracks shared outputs #2989

optout21 · 2024-04-10T09:12:47Z

Interactive TX negotiation now tracks the shared funding output. This allows for better checks, better contribution verification.
Shared inputs are not included, those are splicing-specific, shall be done later.
Besed on 36e7452 by @dunxen .

One notable change is that local/remote contribution are not computed by filtering by serial_id and adding values, but summing local/remote values across all inputs/outputs (i.e. in build_transaction() https://github.com/lightningdevkit/rust-lightning/pull/2989/files#diff-c92e994fd9949ebcb6a8d9ec76553e8497ee223b707b51905e35017b80124c77R467).

~~Housekeeping: this should come after #2981~~

codecov-commenter · 2024-04-10T09:20:32Z

Codecov Report

Attention: Patch coverage is 95.77465% with 24 lines in your changes are missing coverage. Please review.

Project coverage is 91.11%. Comparing base (0e22b12) to head (02a8244).
Report is 94 commits behind head on main.

Files	Patch %	Lines
lightning/src/ln/interactivetxs.rs	95.77%	18 Missing and 6 partials ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2989      +/-   ##
==========================================
+ Coverage   89.15%   91.11%   +1.96%     
==========================================
  Files         118      118              
  Lines       97678   107009    +9331     
  Branches    97678   107009    +9331     
==========================================
+ Hits        87080    97496   +10416     
+ Misses       8357     7145    -1212     
- Partials     2241     2368     +127

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

lightning/src/ln/interactivetxs.rs

optout21 · 2024-04-16T20:34:06Z

Changed NegotiationContext to store local and remote inputs/output in separate vectors (in separate commit for now)

dunxen · 2024-04-23T08:47:49Z

Changed NegotiationContext to store local and remote inputs/output in separate vectors (in separate commit for now)

Sorry about this, but I've reverted this in #2981 as there just ended up being too much cloning going around. I believe we will still be fine with the splicing additions here to have single maps for inputs/outputs.

Edit: I've also removed the minimal splicing specific stuff from #2981 so that all that can be done atomically in this PR. See: #2981 (comment).

Basically just removed the to_remote_value_satoshis and the check which wasn't necessarily complete for both splice in and out. So if you rebase and see that then just take note why it was removed.

So a PR title change might be appropriate here.

Thanks! 🙏

optout21 · 2024-04-24T15:44:38Z

Rebased after merge of #2981 .

dunxen

Apologies for the delay. I've done some initial review and so far LGTM. Did you want to tackle splicing calculations in a separate PR? I was thinking it would be okay to do that here and track the shared inputs too. Or do imagine that to be quite involved and more than a few extra commits?

Either way this looks good to take out of draft if you're happy and I'll give it another round once you're happy 🙂

lightning/src/ln/interactivetxs.rs

optout21 · 2024-05-02T06:11:07Z

Apologies for the delay. I've done some initial review and so far LGTM. Did you want to tackle splicing calculations in a separate PR? I was thinking it would be okay to do that here and track the shared inputs too. Or do imagine that to be quite involved and more than a few extra commits?

With current state of splicing work, I still don't see exactly the way (and the need) to track the shared output, so I would defer that to the time splicing is added.

optout21 · 2024-05-02T06:12:21Z

Folded in proposed comment changes; marked ready for review.

dunxen · 2024-05-02T06:36:34Z

Folded in proposed comment changes; marked ready for review.

Thanks. I'll give this another look over today.

lightning/src/ln/interactivetxs.rs

dunxen

LGTM. I'm currently writing some more tests at the channelmanager-level to cover some more interesting funding cases.

Looking forward to rebasing on this.

lightning/src/ln/interactivetxs.rs

optout21 · 2024-05-10T09:40:29Z

Made some smaller changes according to review comments.

optout21 · 2024-05-10T09:47:50Z

The last review questions made me thinking, if the API can be made more straightforward.

The user of the InteractiveTxConstructor has to supply the provided outputs (TxOut's), plus it has to provide the script pubkey of the expected shared output (one of the outputs), and its contribution from that. This setup has a few easy places for inconsistency.

Maybe it would be better to wrap the provided outputs in an enum, for different types:

shared output, but its value belonging entirely to initiator (typical funding output)
shared output, with partial value belonging initiator (this value has to be provided, this is a less typical case)
output belonging to initiator (e.g. change)

Additionally, for the infrequent case when we don't specify any outputs, but expect a shared output and some balance belonging to us, an optional (pubkey+localvalue) should be provided.

Maybe this way the API would be easier to understand.
I put the PR back to Draft, for a 2nd thought.

TheBlueMatt · 2024-05-13T19:16:13Z

Rather than pushing type info upstream, maybe we should have simpler (public) constructors for the InteractiveTxConstructor that are context-specific? ie InteractiveTxConstructor::for_splicing and InteractiveTxConstructor::for_dual_funding are kinda separate things, and could use separate constructors. That would simplify the public interface without adding more types for callers to keep track of.

optout21 · 2024-05-13T21:52:42Z

Reworked:

In the InteractiveTxConstructor::new(), the type of the contributed outputs has to be specified -- controlled by local node, shared output but all belongs to the local node, or shared output with joint ownership (split).
Additional expected shared output script has to be specified only in the rare case when the local node does not add a shared output, but expects the remote node to add a joint-owned shared output.

optout21 · 2024-05-13T22:30:31Z

Rather than pushing type info upstream, maybe we should have simpler (public) constructors for the InteractiveTxConstructor that are context-specific? ie InteractiveTxConstructor::for_splicing and InteractiveTxConstructor::for_dual_funding are kinda separate things, and could use separate constructors.

Good idea, though this version aims at dual funding only (only funding outputs), splicing is not considered in this PR

lightning/src/ln/interactivetxs.rs

dunxen · 2024-05-21T14:23:15Z

I've been writing some new tests for #2302 and have encountered some issues due to not tracking the shared output within the constructor and when validating the constructed tx, so this PR is a little bit of a blocker for 2302. I'll integrate these changes for now though so I can carry on with the new tests. :)

TheBlueMatt

Sorry for the delay here :(

lightning/src/ln/interactivetxs.rs

optout21 · 2024-06-18T13:37:24Z

Addressed review comments (sorry, they fall of my priority table...).

Remaining outstanding:

~~rebase~~
whether there should be a check in validate_tx for the existence of a shared output

optout21 · 2024-06-20T10:59:42Z

Did remaining changes:

Add check for missing funding output in validate_tx()
Make expected_shared_funding_output mandatory in NegotiationContext, as suggested by @TheBlueMatt . In InteractiveTxConstructor either a shared output has to be provided, or a pubkey for the shared output to be added by the remote.

dunxen

Just some comment nits, but LGTM. I believe this needs to be formatted with rustfmt as it's not excluded.

lightning/src/ln/interactivetxs.rs

optout21 · 2024-06-20T15:29:54Z

Did formatting, plus 2 minor comment wording change (review).

optout21 · 2024-06-27T08:21:51Z

If this is merged before #3137, these interactivetx.rs changes will disappear from #3137 diff. That would make sense, as this PR has been mostly reviewed already.

dunxen · 2024-06-27T08:34:34Z

If this is merged before #3137, these interactivetx.rs changes will disappear from #3137 diff. That would make sense, as this PR has been mostly reviewed already.

Yip, that's the plan. I just cherry-picked this.

dunxen · 2024-06-27T08:37:16Z

Since this only affects interactivetxs.rs, I'm going to go ahead and merge this and any other nits/issues can be addressed in a follow-up. Then that should unblock 3137.

TheBlueMatt

Post-merge ACK, but a few nits.

TheBlueMatt · 2024-06-27T15:19:46Z

lightning/src/ln/interactivetxs.rs

+				},
+				OutputOwned::Shared(output) => {
+					// Sanity check
+					if output.local_owned > output.tx_out.value.to_sat() {


This should be >=, right (as = should have gone through SharedControlFullyOwned)?

TheBlueMatt · 2024-06-27T15:33:18Z

lightning/src/ln/interactivetxs.rs

+/// its ownership -- value fully owned by the adder or jointly
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub enum OutputOwned {
+	/// Belongs to local node -- controlled exclusively and fully belonging to local node


This is wrong, right? Single maybe be owned by the counterparty, depending on where its stored.

TheBlueMatt · 2024-06-27T15:37:47Z

lightning/src/ln/interactivetxs.rs

+}
+
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub struct InteractiveTxOutput {


There's no reason for this to be pub, right? Its an internal abstraction.

TheBlueMatt · 2024-06-27T15:38:37Z

lightning/src/ln/interactivetxs.rs

+}
+
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub enum InteractiveTxInput {


There's no reason for this to be pub, right? Its an internal abstraction.

Looks like visibility could be reduced indeed. I will check in the wider scope where this class is actually used.
These are used in ConstructedTransaction, which is pub(crate).

Sounds good, thanks. A followup reducing visibility of the nits here would be much appreciated.

optout21 force-pushed the iatx-shared-output branch from b20679f to 50dce76 Compare April 10, 2024 09:22

dunxen reviewed Apr 15, 2024

View reviewed changes

lightning/src/ln/interactivetxs.rs Show resolved Hide resolved

optout21 force-pushed the iatx-shared-output branch from ef18e92 to ae57869 Compare April 18, 2024 06:05

dunxen mentioned this pull request Apr 23, 2024

Fixups for #2419 #2981

Merged

optout21 closed this Apr 24, 2024

optout21 force-pushed the iatx-shared-output branch from ae57869 to eaf76f6 Compare April 24, 2024 15:37

optout21 reopened this Apr 24, 2024

dunxen reviewed Apr 29, 2024

View reviewed changes

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

optout21 force-pushed the iatx-shared-output branch from e43786c to 0cf4681 Compare May 2, 2024 06:09

optout21 marked this pull request as ready for review May 2, 2024 06:12

TheBlueMatt reviewed May 6, 2024

View reviewed changes

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

TheBlueMatt reviewed May 6, 2024

View reviewed changes

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

optout21 force-pushed the iatx-shared-output branch from 0cf4681 to 83f7845 Compare May 7, 2024 12:52

dunxen previously approved these changes May 7, 2024

View reviewed changes

TheBlueMatt reviewed May 8, 2024

View reviewed changes

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

optout21 dismissed dunxen’s stale review via 9869e48 May 10, 2024 09:17

optout21 force-pushed the iatx-shared-output branch from 83f7845 to 9869e48 Compare May 10, 2024 09:17

optout21 marked this pull request as draft May 10, 2024 09:40

optout21 force-pushed the iatx-shared-output branch from 9869e48 to 02a8244 Compare May 13, 2024 21:49

optout21 marked this pull request as ready for review May 13, 2024 21:54

optout21 requested a review from dunxen May 14, 2024 12:48

dunxen previously approved these changes May 20, 2024

View reviewed changes

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

TheBlueMatt reviewed May 28, 2024

View reviewed changes

dunxen mentioned this pull request Jun 6, 2024

Dual-funded channels and Splicing Project Tracking #1621

Open

6 tasks

optout21 dismissed dunxen’s stale review via 85350fe June 18, 2024 13:21

optout21 force-pushed the iatx-shared-output branch from 02a8244 to 85350fe Compare June 18, 2024 13:21

optout21 marked this pull request as draft June 18, 2024 15:38

optout21 force-pushed the iatx-shared-output branch 3 times, most recently from 3163ffc to 6a2d787 Compare June 20, 2024 10:57

optout21 marked this pull request as ready for review June 20, 2024 10:59

dunxen reviewed Jun 20, 2024

View reviewed changes

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

lightning/src/ln/interactivetxs.rs Outdated Show resolved Hide resolved

Interactive TX negotiation tracks shared outputs

80eb5ce

optout21 force-pushed the iatx-shared-output branch from 6a2d787 to 80eb5ce Compare June 20, 2024 15:29

dunxen approved these changes Jun 20, 2024

View reviewed changes

optout21 requested a review from TheBlueMatt June 22, 2024 00:27

optout21 mentioned this pull request Jun 26, 2024

Implement accepting dual-funded channels without contributing #3137

Open

dunxen merged commit cb08498 into lightningdevkit:main Jun 27, 2024
16 checks passed

TheBlueMatt reviewed Jun 27, 2024

View reviewed changes

TheBlueMatt mentioned this pull request Jul 11, 2024

#2989 Followups #3170

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Interactive TX negotiation tracks shared outputs #2989

Interactive TX negotiation tracks shared outputs #2989

optout21 commented Apr 10, 2024 •

edited

Loading

codecov-commenter commented Apr 10, 2024 •

edited

Loading

optout21 commented Apr 16, 2024

dunxen commented Apr 23, 2024 •

edited

Loading

optout21 commented Apr 24, 2024

dunxen left a comment

optout21 commented May 2, 2024

optout21 commented May 2, 2024

dunxen commented May 2, 2024

dunxen left a comment

optout21 commented May 10, 2024

optout21 commented May 10, 2024

TheBlueMatt commented May 13, 2024

optout21 commented May 13, 2024

optout21 commented May 13, 2024

dunxen commented May 21, 2024

TheBlueMatt left a comment

optout21 commented Jun 18, 2024 •

edited

Loading

optout21 commented Jun 20, 2024

dunxen left a comment

optout21 commented Jun 20, 2024

optout21 commented Jun 27, 2024

dunxen commented Jun 27, 2024

dunxen commented Jun 27, 2024

TheBlueMatt left a comment

TheBlueMatt Jun 27, 2024

TheBlueMatt Jun 27, 2024

TheBlueMatt Jun 27, 2024

TheBlueMatt Jun 27, 2024

optout21 Jun 27, 2024

TheBlueMatt Jul 8, 2024

Interactive TX negotiation tracks shared outputs #2989

Interactive TX negotiation tracks shared outputs #2989

Conversation

optout21 commented Apr 10, 2024 • edited Loading

codecov-commenter commented Apr 10, 2024 • edited Loading

Codecov Report

optout21 commented Apr 16, 2024

dunxen commented Apr 23, 2024 • edited Loading

optout21 commented Apr 24, 2024

dunxen left a comment

Choose a reason for hiding this comment

optout21 commented May 2, 2024

optout21 commented May 2, 2024

dunxen commented May 2, 2024

dunxen left a comment

Choose a reason for hiding this comment

optout21 commented May 10, 2024

optout21 commented May 10, 2024

TheBlueMatt commented May 13, 2024

optout21 commented May 13, 2024

optout21 commented May 13, 2024

dunxen commented May 21, 2024

TheBlueMatt left a comment

Choose a reason for hiding this comment

optout21 commented Jun 18, 2024 • edited Loading

optout21 commented Jun 20, 2024

dunxen left a comment

Choose a reason for hiding this comment

optout21 commented Jun 20, 2024

optout21 commented Jun 27, 2024

dunxen commented Jun 27, 2024

dunxen commented Jun 27, 2024

TheBlueMatt left a comment

Choose a reason for hiding this comment

TheBlueMatt Jun 27, 2024

Choose a reason for hiding this comment

TheBlueMatt Jun 27, 2024

Choose a reason for hiding this comment

TheBlueMatt Jun 27, 2024

Choose a reason for hiding this comment

TheBlueMatt Jun 27, 2024

Choose a reason for hiding this comment

optout21 Jun 27, 2024

Choose a reason for hiding this comment

TheBlueMatt Jul 8, 2024

Choose a reason for hiding this comment

optout21 commented Apr 10, 2024 •

edited

Loading

codecov-commenter commented Apr 10, 2024 •

edited

Loading

dunxen commented Apr 23, 2024 •

edited

Loading

optout21 commented Jun 18, 2024 •

edited

Loading