generate cli docs

zeta-chain · Feb 7, 2024 · de278b4 · de278b4
1 parent 7333842
commit de278b4
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 16 deletions.
diff --git a/common/common.pb.go b/common/common.pb.go
diff --git a/docs/cli/zetacored/zetacored_tx_crosschain.md b/docs/cli/zetacored/zetacored_tx_crosschain.md
@@ -36,4 +36,5 @@ zetacored tx crosschain [flags]
 * [zetacored tx crosschain outbound-voter](zetacored_tx_crosschain_outbound-voter.md)	 - Broadcast message receiveConfirmation
 * [zetacored tx crosschain remove-from-out-tx-tracker](zetacored_tx_crosschain_remove-from-out-tx-tracker.md)	 - Remove a out-tx-tracker
 * [zetacored tx crosschain update-tss-address](zetacored_tx_crosschain_update-tss-address.md)	 - Create a new TSSVoter
-* [zetacored tx crosschain whitelist-erc20](zetacored_tx_crosschain-whitelist-erc20.md) - Add a new ERC20 address to whitelist
+* [zetacored tx crosschain whitelist-erc20](zetacored_tx_crosschain_whitelist-erc20.md)	 - Add a new erc20 token to whitelist
+
diff --git a/...etacored_tx_crosschain-whitelist-erc20.md → ...etacored_tx_crosschain_whitelist-erc20.md b/...etacored_tx_crosschain-whitelist-erc20.md → ...etacored_tx_crosschain_whitelist-erc20.md
@@ -1,17 +1,17 @@
 # tx crosschain whitelist-erc20
 
-Add a new ERC20 address to whitelist
+Add a new erc20 token to whitelist
 
 ```
-zetacored tx crosschain whitelist-erc20 [erc20Address] [chainId] [name] [symbol] [decimals] [gasLimit] [flags]
+zetacored tx crosschain whitelist-erc20 [erc20Address] [chainID] [name] [symbol] [decimals] [gasLimit] [flags]
 ```
 
 ### Options
 
 ```
   -a, --account-number uint      The account number of the signing account (offline mode only)
       --aux                      Generate aux signer data instead of sending a tx
-  -b, --broadcast-mode string    Transaction broadcasting mode (sync|async|block) (default "sync")
+  -b, --broadcast-mode string    Transaction broadcasting mode (sync|async|block) 
       --dry-run                  ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible)
       --fee-granter string       Fee granter grants fees for the transaction
       --fee-payer string         Fee payer pays fees for the transaction instead of deducting from the signer
@@ -21,14 +21,14 @@ zetacored tx crosschain whitelist-erc20 [erc20Address] [chainId] [name] [symbol]
       --gas-adjustment float     adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored  (default 1)
       --gas-prices string        Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
       --generate-only            Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
-  -h, --help                     help for add-whitelist-erc20
-      --keyring-backend string   Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
+  -h, --help                     help for whitelist-erc20
+      --keyring-backend string   Select keyring's backend (os|file|kwallet|pass|test|memory) 
       --keyring-dir string       The client Keyring directory; if omitted, the default 'home' directory will be used
       --ledger                   Use a connected Ledger device
-      --node string              <host>:<port> to tendermint rpc interface for this chain (default "tcp://localhost:26657")
+      --node string              [host]:[port] to tendermint rpc interface for this chain 
       --note string              Note to add a description to the transaction (previously --memo)
       --offline                  Offline mode (does not allow any online functionality)
-  -o, --output string            Output format (text|json) (default "json")
+  -o, --output string            Output format (text|json) 
   -s, --sequence uint            The sequence number of the signing account (offline mode only)
       --sign-mode string         Choose sign mode (direct|amino-json|direct-aux), this is an advanced feature
       --timeout-height uint      Set a block timeout height to prevent the tx from being committed past a certain height
@@ -40,12 +40,13 @@ zetacored tx crosschain whitelist-erc20 [erc20Address] [chainId] [name] [symbol]
 
 ```
       --chain-id string     The network chain ID
-      --home string         directory for config and data
-      --log_format string   The logging format (json|plain) (default "plain")
-      --log_level string    The logging level (trace|debug|info|warn|error|fatal|panic) (default "info")
+      --home string         directory for config and data 
+      --log_format string   The logging format (json|plain) 
+      --log_level string    The logging level (trace|debug|info|warn|error|fatal|panic) 
       --trace               print out full stack trace on errors
 ```
 
 ### SEE ALSO
 
-* [zetacored tx crosschain](zetacored_tx_crosschain.md)	 - crosschain transactions subcommands
+* [zetacored tx crosschain](zetacored_tx_crosschain.md)	 - crosschain transactions subcommands
+
diff --git a/x/crosschain/types/tx.pb.go b/x/crosschain/types/tx.pb.go