doc: re-generate docs

pull/32/head v0.9.0
Oliver Gugger 3 years ago
parent 883705f2f0
commit dc10f2dd87
No known key found for this signature in database
GPG Key ID: 8E4256593F177720

@ -299,6 +299,7 @@ Detailed documentation for each sub command is available in the
Quick access: Quick access:
+ [chanbackup](doc/chantools_chanbackup.md) + [chanbackup](doc/chantools_chanbackup.md)
+ [compactdb](doc/chantools_compactdb.md) + [compactdb](doc/chantools_compactdb.md)
+ [deletepayments](doc/chantools_deletepayments.md)
+ [derivekey](doc/chantools_derivekey.md) + [derivekey](doc/chantools_derivekey.md)
+ [dropchannelgraph](doc/chantools_dropchannelgraph.md) + [dropchannelgraph](doc/chantools_dropchannelgraph.md)
+ [dumpbackup](doc/chantools_dumpbackup.md) + [dumpbackup](doc/chantools_dumpbackup.md)
@ -319,3 +320,4 @@ Quick access:
+ [sweeptimelockmanual](doc/chantools_sweeptimelockmanual.md) + [sweeptimelockmanual](doc/chantools_sweeptimelockmanual.md)
+ [vanitygen](doc/chantools_vanitygen.md) + [vanitygen](doc/chantools_vanitygen.md)
+ [walletinfo](doc/chantools_walletinfo.md) + [walletinfo](doc/chantools_walletinfo.md)
+ [zombierecovery](doc/chantools_zombierecovery.md)

@ -20,6 +20,7 @@ Complete documentation is available at https://github.com/guggero/chantools/.
* [chantools chanbackup](chantools_chanbackup.md) - Create a channel.backup file from a channel database * [chantools chanbackup](chantools_chanbackup.md) - Create a channel.backup file from a channel database
* [chantools compactdb](chantools_compactdb.md) - Create a copy of a channel.db file in safe/read-only mode * [chantools compactdb](chantools_compactdb.md) - Create a copy of a channel.db file in safe/read-only mode
* [chantools deletepayments](chantools_deletepayments.md) - Remove all (failed) payments from a channel DB
* [chantools derivekey](chantools_derivekey.md) - Derive a key with a specific derivation path * [chantools derivekey](chantools_derivekey.md) - Derive a key with a specific derivation path
* [chantools dropchannelgraph](chantools_dropchannelgraph.md) - Remove all graph related data from a channel DB * [chantools dropchannelgraph](chantools_dropchannelgraph.md) - Remove all graph related data from a channel DB
* [chantools dumpbackup](chantools_dumpbackup.md) - Dump the content of a channel.backup file * [chantools dumpbackup](chantools_dumpbackup.md) - Dump the content of a channel.backup file

@ -0,0 +1,44 @@
## chantools deletepayments
Remove all (failed) payments from a channel DB
### Synopsis
This command removes all payments from a channel DB.
If only the failed payments should be deleted (and not the successful ones), the
--failedonly flag can be specified.
CAUTION: Running this command will make it impossible to use the channel DB
with an older version of lnd. Downgrading is not possible and you'll need to
run lnd v0.13.1-beta or later after using this command!'
```
chantools deletepayments [flags]
```
### Examples
```
chantools deletepayments --failedonly \
--channeldb ~/.lnd/data/graph/mainnet/channel.db
```
### Options
```
--channeldb string lnd channel.db file to dump channels from
--failedonly don't delete all payments, only failed ones
-h, --help help for deletepayments
```
### 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

@ -9,7 +9,7 @@ forcing the lnd node to do a full graph sync.
CAUTION: Running this command will make it impossible to use the channel DB CAUTION: Running this command will make it impossible to use the channel DB
with an older version of lnd. Downgrading is not possible and you'll need to with an older version of lnd. Downgrading is not possible and you'll need to
run lnd v0.12.0-beta or later after using this command!' run lnd v0.13.1-beta or later after using this command!'
``` ```
chantools dropchannelgraph [flags] chantools dropchannelgraph [flags]

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

@ -11,7 +11,7 @@ needs to read the database content.
CAUTION: Running this command will make it impossible to use the channel DB CAUTION: Running this command will make it impossible to use the channel DB
with an older version of lnd. Downgrading is not possible and you'll need to with an older version of lnd. Downgrading is not possible and you'll need to
run lnd v0.12.0-beta or later after using this command!' run lnd v0.13.1-beta or later after using this command!'
``` ```
chantools migratedb [flags] chantools migratedb [flags]

@ -11,7 +11,7 @@ channel was never confirmed on chain!
CAUTION: Running this command will make it impossible to use the channel DB CAUTION: Running this command will make it impossible to use the channel DB
with an older version of lnd. Downgrading is not possible and you'll need to with an older version of lnd. Downgrading is not possible and you'll need to
run lnd v0.12.0-beta or later after using this command! run lnd v0.13.1-beta or later after using this command!
``` ```
chantools removechannel [flags] chantools removechannel [flags]

@ -26,8 +26,10 @@ chantools signrescuefunding \
### Options ### Options
``` ```
-h, --help help for signrescuefunding --bip39 read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag
--psbt string Partially Signed Bitcoin Transaction that was provided by the initiator of the channel to rescue -h, --help help for signrescuefunding
--psbt string Partially Signed Bitcoin Transaction that was provided by the initiator of the channel to rescue
--rootkey string BIP32 HD root key of the wallet to use for deriving keys; leave empty to prompt for lnd 24 word aezeed
``` ```
### Options inherited from parent commands ### Options inherited from parent commands

@ -2,6 +2,11 @@
[3/3] Sign an offer sent by the remote peer to recover funds [3/3] Sign an offer sent by the remote peer to recover funds
### Synopsis
Inspect and sign an offer that was sent by the remote
peer to recover funds from one or more channels.
``` ```
chantools zombierecovery signoffer [flags] chantools zombierecovery signoffer [flags]
``` ```

Loading…
Cancel
Save