Skip to content

Commit 3c04692

Browse files
authored
Merge pull request #145 from hieblmi/update-readme
Update readme with latest command line helptext.
2 parents 3890b63 + 0f056e9 commit 3c04692

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
/chantools
33
results
44
/chantools-v*
5+
.idea

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -402,19 +402,20 @@ run them on a computer with a firewall that blocks outgoing connections.
402402
```text
403403
This tool provides helper functions that can be used rescue
404404
funds locked in lnd channels in case lnd itself cannot run properly anymore.
405-
Complete documentation is available at https://github.com/lightninglabs/chantools/.
405+
Complete documentation is available at
406+
https://github.com/lightninglabs/chantools/.
406407
407408
Usage:
408409
chantools [command]
409410
410411
Available Commands:
411412
chanbackup Create a channel.backup file from a channel database
412413
closepoolaccount Tries to close a Pool account that has expired
413-
compactdb Create a copy of a channel.db file in safe/read-only mode
414414
createwallet Create a new lnd compatible wallet.db file from an existing seed or by generating a new one
415+
compactdb Create a copy of a channel.db file in safe/read-only mode
415416
deletepayments Remove all (failed) payments from a channel DB
416417
derivekey Derive a key with a specific derivation path
417-
doublespendinputs Tries to double spend the given inputs by deriving the private for the address and sweeping the funds to the given address. This can only be used with inputs that belong to an lnd wallet.
418+
doublespendinputs Replace a transaction by double spending its input
418419
dropchannelgraph Remove all graph related data from a channel DB
419420
dropgraphzombies Remove all channels identified as zombies from the graph to force a re-sync of the graph
420421
dumpbackup Dump the content of a channel.backup file
@@ -426,19 +427,20 @@ Available Commands:
426427
genimportscript Generate a script containing the on-chain keys of an lnd wallet that can be imported into other software like bitcoind
427428
migratedb Apply all recent lnd channel database migrations
428429
pullanchor Attempt to CPFP an anchor output of a channel
430+
recoverloopin Recover a loop in swap that the loop daemon is not able to sweep
429431
removechannel Remove a single channel from the given channel DB
430432
rescueclosed Try finding the private keys for funds that are in outputs of remotely force-closed channels
431433
rescuefunding Rescue funds locked in a funding multisig output that never resulted in a proper channel; this is the command the initiator of the channel needs to run
432434
rescuetweakedkey Attempt to rescue funds locked in an address with a key that was affected by a specific bug in lnd
433435
showrootkey Extract and show the BIP32 HD root key from the 24 word lnd aezeed
434-
signmessage Sign a message with the nodes identity pubkey.
435-
signpsbt Sign a Partially Signed Bitcoin Transaction (PSBT)
436+
signmessage Sign a message with the node's private key.
436437
signrescuefunding Rescue funds locked in a funding multisig output that never resulted in a proper channel; this is the command the remote node (the non-initiator) of the channel needs to run
438+
signpsbt Sign a Partially Signed Bitcoin Transaction (PSBT)
437439
summary Compile a summary about the current state of channels
438440
sweeptimelock Sweep the force-closed state after the time lock has expired
439441
sweeptimelockmanual Sweep the force-closed state of a single channel manually if only a channel backup file is available
440442
sweepremoteclosed 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
441-
triggerforceclose Connect to a peer and send request to trigger a force close of the specified channel
443+
triggerforceclose Connect to a Lightning Network peer and send specific messages to trigger a force close of the specified channel
442444
vanitygen Generate a seed with a custom lnd node identity public key that starts with the given prefix
443445
walletinfo Shows info about an lnd wallet.db file and optionally extracts the BIP32 HD root key
444446
zombierecovery Try rescuing funds stuck in channels with zombie nodes
@@ -447,7 +449,9 @@ Available Commands:
447449
Flags:
448450
-h, --help help for chantools
449451
-r, --regtest Indicates if regtest parameters should be used
452+
-s, --signet Indicates if the public signet parameters should be used
450453
-t, --testnet Indicates if testnet parameters should be used
454+
-v, --version version for chantools
451455
452456
Use "chantools [command] --help" for more information about a command.
453457
```

0 commit comments

Comments
 (0)