Prefer implementing From<PaymentPreimage> over Into<PaymentHash>

[tnull]

In #2916 an Into<PaymentHash> implementation was added.

Here, we change that to From<PaymentPreimage> as the std library docs state that implementing Into should be avoided:

One should avoid implementing Into and implement From instead. Implementing From automatically provides one with an implementation of Into thanks to the blanket implementation in the standard library.

[coderabbitai]

Walkthrough

The update in the codebase shifts the method of converting a PaymentPreimage to a PaymentHash from utilizing the Into trait to employing the From trait. This modification enhances the clarity and efficiency of type conversions within the system, accompanied by necessary adjustments in function signatures and parameter management.

Changes

File Path	Change Summary
.../ln/mod.rs	Changed conversion of PaymentPreimage to PaymentHash from Into trait to From trait.

🐇✨
In the realm of code, where logic does abide,
A tiny change makes a leap, wide.
From Into to From, a path we stride,
With PaymentPreimage as our guide.
So here's to the code, in its new pride!
🌟🐾

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 bf3bc42 and fe50a50.

Files selected for processing (1)

• lightning/src/ln/mod.rs (1 hunks)

Additional comments: 1

lightning/src/ln/mod.rs (1)

• 115-117: The implementation of From<PaymentPreimage> for PaymentHash correctly follows Rust's idiomatic practices for type conversion, aligning with the guidance from the Rust standard library documentation. By using the From trait, the code benefits from an automatic Into implementation, simplifying the codebase and enhancing maintainability. The conversion logic, which hashes the PaymentPreimage using SHA256 to produce a PaymentHash, is correctly implemented and efficiently utilizes the Sha256::hash function followed by to_byte_array() to convert the hash result into the expected format. This change effectively improves the code's clarity and alignment with recommended Rust practices.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 89.13%. Comparing base (bf3bc42) to head (fe50a50).

Files	Patch %	Lines
lightning/src/ln/mod.rs	0.00%	2 Missing ⚠️

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

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2918      +/-   ##
==========================================
- Coverage   89.15%   89.13%   -0.02%     
==========================================
  Files         117      117              
  Lines       94856    94856              
  Branches    94856    94856              
==========================================
- Hits        84568    84554      -14     
- Misses       7812     7827      +15     
+ Partials     2476     2475       -1     

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

[TheBlueMatt]

Good catch. There's not a lot of reason to make someone else look at this one, either. Just gonna land.