Skip to content

Refactor Payment PR 1 #9825

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

ziggie1984
Copy link
Collaborator

@ziggie1984 ziggie1984 commented May 19, 2025

This PR is the start of a refactor series to finally support both payment backends out of the box for LND.

This PR starts with unifying the PaymentDB code which is currently splitted across multiple files and introducing a new KVPaymentDB struct at the server level. Apart from the second commit which adds a new DB to the server level (but does not use it yet) all of the changes are only refactors so nothing changed.

Copy link
Contributor

coderabbitai bot commented May 19, 2025

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.

@ziggie1984 ziggie1984 self-assigned this May 19, 2025
@ziggie1984 ziggie1984 added this to the v0.20.0 milestone May 19, 2025
@ziggie1984 ziggie1984 force-pushed the refactor-payments-code branch from fb6f2c6 to 3635b27 Compare May 19, 2025 11:13
@ziggie1984 ziggie1984 marked this pull request as ready for review May 19, 2025 11:13
@ziggie1984 ziggie1984 added refactoring payments Related to invoices/payments labels May 19, 2025
@ziggie1984 ziggie1984 requested a review from bhandras May 19, 2025 11:14
@ziggie1984 ziggie1984 force-pushed the refactor-payments-code branch from 3635b27 to cedd931 Compare May 19, 2025 13:43
@saubyk saubyk moved this to In progress in lnd v0.20 May 19, 2025
@ziggie1984 ziggie1984 requested review from yyforyongyu and ellemouton and removed request for bhandras May 19, 2025 15:31
@ziggie1984 ziggie1984 force-pushed the refactor-payments-code branch 5 times, most recently from 6c85629 to da88254 Compare May 20, 2025 09:27
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 move all code from the payment_control.go into payments.go so
that for later commits we can easily have all payment db related
kv db code together.
@ziggie1984 ziggie1984 force-pushed the refactor-payments-code branch from da88254 to 3a02bcd Compare May 21, 2025 06:52
@ziggie1984 ziggie1984 moved this from In progress to In review in lnd v0.20 May 21, 2025
return fmt.Errorf("HTLC with ID %v not registered",
attemptID)
}

// Make sure the shard is not already failed or settled.
if htlcsBucket.Get(htlcBucketKey(htlcFailInfoKey, aid)) != nil {
failInfo := htlcsBucket.Get(
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: keep the comment?

Comment on lines +303 to +305
// KVPaymentsDB implements persistence for payments and payment attempts.
type KVPaymentsDB struct {
paymentSeqMx sync.Mutex
Copy link
Collaborator

Choose a reason for hiding this comment

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

i would have rather just renamed payment_control.go to payments_db_kvdb.go so that this file clearly contains only the KVDB CRUD for payments. then later, we'd add a payments_db_sql.go where we'd implement the SQL CRUD for payments.

See an example here for the graph store. Specifically, see sql_store.go and kv_store.go

Copy link
Collaborator

Choose a reason for hiding this comment

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

then the payments.go file can continue to only contain payment related items that are db-agnostic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog payments Related to invoices/payments refactoring
Projects
Status: In review
Development

Successfully merging this pull request may close these issues.

2 participants