Skip to content

Commit f960dd0

Browse files
committed
doc: update docs
1 parent aadbb18 commit f960dd0

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Example (make sure you always use the latest version!):
2929

3030
```shell
3131
$ cd /tmp
32-
$ wget -O chantools.tar.gz https://github.com/guggero/chantools/releases/download/v0.10.4/chantools-linux-amd64-v0.10.4.tar.gz
32+
$ wget -O chantools.tar.gz https://github.com/guggero/chantools/releases/download/v0.10.7/chantools-linux-amd64-v0.10.7.tar.gz
3333
$ tar -zxvf chantools.tar.gz
3434
$ sudo mv chantools-*/chantools /usr/local/bin/
3535
```
@@ -38,7 +38,7 @@ $ sudo mv chantools-*/chantools /usr/local/bin/
3838

3939
If there isn't a pre-built binary for your operating system or architecture
4040
available or you want to build `chantools` from source for another reason, you
41-
need to make sure you have `go 1.16.x` (or later) and `make` installed and can
41+
need to make sure you have `go 1.19.x` (or later) and `make` installed and can
4242
then run the following commands:
4343

4444
```bash

doc/chantools_fakechanbackup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ chantools fakechanbackup --from_channel_graph lncli_describegraph.json \
6161
--channelpoint string funding transaction outpoint of the channel to rescue (<txid>:<txindex>) as it is displayed on 1ml.com
6262
--from_channel_graph string the full LN channel graph in the JSON format that the 'lncli describegraph' returns
6363
-h, --help help for fakechanbackup
64-
--multi_file string the fake channel backup file to create (default "results/fake-2023-02-25-14-15-10.backup")
64+
--multi_file string the fake channel backup file to create (default "results/fake-2023-04-11-16-33-35.backup")
6565
--remote_node_addr string the remote node connection information in the format pubkey@host:port
6666
--rootkey string BIP32 HD root key of the wallet to use for encrypting the backup; leave empty to prompt for lnd 24 word aezeed
6767
--short_channel_id string the short channel ID in the format <blockheight>x<transactionindex>x<outputindex>

doc/chantools_walletinfo.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ latter can be useful to recover funds from a wallet if the wallet password is
1111
still known but the seed was lost. **The 24 word seed phrase itself cannot be
1212
extracted** because it is hashed into the extended HD root key before storing it
1313
in the wallet.db.
14+
In case lnd was started with "--noseedbackup=true" your wallet has the default
15+
password. To unlock the wallet set the environment variable WALLET_PASSWORD="-"
16+
or simply press <enter> without entering a password when being prompted.
1417

1518
```
1619
chantools walletinfo [flags]

doc/chantools_zombierecovery_findmatches.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,16 @@ chantools zombierecovery findmatches [flags]
2020
```
2121
chantools zombierecovery findmatches \
2222
--registrations data.txt \
23-
--channel_graph lncli_describegraph.json \
24-
--pairs_done pairs-done.json
23+
--ambosskey <API key>
2524
```
2625

2726
### Options
2827

2928
```
29+
--ambossdelay duration the delay between each query to the Amboss GraphQL API (default 4s)
30+
--ambosskey string the API key for the Amboss GraphQL API
3031
--apiurl string API URL to use (must be esplora compatible) (default "https://blockstream.info/api")
31-
--channel_graph string the full LN channel graph in the JSON format that the 'lncli describegraph' returns
3232
-h, --help help for findmatches
33-
--pairs_done string an optional file containing all pairs that have already been contacted and shouldn't be matched again
3433
--registrations string the raw data.txt where the registrations are stored in
3534
```
3635

0 commit comments

Comments
 (0)