Skip to content
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

multi: generate and pass along HTLC resolution blobs for aux channels #9194

Open
wants to merge 12 commits into
base: 0-18-4-branch-rc1
Choose a base branch
from

Conversation

Roasbeef
Copy link
Member

In this commit, we remove the old blockers on aux channel HTLC resolver logic. In place, we utilize a new set of aux blobs obtained from the AuxContractResolver to generate blobs that contain everything needed to resolve an aux HTLC. This information is now stored on disk in the cnct within the taproot briefcase. Each time we go to have the sweeper handle an HTLC output, we'll now pass along the blob along side, just like we do for the commitment outputs. Finally, we add a new Preimage method to the input.Input interface. As the preimage may only be known after the fact (reveal by peer on/off chain), we need a way to give the AuxSweeer a way to obtain the preimage to complete any final witnesses.

Copy link

Pull reviewers stats

Stats of the last 30 days for lnd:

User Total reviews Time to review Total comments
guggero
🥇
8
▀▀
3h 5m
4
Roasbeef
🥈
6
2d 2h 11m
17
▀▀
ziggie1984
🥉
6
1d 7h 24m
22
▀▀
bhandras
5
35m
1
yyforyongyu
5
1d 23h 37m
10
ellemouton
4
2d 23h 3m
8
ProofOfKeags
3
23h 7m
18
▀▀
bitromortac
3
12h 4m
0
dstadulis
2
3d 4h 6m
2
saubyk
2
7d 19h 17m
▀▀▀
4
ViktorTigerstrom
1
3d 15h 2m
1
GeorgeTsagk
1
2h 19m
0
calvinrzachman
1
2d 2h 39m
6
carlaKC
1
1h 27m
0

Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • llm-review

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using 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 do a full 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 configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@Roasbeef Roasbeef changed the base branch from 0-19-staging to 0-18-4-branch-rc1 October 23, 2024 23:00
@Roasbeef Roasbeef changed the base branch from 0-18-4-branch-rc1 to master November 9, 2024 00:29
@Roasbeef Roasbeef marked this pull request as ready for review November 9, 2024 00:29
@Roasbeef Roasbeef changed the base branch from master to 0-18-4-branch-rc1 November 9, 2024 00:38
Copy link
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Very clean PR! Looks very good, changes are quite easy to follow.

lnwallet/channel.go Outdated Show resolved Hide resolved
@Roasbeef Roasbeef force-pushed the aux-channel-htlc branch 3 times, most recently from 18eaebb to 59c072b Compare November 12, 2024 02:52
Copy link
Member

@yyforyongyu yyforyongyu left a comment

Choose a reason for hiding this comment

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

Straightforward PR, this it's good to go once the unit tests are fixed - weird FuzzReplyChannelRange is failing...

lnwallet/channel.go Outdated Show resolved Hide resolved
sweep/tx_input_set.go Show resolved Hide resolved
#
v0.4.8#15807814492030881602
0x5555555555555
0x0
Copy link
Member

Choose a reason for hiding this comment

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

So all the fields are empty?

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmm, not sure quite how to interpret the output.

The cases get added when somethings fails in the past, so this way even though the tests are randomized we make sure that we never fail an old test case.

@Roasbeef
Copy link
Member Author

Not sure what to make of the test failure to FuzzReplyChannelRange. Nothing in this PR touches anything related to that...

In this commit, we add some additional attributes to the ResolutionReq
struct. These will be used to make sure that we can properly handle all
the HTLC variants, on chain.

The `AuxSigDesc` will be used to communicate if an HTLC needs to go to
the second level or not. It contains the second-level sig information
needed to finalize a broadcast to the second level.
Similar to the other blobs we have for the commitment output force close
resolution, these blobs will be used to ensure that we have everything
needed to sweep aux HTLCs.
…ions

In this commit, we populate the resolution blobs for the incoming and
outgoing HTLCs. We take care to populate the AuxSigDesc with the correct
information, as we need to pass along the second-level aux signature and
also sign desc along with it.
In this commit, we add a new method to obtain an option of a preimage to
the input.Input struct. This is useful for callers that have an Input,
and want to optionally obtain the preimage.
In this commit, we add the set of HtlcBlobs to the taprootBriefcase
struct. This new field will store all the resolution blobs for a given
HTLC. We also add some new property based tests along the way for
adequate test coverage.
When we read/write the aux data, we need to make sure we always set the
new fields for aux HTLCs.
With this commit, we update all the resolvers to pass in the new htlc
resolution blobs. Along the way, we remove the old blocking guard on
this resolution logic for HTLCs with blobs.
In this commit, we expand the `NotifyBroadcast` to include an outpoint
index. This is useful as it indicates the index of a given required tx
out input.
This is useful for additional context to know which commit the
AuxLeafStore is fetching the leaves for.
In this commit, we update the `Budget()` call to factor in the
`extraBudget` value. Otherwise, when we go to intialize the fee
function, we won't factor in the extra budget, and will determine that
we can't broadcast/bump.
Copy link
Member

@yyforyongyu yyforyongyu left a comment

Choose a reason for hiding this comment

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

Not sure what to make of the test failure to FuzzReplyChannelRange. Nothing in this PR touches anything related to that...

Looks like it's introduced in this PR where we started to use a default value instead of empty. Maybe we do a rebase on master and it will go away...

HtlcID: fn.Some(htlc.HtlcIndex),
PayHash: fn.Some(htlc.RHash),
AuxSigDesc: fn.Some(AuxSigDesc{
SignDetails: *txSignDetails,
Copy link
Member

Choose a reason for hiding this comment

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

think this is causing the panic in the unit test - the txSignDetails is nil here - maybe we should check it against nil and return an error if there're no signing details?

@guggero
Copy link
Collaborator

guggero commented Nov 13, 2024

Not sure what to make of the test failure to FuzzReplyChannelRange. Nothing in this PR touches anything related to that...

I think we might need #9082 to be added to the 0-18-4-branch-rc1. Will try that out today.

EDIT: Yes, needed to add #9082 and #9084 to fix the fuzz tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants