docs: update module and OpenAPI specs from the node repo (#128)

Co-authored-by: fadeev <[email protected]>
zeta-chain · Sep 6, 2023 · d091ce0 · d091ce0
1 parent a1650b3
commit d091ce0
Show file tree

Hide file tree

Showing 4 changed files with 1,268 additions and 1,169 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/fungible/messages.md b/docs/architecture/modules/fungible/messages.md
@@ -2,7 +2,7 @@
 
 ## MsgDeployFungibleCoinZRC20
 
-Deploys a fungible coin from a connected chains as a ZRC20 on ZetaChain.
+DeployFungibleCoinZRC20 deploys a fungible coin from a connected chains as a ZRC20 on ZetaChain.
 
 If this is a gas coin, the following happens:
 
@@ -36,7 +36,7 @@ message MsgDeployFungibleCoinZRC20 {
 
 ## MsgRemoveForeignCoin
 
-Removes a coin from the list of foreign coins in the module's state.
+RemoveForeignCoin removes a coin from the list of foreign coins in the module's state.
 
 Only the admin policy account is authorized to broadcast this message.
 

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;
 }
 ```