diff --git a/cmd/chantools/fakechanbackup.go b/cmd/chantools/fakechanbackup.go index 949240e..e0524a8 100644 --- a/cmd/chantools/fakechanbackup.go +++ b/cmd/chantools/fakechanbackup.go @@ -65,7 +65,14 @@ The second version of the command only takes the --from_channel_graph and network graph (must be provided in the JSON format that the 'lncli describegraph' command returns) into a fake backup file. This is the most convenient way to use this command but requires one to have a fully synced -lnd node.`, +lnd node. + +Any fake channel backup _needs_ to be used with the custom fork of lnd +specifically built for this purpose: https://github.com/guggero/lnd/releases +Also the debuglevel must be set to debug (lnd.conf, set 'debuglevel=debug') when +running the above lnd for it to produce the correct log file that will be needed +for the rescueclosed command. +`, Example: `chantools fakechanbackup \ --capacity 123456 \ --channelpoint f39310xxxxxxxxxx:1 \ diff --git a/cmd/chantools/rescueclosed.go b/cmd/chantools/rescueclosed.go index 6cf058a..5556f15 100644 --- a/cmd/chantools/rescueclosed.go +++ b/cmd/chantools/rescueclosed.go @@ -61,15 +61,17 @@ know about the channels any more but we still have the channel.db from the moment they force-closed. The alternative use case for this command is if you got the commit point by -running the fund-recovery branch of my guggero/lnd fork in combination with the -fakechanbackup command. Then you need to specify the --commit_point and +running the fund-recovery branch of my guggero/lnd fork (see +https://github.com/guggero/lnd/releases for a binary release) in combination +with the fakechanbackup command. Then you need to specify the --commit_point and --force_close_addr flags instead of the --channeldb and --fromsummary flags. If you need to rescue a whole bunch of channels all at once, you can also specify the --fromsummary and --lnd_log flags to automatically look for force close addresses in the summary and the corresponding commit points in the lnd log file. This only works if lnd is running the fund-recovery branch of my -guggero/lnd fork.`, +guggero/lnd (https://github.com/guggero/lnd/releases) fork and only if the +debuglevel is set to debug (lnd.conf, set 'debuglevel=debug').`, Example: `chantools rescueclosed \ --fromsummary results/summary-xxxxxx.json \ --channeldb ~/.lnd/data/graph/mainnet/channel.db diff --git a/cmd/chantools/root.go b/cmd/chantools/root.go index bb195af..a1b4d00 100644 --- a/cmd/chantools/root.go +++ b/cmd/chantools/root.go @@ -26,7 +26,7 @@ import ( const ( defaultAPIURL = "https://blockstream.info/api" - version = "0.9.1" + version = "0.9.2" na = "n/a" Commit = "" diff --git a/doc/chantools_dropchannelgraph.md b/doc/chantools_dropchannelgraph.md index 4edeb49..f1b5e5d 100644 --- a/doc/chantools_dropchannelgraph.md +++ b/doc/chantools_dropchannelgraph.md @@ -7,6 +7,9 @@ Remove all graph related data from a channel DB This command removes all graph data from a channel DB, forcing the lnd node to do a full graph sync. +Or if a single channel is specified, that channel is purged from the graph +without removing any other data. + 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!' @@ -20,13 +23,18 @@ chantools dropchannelgraph [flags] ``` chantools dropchannelgraph \ --channeldb ~/.lnd/data/graph/mainnet/channel.db + +chantools dropchannelgraph \ + --channeldb ~/.lnd/data/graph/mainnet/channel.db \ + --single_channel 726607861215512345 ``` ### Options ``` - --channeldb string lnd channel.db file to dump channels from - -h, --help help for dropchannelgraph + --channeldb string lnd channel.db file to dump channels from + -h, --help help for dropchannelgraph + --single_channel uint the single channel identified by its short channel ID (CID) to remove from the graph ``` ### Options inherited from parent commands diff --git a/doc/chantools_fakechanbackup.md b/doc/chantools_fakechanbackup.md index a72db87..2d2fc85 100644 --- a/doc/chantools_fakechanbackup.md +++ b/doc/chantools_fakechanbackup.md @@ -28,6 +28,13 @@ network graph (must be provided in the JSON format that the most convenient way to use this command but requires one to have a fully synced lnd node. +Any fake channel backup _needs_ to be used with the custom fork of lnd +specifically built for this purpose: https://github.com/guggero/lnd/releases +Also the debuglevel must be set to debug (lnd.conf, set 'debuglevel=debug') when +running the above lnd for it to produce the correct log file that will be needed +for the rescueclosed command. + + ``` chantools fakechanbackup [flags] ``` @@ -54,7 +61,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-07-26-11-03-50.backup") + --multi_file string the fake channel backup file to create (default "results/fake-2021-08-13-13-09-39.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_rescueclosed.md b/doc/chantools_rescueclosed.md index b86967f..27f3b25 100644 --- a/doc/chantools_rescueclosed.md +++ b/doc/chantools_rescueclosed.md @@ -13,15 +13,17 @@ know about the channels any more but we still have the channel.db from the moment they force-closed. The alternative use case for this command is if you got the commit point by -running the fund-recovery branch of my guggero/lnd fork in combination with the -fakechanbackup command. Then you need to specify the --commit_point and +running the fund-recovery branch of my guggero/lnd fork (see +https://github.com/guggero/lnd/releases for a binary release) in combination +with the fakechanbackup command. Then you need to specify the --commit_point and --force_close_addr flags instead of the --channeldb and --fromsummary flags. If you need to rescue a whole bunch of channels all at once, you can also specify the --fromsummary and --lnd_log flags to automatically look for force close addresses in the summary and the corresponding commit points in the lnd log file. This only works if lnd is running the fund-recovery branch of my -guggero/lnd fork. +guggero/lnd (https://github.com/guggero/lnd/releases) fork and only if the +debuglevel is set to debug (lnd.conf, set 'debuglevel=debug'). ``` chantools rescueclosed [flags]