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

zeta-chain · Sep 21, 2023 · 1572e7c · 1572e7c
1 parent 57dad39
commit 1572e7c
Show file tree

Hide file tree

Showing 4 changed files with 269 additions and 8 deletions.
diff --git a/docs/architecture/modules/crosschain/messages.md b/docs/architecture/modules/crosschain/messages.md
@@ -2,25 +2,25 @@
 
 ## MsgAddToOutTxTracker
 
-Adds a new record to the outbound transaction tracker.
-
-Only the admin policy account and the observer validators are authorized to
-broadcast this message.
+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.
 
 ```proto
 message MsgAddToOutTxTracker {
 	string creator = 1;
 	int64 chain_id = 2;
 	uint64 nonce = 3;
 	string tx_hash = 4;
+	common.Proof proof = 5;
+	string block_hash = 6;
+	int64 tx_index = 7;
 }
 ```
 
 ## MsgRemoveFromOutTxTracker
 
-Removes a record from the outbound transaction tracker by chain ID and nonce.
-
-Only the admin policy account is authorized to broadcast this message.
+RemoveFromOutTxTracker removes a record from the outbound transaction tracker by chain ID and nonce.
+only the admin policy account is authorized to broadcast this message.
 
 ```proto
 message MsgRemoveFromOutTxTracker {
@@ -134,7 +134,8 @@ message MsgVoteOnObservedOutboundTx {
 	uint64 observed_outTx_blockHeight = 4;
 	uint64 observed_outTx_gas_used = 10;
 	string observed_outTx_effective_gas_price = 11;
-	string zeta_minted = 5;
+	uint64 observed_outTx_effective_gas_limit = 12;
+	string value_received = 5;
 	common.ReceiveStatus status = 6;
 	int64 outTx_chain = 7;
 	uint64 outTx_tss_nonce = 8;

diff --git a/docs/architecture/modules/fungible/messages.md b/docs/architecture/modules/fungible/messages.md
@@ -66,3 +66,16 @@ message MsgUpdateZRC20WithdrawFee {
 }
 ```
 
+## MsgUpdateZRC20PausedStatus
+
+UpdateZRC20PausedStatus updates the paused status of a ZRC20
+The list of ZRC20s are either paused or unpaused
+
+```proto
+message MsgUpdateZRC20PausedStatus {
+	string creator = 1;
+	string zrc20_addresses = 2;
+	UpdatePausedStatusAction action = 3;
+}
+```
+
diff --git a/docs/architecture/modules/observer/messages.md b/docs/architecture/modules/observer/messages.md
@@ -70,3 +70,17 @@ message MsgUpdateKeygen {
 }
 ```
 
+## MsgAddBlockHeader
+
+AddBlockHeader handles adding a block header to the store, through majority voting of observers
+
+```proto
+message MsgAddBlockHeader {
+	string creator = 1;
+	int64 chain_id = 2;
+	bytes block_hash = 3;
+	int64 height = 4;
+	common.HeaderData header = 5;
+}
+```
+