Skip to content

Conversation

ellemouton
Copy link
Collaborator

@ellemouton ellemouton commented May 7, 2025

In this PR, we start validating that any gossip message we decode has a valid TLV stream.
This is in preparation for creating a SQL version of the graph store in which we will store the TLV
records in a normalised fashion instead of in a flat structure as is done today.

part of #9795

Copy link
Contributor

coderabbitai bot commented May 7, 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.
    • 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.

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.

@ellemouton ellemouton changed the base branch from elle-graph to master May 7, 2025 07:51
@ellemouton ellemouton changed the base branch from master to elle-graph May 7, 2025 07:51
@bitromortac bitromortac requested a review from Copilot May 7, 2025 07:58
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces TLV blob validation during decoding and fixes the MilliSatoshi TLV record type size calculation. Key changes include:

  • Updating the TLV size parameter for MilliSatoshi in lnwire/msat.go and its migration counterpart.
  • Adding TLV stream validation to ExtraOpaqueData decoding in lnwire/extra_bytes.go.
  • Adjusting test inputs in graph/db/graph_test.go to provide valid TLV byte sequences.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
lnwire/msat.go Uses an explicit uint64 conversion for correct TLV size calculation.
lnwire/extra_bytes.go Adds TLV stream decoding and validation to ensure extra data integrity.
graph/db/graph_test.go Updates byte literal values for extra opaque data to simulate valid TLV data.
channeldb/migration/lnwire21/msat.go Mirrors the TLV size fix applied in lnwire/msat.go.
Comments suppressed due to low confidence (2)

lnwire/extra_bytes.go:71

  • [nitpick] The formatted error message now includes the invalid TLV bytes, which is helpful; consider adding further context or logging in cases where malformed TLV data is encountered to aid troubleshooting.
return fmt.Errorf("invalid TLV stream: %w: %v", err, *e)

graph/db/graph_test.go:113

  • [nitpick] The test now uses a byte literal for ExtraOpaqueData that simulates a valid TLV stream; ensure that additional tests are added to cover both well-formed and malformed TLV cases to fully validate the new decoding logic.
ExtraOpaqueData:      []byte{1, 1, 1, 2, 2, 2, 2},

@ellemouton ellemouton force-pushed the graphSQL1-extra-opaque branch from bce1d82 to 2897f6e Compare May 7, 2025 07:59
@ellemouton ellemouton changed the base branch from elle-graph to master May 7, 2025 07:59
@ziggie1984 ziggie1984 self-requested a review May 7, 2025 07:59
@ellemouton ellemouton requested a review from guggero May 7, 2025 08:00
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.

I think we should de-risk the TLV validation a bit, see inline comment. Other than that looks good to me.

@ellemouton ellemouton force-pushed the graphSQL1-extra-opaque branch 2 times, most recently from 4e9f7a9 to 3caa1f9 Compare May 7, 2025 08:39
@ellemouton ellemouton requested a review from guggero May 7, 2025 09:39
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 🎉

@ellemouton ellemouton force-pushed the graphSQL1-extra-opaque branch from 3caa1f9 to dd5bddc Compare May 7, 2025 10:17
@ellemouton ellemouton requested a review from bitromortac May 7, 2025 10:18
@ellemouton
Copy link
Collaborator Author

with the change in #9789, we can just merge that in 19 and hold off on the rest of the diff here until 20

@ellemouton ellemouton changed the base branch from master to elle-graph May 8, 2025 06:14
@ellemouton ellemouton force-pushed the graphSQL1-extra-opaque branch from dd5bddc to aa754b2 Compare May 8, 2025 06:14
@ellemouton ellemouton removed the request for review from bitromortac May 8, 2025 06:15
Copy link
Collaborator

@ziggie1984 ziggie1984 left a comment

Choose a reason for hiding this comment

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

LGTM-pending dependencies.

ellemouton added 2 commits May 8, 2025 10:25
Later when we introduce our SQL version of the graph store, we will
normalise the persistence of the ExtraOpaqueData using the fact that it
is always made up of TLV entries. So we update our tests here to ensure
that they use valid TLV streams as examples.
In this commit, we check that the extra bytes appended to gossip
messages contain valid TLV streams. We do this here for:
- channel_announcement
- channel_announcement_2
- channel_update
- channel_update_2
- node_announcement

This is in preparation for the SQL version of the graph store which will
normalise TLV streams at persistence time.
@ellemouton ellemouton merged commit 8dec9cb into lightningnetwork:elle-graph May 8, 2025
33 of 35 checks passed
@ellemouton ellemouton deleted the graphSQL1-extra-opaque branch May 8, 2025 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants