Skip to content

docs: update module and OpenAPI specs from the node repo #762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update module and OpenAPI specs from the node repo #762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions public/data/openapi.swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55748,6 +55748,8 @@ definitions:
type: object
zetachain.zetacore.observer.MsgRemoveChainParamsResponse:
type: object
zetachain.zetacore.observer.MsgRemoveObserverResponse:
type: object
zetachain.zetacore.observer.MsgResetChainNoncesResponse:
type: object
zetachain.zetacore.observer.MsgUpdateChainParamsResponse:
Expand Down
11 changes: 11 additions & 0 deletions src/pages/developers/architecture/modules.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -816,6 +816,17 @@ message MsgAddObserver {
}
```

#### MsgRemoveObserver

RemoveObserver removes an observer address from the observer set and node account list

```proto
message MsgRemoveObserver {
string creator = 1;
string observer_address = 2;
}
```

#### MsgUpdateObserver

UpdateObserver handles updating an observer address
Expand Down
52 changes: 51 additions & 1 deletion src/pages/developers/architecture/zetacored.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Zetacore Daemon (server)
* [zetacored comet](#zetacored-comet) - CometBFT subcommands
* [zetacored config](#zetacored-config) - Utilities for managing application configuration
* [zetacored debug](#zetacored-debug) - Tool for helping with debugging your application
* [zetacored devnet](#zetacored-devnet) - Modify state to create devnet from current local data
* [zetacored docs](#zetacored-docs) - Generate markdown documentation for zetacored
* [zetacored export](#zetacored-export) - Export state to JSON
* [zetacored gentx](#zetacored-gentx) - Generate a genesis tx carrying a self delegation
Expand Down Expand Up @@ -990,6 +991,52 @@ zetacored debug raw-bytes '[72 101 108 108 111 44 32 112 108 97 121 103 114 111

* [zetacored debug](#zetacored-debug) - Tool for helping with debugging your application

## zetacored devnet

Modify state to create devnet from current local data

### Synopsis

Modify state to create a devnet from current local state. This will set the chain ID to the provided newChainID.
The provided operatorAddress is used as the operator for the single validator in this network. The existing node key is reused.
The optional upgradeVersion parameter schedules an upgrade to that version (e.g., v37.0.0). If not provided, no upgrade is scheduled.


```
zetacored devnet [newChainID] [operatorAddress] [upgradeVersion] [flags]
```

### Examples

```
zetacored devnet devnet_70000-1 zeta13c7p3xrhd6q2rx3h235jpt8pjdwvacyw6twpax
zetacored devnet devnet_70000-1 zeta13c7p3xrhd6q2rx3h235jpt8pjdwvacyw6twpax v37.0.0
```

### Options

```
-h, --help help for devnet
--shutdown-grace duration On Shutdown, duration to wait for resource clean up (default 3s)
--skip-confirmation Skip the confirmation prompt
--trace-store string Enable KVStore tracing to an output file
--with-cometbft Run abci app embedded in-process with CometBFT (default true)
```

### 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|disabled or '*:[level],[key]:[level]')
--log_no_color Disable colored logs
--trace print out full stack trace on errors
```

### SEE ALSO

* [zetacored](#zetacored) - Zetacore Daemon (server)

## zetacored docs

Generate markdown documentation for zetacored
Expand Down Expand Up @@ -9722,6 +9769,7 @@ zetacored start [flags]
--home string The application home directory
--inter-block-cache Enable inter-block caching (default true)
--inv-check-period uint Assert registered invariants every N blocks
--is-devnet Enable devnet mode to fork from existing state
--json-rpc.address string the JSON-RPC server address to listen on
--json-rpc.allow-insecure-unlock Allow insecure account unlocking when account-related RPCs are exposed by http (default true)
--json-rpc.allow-unprotected-txs Allow for unprotected (non EIP155 signed) transactions to be submitted via the node's RPC when the global parameter is disabled
Expand All @@ -9742,6 +9790,7 @@ zetacored start [flags]
--min-retain-blocks uint Minimum block height offset during ABCI commit to prune CometBFT blocks
--minimum-gas-prices string Minimum gas prices to accept for transactions; Any fee in a tx must meet this minimum (e.g. 20000000000azeta)
--moniker string node name
--new-chain-ID string New chain ID to use when running in devnet mode
--p2p.external-address string ip:port address to advertise to peers for them to dial
--p2p.laddr string node listen address. (0.0.0.0:0 means any interface, any port)
--p2p.persistent_peers string comma-delimited ID@host:port persistent peers
Expand All @@ -9759,7 +9808,8 @@ zetacored start [flags]
--rpc.laddr string RPC listen address. Port required
--rpc.pprof_laddr string pprof listen address (https://golang.org/pkg/net/http/pprof)
--rpc.unsafe enabled unsafe rpc methods
--skip-config-overwrite Skip running the config configuration overwrite handler.This is used for testing purposes only and skips using the default timeouts hardcoded and uses the config file instead
--shutdown-grace duration On Shutdown, duration to wait for resource clean up (default 3s)
--skip-config-overwrite Skip running the config configuration overwrite handler. This is used for testing purposes only and skips using the default timeouts hardcoded and uses the config file instead
--state-sync.snapshot-interval uint State sync snapshot interval
--state-sync.snapshot-keep-recent uint32 State sync snapshot to keep (default 2)
--tls.certificate-path string the cert.pem file path for the server TLS configuration
Expand Down
Loading