Skip to content

cmd: fix error parsed from status - #9605

Merged
Roasbeef merged 2 commits into
lightningnetwork:masterfrom
yyforyongyu:fix-unlock-wallet
Mar 18, 2025
Merged

cmd: fix error parsed from status#9605
Roasbeef merged 2 commits into
lightningnetwork:masterfrom
yyforyongyu:fix-unlock-wallet

Conversation

@yyforyongyu

@yyforyongyu yyforyongyu commented Mar 17, 2025

Copy link
Copy Markdown
Member

A user was having trouble debugging its node, which was running in an lnd without the walletrpc enabled. The user then tried to build the lncli with the RPC enabled, but the lnd node could not be built since it was running remotely. Then the command failed with the following weird msg,

./lncli wallet pendingsweeps
[lncli] Wallet is encrypted. Please unlock using 'lncli unlock', or set password using 'lncli create' if this is the first time starting lnd.

This message is confusing as it doesn't show the RPC isn't built. This is now changed to,

./lncli-debug wallet pendingsweeps
[lncli] rpc error: code = Unimplemented desc = unknown service walletrpc.WalletKit

In addition, this error msg is also fixed,

./lncli unlock       
Input wallet password: 
[lncli] rpc error: code = Unknown desc = wallet already unlocked, WalletUnlocker service is no longer available

is now changed to,

./lncli-debug unlock              
Input wallet password: 
[lncli] Wallet is already unlocked

@yyforyongyu yyforyongyu added wallet The wallet (lnwallet) which LND uses cli Related to the command line interface size/micro small bug fix or feature, less than 15 mins of review, less than 250 labels Mar 17, 2025
@coderabbitai

coderabbitai Bot commented Mar 17, 2025

Copy link
Copy Markdown
Contributor

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.
    • 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 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 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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

The `codes.Unimplemented` is only returned when the RPCs are not built.
When the wallet is in an unexpected state, `codes.Unknown` is returned
instead, so we need to catch it properly to make sure we return the
right error msg.
@yyforyongyu yyforyongyu self-assigned this Mar 18, 2025
@yyforyongyu yyforyongyu added this to the v0.19.0 milestone Mar 18, 2025

@Roasbeef Roasbeef left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM 🥕

@Roasbeef
Roasbeef merged commit c292acf into lightningnetwork:master Mar 18, 2025
@yyforyongyu
yyforyongyu deleted the fix-unlock-wallet branch March 18, 2025 16:39
guggero added a commit to guggero/lnd that referenced this pull request Mar 26, 2025
Fixes a bug introduced by lightningnetwork#9605, fixes lightningnetwork#9648.
We need to use the "Unimplemented" code to detect whether the wallet is
already unlocked. Otherwise we'll always get the wrong error message.
But because the Unimplemented code can also occur if there is a mismatch
between the build tags used for lncli and lnd, we also need to include
that possibility in the erorr message to make sure the user can fix the
problem.
guggero added a commit to guggero/lnd that referenced this pull request Mar 26, 2025
Fixes a bug introduced by lightningnetwork#9605, fixes lightningnetwork#9648.
We need to use the "Unimplemented" code to detect whether the wallet is
already unlocked. Otherwise we'll always get the wrong error message.
But because the Unimplemented code can also occur if there is a mismatch
between the build tags used for lncli and lnd, we also need to include
that possibility in the erorr message to make sure the user can fix the
problem.
guggero added a commit to guggero/lnd that referenced this pull request Mar 26, 2025
Fixes a bug introduced by lightningnetwork#9605, fixes lightningnetwork#9648.
We return a specific error in the RPC permission interceptor for the
case where the wallet is already unlocked or is still locked.
We need to catch those errors correctly to give the user a bit more
context on what to do.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cli Related to the command line interface size/micro small bug fix or feature, less than 15 mins of review, less than 250 wallet The wallet (lnwallet) which LND uses

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants