Skip to content

fix: use second routing hint in MRH #975

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

Merged
merged 1 commit into from
Jun 23, 2025
Merged

fix: use second routing hint in MRH #975

merged 1 commit into from
Jun 23, 2025

Conversation

michael1011
Copy link
Member

@michael1011 michael1011 commented Jun 23, 2025

The probing logic of LND assumes that the first node of the routing hint is a LSP (and probes that node) if all route hints have the same first node. We trick that heuristic by adding a second routing hint with a different public key when we add a magic routing hint to the invoice.

Summary by CodeRabbit

  • New Features
    • Enhanced routing hints to include an additional entry for improved compatibility with Lightning Network payments.
  • Tests
    • Updated test cases to verify the presence of the new routing hint in relevant scenarios.

The probing logic of LND assumes that the first node of the routing hint
is a LSP (and probes that node) if all route hints have the same first
node. We trick that heuristic by adding a second routing hint with a
different public key when we add a magic routing hint to the invoice.
Copy link

coderabbitai bot commented Jun 23, 2025

Walkthrough

The ReverseRoutingHints class's internal method was updated to return an additional, intentionally "useless" routing hint to influence LND's routing behavior. Corresponding unit tests were modified to account for this extra routing hint, ensuring test expectations match the new output.

Changes

File(s) Change Summary
lib/swap/ReverseRoutingHints.ts Modified encodeRoutingHint to append a second, "useless" routing hint to the returned array.
test/unit/swap/ReverseRoutingHints.spec.ts Updated tests to include the new fake routing hint in expected outputs for relevant cases.

Poem

In the warren of routes, a trickster appears,
A second hint hops in, to fool all our peers.
The tests now expect this extra disguise,
Two hints in the basket, a bunny surprise!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-23T17_49_28_429Z-debug-0.log

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
lib/swap/ReverseRoutingHints.ts (1)

143-154: Implementation correctly addresses LND probing issue.

The addition of a second routing hint with different parameters effectively prevents LND from assuming all route hints belong to the same LSP. The hard-coded values serve their purpose as a "decoy" hint.

Consider documenting the specific hard-coded values used (nodeId, chanId, fee parameters) to ensure they remain appropriate over time and don't accidentally conflict with real network nodes.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f565cba and 3839411.

📒 Files selected for processing (2)
  • lib/swap/ReverseRoutingHints.ts (1 hunks)
  • test/unit/swap/ReverseRoutingHints.spec.ts (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: build (ubuntu-latest, 20, stable)
  • GitHub Check: build-rust (ubuntu-latest, 20, stable)
  • GitHub Check: build-rust (ubuntu-latest, 20, stable)
  • GitHub Check: build (ubuntu-latest, 20, stable)
🔇 Additional comments (3)
test/unit/swap/ReverseRoutingHints.spec.ts (3)

6-6: Import correctly added for test dependencies.

The import of transactionToLndScid is needed for the fakeRoutingHint constant definition.


20-29: Test constant matches implementation values.

The fakeRoutingHint constant correctly mirrors the second routing hint added in the implementation, ensuring test accuracy.


150-150: Tests properly updated for dual routing hints.

The test expectations correctly include both the original routing hint and the new fakeRoutingHint, ensuring comprehensive coverage of the updated functionality.

Also applies to: 223-223

@@ -140,6 +140,17 @@ class ReverseRoutingHints {
feeProportionalMillionths: 21,
},
],
// Useless hint to trick LND into thinking the MRH is not an LSP
Copy link
Member

Choose a reason for hiding this comment

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

could do a const here

Copy link
Member Author

@michael1011 michael1011 Jun 23, 2025

Choose a reason for hiding this comment

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

In case the return value is changed in wherever it being used, it would change the values in the const object. Not sure if our gRPC transformations are destructive, so I create a new object every time

@michael1011 michael1011 merged commit dd8fa94 into master Jun 23, 2025
5 checks passed
@michael1011 michael1011 deleted the mrh-lsp-fix branch June 23, 2025 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants