-
Notifications
You must be signed in to change notification settings - Fork 2.2k
docs: add a new category of docs -> databases to explain sphinx replay #9616
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
base: master
Are you sure you want to change the base?
docs: add a new category of docs -> databases to explain sphinx replay #9616
Conversation
Important Review skippedAuto reviews are limited to specific labels. 🏷️ Labels to auto review (1)
Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the PR - can you make sure the requirement is met:
- Commits follow the Ideal Git Commit Structure.
@yyforyongyu changed the commit structure according to the ideal git commit structure. Kindly review the same. |
Now you have 4 commits... Please rebase and squash. |
8df7720
to
778d1a0
Compare
@yyforyongyu @guggero Please check I have made a single commit message |
Are you sure you want to change 113 files? |
@guggero I tried rebasing all the commits my branch was behind current |
You can fix this without creating a new PR. Please read up on the basics of how to use |
778d1a0
to
c232a72
Compare
@yyforyongyu: review reminder |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks.
@@ -0,0 +1,16 @@ | |||
# Understanding Sphinx Replay Protection | |||
|
|||
Sphinx is a protocol enabling anonymous and untraceable messaging in networks, commonly used in Lightning's onion routing. To prevent replay attacks, a Sphinx replay database stores message hashes along with metadata (e.g., timestamp, sender ID). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you wrap the lines at 80 characters please?
Maybe this can help enforce an 80‑character line length: https://github.com/lightningnetwork/lnd/blob/master/docs/code_formatting_rules.md#recommended-settings-for-your-editor In VS Code, you can add the following to your settings to show where lines should break: {
"editor.wordWrapColumn": 80,
"editor.tabSize": 8
} Optional suggestion: this guide might help improve your commit messages — https://github.com/lightningnetwork/lnd/blob/master/docs/code_contribution_guidelines.md#model-git-commit-messages Other than that, LGTM 👍 |
Change Description
The explaination of the
sphinxreplay.db
was earlier not provided so I created a new category ofdocs
to provide documentation of databases. Fixes #6584Steps to Test
Documentation Changes - can be seen directly
Pull Request Checklist
Testing
Code Style and Documentation
[skip ci]
in the commit message for small changes.📝 Please see our Contribution Guidelines for further guidance.