Refactor Payment PR 3 by ziggie1984 · Pull Request #9844 · lightningnetwork/lnd

ziggie1984 · 2025-05-20T19:04:47Z

This Refactor commit starts moving payment related code into its own package.
It still keeps the KVPaymentDB implementation in the channeldb package. This will be moved to the payments package in the next PR.

coderabbitai · 2025-05-20T19:04:54Z

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.

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.

ellemouton

Nice! some nits

channeldb/payments_test.go

channeldb/payments_kv_store.go

channeldb/payments_kv_store_test.go

payments/db/options.go

channeldb/payments_kv_store_test.go

channeldb/payments_test.go

yyforyongyu · 2025-08-08T10:11:17Z

channeldb/mp_payment.go

 	"github.com/lightningnetwork/lnd/lntypes"
 	"github.com/lightningnetwork/lnd/lnutils"
 	"github.com/lightningnetwork/lnd/lnwire"
+	paymentsdb "github.com/lightningnetwork/lnd/payments/db"


nit: consider name it pdb for brevity?

currently I prefer the longer name, but happy to change it in PR4, so that I don't end up in rebase hell. (most of the refactor PRs are ready so I would need to rebase everything all the time, so going to rename it after the last refactor for the whole series.

payments/db/log.go

channeldb/payments_kv_store.go

payments/db/payments.go

channeldb/payments_kv_store.go

yyforyongyu · 2025-08-08T11:06:33Z

/gemini review

gemini-code-assist

Code Review

This pull request is a significant refactoring that moves payment-related code from the channeldb package to a new, dedicated payments/db package. This is a great architectural improvement that enhances modularity and separation of concerns. The changes are extensive but appear to be consistently applied across the codebase. The introduction of a paymentsdb package with its own options and error types is a solid step forward. My review focuses on ensuring adherence to the project's style guide, particularly regarding line length, which I've found a few violations of.

channeldb/payments_kv_store.go

lnrpc/routerrpc/router_backend.go

routing/payment_lifecycle.go

routing/router.go

We add a context for the query method because the query method is part of the paymentDB interface and for the SQL case we will need the context for this method because the native SQL drivers demand one. So we add it for the kv implementation here as well so we can then make use of the new interface type.

We introduce a new package paymentsDB and start by moving the payment specifc errors from the channeldb package to the paymentsDB package. We also fix linter issues which showed up due to changing this code part.

Instead of the ChannelState struct we now use the kv backend interface for the payment kv database.

yyforyongyu

🦾

yyforyongyu · 2025-08-13T10:01:06Z

channeldb/payments_kv_store.go

+	// db is the underlying database implementation.
+	db kvdb.Backend
+
+	keepFailedPaymentAttempts bool


We should keep the docs.

added in PR4

yyforyongyu · 2025-08-13T10:03:50Z

channeldb/payments_kv_store.go

+	}, nil
+}
+
+var paymentsTopLevelBuckets = [][]byte{


would be nice to add more docs, can do it in a later pr tho.

added in PR4

ziggie1984 self-assigned this May 20, 2025

ziggie1984 added payments Related to invoices/payments refactoring no-changelog labels May 20, 2025

ziggie1984 added this to the v0.20.0 milestone May 20, 2025

ziggie1984 added this to lnd v0.20 May 20, 2025

ziggie1984 marked this pull request as ready for review May 20, 2025 19:07

ziggie1984 force-pushed the refactor-payments-code-03 branch from 50f580b to 90108ed Compare May 20, 2025 19:12

ziggie1984 requested review from ellemouton and yyforyongyu May 20, 2025 19:13

ziggie1984 force-pushed the refactor-payments-code-03 branch 3 times, most recently from 8658c85 to b308ed0 Compare May 21, 2025 07:17

ziggie1984 moved this to In progress in lnd v0.20 May 21, 2025

ziggie1984 force-pushed the refactor-payments-code-03 branch from b308ed0 to 3a573e0 Compare May 21, 2025 07:51

ziggie1984 removed request for ellemouton and yyforyongyu May 21, 2025 12:20

ziggie1984 mentioned this pull request May 25, 2025

[feature]: Refactor the Payment Code Base #9862

Closed

ziggie1984 force-pushed the refactor-payments-code-03 branch from 3a573e0 to 7faf0b0 Compare August 7, 2025 16:45

ziggie1984 requested review from ellemouton and yyforyongyu August 7, 2025 16:46

ziggie1984 force-pushed the refactor-payments-code-03 branch 2 times, most recently from 8c5b919 to 4b08ee1 Compare August 7, 2025 17:46

ellemouton approved these changes Aug 8, 2025

View reviewed changes

yyforyongyu requested changes Aug 8, 2025

View reviewed changes

gemini-code-assist bot reviewed Aug 8, 2025

View reviewed changes

channeldb/payments_kv_store.go Outdated Show resolved Hide resolved

lnrpc/routerrpc/router_backend.go Outdated Show resolved Hide resolved

routing/payment_lifecycle.go Show resolved Hide resolved

routing/router.go Show resolved Hide resolved

ziggie1984 force-pushed the refactor-payments-code-03 branch 2 times, most recently from 99ed9d0 to bbc8e63 Compare August 11, 2025 14:11

ziggie1984 force-pushed the refactor-payments-code-03 branch from bbc8e63 to c010c72 Compare August 11, 2025 14:14

ziggie1984 requested a review from yyforyongyu August 11, 2025 14:18

ziggie1984 force-pushed the refactor-payments-code-03 branch from 47dca79 to b51e82b Compare August 11, 2025 14:36

ziggie1984 added 7 commits August 11, 2025 16:44

multi: introduce new paymentsDB package

18afd44

We introduce a new package paymentsDB and start by moving the payment specifc errors from the channeldb package to the paymentsDB package. We also fix linter issues which showed up due to changing this code part.

paymentsdb: add subsystem logging for payments package

3aec402

mulit: use kvdb.Backend for the kv payment db

88da582

Instead of the ChannelState struct we now use the kv backend interface for the payment kv database.

channeldb: rename paymentSeqMx

6bae3c9

channeldb: rename currPaymentSeq

a4b1569

channeldb: rename storedPaymentSeq

4e0af2f

ziggie1984 force-pushed the refactor-payments-code-03 branch from b51e82b to 4e0af2f Compare August 11, 2025 14:44

ziggie1984 mentioned this pull request Aug 12, 2025

Refactor Payment PR 4 #9847

Merged

ziggie1984 moved this from In progress to In review in lnd v0.20 Aug 12, 2025

yyforyongyu approved these changes Aug 13, 2025

View reviewed changes

yyforyongyu merged commit c6a9116 into lightningnetwork:master Aug 13, 2025
36 of 39 checks passed

github-project-automation bot moved this from In review to Done in lnd v0.20 Aug 13, 2025

Conversation

ziggie1984 commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented May 20, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

ellemouton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yyforyongyu Aug 8, 2025

Choose a reason for hiding this comment

Uh oh!

ziggie1984 Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yyforyongyu commented Aug 8, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yyforyongyu left a comment

Choose a reason for hiding this comment

Uh oh!

yyforyongyu Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

ziggie1984 Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

yyforyongyu Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

ziggie1984 Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ziggie1984 commented May 20, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)