[6/5]: invoice+rpc: add exit hop InvoiceAcceptor sub-systems and RPC calls #8771

guggero · 2024-05-22T16:03:58Z

Replaces #8669.

Closes #8616

This pull request introduces the following components:

An interceptor service for invoice settlements.
An invoice acceptor RPC server and endpoint which makes use of the invoice settlement interceptor.
An integration test demonstrating the settlement of an invoice through the invoice acceptor, using a HTLC with an amount smaller than the specified invoice amount.

Link to all PRs in the saga:

1/5: [1/?]: multi: add ability to fund+use musig2 channels that commit to a tapscript root #8683
2/5: [2/?]: lnwallet+channeldb: add new AuxLeafStore for dynamic aux leaves #8684
3/5: [3/5]: multi: add new AuxFundingController for custom external funding flows #8622
4/5: [4/5]: lnwallet: add new AuxSigner interface to mirror SigPool #8632
5/5: [5/5]: lnwallet: extensions to aux leaf store to integrate custom channels #8641
6/5: [6/5]: invoice+rpc: add exit hop InvoiceAcceptor sub-systems and RPC calls #8771

coderabbitai · 2024-05-22T16:04:08Z

Important

Review Skipped

Auto reviews are disabled on this repository.

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 full the review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

guggero · 2024-05-22T16:26:35Z

This isn't ready for review yet. And for some reason I can't put it back to draft anymore, sorry.

guggero · 2024-05-24T16:26:49Z

PR is now ready to review.

invoices/invoiceregistry.go

lnrpc/invoicesrpc/htlc_interceptor.go

lnrpc/invoicesrpc/invoices.proto

lnrpc/invoicesrpc/invoices_server.go

lntest/harness.go

GeorgeTsagk

looking good
CI is unhappy

GeorgeTsagk · 2024-05-27T14:54:37Z

invoices/settlement_interceptor.go

+
+// MockHtlcModifier is a mock implementation of the HtlcModifier interface.
+type MockHtlcModifier struct {
+}


shouldn't the mocks live under some test related pkg?

Unfortunately in Go we can't import test code from one package into the other. And because we need the mock in multiple packages, it needs to be defined in non-test code.

This commit introduces a new invoice htlc interceptor service that intercepts invoice HTLCs during their settlement phase. It forwards HTLCs to a subscribed client to determine their settlement outcomes. This commit also introduces an interface to facilitate integrating the interceptor with other packages.

This commit updates the invoice registry to utilize the settlement interceptor during the invoice settlement routine. It allows the interceptor to capture the invoice, providing interception clients an opportunity to determine the settlement outcome.

This commit initiates the invoice settlement interceptor during the main server startup, assigning it a handle within the server.

This commit integrates the HTLC modifier service into the invoices RPC server.

This commit introduces a singleton invoice HTLC modifier RPC server and an endpoint to activate it. The server interfaces with the internal invoice HTLC modifier interpreter, handling the marshalling between RPC types and internal formats.

This commit enhances the itest LND node harness to include support for the new `HtlcModifier` RPC endpoint. At the same time we move another method to the correct file.

This commit introduces a basic integration test for the invoice HTLC modifier. The test covers scenarios where an invoice is settled with a payment that is less than the invoice amount, facilitated by the invoice HTLC modifier.

guggero · 2024-05-28T06:49:25Z

Fixed the CI, ready for final look.

GeorgeTsagk

Looks good!

GeorgeTsagk · 2024-05-28T09:40:47Z

lnrpc/invoicesrpc/invoices.proto

