Skip to content
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

routerrpc: add option PreventSubsequentPayment to TrackPaymentV2 #9457

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

Conversation

starius
Copy link
Collaborator

@starius starius commented Jan 29, 2025

Change Description

The option is added to TrackPaymentV2's request. If it is enabled set and if the TrackPaymentV2 call is done before starting the payment, this fails a future payment with this payment hash.

If TrackPaymentV2 is only expected after starting a payment, you can use this flag to enforce the order of requests.

Changes in packages. In channeldb PaymentControl gets new method FetchOrIndalidatePayment which is similar to FetchPayment, but marks the payment invalid (FailureReasonTracked) in case it doesn't exist. Also added new PaymentStatus: StatusTracked. It is used for payments with FailureReasonTracked.

In package routing ControlTower gets an additional argument in method SubscribePayment: preventSubsequentPayment. If it is enabled and the payment hasn't started yet, it will be blocked in the future. It uses channeldb's new method FetchOrIndalidatePayment.

Steps to Test

make itest icase='tracked_payment_invalidates'

Pull Request Checklist

Testing

  • Your PR passes all CI checks.
  • Tests covering the positive and negative (error paths) are included.
  • Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

📝 Please see our Contribution Guidelines for further guidance.

The option is added to TrackPaymentV2's request. If it is enabled set and if the
TrackPaymentV2 call is done before starting the payment, this fails a future
payment with this payment hash.

If TrackPaymentV2 is only expected after starting a payment, you can use this
flag to enforce the order of requests.

Changes in packages. In channeldb PaymentControl gets new method
FetchOrIndalidatePayment which is similar to FetchPayment, but marks the payment
invalid (FailureReasonTracked) in case it doesn't exist. Also added new
PaymentStatus: StatusTracked. It is used for payments with FailureReasonTracked.

In package routing ControlTower gets an additional argument in method
SubscribePayment: preventSubsequentPayment. If it is enabled and the payment
hasn't started yet, it will be blocked in the future. It uses channeldb's new
method FetchOrIndalidatePayment.
@starius starius requested a review from bhandras January 29, 2025 03:35
Copy link
Contributor

coderabbitai bot commented Jan 29, 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.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

@starius starius changed the title Prevent subsequent payment routerrpc: add option PreventSubsequentPayment to TrackPaymentV2's request Jan 29, 2025
@starius starius changed the title routerrpc: add option PreventSubsequentPayment to TrackPaymentV2's request routerrpc: add option PreventSubsequentPayment to TrackPaymentV2 Jan 29, 2025
@starius starius marked this pull request as ready for review January 29, 2025 14:24
@saubyk saubyk added this to the v0.20.0 milestone Jan 29, 2025
@lightninglabs-deploy
Copy link

@bhandras: review reminder

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.

3 participants