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 Sep 2, 2023
1 parent a1650b3 commit 9d7b058
Show file tree
Hide file tree
Showing 4 changed files with 106 additions and 7 deletions.
11 changes: 11 additions & 0 deletions docs/architecture/modules/crosschain/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ message MsgVoteOnObservedOutboundTx {
string cctx_hash = 2;
string observed_outTx_hash = 3;
uint64 observed_outTx_blockHeight = 4;
uint64 observed_outTx_gas_used = 10;
string observed_outTx_effective_gas_price = 11;
string zeta_minted = 5;
common.ReceiveStatus status = 6;
int64 outTx_chain = 7;
Expand Down Expand Up @@ -216,3 +218,12 @@ message MsgWhitelistERC20 {
}
```

## MsgUpdateTssAddress

```proto
message MsgUpdateTssAddress {
string creator = 1;
string tss_pubkey = 2;
}
```

4 changes: 2 additions & 2 deletions docs/architecture/modules/fungible/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## MsgDeployFungibleCoinZRC20

Deploys a fungible coin from a connected chains as a ZRC20 on ZetaChain.
DeployFungibleCoinZRC20 deploys a fungible coin from a connected chains as a ZRC20 on ZetaChain.

If this is a gas coin, the following happens:

Expand Down Expand Up @@ -36,7 +36,7 @@ message MsgDeployFungibleCoinZRC20 {

## MsgRemoveForeignCoin

Removes a coin from the list of foreign coins in the module's state.
RemoveForeignCoin removes a coin from the list of foreign coins in the module's state.

Only the admin policy account is authorized to broadcast this message.

Expand Down
9 changes: 6 additions & 3 deletions docs/architecture/modules/observer/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

## MsgAddObserver

Not implemented.
AddObserver adds in a new observer to the store.It can be executed using an admin policy account
Once added, the function also resets keygen and pauses inbound so that a new TSS can be generated.

```proto
message MsgAddObserver {
string creator = 1;
int64 chain_id = 2;
ObservationType observationType = 3;
string observer_address = 2;
string zetaclient_grantee_pubkey = 3;
bool add_node_account_only = 4;
}
```

Expand Down Expand Up @@ -50,6 +52,7 @@ Only the admin policy account is authorized to broadcast this message.
message MsgUpdatePermissionFlags {
string creator = 1;
bool isInboundEnabled = 3;
bool isOutboundEnabled = 4;
}
```

Expand Down
89 changes: 87 additions & 2 deletions static/data/openapi.swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27227,6 +27227,20 @@ paths:
$ref: '#/definitions/googlerpcStatus'
tags:
- Query
/zeta-chain/crosschain/tssHistory: |
get:
operationId: Query_TssHistory
responses:
"200":
description: A successful response.
schema:
$ref: '#/definitions/crosschainQueryTssHistoryResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
tags:
- Query
/zeta-chain/observer/all_observer_mappers: |
get:
operationId: Query_AllObserverMappers
Expand Down Expand Up @@ -27633,6 +27647,42 @@ paths:
type: string
tags:
- Query
/zeta-chain/zetacore/fungible/gas_stability_pool_address: |
get:
summary: Queries the address of a gas stability pool on a given chain.
operationId: Query_GasStabilityPoolAddress
responses:
"200":
description: A successful response.
schema:
$ref: '#/definitions/fungibleQueryGetGasStabilityPoolAddressResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
tags:
- Query
/zeta-chain/zetacore/fungible/gas_stability_pool_balance/{chain_id}: |
get:
summary: Queries the balance of a gas stability pool on a given chain.
operationId: Query_GasStabilityPoolBalance
responses:
"200":
description: A successful response.
schema:
$ref: '#/definitions/fungibleQueryGetGasStabilityPoolBalanceResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: chain_id
in: path
required: true
type: string
format: int64
tags:
- Query
/zeta-chain/zetacore/fungible/params: |
get:
summary: Parameters queries the parameters of the module.
Expand Down Expand Up @@ -50213,6 +50263,8 @@ definitions:
type: object
crosschainMsgRemoveFromOutTxTrackerResponse:
type: object
crosschainMsgUpdateTssAddressResponse:
type: object
crosschainMsgVoteOnObservedInboundTxResponse:
type: object
crosschainMsgVoteOnObservedOutboundTxResponse:
Expand Down Expand Up @@ -50260,12 +50312,19 @@ definitions:
type: string
title: |-
the above are commands for zetaclients
the following fields are used for the outbound tx are mined
the following fields are used when the outbound tx is mined
outbound_tx_ballot_index:
type: string
outbound_tx_observed_external_height:
type: string
format: uint64
outbound_tx_gas_used:
type: string
format: uint64
outbound_tx_effective_gas_price:
type: string
tss_pubkey:
type: string
crosschainPendingNonces:
type: object
properties:
Expand Down Expand Up @@ -50440,6 +50499,14 @@ definitions:
properties:
feeInZeta:
type: string
crosschainQueryTssHistoryResponse:
type: object
properties:
tss_list:
type: array
items:
type: object
$ref: '#/definitions/crosschainTSS'
crosschainTSS:
type: object
properties:
Expand Down Expand Up @@ -50536,6 +50603,20 @@ definitions:
properties:
foreignCoins:
$ref: '#/definitions/fungibleForeignCoins'
fungibleQueryGetGasStabilityPoolAddressResponse:
type: object
properties:
cosmos_address:
type: string
evm_address:
type: string
fungibleQueryGetGasStabilityPoolBalanceResponse:
type: object
properties:
contract_address:
type: string
balance:
type: string
fungibleQueryGetSystemContractResponse:
type: object
properties:
Expand Down Expand Up @@ -50736,6 +50817,8 @@ definitions:
properties:
isInboundEnabled:
type: boolean
isOutboundEnabled:
type: boolean
observerPolicy_Type:
type: string
enum:
Expand All @@ -50744,6 +50827,7 @@ definitions:
- update_client_params
- update_keygen_block
- out_tx_tracker
- add_observer
default: stop_inbound_cctx
title: '- stop_inbound_cctx: some observer sees inbound tx'
observerQueryAllBlameRecordsResponse:
Expand Down Expand Up @@ -51011,4 +51095,5 @@ definitions:
$ref: '#/definitions/zetacoreobserverParams'
description: params holds all the parameters of this module.
description: QueryParamsResponse is response type for the Query/Params RPC method.
\nhost: zetachain-athens.blockpi.network/lcd/v1/public

host: zetachain-athens.blockpi.network/lcd/v1/public

0 comments on commit 9d7b058

Please sign in to comment.