multi: remove optional --rootkey flag from examples

pull/20/head
Oliver Gugger 3 years ago
parent 3a06ffe259
commit f78b4e07b7
No known key found for this signature in database
GPG Key ID: 8E4256593F177720

@ -23,7 +23,7 @@ func newChanBackupCommand() *cobra.Command {
Short: "Create a channel.backup file from a channel database",
Long: `This command creates a new channel.backup from a
channel.db file.`,
Example: `chantools chanbackup --rootkey xprvxxxxxxx \
Example: `chantools chanbackup \
--channeldb ~/.lnd/data/graph/mainnet/channel.db \
--multi_file new_channel_backup.backup`,
RunE: cc.Execute,

@ -35,8 +35,8 @@ func newDeriveKeyCommand() *cobra.Command {
Short: "Derive a key with a specific derivation path",
Long: `This command derives a single key with the given BIP32
derivation path from the root key and prints it to the console.`,
Example: `chantools derivekey --rootkey xprvxxxxxxxxxx \
--path "m/1017'/0'/5'/0/0'" --neuter`,
Example: `chantools derivekey --path "m/1017'/0'/5'/0/0'" \
--neuter`,
RunE: cc.Execute,
}
cc.cmd.Flags().StringVar(

@ -25,7 +25,7 @@ func newDumpBackupCommand() *cobra.Command {
Short: "Dump the content of a channel.backup file",
Long: `This command dumps all information that is inside a
channel.backup file in a human readable format.`,
Example: `chantools dumpbackup --rootkey xprvxxxxxxxxxx \
Example: `chantools dumpbackup \
--multi_file ~/.lnd/data/chain/bitcoin/mainnet/channel.backup`,
RunE: cc.Execute,
}

@ -66,15 +66,14 @@ network graph (must be provided in the JSON format that the
'lncli describegraph' command returns) into a fake backup file. This is the
most convenient way to use this command but requires one to have a fully synced
lnd node.`,
Example: `chantools fakechanbackup --rootkey xprvxxxxxxxxxx \
Example: `chantools fakechanbackup \
--capacity 123456 \
--channelpoint f39310xxxxxxxxxx:1 \
--remote_node_addr 022c260xxxxxxxx@213.174.150.1:9735 \
--short_channel_id 566222x300x1 \
--multi_file fake.backup
chantools fakechanbackup --rootkey xprvxxxxxxxxxx \
--from_channel_graph lncli_describegraph.json \
chantools fakechanbackup --from_channel_graph lncli_describegraph.json \
--multi_file fake.backup`,
RunE: cc.Execute,
}

