Skip to content
This repository has been archived by the owner on Jun 26, 2024. It is now read-only.

Commit

Permalink
doc: Updated dev command warning
Browse files Browse the repository at this point in the history
Changelog-Changed: Documentation: Merged `example_json_request` and `example_json_response` in a single `json_examples` array to maintain the request and its corresponding response together.
  • Loading branch information
ShahanaFarooqui authored and rustyrussell committed Apr 4, 2024
1 parent 9e782f4 commit aff8f0f
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 0 deletions.
2 changes: 2 additions & 0 deletions contrib/msggen/msggen/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -8794,6 +8794,8 @@
"title": "Command to remove the DB entries from the database after a close",
"warning": "For advanced users only",
"description": [
"Never use any `dev` command, including this one, unless you know exactly what you are doing; and have checked with a developer that your understanding is correct. They are meant only as a means of last resort and have the potential to mess things up. You have been warned\u2757\ufe0f",
"",
"The **dev-forget-channel** forgets the channel with given details. It will perform additional checks on whether it is safe to forget the channel, and only then remove the channel from the DB. Notice that this command is only available if CLN was started with --developer.",
"",
"Also see https://docs.corelightning.org/docs/faq#how-to-forget-about-a-channel"
Expand Down
6 changes: 6 additions & 0 deletions doc/node-operators-guide/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,12 @@ Effort has been made to get `lightningd` running on Android, [see issue #3484](h

### How to forget about a channel?

> 🚧
>
> Never use any `dev` command unless you know exactly what you are doing, and have checked with a developer that your understanding is correct. They are meant only as a means of last resort and have the potential to mess things up. You have been warned❗️
>

Channels may end up stuck during funding and never confirm on-chain. There is a variety of causes, the most common ones being that the funds have been double-spent, or the funding fee was too low to be confirmed. This is unlikely to happen in normal operation, as CLN tries to use sane defaults and prevents double-spends whenever possible, but using custom feerates or when the bitcoin backend has no good fee estimates it is still possible.

Before forgetting about a channel it is important to ensure that the funding transaction will never be confirmable by double-spending the funds. To do so you have to rescan the UTXOs using
Expand Down
2 changes: 2 additions & 0 deletions doc/schemas/lightning-dev-forget-channel.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
"title": "Command to remove the DB entries from the database after a close",
"warning": "For advanced users only",
"description": [
"Never use any `dev` command, including this one, unless you know exactly what you are doing; and have checked with a developer that your understanding is correct. They are meant only as a means of last resort and have the potential to mess things up. You have been warned❗️",
"",
"The **dev-forget-channel** forgets the channel with given details. It will perform additional checks on whether it is safe to forget the channel, and only then remove the channel from the DB. Notice that this command is only available if CLN was started with --developer.",
"",
"Also see https://docs.corelightning.org/docs/faq#how-to-forget-about-a-channel"
Expand Down

0 comments on commit aff8f0f

Please sign in to comment.