improve CloseChannel docs #9958

ZZiigguurraatt · 2025-06-17T17:43:24Z

This is a docs change only to improve the clarity of how to use CloseChannel .

Fixes #9771
Fixes #9837

coderabbitai · 2025-06-17T17:43:29Z

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.

ZZiigguurraatt · 2025-06-17T18:02:38Z

Do I also need to update lightning.swagger.json to properly complete this PR? It is unclear to me why we seem to have duplicate text in there. What is lightning.swagger.json for?

guggero · 2025-06-17T18:19:10Z

Do I also need to update lightning.swagger.json to properly complete this PR? It is unclear to me why we seem to have duplicate text in there. What is lightning.swagger.json for?

Yes, you need to generate the stubs with make rpc.

ZZiigguurraatt · 2025-06-19T15:25:53Z

@ziggie1984 please review.

lnrpc/lightning.proto

ziggie1984

Nice addition!

ziggie1984 · 2025-06-20T06:19:54Z

lnrpc/lightning.proto

+    // If `no_wait=true` (`wait=false`) when a coop close is attempted, then the
+    // rpc call will not initially block while it awaits a closing txid to be
+    // broadcasted to the mempool. Instead, a coop close will be initiated even
+    // if there are HTLCs active in flight on the channel and a `close_instant`


and a close_instant msg will sent over the stream ...

please check my update

lnrpc/lightning.proto

ziggie1984 · 2025-06-20T06:34:00Z

lnrpc/lightning.proto

+    // resolved before that can happen. If a coop close is attempted with no in
+    // flight HTLCs on the channel OR a force close is attempted, the `no_wait`
+    // option is ignored. In summary, the `no_wait` option controls if the user


If a coop close is attempted with no inflight HTLCs on the channel the no_wait=true parameter has still the effect that the stream sends the close_instant msg immediately however that should not make much of a difference because LND should broadcast the closing tx without much time delay and therefore should send the close_pending update right after.

please check my update on this. I'm not sure if I got it right about force closing.

ziggie1984 · 2025-06-20T06:35:25Z

lnrpc/lightning.proto

+    // wait for the in flight HTLCs to be resolved and then start the coop
+    // closing process. Note: `lncli closechannel` always sets `no_wait=true`
+    // and its `--block` option controls if `lncli` should wait for a
+    // `close_pending` update and a `chan_close` update before returning or if


should wait for the chan_close update (we still on the lncli side wait for the close_pending, which signals when the tx is broadcasted to the mempool)

please check my update

lnrpc/lightning.proto

ziggie1984 · 2025-06-23T20:31:58Z

lnrpc/lightning.proto

+    // will fail and abort the closing process because it can't wait for a
+    // closing TXID to be broadcast to the mempool because it needs to
+    // immediately tell the user that there are in flight HTLCs that need to be
+    // resolved before that can happen. If a coop close is attempted with no in


then the rpc call will fail and abort the closing process because the caller wants to wait for the closing tx being broadcasted to the mempool but because of the inflight HTLCs this can be very long therefore LND will not allow initiating the coop-close with this setting.

it is not that we can't we just decided to not do so because of the above reasons, does it make sense ?

no, that is very convoluted.

Ok I am trying to say, that we decided to not close the channel in that case because we do not want the user to wait until the HTLCs resolves because he signaled via "wait=true" he wants to wait for the closing information. But we definitely could, like technically this is not a problem, it is just we decided not to, to make sure the user does not have to wait forever

so how exactly would you re-write the sentence?

ZZiigguurraatt · 2025-06-24T15:17:05Z

taking out of draft as I'd like to see some feedback from others. @saubyk , do you have any feedback?

lnrpc/lightning.proto

ziggie1984

LGTM

saubyk · 2025-06-26T03:40:44Z

lnrpc/lightning.pb.go

-	// initiated even if HTLCs are active on the channel. The channel will wait
-	// until all HTLCs are resolved and then start the coop closing process. The
-	// channel will be disabled in the meantime and will disallow any new HTLCs.
+	// When force closing, `no_wait` has no effect.


This is an extremely verbose description and it doesn't seem to me that this is right place to get into the detailed scenarios here. How and where would this content would be made available to the user?

My first reaction is that it's not easy to follow and digest. And we may need to supplement the documentation somewhere else, rather than here.

docs: explain RBF coop CloseChannel usage

b0c0cde

ZZiigguurraatt force-pushed the closechannel_docs branch 2 times, most recently from 6380421 to 89cd7f2 Compare June 19, 2025 15:20

ZZiigguurraatt commented Jun 19, 2025

View reviewed changes

lnrpc/lightning.proto Show resolved Hide resolved

ZZiigguurraatt mentioned this pull request Jun 19, 2025

[bug]: CloseChannel: no_wait=True still waiting #9837

Open

ZZiigguurraatt force-pushed the closechannel_docs branch from 89cd7f2 to e4caccb Compare June 19, 2025 15:44

ziggie1984 reviewed Jun 20, 2025

View reviewed changes

ZZiigguurraatt force-pushed the closechannel_docs branch from e4caccb to ae1a1d1 Compare June 20, 2025 15:23

ZZiigguurraatt requested a review from ziggie1984 June 20, 2025 15:24

ziggie1984 reviewed Jun 23, 2025

View reviewed changes

docs: better explain CloseChannel no_wait option

4eab4b3

ZZiigguurraatt force-pushed the closechannel_docs branch from ae1a1d1 to 4eab4b3 Compare June 24, 2025 15:13

ZZiigguurraatt marked this pull request as ready for review June 24, 2025 15:16

ZZiigguurraatt requested a review from ziggie1984 June 24, 2025 15:16

ziggie1984 reviewed Jun 24, 2025

View reviewed changes

lnrpc/lightning.proto Show resolved Hide resolved

ziggie1984 approved these changes Jun 24, 2025

View reviewed changes

ziggie1984 requested a review from saubyk June 24, 2025 17:10

saubyk reviewed Jun 26, 2025

View reviewed changes

improve CloseChannel docs #9958

Are you sure you want to change the base?

improve CloseChannel docs #9958

Conversation

ZZiigguurraatt commented Jun 17, 2025 • edited by saubyk Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jun 17, 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!

ZZiigguurraatt commented Jun 17, 2025

Uh oh!

guggero commented Jun 17, 2025

Uh oh!

ZZiigguurraatt commented Jun 19, 2025

Uh oh!

Uh oh!

ziggie1984 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!

Uh oh!

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!

Uh oh!

Uh oh!

Uh oh!

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!

ZZiigguurraatt commented Jun 24, 2025

Uh oh!

Uh oh!

ziggie1984 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ZZiigguurraatt commented Jun 17, 2025 •

edited by saubyk

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)