Skip to content

Commit 732217b

Browse files
committed
doc: add recoverloopin
1 parent 890a1ca commit 732217b

File tree

3 files changed

+52
-1
lines changed

3 files changed

+52
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,9 +331,10 @@ Quick access:
331331
+ [fakechanbackup](doc/chantools_fakechanbackup.md)
332332
+ [filterbackup](doc/chantools_filterbackup.md)
333333
+ [fixoldbackup](doc/chantools_fixoldbackup.md)
334+
+ [forceclose](doc/chantools_forceclose.md)
334335
+ [genimportscript](doc/chantools_genimportscript.md)
335336
+ [migratedb](doc/chantools_migratedb.md)
336-
+ [forceclose](doc/chantools_forceclose.md)
337+
+ [recoverloopin](doc/chantools_recoverloopin.md)
337338
+ [removechannel](doc/chantools_removechannel.md)
338339
+ [rescueclosed](doc/chantools_rescueclosed.md)
339340
+ [rescuefunding](doc/chantools_rescuefunding.md)

doc/chantools.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Complete documentation is available at https://github.com/guggero/chantools/.
3232
* [chantools forceclose](chantools_forceclose.md) - Force-close the last state that is in the channel.db provided
3333
* [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
3434
* [chantools migratedb](chantools_migratedb.md) - Apply all recent lnd channel database migrations
35+
* [chantools recoverloopin](chantools_recoverloopin.md) - Recover a loop in swap that the loop daemon is not able to sweep
3536
* [chantools removechannel](chantools_removechannel.md) - Remove a single channel from the given channel DB
3637
* [chantools rescueclosed](chantools_rescueclosed.md) - Try finding the private keys for funds that are in outputs of remotely force-closed channels
3738
* [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

doc/chantools_recoverloopin.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## chantools recoverloopin
2+
3+
Recover a loop in swap that the loop daemon is not able to sweep
4+
5+
```
6+
chantools recoverloopin [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
chantools recoverloopin \
13+
--txid abcdef01234... \
14+
--vout 0 \
15+
--swap_hash abcdef01234... \
16+
--loop_db_path /path/to/loop.db \
17+
--sweep_addr bc1pxxxxxxx \
18+
--feerate 10
19+
```
20+
21+
### Options
22+
23+
```
24+
--apiurl string API URL to use (must be esplora compatible) (default "https://blockstream.info/api")
25+
--bip39 read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag
26+
--feerate uint16 fee rate to use for the sweep transaction in sat/vByte
27+
-h, --help help for recoverloopin
28+
--loop_db_path string path to the loop database file
29+
--num_tries int number of tries to try to find the correct key index (default 1000)
30+
--publish publish sweep TX to the chain API instead of just printing the TX
31+
--rootkey string BIP32 HD root key of the wallet to use for deriving starting key; leave empty to prompt for lnd 24 word aezeed
32+
--start_key_index int start key index to try to find the correct key index
33+
--swap_hash string swap hash of the loop in swap
34+
--sweep_addr string address to recover the funds to
35+
--txid string transaction id of the on-chain transaction that created the HTLC
36+
--vout uint32 output index of the on-chain transaction that created the HTLC
37+
```
38+
39+
### Options inherited from parent commands
40+
41+
```
42+
-r, --regtest Indicates if regtest parameters should be used
43+
-t, --testnet Indicates if testnet parameters should be used
44+
```
45+
46+
### SEE ALSO
47+
48+
* [chantools](chantools.md) - Chantools helps recover funds from lightning channels
49+

0 commit comments

Comments
 (0)