Skip to content

Commit 71b824e

Browse files
committed
README+doc: update all docs
1 parent 1a46f90 commit 71b824e

29 files changed

+162
-26
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,7 @@ Available Commands:
410410
chanbackup Create a channel.backup file from a channel database
411411
closepoolaccount Tries to close a Pool account that has expired
412412
compactdb Create a copy of a channel.db file in safe/read-only mode
413+
createwallet Create a new lnd compatible wallet.db file from an existing seed or by generating a new one
413414
deletepayments Remove all (failed) payments from a channel DB
414415
derivekey Derive a key with a specific derivation path
415416
doublespendinputs Tries to double spend the given inputs by deriving the private for the address and sweeping the funds to the given address. This can only be used with inputs that belong to an lnd wallet.
@@ -430,6 +431,7 @@ Available Commands:
430431
rescuetweakedkey Attempt to rescue funds locked in an address with a key that was affected by a specific bug in lnd
431432
showrootkey Extract and show the BIP32 HD root key from the 24 word lnd aezeed
432433
signmessage Sign a message with the nodes identity pubkey.
434+
signpsbt Sign a Partially Signed Bitcoin Transaction (PSBT)
433435
signrescuefunding Rescue funds locked in a funding multisig output that never resulted in a proper channel; this is the command the remote node (the non-initiator) of the channel needs to run
434436
summary Compile a summary about the current state of channels
435437
sweeptimelock Sweep the force-closed state after the time lock has expired
@@ -470,6 +472,7 @@ Legend:
470472
| [chanbackup](doc/chantools_chanbackup.md) | :pencil: Extract a `channel.backup` file from a `channel.db` file |
471473
| [closepoolaccount](doc/chantools_closepoolaccount.md) | :pencil: Manually close an expired Lightning Pool account |
472474
| [compactdb](doc/chantools_compactdb.md) | Run database compaction manually to reclaim space |
475+
| [createwallet](doc/chantools_createwallet.md) | :pencil: Create a new lnd compatible wallet.db file from an existing seed or by generating a new one |
473476
| [deletepayments](doc/chantools_deletepayments.md) | Remove ALL payments from a `channel.db` file to reduce size |
474477
| [derivekey](doc/chantools_derivekey.md) | :pencil: Derive a single private/public key from `lnd`'s seed, use to test seed |
475478
| [doublespendinputs](doc/chantools_doublespendinputs.md) | :pencil: Tries to double spend the given inputs by deriving the private for the address and sweeping the funds to the given address |
@@ -483,13 +486,14 @@ Legend:
483486
| [forceclose](doc/chantools_forceclose.md) | :pencil: (:skull: :warning:) Publish an old channel state from a `channel.db` file |
484487
| [genimportscript](doc/chantools_genimportscript.md) | :pencil: Create a script/text file that can be used to import `lnd` keys into other software |
485488
| [migratedb](doc/chantools_migratedb.md) | Upgrade the `channel.db` file to the latest version |
486-
| [pullanchor](doc/chantools_pullanchor.md) | :pencil: Attempt to CPFP an anchor output of a channel |
489+
| [pullanchor](doc/chantools_pullanchor.md) | :pencil: Attempt to CPFP an anchor output of a channel |
487490
| [recoverloopin](doc/chantools_recoverloopin.md) | :pencil: Recover funds from a failed Lightning Loop inbound swap |
488491
| [removechannel](doc/chantools_removechannel.md) | (:skull: :warning:) Remove a single channel from a `channel.db` file |
489492
| [rescueclosed](doc/chantools_rescueclosed.md) | :pencil: (:pushpin:) Rescue funds in a legacy (pre `STATIC_REMOTE_KEY`) channel output |
490493
| [rescuefunding](doc/chantools_rescuefunding.md) | :pencil: (:pushpin:) Rescue funds from a funding transaction. Deprecated, use [zombierecovery](doc/chantools_zombierecovery.md) instead |
491494
| [showrootkey](doc/chantools_showrootkey.md) | :pencil: Display the master root key (`xprv`) from your seed (DO NOT SHARE WITH ANYONE) |
492495
| [signmessage](doc/chantools_signmessage.md) | :pencil: Sign a message with the nodes identity pubkey. |
496+
| [signpsbt](doc/chantools_signpsbt.md) | :pencil: Sign a Partially Signed Bitcoin Transaction (PSBT) |
493497
| [signrescuefunding](doc/chantools_signrescuefunding.md) | :pencil: (:pushpin:) Sign to funds from a funding transaction. Deprecated, use [zombierecovery](doc/chantools_zombierecovery.md) instead |
494498
| [summary](doc/chantools_summary.md) | Create a summary of channel funds from a `channel.db` file |
495499
| [sweepremoteclosed](doc/chantools_sweepremoteclosed.md) | :pencil: Find channel funds from remotely force closed channels and sweep them |