@ -28,7 +28,7 @@ func newFilterBackupCommand() *cobra.Command {
"channels",
Long: `Filter an lnd channel.backup file by removing certain
channels (identified by their funding transaction outpoints).`,
Example: `chantools filterbackup --rootkey xprvxxxxxxxxxx \
Example: `chantools filterbackup \
--multi_file ~/.lnd/data/chain/bitcoin/mainnet/channel.backup \
--discard 2abcdef2b2bffaaa...db0abadd:1,4abcdef2b2bffaaa...db8abadd:0`,
RunE: cc.Execute,

@ -30,7 +30,7 @@ lnd issue [#3881](https://github.com/lightningnetwork/lnd/issues/3881)
(<code>[lncli] unable to restore chan backups: rpc error: code = Unknown desc =
unable to unpack chan backup: unable to derive shachain root key: unable to
derive private key</code>).`,
Example: `chantools fixoldbackup --rootkey xprvxxxxxxxxxx \
Example: `chantools fixoldbackup \
--multi_file ~/.lnd/data/chain/bitcoin/mainnet/channel.backup`,
RunE: cc.Execute,
}

@ -47,7 +47,7 @@ come online before you can sweep the funds from the time locked (144 - 2000
blocks) transaction *or* they have a watch tower looking out for them.
**This should absolutely be the last resort and you have been warned!**`,
Example: `chantools forceclose --rootkey xprvxxxxxxxxxx \
Example: `chantools forceclose \
--fromsummary results/summary-xxxx-yyyy.json
--channeldb ~/.lnd/data/graph/mainnet/channel.db \
--publish`,

@ -70,16 +70,13 @@ specify the --fromsummary and --lnd_log flags to automatically look for force
close addresses in the summary and the corresponding commit points in the
lnd log file. This only works if lnd is running the fund-recovery branch of my
guggero/lnd fork.`,
Example: `chantools rescueclosed --rootkey xprvxxxxxxxxxx \
Example: `chantools rescueclosed \
--fromsummary results/summary-xxxxxx.json \
--channeldb ~/.lnd/data/graph/mainnet/channel.db
chantools rescueclosed --rootkey xprvxxxxxxxxxx \
--force_close_addr bc1q... \
--commit_point 03xxxx
chantools rescueclosed --force_close_addr bc1q... --commit_point 03xxxx
chantools rescueclosed --rootkey xprvxxxxxxxxxx \
--fromsummary results/summary-xxxxxx.json \
chantools rescueclosed --fromsummary results/summary-xxxxxx.json \
--lnd_log ~/.lnd/logs/bitcoin/mainnet/lnd.log`,
RunE: cc.Execute,
}

@ -61,7 +61,7 @@ work**! They need to run the second command of this process: signrescuefunding
If successful, this will create a PSBT that then has to be sent to the channel
partner (remote node operator).`,
Example: `chantools rescuefunding --rootkey xprvxxxxxxxxxx \
Example: `chantools rescuefunding \
--channeldb ~/.lnd/data/graph/mainnet/channel.db \
--channelpoint xxxxxxx:xx \
--sweepaddr bc1qxxxxxxxxx \

@ -34,7 +34,7 @@ the 2-of-2 multisig.
If successful, this will create a final on-chain transaction that can be
broadcast by any Bitcoin node.`,
Example: `chantools signrescuefunding --rootkey xprvxxxxxxxxxx \
Example: `chantools signrescuefunding \
--psbt <the_base64_encoded_psbt_from_step_1>`,
RunE: cc.Execute,
}

@ -48,7 +48,7 @@ have to wait until the highest time lock (can be up to 2016 blocks which is more
than two weeks) of all the channels has passed. If you only want to sweep
channels that have the default CSV limit of 1 day, you can set the --maxcsvlimit
parameter to 144.`,
Example: `chantools sweeptimelock --rootkey xprvxxxxxxxxxx \
Example: `chantools sweeptimelock \
--fromsummary results/forceclose-xxxx-yyyy.json \
--sweepaddr bc1q.....
--publish`,

