diff --git a/README.md b/README.md index 7a95797..4cf6845 100644 --- a/README.md +++ b/README.md @@ -299,6 +299,7 @@ Detailed documentation for each sub command is available in the Quick access: + [chanbackup](doc/chantools_chanbackup.md) + [compactdb](doc/chantools_compactdb.md) ++ [deletepayments](doc/chantools_deletepayments.md) + [derivekey](doc/chantools_derivekey.md) + [dropchannelgraph](doc/chantools_dropchannelgraph.md) + [dumpbackup](doc/chantools_dumpbackup.md) @@ -319,3 +320,4 @@ Quick access: + [sweeptimelockmanual](doc/chantools_sweeptimelockmanual.md) + [vanitygen](doc/chantools_vanitygen.md) + [walletinfo](doc/chantools_walletinfo.md) ++ [zombierecovery](doc/chantools_zombierecovery.md) diff --git a/doc/chantools.md b/doc/chantools.md index fcd69c4..195c2df 100644 --- a/doc/chantools.md +++ b/doc/chantools.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 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 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 diff --git a/doc/chantools_deletepayments.md b/doc/chantools_deletepayments.md new file mode 100644 index 0000000..792995e --- /dev/null +++ b/doc/chantools_deletepayments.md @@ -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 + diff --git a/doc/chantools_dropchannelgraph.md b/doc/chantools_dropchannelgraph.md index e4e8379..4edeb49 100644 --- a/doc/chantools_dropchannelgraph.md +++ b/doc/chantools_dropchannelgraph.md @@ -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 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] diff --git a/doc/chantools_fakechanbackup.md b/doc/chantools_fakechanbackup.md index cbde68b..a72db87 100644 --- a/doc/chantools_fakechanbackup.md +++ b/doc/chantools_fakechanbackup.md @@ -54,7 +54,7 @@ chantools fakechanbackup --from_channel_graph lncli_describegraph.json \ --channelpoint string funding transaction outpoint of the channel to rescue (:) 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 -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 --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 xx diff --git a/doc/chantools_migratedb.md b/doc/chantools_migratedb.md index 6384eee..af10376 100644 --- a/doc/chantools_migratedb.md +++ b/doc/chantools_migratedb.md @@ -11,7 +11,7 @@ needs to read the database content. 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.12.0-beta or later after using this command!' +run lnd v0.13.1-beta or later after using this command!' ``` chantools migratedb [flags] diff --git a/doc/chantools_removechannel.md b/doc/chantools_removechannel.md index f527eec..dd5777a 100644 --- a/doc/chantools_removechannel.md +++ b/doc/chantools_removechannel.md @@ -11,7 +11,7 @@ channel was never confirmed on chain! 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.12.0-beta or later after using this command! +run lnd v0.13.1-beta or later after using this command! ``` chantools removechannel [flags] diff --git a/doc/chantools_signrescuefunding.md b/doc/chantools_signrescuefunding.md index 110f505..0e18668 100644 --- a/doc/chantools_signrescuefunding.md +++ b/doc/chantools_signrescuefunding.md @@ -26,8 +26,10 @@ chantools signrescuefunding \ ### Options ``` - -h, --help help for signrescuefunding - --psbt string Partially Signed Bitcoin Transaction that was provided by the initiator of the channel to rescue + --bip39 read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag + -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 diff --git a/doc/chantools_zombierecovery_signoffer.md b/doc/chantools_zombierecovery_signoffer.md index e082bdf..b91623c 100644 --- a/doc/chantools_zombierecovery_signoffer.md +++ b/doc/chantools_zombierecovery_signoffer.md @@ -2,6 +2,11 @@ [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] ```