Skip to content

[WIP] loop-ins: fix route hints passing, add test coverage#1122

Open
starius wants to merge 4 commits intolightninglabs:masterfrom
starius:addinvoice-coverage
Open

[WIP] loop-ins: fix route hints passing, add test coverage#1122
starius wants to merge 4 commits intolightninglabs:masterfrom
starius:addinvoice-coverage

Conversation

@starius
Copy link
Copy Markdown
Collaborator

@starius starius commented Apr 15, 2026

Include lightninglabs/lndclient#268

Pull Request Checklist

  • Update release_notes.md if your PR contains major features, breaking changes or bugfixes

Include lightninglabs/lndclient#268
Preserve AddInvoiceData fields across invoice wrappers

TODO: remove go replace.
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses an issue where route hints were being dropped during the loop-in swap invoice creation process. By updating the test infrastructure to properly handle and verify route hints, the changes ensure that these hints are correctly propagated, improving the reliability of loop-in payments. The PR also includes new test cases to prevent future regressions in this area.

Highlights

  • Route Hint Propagation: Updated the invoice creation logic in test mocks to correctly include and propagate route hints, ensuring they are preserved in loop-in swap invoices.
  • Test Coverage: Added new regression tests, 'TestLoopInSwapInvoiceRouteHintsMatchProbe' and 'TestInitHtlcActionPreservesRouteHints', to verify that route hints are correctly handled in both standard and static-address loop-in scenarios.
  • Dependency Update: Updated the 'lndclient' dependency to a custom fork to support the necessary changes for route hint passing.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@starius starius requested a review from hieblmi April 15, 2026 00:03
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the lndclient dependency to a fork and introduces regression tests to ensure that route hints are correctly preserved in loop-in invoices for both standard and static-address swaps. The changes include updates to test mocks to support route hint encoding in generated invoices. Review feedback suggests improving test context management by using t.Context() and deduplicating the requireRouteHintsEqual helper function by moving it to a shared utility package.

Comment thread loopin_test.go Outdated
req := testLoopInRequest
req.RouteHints = testLoopInRouteHints()

_, err := newLoopInSwap(context.Background(), cfg, 600, &req)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Use t.Context() instead of context.Background() to ensure the context is properly managed by the test runner. This provides automatic cancellation if the test times out and is the recommended practice for Go 1.24+.

Suggested change
_, err := newLoopInSwap(context.Background(), cfg, 600, &req)
_, err := newLoopInSwap(t.Context(), cfg, 600, &req)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Fixed

Comment thread loopin_test.go Outdated
Comment on lines +308 to +335
func requireRouteHintsEqual(t *testing.T, expected, actual [][]zpay32.HopHint) {
t.Helper()

require.Len(t, actual, len(expected))

for i := range expected {
require.Len(t, actual[i], len(expected[i]))

for j := range expected[i] {
expectedHint := expected[i][j]
actualHint := actual[i][j]

require.Equal(
t,
expectedHint.NodeID.SerializeCompressed(),
actualHint.NodeID.SerializeCompressed(),
)
require.Equal(t, expectedHint.ChannelID, actualHint.ChannelID)
require.Equal(t, expectedHint.FeeBaseMSat,
actualHint.FeeBaseMSat)
require.Equal(t,
expectedHint.FeeProportionalMillionths,
actualHint.FeeProportionalMillionths)
require.Equal(t, expectedHint.CLTVExpiryDelta,
actualHint.CLTVExpiryDelta)
}
}
}
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The requireRouteHintsEqual helper function is duplicated in staticaddr/loopin/actions_test.go. Consider moving it to a shared test utility package (e.g., github.com/lightninglabs/loop/test) to improve maintainability and follow the DRY (Don't Repeat Yourself) principle.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Fixed

Comment thread staticaddr/loopin/actions_test.go Outdated
loopIn: loopIn,
}

event := f.InitHtlcAction(context.Background(), nil)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Use t.Context() instead of context.Background() for consistency with other tests in this file (e.g., line 33) and to ensure proper context lifecycle management during the test execution.

Suggested change
event := f.InitHtlcAction(context.Background(), nil)
event := f.InitHtlcAction(t.Context(), nil)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Fixed

@starius starius force-pushed the addinvoice-coverage branch from c6644b2 to 3e6cb16 Compare April 15, 2026 05:41
@starius starius marked this pull request as ready for review April 15, 2026 06:43
Copy link
Copy Markdown
Collaborator

@hieblmi hieblmi left a comment

Choose a reason for hiding this comment

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

LGTM, pending go.mod replace after lndclient is merged.

Comment thread go.mod

replace github.com/lightninglabs/loop/looprpc => ./looprpc

replace github.com/lightninglabs/lndclient => github.com/starius/lndclient v0.20.0-7-addinvoice
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

reminder to remove and upgrade lndclient once it is merged and tagged.

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