[4/5]: lnwallet: add new AuxSigner interface to mirror SigPool #8632

Roasbeef · 2024-04-09T02:53:53Z

Depends on #8622.

In this PR, we add a new aux signer interface that's meant to mirror the SigPool. If present, this'll be used to (maybe) obtain signatures for second level HTLCs for certain classes of custom channels.

TODO

merge sigs into existing tlv.Blob on disk for HTLCs

Link to all PRs in the saga:

1/5: [1/?]: multi: add ability to fund+use musig2 channels that commit to a tapscript root #8683
2/5: [2/?]: lnwallet+channeldb: add new AuxLeafStore for dynamic aux leaves #8684
3/5: [3/5]: multi: add new AuxFundingController for custom external funding flows #8622
4/5: [4/5]: lnwallet: add new AuxSigner interface to mirror SigPool #8632
5/5: [5/5]: lnwallet: extensions to aux leaf store to integrate custom channels #8641
6/5: [6/5]: invoice+rpc: add exit hop InvoiceAcceptor sub-systems and RPC calls #8771

coderabbitai · 2024-04-09T02:53:58Z

Important

Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to full the review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2024-04-09T02:54:06Z

Pull reviewers stats

Stats of the last 30 days for lnd:

User	Total reviews	Time to review	Total comments
guggero 🥇	21 ▀▀▀	2d 11h 48m	58 ▀▀▀
ellemouton 🥈	12 ▀▀	1d 22h 6m	20 ▀
bhandras 🥉	9 ▀	30m	0
yyforyongyu	6 ▀	3h 18m	0
Roasbeef	5 ▀	1d 19h 36m	6
ziggie1984	5 ▀	3d 1h 5m	14 ▀
ProofOfKeags	4 ▀	4d 6h 9m ▀	41 ▀▀
GeorgeTsagk	4 ▀	2d 20h 31m	10 ▀
bitromortac	2	13d 3h 49m ▀▀	6
saubyk	2	5h 24m	0
Chinwendu20	2	18d 5h 38m ▀▀	9
positiveblue	1	4d 21h 57m ▀	0
AndySchroder	1	17d 9h 5m ▀▀	4
ffranr	1	14h 10m	4
Crypt-iQ	1	7d 14h 36m ▀	4
dstadulis	1	1d 22h 10m	4
morehouse	1	2d 2h 39m	1
carlaKC	1	12h 2m	0
mohamedawnallah	1	1d 4h 44m	0

guggero · 2024-05-17T12:51:08Z

Included all changes from the PoC branch, ready for first pass review.

GeorgeTsagk

Simple, clean diff ✨

Would be nice to mock the AuxSigner and have some simple tests to verify the htlc sig processing flows & generated ExtraData

Could def make a TODO for when we're done with the saga, or perhaps coverage is introduced in a latter PR so I'll keep an eye on this 👀

LGTM

GeorgeTsagk · 2024-05-23T17:04:36Z

config_builder.go

-
-	// AuxLeafStore is an optional data source that can be used by custom
-	// channels to fetch+store various data.
-	AuxLeafStore fn.Option[lnwallet.AuxLeafStore]


why was this here / being removed now?

This was just in the wrong place, moved it to the AuxComponents sub struct. When we just had a single aux interface it made sense here, as "store" vaguely has something to do with database. But with all the other components it made sense to move everything to its own struct.

lnwallet/channel.go

GeorgeTsagk · 2024-05-23T17:43:20Z

lnwallet/aux_signer.go

