From f960dd07c493826553660763d64aa5a0459ed23c Mon Sep 17 00:00:00 2001 From: Oliver Gugger Date: Tue, 11 Apr 2023 16:34:48 +0200 Subject: [PATCH] doc: update docs --- README.md | 4 ++-- doc/chantools_fakechanbackup.md | 2 +- doc/chantools_walletinfo.md | 3 +++ doc/chantools_zombierecovery_findmatches.md | 7 +++---- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8c97d64..c04d093 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Example (make sure you always use the latest version!): ```shell $ cd /tmp -$ wget -O chantools.tar.gz https://github.com/guggero/chantools/releases/download/v0.10.4/chantools-linux-amd64-v0.10.4.tar.gz +$ wget -O chantools.tar.gz https://github.com/guggero/chantools/releases/download/v0.10.7/chantools-linux-amd64-v0.10.7.tar.gz $ tar -zxvf chantools.tar.gz $ sudo mv chantools-*/chantools /usr/local/bin/ ``` @@ -38,7 +38,7 @@ $ sudo mv chantools-*/chantools /usr/local/bin/ If there isn't a pre-built binary for your operating system or architecture available or you want to build `chantools` from source for another reason, you -need to make sure you have `go 1.16.x` (or later) and `make` installed and can +need to make sure you have `go 1.19.x` (or later) and `make` installed and can then run the following commands: ```bash diff --git a/doc/chantools_fakechanbackup.md b/doc/chantools_fakechanbackup.md index 18d064d..cc0b262 100644 --- a/doc/chantools_fakechanbackup.md +++ b/doc/chantools_fakechanbackup.md @@ -61,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-2023-02-25-14-15-10.backup") + --multi_file string the fake channel backup file to create (default "results/fake-2023-04-11-16-33-35.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_walletinfo.md b/doc/chantools_walletinfo.md index 4916674..456873e 100644 --- a/doc/chantools_walletinfo.md +++ b/doc/chantools_walletinfo.md @@ -11,6 +11,9 @@ latter can be useful to recover funds from a wallet if the wallet password is still known but the seed was lost. **The 24 word seed phrase itself cannot be extracted** because it is hashed into the extended HD root key before storing it in the wallet.db. +In case lnd was started with "--noseedbackup=true" your wallet has the default +password. To unlock the wallet set the environment variable WALLET_PASSWORD="-" +or simply press without entering a password when being prompted. ``` chantools walletinfo [flags] diff --git a/doc/chantools_zombierecovery_findmatches.md b/doc/chantools_zombierecovery_findmatches.md index 4da1a92..f83718e 100644 --- a/doc/chantools_zombierecovery_findmatches.md +++ b/doc/chantools_zombierecovery_findmatches.md @@ -20,17 +20,16 @@ chantools zombierecovery findmatches [flags] ``` chantools zombierecovery findmatches \ --registrations data.txt \ - --channel_graph lncli_describegraph.json \ - --pairs_done pairs-done.json + --ambosskey ``` ### Options ``` + --ambossdelay duration the delay between each query to the Amboss GraphQL API (default 4s) + --ambosskey string the API key for the Amboss GraphQL API --apiurl string API URL to use (must be esplora compatible) (default "https://blockstream.info/api") - --channel_graph string the full LN channel graph in the JSON format that the 'lncli describegraph' returns -h, --help help for findmatches - --pairs_done string an optional file containing all pairs that have already been contacted and shouldn't be matched again --registrations string the raw data.txt where the registrations are stored in ```