Skip to content

Commit

Permalink
"docs: update module and OpenAPI specs from zeta-chain/node"
Browse files Browse the repository at this point in the history
  • Loading branch information
fadeev authored Dec 19, 2024
1 parent 7aa56db commit 1133aab
Show file tree
Hide file tree
Showing 4 changed files with 140 additions and 0 deletions.
34 changes: 34 additions & 0 deletions public/data/openapi.swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30431,6 +30431,21 @@ paths:
$ref: '#/definitions/googlerpcStatus'
tags:
- Query
/zeta-chain/observer/operationalFlags:
get:
summary: Queries operational flags
operationId: Query_OperationalFlags
responses:
"200":
description: A successful response.
schema:
$ref: '#/definitions/observerQueryOperationalFlagsResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
tags:
- Query
/zeta-chain/observer/pendingNonces:
get:
operationId: Query_PendingNoncesAll
Expand Down Expand Up @@ -57603,6 +57618,8 @@ definitions:
type: string
tx_signer:
type: string
proven:
type: boolean
cryptoPubKeySet:
type: object
properties:
Expand Down Expand Up @@ -58016,6 +58033,8 @@ definitions:
type: object
observerMsgUpdateObserverResponse:
type: object
observerMsgUpdateOperationalFlagsResponse:
type: object
observerMsgVoteBlameResponse:
type: object
observerMsgVoteBlockHeaderResponse:
Expand Down Expand Up @@ -58082,6 +58101,16 @@ definitions:
- Tombstoned
- AdminUpdate
default: Undefined
observerOperationalFlags:
type: object
properties:
restart_height:
type: string
format: int64
description: |-
Height for a coordinated zetaclient restart.
Will be ignored if missed.
description: Flags for the top-level operation of zetaclient.
observerPendingNonces:
type: object
properties:
Expand Down Expand Up @@ -58225,6 +58254,11 @@ definitions:
type: array
items:
type: string
observerQueryOperationalFlagsResponse:
type: object
properties:
operational_flags:
$ref: '#/definitions/observerOperationalFlags'
observerQueryPendingNoncesByChainResponse:
type: object
properties:
Expand Down
6 changes: 6 additions & 0 deletions src/pages/architecture/modules/crosschain/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ message MsgAddOutboundTracker {
int64 chain_id = 2;
uint64 nonce = 3;
string tx_hash = 4;
pkg.proofs.Proof proof = 5;
string block_hash = 6;
int64 tx_index = 7;
}
```

Expand All @@ -25,6 +28,9 @@ message MsgAddInboundTracker {
int64 chain_id = 2;
string tx_hash = 3;
pkg.coin.CoinType coin_type = 4;
pkg.proofs.Proof proof = 5;
string block_hash = 6;
int64 tx_index = 7;
}
```

Expand Down
9 changes: 9 additions & 0 deletions src/pages/architecture/modules/observer/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,3 +164,12 @@ message MsgUpdateGasPriceIncreaseFlags {
}
```

## MsgUpdateOperationalFlags

```proto
message MsgUpdateOperationalFlags {
string creator = 1;
OperationalFlags operationalFlags = 2;
}
```

91 changes: 91 additions & 0 deletions src/pages/architecture/zetacored/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -5394,6 +5394,7 @@ zetacored query observer [flags]
* [zetacored query observer show-keygen](#zetacored-query-observer-show-keygen) - shows keygen
* [zetacored query observer show-node-account](#zetacored-query-observer-show-node-account) - shows a NodeAccount
* [zetacored query observer show-observer-count](#zetacored-query-observer-show-observer-count) - Query show-observer-count
* [zetacored query observer show-operational-flags](#zetacored-query-observer-show-operational-flags) - shows the operational flags
* [zetacored query observer show-tss](#zetacored-query-observer-show-tss) - shows a TSS
* [zetacored query observer show-tss-funds-migrator](#zetacored-query-observer-show-tss-funds-migrator) - show the tss funds migrator for a chain

Expand Down Expand Up @@ -6101,6 +6102,40 @@ zetacored query observer show-observer-count [flags]

* [zetacored query observer](#zetacored-query-observer) - Querying commands for the observer module

## zetacored query observer show-operational-flags

shows the operational flags

```
zetacored query observer show-operational-flags [flags]
```

### Options

```
--grpc-addr string the gRPC endpoint to use for this chain
--grpc-insecure allow gRPC over insecure channels, if not TLS the server must use TLS
--height int Use a specific height to query state at (this can error if the node is pruning state)
-h, --help help for show-operational-flags
--node string [host]:[port] to Tendermint RPC interface for this chain
-o, --output string Output format (text|json)
```

### 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)
--log_no_color Disable colored logs
--trace print out full stack trace on errors
```

### SEE ALSO

* [zetacored query observer](#zetacored-query-observer) - Querying commands for the observer module

## zetacored query observer show-tss

shows a TSS
Expand Down Expand Up @@ -12767,6 +12802,7 @@ zetacored tx observer [flags]
* [zetacored tx observer update-gas-price-increase-flags](#zetacored-tx-observer-update-gas-price-increase-flags) - Update the gas price increase flags
* [zetacored tx observer update-keygen](#zetacored-tx-observer-update-keygen) - command to update the keygen block via a group proposal
* [zetacored tx observer update-observer](#zetacored-tx-observer-update-observer) - Broadcast message add-observer
* [zetacored tx observer update-operational-flags](#zetacored-tx-observer-update-operational-flags) - Broadcast message UpdateOperationalFlags
* [zetacored tx observer vote-blame](#zetacored-tx-observer-vote-blame) - Broadcast message vote-blame
* [zetacored tx observer vote-tss](#zetacored-tx-observer-vote-tss) - Vote for a new TSS creation

Expand Down Expand Up @@ -13300,6 +13336,61 @@ zetacored tx observer update-observer [old-observer-address] [new-observer-addre

* [zetacored tx observer](#zetacored-tx-observer) - observer transactions subcommands

## zetacored tx observer update-operational-flags

Broadcast message UpdateOperationalFlags

```
zetacored tx observer update-operational-flags [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)
--chain-id string The network chain ID
--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
--file string Path to a JSON file containing OperationalFlags
--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 update-operational-flags
--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)
--restart-height int Height for a coordinated zetaclient restart
-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

```
--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)
--log_no_color Disable colored logs
--trace print out full stack trace on errors
```

### SEE ALSO

* [zetacored tx observer](#zetacored-tx-observer) - observer transactions subcommands

## zetacored tx observer vote-blame

Broadcast message vote-blame
Expand Down

0 comments on commit 1133aab

Please sign in to comment.