Skip to content

Commit 9000e82

Browse files
committed
docs: re-generate docs
1 parent 629d381 commit 9000e82

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

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-2021-08-29-22-04-34.backup")
64+
--multi_file string the fake channel backup file to create (default "results/fake-2021-11-11-13-31-59.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_rescuefunding.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,30 @@ chantools rescuefunding [flags]
2424
```
2525
chantools rescuefunding \
2626
--channeldb ~/.lnd/data/graph/mainnet/channel.db \
27-
--channelpoint xxxxxxx:xx \
27+
--dbchannelpoint xxxxxxx:xx \
28+
--sweepaddr bc1qxxxxxxxxx \
29+
--feerate 10
30+
31+
chantools rescuefunding \
32+
--confirmedchannelpoint xxxxxxx:xx \
33+
--localkeyindex x \
34+
--remotepubkey 0xxxxxxxxxxxxxxxx \
2835
--sweepaddr bc1qxxxxxxxxx \
2936
--feerate 10
3037
```
3138

3239
### Options
3340

3441
```
42+
--apiurl string API URL to use (must be esplora compatible) (default "https://blockstream.info/api")
3543
--bip39 read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag
3644
--channeldb string lnd channel.db file to rescue a channel from; must contain the pending channel specified with --channelpoint
37-
--channelpoint string funding transaction outpoint of the channel to rescue (<txid>:<txindex>) as it is recorded in the DB
38-
--confirmedchannelpoint string channel outpoint that got confirmed on chain (<txid>:<txindex>); normally this is the same as the --channelpoint so it will be set to that value ifthis is left empty
45+
--confirmedchannelpoint string channel outpoint that got confirmed on chain (<txid>:<txindex>); normally this is the same as the --dbchannelpoint so it will be set to that value ifthis is left empty
46+
--dbchannelpoint string funding transaction outpoint of the channel to rescue (<txid>:<txindex>) as it is recorded in the DB
3947
--feerate uint16 fee rate to use for the sweep transaction in sat/vByte (default 30)
4048
-h, --help help for rescuefunding
49+
--localkeyindex uint32 in case a channel DB is not available (but perhaps a channel backup file), the derivation index of the local multisig public key can be specified manually
50+
--remotepubkey string in case a channel DB is not available (but perhaps a channel backup file), the remote multisig public key can be specified manually
4151
--rootkey string BIP32 HD root key of the wallet to use for deriving keys; leave empty to prompt for lnd 24 word aezeed
4252
--sweepaddr string address to sweep the funds to
4353
```

0 commit comments

Comments
 (0)