diff --git a/README.md b/README.md index c04d093..0ec5404 100644 --- a/README.md +++ b/README.md @@ -331,9 +331,10 @@ Quick access: + [fakechanbackup](doc/chantools_fakechanbackup.md) + [filterbackup](doc/chantools_filterbackup.md) + [fixoldbackup](doc/chantools_fixoldbackup.md) ++ [forceclose](doc/chantools_forceclose.md) + [genimportscript](doc/chantools_genimportscript.md) + [migratedb](doc/chantools_migratedb.md) -+ [forceclose](doc/chantools_forceclose.md) ++ [recoverloopin](doc/chantools_recoverloopin.md) + [removechannel](doc/chantools_removechannel.md) + [rescueclosed](doc/chantools_rescueclosed.md) + [rescuefunding](doc/chantools_rescuefunding.md) diff --git a/doc/chantools.md b/doc/chantools.md index 7d1f9c1..fe63648 100644 --- a/doc/chantools.md +++ b/doc/chantools.md @@ -32,6 +32,7 @@ Complete documentation is available at https://github.com/guggero/chantools/. * [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 * [chantools migratedb](chantools_migratedb.md) - Apply all recent lnd channel database migrations +* [chantools recoverloopin](chantools_recoverloopin.md) - Recover a loop in swap that the loop daemon is not able to sweep * [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 diff --git a/doc/chantools_recoverloopin.md b/doc/chantools_recoverloopin.md new file mode 100644 index 0000000..f983881 --- /dev/null +++ b/doc/chantools_recoverloopin.md @@ -0,0 +1,49 @@ +## chantools recoverloopin + +Recover a loop in swap that the loop daemon is not able to sweep + +``` +chantools recoverloopin [flags] +``` + +### Examples + +``` +chantools recoverloopin \ + --txid abcdef01234... \ + --vout 0 \ + --swap_hash abcdef01234... \ + --loop_db_path /path/to/loop.db \ + --sweep_addr bc1pxxxxxxx \ + --feerate 10 +``` + +### Options + +``` + --apiurl string API URL to use (must be esplora compatible) (default "https://blockstream.info/api") + --bip39 read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag + --feerate uint16 fee rate to use for the sweep transaction in sat/vByte + -h, --help help for recoverloopin + --loop_db_path string path to the loop database file + --num_tries int number of tries to try to find the correct key index (default 1000) + --publish publish sweep TX to the chain API instead of just printing the TX + --rootkey string BIP32 HD root key of the wallet to use for deriving starting key; leave empty to prompt for lnd 24 word aezeed + --start_key_index int start key index to try to find the correct key index + --swap_hash string swap hash of the loop in swap + --sweep_addr string address to recover the funds to + --txid string transaction id of the on-chain transaction that created the HTLC + --vout uint32 output index of the on-chain transaction that created the HTLC +``` + +### Options inherited from parent commands + +``` + -r, --regtest Indicates if regtest parameters should be used + -t, --testnet Indicates if testnet parameters should be used +``` + +### SEE ALSO + +* [chantools](chantools.md) - Chantools helps recover funds from lightning channels +