Small comment tweaks

[TheBlueMatt]

No description provided.

[coderabbitai]

Walkthrough

This update includes minor, yet significant improvements in the code documentation for a clearer understanding of the internal workings. Specifically, it fixes a typo in a comment within channelmonitor.rs that pertains to fuzzer behavior, and enriches ln/channel.rs with detailed comments explaining the state of HTLC in the state machine, alongside how new states are managed across different versions of the Lightning Development Kit (LDK).

Changes

Files	Change Summary
.../chain/channelmonitor.rs	Corrected a typo in a comment related to fuzzer behavior.
.../ln/channel.rs	Added comments explaining HTLC states in the state machine and handling of new states in LDK.

"In the realm of code, a rabbit hopped, 🐇
Fixing typos, and comments it dropped. 🛠️
With each line, clarity it brought,
In the LDK, a better understanding it sought."

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 4a7ba67 and d1c2e14.

Files selected for processing (2)

• lightning/src/chain/channelmonitor.rs (1 hunks)
• lightning/src/ln/channel.rs (2 hunks)

Files skipped from review due to trivial changes (1)

• lightning/src/chain/channelmonitor.rs

Additional comments: 2

lightning/src/ln/channel.rs (2)

• 250-257: The added comments in InboundHTLCDetails struct provide valuable context about the HTLC state in the state machine and handling of new states across LDK versions. Ensure the reference to InboundHTLCStateDetails is accurate and accessible for developers looking for detailed state information.
• 436-443: The comments added to OutboundHTLCDetails struct mirror those in InboundHTLCDetails, offering insights into the HTLC state and its evolution across LDK versions. Similar to the previous hunk, confirm the accuracy and accessibility of the OutboundHTLCStateDetails reference for comprehensive state details.

[valentinewallace]

Could we include the specific version?

[TheBlueMatt]

There is no specific version. Its entirely speculative.

[TheBlueMatt]

We could also consider making it not an Option, but then we'd fail to read a ChannelDetails just because of an upgrade.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4a7ba67) 89.13% compared to head (d1c2e14) 89.12%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2878      +/-   ##
==========================================
- Coverage   89.13%   89.12%   -0.02%     
==========================================
  Files         115      115              
  Lines       93522    93522              
  Branches    93522    93522              
==========================================
- Hits        83359    83347      -12     
- Misses       7635     7641       +6     
- Partials     2528     2534       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[wvanlint]

Thanks for adding the comment! 🙏