Skip to content

Commit

Permalink
docs: update module and OpenAPI specs from the node repo (#483)
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 Oct 4, 2024
1 parent 746cde4 commit 16cc608
Show file tree
Hide file tree
Showing 12 changed files with 15,423 additions and 36 deletions.
106 changes: 70 additions & 36 deletions public/data/openapi.swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29498,21 +29498,6 @@ paths:
$ref: '#/definitions/googlerpcStatus'
tags:
- Query
/zeta-chain/emissions/get_emissions_factors:
get:
summary: Queries a list of GetEmmisonsFactors items.
operationId: Query_GetEmissionsFactors
responses:
"200":
description: A successful response.
schema:
$ref: '#/definitions/emissionsQueryGetEmissionsFactorsResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
tags:
- Query
/zeta-chain/emissions/list_addresses:
get:
summary: Queries a list of ListBalances items.
Expand Down Expand Up @@ -56853,6 +56838,9 @@ definitions:
description: |-
MsgRemoveAuthorizationResponse defines the MsgRemoveAuthorizationResponse
service.
authorityMsgRemoveChainInfoResponse:
type: object
description: MsgRemoveChainInfoResponse defines the MsgRemoveChainInfoResponse service.
authorityMsgUpdateChainInfoResponse:
type: object
description: MsgUpdateChainInfoResponse defines the MsgUpdateChainInfoResponse service.
Expand Down Expand Up @@ -57071,11 +57059,21 @@ definitions:
- Gas
- ERC20
- Cmd
- NoAssetCall
default: Zeta
title: |-
- Gas: Ether, BNB, Matic, Klay, BTC, etc
- ERC20: ERC20 token
- Cmd: not a real coin, rather a command
- Cmd: no asset, used for admin command
- NoAssetCall: no asset, used for contract call
crosschainCallOptions:
type: object
properties:
gas_limit:
type: string
format: uint64
is_arbitrary_call:
type: boolean
crosschainCctxStatus:
type: string
enum:
Expand Down Expand Up @@ -57121,6 +57119,10 @@ definitions:
items:
type: object
$ref: '#/definitions/crosschainOutboundParams'
protocol_contract_version:
$ref: '#/definitions/crosschainProtocolContractVersion'
revert_options:
$ref: '#/definitions/crosschainRevertOptions'
crosschainGasPrice:
type: object
properties:
Expand Down Expand Up @@ -57231,12 +57233,22 @@ definitions:
is_removed:
type: boolean
title: if the tx was removed from the tracker due to no pending cctx
crosschainMsgMigrateERC20CustodyFundsResponse:
type: object
properties:
cctx_index:
type: string
crosschainMsgMigrateTssFundsResponse:
type: object
crosschainMsgRefundAbortedCCTXResponse:
type: object
crosschainMsgRemoveOutboundTrackerResponse:
type: object
crosschainMsgUpdateERC20CustodyPauseStatusResponse:
type: object
properties:
cctx_index:
type: string
crosschainMsgUpdateRateLimiterFlagsResponse:
type: object
crosschainMsgUpdateTssAddressResponse:
Expand Down Expand Up @@ -57272,6 +57284,7 @@ definitions:
gas_limit:
type: string
format: uint64
title: Deprecated (v21), use CallOptions
gas_price:
type: string
gas_priority_fee:
Expand All @@ -57298,6 +57311,8 @@ definitions:
type: string
tx_finalization_status:
$ref: '#/definitions/crosschainTxFinalizationStatus'
call_options:
$ref: '#/definitions/crosschainCallOptions'
crosschainOutboundTracker:
type: object
properties:
Expand All @@ -57315,6 +57330,15 @@ definitions:
items:
type: object
$ref: '#/definitions/crosschainTxHash'
crosschainProtocolContractVersion:
type: string
enum:
- V1
- V2
default: V1
title: |-
ProtocolContractVersion represents the version of the protocol contract used
for cctx workflow
crosschainQueryAllCctxResponse:
type: object
properties:
Expand Down Expand Up @@ -57537,6 +57561,21 @@ definitions:
type: object
$ref: '#/definitions/crosschainConversion'
title: conversion in azeta per token
crosschainRevertOptions:
type: object
properties:
revert_address:
type: string
call_on_revert:
type: boolean
abort_address:
type: string
revert_message:
type: string
format: byte
revert_gas_limit:
type: string
title: RevertOptions represents the options for reverting a cctx
crosschainTxFinalizationStatus:
type: string
enum:
Expand Down Expand Up @@ -57569,15 +57608,6 @@ definitions:
type: object
emissionsMsgWithdrawEmissionResponse:
type: object
emissionsQueryGetEmissionsFactorsResponse:
type: object
properties:
reservesFactor:
type: string
bondFactor:
type: string
durationFactor:
type: string
emissionsQueryListPoolAddressesResponse:
type: object
properties:
Expand Down Expand Up @@ -58421,31 +58451,35 @@ definitions:
format: int64
isAbortRefunded:
type: boolean
created_timestamp:
type: string
format: int64
description: when the CCTX was created. only populated on new transactions.
zetacoreemissionsParams:
type: object
properties:
max_bond_factor:
type: string
min_bond_factor:
type: string
avg_block_time:
type: string
target_bond_ratio:
type: string
validator_emission_percentage:
type: string
observer_emission_percentage:
type: string
tss_signer_emission_percentage:
type: string
duration_factor_constant:
type: string
observer_slash_amount:
type: string
ballot_maturity_blocks:
type: string
format: int64
description: Params defines the parameters for the module.
block_reward_amount:
type: string
title: |-
Params defines the parameters for the module.
Sample values:
ValidatorEmissionPercentage: "00.50",
ObserverEmissionPercentage: "00.25",
TssSignerEmissionPercentage: "00.25",
ObserverSlashAmount: 100000000000000000,
BallotMaturityBlocks: 100,
BlockRewardAmount: 9620949074074074074.074070733466756687,
ethermint.evm.v1.ChainConfig:
type: object
properties:
Expand Down
61 changes: 61 additions & 0 deletions src/pages/architecture/modules/authority/messages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Messages

## MsgUpdatePolicies

UpdatePolicies updates policies

```proto
message MsgUpdatePolicies {
string creator = 1;
Policies policies = 2;
}
```

## MsgUpdateChainInfo

UpdateChainInfo updates the chain info object
If the provided chain does not exist in the chain info object, it is added
If the chain already exists in the chain info object, it is updated

```proto
message MsgUpdateChainInfo {
string creator = 1;
pkg.chains.Chain chain = 3;
}
```

## MsgRemoveChainInfo

RemoveChainInfo removes the chain info for the specified chain id

```proto
message MsgRemoveChainInfo {
string creator = 1;
int64 chain_id = 2;
}
```

## MsgAddAuthorization

AddAuthorization defines a method to add an authorization.If the authorization already exists, it will be overwritten with the provided policy.
This should be called by the admin policy account.

```proto
message MsgAddAuthorization {
string creator = 1;
string msg_url = 2;
PolicyType authorized_policy = 3;
}
```

## MsgRemoveAuthorization

RemoveAuthorization removes the authorization from the list. It should be called by the admin policy account.

```proto
message MsgRemoveAuthorization {
string creator = 1;
string msg_url = 2;
}
```

Loading

0 comments on commit 16cc608

Please sign in to comment.