[WIP] loop-ins: fix route hints passing, add test coverage#1122
[WIP] loop-ins: fix route hints passing, add test coverage#1122starius wants to merge 4 commits intolightninglabs:masterfrom
Conversation
Include lightninglabs/lndclient#268 Preserve AddInvoiceData fields across invoice wrappers TODO: remove go replace.
Summary of ChangesHello, 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
🧠 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 AssistThe 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
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 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
|
There was a problem hiding this comment.
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.
| req := testLoopInRequest | ||
| req.RouteHints = testLoopInRouteHints() | ||
|
|
||
| _, err := newLoopInSwap(context.Background(), cfg, 600, &req) |
There was a problem hiding this comment.
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+.
| _, err := newLoopInSwap(context.Background(), cfg, 600, &req) | |
| _, err := newLoopInSwap(t.Context(), cfg, 600, &req) |
| 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) | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
| loopIn: loopIn, | ||
| } | ||
|
|
||
| event := f.InitHtlcAction(context.Background(), nil) |
There was a problem hiding this comment.
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.
| event := f.InitHtlcAction(context.Background(), nil) | |
| event := f.InitHtlcAction(t.Context(), nil) |
c6644b2 to
3e6cb16
Compare
hieblmi
left a comment
There was a problem hiding this comment.
LGTM, pending go.mod replace after lndclient is merged.
|
|
||
| replace github.com/lightninglabs/loop/looprpc => ./looprpc | ||
|
|
||
| replace github.com/lightninglabs/lndclient => github.com/starius/lndclient v0.20.0-7-addinvoice |
There was a problem hiding this comment.
reminder to remove and upgrade lndclient once it is merged and tagged.
Include lightninglabs/lndclient#268
Pull Request Checklist
release_notes.mdif your PR contains major features, breaking changes or bugfixes