doc/chantools.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ https://github.com/lightninglabs/chantools/.
2323
* [chantools chanbackup](chantools_chanbackup.md) - Create a channel.backup file from a channel database
2424
* [chantools closepoolaccount](chantools_closepoolaccount.md) - Tries to close a Pool account that has expired
2525
* [chantools compactdb](chantools_compactdb.md) - Create a copy of a channel.db file in safe/read-only mode
26+
* [chantools createwallet](chantools_createwallet.md) - Create a new lnd compatible wallet.db file from an existing seed or by generating a new one
2627
* [chantools deletepayments](chantools_deletepayments.md) - Remove all (failed) payments from a channel DB
2728
* [chantools derivekey](chantools_derivekey.md) - Derive a key with a specific derivation path
2829
* [chantools doublespendinputs](chantools_doublespendinputs.md) - Replace a transaction by double spending its input
@@ -43,6 +44,8 @@ https://github.com/lightninglabs/chantools/.
4344
* [chantools rescuefunding](chantools_rescuefunding.md) - Rescue funds locked in a funding multisig output that never resulted in a proper channel; this is the command the initiator of the channel needs to run
4445
* [chantools rescuetweakedkey](chantools_rescuetweakedkey.md) - Attempt to rescue funds locked in an address with a key that was affected by a specific bug in lnd
4546
* [chantools showrootkey](chantools_showrootkey.md) - Extract and show the BIP32 HD root key from the 24 word lnd aezeed
47+
* [chantools signmessage](chantools_signmessage.md) - Sign a message with the node's private key.
48+
* [chantools signpsbt](chantools_signpsbt.md) - Sign a Partially Signed Bitcoin Transaction (PSBT)
4649
* [chantools signrescuefunding](chantools_signrescuefunding.md) - Rescue funds locked in a funding multisig output that never resulted in a proper channel; this is the command the remote node (the non-initiator) of the channel needs to run
4750
* [chantools summary](chantools_summary.md) - Compile a summary about the current state of channels
4851
* [chantools sweepremoteclosed](chantools_sweepremoteclosed.md) - Go through all the addresses that could have funds of channels that were force-closed by the remote party. A public block explorer is queried for each address and if any balance is found, all funds are swept to a given address

doc/chantools_chanbackup.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ chantools chanbackup \
2727
-h, --help help for chanbackup
2828
--multi_file string lnd channel.backup file to create
2929
--rootkey string BIP32 HD root key of the wallet to use for creating the backup; leave empty to prompt for lnd 24 word aezeed
30+
--walletdb string read the seed/master root key to use fro creating the backup from an lnd wallet.db file instead of asking for a seed or providing the --rootkey flag
3031
```
3132

3233
### Options inherited from parent commands

doc/chantools_closepoolaccount.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ chantools closepoolaccount \
4242
--publish publish sweep TX to the chain API instead of just printing the TX
4343
--rootkey string BIP32 HD root key of the wallet to use for deriving keys; leave empty to prompt for lnd 24 word aezeed
4444
--sweepaddr string address to recover the funds to; specify 'fromseed' to derive a new address from the seed automatically
45+
--walletdb string read the seed/master root key to use fro deriving keys from an lnd wallet.db file instead of asking for a seed or providing the --rootkey flag
4546
```
4647

4748
### Options inherited from parent commands

