Skip to content

Commit fe92337

Browse files
committed
fakechanbackup+rescueclosed: update description
1 parent 98aabb8 commit fe92337

File tree

6 files changed

+37
-11
lines changed

6 files changed

+37
-11
lines changed

cmd/chantools/fakechanbackup.go

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,14 @@ The second version of the command only takes the --from_channel_graph and
6565
network graph (must be provided in the JSON format that the
6666
'lncli describegraph' command returns) into a fake backup file. This is the
6767
most convenient way to use this command but requires one to have a fully synced
68-
lnd node.`,
68+
lnd node.
69+
70+
Any fake channel backup _needs_ to be used with the custom fork of lnd
71+
specifically built for this purpose: https://github.com/guggero/lnd/releases
72+
Also the debuglevel must be set to debug (lnd.conf, set 'debuglevel=debug') when
73+
running the above lnd for it to produce the correct log file that will be needed
74+
for the rescueclosed command.
75+
`,
6976
Example: `chantools fakechanbackup \
7077
--capacity 123456 \
7178
--channelpoint f39310xxxxxxxxxx:1 \

cmd/chantools/rescueclosed.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,17 @@ know about the channels any more but we still have the channel.db from the
6161
moment they force-closed.
6262
6363
The alternative use case for this command is if you got the commit point by
64-
running the fund-recovery branch of my guggero/lnd fork in combination with the
65-
fakechanbackup command. Then you need to specify the --commit_point and
64+
running the fund-recovery branch of my guggero/lnd fork (see
65+
https://github.com/guggero/lnd/releases for a binary release) in combination
66+
with the fakechanbackup command. Then you need to specify the --commit_point and
6667
--force_close_addr flags instead of the --channeldb and --fromsummary flags.
6768
6869
If you need to rescue a whole bunch of channels all at once, you can also
6970
specify the --fromsummary and --lnd_log flags to automatically look for force
7071
close addresses in the summary and the corresponding commit points in the
7172
lnd log file. This only works if lnd is running the fund-recovery branch of my
72-
guggero/lnd fork.`,
73+
guggero/lnd (https://github.com/guggero/lnd/releases) fork and only if the
74+
debuglevel is set to debug (lnd.conf, set 'debuglevel=debug').`,
7375
Example: `chantools rescueclosed \
7476
--fromsummary results/summary-xxxxxx.json \
7577
--channeldb ~/.lnd/data/graph/mainnet/channel.db

cmd/chantools/root.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import (
2626

2727
const (
2828
defaultAPIURL = "https://blockstream.info/api"
29-
version = "0.9.1"
29+
version = "0.9.2"
3030
na = "n/a"
3131

3232
Commit = ""

doc/chantools_dropchannelgraph.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Remove all graph related data from a channel DB
77
This command removes all graph data from a channel DB,
88
forcing the lnd node to do a full graph sync.
99

10+
Or if a single channel is specified, that channel is purged from the graph
11+
without removing any other data.
12+
1013
CAUTION: Running this command will make it impossible to use the channel DB
1114
with an older version of lnd. Downgrading is not possible and you'll need to
1215
run lnd v0.13.1-beta or later after using this command!'
@@ -20,13 +23,18 @@ chantools dropchannelgraph [flags]
2023
```
2124
chantools dropchannelgraph \
2225
--channeldb ~/.lnd/data/graph/mainnet/channel.db
26+
27+
chantools dropchannelgraph \
28+
--channeldb ~/.lnd/data/graph/mainnet/channel.db \
29+
--single_channel 726607861215512345
2330
```
2431

2532
### Options
2633

2734
```
28-
--channeldb string lnd channel.db file to dump channels from
29-
-h, --help help for dropchannelgraph
35+
--channeldb string lnd channel.db file to dump channels from
36+
-h, --help help for dropchannelgraph
37+
--single_channel uint the single channel identified by its short channel ID (CID) to remove from the graph
3038
```
3139

3240
### Options inherited from parent commands

doc/chantools_fakechanbackup.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,13 @@ network graph (must be provided in the JSON format that the
2828
most convenient way to use this command but requires one to have a fully synced
2929
lnd node.
3030

31+
Any fake channel backup _needs_ to be used with the custom fork of lnd
32+
specifically built for this purpose: https://github.com/guggero/lnd/releases
33+
Also the debuglevel must be set to debug (lnd.conf, set 'debuglevel=debug') when
34+
running the above lnd for it to produce the correct log file that will be needed
35+
for the rescueclosed command.
36+
37+
3138
```
3239
chantools fakechanbackup [flags]
3340
```
@@ -54,7 +61,7 @@ chantools fakechanbackup --from_channel_graph lncli_describegraph.json \
5461
--channelpoint string funding transaction outpoint of the channel to rescue (<txid>:<txindex>) as it is displayed on 1ml.com
5562
--from_channel_graph string the full LN channel graph in the JSON format that the 'lncli describegraph' returns
5663
-h, --help help for fakechanbackup
57-
--multi_file string the fake channel backup file to create (default "results/fake-2021-07-26-11-03-50.backup")
64+
--multi_file string the fake channel backup file to create (default "results/fake-2021-08-13-13-09-39.backup")
5865
--remote_node_addr string the remote node connection information in the format pubkey@host:port
5966
--rootkey string BIP32 HD root key of the wallet to use for encrypting the backup; leave empty to prompt for lnd 24 word aezeed
6067
--short_channel_id string the short channel ID in the format <blockheight>x<transactionindex>x<outputindex>

doc/chantools_rescueclosed.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,17 @@ know about the channels any more but we still have the channel.db from the
1313
moment they force-closed.
1414

1515
The alternative use case for this command is if you got the commit point by
16-
running the fund-recovery branch of my guggero/lnd fork in combination with the
17-
fakechanbackup command. Then you need to specify the --commit_point and
16+
running the fund-recovery branch of my guggero/lnd fork (see
17+
https://github.com/guggero/lnd/releases for a binary release) in combination
18+
with the fakechanbackup command. Then you need to specify the --commit_point and
1819
--force_close_addr flags instead of the --channeldb and --fromsummary flags.
1920

2021
If you need to rescue a whole bunch of channels all at once, you can also
2122
specify the --fromsummary and --lnd_log flags to automatically look for force
2223
close addresses in the summary and the corresponding commit points in the
2324
lnd log file. This only works if lnd is running the fund-recovery branch of my
24-
guggero/lnd fork.
25+
guggero/lnd (https://github.com/guggero/lnd/releases) fork and only if the
26+
debuglevel is set to debug (lnd.conf, set 'debuglevel=debug').
2527

2628
```
2729
chantools rescueclosed [flags]

0 commit comments

Comments
 (0)