Skip to content

Commit

Permalink
doc+triggerforceclose: make command help more explicit
Browse files Browse the repository at this point in the history
  • Loading branch information
guggero committed Sep 14, 2023
1 parent b0097ad commit 4926ae2
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
7 changes: 6 additions & 1 deletion cmd/chantools/triggerforceclose.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,13 @@ func newTriggerForceCloseCommand() *cobra.Command {
cc := &triggerForceCloseCommand{}
cc.cmd = &cobra.Command{
Use: "triggerforceclose",
Short: "Connect to a peer and send a custom message to " +
Short: "Connect to a CLN peer and send a custom message to " +
"trigger a force close of the specified channel",
Long: `Certain versions of CLN didn't properly react to error
messages sent by peers and therefore didn't follow the DLP protocol to recover
channel funds using SCB. This command can be used to trigger a force close with
those earlier versions of CLN (this command will not work for lnd peers or CLN
peers of a different version).`,
Example: `chantools triggerforceclose \
--peer 03abce...@xx.yy.zz.aa:9735 \
--channel_point abcdef01234...:x`,
Expand Down
2 changes: 1 addition & 1 deletion doc/chantools.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Complete documentation is available at https://github.com/lightninglabs/chantool
* [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
* [chantools sweeptimelock](chantools_sweeptimelock.md) - Sweep the force-closed state after the time lock has expired
* [chantools sweeptimelockmanual](chantools_sweeptimelockmanual.md) - Sweep the force-closed state of a single channel manually if only a channel backup file is available
* [chantools triggerforceclose](chantools_triggerforceclose.md) - Connect to a peer and send a custom message to trigger a force close of the specified channel
* [chantools triggerforceclose](chantools_triggerforceclose.md) - Connect to a CLN peer and send a custom message to trigger a force close of the specified channel
* [chantools vanitygen](chantools_vanitygen.md) - Generate a seed with a custom lnd node identity public key that starts with the given prefix
* [chantools walletinfo](chantools_walletinfo.md) - Shows info about an lnd wallet.db file and optionally extracts the BIP32 HD root key
* [chantools zombierecovery](chantools_zombierecovery.md) - Try rescuing funds stuck in channels with zombie nodes
Expand Down
10 changes: 9 additions & 1 deletion doc/chantools_triggerforceclose.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
## chantools triggerforceclose

Connect to a peer and send a custom message to trigger a force close of the specified channel
Connect to a CLN peer and send a custom message to trigger a force close of the specified channel

### Synopsis

Certain versions of CLN didn't properly react to error
messages sent by peers and therefore didn't follow the DLP protocol to recover
channel funds using SCB. This command can be used to trigger a force close with
those earlier versions of CLN (this command will not work for lnd peers or CLN
peers of a different version).

```
chantools triggerforceclose [flags]
Expand Down

0 comments on commit 4926ae2

Please sign in to comment.