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

zeta-chain · Nov 12, 2023 · 290b863 · 290b863
1 parent 877e94c
commit 290b863
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 4 deletions.
diff --git a/docs/architecture/modules/crosschain/messages.md b/docs/architecture/modules/crosschain/messages.md
@@ -4,6 +4,7 @@
 
 AddToOutTxTracker adds a new record to the outbound transaction tracker.
 only the admin policy account and the observer validators are authorized to broadcast this message without proof.
+If no pending cctx is found, the tracker is removed, if there is an existed tracker with the nonce & chainID.
 
 ```proto
 message MsgAddToOutTxTracker {
@@ -218,6 +219,7 @@ message MsgVoteOnObservedInboundTx {
 	common.CoinType coin_type = 12;
 	string tx_origin = 13;
 	string asset = 14;
+	uint64 event_index = 15;
 }
 ```
 

diff --git a/docs/architecture/zetacored/zetacored.md b/docs/architecture/zetacored/zetacored.md
@@ -25,7 +25,7 @@ Zetacore Daemon (server)
 * [zetacored docs](zetacored_docs.md)	 - Generate markdown documentation for zetacored
 * [zetacored export](zetacored_export.md)	 - Export state to JSON
 * [zetacored gentx](zetacored_gentx.md)	 - Generate a genesis tx carrying a self delegation
-* [zetacored get-pubkey](zetacored_get-pubkey.md)	 - Get you node account
+* [zetacored get-pubkey](zetacored_get-pubkey.md)	 - Get the node account public key
 * [zetacored index-eth-tx](zetacored_index-eth-tx.md)	 - Index historical eth txs
 * [zetacored init](zetacored_init.md)	 - Initialize private validator, p2p, genesis, and application configuration files
 * [zetacored keys](zetacored_keys.md)	 - Manage your application's keys

diff --git a/docs/architecture/zetacored/zetacored_get-pubkey.md b/docs/architecture/zetacored/zetacored_get-pubkey.md
@@ -1,9 +1,9 @@
 # get-pubkey
 
-Get you node account
+Get the node account public key
 
 ```
-zetacored get-pubkey [tssKeyName] [Password] [flags]
+zetacored get-pubkey [tssKeyName] [password] [flags]
 ```
 
 ### Options

diff --git a/docs/architecture/zetacored/zetacored_tx_crosschain_inbound-voter.md b/docs/architecture/zetacored/zetacored_tx_crosschain_inbound-voter.md
@@ -3,7 +3,7 @@
 Broadcast message sendVoter
 
 ```
-zetacored tx crosschain inbound-voter [sender] [senderChainID] [txOrigin] [receiver] [receiverChainID] [amount] [message] [inTxHash] [inBlockHeight] [coinType] [asset] [flags]
+zetacored tx crosschain inbound-voter [sender] [senderChainID] [txOrigin] [receiver] [receiverChainID] [amount] [message] [inTxHash] [inBlockHeight] [coinType] [asset] [eventIndex] [flags]
 ```
 
 ### Options

diff --git a/static/data/openapi.swagger.yaml b/static/data/openapi.swagger.yaml
@@ -26646,6 +26646,32 @@ paths:
           type: boolean
       tags:
         - Query
+  /zeta-chain/crosschain/cctxbyStatus/{status}:
+    get:
+      operationId: Query_CctxByStatus
+      responses:
+        "200":
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/crosschainQueryCctxByStatusResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+      parameters:
+        - name: status
+          in: path
+          required: true
+          type: string
+          enum:
+            - PendingInbound
+            - PendingOutbound
+            - OutboundMined
+            - PendingRevert
+            - Reverted
+            - Aborted
+      tags:
+        - Query
   /zeta-chain/crosschain/chainNonces:
     get:
       summary: Queries a list of chainNonces items.
@@ -27740,6 +27766,26 @@ paths:
           format: byte
       tags:
         - Query
+  /zeta-chain/observer/get_block_header_state_by_chain_id/{chain_id}:
+    get:
+      operationId: Query_GetBlockHeaderStateByChain
+      responses:
+        "200":
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/observerQueryGetBlockHeaderStateResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+      parameters:
+        - name: chain_id
+          in: path
+          required: true
+          type: string
+          format: int64
+      tags:
+        - Query
   /zeta-chain/observer/get_client_params_for_chain/{chain_id}:
     get:
       summary: Queries a list of GetClientParamsForChain items.
@@ -50609,6 +50655,10 @@ definitions:
     type: object
   crosschainMsgAddToOutTxTrackerResponse:
     type: object
+    properties:
+      is_removed:
+        type: boolean
+        title: if the tx was removed from the tracker due to no pending cctx
   crosschainMsgCreateTSSVoterResponse:
     type: object
   crosschainMsgGasPriceVoterResponse:
@@ -50810,6 +50860,14 @@ definitions:
         items:
           type: object
           $ref: '#/definitions/crosschainPendingNonces'
+  crosschainQueryCctxByStatusResponse:
+    type: object
+    properties:
+      CrossChainTx:
+        type: array
+        items:
+          type: object
+          $ref: '#/definitions/crosschainCrossChainTx'
   crosschainQueryConvertGasToZetaResponse:
     type: object
     properties:
@@ -51099,6 +51157,21 @@ definitions:
         items:
           type: object
           $ref: '#/definitions/observerNode'
+  observerBlockHeaderState:
+    type: object
+    properties:
+      chain_id:
+        type: string
+        format: int64
+      latest_height:
+        type: string
+        format: int64
+      earliest_height:
+        type: string
+        format: int64
+      latest_block_hash:
+        type: string
+        format: byte
   observerBlockHeaderVerificationFlags:
     type: object
     properties:
@@ -51354,6 +51427,11 @@ definitions:
     properties:
       block_header:
         $ref: '#/definitions/commonBlockHeader'
+  observerQueryGetBlockHeaderStateResponse:
+    type: object
+    properties:
+      block_header_state:
+        $ref: '#/definitions/observerBlockHeaderState'
   observerQueryGetCoreParamsForChainResponse:
     type: object
     properties: