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

zeta-chain · Sep 1, 2023 · df29f58 · df29f58
1 parent f9add3d
commit df29f58
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 4 deletions.
diff --git a/docs/architecture/modules/crosschain/messages.md b/docs/architecture/modules/crosschain/messages.md
@@ -132,6 +132,8 @@ message MsgVoteOnObservedOutboundTx {
 	string cctx_hash = 2;
 	string observed_outTx_hash = 3;
 	uint64 observed_outTx_blockHeight = 4;
+	uint64 observed_outTx_gas_used = 10;
+	string observed_outTx_effective_gas_price = 11;
 	string zeta_minted = 5;
 	common.ReceiveStatus status = 6;
 	int64 outTx_chain = 7;
@@ -216,3 +218,12 @@ message MsgWhitelistERC20 {
 }
 ```
 
+## MsgUpdateTssAddress
+
+```proto
+message MsgUpdateTssAddress {
+	string creator = 1;
+	string tss_pubkey = 2;
+}
+```
+
diff --git a/docs/architecture/modules/observer/messages.md b/docs/architecture/modules/observer/messages.md
@@ -2,13 +2,15 @@
 
 ## MsgAddObserver
 
-Not implemented.
+AddObserver adds in a new observer to the store.It can be executed using an admin policy account
+Once added, the function also resets keygen and pauses inbound so that a new TSS can be generated.
 
 ```proto
 message MsgAddObserver {
 	string creator = 1;
-	int64 chain_id = 2;
-	ObservationType observationType = 3;
+	string observer_address = 2;
+	string zetaclient_grantee_pubkey = 3;
+	bool add_node_account_only = 4;
 }
 ```
 
@@ -50,6 +52,7 @@ Only the admin policy account is authorized to broadcast this message.
 message MsgUpdatePermissionFlags {
 	string creator = 1;
 	bool isInboundEnabled = 3;
+	bool isOutboundEnabled = 4;
 }
 ```
 

diff --git a/static/data/openapi.swagger.yaml b/static/data/openapi.swagger.yaml
@@ -27227,6 +27227,20 @@ paths:
                     $ref: '#/definitions/googlerpcStatus'
         tags:
             - Query
+  /zeta-chain/crosschain/tssHistory: |
+    get:
+        operationId: Query_TssHistory
+        responses:
+            "200":
+                description: A successful response.
+                schema:
+                    $ref: '#/definitions/crosschainQueryTssHistoryResponse'
+            default:
+                description: An unexpected error response.
+                schema:
+                    $ref: '#/definitions/googlerpcStatus'
+        tags:
+            - Query
   /zeta-chain/observer/all_observer_mappers: |
     get:
         operationId: Query_AllObserverMappers
@@ -50213,6 +50227,8 @@ definitions:
     type: object
   crosschainMsgRemoveFromOutTxTrackerResponse:
     type: object
+  crosschainMsgUpdateTssAddressResponse:
+    type: object
   crosschainMsgVoteOnObservedInboundTxResponse:
     type: object
   crosschainMsgVoteOnObservedOutboundTxResponse:
@@ -50260,12 +50276,19 @@ definitions:
         type: string
         title: |-
           the above are commands for zetaclients
-          the following fields are used for the outbound tx are mined
+          the following fields are used when the outbound tx is mined
       outbound_tx_ballot_index:
         type: string
       outbound_tx_observed_external_height:
         type: string
         format: uint64
+      outbound_tx_gas_used:
+        type: string
+        format: uint64
+      outbound_tx_effective_gas_price:
+        type: string
+      tss_pubkey:
+        type: string
   crosschainPendingNonces:
     type: object
     properties:
@@ -50440,6 +50463,14 @@ definitions:
     properties:
       feeInZeta:
         type: string
+  crosschainQueryTssHistoryResponse:
+    type: object
+    properties:
+      tss_list:
+        type: array
+        items:
+          type: object
+          $ref: '#/definitions/crosschainTSS'
   crosschainTSS:
     type: object
     properties:
@@ -50736,6 +50767,8 @@ definitions:
     properties:
       isInboundEnabled:
         type: boolean
+      isOutboundEnabled:
+        type: boolean
   observerPolicy_Type:
     type: string
     enum:
@@ -50744,6 +50777,7 @@ definitions:
       - update_client_params
       - update_keygen_block
       - out_tx_tracker
+      - add_observer
     default: stop_inbound_cctx
     title: '- stop_inbound_cctx: some observer sees inbound tx'
   observerQueryAllBlameRecordsResponse: