Refactor Payment PR 2 by ziggie1984 · Pull Request #9826 · lightningnetwork/lnd

ziggie1984 · 2025-05-19T11:41:09Z

Builds on top of #9825, the first 4 commits are from the PR 1.

This Refactor PR does separates out the paymentDB currently just for the kv backend and unifies all payment related db queries under this unified umbrella. Before we would have a PaymentControl struct for payment lifecycle related data and then queries which fetched payments or deleted payments were implemented directly on the kvdb pointer receiver. This is now changed.

In the next PR we are going to introduce the new payments package, separate DB agnostic stuff more clearly.

coderabbitai · 2025-05-19T11:41:16Z

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.

We rename the file to payment_kv_store to highlight that this is the kv implementation of the payment db backend.

In the following commits we will gradually unify the current payment db operations into an interface to later down the road support both backends (sql+kv).

We also addd this new db on the server level to use it in the following commit to do all the payment related queries of the rpcserver. We add a new payment db instance on the server level. Which we will you for the payment related queries in a following commit.

We move all kv particular code which was in the payments.go file to the kv related file. Code which will be backend independant will remain in the payments.go file although only the kv backend is currently supported.

All interactions related to the payment db are now part of the kvPaymentDB struct.

yyforyongyu

LGTM🌹 I think for future PRs we can merge them to a side branch - you can also consider creating branches in upstream so this PR will be based on top of the branch #9825, thus the diff here will be 4 commits instead of 8.

yyforyongyu · 2025-08-04T07:25:09Z

config_builder.go


+	// KVPaymentsDB is the database that stores all payment related
+	// information.
+	KVPaymentsDB *channeldb.KVPaymentsDB


nit: can just name it PaymentsDB given it will be an interface supporting multiple types of DBs.

ellemouton

lgtm!

Agreed with YY re pushing upstream branches so that the diff just shows the commits in question.

But not fully agreed on the side-branch comment as imo, there is lots of value in getting these diffs into master so that the CI for all open PRs is exercising these changes (rather than just the side branch PR and the PRs pointing to it). That way we can be more confident about the changes at release time. I think that's less scary than the all-or-nothing approach of merging in the side-branch once it is huge/feature complete. Obvs open to debate :)

yyforyongyu · 2025-08-04T09:01:02Z

But not fully agreed on the side-branch comment as imo, there is lots of value in getting these diffs into master so that the CI for all open PRs is exercising these changes (rather than just the side branch PR and the PRs pointing to it). That way we can be more confident about the changes at release time.

For refactoring PRs, sure. For feature-based PRs, I'm not sure how to ship them to master when the feature is not complete tho, given they are built in smaller PRs. I'm also not sure why it gives more confidence that way - maybe it's because it's merged, and everyone else would rebase the PR, and let it fail in other PRs' CIs?

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

ziggie1984 marked this pull request as ready for review May 19, 2025 11:43

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

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

ziggie1984 requested a review from bhandras May 19, 2025 11:44

ziggie1984 force-pushed the refactor-payments-code-02 branch from f670374 to e13b29c Compare May 19, 2025 13:42

ziggie1984 mentioned this pull request May 19, 2025

[Part 1|3] Introduce SQL Payment schema into LND #9147

Merged

ziggie1984 self-assigned this May 19, 2025

saubyk moved this to In progress in lnd v0.20 May 19, 2025

ziggie1984 force-pushed the refactor-payments-code-02 branch from e13b29c to 26afc39 Compare May 19, 2025 15:39

ziggie1984 requested review from ellemouton and yyforyongyu and removed request for bhandras May 19, 2025 15:40

ziggie1984 force-pushed the refactor-payments-code-02 branch 4 times, most recently from 39ae57b to bfdb4c1 Compare May 20, 2025 11:30

ziggie1984 mentioned this pull request May 20, 2025

Refactor Payment PR 3 #9844

Merged

ziggie1984 force-pushed the refactor-payments-code-02 branch from bfdb4c1 to 6e866e2 Compare May 21, 2025 06:52

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

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

ziggie1984 mentioned this pull request May 25, 2025

[feature]: Refactor the Payment Code Base #9862

Closed

channeldb: rename payment_control files

252ebde

We rename the file to payment_kv_store to highlight that this is the kv implementation of the payment db backend.

ziggie1984 force-pushed the refactor-payments-code-02 branch from 6e866e2 to f90ba60 Compare August 2, 2025 09:09

ziggie1984 requested review from ellemouton and yyforyongyu August 2, 2025 09:09

ziggie1984 force-pushed the refactor-payments-code-02 branch from f90ba60 to ba1907d Compare August 2, 2025 09:12

channeldb: rename PaymentControl struct

2d07d44

In the following commits we will gradually unify the current payment db operations into an interface to later down the road support both backends (sql+kv).

ziggie1984 force-pushed the refactor-payments-code-02 branch from ba1907d to c52c3c9 Compare August 2, 2025 09:36

channeldb: rename pControl to paymentDB in tests

8bd4744

ziggie1984 force-pushed the refactor-payments-code-02 branch from c52c3c9 to d5cb7de Compare August 2, 2025 10:03

ziggie1984 added 5 commits August 2, 2025 13:21

multi: fix linter issues

84b2a94

channeldb: move kv related code

aaa1ee0

We move all kv particular code which was in the payments.go file to the kv related file. Code which will be backend independant will remain in the payments.go file although only the kv backend is currently supported.

multi: unify all payment related kv data

0aef5fa

All interactions related to the payment db are now part of the kvPaymentDB struct.

multi: fix linter issues

2b3b27f

ziggie1984 force-pushed the refactor-payments-code-02 branch from d5cb7de to 2b3b27f Compare August 2, 2025 11:25

yyforyongyu approved these changes Aug 4, 2025

View reviewed changes

ellemouton approved these changes Aug 4, 2025

View reviewed changes

yyforyongyu merged commit 21726f0 into lightningnetwork:master Aug 4, 2025
36 of 39 checks passed

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Payment PR 2#9826

Refactor Payment PR 2#9826
yyforyongyu merged 8 commits intolightningnetwork:masterfrom
ziggie1984:refactor-payments-code-02

ziggie1984 commented May 19, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented May 19, 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!

yyforyongyu left a comment

Uh oh!

yyforyongyu Aug 4, 2025

Uh oh!

ellemouton left a comment

Uh oh!

yyforyongyu commented Aug 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

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

Uh oh!

Uh oh!

coderabbitai bot commented May 19, 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!

yyforyongyu left a comment

Choose a reason for hiding this comment

Uh oh!

yyforyongyu Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

ellemouton left a comment

Choose a reason for hiding this comment

Uh oh!

yyforyongyu commented Aug 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ziggie1984 commented May 19, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)