`LightningPayment` first hop custom records #8656

GeorgeTsagk · 2024-04-16T11:16:39Z

Description

Based on #8633

This PR adds a new field for first hop custom records to LightningPayment. This allows the sender to specify a set of custom records to be delivered via the wire message update_add_htlc to the first hop peer.

This method adds encode and decode methods to type `CustomSet`. These methods will allow us to serialise and deserialize a `CustomSet` map as a byte slice.

- Introduce the field `CustomRecordsBlob` to the type `UpdateAddHtlc`. - Encode and decode the new field into the `ExtraData` field of the `update_add_htlc` wire message.

Introduce `ResumeModified` action to resume standard behavior of a p2p message with optional modifications as specified by the client during interception.

This commit extends the forward HTLC intercept response with fields that can be used in conjunction with a `ResumeModified` action to modify the intercepted HTLC p2p message.

Implement an integration test where an HTLC is intercepted and the interception response modifies fields in the resultant p2p message.

coderabbitai · 2024-04-16T11:16:44Z

Important

Auto 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@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.

GeorgeTsagk · 2024-04-16T11:19:01Z

itest/lnd_forward_interceptor_test.go

+
+	require.Eventually(ht, func() bool {
+		ctx := context.Background()
+		dbgInfo, err := bob.RPC.LN.GetDebugInfo(


Since there's not yet support to retrieve the custom blob from the interceptor, we'll assert that bob receives the first hop records by peeking at his logs

dstadulis · 2024-04-23T17:47:16Z

@carlaKC Would you still like to review this? based on your comment on #8618

GeorgeTsagk · 2024-04-23T18:24:30Z

@carlaKC Would you still like to review this? based on your comment on #8618

given the narrow context of this specific PR & since we're soon changing the base to custom-channel-integration, I think it's better to hold back the reviews for now

Also very closely related to this PR: #8660

carlaKC · 2024-04-23T19:37:18Z

it's better to hold back the reviews for now

Removing myself for now then, feel free to re-add!

Roasbeef · 2024-04-24T02:36:39Z

lnrpc/routerrpc/router_backend.go

+	if err := firstHopRecords.Validate(); err != nil {
+		return nil, err
+	}
+	payIntent.FirstHopCustomRecords = firstHopRecords


Looks like the FirstHopCustomRecords field was added in a later commit. I think this one is more temp, but if not, we should move the commit that adds the new field to before this one.

Roasbeef · 2024-04-24T02:37:53Z

routing/payment_lifecycle.go

+		recordsBytes,
+	)
+
+	htlcAdd.CustomRecordsBlob = tlv.SomeRecordT(tlvRecord)


So I chatted with @ffranr about this offline, but instead we only want to be setting ExtraData. All the other logic (further down in the state machine), will only look inside of ExtraData, as it isn't expecting that extra layer of wrapping.

We do want the upfront validation here tho to ensure that w/e we're passed in is actually a canonical TLV stream.

lightninglabs-deploy · 2024-05-15T04:04:28Z

@GeorgeTsagk, remember to re-request review from reviewers when ready

GeorgeTsagk · 2024-05-15T14:57:52Z

These commits are now part of #8660
Closing this

ffranr and others added 9 commits April 9, 2024 18:42

multi: improve comment grammar

40f32b0

htlcswitch: add missing method doc

c9c7304

record: add encode and decode methods to CustomSet

103a671

This method adds encode and decode methods to type `CustomSet`. These methods will allow us to serialise and deserialize a `CustomSet` map as a byte slice.

lnwire: add custom records blob field to type UpdateAddHtlc

75bc4ae

- Introduce the field `CustomRecordsBlob` to the type `UpdateAddHtlc`. - Encode and decode the new field into the `ExtraData` field of the `update_add_htlc` wire message.

htlcswitch: add resume modified HTLC action to switch

74d5b57

Introduce `ResumeModified` action to resume standard behavior of a p2p message with optional modifications as specified by the client during interception.

routerrpc: extend HTLC forward interceptor resp with modification fields

bea7e44

This commit extends the forward HTLC intercept response with fields that can be used in conjunction with a `ResumeModified` action to modify the intercepted HTLC p2p message.

itest: add itest for field modification HTLC interception response

2d70c13

Implement an integration test where an HTLC is intercepted and the interception response modifies fields in the resultant p2p message.

lnrpc: add first hop records field to SendPayment

6b4ba1c

routing: encode first hop records in update_add_htlc message

5260069

GeorgeTsagk self-assigned this Apr 16, 2024

GeorgeTsagk commented Apr 16, 2024

View reviewed changes

itest: add first hop records interceptor test

c092a65

GeorgeTsagk force-pushed the payment-firsthop-records branch from 57b3608 to c092a65 Compare April 16, 2024 11:20

GeorgeTsagk mentioned this pull request Apr 17, 2024

Enhance update_add_htlc with remote peer's custom records #8660

Merged

saubyk requested a review from carlaKC April 19, 2024 19:19

carlaKC removed their request for review April 23, 2024 19:37

Roasbeef reviewed Apr 24, 2024

View reviewed changes

GeorgeTsagk closed this May 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`LightningPayment` first hop custom records #8656

`LightningPayment` first hop custom records #8656

GeorgeTsagk commented Apr 16, 2024 •

edited by saubyk

Loading

coderabbitai bot commented Apr 16, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

GeorgeTsagk Apr 16, 2024

dstadulis commented Apr 23, 2024

GeorgeTsagk commented Apr 23, 2024

carlaKC commented Apr 23, 2024

Roasbeef Apr 24, 2024

Roasbeef Apr 24, 2024

lightninglabs-deploy commented May 15, 2024

GeorgeTsagk commented May 15, 2024

LightningPayment first hop custom records #8656

LightningPayment first hop custom records #8656

Conversation

GeorgeTsagk commented Apr 16, 2024 • edited by saubyk Loading

Description

coderabbitai bot commented Apr 16, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

GeorgeTsagk Apr 16, 2024

Choose a reason for hiding this comment

dstadulis commented Apr 23, 2024

GeorgeTsagk commented Apr 23, 2024

carlaKC commented Apr 23, 2024

Roasbeef Apr 24, 2024

Choose a reason for hiding this comment

Roasbeef Apr 24, 2024

Choose a reason for hiding this comment

lightninglabs-deploy commented May 15, 2024

GeorgeTsagk commented May 15, 2024

`LightningPayment` first hop custom records #8656

`LightningPayment` first hop custom records #8656

GeorgeTsagk commented Apr 16, 2024 •

edited by saubyk

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)