Skip to content

Commit d57f64a

Browse files
committed
README: mark CLN compatible commands
1 parent 38df842 commit d57f64a

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
* [Commands](#commands)
1010

1111
This tool provides helper functions that can be used to rescue funds locked in
12-
`lnd` channels in case `lnd` itself cannot run properly anymore.
12+
`lnd` channels in case `lnd` itself cannot run properly anymore (some commands
13+
also support Core Lightning (CLN), check [command overview](#commands) below
14+
for a list of compatible commands).
1315

1416
**WARNING**: This tool was specifically built for a certain rescue operation and
1517
might not be well-suited for your use case. Or not all edge cases for your needs
@@ -30,7 +32,7 @@ Example (make sure you always use the latest version!):
3032

3133
```shell
3234
$ cd /tmp
33-
$ wget -O chantools.tar.gz https://github.com/lightninglabs/chantools/releases/download/v0.13.4/chantools-linux-amd64-v0.13.4.tar.gz
35+
$ wget -O chantools.tar.gz https://github.com/lightninglabs/chantools/releases/download/v0.13.7/chantools-linux-amd64-v0.13.7.tar.gz
3436
$ tar -zxvf chantools.tar.gz
3537
$ sudo mv chantools-*/chantools /usr/local/bin/
3638
```
@@ -472,6 +474,8 @@ Legend:
472474
- :skull: Danger of loss of funds, only use when instructed to.
473475
- :pushpin: Command was created for a very specific version or use case and most
474476
likely does not apply to 99.9% of users
477+
- **CLN**: Command is compatible with Core Lightning (CLN), use `--hsm_secret`
478+
flag instead of root key or wallet.
475479

476480
| Command | Use when |
477481
|-------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
@@ -482,7 +486,7 @@ Legend:
482486
| [deletepayments](doc/chantools_deletepayments.md) | Remove ALL payments from a `channel.db` file to reduce size |
483487
| [derivekey](doc/chantools_derivekey.md) | :pencil: Derive a single private/public key from `lnd`'s seed, use to test seed |
484488
| [doublespendinputs](doc/chantools_doublespendinputs.md) | :pencil: Tries to double spend the given inputs by deriving the private for the address and sweeping the funds to the given address |
485-
| [dropchannelgraph](doc/chantools_dropchannelgraph.md) | (:warning:) Completely drop the channel graph from a `channel.db` to force re-sync |
489+
| [dropchannelgraph](doc/chantools_dropchannelgraph.md) | ( :warning: ) Completely drop the channel graph from a `channel.db` to force re-sync (not recommended while channels are open!) |
486490
| [dropgraphzombies](doc/chantools_dropgraphzombies.md) | Drop all zombie channels from a `channel.db` to force a graph re-sync |
487491
| [dumpbackup](doc/chantools_dumpbackup.md) | :pencil: Show the content of a `channel.backup` file as text |
488492
| [dumpchannels](doc/chantools_dumpchannels.md) | Show the content of a `channel.db` file as text |
@@ -503,13 +507,13 @@ Legend:
503507
| [signpsbt](doc/chantools_signpsbt.md) | :pencil: Sign a Partially Signed Bitcoin Transaction (PSBT) |
504508
| [signrescuefunding](doc/chantools_signrescuefunding.md) | :pencil: (:pushpin:) Sign to funds from a funding transaction. Deprecated, use [zombierecovery](doc/chantools_zombierecovery.md) instead |
505509
| [summary](doc/chantools_summary.md) | Create a summary of channel funds from a `channel.db` file |
506-
| [sweepremoteclosed](doc/chantools_sweepremoteclosed.md) | :pencil: Find channel funds from remotely force closed channels and sweep them |
510+
| [sweepremoteclosed](doc/chantools_sweepremoteclosed.md) | :pencil: **CLN** Find channel funds from remotely force closed channels and sweep them |
507511
| [sweeptimelock](doc/chantools_sweeptimelock.md) | :pencil: Sweep funds in locally force closed channels once time lock has expired (requires `channel.db`) |
508512
| [sweeptimelockmanual](doc/chantools_sweeptimelockmanual.md) | :pencil: Manually sweep funds in a locally force closed channel where no `channel.db` file is available |
509-
| [triggerforceclose](doc/chantools_triggerforceclose.md) | :pencil: (:pushpin:) Request a peer to force close a channel |
513+
| [triggerforceclose](doc/chantools_triggerforceclose.md) | :pencil: **CLN** (:pushpin:) Request a peer to force close a channel |
510514
| [vanitygen](doc/chantools_vanitygen.md) | Generate an `lnd` seed for a node public key that starts with a certain sequence of hex digits |
511515
| [walletinfo](doc/chantools_walletinfo.md) | Show information from a `wallet.db` file, requires access to the wallet password |
512-
| [zombierecovery](doc/chantools_zombierecovery.md) | :pencil: Cooperatively rescue funds from channels where normal recovery is not possible (see [full guide here][zombie-recovery]) |
516+
| [zombierecovery](doc/chantools_zombierecovery.md) | :pencil: **CLN** Cooperatively rescue funds from channels where normal recovery is not possible (see [full guide here][zombie-recovery]) |
513517

514518
[safety]: https://github.com/lightningnetwork/lnd/blob/master/docs/safety.md
515519

0 commit comments

Comments
 (0)