Skip to content

Commit 8e9aa8a

Browse files
mergify[bot]mpoke
andauthored
docs: improve CLI help messages (backport #2352) (#2353)
docs: improve CLI help messages (#2352) improve CLI help messages (cherry picked from commit 81755f1) Co-authored-by: Marius Poke <[email protected]>
1 parent 8f55cd7 commit 8e9aa8a

File tree

1 file changed

+23
-23
lines changed
  • x/ccv/provider/client/cli

1 file changed

+23
-23
lines changed

x/ccv/provider/client/cli/tx.go

+23-23
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ An IBC misbehaviour contains two conflicting IBC client headers, which are used
9595
The misbehaviour type definition can be found in the IBC client messages, see ibc-go/proto/ibc/core/client/v1/tx.proto.
9696
9797
Example:
98-
%s tx provider submit-consumer-misbehaviour [consumer-id] [path/to/misbehaviour.json] --from node0 --home ../node0 --chain-id $CID
98+
%s tx provider submit-consumer-misbehaviour [consumer-id] [path/to/misbehaviour.json]
9999
`, version.AppName)),
100100
Args: cobra.ExactArgs(2),
101101
RunE: func(cmd *cobra.Command, args []string) error {
@@ -154,7 +154,7 @@ func NewSubmitConsumerDoubleVotingCmd() *cobra.Command {
154154
definition can be found in the IBC messages, see ibc-go/proto/ibc/lightclients/tendermint/v1/tendermint.proto.
155155
156156
Example:
157-
%s tx provider submit-consumer-double-voting [consumer-id] [path/to/evidence.json] [path/to/infraction_header.json] --from node0 --home ../node0 --chain-id $CID
157+
%s tx provider submit-consumer-double-voting [consumer-id] [path/to/evidence.json] [path/to/infraction_header.json]
158158
`, version.AppName)),
159159
Args: cobra.ExactArgs(3),
160160
RunE: func(cmd *cobra.Command, args []string) error {
@@ -221,23 +221,23 @@ Note that the one that signs this message is the owner of this consumer chain. T
221221
changed by updating the consumer chain.
222222
223223
Example:
224-
%s tx provider create-consumer [path/to/create_consumer.json] --from node0 --home ../node0 --chain-id $CID
224+
%s tx provider create-consumer [path/to/create_consumer.json]
225225
226226
where create_consumer.json has the following structure:
227227
{
228-
"chain_id": "consu",
228+
"chain_id": "consumer-1",
229229
"metadata": {
230230
"name": "chain consumer",
231231
"description": "description",
232-
"metadata": "metadata"
232+
"metadata": "{\"forge_json_url\": \"...\", \"stage\": \"mainnet\"}"
233233
},
234234
"initialization_parameters": {
235235
"initial_height": {
236236
"revision_number": 0,
237237
"revision_height": 1
238238
},
239-
"genesis_hash": "Z2VuX2hhc2g=",
240-
"binary_hash": "YmluX2hhc2g=",
239+
"genesis_hash": "",
240+
"binary_hash": "",
241241
"spawn_time": "2024-08-29T12:26:16.529913Z",
242242
"unbonding_period": 1728000000000000,
243243
"ccv_timeout_period": 2419200000000000,
@@ -248,12 +248,12 @@ where create_consumer.json has the following structure:
248248
"distribution_transmission_channel": ""
249249
},
250250
"power_shaping_parameters": {
251-
"top_N": 100,
252-
"validators_power_cap": 0,
251+
"top_N": 0,
252+
"validators_power_cap": 10,
253253
"validator_set_cap": 0,
254-
"allowlist": [],
255-
"denylist": [],
256-
"min_stake": "0",
254+
"allowlist": ["cosmosvalcons..."],
255+
"denylist": ["cosmosvalcons..."],
256+
"min_stake": 0,
257257
"allow_inactive_vals": false
258258
},
259259
"allowlisted_reward_denoms": {
@@ -318,7 +318,7 @@ func NewUpdateConsumerCmd() *cobra.Command {
318318
Note that only the owner of the chain can initialize it.
319319
320320
Example:
321-
%s tx provider update-consumer [path/to/update_consumer.json] --from node0 --home ../node0 --chain-id $CID
321+
%s tx provider update-consumer [path/to/update_consumer.json]
322322
323323
where update_consumer.json has the following structure:
324324
{
@@ -327,15 +327,15 @@ where update_consumer.json has the following structure:
327327
"metadata": {
328328
"name": "chain consumer",
329329
"description": "description",
330-
"metadata": "metadata"
330+
"metadata": "{\"forge_json_url\": \"...\", \"stage\": \"mainnet\"}"
331331
},
332332
"initialization_parameters": {
333333
"initial_height": {
334334
"revision_number": 0,
335335
"revision_height": 1
336336
},
337-
"genesis_hash": "Z2VuX2hhc2g=",
338-
"binary_hash": "YmluX2hhc2g=",
337+
"genesis_hash": "",
338+
"binary_hash": "",
339339
"spawn_time": "2024-08-29T12:26:16.529913Z",
340340
"unbonding_period": 1728000000000000,
341341
"ccv_timeout_period": 2419200000000000,
@@ -346,12 +346,12 @@ where update_consumer.json has the following structure:
346346
"distribution_transmission_channel": ""
347347
},
348348
"power_shaping_parameters": {
349-
"top_N": 100,
350-
"validators_power_cap": 0,
349+
"top_N": 0,
350+
"validators_power_cap": 10,
351351
"validator_set_cap": 0,
352-
"allowlist": [],
353-
"denylist": [],
354-
"min_stake": "0",
352+
"allowlist": ["cosmosvalcons..."],
353+
"denylist": ["cosmosvalcons..."],
354+
"min_stake": 0,
355355
"allow_inactive_vals": false
356356
},
357357
"allowlisted_reward_denoms": {
@@ -421,7 +421,7 @@ func NewRemoveConsumerCmd() *cobra.Command {
421421
Long: strings.TrimSpace(
422422
fmt.Sprintf(`Removes (and stops) a consumer chain. Note that only the owner of the chain can remove it.
423423
Example:
424-
%s tx provider remove-consumer [consumer-id] --from node0 --home ../node0 --chain-id $CID
424+
%s tx provider remove-consumer [consumer-id]
425425
`, version.AppName)),
426426
Args: cobra.ExactArgs(1),
427427
RunE: func(cmd *cobra.Command, args []string) error {
@@ -552,7 +552,7 @@ func NewSetConsumerCommissionRateCmd() *cobra.Command {
552552
Long: strings.TrimSpace(
553553
fmt.Sprintf(`Note that the "commission-rate" argument is a fraction and should be in the range [0,1].
554554
Example:
555-
%s set-consumer-commission-rate 123 0.5 --from node0 --home ../node0`,
555+
%s set-consumer-commission-rate 123 0.5`,
556556
version.AppName),
557557
),
558558
Args: cobra.ExactArgs(2),

0 commit comments

Comments
 (0)