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

zeta-chain · Feb 6, 2024 · 63245d9 · 63245d9
1 parent 3ef768e
commit 63245d9
Show file tree

Hide file tree

Showing 6 changed files with 87 additions and 5 deletions.
diff --git a/docs/architecture/modules/crosschain/messages.md b/docs/architecture/modules/crosschain/messages.md
@@ -258,3 +258,15 @@ message MsgCreateTSSVoter {
 }
 ```
 
+## MsgAbortStuckCCTX
+
+AbortStuckCCTX aborts a stuck CCTX
+Authorized: admin policy group 2
+
+```proto
+message MsgAbortStuckCCTX {
+	string creator = 1;
+	string cctx_index = 2;
+}
+```
+
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
@@ -3,7 +3,7 @@
 Query tss address by finalized zeta height (for historical tss addresses)
 
 ```
-zetacored query observer get-historical-tss-address [finalizedZetaHeight] [flags]
+zetacored query observer get-historical-tss-address [finalizedZetaHeight] [bitcoinChainId] [flags]
 ```
 
 ### Options

diff --git a/docs/architecture/zetacored/zetacored_query_observer_get-tss-address.md b/docs/architecture/zetacored/zetacored_query_observer_get-tss-address.md
@@ -3,7 +3,7 @@
 Query current tss address
 
 ```
-zetacored query observer get-tss-address [flags]
+zetacored query observer get-tss-address [bitcoinChainId]] [flags]
 ```
 
 ### Options

diff --git a/docs/architecture/zetacored/zetacored_tx_crosschain.md b/docs/architecture/zetacored/zetacored_tx_crosschain.md
@@ -25,6 +25,7 @@ zetacored tx crosschain [flags]
 ### SEE ALSO
 
 * [zetacored tx](zetacored_tx.md)	 - Transactions subcommands
+* [zetacored tx crosschain abort-stuck-cctx](zetacored_tx_crosschain_abort-stuck-cctx.md)	 - abort a stuck CCTX
 * [zetacored tx crosschain add-to-in-tx-tracker](zetacored_tx_crosschain_add-to-in-tx-tracker.md)	 - Add a in-tx-tracker 
 				Use 0:Zeta,1:Gas,2:ERC20
 * [zetacored tx crosschain add-to-out-tx-tracker](zetacored_tx_crosschain_add-to-out-tx-tracker.md)	 - Add a out-tx-tracker

diff --git a/docs/architecture/zetacored/zetacored_tx_crosschain_abort-stuck-cctx.md b/docs/architecture/zetacored/zetacored_tx_crosschain_abort-stuck-cctx.md
@@ -0,0 +1,52 @@
+# tx crosschain abort-stuck-cctx
+
+abort a stuck CCTX
+
+```
+zetacored tx crosschain abort-stuck-cctx [index] [flags]
+```
+
+### Options
+
+```
+  -a, --account-number uint      The account number of the signing account (offline mode only)
+      --aux                      Generate aux signer data instead of sending a tx
+  -b, --broadcast-mode string    Transaction broadcasting mode (sync|async|block) 
+      --dry-run                  ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible)
+      --fee-granter string       Fee granter grants fees for the transaction
+      --fee-payer string         Fee payer pays fees for the transaction instead of deducting from the signer
+      --fees string              Fees to pay along with transaction; eg: 10uatom
+      --from string              Name or address of private key with which to sign
+      --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 only accessed when providing a key name)
+  -h, --help                     help for abort-stuck-cctx
+      --keyring-backend string   Select keyring's backend (os|file|kwallet|pass|test|memory) 
+      --keyring-dir string       The client Keyring directory; if omitted, the default 'home' directory will be used
+      --ledger                   Use a connected Ledger device
+      --node string              [host]:[port] to tendermint rpc interface for this chain 
+      --note string              Note to add a description to the transaction (previously --memo)
+      --offline                  Offline mode (does not allow any online functionality)
+  -o, --output string            Output format (text|json) 
+  -s, --sequence uint            The sequence number of the signing account (offline mode only)
+      --sign-mode string         Choose sign mode (direct|amino-json|direct-aux), this is an advanced feature
+      --timeout-height uint      Set a block timeout height to prevent the tx from being committed past a certain height
+      --tip string               Tip is the amount that is going to be transferred to the fee payer on the target chain. This flag is only valid when used with --aux, and is ignored if the target chain didn't enable the TipDecorator
+  -y, --yes                      Skip tx broadcasting prompt confirmation
+```
+
+### 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 tx crosschain](zetacored_tx_crosschain.md)	 - crosschain transactions subcommands
+
diff --git a/static/data/openapi.swagger.yaml b/static/data/openapi.swagger.yaml
@@ -27817,7 +27817,7 @@ paths:
           format: int64
       tags:
         - Query
-  /zeta-chain/observer/get_tss_address:
+  /zeta-chain/observer/get_tss_address/{bitcoin_chain_id}:
     get:
       summary: Queries a list of GetTssAddress items.
       operationId: Query_GetTssAddress
@@ -27832,8 +27832,8 @@ paths:
             $ref: '#/definitions/googlerpcStatus'
       parameters:
         - name: bitcoin_chain_id
-          in: query
-          required: false
+          in: path
+          required: true
           type: string
           format: int64
       tags:
@@ -50813,6 +50813,8 @@ definitions:
       inbound_tx_finalized_zeta_height:
         type: string
         format: uint64
+      tx_finalization_status:
+        $ref: '#/definitions/crosschainTxFinalizationStatus'
   crosschainLastBlockHeight:
     type: object
     properties:
@@ -50828,6 +50830,8 @@ definitions:
       lastReceiveHeight:
         type: string
         format: uint64
+  crosschainMsgAbortStuckCCTXResponse:
+    type: object
   crosschainMsgAddToInTxTrackerResponse:
     type: object
   crosschainMsgAddToOutTxTrackerResponse:
@@ -50914,6 +50918,8 @@ definitions:
         format: uint64
       tss_pubkey:
         type: string
+      tx_finalization_status:
+        $ref: '#/definitions/crosschainTxFinalizationStatus'
   crosschainQueryAllCctxResponse:
     type: object
     properties:
@@ -51064,6 +51070,17 @@ definitions:
     properties:
       aborted_zeta_amount:
         type: string
+  crosschainTxFinalizationStatus:
+    type: string
+    enum:
+      - NotFinalized
+      - Finalized
+      - Executed
+    default: NotFinalized
+    title: |-
+      - NotFinalized: the corresponding tx is not finalized
+       - Finalized: the corresponding tx is finalized but not executed yet
+       - Executed: the corresponding tx is executed
   crosschainTxHashList:
     type: object
     properties: