chantools/doc/chantools.md

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. Complete documentation is available at https://github.com/lightninglabs/chantools/.

Options

  -h, --help                help for chantools
      --nologfile           If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
  -r, --regtest             Indicates if regtest parameters should be used
      --resultsdir string   Directory where results should be stored (default "./results")
  -s, --signet              Indicates if the public signet parameters should be used
  -t, --testnet             Indicates if testnet parameters should be used

SEE ALSO

• chantools chanbackup - Create a channel.backup file from a channel database
• chantools closepoolaccount - Tries to close a Pool account that has expired
• chantools compactdb - Create a copy of a channel.db file in safe/read-only mode
• chantools completion - Generate the autocompletion script for the specified shell
• chantools createwallet - Create a new lnd compatible wallet.db file from an existing seed or by generating a new one
• chantools deletepayments - Remove all (failed) payments from a channel DB
• chantools derivekey - Derive a key with a specific derivation path
• chantools doublespendinputs - Replace a transaction by double spending its input
• chantools dropchannelgraph - Remove all graph related data from a channel DB
• chantools dropgraphzombies - Remove all channels identified as zombies from the graph to force a re-sync of the graph
• chantools dumpbackup - Dump the content of a channel.backup file
• chantools dumpchannels - Dump all channel information from an lnd channel database
• chantools fakechanbackup - Fake a channel backup file to attempt fund recovery
• chantools filterbackup - Filter an lnd channel.backup file and remove certain channels
• chantools fixoldbackup - Fixes an old channel.backup file that is affected by the lnd issue #3881 (unable to derive shachain root key)
• chantools forceclose - Force-close the last state that is in the channel.db provided
• chantools genimportscript - Generate a script containing the on-chain keys of an lnd wallet that can be imported into other software like bitcoind
• chantools migratedb - Apply all recent lnd channel database migrations
• chantools pullanchor - Attempt to CPFP an anchor output of a channel
• chantools recoverloopin - Recover a loop in swap that the loop daemon is not able to sweep
• chantools removechannel - Remove a single channel from the given channel DB
• chantools rescueclosed - Try finding the private keys for funds that are in outputs of remotely force-closed channels
• chantools 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
• chantools rescuetweakedkey - Attempt to rescue funds locked in an address with a key that was affected by a specific bug in lnd
• chantools scbforceclose - Force-close the last state that is in the SCB provided
• chantools showrootkey - Extract and show the BIP32 HD root key from the 24 word lnd aezeed
• chantools signmessage - Sign a message with the node's private key.
• chantools signpsbt - Sign a Partially Signed Bitcoin Transaction (PSBT)
• chantools 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
• chantools summary - Compile a summary about the current state of channels
• chantools 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
• chantools sweeptimelock - Sweep the force-closed state after the time lock has expired
• chantools sweeptimelockmanual - Sweep the force-closed state of a single channel manually if only a channel backup file is available
• chantools triggerforceclose - Connect to a Lightning Network peer and send specific messages to trigger a force close of the specified channel
• chantools vanitygen - Generate a seed with a custom lnd node identity public key that starts with the given prefix
• chantools walletinfo - Shows info about an lnd wallet.db file and optionally extracts the BIP32 HD root key
• chantools zombierecovery - Try rescuing funds stuck in channels with zombie nodes