doc/chantools_createwallet.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## chantools createwallet
2+
3+
Create a new lnd compatible wallet.db file from an existing seed or by generating a new one
4+
5+
### Synopsis
6+
7+
Creates a new wallet that can be used with lnd or with
8+
chantools. The wallet can be created from an existing seed or a new one can be
9+
generated (use --generateseed).
10+
11+
```
12+
chantools createwallet [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
chantools createwallet \
19+
--walletdbdir ~/.lnd/data/chain/bitcoin/mainnet
20+
```
21+
22+
### Options
23+
24+
```
25+
--bip39 read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag
26+
--generateseed generate a new seed instead of using an existing one
27+
-h, --help help for createwallet
28+
--rootkey string BIP32 HD root key of the wallet to use for creating the new wallet; leave empty to prompt for lnd 24 word aezeed
29+
--walletdb string read the seed/master root key to use fro creating the new wallet from an lnd wallet.db file instead of asking for a seed or providing the --rootkey flag
30+
--walletdbdir string the folder to create the new wallet.db file in
31+
```
32+
33+
### Options inherited from parent commands
34+
35+
```
36+
-r, --regtest Indicates if regtest parameters should be used
37+
-s, --signet Indicates if the public signet parameters should be used
38+
-t, --testnet Indicates if testnet parameters should be used
39+
```
40+
41+
### SEE ALSO
42+
43+
* [chantools](chantools.md) - Chantools helps recover funds from lightning channels
44+

doc/chantools_derivekey.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,13 @@ chantools derivekey --identity
2323
### Options
2424

2525
```
26-
--bip39 read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag
27-
-h, --help help for derivekey
28-
--identity derive the lnd identity_pubkey
29-
--neuter don't output private key(s), only public key(s)
30-
--path string BIP32 derivation path to derive; must start with "m/"
31-
--rootkey string BIP32 HD root key of the wallet to use for decrypting the backup; leave empty to prompt for lnd 24 word aezeed
26+
--bip39 read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag
27+
-h, --help help for derivekey
28+
--identity derive the lnd identity_pubkey
29+
--neuter don't output private key(s), only public key(s)
30+
--path string BIP32 derivation path to derive; must start with "m/"
31+
--rootkey string BIP32 HD root key of the wallet to use for decrypting the backup; leave empty to prompt for lnd 24 word aezeed
32+
--walletdb string read the seed/master root key to use fro decrypting the backup from an lnd wallet.db file instead of asking for a seed or providing the --rootkey flag
3233
```
3334

3435
### Options inherited from parent commands

doc/chantools_doublespendinputs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ chantools doublespendinputs \
3434
--recoverywindow uint32 number of keys to scan per internal/external branch; output will consist of double this amount of keys (default 2500)
3535
--rootkey string BIP32 HD root key of the wallet to use for deriving the input keys; leave empty to prompt for lnd 24 word aezeed
3636
--sweepaddr string address to recover the funds to; specify 'fromseed' to derive a new address from the seed automatically
37+
--walletdb string read the seed/master root key to use fro deriving the input keys from an lnd wallet.db file instead of asking for a seed or providing the --rootkey flag
3738
```
3839

3940
### Options inherited from parent commands

doc/chantools_dumpbackup.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ chantools dumpbackup \
2525
-h, --help help for dumpbackup
2626
--multi_file string lnd channel.backup file to dump
2727
--rootkey string BIP32 HD root key of the wallet to use for decrypting the backup; leave empty to prompt for lnd 24 word aezeed
28+
--walletdb string read the seed/master root key to use fro decrypting the backup from an lnd wallet.db file instead of asking for a seed or providing the --rootkey flag
2829
```
2930

3031
### Options inherited from parent commands

doc/chantools_fakechanbackup.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ chantools fakechanbackup --from_channel_graph lncli_describegraph.json \
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>
68+
--walletdb string read the seed/master root key to use fro encrypting the backup from an lnd wallet.db file instead of asking for a seed or providing the --rootkey flag
6869
```
6970

7071
### Options inherited from parent commands

doc/chantools_filterbackup.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ chantools filterbackup \
2727
-h, --help help for filterbackup
2828
--multi_file string lnd channel.backup file to filter
2929
--rootkey string BIP32 HD root key of the wallet to use for decrypting the backup; leave empty to prompt for lnd 24 word aezeed
30+
--walletdb string read the seed/master root key to use fro decrypting the backup from an lnd wallet.db file instead of asking for a seed or providing the --rootkey flag
3031
```
3132

3233
### Options inherited from parent commands

0 commit comments

Comments
 (0)