smeb_y/0g-chain
1
0
Fork 0
mirror of https://github.com/0glabs/0g-chain.git synced 2024-11-14 12:05:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
206c3dcad6
0g-chain/docs/core/proto-docs.md
0g-wh 206c3dcad6 rebase to kava cosmos 0.47 upgrade 
rename

rename

tidy

clean code
2024-08-03 14:25:51 +08:00

146 KiB
Raw Blame History

Protobuf Documentation

Table of Contents

Top

crypto/vrf/keys.proto

Copyright Tharsis Labs Ltd.(Evmos) SPDX-License-Identifier:ENCL-1.0(https://github.com/evmos/evmos/blob/main/LICENSE)

PrivKey

PrivKey defines a type alias for an vrf.PrivateKey that implements Vrf's PrivateKey interface.

Field Type Label Description
key bytes key is the private key in byte form

PubKey

PubKey defines a type alias for an vrf.PublicKey that implements Vrf's PubKey interface. It represents the 32-byte compressed public key format.

Field Type Label Description
key bytes key is the public key in byte form

Top

zgc/bep3/v1beta1/bep3.proto

AssetParam

AssetParam defines parameters for each bep3 asset.

Field Type Label Description
denom string denom represents the denominatin for this asset
coin_id int64 coin_id represents the registered coin type to use (https://github.com/satoshilabs/slips/blob/master/slip-0044.md)
supply_limit SupplyLimit supply_limit defines the maximum supply allowed for the asset - a total or time based rate limit
active bool active specifies if the asset is live or paused
deputy_address bytes deputy_address the 0g-chain address of the deputy
fixed_fee string fixed_fee defines the fee for incoming swaps
min_swap_amount string min_swap_amount defines the minimum amount able to be swapped in a single message
max_swap_amount string max_swap_amount defines the maximum amount able to be swapped in a single message
min_block_lock uint64 min_block_lock defined the minimum blocks to lock
max_block_lock uint64 min_block_lock defined the maximum blocks to lock

AssetSupply

AssetSupply defines information about an asset's supply.

Field Type Label Description
incoming_supply cosmos.base.v1beta1.Coin incoming_supply represents the incoming supply of an asset
outgoing_supply cosmos.base.v1beta1.Coin outgoing_supply represents the outgoing supply of an asset
current_supply cosmos.base.v1beta1.Coin current_supply represents the current on-chain supply of an asset
time_limited_current_supply cosmos.base.v1beta1.Coin time_limited_current_supply represents the time limited current supply of an asset
time_elapsed google.protobuf.Duration time_elapsed represents the time elapsed

AtomicSwap

AtomicSwap defines an atomic swap between chains for the pricefeed module.

Field Type Label Description
amount cosmos.base.v1beta1.Coin repeated amount represents the amount being swapped
random_number_hash bytes random_number_hash represents the hash of the random number
expire_height uint64 expire_height represents the height when the swap expires
timestamp int64 timestamp represents the timestamp of the swap
sender bytes sender is the 0g-chain sender of the swap
recipient bytes recipient is the 0g-chain recipient of the swap
sender_other_chain string sender_other_chain is the sender on the other chain
recipient_other_chain string recipient_other_chain is the recipient on the other chain
closed_block int64 closed_block is the block when the swap is closed
status SwapStatus status represents the current status of the swap
cross_chain bool cross_chain identifies whether the atomic swap is cross chain
direction SwapDirection direction identifies if the swap is incoming or outgoing

Params

Params defines the parameters for the bep3 module.

Field Type Label Description
asset_params AssetParam repeated asset_params define the parameters for each bep3 asset

SupplyLimit

SupplyLimit define the absolute and time-based limits for an assets's supply.

Field Type Label Description
limit string limit defines the total supply allowed
time_limited bool time_limited enables or disables time based supply limiting
time_period google.protobuf.Duration time_period specifies the duration that time_based_limit is evalulated
time_based_limit string time_based_limit defines the maximum supply that can be swapped within time_period

SwapDirection

SwapDirection is the direction of an AtomicSwap

Name Number Description
SWAP_DIRECTION_UNSPECIFIED 0 SWAP_DIRECTION_UNSPECIFIED represents unspecified or invalid swap direcation
SWAP_DIRECTION_INCOMING 1 SWAP_DIRECTION_INCOMING represents is incoming swap (to the 0g-chain)
SWAP_DIRECTION_OUTGOING 2 SWAP_DIRECTION_OUTGOING represents an outgoing swap (from the 0g-chain)

SwapStatus

SwapStatus is the status of an AtomicSwap

Name Number Description
SWAP_STATUS_UNSPECIFIED 0 SWAP_STATUS_UNSPECIFIED represents an unspecified status
SWAP_STATUS_OPEN 1 SWAP_STATUS_OPEN represents an open swap
SWAP_STATUS_COMPLETED 2 SWAP_STATUS_COMPLETED represents a completed swap
SWAP_STATUS_EXPIRED 3 SWAP_STATUS_EXPIRED represents an expired swap

Top

zgc/bep3/v1beta1/genesis.proto

GenesisState

GenesisState defines the pricefeed module's genesis state.

Field Type Label Description
params Params params defines all the parameters of the module.
atomic_swaps AtomicSwap repeated atomic_swaps represents the state of stored atomic swaps
supplies AssetSupply repeated supplies represents the supply information of each atomic swap
previous_block_time google.protobuf.Timestamp previous_block_time represents the time of the previous block

Top

zgc/bep3/v1beta1/query.proto

AssetSupplyResponse

AssetSupplyResponse defines information about an asset's supply.

Field Type Label Description
incoming_supply cosmos.base.v1beta1.Coin incoming_supply represents the incoming supply of an asset
outgoing_supply cosmos.base.v1beta1.Coin outgoing_supply represents the outgoing supply of an asset
current_supply cosmos.base.v1beta1.Coin current_supply represents the current on-chain supply of an asset
time_limited_current_supply cosmos.base.v1beta1.Coin time_limited_current_supply represents the time limited current supply of an asset
time_elapsed google.protobuf.Duration time_elapsed represents the time elapsed

AtomicSwapResponse

AtomicSwapResponse represents the returned atomic swap properties

Field Type Label Description
id string id represents the id of the atomic swap
amount cosmos.base.v1beta1.Coin repeated amount represents the amount being swapped
random_number_hash string random_number_hash represents the hash of the random number
expire_height uint64 expire_height represents the height when the swap expires
timestamp int64 timestamp represents the timestamp of the swap
sender string sender is the 0g-chain sender of the swap
recipient string recipient is the 0g-chain recipient of the swap
sender_other_chain string sender_other_chain is the sender on the other chain
recipient_other_chain string recipient_other_chain is the recipient on the other chain
closed_block int64 closed_block is the block when the swap is closed
status SwapStatus status represents the current status of the swap
cross_chain bool cross_chain identifies whether the atomic swap is cross chain
direction SwapDirection direction identifies if the swap is incoming or outgoing

QueryAssetSuppliesRequest

QueryAssetSuppliesRequest is the request type for the Query/AssetSupplies RPC method.

QueryAssetSuppliesResponse

QueryAssetSuppliesResponse is the response type for the Query/AssetSupplies RPC method.

Field Type Label Description
asset_supplies AssetSupplyResponse repeated asset_supplies represents the supplies of returned assets

QueryAssetSupplyRequest

QueryAssetSupplyRequest is the request type for the Query/AssetSupply RPC method.

Field Type Label Description
denom string denom filters the asset response for the specified denom

QueryAssetSupplyResponse

QueryAssetSupplyResponse is the response type for the Query/AssetSupply RPC method.

Field Type Label Description
asset_supply AssetSupplyResponse asset_supply represents the supply of the asset

QueryAtomicSwapRequest

QueryAtomicSwapRequest is the request type for the Query/AtomicSwap RPC method.

Field Type Label Description
swap_id string swap_id represents the id of the swap to query

QueryAtomicSwapResponse

QueryAtomicSwapResponse is the response type for the Query/AtomicSwap RPC method.

Field Type Label Description
atomic_swap AtomicSwapResponse

QueryAtomicSwapsRequest

QueryAtomicSwapsRequest is the request type for the Query/AtomicSwaps RPC method.

Field Type Label Description
involve string involve filters by address
expiration uint64 expiration filters by expiration block height
status SwapStatus status filters by swap status
direction SwapDirection direction fitlers by swap direction
pagination cosmos.base.query.v1beta1.PageRequest

QueryAtomicSwapsResponse

QueryAtomicSwapsResponse is the response type for the Query/AtomicSwaps RPC method.

Field Type Label Description
atomic_swaps AtomicSwapResponse repeated atomic_swap represents the returned atomic swaps for the request
pagination cosmos.base.query.v1beta1.PageResponse

QueryParamsRequest

QueryParamsRequest defines the request type for querying x/bep3 parameters.

QueryParamsResponse

QueryParamsResponse defines the response type for querying x/bep3 parameters.

Field Type Label Description
params Params params represents the parameters of the module

Query

Query defines the gRPC querier service for bep3 module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries module params GET /0g/bep3/v1beta1/params
AssetSupply QueryAssetSupplyRequest QueryAssetSupplyResponse AssetSupply queries info about an asset's supply GET /0g/bep3/v1beta1/assetsupply/{denom}
AssetSupplies QueryAssetSuppliesRequest QueryAssetSuppliesResponse AssetSupplies queries a list of asset supplies GET /0g/bep3/v1beta1/assetsupplies
AtomicSwap QueryAtomicSwapRequest QueryAtomicSwapResponse AtomicSwap queries info about an atomic swap GET /0g/bep3/v1beta1/atomicswap/{swap_id}
AtomicSwaps QueryAtomicSwapsRequest QueryAtomicSwapsResponse AtomicSwaps queries a list of atomic swaps GET /0g/bep3/v1beta1/atomicswaps

Top

zgc/bep3/v1beta1/tx.proto

MsgClaimAtomicSwap

MsgClaimAtomicSwap defines the Msg/ClaimAtomicSwap request type.

Field Type Label Description
from string
swap_id string
random_number string

MsgClaimAtomicSwapResponse

MsgClaimAtomicSwapResponse defines the Msg/ClaimAtomicSwap response type.

MsgCreateAtomicSwap

MsgCreateAtomicSwap defines the Msg/CreateAtomicSwap request type.

Field Type Label Description
from string
to string
recipient_other_chain string
sender_other_chain string
random_number_hash string
timestamp int64
amount cosmos.base.v1beta1.Coin repeated
height_span uint64

MsgCreateAtomicSwapResponse

MsgCreateAtomicSwapResponse defines the Msg/CreateAtomicSwap response type.

MsgRefundAtomicSwap

MsgRefundAtomicSwap defines the Msg/RefundAtomicSwap request type.

Field Type Label Description
from string
swap_id string

MsgRefundAtomicSwapResponse

MsgRefundAtomicSwapResponse defines the Msg/RefundAtomicSwap response type.

Msg

Msg defines the bep3 Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
CreateAtomicSwap MsgCreateAtomicSwap MsgCreateAtomicSwapResponse CreateAtomicSwap defines a method for creating an atomic swap
ClaimAtomicSwap MsgClaimAtomicSwap MsgClaimAtomicSwapResponse ClaimAtomicSwap defines a method for claiming an atomic swap
RefundAtomicSwap MsgRefundAtomicSwap MsgRefundAtomicSwapResponse RefundAtomicSwap defines a method for refunding an atomic swap

Top

zgc/committee/v1beta1/committee.proto

CDP

CDP defines the state of a single collateralized debt position.

Field Type Label Description
id uint64
owner bytes
type string
collateral cosmos.base.v1beta1.Coin
principal cosmos.base.v1beta1.Coin
accumulated_fees cosmos.base.v1beta1.Coin
fees_updated google.protobuf.Timestamp
interest_factor string

Deposit

Deposit defines an amount of coins deposited by an account to a cdp

Field Type Label Description
cdp_id uint64
depositor string
amount cosmos.base.v1beta1.Coin

OwnerCDPIndex

OwnerCDPIndex defines the cdp ids for a single cdp owner

Field Type Label Description
cdp_ids uint64 repeated

TotalCollateral

TotalCollateral defines the total collateral of a given collateral type

Field Type Label Description
collateral_type string
amount cosmos.base.v1beta1.Coin

TotalPrincipal

TotalPrincipal defines the total principal of a given collateral type

Field Type Label Description
collateral_type string
amount cosmos.base.v1beta1.Coin

Top

kava/cdp/v1beta1/genesis.proto

CollateralParam

CollateralParam defines governance parameters for each collateral type within the cdp module

Field Type Label Description
denom string
type string
liquidation_ratio string
debt_limit cosmos.base.v1beta1.Coin
stability_fee string
auction_size string
liquidation_penalty string
spot_market_id string
liquidation_market_id string
keeper_reward_percentage string
check_collateralization_index_count string
conversion_factor string

DebtParam

DebtParam defines governance params for debt assets

Field Type Label Description
denom string
reference_asset string
conversion_factor string
debt_floor string

GenesisAccumulationTime

GenesisAccumulationTime defines the previous distribution time and its corresponding denom

Field Type Label Description
collateral_type string
previous_accumulation_time google.protobuf.Timestamp
interest_factor string

GenesisState

GenesisState defines the cdp module's genesis state.

Field Type Label Description
params Params params defines all the parameters of the module.
cdps CDP repeated
deposits Deposit repeated
starting_cdp_id uint64
debt_denom string
gov_denom string
previous_accumulation_times GenesisAccumulationTime repeated
total_principals GenesisTotalPrincipal repeated

GenesisTotalPrincipal

GenesisTotalPrincipal defines the total principal and its corresponding collateral type

Field Type Label Description
collateral_type string
total_principal string

Params

Params defines the parameters for the cdp module.

Field Type Label Description
collateral_params CollateralParam repeated
debt_param DebtParam
global_debt_limit cosmos.base.v1beta1.Coin
surplus_auction_threshold string
surplus_auction_lot string
debt_auction_threshold string
debt_auction_lot string
circuit_breaker bool
liquidation_block_interval int64

Top

kava/cdp/v1beta1/query.proto

CDPResponse

CDPResponse defines the state of a single collateralized debt position.

Field Type Label Description
id uint64
owner string
type string
collateral cosmos.base.v1beta1.Coin
principal cosmos.base.v1beta1.Coin
accumulated_fees cosmos.base.v1beta1.Coin
fees_updated google.protobuf.Timestamp
interest_factor string
collateral_value cosmos.base.v1beta1.Coin
collateralization_ratio string

QueryAccountsRequest

QueryAccountsRequest defines the request type for the Query/Accounts RPC method.

QueryAccountsResponse

QueryAccountsResponse defines the response type for the Query/Accounts RPC method.

Field Type Label Description
accounts cosmos.auth.v1beta1.ModuleAccount repeated

QueryCdpRequest

QueryCdpRequest defines the request type for the Query/Cdp RPC method.

Field Type Label Description
collateral_type string
owner string

QueryCdpResponse

QueryCdpResponse defines the response type for the Query/Cdp RPC method.

Field Type Label Description
cdp CDPResponse

QueryCdpsRequest

QueryCdpsRequest is the params for a filtered CDP query, the request type for the Query/Cdps RPC method.

Field Type Label Description
collateral_type string
owner string
id uint64
ratio string sdk.Dec as a string
pagination cosmos.base.query.v1beta1.PageRequest

QueryCdpsResponse

QueryCdpsResponse defines the response type for the Query/Cdps RPC method.

Field Type Label Description
cdps CDPResponse repeated
pagination cosmos.base.query.v1beta1.PageResponse

QueryDepositsRequest

QueryDepositsRequest defines the request type for the Query/Deposits RPC method.

Field Type Label Description
collateral_type string
owner string

QueryDepositsResponse

QueryDepositsResponse defines the response type for the Query/Deposits RPC method.

Field Type Label Description
deposits Deposit repeated

QueryParamsRequest

QueryParamsRequest defines the request type for the Query/Params RPC method.

QueryParamsResponse

QueryParamsResponse defines the response type for the Query/Params RPC method.

Field Type Label Description
params Params

QueryTotalCollateralRequest

QueryTotalCollateralRequest defines the request type for the Query/TotalCollateral RPC method.

Field Type Label Description
collateral_type string

QueryTotalCollateralResponse

QueryTotalCollateralResponse defines the response type for the Query/TotalCollateral RPC method.

Field Type Label Description
total_collateral TotalCollateral repeated

QueryTotalPrincipalRequest

QueryTotalPrincipalRequest defines the request type for the Query/TotalPrincipal RPC method.

Field Type Label Description
collateral_type string

QueryTotalPrincipalResponse

QueryTotalPrincipalResponse defines the response type for the Query/TotalPrincipal RPC method.

Field Type Label Description
total_principal TotalPrincipal repeated

Query

Query defines the gRPC querier service for cdp module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries all parameters of the cdp module. GET /kava/cdp/v1beta1/params
Accounts QueryAccountsRequest QueryAccountsResponse Accounts queries the CDP module accounts. GET /kava/cdp/v1beta1/accounts
TotalPrincipal QueryTotalPrincipalRequest QueryTotalPrincipalResponse TotalPrincipal queries the total principal of a given collateral type. GET /kava/cdp/v1beta1/totalPrincipal
TotalCollateral QueryTotalCollateralRequest QueryTotalCollateralResponse TotalCollateral queries the total collateral of a given collateral type. GET /kava/cdp/v1beta1/totalCollateral
Cdps QueryCdpsRequest QueryCdpsResponse Cdps queries all active CDPs. GET /kava/cdp/v1beta1/cdps
Cdp QueryCdpRequest QueryCdpResponse Cdp queries a CDP with the input owner address and collateral type. GET /kava/cdp/v1beta1/cdps/{owner}/{collateral_type}
Deposits QueryDepositsRequest QueryDepositsResponse Deposits queries deposits associated with the CDP owned by an address for a collateral type. GET /kava/cdp/v1beta1/cdps/deposits/{owner}/{collateral_type}

Top

kava/cdp/v1beta1/tx.proto

MsgCreateCDP

MsgCreateCDP defines a message to create a new CDP.

Field Type Label Description
sender string
collateral cosmos.base.v1beta1.Coin
principal cosmos.base.v1beta1.Coin
collateral_type string

MsgCreateCDPResponse

MsgCreateCDPResponse defines the Msg/CreateCDP response type.

Field Type Label Description
cdp_id uint64

MsgDeposit

MsgDeposit defines a message to deposit to a CDP.

Field Type Label Description
depositor string
owner string
collateral cosmos.base.v1beta1.Coin
collateral_type string

MsgDepositResponse

MsgDepositResponse defines the Msg/Deposit response type.

MsgDrawDebt

MsgDrawDebt defines a message to draw debt from a CDP.

Field Type Label Description
sender string
collateral_type string
principal cosmos.base.v1beta1.Coin

MsgDrawDebtResponse

MsgDrawDebtResponse defines the Msg/DrawDebt response type.

MsgLiquidate

MsgLiquidate defines a message to attempt to liquidate a CDP whos collateralization ratio is under its liquidation ratio.

Field Type Label Description
keeper string
borrower string
collateral_type string

MsgLiquidateResponse

MsgLiquidateResponse defines the Msg/Liquidate response type.

MsgRepayDebt

MsgRepayDebt defines a message to repay debt from a CDP.

Field Type Label Description
sender string
collateral_type string
payment cosmos.base.v1beta1.Coin

MsgRepayDebtResponse

MsgRepayDebtResponse defines the Msg/RepayDebt response type.

MsgWithdraw

MsgWithdraw defines a message to withdraw collateral from a CDP.

Field Type Label Description
depositor string
owner string
collateral cosmos.base.v1beta1.Coin
collateral_type string

MsgWithdrawResponse

MsgWithdrawResponse defines the Msg/Withdraw response type.

Msg

Msg defines the cdp Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
CreateCDP MsgCreateCDP MsgCreateCDPResponse CreateCDP defines a method to create a new CDP.
Deposit MsgDeposit MsgDepositResponse Deposit defines a method to deposit to a CDP.
Withdraw MsgWithdraw MsgWithdrawResponse Withdraw defines a method to withdraw collateral from a CDP.
DrawDebt MsgDrawDebt MsgDrawDebtResponse DrawDebt defines a method to draw debt from a CDP.
RepayDebt MsgRepayDebt MsgRepayDebtResponse RepayDebt defines a method to repay debt from a CDP.
Liquidate MsgLiquidate MsgLiquidateResponse Liquidate defines a method to attempt to liquidate a CDP whos collateralization ratio is under its liquidation ratio.

Top

kava/committee/v1beta1/committee.proto

BaseCommittee

BaseCommittee is a common type shared by all Committees

Field Type Label Description
id uint64
description string
members bytes repeated
permissions google.protobuf.Any repeated
vote_threshold string Smallest percentage that must vote for a proposal to pass
proposal_duration google.protobuf.Duration The length of time a proposal remains active for. Proposals will close earlier if they get enough votes.
tally_option TallyOption

MemberCommittee

MemberCommittee is an alias of BaseCommittee

Field Type Label Description
base_committee BaseCommittee

TokenCommittee

TokenCommittee supports voting on proposals by token holders

Field Type Label Description
base_committee BaseCommittee
quorum string
tally_denom string

TallyOption

TallyOption enumerates the valid types of a tally.

Name Number Description
TALLY_OPTION_UNSPECIFIED 0 TALLY_OPTION_UNSPECIFIED defines a null tally option.
TALLY_OPTION_FIRST_PAST_THE_POST 1 Votes are tallied each block and the proposal passes as soon as the vote threshold is reached
TALLY_OPTION_DEADLINE 2 Votes are tallied exactly once, when the deadline time is reached

Top

zgc/committee/v1beta1/genesis.proto

GenesisState

GenesisState defines the committee module's genesis state.

Field Type Label Description
next_proposal_id uint64
committees google.protobuf.Any repeated
proposals Proposal repeated
votes Vote repeated

Proposal

Proposal is an internal record of a governance proposal submitted to a committee.

Field Type Label Description
content google.protobuf.Any
id uint64
committee_id uint64
deadline google.protobuf.Timestamp

Vote

Vote is an internal record of a single governance vote.

Field Type Label Description
proposal_id uint64
voter bytes
vote_type VoteType

VoteType

VoteType enumerates the valid types of a vote.

Name Number Description
VOTE_TYPE_UNSPECIFIED 0 VOTE_TYPE_UNSPECIFIED defines a no-op vote option.
VOTE_TYPE_YES 1 VOTE_TYPE_YES defines a yes vote option.
VOTE_TYPE_NO 2 VOTE_TYPE_NO defines a no vote option.
VOTE_TYPE_ABSTAIN 3 VOTE_TYPE_ABSTAIN defines an abstain vote option.

Top

zgc/committee/v1beta1/permissions.proto

AllowedParamsChange

AllowedParamsChange contains data on the allowed parameter changes for subspace, key, and sub params requirements.

Field Type Label Description
subspace string
key string
single_subparam_allowed_attrs string repeated Requirements for when the subparam value is a single record. This contains list of allowed attribute keys that can be changed on the subparam record.
multi_subparams_requirements SubparamRequirement repeated Requirements for when the subparam value is a list of records. The requirements contains requirements for each record in the list.

CommunityCDPRepayDebtPermission

CommunityCDPRepayDebtPermission allows submission of CommunityCDPRepayDebtProposal

CommunityCDPWithdrawCollateralPermission

CommunityCDPWithdrawCollateralPermission allows submission of CommunityCDPWithdrawCollateralProposal

CommunityPoolLendWithdrawPermission

CommunityPoolLendWithdrawPermission allows submission of CommunityPoolLendWithdrawProposal

GodPermission

GodPermission allows any governance proposal. It is used mainly for testing.

ParamsChangePermission

ParamsChangePermission allows any parameter or sub parameter change proposal.

Field Type Label Description
allowed_params_changes AllowedParamsChange repeated

SoftwareUpgradePermission

SoftwareUpgradePermission permission type for software upgrade proposals

SubparamRequirement

SubparamRequirement contains requirements for a single record in a subparam value list

Field Type Label Description
key string The required attr key of the param record.
val string The required param value for the param record key. The key and value is used to match to the target param record.
allowed_subparam_attr_changes string repeated The sub param attrs that are allowed to be changed.

TextPermission

TextPermission allows any text governance proposal.

Top

zgc/committee/v1beta1/proposal.proto

CommitteeChangeProposal

CommitteeChangeProposal is a gov proposal for creating a new committee or modifying an existing one.

Field Type Label Description
title string
description string
new_committee google.protobuf.Any

CommitteeDeleteProposal

CommitteeDeleteProposal is a gov proposal for removing a committee.

Field Type Label Description
title string
description string
committee_id uint64

Top

zgc/committee/v1beta1/query.proto

QueryCommitteeRequest

QueryCommitteeRequest defines the request type for querying x/committee committee.

Field Type Label Description
committee_id uint64

QueryCommitteeResponse

QueryCommitteeResponse defines the response type for querying x/committee committee.

Field Type Label Description
committee google.protobuf.Any

QueryCommitteesRequest

QueryCommitteesRequest defines the request type for querying x/committee committees.

QueryCommitteesResponse

QueryCommitteesResponse defines the response type for querying x/committee committees.

Field Type Label Description
committees google.protobuf.Any repeated

QueryNextProposalIDRequest

QueryNextProposalIDRequest defines the request type for querying x/committee NextProposalID.

QueryNextProposalIDResponse

QueryNextProposalIDRequest defines the response type for querying x/committee NextProposalID.

Field Type Label Description
next_proposal_id uint64

QueryProposalRequest

QueryProposalRequest defines the request type for querying x/committee proposal.

Field Type Label Description
proposal_id uint64

QueryProposalResponse

QueryProposalResponse defines the response type for querying x/committee proposal.

Field Type Label Description
pub_proposal google.protobuf.Any
id uint64
committee_id uint64
deadline google.protobuf.Timestamp

QueryProposalsRequest

QueryProposalsRequest defines the request type for querying x/committee proposals.

Field Type Label Description
committee_id uint64

QueryProposalsResponse

QueryProposalsResponse defines the response type for querying x/committee proposals.

Field Type Label Description
proposals QueryProposalResponse repeated

QueryRawParamsRequest

QueryRawParamsRequest defines the request type for querying x/committee raw params.

Field Type Label Description
subspace string
key string

QueryRawParamsResponse

QueryRawParamsResponse defines the response type for querying x/committee raw params.

Field Type Label Description
raw_data string

QueryTallyRequest

QueryTallyRequest defines the request type for querying x/committee tally.

Field Type Label Description
proposal_id uint64

QueryTallyResponse

QueryTallyResponse defines the response type for querying x/committee tally.

Field Type Label Description
proposal_id uint64
yes_votes string
no_votes string
current_votes string
possible_votes string
vote_threshold string
quorum string

QueryVoteRequest

QueryVoteRequest defines the request type for querying x/committee vote.

Field Type Label Description
proposal_id uint64
voter string

QueryVoteResponse

QueryVoteResponse defines the response type for querying x/committee vote.

Field Type Label Description
proposal_id uint64
voter string
vote_type VoteType

QueryVotesRequest

QueryVotesRequest defines the request type for querying x/committee votes.

Field Type Label Description
proposal_id uint64
pagination cosmos.base.query.v1beta1.PageRequest

QueryVotesResponse

QueryVotesResponse defines the response type for querying x/committee votes.

Field Type Label Description
votes QueryVoteResponse repeated votes defined the queried votes.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

Query

Query defines the gRPC querier service for committee module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Committees QueryCommitteesRequest QueryCommitteesResponse Committees queries all committess of the committee module. GET /0g/committee/v1beta1/committees
Committee QueryCommitteeRequest QueryCommitteeResponse Committee queries a committee based on committee ID. GET /0g/committee/v1beta1/committees/{committee_id}
Proposals QueryProposalsRequest QueryProposalsResponse Proposals queries proposals based on committee ID. GET /0g/committee/v1beta1/proposals
Proposal QueryProposalRequest QueryProposalResponse Deposits queries a proposal based on proposal ID. GET /0g/committee/v1beta1/proposals/{proposal_id}
NextProposalID QueryNextProposalIDRequest QueryNextProposalIDResponse NextProposalID queries the next proposal ID of the committee module. GET /0g/committee/v1beta1/next-proposal-id
Votes QueryVotesRequest QueryVotesResponse Votes queries all votes for a single proposal ID. GET /0g/committee/v1beta1/proposals/{proposal_id}/votes
Vote QueryVoteRequest QueryVoteResponse Vote queries the vote of a single voter for a single proposal ID. GET /0g/committee/v1beta1/proposals/{proposal_id}/votes/{voter}
Tally QueryTallyRequest QueryTallyResponse Tally queries the tally of a single proposal ID. GET /0g/committee/v1beta1/proposals/{proposal_id}/tally
RawParams QueryRawParamsRequest QueryRawParamsResponse RawParams queries the raw params data of any subspace and key. GET /0g/committee/v1beta1/raw-params

Top

zgc/committee/v1beta1/tx.proto

MsgSubmitProposal

MsgSubmitProposal is used by committee members to create a new proposal that they can vote on.

Field Type Label Description
pub_proposal google.protobuf.Any
proposer string
committee_id uint64

MsgSubmitProposalResponse

MsgSubmitProposalResponse defines the SubmitProposal response type

Field Type Label Description
proposal_id uint64

MsgVote

MsgVote is submitted by committee members to vote on proposals.

Field Type Label Description
proposal_id uint64
voter string
vote_type VoteType

MsgVoteResponse

MsgVoteResponse defines the Vote response type

Msg

Msg defines the committee Msg service

Method Name Request Type Response Type Description HTTP Verb Endpoint
SubmitProposal MsgSubmitProposal MsgSubmitProposalResponse SubmitProposal defines a method for submitting a committee proposal
Vote MsgVote MsgVoteResponse Vote defines a method for voting on a proposal

Top

zgc/council/v1/genesis.proto

Ballot

Field Type Label Description
id uint64
content bytes

Council

Field Type Label Description
id uint64
voting_start_height uint64
start_height uint64
end_height uint64
votes Vote repeated
members bytes repeated

GenesisState

GenesisState defines the council module's genesis state.

Field Type Label Description
params Params params defines all the parameters related to commmunity
staking_rewards_state StakingRewardsState StakingRewardsState stores the internal staking reward data required to track staking rewards across blocks

Params

Field Type Label Description
council_size uint64

Vote

Field Type Label Description
council_id uint64
voter bytes
ballots Ballot repeated

Top

zgc/council/v1/query.proto

QueryCurrentCouncilIDRequest

QueryCurrentCouncilIDResponse

Field Type Label Description
params Params params defines all the parameters related to earn
vault_records VaultRecord repeated vault_records defines the available vaults
vault_share_records VaultShareRecord repeated share_records defines the owned shares of each vault

QueryRegisteredVotersRequest

QueryRegisteredVotersResponse

Field Type Label Description
voters string repeated

Query

Query defines the gRPC querier service for council module

Method Name Request Type Response Type Description HTTP Verb Endpoint
CurrentCouncilID QueryCurrentCouncilIDRequest QueryCurrentCouncilIDResponse GET /0gchain/council/v1/current-council-id
RegisteredVoters QueryRegisteredVotersRequest QueryRegisteredVotersResponse GET /0gchain/council/v1/registered-voters

Top

zgc/council/v1/tx.proto

MsgRegister

Field Type Label Description
voter string
key bytes

MsgRegisterResponse

MsgVote

Field Type Label Description
council_id uint64
voter string
ballots Ballot repeated

MsgVoteResponse

Msg

Msg defines the council Msg service

Method Name Request Type Response Type Description HTTP Verb Endpoint
Register MsgRegister MsgRegisterResponse
Vote MsgVote MsgVoteResponse

Top

zgc/dasigners/v1/dasigners.proto

Quorum

Field Type Label Description
signers string repeated

Quorums

Field Type Label Description
quorums Quorum repeated

Signer

Field Type Label Description
account string account defines the hex address of signer without 0x
socket string socket defines the da node socket address
pubkey_g1 bytes pubkey_g1 defines the public key on bn254 G1
pubkey_g2 bytes pubkey_g1 defines the public key on bn254 G2

Top

zgc/dasigners/v1/genesis.proto

GenesisState

GenesisState defines the dasigners module's genesis state.

Field Type Label Description
params Params params defines all the parameters of related to deposit.
epoch_number uint64 params epoch_number the epoch number
signers Signer repeated signers defines all signers information
quorums_by_epoch Quorums repeated quorums_by_epoch defines chosen quorums by epoch

Params

Field Type Label Description
tokens_per_vote uint64
max_votes_per_signer uint64
max_quorums uint64
epoch_blocks uint64
encoded_slices uint64

Top

zgc/dasigners/v1/query.proto

QueryAggregatePubkeyG1Request

Field Type Label Description
epoch_number uint64
quorum_id uint64
quorum_bitmap bytes

QueryAggregatePubkeyG1Response

Field Type Label Description
aggregate_pubkey_g1 bytes
total uint64
hit uint64

QueryEpochNumberRequest

QueryEpochNumberResponse

Field Type Label Description
epoch_number uint64

QueryEpochQuorumRequest

Field Type Label Description
epoch_number uint64
quorum_id uint64

QueryEpochQuorumResponse

Field Type Label Description
quorum Quorum

QueryEpochQuorumRowRequest

Field Type Label Description
epoch_number uint64
quorum_id uint64
row_index uint32

QueryEpochQuorumRowResponse

Field Type Label Description
signer string

QueryQuorumCountRequest

Field Type Label Description
epoch_number uint64

QueryQuorumCountResponse

Field Type Label Description
quorum_count uint64

QuerySignerRequest

Field Type Label Description
accounts string repeated

QuerySignerResponse

Field Type Label Description
signer Signer repeated

Query

Query defines the gRPC querier service for the dasigners module

Method Name Request Type Response Type Description HTTP Verb Endpoint
EpochNumber QueryEpochNumberRequest QueryEpochNumberResponse GET /0g/dasigners/v1/epoch-number
QuorumCount QueryQuorumCountRequest QueryQuorumCountResponse GET /0g/dasigners/v1/quorum-count
EpochQuorum QueryEpochQuorumRequest QueryEpochQuorumResponse GET /0g/dasigners/v1/epoch-quorum
EpochQuorumRow QueryEpochQuorumRowRequest QueryEpochQuorumRowResponse GET /0g/dasigners/v1/epoch-quorum-row
AggregatePubkeyG1 QueryAggregatePubkeyG1Request QueryAggregatePubkeyG1Response GET /0g/dasigners/v1/aggregate-pubkey-g1
Signer QuerySignerRequest QuerySignerResponse GET /0g/dasigners/v1/signer

Top

zgc/dasigners/v1/tx.proto

MsgRegisterNextEpoch

Field Type Label Description
account string
signature bytes

MsgRegisterNextEpochResponse

MsgRegisterSigner

Field Type Label Description
signer Signer
signature bytes

MsgRegisterSignerResponse

MsgUpdateSocket

Field Type Label Description
account string
socket string

MsgUpdateSocketResponse

Msg

Msg defines the dasigners Msg service

Method Name Request Type Response Type Description HTTP Verb Endpoint
RegisterSigner MsgRegisterSigner MsgRegisterSignerResponse
UpdateSocket MsgUpdateSocket MsgUpdateSocketResponse
RegisterNextEpoch MsgRegisterNextEpoch MsgRegisterNextEpochResponse

Top

zgc/evmutil/v1beta1/conversion_pair.proto

AllowedCosmosCoinERC20Token

AllowedCosmosCoinERC20Token defines allowed cosmos-sdk denom & metadata for evm token representations of sdk assets. NOTE: once evm token contracts are deployed, changes to metadata for a given cosmos_denom will not change metadata of deployed contract.

Field Type Label Description
cosmos_denom string Denom of the sdk.Coin
name string Name of ERC20 contract
symbol string Symbol of ERC20 contract
decimals uint32 Number of decimals ERC20 contract is deployed with.

ConversionPair

ConversionPair defines a 0gChain ERC20 address and corresponding denom that is allowed to be converted between ERC20 and sdk.Coin

Field Type Label Description
zgchain_erc20_address bytes ERC20 address of the token on the 0gChain EVM
denom string Denom of the corresponding sdk.Coin

Top

zgc/evmutil/v1beta1/genesis.proto

Account

BalanceAccount defines an account in the evmutil module.

Field Type Label Description
address bytes
balance string balance indicates the amount of neuron owned by the address.

GenesisState

GenesisState defines the evmutil module's genesis state.

Field Type Label Description
accounts Account repeated
params Params params defines all the parameters of the module.

Params

Params defines the evmutil module params

Field Type Label Description
enabled_conversion_pairs ConversionPair repeated enabled_conversion_pairs defines the list of conversion pairs allowed to be converted between 0gChain ERC20 and sdk.Coin
allowed_cosmos_denoms AllowedCosmosCoinERC20Token repeated allowed_cosmos_denoms is a list of denom & erc20 token metadata pairs. if a denom is in the list, it is allowed to be converted to an erc20 in the evm.

Top

zgc/evmutil/v1beta1/query.proto

DeployedCosmosCoinContract

DeployedCosmosCoinContract defines a deployed token contract to the evm representing a native cosmos-sdk coin

Field Type Label Description
cosmos_denom string
address string

QueryDeployedCosmosCoinContractsRequest

QueryDeployedCosmosCoinContractsRequest defines the request type for Query/DeployedCosmosCoinContracts method.

Field Type Label Description
cosmos_denoms string repeated optional query param to only return specific denoms in the list denoms that do not have deployed contracts will be omitted from the result must request fewer than 100 denoms at a time.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryDeployedCosmosCoinContractsResponse

QueryDeployedCosmosCoinContractsResponse defines the response type for the Query/DeployedCosmosCoinContracts method.

Field Type Label Description
deployed_cosmos_coin_contracts DeployedCosmosCoinContract repeated deployed_cosmos_coin_contracts is a list of cosmos-sdk coin denom and its deployed contract address
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryParamsRequest

QueryParamsRequest defines the request type for querying x/evmutil parameters.

QueryParamsResponse

QueryParamsResponse defines the response type for querying x/evmutil parameters.

Field Type Label Description
params Params

Query

Query defines the gRPC querier service for evmutil module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries all parameters of the evmutil module. GET /0g/evmutil/v1beta1/params
DeployedCosmosCoinContracts QueryDeployedCosmosCoinContractsRequest QueryDeployedCosmosCoinContractsResponse DeployedCosmosCoinContracts queries a list cosmos coin denom and their deployed erc20 address GET /0g/evmutil/v1beta1/deployed_cosmos_coin_contracts

Top

zgc/evmutil/v1beta1/tx.proto

MsgConvertCoinToERC20

MsgConvertCoinToERC20 defines a conversion from sdk.Coin to 0gChain ERC20 for EVM-native assets.

Field Type Label Description
initiator string 0gChain bech32 address initiating the conversion.
receiver string EVM 0x hex address that will receive the converted 0gChain ERC20 tokens.
amount cosmos.base.v1beta1.Coin Amount is the sdk.Coin amount to convert.

MsgConvertCoinToERC20Response

MsgConvertCoinToERC20Response defines the response value from Msg/ConvertCoinToERC20.

MsgConvertCosmosCoinFromERC20

MsgConvertCosmosCoinFromERC20 defines a conversion from ERC20 to cosmos coins for cosmos-native assets.

Field Type Label Description
initiator string EVM hex address initiating the conversion.
receiver string 0gChain bech32 address that will receive the cosmos coins.
amount cosmos.base.v1beta1.Coin Amount is the amount to convert, expressed as a Cosmos coin.

MsgConvertCosmosCoinFromERC20Response

MsgConvertCosmosCoinFromERC20Response defines the response value from Msg/MsgConvertCosmosCoinFromERC20.

MsgConvertCosmosCoinToERC20

MsgConvertCosmosCoinToERC20 defines a conversion from cosmos sdk.Coin to ERC20 for cosmos-native assets.

Field Type Label Description
initiator string 0gChain bech32 address initiating the conversion.
receiver string EVM hex address that will receive the ERC20 tokens.
amount cosmos.base.v1beta1.Coin Amount is the sdk.Coin amount to convert.

MsgConvertCosmosCoinToERC20Response

MsgConvertCosmosCoinToERC20Response defines the response value from Msg/MsgConvertCosmosCoinToERC20.

MsgConvertERC20ToCoin

MsgConvertERC20ToCoin defines a conversion from 0gChain ERC20 to sdk.Coin for EVM-native assets.

Field Type Label Description
initiator string EVM 0x hex address initiating the conversion.
receiver string 0gChain bech32 address that will receive the converted sdk.Coin.
zgchain_erc20_address string EVM 0x hex address of the ERC20 contract.
amount string ERC20 token amount to convert.

MsgConvertERC20ToCoinResponse

MsgConvertERC20ToCoinResponse defines the response value from Msg/MsgConvertERC20ToCoin.

Msg

Msg defines the evmutil Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
ConvertCoinToERC20 MsgConvertCoinToERC20 MsgConvertCoinToERC20Response ConvertCoinToERC20 defines a method for converting sdk.Coin to 0gChain ERC20.
ConvertERC20ToCoin MsgConvertERC20ToCoin MsgConvertERC20ToCoinResponse ConvertERC20ToCoin defines a method for converting 0gChain ERC20 to sdk.Coin.
ConvertCosmosCoinToERC20 MsgConvertCosmosCoinToERC20 MsgConvertCosmosCoinToERC20Response ConvertCosmosCoinToERC20 defines a method for converting a cosmos sdk.Coin to an ERC20.
ConvertCosmosCoinFromERC20 MsgConvertCosmosCoinFromERC20 MsgConvertCosmosCoinFromERC20Response ConvertCosmosCoinFromERC20 defines a method for converting a cosmos sdk.Coin to an ERC20.

Top

zgc/issuance/v1beta1/genesis.proto

Asset

Asset type for assets in the issuance module

Field Type Label Description
owner string
denom string
blocked_addresses string repeated
paused bool
blockable bool
rate_limit RateLimit

AssetSupply

AssetSupply contains information about an asset's rate-limited supply (the total supply of the asset is tracked in the top-level supply module)

Field Type Label Description
current_supply cosmos.base.v1beta1.Coin
time_elapsed google.protobuf.Duration

GenesisState

GenesisState defines the issuance module's genesis state.

Field Type Label Description
params Params params defines all the parameters of the module.
supplies AssetSupply repeated

Params

Params defines the parameters for the issuance module.

Field Type Label Description
assets Asset repeated

RateLimit

RateLimit parameters for rate-limiting the supply of an issued asset

Field Type Label Description
active bool
limit bytes
time_period google.protobuf.Duration

Top

zgc/issuance/v1beta1/query.proto

QueryParamsRequest

QueryParamsRequest defines the request type for querying x/issuance parameters.

QueryParamsResponse

QueryParamsResponse defines the response type for querying x/issuance parameters.

Field Type Label Description
params Params

Query

Query defines the gRPC querier service for issuance module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries all parameters of the issuance module. GET /0g/issuance/v1beta1/params

Top

zgc/issuance/v1beta1/tx.proto

MsgBlockAddress

MsgBlockAddress represents a message used by the issuer to block an address from holding or transferring tokens

Field Type Label Description
sender string
denom string
blocked_address string

MsgBlockAddressResponse

MsgBlockAddressResponse defines the Msg/BlockAddress response type.

MsgIssueTokens

MsgIssueTokens represents a message used by the issuer to issue new tokens

Field Type Label Description
sender string
tokens cosmos.base.v1beta1.Coin
receiver string

MsgIssueTokensResponse

MsgIssueTokensResponse defines the Msg/IssueTokens response type.

MsgRedeemTokens

MsgRedeemTokens represents a message used by the issuer to redeem (burn) tokens

Field Type Label Description
sender string
tokens cosmos.base.v1beta1.Coin

MsgRedeemTokensResponse

MsgRedeemTokensResponse defines the Msg/RedeemTokens response type.

MsgSetPauseStatus

MsgSetPauseStatus message type used by the issuer to pause or unpause status

Field Type Label Description
sender string
denom string
status bool

MsgSetPauseStatusResponse

MsgSetPauseStatusResponse defines the Msg/SetPauseStatus response type.

MsgUnblockAddress

MsgUnblockAddress message type used by the issuer to unblock an address from holding or transferring tokens

Field Type Label Description
sender string
denom string
blocked_address string

MsgUnblockAddressResponse

MsgUnblockAddressResponse defines the Msg/UnblockAddress response type.

Msg

Msg defines the issuance Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
IssueTokens MsgIssueTokens MsgIssueTokensResponse IssueTokens message type used by the issuer to issue new tokens
RedeemTokens MsgRedeemTokens MsgRedeemTokensResponse RedeemTokens message type used by the issuer to redeem (burn) tokens
BlockAddress MsgBlockAddress MsgBlockAddressResponse BlockAddress message type used by the issuer to block an address from holding or transferring tokens
UnblockAddress MsgUnblockAddress MsgUnblockAddressResponse UnblockAddress message type used by the issuer to unblock an address from holding or transferring tokens
SetPauseStatus MsgSetPauseStatus MsgSetPauseStatusResponse SetPauseStatus message type used to pause or unpause status

Top

zgc/pricefeed/v1beta1/store.proto

CurrentPrice

CurrentPrice defines a current price for a particular market in the pricefeed module.

Field Type Label Description
market_id string
price string

Market

Market defines an asset in the pricefeed.

Field Type Label Description
market_id string
base_asset string
quote_asset string
oracles bytes repeated
active bool

Params

Params defines the parameters for the pricefeed module.

Field Type Label Description
markets Market repeated

PostedPrice

PostedPrice defines a price for market posted by a specific oracle.

Field Type Label Description
market_id string
oracle_address bytes
price string
expiry google.protobuf.Timestamp

Top

zgc/pricefeed/v1beta1/genesis.proto

GenesisState

GenesisState defines the pricefeed module's genesis state.

Field Type Label Description
params Params params defines all the parameters of the module.
posted_prices PostedPrice repeated

Top

zgc/pricefeed/v1beta1/query.proto

CurrentPriceResponse

CurrentPriceResponse defines a current price for a particular market in the pricefeed module.

Field Type Label Description
market_id string
price string

MarketResponse

MarketResponse defines an asset in the pricefeed.

Field Type Label Description
market_id string
base_asset string
quote_asset string
oracles string repeated
active bool

PostedPriceResponse

PostedPriceResponse defines a price for market posted by a specific oracle.

Field Type Label Description
market_id string
oracle_address string
price string
expiry google.protobuf.Timestamp

QueryMarketsRequest

QueryMarketsRequest is the request type for the Query/Markets RPC method.

QueryMarketsResponse

QueryMarketsResponse is the response type for the Query/Markets RPC method.

Field Type Label Description
markets MarketResponse repeated List of markets

QueryOraclesRequest

QueryOraclesRequest is the request type for the Query/Oracles RPC method.

Field Type Label Description
market_id string

QueryOraclesResponse

QueryOraclesResponse is the response type for the Query/Oracles RPC method.

Field Type Label Description
oracles string repeated List of oracle addresses

QueryParamsRequest

QueryParamsRequest defines the request type for querying x/pricefeed parameters.

QueryParamsResponse

QueryParamsResponse defines the response type for querying x/pricefeed parameters.

Field Type Label Description
params Params

QueryPriceRequest

QueryPriceRequest is the request type for the Query/PriceRequest RPC method.

Field Type Label Description
market_id string

QueryPriceResponse

QueryPriceResponse is the response type for the Query/Prices RPC method.

Field Type Label Description
price CurrentPriceResponse

QueryPricesRequest

QueryPricesRequest is the request type for the Query/Prices RPC method.

QueryPricesResponse

QueryPricesResponse is the response type for the Query/Prices RPC method.

Field Type Label Description
prices CurrentPriceResponse repeated

QueryRawPricesRequest

QueryRawPricesRequest is the request type for the Query/RawPrices RPC method.

Field Type Label Description
market_id string

QueryRawPricesResponse

QueryRawPricesResponse is the response type for the Query/RawPrices RPC method.

Field Type Label Description
raw_prices PostedPriceResponse repeated

Query

Query defines the gRPC querier service for pricefeed module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries all parameters of the pricefeed module. GET /0g/pricefeed/v1beta1/params
Price QueryPriceRequest QueryPriceResponse Price queries price details based on a market GET /0g/pricefeed/v1beta1/prices/{market_id}
Prices QueryPricesRequest QueryPricesResponse Prices queries all prices GET /0g/pricefeed/v1beta1/prices
RawPrices QueryRawPricesRequest QueryRawPricesResponse RawPrices queries all raw prices based on a market GET /0g/pricefeed/v1beta1/rawprices/{market_id}
Oracles QueryOraclesRequest QueryOraclesResponse Oracles queries all oracles based on a market GET /0g/pricefeed/v1beta1/oracles/{market_id}
Markets QueryMarketsRequest QueryMarketsResponse Markets queries all markets GET /0g/pricefeed/v1beta1/markets

Top

zgc/pricefeed/v1beta1/tx.proto

MsgPostPrice

MsgPostPrice represents a method for creating a new post price

Field Type Label Description
from string address of client
market_id string
price string
expiry google.protobuf.Timestamp

MsgPostPriceResponse

MsgPostPriceResponse defines the Msg/PostPrice response type.

Msg

Msg defines the pricefeed Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
PostPrice MsgPostPrice MsgPostPriceResponse PostPrice defines a method for creating a new post price

Top

kava/router/v1beta1/tx.proto

MsgDelegateMintDeposit

MsgDelegateMintDeposit delegates tokens to a validator, then converts them into staking derivatives, then deposits to an earn vault.

Field Type Label Description
depositor string depositor represents the owner of the tokens to delegate
validator string validator is the address of the validator to delegate to
amount cosmos.base.v1beta1.Coin amount is the tokens to delegate

MsgDelegateMintDepositResponse

MsgDelegateMintDepositResponse defines the Msg/MsgDelegateMintDeposit response type.

MsgMintDeposit

MsgMintDeposit converts a delegation into staking derivatives and deposits it all into an earn vault.

Field Type Label Description
depositor string depositor represents the owner of the delegation to convert
validator string validator is the validator for the depositor's delegation
amount cosmos.base.v1beta1.Coin amount is the delegation balance to convert

MsgMintDepositResponse

MsgMintDepositResponse defines the Msg/MsgMintDeposit response type.

MsgWithdrawBurn

MsgWithdrawBurn removes staking derivatives from an earn vault and converts them back to a staking delegation.

Field Type Label Description
from string from is the owner of the earn vault to withdraw from
validator string validator is the address to select the derivative denom to withdraw
amount cosmos.base.v1beta1.Coin amount is the staked token equivalent to withdraw

MsgWithdrawBurnResponse

MsgWithdrawBurnResponse defines the Msg/MsgWithdrawBurn response type.

MsgWithdrawBurnUndelegate

MsgWithdrawBurnUndelegate removes staking derivatives from an earn vault, converts them to a staking delegation, then undelegates them from their validator.

Field Type Label Description
from string from is the owner of the earn vault to withdraw from
validator string validator is the address to select the derivative denom to withdraw
amount cosmos.base.v1beta1.Coin amount is the staked token equivalent to withdraw

MsgWithdrawBurnUndelegateResponse

MsgWithdrawBurnUndelegateResponse defines the Msg/MsgWithdrawBurnUndelegate response type.

Msg

Msg defines the router Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
MintDeposit MsgMintDeposit MsgMintDepositResponse MintDeposit converts a delegation into staking derivatives and deposits it all into an earn vault.
DelegateMintDeposit MsgDelegateMintDeposit MsgDelegateMintDepositResponse DelegateMintDeposit delegates tokens to a validator, then converts them into staking derivatives, then deposits to an earn vault.
WithdrawBurn MsgWithdrawBurn MsgWithdrawBurnResponse WithdrawBurn removes staking derivatives from an earn vault and converts them back to a staking delegation.
WithdrawBurnUndelegate MsgWithdrawBurnUndelegate MsgWithdrawBurnUndelegateResponse WithdrawBurnUndelegate removes staking derivatives from an earn vault, converts them to a staking delegation, then undelegates them from their validator.

Top

kava/savings/v1beta1/store.proto

Deposit

Deposit defines an amount of coins deposited into a savings module account.

Field Type Label Description
depositor string
amount cosmos.base.v1beta1.Coin repeated

Params

Params defines the parameters for the savings module.

Field Type Label Description
supported_denoms string repeated

Top

kava/savings/v1beta1/genesis.proto

GenesisState

GenesisState defines the savings module's genesis state.

Field Type Label Description
params Params params defines all the parameters of the module.
deposits Deposit repeated

Top

kava/savings/v1beta1/query.proto

QueryDepositsRequest

QueryDepositsRequest defines the request type for querying x/savings deposits.

Field Type Label Description
denom string
owner string
pagination cosmos.base.query.v1beta1.PageRequest

QueryDepositsResponse

QueryDepositsResponse defines the response type for querying x/savings deposits.

Field Type Label Description
deposits Deposit repeated
pagination cosmos.base.query.v1beta1.PageResponse

QueryParamsRequest

QueryParamsRequest defines the request type for querying x/savings parameters.

QueryParamsResponse

QueryParamsResponse defines the response type for querying x/savings parameters.

Field Type Label Description
params Params

QueryTotalSupplyRequest

QueryTotalSupplyRequest defines the request type for Query/TotalSupply method.

QueryTotalSupplyResponse

TotalSupplyResponse defines the response type for the Query/TotalSupply method.

Field Type Label Description
height int64 Height is the block height at which these totals apply
result cosmos.base.v1beta1.Coin repeated Result is a list of coins supplied to savings

Query

Query defines the gRPC querier service for savings module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries all parameters of the savings module. GET /kava/savings/v1beta1/params
Deposits QueryDepositsRequest QueryDepositsResponse Deposits queries savings deposits. GET /kava/savings/v1beta1/deposits
TotalSupply QueryTotalSupplyRequest QueryTotalSupplyResponse TotalSupply returns the total sum of all coins currently locked into the savings module. GET /kava/savings/v1beta1/total_supply

Top

kava/savings/v1beta1/tx.proto

MsgDeposit

MsgDeposit defines the Msg/Deposit request type.

Field Type Label Description
depositor string
amount cosmos.base.v1beta1.Coin repeated

MsgDepositResponse

MsgDepositResponse defines the Msg/Deposit response type.

MsgWithdraw

MsgWithdraw defines the Msg/Withdraw request type.

Field Type Label Description
depositor string
amount cosmos.base.v1beta1.Coin repeated

MsgWithdrawResponse

MsgWithdrawResponse defines the Msg/Withdraw response type.

Msg

Msg defines the savings Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Deposit MsgDeposit MsgDepositResponse Deposit defines a method for depositing funds to the savings module account
Withdraw MsgWithdraw MsgWithdrawResponse Withdraw defines a method for withdrawing funds to the savings module account

Top

kava/swap/v1beta1/swap.proto

AllowedPool

AllowedPool defines a pool that is allowed to be created

Field Type Label Description
token_a string token_a represents the a token allowed
token_b string token_b represents the b token allowed

Params

Params defines the parameters for the swap module.

Field Type Label Description
allowed_pools AllowedPool repeated allowed_pools defines that pools that are allowed to be created
swap_fee string swap_fee defines the swap fee for all pools

PoolRecord

PoolRecord represents the state of a liquidity pool and is used to store the state of a denominated pool

Field Type Label Description
pool_id string pool_id represents the unique id of the pool
reserves_a cosmos.base.v1beta1.Coin reserves_a is the a token coin reserves
reserves_b cosmos.base.v1beta1.Coin reserves_b is the a token coin reserves
total_shares string total_shares is the total distrubuted shares of the pool

ShareRecord

ShareRecord stores the shares owned for a depositor and pool

Field Type Label Description
depositor bytes depositor represents the owner of the shares
pool_id string pool_id represents the pool the shares belong to
shares_owned string shares_owned represents the number of shares owned by depsoitor for the pool_id

Top

kava/swap/v1beta1/genesis.proto

GenesisState

GenesisState defines the swap module's genesis state.

Field Type Label Description
params Params params defines all the parameters related to swap
pool_records PoolRecord repeated pool_records defines the available pools
share_records ShareRecord repeated share_records defines the owned shares of each pool

Top

kava/swap/v1beta1/query.proto

DepositResponse

DepositResponse defines a single deposit query response type.

Field Type Label Description
depositor string depositor represents the owner of the deposit
pool_id string pool_id represents the pool the deposit is for
shares_owned string shares_owned presents the shares owned by the depositor for the pool
shares_value cosmos.base.v1beta1.Coin repeated shares_value represents the coin value of the shares_owned

PoolResponse

Pool represents the state of a single pool

Field Type Label Description
name string name represents the name of the pool
coins cosmos.base.v1beta1.Coin repeated coins represents the total reserves of the pool
total_shares string total_shares represents the total shares of the pool

QueryDepositsRequest

QueryDepositsRequest is the request type for the Query/Deposits RPC method.

Field Type Label Description
owner string owner optionally filters deposits by owner
pool_id string pool_id optionally fitlers deposits by pool id
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryDepositsResponse

QueryDepositsResponse is the response type for the Query/Deposits RPC method.

Field Type Label Description
deposits DepositResponse repeated deposits returns the deposits matching the requested parameters
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryParamsRequest

QueryParamsRequest defines the request type for querying x/swap parameters.

QueryParamsResponse

QueryParamsResponse defines the response type for querying x/swap parameters.

Field Type Label Description
params Params params represents the swap module parameters

QueryPoolsRequest

QueryPoolsRequest is the request type for the Query/Pools RPC method.

Field Type Label Description
pool_id string pool_id filters pools by id
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryPoolsResponse

QueryPoolsResponse is the response type for the Query/Pools RPC method.

Field Type Label Description
pools PoolResponse repeated pools represents returned pools
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

Query

Query defines the gRPC querier service for swap module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries all parameters of the swap module. GET /kava/swap/v1beta1/params
Pools QueryPoolsRequest QueryPoolsResponse Pools queries pools based on pool ID GET /kava/swap/v1beta1/pools
Deposits QueryDepositsRequest QueryDepositsResponse Deposits queries deposit details based on owner address and pool GET /kava/swap/v1beta1/deposits

Top

kava/swap/v1beta1/tx.proto

MsgDeposit

MsgDeposit represents a message for depositing liquidity into a pool

Field Type Label Description
depositor string depositor represents the address to deposit funds from
token_a cosmos.base.v1beta1.Coin token_a represents one token of deposit pair
token_b cosmos.base.v1beta1.Coin token_b represents one token of deposit pair
slippage string slippage represents the max decimal percentage price change
deadline int64 deadline represents the unix timestamp to complete the deposit by

MsgDepositResponse

MsgDepositResponse defines the Msg/Deposit response type.

MsgSwapExactForTokens

MsgSwapExactForTokens represents a message for trading exact coinA for coinB

Field Type Label Description
requester string represents the address swaping the tokens
exact_token_a cosmos.base.v1beta1.Coin exact_token_a represents the exact amount to swap for token_b
token_b cosmos.base.v1beta1.Coin token_b represents the desired token_b to swap for
slippage string slippage represents the maximum change in token_b allowed
deadline int64 deadline represents the unix timestamp to complete the swap by

MsgSwapExactForTokensResponse

MsgSwapExactForTokensResponse defines the Msg/SwapExactForTokens response type.

MsgSwapForExactTokens

MsgSwapForExactTokens represents a message for trading coinA for an exact coinB

Field Type Label Description
requester string represents the address swaping the tokens
token_a cosmos.base.v1beta1.Coin token_a represents the desired token_a to swap for
exact_token_b cosmos.base.v1beta1.Coin exact_token_b represents the exact token b amount to swap for token a
slippage string slippage represents the maximum change in token_a allowed
deadline int64 deadline represents the unix timestamp to complete the swap by

MsgSwapForExactTokensResponse

MsgSwapForExactTokensResponse defines the Msg/SwapForExactTokensResponse response type.

MsgWithdraw

MsgWithdraw represents a message for withdrawing liquidity from a pool

Field Type Label Description
from string from represents the address we are withdrawing for
shares string shares represents the amount of shares to withdraw
min_token_a cosmos.base.v1beta1.Coin min_token_a represents the minimum a token to withdraw
min_token_b cosmos.base.v1beta1.Coin min_token_a represents the minimum a token to withdraw
deadline int64 deadline represents the unix timestamp to complete the withdraw by

MsgWithdrawResponse

MsgWithdrawResponse defines the Msg/Withdraw response type.

Msg

Msg defines the swap Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Deposit MsgDeposit MsgDepositResponse Deposit defines a method for depositing liquidity into a pool
Withdraw MsgWithdraw MsgWithdrawResponse Withdraw defines a method for withdrawing liquidity into a pool
SwapExactForTokens MsgSwapExactForTokens MsgSwapExactForTokensResponse SwapExactForTokens represents a message for trading exact coinA for coinB
SwapForExactTokens MsgSwapForExactTokens MsgSwapForExactTokensResponse SwapForExactTokens represents a message for trading coinA for an exact coinB

Top

kava/validatorvesting/v1beta1/query.proto

QueryCirculatingSupplyHARDRequest

QueryCirculatingSupplyHARDRequest is the request type for the Query/CirculatingSupplyHARD RPC method

QueryCirculatingSupplyHARDResponse

QueryCirculatingSupplyHARDResponse is the response type for the Query/CirculatingSupplyHARD RPC method

Field Type Label Description
amount string

QueryCirculatingSupplyRequest

QueryCirculatingSupplyRequest is the request type for the Query/CirculatingSupply RPC method

QueryCirculatingSupplyResponse

QueryCirculatingSupplyResponse is the response type for the Query/CirculatingSupply RPC method

Field Type Label Description
amount string

QueryCirculatingSupplySWPRequest

QueryCirculatingSupplySWPRequest is the request type for the Query/CirculatingSupplySWP RPC method

QueryCirculatingSupplySWPResponse

QueryCirculatingSupplySWPResponse is the response type for the Query/CirculatingSupplySWP RPC method

Field Type Label Description
amount string

QueryCirculatingSupplyUSDXRequest

QueryCirculatingSupplyUSDXRequest is the request type for the Query/CirculatingSupplyUSDX RPC method

QueryCirculatingSupplyUSDXResponse

QueryCirculatingSupplyUSDXResponse is the response type for the Query/CirculatingSupplyUSDX RPC method

Field Type Label Description
amount string

QueryTotalSupplyHARDRequest

QueryTotalSupplyHARDRequest is the request type for the Query/TotalSupplyHARD RPC method

QueryTotalSupplyHARDResponse

QueryTotalSupplyHARDResponse is the response type for the Query/TotalSupplyHARD RPC method

Field Type Label Description
amount string

QueryTotalSupplyRequest

QueryTotalSupplyRequest is the request type for the Query/TotalSupply RPC method

QueryTotalSupplyResponse

QueryTotalSupplyResponse is the response type for the Query/TotalSupply RPC method

Field Type Label Description
amount string

QueryTotalSupplyUSDXRequest

QueryTotalSupplyUSDXRequest is the request type for the Query/TotalSupplyUSDX RPC method

QueryTotalSupplyUSDXResponse

QueryTotalSupplyUSDXResponse is the response type for the Query/TotalSupplyUSDX RPC method

Field Type Label Description
amount string

Query

Query defines the gRPC querier service for validator-vesting module

Method Name Request Type Response Type Description HTTP Verb Endpoint
CirculatingSupply QueryCirculatingSupplyRequest QueryCirculatingSupplyResponse CirculatingSupply returns the total amount of kava tokens in circulation GET /kava/validator-vesting/v1beta1/circulating_supply
TotalSupply QueryTotalSupplyRequest QueryTotalSupplyResponse TotalSupply returns the total amount of kava tokens GET /kava/validator-vesting/v1beta1/total_supply
CirculatingSupplyHARD QueryCirculatingSupplyHARDRequest QueryCirculatingSupplyHARDResponse CirculatingSupplyHARD returns the total amount of hard tokens in circulation GET /kava/validator-vesting/v1beta1/circulating_supply_hard
CirculatingSupplyUSDX QueryCirculatingSupplyUSDXRequest QueryCirculatingSupplyUSDXResponse CirculatingSupplyUSDX returns the total amount of usdx tokens in circulation GET /kava/validator-vesting/v1beta1/circulating_supply_usdx
CirculatingSupplySWP QueryCirculatingSupplySWPRequest QueryCirculatingSupplySWPResponse CirculatingSupplySWP returns the total amount of swp tokens in circulation GET /kava/validator-vesting/v1beta1/circulating_supply_swp
TotalSupplyHARD QueryTotalSupplyHARDRequest QueryTotalSupplyHARDResponse TotalSupplyHARD returns the total amount of hard tokens GET /kava/validator-vesting/v1beta1/total_supply_hard
TotalSupplyUSDX QueryTotalSupplyUSDXRequest QueryTotalSupplyUSDXResponse TotalSupplyUSDX returns the total amount of usdx tokens GET /kava/validator-vesting/v1beta1/total_supply_usdx

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)