routing: assume TLV onion feature bit #8791

ellemouton · 2024-05-29T20:32:09Z

In this PR, we start assuming that hops on a path all support TLV onion encoding.

This PR is the bare minimum. It does not completely remove the Hop.LegacyPayload member since we do still use this for deserialising persisted Hops for an HTLC attempt. So there is a chance that we have some on disk. And since we do have cases where we assume hops only support legacy encoding (either we did not receive their node announcement or we received chained hop hints in an invoice) the chances of this being the case are not that small. So some discussion/thought is perhaps needed around how we can handle this.

The other thing we could potentially add to this PR is the removal of --protocol.legacy.onion

We already no longer read the TlvPayload boolean in SendToRouteReq.Hop so we could potentially remove this or warn the user if they are setting this to false that it is being ignored.

Fixes: #8785

coderabbitai · 2024-05-29T20:32:15Z

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

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.

bhandras

LGTM 🥇

routing/pathfind_test.go

ellemouton

Thanks @bhandras ! 🥛

routing/pathfind_test.go

lightninglabs-deploy · 2024-06-18T21:41:39Z

@yyforyongyu: review reminder

yyforyongyu

Needs a rebase, otherwise LGTM🦾

routing/pathfind_test.go

yyforyongyu · 2024-06-24T13:30:33Z

routing/route/route.go

+	// NOTE: we should no longer ever create a Hop with Legacy set to true.
+	// The only reason we are keeping this member is that it could be the
+	// case that we have serialised hops persisted to disk where
+	// LegacyPayload is true.


wonder when can we remove this completely🤔

I think we'd be able to do it quite soon. Afaict, we only serialise these for active payments & also for mission control. But for MC, we dont actually need this: so we should remove encoding all of this stuff for MC anyways and then for the payment scenario: as soon as no active payments have this anymore, we can remove it. So I think people just need to run this version for a bit (where no new legacy stuff gets persisted) and then after a few releases, we can just remove it.

ellemouton

Thanks @yyforyongyu ! 🚀

ellemouton · 2024-06-24T17:01:03Z

routing/route/route.go

+	// NOTE: we should no longer ever create a Hop with Legacy set to true.
+	// The only reason we are keeping this member is that it could be the
+	// case that we have serialised hops persisted to disk where
+	// LegacyPayload is true.


I think we'd be able to do it quite soon. Afaict, we only serialise these for active payments & also for mission control. But for MC, we dont actually need this: so we should remove encoding all of this stuff for MC anyways and then for the payment scenario: as soon as no active payments have this anymore, we can remove it. So I think people just need to run this version for a bit (where no new legacy stuff gets persisted) and then after a few releases, we can just remove it.

JssDWt · 2024-06-25T07:26:10Z

Tested with the test setup described in #8785, it fixes the issue.

ellemouton · 2024-06-25T18:55:37Z

awesome - thanks for testing @JssDWt 🚀

saubyk assigned ellemouton Jun 3, 2024

saubyk added the tlv label Jun 3, 2024

saubyk added this to the v0.18.1 milestone Jun 3, 2024

saubyk requested review from bhandras and yyforyongyu June 11, 2024 16:41

bhandras approved these changes Jun 11, 2024

View reviewed changes

routing/pathfind_test.go Show resolved Hide resolved

routing/pathfind_test.go Outdated Show resolved Hide resolved

routing/pathfind_test.go Show resolved Hide resolved

ellemouton force-pushed the assumeTLV branch from edb042a to 621e221 Compare June 11, 2024 20:54

ellemouton commented Jun 11, 2024

View reviewed changes

routing/pathfind_test.go Show resolved Hide resolved

routing/pathfind_test.go Outdated Show resolved Hide resolved

ellemouton force-pushed the assumeTLV branch from 6f7b11e to 8f0a5d7 Compare June 18, 2024 23:21

yyforyongyu approved these changes Jun 24, 2024

View reviewed changes

ellemouton added 3 commits June 24, 2024 10:01

routing: assume TLV onion during path finding

738253f

routing: assume TLV onion during route construction

99b3c57

docs: add release notes entry

738206f

ellemouton force-pushed the assumeTLV branch from 8f0a5d7 to 738206f Compare June 24, 2024 17:01

ellemouton commented Jun 24, 2024

View reviewed changes

ellemouton merged commit 6b64703 into lightningnetwork:master Jun 24, 2024
27 of 33 checks passed

ellemouton deleted the assumeTLV branch June 24, 2024 18:03

ellemouton mentioned this pull request Jun 24, 2024

[1/4] Route Blinding Receives: Groundwork #8752

Merged

ellemouton mentioned this pull request Jun 26, 2024

routing: remove left over TLV feature bit checks #8874

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

routing: assume TLV onion feature bit #8791

routing: assume TLV onion feature bit #8791

ellemouton commented May 29, 2024 •

edited

Loading

coderabbitai bot commented May 29, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

bhandras left a comment

ellemouton left a comment

lightninglabs-deploy commented Jun 18, 2024

yyforyongyu left a comment

yyforyongyu Jun 24, 2024

ellemouton Jun 24, 2024

ellemouton left a comment

ellemouton Jun 24, 2024

JssDWt commented Jun 25, 2024

ellemouton commented Jun 25, 2024

routing: assume TLV onion feature bit #8791

routing: assume TLV onion feature bit #8791

Conversation

ellemouton commented May 29, 2024 • edited Loading

coderabbitai bot commented May 29, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

bhandras left a comment

Choose a reason for hiding this comment

ellemouton left a comment

Choose a reason for hiding this comment

lightninglabs-deploy commented Jun 18, 2024

yyforyongyu left a comment

Choose a reason for hiding this comment

yyforyongyu Jun 24, 2024

Choose a reason for hiding this comment

ellemouton Jun 24, 2024

Choose a reason for hiding this comment

ellemouton left a comment

Choose a reason for hiding this comment

ellemouton Jun 24, 2024

Choose a reason for hiding this comment

JssDWt commented Jun 25, 2024

ellemouton commented Jun 25, 2024

ellemouton commented May 29, 2024 •

edited

Loading

coderabbitai bot commented May 29, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)