Skip to content

Commit f78b4e0

Browse files
committed
multi: remove optional --rootkey flag from examples
1 parent 3a06ffe commit f78b4e0

24 files changed

+33
-41
lines changed

cmd/chantools/chanbackup.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ func newChanBackupCommand() *cobra.Command {
2323
Short: "Create a channel.backup file from a channel database",
2424
Long: `This command creates a new channel.backup from a
2525
channel.db file.`,
26-
Example: `chantools chanbackup --rootkey xprvxxxxxxx \
26+
Example: `chantools chanbackup \
2727
--channeldb ~/.lnd/data/graph/mainnet/channel.db \
2828
--multi_file new_channel_backup.backup`,
2929
RunE: cc.Execute,

cmd/chantools/derivekey.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ func newDeriveKeyCommand() *cobra.Command {
3535
Short: "Derive a key with a specific derivation path",
3636
Long: `This command derives a single key with the given BIP32
3737
derivation path from the root key and prints it to the console.`,
38-
Example: `chantools derivekey --rootkey xprvxxxxxxxxxx \
39-
--path "m/1017'/0'/5'/0/0'" --neuter`,
38+
Example: `chantools derivekey --path "m/1017'/0'/5'/0/0'" \
39+
--neuter`,
4040
RunE: cc.Execute,
4141
}
4242
cc.cmd.Flags().StringVar(

cmd/chantools/dumpbackup.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ func newDumpBackupCommand() *cobra.Command {
2525
Short: "Dump the content of a channel.backup file",
2626
Long: `This command dumps all information that is inside a
2727
channel.backup file in a human readable format.`,
28-
Example: `chantools dumpbackup --rootkey xprvxxxxxxxxxx \
28+
Example: `chantools dumpbackup \
2929
--multi_file ~/.lnd/data/chain/bitcoin/mainnet/channel.backup`,
3030
RunE: cc.Execute,
3131
}

cmd/chantools/fakechanbackup.go

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,14 @@ network graph (must be provided in the JSON format that the
6666
'lncli describegraph' command returns) into a fake backup file. This is the
6767
most convenient way to use this command but requires one to have a fully synced
6868
lnd node.`,
69-
Example: `chantools fakechanbackup --rootkey xprvxxxxxxxxxx \
69+
Example: `chantools fakechanbackup \
7070
--capacity 123456 \
7171
--channelpoint f39310xxxxxxxxxx:1 \
7272
--remote_node_addr [email protected]:9735 \
7373
--short_channel_id 566222x300x1 \
7474
--multi_file fake.backup
7575
76-
chantools fakechanbackup --rootkey xprvxxxxxxxxxx \
77-
--from_channel_graph lncli_describegraph.json \
76+
chantools fakechanbackup --from_channel_graph lncli_describegraph.json \
7877
--multi_file fake.backup`,
7978
RunE: cc.Execute,
8079
}

cmd/chantools/filterbackup.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func newFilterBackupCommand() *cobra.Command {
2828
"channels",
2929
Long: `Filter an lnd channel.backup file by removing certain
3030
channels (identified by their funding transaction outpoints).`,
31-
Example: `chantools filterbackup --rootkey xprvxxxxxxxxxx \
31+
Example: `chantools filterbackup \
3232
--multi_file ~/.lnd/data/chain/bitcoin/mainnet/channel.backup \
3333
--discard 2abcdef2b2bffaaa...db0abadd:1,4abcdef2b2bffaaa...db8abadd:0`,
3434
RunE: cc.Execute,

cmd/chantools/fixoldbackup.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ lnd issue [#3881](https://github.com/lightningnetwork/lnd/issues/3881)
3030
(<code>[lncli] unable to restore chan backups: rpc error: code = Unknown desc =
3131
unable to unpack chan backup: unable to derive shachain root key: unable to
3232
derive private key</code>).`,
33-
Example: `chantools fixoldbackup --rootkey xprvxxxxxxxxxx \
33+
Example: `chantools fixoldbackup \
3434
--multi_file ~/.lnd/data/chain/bitcoin/mainnet/channel.backup`,
3535
RunE: cc.Execute,
3636
}

cmd/chantools/forceclose.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ come online before you can sweep the funds from the time locked (144 - 2000
4747
blocks) transaction *or* they have a watch tower looking out for them.
4848
4949
**This should absolutely be the last resort and you have been warned!**`,
50-
Example: `chantools forceclose --rootkey xprvxxxxxxxxxx \
50+
Example: `chantools forceclose \
5151
--fromsummary results/summary-xxxx-yyyy.json
5252
--channeldb ~/.lnd/data/graph/mainnet/channel.db \
5353
--publish`,

cmd/chantools/rescueclosed.go

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,13 @@ specify the --fromsummary and --lnd_log flags to automatically look for force
7070
close addresses in the summary and the corresponding commit points in the
7171
lnd log file. This only works if lnd is running the fund-recovery branch of my
7272
guggero/lnd fork.`,
73-
Example: `chantools rescueclosed --rootkey xprvxxxxxxxxxx \
73+
Example: `chantools rescueclosed \
7474
--fromsummary results/summary-xxxxxx.json \
7575
--channeldb ~/.lnd/data/graph/mainnet/channel.db
7676
77-
chantools rescueclosed --rootkey xprvxxxxxxxxxx \
78-
--force_close_addr bc1q... \
79-
--commit_point 03xxxx
77+
chantools rescueclosed --force_close_addr bc1q... --commit_point 03xxxx
8078
81-
chantools rescueclosed --rootkey xprvxxxxxxxxxx \
82-
--fromsummary results/summary-xxxxxx.json \
79+
chantools rescueclosed --fromsummary results/summary-xxxxxx.json \
8380
--lnd_log ~/.lnd/logs/bitcoin/mainnet/lnd.log`,
8481
RunE: cc.Execute,
8582
}

cmd/chantools/rescuefunding.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ work**! They need to run the second command of this process: signrescuefunding
6161
6262
If successful, this will create a PSBT that then has to be sent to the channel
6363
partner (remote node operator).`,
64-
Example: `chantools rescuefunding --rootkey xprvxxxxxxxxxx \
64+
Example: `chantools rescuefunding \
6565
--channeldb ~/.lnd/data/graph/mainnet/channel.db \
6666
--channelpoint xxxxxxx:xx \
6767
--sweepaddr bc1qxxxxxxxxx \

cmd/chantools/signrescuefunding.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ the 2-of-2 multisig.
3434
3535
If successful, this will create a final on-chain transaction that can be
3636
broadcast by any Bitcoin node.`,
37-
Example: `chantools signrescuefunding --rootkey xprvxxxxxxxxxx \
37+
Example: `chantools signrescuefunding \
3838
--psbt <the_base64_encoded_psbt_from_step_1>`,
3939
RunE: cc.Execute,
4040
}

0 commit comments

Comments
 (0)