+    map<uint64, bytes> exit_htlc_wire_custom_records = 6;
+}
+
+message HtlcModifyResponse {


my only side note in this PR is that we may wanna add more stuff here in the future?

Yeah, I guess we might want to, but it's not clear right now if we actually need to. So leaving off a TODO for now to avoid needing to trigger another CI run. But added this comment to the tracking issue.

guggero added taproot taproot chans custom chans labels May 22, 2024

guggero linked an issue May 22, 2024 that may be closed by this pull request

invoice+rpc: add exit hop InvoiceAcceptor sub-systems and RPC calls #8616

Closed

2 tasks

dstadulis assigned guggero May 22, 2024

dstadulis requested a review from ffranr May 22, 2024 16:14

guggero force-pushed the custom-channels-integration-invoice branch from 91236ab to a5dde8a Compare May 22, 2024 16:25

guggero force-pushed the custom-channels-integration branch from 12d4694 to 44fe836 Compare May 22, 2024 16:25

guggero removed the request for review from ffranr May 22, 2024 16:26

dstadulis mentioned this pull request May 15, 2024

[tracking]: lnd/lnwallet saga lightninglabs/taproot-assets#898

Closed

4 tasks

guggero force-pushed the custom-channels-integration branch from 44fe836 to 5401a54 Compare May 23, 2024 11:38

guggero force-pushed the custom-channels-integration-invoice branch from a5dde8a to 8d716d9 Compare May 23, 2024 11:38

dstadulis mentioned this pull request May 23, 2024

[tracking]: Add Invoice Interceptor functionality lightninglabs/taproot-assets#913

Closed

guggero force-pushed the custom-channels-integration-invoice branch from 8d716d9 to 6c31983 Compare May 24, 2024 16:08

guggero requested review from GeorgeTsagk and ffranr May 24, 2024 16:26

ffranr reviewed May 27, 2024

View reviewed changes

guggero force-pushed the custom-channels-integration branch 2 times, most recently from c6b7ef7 to 13828b7 Compare May 27, 2024 11:47

guggero force-pushed the custom-channels-integration-invoice branch from 6c31983 to 7158c31 Compare May 27, 2024 13:35

guggero requested a review from ffranr May 27, 2024 13:36

ffranr approved these changes May 27, 2024

View reviewed changes

guggero force-pushed the custom-channels-integration branch from 13828b7 to f2e71de Compare May 27, 2024 13:53

guggero force-pushed the custom-channels-integration-invoice branch from 7158c31 to 3d167f3 Compare May 27, 2024 13:53

GeorgeTsagk reviewed May 27, 2024

View reviewed changes

guggero force-pushed the custom-channels-integration-invoice branch from 3d167f3 to f9d0aa1 Compare May 27, 2024 16:20

guggero force-pushed the custom-channels-integration branch from f2e71de to d2d5064 Compare May 27, 2024 16:20

Base automatically changed from custom-channels-integration to 0-19-staging May 27, 2024 18:22

guggero and others added 8 commits May 27, 2024 20:23

htlcswitch: override amount check on custom records

a3cdae0

routing+lnrpc: fix log statements

8865484

routing: remove unused struct member

1404468

routing: update TLV traffic shaper interface

b628483

lnd: initialize invoice settlement interceptor at server startup

7e8a3b0

This commit initiates the invoice settlement interceptor during the main server startup, assigning it a handle within the server.

invoicesrpc: add HTLC modifier to invoices RPC server

73f52c8

This commit integrates the HTLC modifier service into the invoices RPC server.

guggero force-pushed the custom-channels-integration-invoice branch from f9d0aa1 to d593663 Compare May 27, 2024 18:23

guggero requested a review from GeorgeTsagk May 27, 2024 18:24

ffranr added 3 commits May 27, 2024 20:33

lntest: add HtlcModifier support to node RPC harness

08429c6

This commit enhances the itest LND node harness to include support for the new `HtlcModifier` RPC endpoint. At the same time we move another method to the correct file.

itest: add basic invoice HTLC modifier integration test

c0d2b53

This commit introduces a basic integration test for the invoice HTLC modifier. The test covers scenarios where an invoice is settled with a payment that is less than the invoice amount, facilitated by the invoice HTLC modifier.

guggero force-pushed the custom-channels-integration-invoice branch from d593663 to db61508 Compare May 27, 2024 18:35

multi: pass UpdateAddHtlc message custom records to invoice modifier

197b291

guggero force-pushed the custom-channels-integration-invoice branch from db61508 to 197b291 Compare May 28, 2024 06:48

GeorgeTsagk approved these changes May 28, 2024

View reviewed changes

guggero mentioned this pull request May 28, 2024

tracking: remaining cleanup to address before merging 0-19-staging branch into master #8769

Open

10 tasks

guggero merged commit e4e04b6 into 0-19-staging May 28, 2024
24 of 27 checks passed

guggero deleted the custom-channels-integration-invoice branch May 28, 2024 09:50

guggero mentioned this pull request May 28, 2024

invoice+rpc: add exit hop InvoiceAcceptor sub-systems and RPC calls #8616

Closed

2 tasks

dstadulis mentioned this pull request Jul 16, 2024

[tracking]: Add testing to lnd 0-19-staging branch before lightning-terminal non-experimental release lightninglabs/taproot-assets#1027

Open

guggero mentioned this pull request Aug 9, 2024

[custom channels 5/5]: merge custom channel staging branch into master #8960

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[6/5]: invoice+rpc: add exit hop InvoiceAcceptor sub-systems and RPC calls #8771

[6/5]: invoice+rpc: add exit hop InvoiceAcceptor sub-systems and RPC calls #8771

guggero commented May 22, 2024 •

edited

Loading

coderabbitai bot commented May 22, 2024 •

edited

Loading

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

guggero commented May 22, 2024 •

edited

Loading

guggero commented May 24, 2024

GeorgeTsagk left a comment

GeorgeTsagk May 27, 2024

guggero May 27, 2024

guggero commented May 28, 2024

GeorgeTsagk left a comment

GeorgeTsagk May 28, 2024

guggero May 28, 2024

[6/5]: invoice+rpc: add exit hop InvoiceAcceptor sub-systems and RPC calls #8771

[6/5]: invoice+rpc: add exit hop InvoiceAcceptor sub-systems and RPC calls #8771

Conversation

guggero commented May 22, 2024 • edited Loading

coderabbitai bot commented May 22, 2024 • edited Loading

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

guggero commented May 22, 2024 • edited Loading

guggero commented May 24, 2024

GeorgeTsagk left a comment

Choose a reason for hiding this comment

GeorgeTsagk May 27, 2024

Choose a reason for hiding this comment

guggero May 27, 2024

Choose a reason for hiding this comment

guggero commented May 28, 2024

GeorgeTsagk left a comment

Choose a reason for hiding this comment

GeorgeTsagk May 28, 2024

Choose a reason for hiding this comment

guggero May 28, 2024

Choose a reason for hiding this comment

guggero commented May 22, 2024 •

edited

Loading

coderabbitai bot commented May 22, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

guggero commented May 22, 2024 •

edited

Loading