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

Add Custom Error msg and Prioritise replayed HTLCs #9454

Merged
merged 8 commits into from
Jan 30, 2025

Conversation

ziggie1984
Copy link
Collaborator

@ziggie1984 ziggie1984 commented Jan 28, 2025

Change Description

We introduce a new method to the TrafficShaper to remove the logic needed for custom channels and move it to the outer layers. Moreover this PR also prioritises replayed HTLCs and will not allow the HTLCModifier to change their previous resolution result. It also increases the test coverage of the invoiceregistry especially for AMP multi-part payments.

Copy link
Contributor

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

@ziggie1984 ziggie1984 marked this pull request as ready for review January 28, 2025 19:29
@ziggie1984 ziggie1984 self-assigned this Jan 28, 2025
Copy link
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Did a first pass. Looks good, thanks for the custom channel fixes!

@Roasbeef
Copy link
Member

Error: itest/list_on_test.go:415:13: undefined: testForwardInterceptorWireRecords

@ziggie1984 ziggie1984 force-pushed the add_custom_error_msg branch from 4383342 to 955facb Compare January 28, 2025 22:22
@ziggie1984 ziggie1984 added this to the v0.19.0 milestone Jan 28, 2025
@ziggie1984 ziggie1984 added amp testing Improvements/modifications to the test suite custom chans size/kilo medium, proper context needed, less than 1000 lines labels Jan 28, 2025
@ziggie1984 ziggie1984 force-pushed the add_custom_error_msg branch 4 times, most recently from 5b53ddb to 7e0be90 Compare January 29, 2025 00:25
Copy link
Member

@yyforyongyu yyforyongyu left a comment

Choose a reason for hiding this comment

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

Thanks for the quick fix! Pending typo fixes otherwise LGTM 🙏

We make sure that HTLCs which have already been decided upon
are resolved before before allowing the external interceptor to
potentially cancel them back. This makes the implementation for
the external HTLC interceptor more streamlined.
We introduce a new specific fail resolution error when the
external HTLC interceptor denies the incoming HTLC. Moreover
we introduce a new traffic shaper method which moves the
implementation of asset HTLC to the external layers.
Moreover itests are adopted to reflect this new change.
Copy link
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

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

LGTM 🎉

@ziggie1984 ziggie1984 force-pushed the add_custom_error_msg branch 3 times, most recently from 6ba3a46 to 4bfa305 Compare January 29, 2025 14:16
@yyforyongyu
Copy link
Member

hmm looks like the linter failed, plus this new flake, think it's related?

--- FAIL: TestInvoiceRegistry (4.07s)
    --- FAIL: TestInvoiceRegistry/FailPartialAMPPayment_KV (5.64s)
        invoiceregistry_test.go:2411: timeout waiting for HTLC resolution

The invoiceregistry test suite also includes unit tests for
multi part payment especially also including payments to AMP
invoices.
We always fetch the HTLCs for the specific setID, so there is no
need to keep this code. In earlier versions we would call the
UpdateInvoice method with `nil` for the setID therefore we had
to lookup the AMPState. However this was error prune because in
case one partial payment times-out the AMPState would change to
cancelled and that could lead to not resolve HTLCs.
@ziggie1984 ziggie1984 force-pushed the add_custom_error_msg branch from 4bfa305 to 91014ea Compare January 29, 2025 17:21
@ziggie1984
Copy link
Collaborator Author

Yes it's related, I was relying on the kvdb.Update ordering on the Application level, however this is never gruanted. So I had to change the test a bit so it never runs in this scenario.

@saubyk saubyk modified the milestones: v0.19.0, v0.18.5 Jan 29, 2025
Copy link
Member

@yyforyongyu yyforyongyu left a comment

Choose a reason for hiding this comment

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

LGTM🫡

log.Debugf("Cancelling htlc (%v) of invoice(%v) with "+
"resolution: %v", key, invoiceRef, result)
log.Debugf("Signaling htlc(%v) cancellation of invoice(%v) "+
"with resolution(%v) to the link subsystem", key,
Copy link
Member

Choose a reason for hiding this comment

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

nit: it's not necessary the link system?

log.Debugf("cancelSingleHtlc: invoice %v no longer "+
"open", invoiceRef)
log.Debugf("CancelSingleHtlc: cannot cancel htlc %v "+
"on invoice %v, invoice is no longer open", key,
Copy link
Member

Choose a reason for hiding this comment

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

nit: think we wanna be as concise as possible in the logging - so i would do,
"CancelSingleHtlc: cannot cancel htlc: invoice(%v) no longer open"

@@ -234,6 +234,9 @@ config option](https://github.com/lightningnetwork/lnd/pull/9182) and introduce
a new option `channel-max-fee-exposure` which is unambiguous in its description.
The underlying functionality between those two options remain the same.

* [Improved user experience](https://github.com/lightningnetwork/lnd/pull/9454)
Copy link
Member

Choose a reason for hiding this comment

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

Should be 0.18.5 now i guess?

Copy link
Member

Choose a reason for hiding this comment

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

I pushed a commit to move it into 0.18.5.

Copy link
Member

@Roasbeef Roasbeef left a comment

Choose a reason for hiding this comment

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

LGTM 🏆

@Roasbeef Roasbeef force-pushed the add_custom_error_msg branch from 91014ea to f4e2f2a Compare January 30, 2025 04:46
@Roasbeef Roasbeef merged commit 32cdbb4 into lightningnetwork:master Jan 30, 2025
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
amp custom chans size/kilo medium, proper context needed, less than 1000 lines testing Improvements/modifications to the test suite
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants