2
0
mirror of https://github.com/guggero/chantools synced 2024-11-18 21:26:23 +00:00
chantools/doc/chantools.md

59 lines
5.2 KiB
Markdown
Raw Normal View History

2020-12-27 00:10:02 +00:00
## chantools
Chantools helps recover funds from lightning channels
### Synopsis
This tool provides helper functions that can be used rescue
funds locked in lnd channels in case lnd itself cannot run properly anymore.
2023-12-29 08:46:04 +00:00
Complete documentation is available at
https://github.com/lightninglabs/chantools/.
2020-12-27 00:10:02 +00:00
### Options
```
-h, --help help for chantools
-r, --regtest Indicates if regtest parameters should be used
2023-09-18 13:09:44 +00:00
-s, --signet Indicates if the public signet parameters should be used
2020-12-27 00:10:02 +00:00
-t, --testnet Indicates if testnet parameters should be used
```
### SEE ALSO
* [chantools chanbackup](chantools_chanbackup.md) - Create a channel.backup file from a channel database
* [chantools closepoolaccount](chantools_closepoolaccount.md) - Tries to close a Pool account that has expired
2020-12-27 00:10:02 +00:00
* [chantools compactdb](chantools_compactdb.md) - Create a copy of a channel.db file in safe/read-only mode
2024-03-12 12:06:32 +00:00
* [chantools createwallet](chantools_createwallet.md) - Create a new lnd compatible wallet.db file from an existing seed or by generating a new one
2021-07-26 09:06:47 +00:00
* [chantools deletepayments](chantools_deletepayments.md) - Remove all (failed) payments from a channel DB
2020-12-27 00:10:02 +00:00
* [chantools derivekey](chantools_derivekey.md) - Derive a key with a specific derivation path
2023-12-29 08:46:04 +00:00
* [chantools doublespendinputs](chantools_doublespendinputs.md) - Replace a transaction by double spending its input
* [chantools dropchannelgraph](chantools_dropchannelgraph.md) - Remove all graph related data from a channel DB
* [chantools dropgraphzombies](chantools_dropgraphzombies.md) - Remove all channels identified as zombies from the graph to force a re-sync of the graph
2020-12-27 00:10:02 +00:00
* [chantools dumpbackup](chantools_dumpbackup.md) - Dump the content of a channel.backup file
* [chantools dumpchannels](chantools_dumpchannels.md) - Dump all channel information from an lnd channel database
* [chantools fakechanbackup](chantools_fakechanbackup.md) - Fake a channel backup file to attempt fund recovery
2020-12-27 00:10:02 +00:00
* [chantools filterbackup](chantools_filterbackup.md) - Filter an lnd channel.backup file and remove certain channels
* [chantools fixoldbackup](chantools_fixoldbackup.md) - Fixes an old channel.backup file that is affected by the lnd issue #3881 (unable to derive shachain root key)
* [chantools forceclose](chantools_forceclose.md) - Force-close the last state that is in the channel.db provided
* [chantools genimportscript](chantools_genimportscript.md) - Generate a script containing the on-chain keys of an lnd wallet that can be imported into other software like bitcoind
2021-01-01 12:19:48 +00:00
* [chantools migratedb](chantools_migratedb.md) - Apply all recent lnd channel database migrations
2023-12-14 10:48:58 +00:00
* [chantools pullanchor](chantools_pullanchor.md) - Attempt to CPFP an anchor output of a channel
2023-04-28 07:24:18 +00:00
* [chantools recoverloopin](chantools_recoverloopin.md) - Recover a loop in swap that the loop daemon is not able to sweep
2020-12-27 00:10:02 +00:00
* [chantools removechannel](chantools_removechannel.md) - Remove a single channel from the given channel DB
* [chantools rescueclosed](chantools_rescueclosed.md) - Try finding the private keys for funds that are in outputs of remotely force-closed channels
* [chantools rescuefunding](chantools_rescuefunding.md) - 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
* [chantools rescuetweakedkey](chantools_rescuetweakedkey.md) - Attempt to rescue funds locked in an address with a key that was affected by a specific bug in lnd
2020-12-27 00:10:02 +00:00
* [chantools showrootkey](chantools_showrootkey.md) - Extract and show the BIP32 HD root key from the 24 word lnd aezeed
2024-03-12 12:06:32 +00:00
* [chantools signmessage](chantools_signmessage.md) - Sign a message with the node's private key.
* [chantools signpsbt](chantools_signpsbt.md) - Sign a Partially Signed Bitcoin Transaction (PSBT)
2020-12-27 00:10:02 +00:00
* [chantools signrescuefunding](chantools_signrescuefunding.md) - 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
* [chantools summary](chantools_summary.md) - Compile a summary about the current state of channels
* [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
2020-12-27 00:10:02 +00:00
* [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 Lightning Network peer and send specific messages to trigger a force close of the specified channel
2020-12-27 00:10:02 +00:00
* [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
2020-12-27 00:10:02 +00:00