chore(cli): apply google CLI Syntax for required and optional args (#…

…1417)

* chore(cli): apply google CLI Syntax for required and optional args

* chore(cli): add changes in CHANGELOG

* chore(cli): fix link to PR in CHANGELOG

* chore(cli): fix args in feemarket

* chore(cli): update docs based on comments

CHANGELOG.md

@@ -66,6 +66,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (ante) [#1390](https://github.com/evmos/ethermint/pull/1390) Added multisig tx support.
 * (test) [#1396](https://github.com/evmos/ethermint/pull/1396) Increase test coverage for the EVM module `keeper`
 * (deps) [#1416](https://github.com/evmos/ethermint/pull/1416) Bump Go version to `1.19`
+* (cmd) [\#1417](https://github.com/evmos/ethermint/pull/1417) Apply Google CLI Syntax for required and optional args.
 
 ### Bug Fixes
 

cmd/ethermintd/genaccounts.go

@@ -32,7 +32,7 @@ const (
 // AddGenesisAccountCmd returns add-genesis-account cobra Command.
 func AddGenesisAccountCmd(defaultNodeHome string) *cobra.Command {
  cmd := &cobra.Command{
- Use: "add-genesis-account [address_or_key_name] [coin][,[coin]]",
+ Use: "add-genesis-account ADDRESS_OR_KEY_NAME COIN...",
  Short: "Add a genesis account to genesis.json",
  Long: `Add a genesis account to genesis.json. The provided account must specify
 the account address or key name and a list of initial coins. If a key name is given,

x/evm/client/cli/query.go

@@ -31,7 +31,7 @@ func GetQueryCmd() *cobra.Command {
 // GetStorageCmd queries a key in an accounts storage
 func GetStorageCmd() *cobra.Command {
  cmd := &cobra.Command{
- Use: "storage [address] [key]",
+ Use: "storage ADDRESS KEY",
  Short: "Gets storage for an account with a given key and height",
  Long: "Gets storage for an account with a given key and height. If the height is not provided, it will use the latest height from context.", //nolint:lll
  Args: cobra.ExactArgs(2),
@@ -71,7 +71,7 @@ func GetStorageCmd() *cobra.Command {
 // GetCodeCmd queries the code field of a given address
 func GetCodeCmd() *cobra.Command {
  cmd := &cobra.Command{
- Use: "code [address]",
+ Use: "code ADDRESS",
  Short: "Gets code from an account",
  Long: "Gets code from an account. If the height is not provided, it will use the latest height from context.",
  Args: cobra.ExactArgs(1),

x/evm/client/cli/tx.go

@@ -32,7 +32,7 @@ func GetTxCmd() *cobra.Command {
 // NewRawTxCmd command build cosmos transaction from raw ethereum transaction
 func NewRawTxCmd() *cobra.Command {
  cmd := &cobra.Command{
- Use: "raw [tx-hex]",
+ Use: "raw TX_HEX",
  Short: "Build cosmos transaction from raw ethereum transaction",
  Args: cobra.ExactArgs(1),
  RunE: func(cmd *cobra.Command, args []string) error {

x/evm/spec/09_client.md

@@ -19,7 +19,7 @@ The `query` commands allow users to query `evm` state.
 Allows users to query the smart contract code at a given address.
 
 ```go
-ethermintd query evm code [address] [flags]
+ethermintd query evm code ADDRESS [flags]
 ```
 
 ```bash
@@ -35,7 +35,7 @@ code: "0xef616c92f3cfc9e92dc270d6acff9cea213cecc7020a76ee4395af09bdceb4837a1ebdb
 Allows users to query storage for an account with a given key and height.
 
 ```bash
-ethermintd query evm storage [address] [key] [flags]
+ethermintd query evm storage ADDRESS KEY [flags]
 ```
 
 ```bash
@@ -55,7 +55,7 @@ The `tx` commands allow users to interact with the `evm` module.
 Allows users to build cosmos transactions from raw ethereum transaction.
 
 ```bash
-ethermintd tx evm raw [tx-hex] [flags]
+ethermintd tx evm raw TX_HEX [flags]
 ```
 
 ```bash

x/feemarket/spec/08_client.md

@@ -20,13 +20,13 @@ ethermintd query feemarket --help
 The `base-fee` command allows users to query the block base fee by height.
 
 ```
-ethermintd query feemarket base-fee [height] [flags]
+ethermintd query feemarket base-fee [flags]
 ```
 
 Example:
 
 ```
-ethermintd query feemarket base-fee 5...
+ethermintd query feemarket base-fee ...
 ```
 
 Example Output:
@@ -40,13 +40,13 @@ base_fee: "512908936"
 The `block-gas` command allows users to query the block gas by height.
 
 ```
-ethermintd query feemarket block-gas [height] [flags]
+ethermintd query feemarket block-gas [flags]
 ```
 
 Example:
 
 ```
-ethermintd query feemarket block-gas 5...
+ethermintd query feemarket block-gas ...
 ```
 
 Example Output: