rpc: proper error code for GetChanInfo #9810

torkelrogstad · 2025-05-15T08:37:43Z

Change Description

When a channel edge is not found, return NotFound instead of the generic Unknown error code.

Steps to Test

Call the GetChanInfo RPC endpoint on an unknown channel.
Observe that a proper NotFound error code is returned.

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 is not insubstantial. Typo fixes are not accepted to fight bot spam.
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 · 2025-05-15T08:37:53Z

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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

guggero

Makes sense, thanks for the PR!

docs/release-notes/release-notes-0.19.0.md

itest/lnd_channel_graph_test.go

lntest/rpc/harness_rpc.go

rpcserver.go

When a channel edge is not found, return `NotFound` instead of the generic `Unknown` error code.

torkelrogstad · 2025-05-15T16:13:01Z

Thanks @guggero, addressed your comments.

mohamedawnallah

Thanks for the PR. This one is probably addressing part of #6729? I've left some nit comments otherwise LGTM

mohamedawnallah · 2025-05-15T20:36:04Z

itest/lnd_channel_graph_test.go

+// testGetChannelInfoNotFound verifies that a missing channel reports an
+// appropriate gRPC status code when calling GetChanInfo
+func testGetChannelInfoNotFound(ht *lntest.HarnessTest) {
+	ctx, cancel := context.WithTimeout(context.Background(), lntest.DefaultTimeout)


The lint code CI test didn't pass here because of 87 chars exceeds 80 chars. This could be:

ctx, cancel := context.WithTimeout( context.Background(), lntest.DefaultTimeout )

You could run make lint and make fmt to see if there are no linting issues in local dev.

mohamedawnallah · 2025-05-15T20:36:26Z

itest/lnd_channel_graph_test.go

@@ -420,6 +424,24 @@ func testNodeAnnouncement(ht *lntest.HarnessTest) {
 	assertAddrs(nodeUpdate.Addresses, advertisedAddrs...)
 }

+// testGetChannelInfoNotFound verifies that a missing channel reports an
+// appropriate gRPC status code when calling GetChanInfo


Nit: . at the end of the comment

mohamedawnallah · 2025-05-15T20:41:41Z

docs/release-notes/release-notes-0.19.1.md

Also the release the note needs to be in a separate git commit after adding the changes

nit: there're no hard requirements on this, but yeah nice to have.

yyforyongyu · 2025-05-18T23:36:11Z

docs/release-notes/release-notes-0.19.1.md

nit: there're no hard requirements on this, but yeah nice to have.

yyforyongyu · 2025-05-18T23:37:20Z

docs/release-notes/release-notes-0.19.1.md

+
+# Bug Fixes
+
+* [Fix a bug](https://github.com/lightningnetwork/lnd/pull/9810) where the


I would put this under ## RPC Updates so the node runners can update accordingly, as it's a behavior change in the RPC.

yyforyongyu · 2025-05-18T23:38:31Z

itest/lnd_channel_graph_test.go

@@ -420,6 +424,24 @@ func testNodeAnnouncement(ht *lntest.HarnessTest) {
 	assertAddrs(nodeUpdate.Addresses, advertisedAddrs...)
 }

+// testGetChannelInfoNotFound verifies that a missing channel reports an


nit: I think this test belongs to lnd_misc_test.go

yyforyongyu · 2025-05-18T23:41:55Z

itest/lnd_channel_graph_test.go

+	defer cancel()
+
+	alice := ht.NewNode("Alice", nil)
+	_, err := alice.RPC.LN.GetChanInfo(ctx, &lnrpc.ChanInfoRequest{


Can we create a GetChanInfoAssertErr instead to keep the format consistent? sth like,

lnd/lntest/rpc/lnd.go

Lines 366 to 390 in 3707b1f

// SendCoins sends a given amount of money to the specified address from the

// passed node.

func (h *HarnessRPC) SendCoins(

req *lnrpc.SendCoinsRequest) *lnrpc.SendCoinsResponse {

ctxt, cancel := context.WithTimeout(h.runCtx, DefaultTimeout)

defer cancel()

resp, err := h.LN.SendCoins(ctxt, req)

h.NoError(err, "SendCoins")

return resp

}

// SendCoinsAssertErr sends a given amount of money to the specified address

// from the passed node and asserts an error has returned.

func (h *HarnessRPC) SendCoinsAssertErr(req *lnrpc.SendCoinsRequest) error {

ctxt, cancel := context.WithTimeout(h.runCtx, DefaultTimeout)

defer cancel()

_, err := h.LN.SendCoins(ctxt, req)

require.Error(h, err, "node %s didn't not return an error", h.Name)

return err

}

torkelrogstad force-pushed the 2025-05-15-getchaninfo branch from 1f4cbf5 to f6b50e0 Compare May 15, 2025 09:16

guggero reviewed May 15, 2025

View reviewed changes

docs/release-notes/release-notes-0.19.0.md Outdated Show resolved Hide resolved

itest/lnd_channel_graph_test.go Show resolved Hide resolved

lntest/rpc/harness_rpc.go Outdated Show resolved Hide resolved

rpcserver.go Show resolved Hide resolved

rpc: proper error code for GetChanInfo

80792fe

When a channel edge is not found, return `NotFound` instead of the generic `Unknown` error code.

torkelrogstad force-pushed the 2025-05-15-getchaninfo branch from f6b50e0 to 80792fe Compare May 15, 2025 16:12

saubyk assigned torkelrogstad May 15, 2025

saubyk added this to the v0.19.1 milestone May 15, 2025

mohamedawnallah reviewed May 15, 2025

View reviewed changes

yyforyongyu reviewed May 18, 2025

View reviewed changes


		# Bug Fixes

		* [Fix a bug](https://github.com/lightningnetwork/lnd/pull/9810) where the

	// SendCoins sends a given amount of money to the specified address from the
	// passed node.
	func (h *HarnessRPC) SendCoins(
	req lnrpc.SendCoinsRequest) lnrpc.SendCoinsResponse {

	ctxt, cancel := context.WithTimeout(h.runCtx, DefaultTimeout)
	defer cancel()

	resp, err := h.LN.SendCoins(ctxt, req)
	h.NoError(err, "SendCoins")

	return resp
	}

	// SendCoinsAssertErr sends a given amount of money to the specified address
	// from the passed node and asserts an error has returned.
	func (h HarnessRPC) SendCoinsAssertErr(req lnrpc.SendCoinsRequest) error {
	ctxt, cancel := context.WithTimeout(h.runCtx, DefaultTimeout)
	defer cancel()

	_, err := h.LN.SendCoins(ctxt, req)
	require.Error(h, err, "node %s didn't not return an error", h.Name)

	return err
	}

rpc: proper error code for GetChanInfo #9810

Are you sure you want to change the base?

rpc: proper error code for GetChanInfo #9810

Uh oh!

Conversation

torkelrogstad commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change Description

Steps to Test

Pull Request Checklist

Testing

Code Style and Documentation

Uh oh!

coderabbitai bot commented May 15, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

guggero left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

torkelrogstad commented May 15, 2025

Uh oh!

mohamedawnallah left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

torkelrogstad commented May 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)