Skip to content

docs: add sphinx replay description #9903

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 16, 2025
Merged

docs: add sphinx replay description #9903

merged 1 commit into from
Jun 16, 2025

Conversation

ziggie1984
Copy link
Collaborator

@ziggie1984 ziggie1984 commented Jun 5, 2025 •
edited
Loading

Previouly the sphinx replay db would cause confusion for what it
is needed at all. We clarify it in a detailed document.

Resolves #6584

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 5, 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

@ziggie1984 ziggie1984 self-assigned this Jun 5, 2025
@ziggie1984 ziggie1984 force-pushed the sphinx-relays-doc branch from 6fe2e8a to eaddb7b Compare June 5, 2025 13:42
@ziggie1984 ziggie1984 requested review from Copilot and saubyk June 5, 2025 13:42
Copilot
Copilot AI reviewed Jun 5, 2025
View reviewed changes
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 adds detailed documentation to clarify the use and necessity of the Sphinx replay database in LND.

  • Added an overview of Sphinx onion routing and its privacy properties.
  • Included an explanation of replay protection mechanisms and the database names used for different backends.
Comments suppressed due to low confidence (1)

docs/SphinxReplayDB.md:104

  • Typo 'abolute' found; please change it to 'absolute'.
as discussed earlier they decay after the abolute locktime of the HTLC expires

@ziggie1984 ziggie1984 force-pushed the sphinx-relays-doc branch from eaddb7b to 9840287 Compare June 5, 2025 13:47
@ziggie1984 ziggie1984 mentioned this pull request Jun 8, 2025
Closed
saubyk
saubyk reviewed Jun 9, 2025
View reviewed changes
Copy link
Collaborator

@saubyk saubyk 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 putting this together, definitely useful. Left some suggestions for improved readability.

docs/SphinxReplayDB.md Outdated
propagating through the network to safeguard the privacy for every network
participant. An attacker could, for example, in hindsight access onion packets
from several highly connected nodes and re-inject it into the network and
potentially unblind receivers of payments which already happened in the past.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there an explanation required here on how the "unblinding" will happen? Currently it reads like an assertion.

Copy link
Collaborator Author

@ziggie1984 ziggie1984 Jun 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I generalized the unblind scenario here to not go into too much detail, because the scenario is very theoretical in my opinion.

@ziggie1984 ziggie1984 requested a review from saubyk June 10, 2025 06:34
@ellemouton ellemouton self-requested a review June 10, 2025 06:41
ellemouton
ellemouton reviewed Jun 10, 2025
View reviewed changes
Copy link
Collaborator

@ellemouton ellemouton 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 this!

@ziggie1984 ziggie1984 requested a review from ellemouton June 10, 2025 09:06
ellemouton
ellemouton approved these changes Jun 10, 2025
View reviewed changes
Copy link
Collaborator

@ellemouton ellemouton left a comment

Choose a reason for hiding this comment

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

great stuff!

saubyk
saubyk approved these changes Jun 11, 2025
View reviewed changes
Copy link
Collaborator

@saubyk saubyk left a comment

Choose a reason for hiding this comment

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

Just one last comment, otherwise LGTM.

@ziggie1984
Copy link
Collaborator Author

Needs an update if this is merged: #9929

@ziggie1984
Copy link
Collaborator Author

Also updated to the newest design so ready to be merged ⚡️

@ziggie1984
docs: add sphinx replay description
1741810 
Previouly the sphinx replay db would cause confusion for what it
is needed at all. We clarify it in a detailed document.
@ziggie1984
Copy link
Collaborator Author

@guggero can be merged.

@guggero guggero merged commit 8f8d17d into lightningnetwork:master Jun 16, 2025
26 of 27 checks passed
@ziggie1984 ziggie1984 mentioned this pull request Jun 16, 2025
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot

@ellemouton ellemouton

@saubyk saubyk

Assignees

@ziggie1984 ziggie1984

Labels
docs no-changelog no-itest
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document Sphinx replay DB (Decayed Log Db)
4 participants
@ziggie1984 @ellemouton @saubyk @guggero