"docs: update module and OpenAPI specs from zeta-chain/node"

zeta-chain · Dec 20, 2023 · 8e069b2 · 8e069b2
1 parent 434a572
commit 8e069b2
Show file tree

Hide file tree

Showing 26 changed files with 873 additions and 435 deletions.
diff --git a/docs/architecture/modules/crosschain/messages.md b/docs/architecture/modules/crosschain/messages.md
@@ -20,6 +20,7 @@ message MsgAddToOutTxTracker {
 
 ## MsgAddToInTxTracker
 
+AddToInTxTracker adds a new record to the inbound transaction tracker.
 TODO https://github.com/zeta-chain/node/issues/1269
 
 ```proto
@@ -47,31 +48,9 @@ message MsgRemoveFromOutTxTracker {
 }
 ```
 
-## MsgCreateTSSVoter
-
-CreateTSSVoter votes on creating a TSS key and recording the information about it (public
-key, participant and operator addresses, finalized and keygen heights).
-
-If the vote passes, the information about the TSS key is recorded on chain
-and the status of the keygen is set to "success".
-
-Fails if the keygen does not exist, the keygen has been already
-completed, or the keygen has failed.
-
-Only node accounts are authorized to broadcast this message.
-
-```proto
-message MsgCreateTSSVoter {
-	string creator = 1;
-	string tss_pubkey = 2;
-	int64 keyGenZetaHeight = 3;
-	common.ReceiveStatus status = 4;
-}
-```
-
 ## MsgGasPriceVoter
 
-Submit information about the connected chain's gas price at a specific block
+GasPriceVoter submits information about the connected chain's gas price at a specific block
 height. Gas price submitted by each validator is recorded separately and a
 median index is updated.
 
@@ -87,18 +66,6 @@ message MsgGasPriceVoter {
 }
 ```
 
-## MsgNonceVoter
-
-Deprecated.
-
-```proto
-message MsgNonceVoter {
-	string creator = 1;
-	int64 chain_id = 2;
-	uint64 nonce = 3;
-}
-```
-
 ## MsgVoteOnObservedOutboundTx
 
 VoteOnObservedOutboundTx casts a vote on an outbound transaction observed on a connected chain (after
@@ -259,3 +226,25 @@ message MsgMigrateTssFunds {
 }
 ```
 
+## MsgCreateTSSVoter
+
+CreateTSSVoter votes on creating a TSS key and recording the information about it (public
+key, participant and operator addresses, finalized and keygen heights).
+
+If the vote passes, the information about the TSS key is recorded on chain
+and the status of the keygen is set to "success".
+
+Fails if the keygen does not exist, the keygen has been already
+completed, or the keygen has failed.
+
+Only node accounts are authorized to broadcast this message.
+
+```proto
+message MsgCreateTSSVoter {
+	string creator = 1;
+	string tss_pubkey = 2;
+	int64 keyGenZetaHeight = 3;
+	common.ReceiveStatus status = 4;
+}
+```
+
diff --git a/docs/architecture/modules/emissions/overview.md b/docs/architecture/modules/emissions/overview.md
@@ -6,7 +6,7 @@ sidebar_position: 1
 
 The `emissions` module is responsible for orchestrating rewards distribution for
 observers, validators and TSS signers. Currently, it only distributes rewards to
-validators for every block. The undistributed amount for TSS and observers is stored
+validators every block. The undistributed amount for TSS and observers is stored
 in their respective pools.
 
 The distribution of rewards is implemented in the begin blocker.

diff --git a/docs/architecture/modules/fungible/messages.md b/docs/architecture/modules/fungible/messages.md
@@ -1,5 +1,15 @@
 # Messages
 
+## MsgDeploySystemContracts
+
+DeploySystemContracts deploy new instances of the system contracts
+
+```proto
+message MsgDeploySystemContracts {
+	string creator = 1;
+}
+```
+
 ## MsgDeployFungibleCoinZRC20
 
 DeployFungibleCoinZRC20 deploys a fungible coin from a connected chains as a ZRC20 on ZetaChain.
@@ -67,7 +77,7 @@ the new contract can add new variable but cannot remove any existing variable
 message MsgUpdateContractBytecode {
 	string creator = 1;
 	string contract_address = 2;
-	string new_bytecode_address = 3;
+	string new_code_hash = 3;
 }
 ```
 
@@ -85,7 +95,7 @@ message MsgUpdateZRC20WithdrawFee {
 ## MsgUpdateZRC20PausedStatus
 
 UpdateZRC20PausedStatus updates the paused status of a ZRC20
-The list of ZRC20s is either paused or unpaused
+The list of ZRC20s are either paused or unpaused
 
 ```proto
 message MsgUpdateZRC20PausedStatus {

diff --git a/docs/architecture/zetacored/zetacored_export.md b/docs/architecture/zetacored/zetacored_export.md
@@ -9,7 +9,7 @@ zetacored export [flags]
 ### Options
 
 ```
-      --for-zero-height              Export state to start at height zero (perform preprocessing)
+      --for-zero-height              Export state to start at height zero (perform preproccessing)
       --height int                   Export state from a particular height (-1 means latest height) (default -1)
   -h, --help                         help for export
       --home string                  The application home directory 

diff --git a/docs/architecture/zetacored/zetacored_gentx.md b/docs/architecture/zetacored/zetacored_gentx.md
@@ -51,7 +51,7 @@ zetacored gentx [key_name] [amount] [flags]
       --gas string                          gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically. Note: "auto" option doesn't always report accurate results. Set a valid coin value to adjust the result. Can be used instead of "fees". (default 200000)
       --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 is only accessed when providing a key name)
+      --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 gentx
       --home string                         The application home directory 
       --identity string                     The (optional) identity signature (ex. UPort or Keybase)

diff --git a/docs/architecture/zetacored/zetacored_keys.md b/docs/architecture/zetacored/zetacored_keys.md
@@ -6,7 +6,7 @@ Manage your application's keys
 
 Keyring management commands. These keys may be in any format supported by the
 Tendermint crypto library and can be used by light-clients, full nodes, or any other application
-that needs to be signed with a private key.
+that needs to sign with a private key.
 
 The keyring supports the following backends:
 
@@ -17,7 +17,7 @@ The keyring supports the following backends:
     kwallet     Uses KDE Wallet Manager as a credentials management application.
     pass        Uses the pass command line utility to store and retrieve keys.
     test        Stores keys insecurely to disk. It does not prompt for a password to be unlocked
-                and it should be used only for testing purposes.
+                and it should be use only for testing purposes.
 
 kwallet and pass backends depend on external tools. Refer to their respective documentation for more
 information:

diff --git a/docs/architecture/zetacored/zetacored_keys_add.md b/docs/architecture/zetacored/zetacored_keys_add.md
@@ -4,7 +4,7 @@ Add an encrypted private key (either newly generated or recovered), encrypt it,
 
 ### Synopsis
 
-Derive a new private key and encrypt it to disk.
+Derive a new private key and encrypt to disk.
 Optionally specify a BIP39 mnemonic, a BIP39 passphrase to further secure the mnemonic,
 and a bip32 HD path to derive a specific account. The key will be stored under the given name
 and encrypted with the given password. The only input that is required is the encryption password.

diff --git a/docs/architecture/zetacored/zetacored_query_crosschain.md b/docs/architecture/zetacored/zetacored_query_crosschain.md
@@ -25,24 +25,19 @@ zetacored query crosschain [flags]
 ### SEE ALSO
 
 * [zetacored query](zetacored_query.md)	 - Querying subcommands
-* [zetacored query crosschain get-tss-address](zetacored_query_crosschain_get-tss-address.md)	 - Query current tss address
+* [zetacored query crosschain get-zeta-accounting](zetacored_query_crosschain_get-zeta-accounting.md)	 - Query zeta accounting
 * [zetacored query crosschain in-tx-hash-to-cctx-data](zetacored_query_crosschain_in-tx-hash-to-cctx-data.md)	 - query a cctx data from a in tx hash
 * [zetacored query crosschain last-zeta-height](zetacored_query_crosschain_last-zeta-height.md)	 - Query last Zeta Height
 * [zetacored query crosschain list-all-in-tx-trackers](zetacored_query_crosschain_list-all-in-tx-trackers.md)	 - shows all inTxTrackers
 * [zetacored query crosschain list-cctx](zetacored_query_crosschain_list-cctx.md)	 - list all CCTX
-* [zetacored query crosschain list-chain-nonces](zetacored_query_crosschain_list-chain-nonces.md)	 - list all chainNonces
 * [zetacored query crosschain list-gas-price](zetacored_query_crosschain_list-gas-price.md)	 - list all gasPrice
 * [zetacored query crosschain list-in-tx-hash-to-cctx](zetacored_query_crosschain_list-in-tx-hash-to-cctx.md)	 - list all inTxHashToCctx
 * [zetacored query crosschain list-in-tx-tracker](zetacored_query_crosschain_list-in-tx-tracker.md)	 - shows a list of in tx tracker by chainId
 * [zetacored query crosschain list-out-tx-tracker](zetacored_query_crosschain_list-out-tx-tracker.md)	 - list all OutTxTracker
 * [zetacored query crosschain list-pending-cctx](zetacored_query_crosschain_list-pending-cctx.md)	 - shows pending CCTX
-* [zetacored query crosschain list-pending-nonces](zetacored_query_crosschain_list-pending-nonces.md)	 - shows a chainNonces
-* [zetacored query crosschain list-tss-history](zetacored_query_crosschain_list-tss-history.md)	 - show historical list of TSS
 * [zetacored query crosschain params](zetacored_query_crosschain_params.md)	 - shows the parameters of the module
 * [zetacored query crosschain show-cctx](zetacored_query_crosschain_show-cctx.md)	 - shows a CCTX
-* [zetacored query crosschain show-chain-nonces](zetacored_query_crosschain_show-chain-nonces.md)	 - shows a chainNonces
 * [zetacored query crosschain show-gas-price](zetacored_query_crosschain_show-gas-price.md)	 - shows a gasPrice
 * [zetacored query crosschain show-in-tx-hash-to-cctx](zetacored_query_crosschain_show-in-tx-hash-to-cctx.md)	 - shows a inTxHashToCctx
 * [zetacored query crosschain show-out-tx-tracker](zetacored_query_crosschain_show-out-tx-tracker.md)	 - shows a OutTxTracker
-* [zetacored query crosschain show-tss](zetacored_query_crosschain_show-tss.md)	 - shows a TSS
 
diff --git a/...ed/zetacored_query_crosschain_show-tss.md → ...d_query_crosschain_get-zeta-accounting.md b/...ed/zetacored_query_crosschain_show-tss.md → ...d_query_crosschain_get-zeta-accounting.md
@@ -1,9 +1,9 @@
-# query crosschain show-tss
+# query crosschain get-zeta-accounting
 
-shows a TSS
+Query zeta accounting
 
 ```
-zetacored query crosschain show-tss [flags]
+zetacored query crosschain get-zeta-accounting [flags]
 ```
 
 ### Options
@@ -12,7 +12,7 @@ zetacored query crosschain show-tss [flags]
       --grpc-addr string   the gRPC endpoint to use for this chain
       --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
-  -h, --help               help for show-tss
+  -h, --help               help for get-zeta-accounting
       --node string        [host]:[port] to Tendermint RPC interface for this chain 
   -o, --output string      Output format (text|json) 
 ```

diff --git a/docs/architecture/zetacored/zetacored_query_crosschain_list-pending-cctx.md b/docs/architecture/zetacored/zetacored_query_crosschain_list-pending-cctx.md
@@ -3,7 +3,7 @@
 shows pending CCTX
 
 ```
-zetacored query crosschain list-pending-cctx [chain-id] [flags]
+zetacored query crosschain list-pending-cctx [chain-id] [limit] [flags]
 ```
 
 ### Options

diff --git a/docs/architecture/zetacored/zetacored_query_fungible.md b/docs/architecture/zetacored/zetacored_query_fungible.md
@@ -25,6 +25,7 @@ zetacored query fungible [flags]
 ### SEE ALSO
 
 * [zetacored query](zetacored_query.md)	 - Querying subcommands
+* [zetacored query fungible code-hash](zetacored_query_fungible_code-hash.md)	 - shows the code hash of an account
 * [zetacored query fungible gas-stability-pool-address](zetacored_query_fungible_gas-stability-pool-address.md)	 - query the address of a gas stability pool
 * [zetacored query fungible gas-stability-pool-balance](zetacored_query_fungible_gas-stability-pool-balance.md)	 - query the balance of a gas stability pool for a chain
 * [zetacored query fungible gas-stability-pool-balances](zetacored_query_fungible_gas-stability-pool-balances.md)	 - query all gas stability pool balances

diff --git a/docs/architecture/zetacored/zetacored_query_fungible_code-hash.md b/docs/architecture/zetacored/zetacored_query_fungible_code-hash.md
@@ -0,0 +1,33 @@
+# query fungible code-hash
+
+shows the code hash of an account
+
+```
+zetacored query fungible code-hash [address] [flags]
+```
+
+### Options
+
+```
+      --grpc-addr string   the gRPC endpoint to use for this chain
+      --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
+      --height int         Use a specific height to query state at (this can error if the node is pruning state)
+  -h, --help               help for code-hash
+      --node string        [host]:[port] to Tendermint RPC interface for this chain 
+  -o, --output string      Output format (text|json) 
+```
+
+### Options inherited from parent commands
+
+```
+      --chain-id string     The network chain ID
+      --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 query fungible](zetacored_query_fungible.md)	 - Querying commands for the fungible module
+
diff --git a/docs/architecture/zetacored/zetacored_query_observer.md b/docs/architecture/zetacored/zetacored_query_observer.md
@@ -25,19 +25,26 @@ zetacored query observer [flags]
 ### SEE ALSO
 
 * [zetacored query](zetacored_query.md)	 - Querying subcommands
+* [zetacored query observer get-historical-tss-address](zetacored_query_observer_get-historical-tss-address.md)	 - Query tss address by finalized zeta height (for historical tss addresses)
+* [zetacored query observer get-tss-address](zetacored_query_observer_get-tss-address.md)	 - Query current tss address
 * [zetacored query observer list-blame](zetacored_query_observer_list-blame.md)	 - Query AllBlameRecords
 * [zetacored query observer list-blame-by-msg](zetacored_query_observer_list-blame-by-msg.md)	 - Query AllBlameRecords
+* [zetacored query observer list-chain-nonces](zetacored_query_observer_list-chain-nonces.md)	 - list all chainNonces
 * [zetacored query observer list-chains](zetacored_query_observer_list-chains.md)	 - list all SupportedChains
 * [zetacored query observer list-core-params](zetacored_query_observer_list-core-params.md)	 - Query GetCoreParams
 * [zetacored query observer list-node-account](zetacored_query_observer_list-node-account.md)	 - list all NodeAccount
 * [zetacored query observer list-observer](zetacored_query_observer_list-observer.md)	 - Query All Observer Mappers
+* [zetacored query observer list-pending-nonces](zetacored_query_observer_list-pending-nonces.md)	 - shows a chainNonces
+* [zetacored query observer list-tss-history](zetacored_query_observer_list-tss-history.md)	 - show historical list of TSS
 * [zetacored query observer params](zetacored_query_observer_params.md)	 - shows the parameters of the module
 * [zetacored query observer show-ballot](zetacored_query_observer_show-ballot.md)	 - Query BallotByIdentifier
 * [zetacored query observer show-blame](zetacored_query_observer_show-blame.md)	 - Query BlameByIdentifier
+* [zetacored query observer show-chain-nonces](zetacored_query_observer_show-chain-nonces.md)	 - shows a chainNonces
 * [zetacored query observer show-core-params](zetacored_query_observer_show-core-params.md)	 - Query GetCoreParamsForChain
 * [zetacored query observer show-crosschain-flags](zetacored_query_observer_show-crosschain-flags.md)	 - shows the crosschain flags
 * [zetacored query observer show-keygen](zetacored_query_observer_show-keygen.md)	 - shows keygen
 * [zetacored query observer show-node-account](zetacored_query_observer_show-node-account.md)	 - shows a NodeAccount
 * [zetacored query observer show-observer](zetacored_query_observer_show-observer.md)	 - Query ObserversByChainAndType , Use common.chain for querying
 * [zetacored query observer show-observer-count](zetacored_query_observer_show-observer-count.md)	 - Query show-observer-count
+* [zetacored query observer show-tss](zetacored_query_observer_show-tss.md)	 - shows a TSS
 
diff --git a/docs/architecture/zetacored/zetacored_query_observer_get-historical-tss-address.md b/docs/architecture/zetacored/zetacored_query_observer_get-historical-tss-address.md
@@ -0,0 +1,33 @@
+# query observer get-historical-tss-address
+
+Query tss address by finalized zeta height (for historical tss addresses)
+
+```
+zetacored query observer get-historical-tss-address [finalizedZetaHeight] [flags]
+```
+
+### Options
+
+```
+      --grpc-addr string   the gRPC endpoint to use for this chain
+      --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
+      --height int         Use a specific height to query state at (this can error if the node is pruning state)
+  -h, --help               help for get-historical-tss-address
+      --node string        [host]:[port] to Tendermint RPC interface for this chain 
+  -o, --output string      Output format (text|json) 
+```
+
+### Options inherited from parent commands
+
+```
+      --chain-id string     The network chain ID
+      --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 query observer](zetacored_query_observer.md)	 - Querying commands for the observer module
+
diff --git a/...cored_query_crosschain_get-tss-address.md → ...tacored_query_observer_get-tss-address.md b/...cored_query_crosschain_get-tss-address.md → ...tacored_query_observer_get-tss-address.md
@@ -1,9 +1,9 @@
-# query crosschain get-tss-address
+# query observer get-tss-address
 
 Query current tss address
 
 ```
-zetacored query crosschain get-tss-address [tss-pubkey] [flags]
+zetacored query observer get-tss-address [flags]
 ```
 
 ### Options
@@ -29,5 +29,5 @@ zetacored query crosschain get-tss-address [tss-pubkey] [flags]
 
 ### SEE ALSO
 
-* [zetacored query crosschain](zetacored_query_crosschain.md)	 - Querying commands for the crosschain module
+* [zetacored query observer](zetacored_query_observer.md)	 - Querying commands for the observer module
 
diff --git a/...red_query_crosschain_list-chain-nonces.md → ...cored_query_observer_list-chain-nonces.md b/...red_query_crosschain_list-chain-nonces.md → ...cored_query_observer_list-chain-nonces.md
@@ -1,9 +1,9 @@
-# query crosschain list-chain-nonces
+# query observer list-chain-nonces
 
 list all chainNonces
 
 ```
-zetacored query crosschain list-chain-nonces [flags]
+zetacored query observer list-chain-nonces [flags]
 ```
 
 ### Options
@@ -35,5 +35,5 @@ zetacored query crosschain list-chain-nonces [flags]
 
 ### SEE ALSO
 
-* [zetacored query crosschain](zetacored_query_crosschain.md)	 - Querying commands for the crosschain module
+* [zetacored query observer](zetacored_query_observer.md)	 - Querying commands for the observer module
 
diff --git a/...d_query_crosschain_list-pending-nonces.md → ...red_query_observer_list-pending-nonces.md b/...d_query_crosschain_list-pending-nonces.md → ...red_query_observer_list-pending-nonces.md
@@ -1,9 +1,9 @@
-# query crosschain list-pending-nonces
+# query observer list-pending-nonces
 
 shows a chainNonces
 
 ```
-zetacored query crosschain list-pending-nonces [flags]
+zetacored query observer list-pending-nonces [flags]
 ```
 
 ### Options
@@ -29,5 +29,5 @@ zetacored query crosschain list-pending-nonces [flags]
 
 ### SEE ALSO
 
-* [zetacored query crosschain](zetacored_query_crosschain.md)	 - Querying commands for the crosschain module
+* [zetacored query observer](zetacored_query_observer.md)	 - Querying commands for the observer module