From 4926ae2db82ed63fd99eb74f80bc77c8fb322d19 Mon Sep 17 00:00:00 2001 From: Oliver Gugger Date: Thu, 14 Sep 2023 11:24:14 +0200 Subject: [PATCH] doc+triggerforceclose: make command help more explicit --- cmd/chantools/triggerforceclose.go | 7 ++++++- doc/chantools.md | 2 +- doc/chantools_triggerforceclose.md | 10 +++++++++- 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/cmd/chantools/triggerforceclose.go b/cmd/chantools/triggerforceclose.go index c1775fe..2a33316 100644 --- a/cmd/chantools/triggerforceclose.go +++ b/cmd/chantools/triggerforceclose.go @@ -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`, diff --git a/doc/chantools.md b/doc/chantools.md index 4c6b1a3..c3cc344 100644 --- a/doc/chantools.md +++ b/doc/chantools.md @@ -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 diff --git a/doc/chantools_triggerforceclose.md b/doc/chantools_triggerforceclose.md index ed0ca63..0575d2b 100644 --- a/doc/chantools_triggerforceclose.md +++ b/doc/chantools_triggerforceclose.md @@ -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]