lncli: Use EOF as a terminator instead of the newline in lncli unlock --stdin command

[mohamedawnallah]

Change Description

Replaces #5638
Closes #5584

Steps to Test

1. Password with new lines at the end: Warning Printed since echo prints a new line by default at the end of the echoed string.

ubuntu@carol:~/lnd$ echo "test" | lncli unlock --stdin
WARNING: Password contains leading ortrailing newline characters and they will not be trimmed.
[lncli] rpc error: code = Unknown desc = invalid passphrase for master public key

2. Password with new lines at the beginning: Warning Printed.

ubuntu@carol:~/lnd$ echo "\ntest" | lncli unlock --stdin
WARNING: Password contains leading ortrailing newline characters and they will not be trimmed.
[lncli] rpc error: code = Unknown desc = invalid passphrase for master public key

3. Valid Password with no new lines at the beginning/end: No Warning Printed.

ubuntu@carol:~/lnd$ echo -n "test" | lncli unlock --stdin
lnd successfully unlocked!

Approach

graph TD;
    A[Is password given from stdin?] -->|true| B[Copy password from stdin];
    B --> C[Create buffer];
    C --> D[Copy stdin to buffer];
    D --> E{Error during copy?};
    E -->|yes| F[Return error];
    E -->|no| G{EOF encountered?};
    G -->|yes| I[Trim buffer from carriage returns];
    I --> J[Check for leading or trailing newline];
    J -->|yes| K[Issue warning];
    J -->|no| L[Continue];
    K --> L;
    L --> M[Finish];

Pull Request Checklist

Testing

• Your PR passes all CI checks.
• Tests covering the positive and negative (error paths) are included.
• Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

• The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.
• Commits follow the Ideal Git Commit Structure.
• Any new logging statements use an appropriate subsystem and logging level.
• Any new lncli commands have appropriate tags in the comments for the rpc in the proto file.
• There is a change description in the release notes, or [skip ci] in the commit message for small changes.

📝 Please see our Contribution Guidelines for further guidance.

[coderabbitai]

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

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.

---

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 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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.
• 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.