+// AuxSigner is an interface that is used to sign and verify HTLCs for custom
+// channels. It is similar to the existing SigPool, but uses opaque blobs to
+// shuffle around signature information and other metadata.
+type AuxSigner interface {


would be nice to mock this and have some minimal test coverage

Added this to the tracking issue, since we currently don't have any coverage for those aux interfaces.

ffranr

LGTM

ffranr · 2024-05-24T11:17:25Z

lnwallet/aux_signer.go

+type BaseAuxJob struct {
+	// OutputIndex is the output index of the HTLC on the commitment
+	// transaction being signed.
+	OutputIndex int32


this should be unsigned int rather than signed?

The value comes from here: https://github.com/lightningnetwork/lnd/blob/a350ccd7/lnwallet/channel.go#L308
So it can actually be negative. Added the same comment here.

lnwallet/commitment.go

In this commit, we add a new aux signer interface that's meant to mirror the SigPool. If present, this'll be used to (maybe) obtain signatures for second level HTLCs for certain classes of custom channels.

In this commit, we start to use the new AuxSigner to obtain+verify aux sigs for all second level HTLCs. This is similar to the existing SigPool, but we'll only attempt to do this if the AuxSigner is present (won't be for most channels).

Roasbeef added the custom chans label Apr 9, 2024

guggero force-pushed the aux-funding branch from da4b505 to bdbfd4c Compare April 24, 2024 13:12

guggero force-pushed the aux-leaf-signing branch 2 times, most recently from 54509a9 to 1858e19 Compare April 24, 2024 15:04

guggero force-pushed the aux-funding branch from bdbfd4c to 17e9758 Compare April 24, 2024 15:04

guggero mentioned this pull request Apr 24, 2024

[5/5]: lnwallet: extensions to aux leaf store to integrate custom channels #8641

Merged

guggero changed the title ~~lnwallet: add new AuxSigner interface to mirror SigPool~~ [4/?]: lnwallet: add new AuxSigner interface to mirror SigPool Apr 24, 2024

guggero force-pushed the aux-leaf-signing branch from 1858e19 to ffa19c0 Compare April 25, 2024 17:06

guggero force-pushed the aux-funding branch from 17e9758 to 4e4ec2b Compare April 25, 2024 17:06

dstadulis assigned guggero Apr 27, 2024

guggero force-pushed the aux-leaf-signing branch from ffa19c0 to 6bd862c Compare April 29, 2024 09:29

guggero force-pushed the aux-funding branch from 4e4ec2b to aaa48ff Compare April 29, 2024 09:29

guggero force-pushed the aux-leaf-signing branch from 6bd862c to ddb5125 Compare April 29, 2024 19:36

guggero force-pushed the aux-funding branch from aaa48ff to a9f9284 Compare April 29, 2024 19:36

guggero force-pushed the aux-leaf-signing branch from ddb5125 to 970ace4 Compare April 30, 2024 14:41

guggero force-pushed the aux-funding branch from a9f9284 to d2fe248 Compare April 30, 2024 14:41

guggero force-pushed the aux-leaf-signing branch 3 times, most recently from 8ed50cf to cfd4314 Compare May 1, 2024 13:53

guggero force-pushed the aux-funding branch from d2fe248 to 8a7167a Compare May 1, 2024 13:55

guggero force-pushed the aux-leaf-signing branch from cfd4314 to e29842a Compare May 14, 2024 07:49

dstadulis mentioned this pull request May 15, 2024

[tracking]: lnd/lnwallet saga lightninglabs/taproot-assets#898

Closed

4 tasks

guggero force-pushed the aux-funding branch 2 times, most recently from fc74f55 to 57adb13 Compare May 17, 2024 11:31

guggero force-pushed the aux-leaf-signing branch from e29842a to 36416dc Compare May 17, 2024 12:05

guggero force-pushed the aux-leaf-signing branch from 36416dc to 2f5bc3e Compare May 17, 2024 12:50

guggero requested review from ffranr and GeorgeTsagk May 17, 2024 12:50

guggero changed the title ~~[4/?]: lnwallet: add new AuxSigner interface to mirror SigPool~~ [4/5]: lnwallet: add new AuxSigner interface to mirror SigPool May 17, 2024

guggero force-pushed the aux-funding branch from 57adb13 to d978f49 Compare May 20, 2024 18:07

guggero force-pushed the aux-leaf-signing branch from 2f5bc3e to c0b5902 Compare May 20, 2024 18:07

guggero force-pushed the aux-funding branch from d978f49 to d43b5f8 Compare May 21, 2024 07:27

guggero force-pushed the aux-leaf-signing branch 2 times, most recently from 6123a1c to e258b87 Compare May 21, 2024 07:46

guggero mentioned this pull request May 22, 2024

[6/5]: invoice+rpc: add exit hop InvoiceAcceptor sub-systems and RPC calls #8771

Merged

guggero force-pushed the aux-leaf-signing branch from e258b87 to 380ba26 Compare May 22, 2024 16:25

guggero force-pushed the aux-funding branch from d43b5f8 to 3a99a28 Compare May 22, 2024 16:25

guggero force-pushed the aux-leaf-signing branch from 380ba26 to adfb663 Compare May 23, 2024 11:38

guggero force-pushed the aux-funding branch from 3a99a28 to 1661c54 Compare May 23, 2024 11:38

GeorgeTsagk approved these changes May 23, 2024

View reviewed changes

ffranr approved these changes May 24, 2024

View reviewed changes

guggero force-pushed the aux-funding branch from 1661c54 to 08b0a97 Compare May 27, 2024 10:41

guggero mentioned this pull request May 27, 2024

tracking: remaining cleanup to address before merging 0-19-staging branch into master #8769

Closed

10 tasks

guggero force-pushed the aux-funding branch from 08b0a97 to a350ccd Compare May 27, 2024 10:59

Roasbeef added 3 commits May 27, 2024 13:02

lnwallet: add new AuxSigner interface to mirror SigPool

d908e8c

In this commit, we add a new aux signer interface that's meant to mirror the SigPool. If present, this'll be used to (maybe) obtain signatures for second level HTLCs for certain classes of custom channels.

lnwallet: add WithAuxSigner option to channel

9b869f9

guggero force-pushed the aux-leaf-signing branch from adfb663 to ebf9856 Compare May 27, 2024 11:04

Base automatically changed from aux-funding to 0-19-staging May 27, 2024 13:26

guggero merged commit 626a1b8 into 0-19-staging May 27, 2024
25 of 27 checks passed

guggero deleted the aux-leaf-signing branch May 27, 2024 13:46

guggero mentioned this pull request May 27, 2024

[tracking]: Ensure AuxFundingController functionality meets tap deliverables / needs lightninglabs/taproot-assets#872

Closed

dstadulis mentioned this pull request Jul 16, 2024

[tracking]: merge custom-channel features into lnd and litd lightninglabs/taproot-assets#1027

Closed

guggero mentioned this pull request Aug 9, 2024

[custom channels 5/5]: merge custom channel staging branch into master #8960

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[4/5]: lnwallet: add new AuxSigner interface to mirror SigPool #8632

[4/5]: lnwallet: add new AuxSigner interface to mirror SigPool #8632

Roasbeef commented Apr 9, 2024 •

edited by guggero

Loading

coderabbitai bot commented Apr 9, 2024 •

edited

Loading

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Apr 9, 2024

guggero commented May 17, 2024

GeorgeTsagk left a comment

GeorgeTsagk May 23, 2024

guggero May 24, 2024 •

edited

Loading

GeorgeTsagk May 23, 2024

guggero May 27, 2024

ffranr left a comment

ffranr May 24, 2024

guggero May 27, 2024 •

edited

Loading

[4/5]: lnwallet: add new AuxSigner interface to mirror SigPool #8632

[4/5]: lnwallet: add new AuxSigner interface to mirror SigPool #8632

Conversation

Roasbeef commented Apr 9, 2024 • edited by guggero Loading

TODO

coderabbitai bot commented Apr 9, 2024 • edited Loading

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Apr 9, 2024

Pull reviewers stats

guggero commented May 17, 2024

GeorgeTsagk left a comment

Choose a reason for hiding this comment

GeorgeTsagk May 23, 2024

Choose a reason for hiding this comment

guggero May 24, 2024 • edited Loading

Choose a reason for hiding this comment

GeorgeTsagk May 23, 2024

Choose a reason for hiding this comment

guggero May 27, 2024

Choose a reason for hiding this comment

ffranr left a comment

Choose a reason for hiding this comment

ffranr May 24, 2024

Choose a reason for hiding this comment

guggero May 27, 2024 • edited Loading

Choose a reason for hiding this comment

Roasbeef commented Apr 9, 2024 •

edited by guggero

Loading

coderabbitai bot commented Apr 9, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

guggero May 24, 2024 •

edited

Loading

guggero May 27, 2024 •

edited

Loading