Skip to content

Commit

Permalink
docs: update module and OpenAPI specs from the node repo (#492)
Browse files Browse the repository at this point in the history
Co-authored-by: fadeev <[email protected]>
  • Loading branch information
github-actions[bot] and fadeev authored Nov 28, 2024
1 parent 97c55ab commit df80461
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 48 deletions.
7 changes: 5 additions & 2 deletions public/data/openapi.swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57202,6 +57202,11 @@ definitions:
format: uint64
tx_finalization_status:
$ref: '#/definitions/crosschainTxFinalizationStatus'
is_cross_chain_call:
type: boolean
title: |-
this field describes if a smart contract call should be made for a inbound
with assets only used for protocol contract version 2
crosschainInboundTracker:
type: object
properties:
Expand Down Expand Up @@ -57598,8 +57603,6 @@ definitions:
type: string
tx_signer:
type: string
proved:
type: boolean
cryptoPubKeySet:
type: object
properties:
Expand Down
8 changes: 2 additions & 6 deletions src/pages/architecture/modules/crosschain/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ 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 @@ -28,9 +25,6 @@ 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 Expand Up @@ -63,6 +57,7 @@ message MsgVoteGasPrice {
uint64 price = 3;
uint64 priority_fee = 6;
uint64 block_number = 4;
string supply = 5;
}
```

Expand Down Expand Up @@ -190,6 +185,7 @@ message MsgVoteInbound {
ProtocolContractVersion protocol_contract_version = 16;
RevertOptions revert_options = 17;
CallOptions call_options = 18;
bool is_cross_chain_call = 19;
}
```

Expand Down
69 changes: 29 additions & 40 deletions src/pages/architecture/zetacored/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ Zetacore Daemon (server)
* [zetacored parse-genesis-file](#zetacored-parse-genesis-file) - Parse the provided genesis file and import the required data into the optionally provided genesis file
* [zetacored query](#zetacored-query) - Querying subcommands
* [zetacored rollback](#zetacored-rollback) - rollback cosmos-sdk and tendermint state by one height
* [zetacored rosetta](#zetacored-rosetta) - spin up a rosetta server
* [zetacored snapshots](#zetacored-snapshots) - Manage local snapshots
* [zetacored start](#zetacored-start) - Run the full node
* [zetacored status](#zetacored-status) - Query remote node for status
* [zetacored tendermint](#zetacored-tendermint) - Tendermint subcommands
* [zetacored testnet](#zetacored-testnet) - subcommands for starting or configuring local testnets
* [zetacored tx](#zetacored-tx) - Transactions subcommands
* [zetacored upgrade-handler-version](#zetacored-upgrade-handler-version) - Print the default upgrade handler version
* [zetacored validate-genesis](#zetacored-validate-genesis) - validates the genesis file at the default location or at the location passed as an arg
* [zetacored version](#zetacored-version) - Print the application binary version information

Expand Down Expand Up @@ -7363,45 +7363,6 @@ zetacored rollback [flags]

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

## zetacored rosetta

spin up a rosetta server

```
zetacored rosetta [flags]
```

### Options

```
--addr string the address rosetta will bind to
--blockchain string the blockchain type
--denom-to-suggest string default denom for fee suggestion
--enable-fee-suggestion enable default fee suggestion
--gas-to-suggest int default gas for fee suggestion (default 200000)
--grpc string the app gRPC endpoint
-h, --help help for rosetta
--network string the network name
--offline run rosetta only with construction API
--prices-to-suggest string default prices for fee suggestion
--retries int the number of retries that will be done before quitting (default 5)
--tendermint string the tendermint rpc endpoint, without tcp://
```

### 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](#zetacored) - Zetacore Daemon (server)

## zetacored snapshots

Manage local snapshots
Expand Down Expand Up @@ -14386,6 +14347,34 @@ zetacored tx vesting create-vesting-account [to_address] [amount] [end_time] [fl

* [zetacored tx vesting](#zetacored-tx-vesting) - Vesting transaction subcommands

## zetacored upgrade-handler-version

Print the default upgrade handler version

```
zetacored upgrade-handler-version [flags]
```

### Options

```
-h, --help help for upgrade-handler-version
```

### 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](#zetacored) - Zetacore Daemon (server)

## zetacored validate-genesis

validates the genesis file at the default location or at the location passed as an arg
Expand Down

0 comments on commit df80461

Please sign in to comment.