Skip to content

Commit 4926ae2

Browse files
committed
doc+triggerforceclose: make command help more explicit
1 parent b0097ad commit 4926ae2

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

cmd/chantools/triggerforceclose.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,13 @@ func newTriggerForceCloseCommand() *cobra.Command {
3838
cc := &triggerForceCloseCommand{}
3939
cc.cmd = &cobra.Command{
4040
Use: "triggerforceclose",
41-
Short: "Connect to a peer and send a custom message to " +
41+
Short: "Connect to a CLN peer and send a custom message to " +
4242
"trigger a force close of the specified channel",
43+
Long: `Certain versions of CLN didn't properly react to error
44+
messages sent by peers and therefore didn't follow the DLP protocol to recover
45+
channel funds using SCB. This command can be used to trigger a force close with
46+
those earlier versions of CLN (this command will not work for lnd peers or CLN
47+
peers of a different version).`,
4348
Example: `chantools triggerforceclose \
4449
--peer [email protected]:9735 \
4550
--channel_point abcdef01234...:x`,

doc/chantools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Complete documentation is available at https://github.com/lightninglabs/chantool
4444
* [chantools sweepremoteclosed](chantools_sweepremoteclosed.md) - Go through all the addresses that could have funds of channels that were force-closed by the remote party. A public block explorer is queried for each address and if any balance is found, all funds are swept to a given address
4545
* [chantools sweeptimelock](chantools_sweeptimelock.md) - Sweep the force-closed state after the time lock has expired
4646
* [chantools sweeptimelockmanual](chantools_sweeptimelockmanual.md) - Sweep the force-closed state of a single channel manually if only a channel backup file is available
47-
* [chantools triggerforceclose](chantools_triggerforceclose.md) - Connect to a peer and send a custom message to trigger a force close of the specified channel
47+
* [chantools triggerforceclose](chantools_triggerforceclose.md) - Connect to a CLN peer and send a custom message to trigger a force close of the specified channel
4848
* [chantools vanitygen](chantools_vanitygen.md) - Generate a seed with a custom lnd node identity public key that starts with the given prefix
4949
* [chantools walletinfo](chantools_walletinfo.md) - Shows info about an lnd wallet.db file and optionally extracts the BIP32 HD root key
5050
* [chantools zombierecovery](chantools_zombierecovery.md) - Try rescuing funds stuck in channels with zombie nodes

doc/chantools_triggerforceclose.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
## chantools triggerforceclose
22

3-
Connect to a peer and send a custom message to trigger a force close of the specified channel
3+
Connect to a CLN peer and send a custom message to trigger a force close of the specified channel
4+
5+
### Synopsis
6+
7+
Certain versions of CLN didn't properly react to error
8+
messages sent by peers and therefore didn't follow the DLP protocol to recover
9+
channel funds using SCB. This command can be used to trigger a force close with
10+
those earlier versions of CLN (this command will not work for lnd peers or CLN
11+
peers of a different version).
412

513
```
614
chantools triggerforceclose [flags]

0 commit comments

Comments
 (0)