@ -56,7 +56,7 @@ then look up the value for RemoteChanCfg -> RevocationBasePoint -> PubKey.
To get the value for --timelockaddr you must look up the channel's funding
output on chain, then follow it to the force close output. The time locked
address is always the one that's longer (because it's P2WSH and not P2PKH).`,
Example: `chantools sweeptimelockmanual --rootkey xprvxxxxxxxx \
Example: `chantools sweeptimelockmanual \
--sweepaddr bc1q..... \
--timelockaddr bc1q............ \
--remoterevbasepoint 03xxxxxxx \

@ -14,7 +14,7 @@ chantools chanbackup [flags]
### Examples
```
chantools chanbackup --rootkey xprvxxxxxxx \
chantools chanbackup \
--channeldb ~/.lnd/data/graph/mainnet/channel.db \
--multi_file new_channel_backup.backup
```

@ -14,8 +14,8 @@ chantools derivekey [flags]
### Examples
```
chantools derivekey --rootkey xprvxxxxxxxxxx \
--path "m/1017'/0'/5'/0/0'" --neuter
chantools derivekey --path "m/1017'/0'/5'/0/0'" \
--neuter
```
### Options

@ -14,7 +14,7 @@ chantools dumpbackup [flags]
### Examples
```
chantools dumpbackup --rootkey xprvxxxxxxxxxx \
chantools dumpbackup \
--multi_file ~/.lnd/data/chain/bitcoin/mainnet/channel.backup
```

@ -35,15 +35,14 @@ chantools fakechanbackup [flags]
### Examples
```
chantools fakechanbackup --rootkey xprvxxxxxxxxxx \
chantools fakechanbackup \
--capacity 123456 \
--channelpoint f39310xxxxxxxxxx:1 \
--remote_node_addr 022c260xxxxxxxx@213.174.150.1:9735 \
--short_channel_id 566222x300x1 \
--multi_file fake.backup
chantools fakechanbackup --rootkey xprvxxxxxxxxxx \
--from_channel_graph lncli_describegraph.json \
chantools fakechanbackup --from_channel_graph lncli_describegraph.json \
--multi_file fake.backup
```
@ -55,7 +54,7 @@ chantools fakechanbackup --rootkey xprvxxxxxxxxxx \
--channelpoint string funding transaction outpoint of the channel to rescue (<txid>:<txindex>) 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-2021-05-01-22-08-48.backup")
--multi_file string the fake channel backup file to create (default "results/fake-2021-05-02-17-39-46.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 <blockheight>x<transactionindex>x<outputindex>

@ -14,7 +14,7 @@ chantools filterbackup [flags]
### Examples
```
chantools filterbackup --rootkey xprvxxxxxxxxxx \
chantools filterbackup \
--multi_file ~/.lnd/data/chain/bitcoin/mainnet/channel.backup \
--discard 2abcdef2b2bffaaa...db0abadd:1,4abcdef2b2bffaaa...db8abadd:0
```

@ -17,7 +17,7 @@ chantools fixoldbackup [flags]
### Examples
```
chantools fixoldbackup --rootkey xprvxxxxxxxxxx \
chantools fixoldbackup \
--multi_file ~/.lnd/data/chain/bitcoin/mainnet/channel.backup
```

@ -24,7 +24,7 @@ chantools forceclose [flags]
### Examples
```
chantools forceclose --rootkey xprvxxxxxxxxxx \
chantools forceclose \
--fromsummary results/summary-xxxx-yyyy.json
--channeldb ~/.lnd/data/graph/mainnet/channel.db \
--publish

@ -30,16 +30,13 @@ chantools rescueclosed [flags]
### Examples
```
chantools rescueclosed --rootkey xprvxxxxxxxxxx \
chantools rescueclosed \
--fromsummary results/summary-xxxxxx.json \
--channeldb ~/.lnd/data/graph/mainnet/channel.db
chantools rescueclosed --rootkey xprvxxxxxxxxxx \
--force_close_addr bc1q... \
--commit_point 03xxxx
chantools rescueclosed --force_close_addr bc1q... --commit_point 03xxxx
chantools rescueclosed --rootkey xprvxxxxxxxxxx \
--fromsummary results/summary-xxxxxx.json \
chantools rescueclosed --fromsummary results/summary-xxxxxx.json \
--lnd_log ~/.lnd/logs/bitcoin/mainnet/lnd.log
```

@ -22,7 +22,7 @@ chantools rescuefunding [flags]
### Examples
```
chantools rescuefunding --rootkey xprvxxxxxxxxxx \
chantools rescuefunding \
--channeldb ~/.lnd/data/graph/mainnet/channel.db \
--channelpoint xxxxxxx:xx \
--sweepaddr bc1qxxxxxxxxx \

@ -19,7 +19,7 @@ chantools signrescuefunding [flags]
### Examples
```
chantools signrescuefunding --rootkey xprvxxxxxxxxxx \
chantools signrescuefunding \
--psbt <the_base64_encoded_psbt_from_step_1>
```

@ -19,7 +19,7 @@ chantools sweeptimelock [flags]
### Examples
```
chantools sweeptimelock --rootkey xprvxxxxxxxxxx \
chantools sweeptimelock \
--fromsummary results/forceclose-xxxx-yyyy.json \
--sweepaddr bc1q.....
--publish

@ -23,7 +23,7 @@ chantools sweeptimelockmanual [flags]
### Examples
```
chantools sweeptimelockmanual --rootkey xprvxxxxxxxx \
chantools sweeptimelockmanual \
--sweepaddr bc1q..... \
--timelockaddr bc1q............ \
--remoterevbasepoint 03xxxxxxx \

Loading…
Cancel
Save