Skip to content

Commit dc10f2d

Browse files
committed
doc: re-generate docs
1 parent 883705f commit dc10f2d

9 files changed

+60
-6
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,7 @@ Detailed documentation for each sub command is available in the
299299
Quick access:
300300
+ [chanbackup](doc/chantools_chanbackup.md)
301301
+ [compactdb](doc/chantools_compactdb.md)
302+
+ [deletepayments](doc/chantools_deletepayments.md)
302303
+ [derivekey](doc/chantools_derivekey.md)
303304
+ [dropchannelgraph](doc/chantools_dropchannelgraph.md)
304305
+ [dumpbackup](doc/chantools_dumpbackup.md)
@@ -319,3 +320,4 @@ Quick access:
319320
+ [sweeptimelockmanual](doc/chantools_sweeptimelockmanual.md)
320321
+ [vanitygen](doc/chantools_vanitygen.md)
321322
+ [walletinfo](doc/chantools_walletinfo.md)
323+
+ [zombierecovery](doc/chantools_zombierecovery.md)

doc/chantools.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Complete documentation is available at https://github.com/guggero/chantools/.
2020

2121
* [chantools chanbackup](chantools_chanbackup.md) - Create a channel.backup file from a channel database
2222
* [chantools compactdb](chantools_compactdb.md) - Create a copy of a channel.db file in safe/read-only mode
23+
* [chantools deletepayments](chantools_deletepayments.md) - Remove all (failed) payments from a channel DB
2324
* [chantools derivekey](chantools_derivekey.md) - Derive a key with a specific derivation path
2425
* [chantools dropchannelgraph](chantools_dropchannelgraph.md) - Remove all graph related data from a channel DB
2526
* [chantools dumpbackup](chantools_dumpbackup.md) - Dump the content of a channel.backup file

doc/chantools_deletepayments.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## chantools deletepayments
2+
3+
Remove all (failed) payments from a channel DB
4+
5+
### Synopsis
6+
7+
This command removes all payments from a channel DB.
8+
If only the failed payments should be deleted (and not the successful ones), the
9+
--failedonly flag can be specified.
10+
11+
CAUTION: Running this command will make it impossible to use the channel DB
12+
with an older version of lnd. Downgrading is not possible and you'll need to
13+
run lnd v0.13.1-beta or later after using this command!'
14+
15+
```
16+
chantools deletepayments [flags]
17+
```
18+
19+
### Examples
20+
21+
```
22+
chantools deletepayments --failedonly \
23+
--channeldb ~/.lnd/data/graph/mainnet/channel.db
24+
```
25+
26+
### Options
27+
28+
```
29+
--channeldb string lnd channel.db file to dump channels from
30+
--failedonly don't delete all payments, only failed ones
31+
-h, --help help for deletepayments
32+
```
33+
34+
### Options inherited from parent commands
35+
36+
```
37+
-r, --regtest Indicates if regtest parameters should be used
38+
-t, --testnet Indicates if testnet parameters should be used
39+
```
40+
41+
### SEE ALSO
42+
43+
* [chantools](chantools.md) - Chantools helps recover funds from lightning channels
44+

doc/chantools_dropchannelgraph.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ forcing the lnd node to do a full graph sync.
99

1010
CAUTION: Running this command will make it impossible to use the channel DB
1111
with an older version of lnd. Downgrading is not possible and you'll need to
12-
run lnd v0.12.0-beta or later after using this command!'
12+
run lnd v0.13.1-beta or later after using this command!'
1313

1414
```
1515
chantools dropchannelgraph [flags]

doc/chantools_fakechanbackup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ chantools fakechanbackup --from_channel_graph lncli_describegraph.json \
5454
--channelpoint string funding transaction outpoint of the channel to rescue (<txid>:<txindex>) as it is displayed on 1ml.com
5555
--from_channel_graph string the full LN channel graph in the JSON format that the 'lncli describegraph' returns
5656
-h, --help help for fakechanbackup
57-
--multi_file string the fake channel backup file to create (default "results/fake-2021-05-02-17-39-46.backup")
57+
--multi_file string the fake channel backup file to create (default "results/fake-2021-07-26-11-03-50.backup")
5858
--remote_node_addr string the remote node connection information in the format pubkey@host:port
5959
--rootkey string BIP32 HD root key of the wallet to use for encrypting the backup; leave empty to prompt for lnd 24 word aezeed
6060
--short_channel_id string the short channel ID in the format <blockheight>x<transactionindex>x<outputindex>

doc/chantools_migratedb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ needs to read the database content.
1111

1212
CAUTION: Running this command will make it impossible to use the channel DB
1313
with an older version of lnd. Downgrading is not possible and you'll need to
14-
run lnd v0.12.0-beta or later after using this command!'
14+
run lnd v0.13.1-beta or later after using this command!'
1515

1616
```
1717
chantools migratedb [flags]

doc/chantools_removechannel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ channel was never confirmed on chain!
1111

1212
CAUTION: Running this command will make it impossible to use the channel DB
1313
with an older version of lnd. Downgrading is not possible and you'll need to
14-
run lnd v0.12.0-beta or later after using this command!
14+
run lnd v0.13.1-beta or later after using this command!
1515

1616
```
1717
chantools removechannel [flags]

doc/chantools_signrescuefunding.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ chantools signrescuefunding \
2626
### Options
2727

2828
```
29-
-h, --help help for signrescuefunding
30-
--psbt string Partially Signed Bitcoin Transaction that was provided by the initiator of the channel to rescue
29+
--bip39 read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag
30+
-h, --help help for signrescuefunding
31+
--psbt string Partially Signed Bitcoin Transaction that was provided by the initiator of the channel to rescue
32+
--rootkey string BIP32 HD root key of the wallet to use for deriving keys; leave empty to prompt for lnd 24 word aezeed
3133
```
3234

3335
### Options inherited from parent commands

doc/chantools_zombierecovery_signoffer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
[3/3] Sign an offer sent by the remote peer to recover funds
44

5+
### Synopsis
6+
7+
Inspect and sign an offer that was sent by the remote
8+
peer to recover funds from one or more channels.
9+
510
```
611
chantools zombierecovery signoffer [flags]
712
```

0 commit comments

Comments
 (0)