Protocol Documentation

Table of Contents

Top

cosmos/crypto/multisig/v1beta1/multisig.proto

CompactBitArray

CompactBitArray is an implementation of a space efficient bit array. This is used to ensure that the encoded data takes up a minimal amount of space after proto encoding. This is not thread safe, and is not intended for concurrent usage.

FieldTypeLabelDescription
extra_bits_storeduint32
elemsbytes

MultiSignature

MultiSignature wraps the signatures from a multisig.LegacyAminoPubKey. See cosmos.tx.v1betata1.ModeInfo.Multi for how to specify which signers signed and with which modes.

FieldTypeLabelDescription
signaturesbytesrepeated

Top

cosmos/crypto/multisig/keys.proto

LegacyAminoPubKey

LegacyAminoPubKey specifies a public key type which nests multiple public keys and a threshold, it uses legacy amino address rules.

FieldTypeLabelDescription
thresholduint32
public_keysgoogle.protobuf.Anyrepeated

Top

cosmos/crypto/secp256k1/keys.proto

PrivKey

PrivKey defines a secp256k1 private key.

FieldTypeLabelDescription
keybytes

PubKey

PubKey defines a secp256k1 public key Key is the compressed form of the pubkey. The first byte depends is a 0x02 byte if the y-coordinate is the lexicographically largest of the two associated with the x-coordinate. Otherwise the first byte is a 0x03. This prefix is followed with the x-coordinate.

FieldTypeLabelDescription
keybytes

Top

cosmos/crypto/ed25519/keys.proto

PrivKey

PrivKey defines a ed25519 private key.

FieldTypeLabelDescription
keybytes

PubKey

PubKey defines a ed25519 public key Key is the compressed form of the pubkey. The first byte depends is a 0x02 byte if the y-coordinate is the lexicographically largest of the two associated with the x-coordinate. Otherwise the first byte is a 0x03. This prefix is followed with the x-coordinate.

FieldTypeLabelDescription
keybytes

Top

cosmos/upgrade/v1beta1/upgrade.proto

CancelSoftwareUpgradeProposal

CancelSoftwareUpgradeProposal is a gov Content type for cancelling a software upgrade.

FieldTypeLabelDescription
titlestring
descriptionstring

Plan

Plan specifies information about a planned upgrade and when it should occur.

FieldTypeLabelDescription
namestringSets the name for the upgrade. This name will be used by the upgraded version of the software to apply any special "on-upgrade" commands during the first BeginBlock method after the upgrade is applied. It is also used to detect whether a software version can handle a given upgrade. If no upgrade handler with this name has been set in the software, it will be assumed that the software is out-of-date when the upgrade Time or Height is reached and the software will exit.
timegoogle.protobuf.TimestampThe time after which the upgrade must be performed. Leave set to its zero value to use a pre-defined Height instead.
heightint64The height at which the upgrade must be performed. Only used if Time is not set.
infostringAny application specific upgrade info to be included on-chain such as a git commit that validators could automatically upgrade to
upgraded_client_stategoogle.protobuf.AnyIBC-enabled chains can opt-in to including the upgraded client state in its upgrade plan This will make the chain commit to the correct upgraded (self) client state before the upgrade occurs, so that connecting chains can verify that the new upgraded client is valid by verifying a proof on the previous version of the chain. This will allow IBC connections to persist smoothly across planned chain upgrades

SoftwareUpgradeProposal

SoftwareUpgradeProposal is a gov Content type for initiating a software upgrade.

FieldTypeLabelDescription
titlestring
descriptionstring
planPlan

Top

cosmos/upgrade/v1beta1/query.proto

QueryAppliedPlanRequest

QueryCurrentPlanRequest is the request type for the Query/AppliedPlan RPC method.

FieldTypeLabelDescription
namestringname is the name of the applied plan to query for.

QueryAppliedPlanResponse

QueryAppliedPlanResponse is the response type for the Query/AppliedPlan RPC method.

FieldTypeLabelDescription
heightint64height is the block height at which the plan was applied.

QueryCurrentPlanRequest

QueryCurrentPlanRequest is the request type for the Query/CurrentPlan RPC method.

QueryCurrentPlanResponse

QueryCurrentPlanResponse is the response type for the Query/CurrentPlan RPC method.

FieldTypeLabelDescription
planPlanplan is the current upgrade plan.

Query

Query defines the gRPC upgrade querier service.

Method NameRequest TypeResponse TypeDescription
CurrentPlanQueryCurrentPlanRequestQueryCurrentPlanResponseCurrentPlan queries the current upgrade plan.
AppliedPlanQueryAppliedPlanRequestQueryAppliedPlanResponseAppliedPlan queries a previously applied upgrade plan by its name.

Top

cosmos/mint/v1beta1/query.proto

QueryAnnualProvisionsRequest

QueryAnnualProvisionsRequest is the request type for the Query/AnnualProvisions RPC method.

QueryAnnualProvisionsResponse

QueryAnnualProvisionsResponse is the response type for the Query/AnnualProvisions RPC method.

FieldTypeLabelDescription
annual_provisionsbytesannual_provisions is the current minting annual provisions value.

QueryInflationRequest

QueryInflationRequest is the request type for the Query/Inflation RPC method.

QueryInflationResponse

QueryInflationResponse is the response type for the Query/Inflation RPC method.

FieldTypeLabelDescription
inflationbytesinflation is the current minting inflation value.

QueryParamsRequest

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

QueryParamsResponse

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

FieldTypeLabelDescription
paramsParamsparams defines the parameters of the module.

Query

Query provides defines the gRPC querier service.

Method NameRequest TypeResponse TypeDescription
ParamsQueryParamsRequestQueryParamsResponseParams returns the total set of minting parameters.
InflationQueryInflationRequestQueryInflationResponseInflation returns the current minting inflation value.
AnnualProvisionsQueryAnnualProvisionsRequestQueryAnnualProvisionsResponseAnnualProvisions current minting annual provisions value.

Top

cosmos/mint/v1beta1/genesis.proto

GenesisState

GenesisState defines the mint module's genesis state.

FieldTypeLabelDescription
minterMinterminter is a space for holding current inflation information.
paramsParamsparams defines all the paramaters of the module.

Top

cosmos/mint/v1beta1/mint.proto

Minter

Minter represents the minting state.

FieldTypeLabelDescription
inflationstringcurrent annual inflation rate
annual_provisionsstringcurrent annual expected provisions

Params

Params holds parameters for the mint module.

FieldTypeLabelDescription
mint_denomstringtype of coin to mint
inflation_rate_changestringmaximum annual change in inflation rate
inflation_maxstringmaximum inflation rate
inflation_minstringminimum inflation rate
goal_bondedstringgoal of percent bonded atoms
blocks_per_yearuint64expected blocks per year

Top

cosmos/evidence/v1beta1/tx.proto

MsgSubmitEvidence

MsgSubmitEvidence represents a message that supports submitting arbitrary Evidence of misbehavior such as equivocation or counterfactual signing.

FieldTypeLabelDescription
submitterstring
evidencegoogle.protobuf.Any

MsgSubmitEvidenceResponse

MsgSubmitEvidenceResponse defines the Msg/SubmitEvidence response type.

FieldTypeLabelDescription
hashbyteshash defines the hash of the evidence.

Msg

Msg defines the evidence Msg service.

Method NameRequest TypeResponse TypeDescription
SubmitEvidenceMsgSubmitEvidenceMsgSubmitEvidenceResponseSubmitEvidence submits an arbitrary Evidence of misbehavior such as equivocation or counterfactual signing.

Top

cosmos/evidence/v1beta1/evidence.proto

Equivocation

Equivocation implements the Evidence interface and defines evidence of double signing misbehavior.

FieldTypeLabelDescription
heightint64
timegoogle.protobuf.Timestamp
powerint64
consensus_addressstring

Top

cosmos/evidence/v1beta1/query.proto

QueryAllEvidenceRequest

QueryEvidenceRequest is the request type for the Query/AllEvidence RPC method.

FieldTypeLabelDescription
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryAllEvidenceResponse

QueryAllEvidenceResponse is the response type for the Query/AllEvidence RPC method.

FieldTypeLabelDescription
evidencegoogle.protobuf.Anyrepeatedevidence returns all evidences.
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

QueryEvidenceRequest

QueryEvidenceRequest is the request type for the Query/Evidence RPC method.

FieldTypeLabelDescription
evidence_hashbytesevidence_hash defines the hash of the requested evidence.

QueryEvidenceResponse

QueryEvidenceResponse is the response type for the Query/Evidence RPC method.

FieldTypeLabelDescription
evidencegoogle.protobuf.Anyevidence returns the requested evidence.

Query

Query defines the gRPC querier service.

Method NameRequest TypeResponse TypeDescription
EvidenceQueryEvidenceRequestQueryEvidenceResponseEvidence queries evidence based on evidence hash.
AllEvidenceQueryAllEvidenceRequestQueryAllEvidenceResponseAllEvidence queries all evidence.

Top

cosmos/evidence/v1beta1/genesis.proto

GenesisState

GenesisState defines the evidence module's genesis state.

FieldTypeLabelDescription
evidencegoogle.protobuf.Anyrepeatedevidence defines all the evidence at genesis.

Top

cosmos/auth/v1beta1/query.proto

QueryAccountRequest

QueryAccountRequest is the request type for the Query/Account RPC method.

FieldTypeLabelDescription
addressstringaddress defines the address to query for.

QueryAccountResponse

QueryAccountResponse is the response type for the Query/Account RPC method.

FieldTypeLabelDescription
accountgoogle.protobuf.Anyaccount defines the account of the corresponding address.

QueryParamsRequest

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

QueryParamsResponse

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

FieldTypeLabelDescription
paramsParamsparams defines the parameters of the module.

Query

Query defines the gRPC querier service.

Method NameRequest TypeResponse TypeDescription
AccountQueryAccountRequestQueryAccountResponseAccount returns account details based on address.
ParamsQueryParamsRequestQueryParamsResponseParams queries all parameters.

Top

cosmos/auth/v1beta1/genesis.proto

GenesisState

GenesisState defines the auth module's genesis state.

FieldTypeLabelDescription
paramsParamsparams defines all the paramaters of the module.
accountsgoogle.protobuf.Anyrepeatedaccounts are the accounts present at genesis.

Top

cosmos/auth/v1beta1/auth.proto

BaseAccount

BaseAccount defines a base account type. It contains all the necessary fields for basic account functionality. Any custom account type should extend this type for additional functionality (e.g. vesting).

FieldTypeLabelDescription
addressstring
pub_keygoogle.protobuf.Any
account_numberuint64
sequenceuint64

ModuleAccount

ModuleAccount defines an account for modules that holds coins on a pool.

FieldTypeLabelDescription
base_accountBaseAccount
namestring
permissionsstringrepeated

Params

Params defines the parameters for the auth module.

FieldTypeLabelDescription
max_memo_charactersuint64
tx_sig_limituint64
tx_size_cost_per_byteuint64
sig_verify_cost_ed25519uint64
sig_verify_cost_secp256k1uint64

Top

cosmos/bank/v1beta1/tx.proto

MsgMultiSend

MsgMultiSend represents an arbitrary multi-in, multi-out send message.

FieldTypeLabelDescription
inputsInputrepeated
outputsOutputrepeated

MsgMultiSendResponse

MsgMultiSendResponse defines the Msg/MultiSend response type.

MsgSend

MsgSend represents a message to send coins from one account to another.

FieldTypeLabelDescription
from_addressstring
to_addressstring
amountcosmos.base.v1beta1.Coinrepeated

MsgSendResponse

MsgSendResponse defines the Msg/Send response type.

Msg

Msg defines the bank Msg service.

Method NameRequest TypeResponse TypeDescription
SendMsgSendMsgSendResponseSend defines a method for sending coins from one account to another account.
MultiSendMsgMultiSendMsgMultiSendResponseMultiSend defines a method for sending coins from some accounts to other accounts.

Top

cosmos/bank/v1beta1/bank.proto

DenomUnit

DenomUnit represents a struct that describes a given denomination unit of the basic token.

FieldTypeLabelDescription
denomstringdenom represents the string name of the given denom unit (e.g uatom).
exponentuint32exponent represents power of 10 exponent that one must raise the base_denom to in order to equal the given DenomUnit's denom 1 denom = 1^exponent base_denom (e.g. with a base_denom of uatom, one can create a DenomUnit of 'atom' with exponent = 6, thus: 1 atom = 10^6 uatom).
aliasesstringrepeatedaliases is a list of string aliases for the given denom

Input

Input models transaction input.

FieldTypeLabelDescription
addressstring
coinscosmos.base.v1beta1.Coinrepeated

Metadata

Metadata represents a struct that describes a basic token.

FieldTypeLabelDescription
descriptionstring
denom_unitsDenomUnitrepeateddenom_units represents the list of DenomUnit's for a given coin
basestringbase represents the base denom (should be the DenomUnit with exponent = 0).
displaystringdisplay indicates the suggested denom that should be displayed in clients.

Output

Output models transaction outputs.

FieldTypeLabelDescription
addressstring
coinscosmos.base.v1beta1.Coinrepeated

Params

Params defines the parameters for the bank module.

FieldTypeLabelDescription
send_enabledSendEnabledrepeated
default_send_enabledbool

SendEnabled

SendEnabled maps coin denom to a send_enabled status (whether a denom is sendable).

FieldTypeLabelDescription
denomstring
enabledbool

Supply

Supply represents a struct that passively keeps track of the total supply amounts in the network.

FieldTypeLabelDescription
totalcosmos.base.v1beta1.Coinrepeated

Top

cosmos/bank/v1beta1/query.proto

QueryAllBalancesRequest

QueryBalanceRequest is the request type for the Query/AllBalances RPC method.

FieldTypeLabelDescription
addressstringaddress is the address to query balances for.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryAllBalancesResponse

QueryAllBalancesResponse is the response type for the Query/AllBalances RPC method.

FieldTypeLabelDescription
balancescosmos.base.v1beta1.Coinrepeatedbalances is the balances of all the coins.
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

QueryBalanceRequest

QueryBalanceRequest is the request type for the Query/Balance RPC method.

FieldTypeLabelDescription
addressstringaddress is the address to query balances for.
denomstringdenom is the coin denom to query balances for.

QueryBalanceResponse

QueryBalanceResponse is the response type for the Query/Balance RPC method.

FieldTypeLabelDescription
balancecosmos.base.v1beta1.Coinbalance is the balance of the coin.

QueryParamsRequest

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

QueryParamsResponse

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

FieldTypeLabelDescription
paramsParams

QuerySupplyOfRequest

QuerySupplyOfRequest is the request type for the Query/SupplyOf RPC method.

FieldTypeLabelDescription
denomstringdenom is the coin denom to query balances for.

QuerySupplyOfResponse

QuerySupplyOfResponse is the response type for the Query/SupplyOf RPC method.

FieldTypeLabelDescription
amountcosmos.base.v1beta1.Coinamount is the supply of the coin.

QueryTotalSupplyRequest

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

QueryTotalSupplyResponse

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

FieldTypeLabelDescription
supplycosmos.base.v1beta1.Coinrepeatedsupply is the supply of the coins

Query

Query defines the gRPC querier service.

Method NameRequest TypeResponse TypeDescription
BalanceQueryBalanceRequestQueryBalanceResponseBalance queries the balance of a single coin for a single account.
AllBalancesQueryAllBalancesRequestQueryAllBalancesResponseAllBalances queries the balance of all coins for a single account.
TotalSupplyQueryTotalSupplyRequestQueryTotalSupplyResponseTotalSupply queries the total supply of all coins.
SupplyOfQuerySupplyOfRequestQuerySupplyOfResponseSupplyOf queries the supply of a single coin.
ParamsQueryParamsRequestQueryParamsResponseParams queries the parameters of x/bank module.

Top

cosmos/bank/v1beta1/genesis.proto

Balance

Balance defines an account address and balance pair used in the bank module's genesis state.

FieldTypeLabelDescription
addressstringaddress is the address of the balance holder.
coinscosmos.base.v1beta1.Coinrepeatedcoins defines the different coins this balance holds.

GenesisState

GenesisState defines the bank module's genesis state.

FieldTypeLabelDescription
paramsParamsparams defines all the paramaters of the module.
balancesBalancerepeatedbalances is an array containing the balances of all the accounts.
supplycosmos.base.v1beta1.Coinrepeatedsupply represents the total supply.
denom_metadataMetadatarepeateddenom_metadata defines the metadata of the differents coins.

Top

cosmos/capability/v1beta1/capability.proto

Capability

Capability defines an implementation of an object capability. The index provided to a Capability must be globally unique.

FieldTypeLabelDescription
indexuint64

CapabilityOwners

CapabilityOwners defines a set of owners of a single Capability. The set of owners must be unique.

FieldTypeLabelDescription
ownersOwnerrepeated

Owner

Owner defines a single capability owner. An owner is defined by the name of capability and the module name.

FieldTypeLabelDescription
modulestring
namestring

Top

cosmos/capability/v1beta1/genesis.proto

GenesisOwners

GenesisOwners defines the capability owners with their corresponding index.

FieldTypeLabelDescription
indexuint64index is the index of the capability owner.
index_ownersCapabilityOwnersindex_owners are the owners at the given index.

GenesisState

GenesisState defines the capability module's genesis state.

FieldTypeLabelDescription
indexuint64index is the capability global index.
ownersGenesisOwnersrepeatedowners represents a map from index to owners of the capability index index key is string to allow amino marshalling.

Top

cosmos/distribution/v1beta1/tx.proto

MsgFundCommunityPool

MsgFundCommunityPool allows an account to directly fund the community pool.

FieldTypeLabelDescription
amountcosmos.base.v1beta1.Coinrepeated
depositorstring

MsgFundCommunityPoolResponse

MsgFundCommunityPoolResponse defines the Msg/FundCommunityPool response type.

MsgSetWithdrawAddress

MsgSetWithdrawAddress sets the withdraw address for a delegator (or validator self-delegation).

FieldTypeLabelDescription
delegator_addressstring
withdraw_addressstring

MsgSetWithdrawAddressResponse

MsgSetWithdrawAddressResponse defines the Msg/SetWithdrawAddress response type.

MsgWithdrawDelegatorReward

MsgWithdrawDelegatorReward represents delegation withdrawal to a delegator from a single validator.

FieldTypeLabelDescription
delegator_addressstring
validator_addressstring

MsgWithdrawDelegatorRewardResponse

MsgWithdrawDelegatorRewardResponse defines the Msg/WithdrawDelegatorReward response type.

MsgWithdrawValidatorCommission

MsgWithdrawValidatorCommission withdraws the full commission to the validator address.

FieldTypeLabelDescription
validator_addressstring

MsgWithdrawValidatorCommissionResponse

MsgWithdrawValidatorCommissionResponse defines the Msg/WithdrawValidatorCommission response type.

Msg

Msg defines the distribution Msg service.

Method NameRequest TypeResponse TypeDescription
SetWithdrawAddressMsgSetWithdrawAddressMsgSetWithdrawAddressResponseSetWithdrawAddress defines a method to change the withdraw address for a delegator (or validator self-delegation).
WithdrawDelegatorRewardMsgWithdrawDelegatorRewardMsgWithdrawDelegatorRewardResponseWithdrawDelegatorReward defines a method to withdraw rewards of delegator from a single validator.
WithdrawValidatorCommissionMsgWithdrawValidatorCommissionMsgWithdrawValidatorCommissionResponseWithdrawValidatorCommission defines a method to withdraw the full commission to the validator address.
FundCommunityPoolMsgFundCommunityPoolMsgFundCommunityPoolResponseFundCommunityPool defines a method to allow an account to directly fund the community pool.

Top

cosmos/distribution/v1beta1/distribution.proto

CommunityPoolSpendProposal

CommunityPoolSpendProposal details a proposal for use of community funds, together with how many coins are proposed to be spent, and to which recipient account.

FieldTypeLabelDescription
titlestring
descriptionstring
recipientstring
amountcosmos.base.v1beta1.Coinrepeated

CommunityPoolSpendProposalWithDeposit

CommunityPoolSpendProposalWithDeposit defines a CommunityPoolSpendProposal with a deposit

FieldTypeLabelDescription
titlestring
descriptionstring
recipientstring
amountstring
depositstring

DelegationDelegatorReward

DelegationDelegatorReward represents the properties of a delegator's delegation reward.

FieldTypeLabelDescription
validator_addressstring
rewardcosmos.base.v1beta1.DecCoinrepeated

DelegatorStartingInfo

DelegatorStartingInfo represents the starting info for a delegator reward period. It tracks the previous validator period, the delegation's amount of staking token, and the creation height (to check later on if any slashes have occurred). NOTE: Even though validators are slashed to whole staking tokens, the delegators within the validator may be left with less than a full token, thus sdk.Dec is used.

FieldTypeLabelDescription
previous_perioduint64
stakestring
heightuint64

FeePool

FeePool is the global fee pool for distribution.

FieldTypeLabelDescription
community_poolcosmos.base.v1beta1.DecCoinrepeated

Params

Params defines the set of params for the distribution module.

FieldTypeLabelDescription
community_taxstring
base_proposer_rewardstring
bonus_proposer_rewardstring
withdraw_addr_enabledbool

ValidatorAccumulatedCommission

ValidatorAccumulatedCommission represents accumulated commission for a validator kept as a running counter, can be withdrawn at any time.

FieldTypeLabelDescription
commissioncosmos.base.v1beta1.DecCoinrepeated

ValidatorCurrentRewards

ValidatorCurrentRewards represents current rewards and current period for a validator kept as a running counter and incremented each block as long as the validator's tokens remain constant.

FieldTypeLabelDescription
rewardscosmos.base.v1beta1.DecCoinrepeated
perioduint64

ValidatorHistoricalRewards

ValidatorHistoricalRewards represents historical rewards for a validator. Height is implicit within the store key. Cumulative reward ratio is the sum from the zeroeth period until this period of rewards / tokens, per the spec. The reference count indicates the number of objects which might need to reference this historical entry at any point. ReferenceCount = number of outstanding delegations which ended the associated period (and might need to read that record) + number of slashes which ended the associated period (and might need to read that record) + one per validator for the zeroeth period, set on initialization

FieldTypeLabelDescription
cumulative_reward_ratiocosmos.base.v1beta1.DecCoinrepeated
reference_countuint32

ValidatorOutstandingRewards

ValidatorOutstandingRewards represents outstanding (un-withdrawn) rewards for a validator inexpensive to track, allows simple sanity checks.

FieldTypeLabelDescription
rewardscosmos.base.v1beta1.DecCoinrepeated

ValidatorSlashEvent

ValidatorSlashEvent represents a validator slash event. Height is implicit within the store key. This is needed to calculate appropriate amount of staking tokens for delegations which are withdrawn after a slash has occurred.

FieldTypeLabelDescription
validator_perioduint64
fractionstring

ValidatorSlashEvents

ValidatorSlashEvents is a collection of ValidatorSlashEvent messages.

FieldTypeLabelDescription
validator_slash_eventsValidatorSlashEventrepeated

Top

cosmos/distribution/v1beta1/query.proto

QueryCommunityPoolRequest

QueryCommunityPoolRequest is the request type for the Query/CommunityPool RPC method.

QueryCommunityPoolResponse

QueryCommunityPoolResponse is the response type for the Query/CommunityPool RPC method.

FieldTypeLabelDescription
poolcosmos.base.v1beta1.DecCoinrepeatedpool defines community pool's coins.

QueryDelegationRewardsRequest

QueryDelegationRewardsRequest is the request type for the Query/DelegationRewards RPC method.

FieldTypeLabelDescription
delegator_addressstringdelegator_address defines the delegator address to query for.
validator_addressstringvalidator_address defines the validator address to query for.

QueryDelegationRewardsResponse

QueryDelegationRewardsResponse is the response type for the Query/DelegationRewards RPC method.

FieldTypeLabelDescription
rewardscosmos.base.v1beta1.DecCoinrepeatedrewards defines the rewards accrued by a delegation.

QueryDelegationTotalRewardsRequest

QueryDelegationTotalRewardsRequest is the request type for the Query/DelegationTotalRewards RPC method.

FieldTypeLabelDescription
delegator_addressstringdelegator_address defines the delegator address to query for.

QueryDelegationTotalRewardsResponse

QueryDelegationTotalRewardsResponse is the response type for the Query/DelegationTotalRewards RPC method.

FieldTypeLabelDescription
rewardsDelegationDelegatorRewardrepeatedrewards defines all the rewards accrued by a delegator.
totalcosmos.base.v1beta1.DecCoinrepeatedtotal defines the sum of all the rewards.

QueryDelegatorValidatorsRequest

QueryDelegatorValidatorsRequest is the request type for the Query/DelegatorValidators RPC method.

FieldTypeLabelDescription
delegator_addressstringdelegator_address defines the delegator address to query for.

QueryDelegatorValidatorsResponse

QueryDelegatorValidatorsResponse is the response type for the Query/DelegatorValidators RPC method.

FieldTypeLabelDescription
validatorsstringrepeatedvalidators defines the validators a delegator is delegating for.

QueryDelegatorWithdrawAddressRequest

QueryDelegatorWithdrawAddressRequest is the request type for the Query/DelegatorWithdrawAddress RPC method.

FieldTypeLabelDescription
delegator_addressstringdelegator_address defines the delegator address to query for.

QueryDelegatorWithdrawAddressResponse

QueryDelegatorWithdrawAddressResponse is the response type for the Query/DelegatorWithdrawAddress RPC method.

FieldTypeLabelDescription
withdraw_addressstringwithdraw_address defines the delegator address to query for.

QueryParamsRequest

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

QueryParamsResponse

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

FieldTypeLabelDescription
paramsParamsparams defines the parameters of the module.

QueryValidatorCommissionRequest

QueryValidatorCommissionRequest is the request type for the Query/ValidatorCommission RPC method

FieldTypeLabelDescription
validator_addressstringvalidator_address defines the validator address to query for.

QueryValidatorCommissionResponse

QueryValidatorCommissionResponse is the response type for the Query/ValidatorCommission RPC method

FieldTypeLabelDescription
commissionValidatorAccumulatedCommissioncommission defines the commision the validator received.

QueryValidatorOutstandingRewardsRequest

QueryValidatorOutstandingRewardsRequest is the request type for the Query/ValidatorOutstandingRewards RPC method.

FieldTypeLabelDescription
validator_addressstringvalidator_address defines the validator address to query for.

QueryValidatorOutstandingRewardsResponse

QueryValidatorOutstandingRewardsResponse is the response type for the Query/ValidatorOutstandingRewards RPC method.

FieldTypeLabelDescription
rewardsValidatorOutstandingRewards

QueryValidatorSlashesRequest

QueryValidatorSlashesRequest is the request type for the Query/ValidatorSlashes RPC method

FieldTypeLabelDescription
validator_addressstringvalidator_address defines the validator address to query for.
starting_heightuint64starting_height defines the optional starting height to query the slashes.
ending_heightuint64starting_height defines the optional ending height to query the slashes.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryValidatorSlashesResponse

QueryValidatorSlashesResponse is the response type for the Query/ValidatorSlashes RPC method.

FieldTypeLabelDescription
slashesValidatorSlashEventrepeatedslashes defines the slashes the validator received.
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

Query

Query defines the gRPC querier service for distribution module.

Method NameRequest TypeResponse TypeDescription
ParamsQueryParamsRequestQueryParamsResponseParams queries params of the distribution module.
ValidatorOutstandingRewardsQueryValidatorOutstandingRewardsRequestQueryValidatorOutstandingRewardsResponseValidatorOutstandingRewards queries rewards of a validator address.
ValidatorCommissionQueryValidatorCommissionRequestQueryValidatorCommissionResponseValidatorCommission queries accumulated commission for a validator.
ValidatorSlashesQueryValidatorSlashesRequestQueryValidatorSlashesResponseValidatorSlashes queries slash events of a validator.
DelegationRewardsQueryDelegationRewardsRequestQueryDelegationRewardsResponseDelegationRewards queries the total rewards accrued by a delegation.
DelegationTotalRewardsQueryDelegationTotalRewardsRequestQueryDelegationTotalRewardsResponseDelegationTotalRewards queries the total rewards accrued by a each validator.
DelegatorValidatorsQueryDelegatorValidatorsRequestQueryDelegatorValidatorsResponseDelegatorValidators queries the validators of a delegator.
DelegatorWithdrawAddressQueryDelegatorWithdrawAddressRequestQueryDelegatorWithdrawAddressResponseDelegatorWithdrawAddress queries withdraw address of a delegator.
CommunityPoolQueryCommunityPoolRequestQueryCommunityPoolResponseCommunityPool queries the community pool coins.

Top

cosmos/distribution/v1beta1/genesis.proto

DelegatorStartingInfoRecord

DelegatorStartingInfoRecord used for import / export via genesis json.

FieldTypeLabelDescription
delegator_addressstringdelegator_address is the address of the delegator.
validator_addressstringvalidator_address is the address of the validator.
starting_infoDelegatorStartingInfostarting_info defines the starting info of a delegator.

DelegatorWithdrawInfo

DelegatorWithdrawInfo is the address for where distributions rewards are withdrawn to by default this struct is only used at genesis to feed in default withdraw addresses.

FieldTypeLabelDescription
delegator_addressstringdelegator_address is the address of the delegator.
withdraw_addressstringwithdraw_address is the address to withdraw the delegation rewards to.

GenesisState

GenesisState defines the distribution module's genesis state.

FieldTypeLabelDescription
paramsParamsparams defines all the paramaters of the module.
fee_poolFeePoolfee_pool defines the fee pool at genesis.
delegator_withdraw_infosDelegatorWithdrawInforepeatedfee_pool defines the delegator withdraw infos at genesis.
previous_proposerstringfee_pool defines the previous proposer at genesis.
outstanding_rewardsValidatorOutstandingRewardsRecordrepeatedfee_pool defines the outstanding rewards of all validators at genesis.
validator_accumulated_commissionsValidatorAccumulatedCommissionRecordrepeatedfee_pool defines the accumulated commisions of all validators at genesis.
validator_historical_rewardsValidatorHistoricalRewardsRecordrepeatedfee_pool defines the historical rewards of all validators at genesis.
validator_current_rewardsValidatorCurrentRewardsRecordrepeatedfee_pool defines the current rewards of all validators at genesis.
delegator_starting_infosDelegatorStartingInfoRecordrepeatedfee_pool defines the delegator starting infos at genesis.
validator_slash_eventsValidatorSlashEventRecordrepeatedfee_pool defines the validator slash events at genesis.

ValidatorAccumulatedCommissionRecord

ValidatorAccumulatedCommissionRecord is used for import / export via genesis json.

FieldTypeLabelDescription
validator_addressstringvalidator_address is the address of the validator.
accumulatedValidatorAccumulatedCommissionaccumulated is the accumulated commission of a validator.

ValidatorCurrentRewardsRecord

ValidatorCurrentRewardsRecord is used for import / export via genesis json.

FieldTypeLabelDescription
validator_addressstringvalidator_address is the address of the validator.
rewardsValidatorCurrentRewardsrewards defines the current rewards of a validator.

ValidatorHistoricalRewardsRecord

ValidatorHistoricalRewardsRecord is used for import / export via genesis json.

FieldTypeLabelDescription
validator_addressstringvalidator_address is the address of the validator.
perioduint64period defines the period the historical rewards apply to.
rewardsValidatorHistoricalRewardsrewards defines the historical rewards of a validator.

ValidatorOutstandingRewardsRecord

ValidatorOutstandingRewardsRecord is used for import/export via genesis json.

FieldTypeLabelDescription
validator_addressstringvalidator_address is the address of the validator.
outstanding_rewardscosmos.base.v1beta1.DecCoinrepeatedoutstanding_rewards represents the oustanding rewards of a validator.

ValidatorSlashEventRecord

ValidatorSlashEventRecord is used for import / export via genesis json.

FieldTypeLabelDescription
validator_addressstringvalidator_address is the address of the validator.
heightuint64height defines the block height at which the slash event occured.
perioduint64period is the period of the slash event.
validator_slash_eventValidatorSlashEventvalidator_slash_event describes the slash event.

Top

cosmos/crisis/v1beta1/tx.proto

MsgVerifyInvariant

MsgVerifyInvariant represents a message to verify a particular invariance.

FieldTypeLabelDescription
senderstring
invariant_module_namestring
invariant_routestring

MsgVerifyInvariantResponse

MsgVerifyInvariantResponse defines the Msg/VerifyInvariant response type.

Msg

Msg defines the bank Msg service.

Method NameRequest TypeResponse TypeDescription
VerifyInvariantMsgVerifyInvariantMsgVerifyInvariantResponseVerifyInvariant defines a method to verify a particular invariance.

Top

cosmos/crisis/v1beta1/genesis.proto

GenesisState

GenesisState defines the crisis module's genesis state.

FieldTypeLabelDescription
constant_feecosmos.base.v1beta1.Coinconstant_fee is the fee used to verify the invariant in the crisis module.

Top

cosmos/tx/signing/v1beta1/signing.proto

SignatureDescriptor

SignatureDescriptor is a convenience type which represents the full data for a signature including the public key of the signer, signing modes and the signature itself. It is primarily used for coordinating signatures between clients.

FieldTypeLabelDescription
public_keygoogle.protobuf.Anypublic_key is the public key of the signer
dataSignatureDescriptor.Data
sequenceuint64sequence is the sequence of the account, which describes the number of committed transactions signed by a given address. It is used to prevent replay attacks.

SignatureDescriptor.Data

Data represents signature data

FieldTypeLabelDescription
singleSignatureDescriptor.Data.Singlesingle represents a single signer
multiSignatureDescriptor.Data.Multimulti represents a multisig signer

SignatureDescriptor.Data.Multi

Multi is the signature data for a multisig public key

FieldTypeLabelDescription
bitarraycosmos.crypto.multisig.v1beta1.CompactBitArraybitarray specifies which keys within the multisig are signing
signaturesSignatureDescriptor.Datarepeatedsignatures is the signatures of the multi-signature

SignatureDescriptor.Data.Single

Single is the signature data for a single signer

FieldTypeLabelDescription
modeSignModemode is the signing mode of the single signer
signaturebytessignature is the raw signature bytes

SignatureDescriptors

SignatureDescriptors wraps multiple SignatureDescriptor's.

FieldTypeLabelDescription
signaturesSignatureDescriptorrepeatedsignatures are the signature descriptors

SignMode

SignMode represents a signing mode with its own security guarantees.

NameNumberDescription
SIGN_MODE_UNSPECIFIED0SIGN_MODE_UNSPECIFIED specifies an unknown signing mode and will be rejected
SIGN_MODE_DIRECT1SIGN_MODE_DIRECT specifies a signing mode which uses SignDoc and is verified with raw bytes from Tx
SIGN_MODE_TEXTUAL2SIGN_MODE_TEXTUAL is a future signing mode that will verify some human-readable textual representation on top of the binary representation from SIGN_MODE_DIRECT
SIGN_MODE_LEGACY_AMINO_JSON127SIGN_MODE_LEGACY_AMINO_JSON is a backwards compatibility mode which uses Amino JSON and will be removed in the future

Top

cosmos/tx/v1beta1/tx.proto

AuthInfo

AuthInfo describes the fee and signer modes that are used to sign a transaction.

FieldTypeLabelDescription
signer_infosSignerInforepeatedsigner_infos defines the signing modes for the required signers. The number and order of elements must match the required signers from TxBody's messages. The first element is the primary signer and the one which pays the fee.
feeFeeFee is the fee and gas limit for the transaction. The first signer is the primary signer and the one which pays the fee. The fee can be calculated based on the cost of evaluating the body and doing signature verification of the signers. This can be estimated via simulation.

Fee

Fee includes the amount of coins paid in fees and the maximum gas to be used by the transaction. The ratio yields an effective "gasprice", which must be above some miminum to be accepted into the mempool.

FieldTypeLabelDescription
amountcosmos.base.v1beta1.Coinrepeatedamount is the amount of coins to be paid as a fee
gas_limituint64gas_limit is the maximum gas that can be used in transaction processing before an out of gas error occurs
payerstringif unset, the first signer is responsible for paying the fees. If set, the specified account must pay the fees. the payer must be a tx signer (and thus have signed this field in AuthInfo). setting this field does not change the ordering of required signers for the transaction.
granterstringif set, the fee payer (either the first signer or the value of the payer field) requests that a fee grant be used to pay fees instead of the fee payer's own balance. If an appropriate fee grant does not exist or the chain does not support fee grants, this will fail

ModeInfo

ModeInfo describes the signing mode of a single or nested multisig signer.

FieldTypeLabelDescription
singleModeInfo.Singlesingle represents a single signer
multiModeInfo.Multimulti represents a nested multisig signer

ModeInfo.Multi

Multi is the mode info for a multisig public key

FieldTypeLabelDescription
bitarraycosmos.crypto.multisig.v1beta1.CompactBitArraybitarray specifies which keys within the multisig are signing
mode_infosModeInforepeatedmode_infos is the corresponding modes of the signers of the multisig which could include nested multisig public keys

ModeInfo.Single

Single is the mode info for a single signer. It is structured as a message to allow for additional fields such as locale for SIGN_MODE_TEXTUAL in the future

FieldTypeLabelDescription
modecosmos.tx.signing.v1beta1.SignModemode is the signing mode of the single signer

SignDoc

SignDoc is the type used for generating sign bytes for SIGN_MODE_DIRECT.

FieldTypeLabelDescription
body_bytesbytesbody_bytes is protobuf serialization of a TxBody that matches the representation in TxRaw.
auth_info_bytesbytesauth_info_bytes is a protobuf serialization of an AuthInfo that matches the representation in TxRaw.
chain_idstringchain_id is the unique identifier of the chain this transaction targets. It prevents signed transactions from being used on another chain by an attacker
account_numberuint64account_number is the account number of the account in state

SignerInfo

SignerInfo describes the public key and signing mode of a single top-level signer.

FieldTypeLabelDescription
public_keygoogle.protobuf.Anypublic_key is the public key of the signer. It is optional for accounts that already exist in state. If unset, the verifier can use the required \ signer address for this position and lookup the public key.
mode_infoModeInfomode_info describes the signing mode of the signer and is a nested structure to support nested multisig pubkey's
sequenceuint64sequence is the sequence of the account, which describes the number of committed transactions signed by a given address. It is used to prevent replay attacks.

Tx

Tx is the standard type used for broadcasting transactions.

FieldTypeLabelDescription
bodyTxBodybody is the processable content of the transaction
auth_infoAuthInfoauth_info is the authorization related content of the transaction, specifically signers, signer modes and fee
signaturesbytesrepeatedsignatures is a list of signatures that matches the length and order of AuthInfo's signer_infos to allow connecting signature meta information like public key and signing mode by position.

TxBody

TxBody is the body of a transaction that all signers sign over.

FieldTypeLabelDescription
messagesgoogle.protobuf.Anyrepeatedmessages is a list of messages to be executed. The required signers of those messages define the number and order of elements in AuthInfo's signer_infos and Tx's signatures. Each required signer address is added to the list only the first time it occurs.

By convention, the first required signer (usually from the first message) is referred to as the primary signer and pays the fee for the whole transaction. | | memo | string | | memo is any arbitrary memo to be added to the transaction | | timeout_height | uint64 | | timeout is the block height after which this transaction will not be processed by the chain | | extension_options | google.protobuf.Any | repeated | extension_options are arbitrary options that can be added by chains when the default options are not sufficient. If any of these are present and can't be handled, the transaction will be rejected | | non_critical_extension_options | google.protobuf.Any | repeated | extension_options are arbitrary options that can be added by chains when the default options are not sufficient. If any of these are present and can't be handled, they will be ignored |

TxRaw

TxRaw is a variant of Tx that pins the signer's exact binary representation of body and auth_info. This is used for signing, broadcasting and verification. The binary serialize(tx: TxRaw) is stored in Tendermint and the hash sha256(serialize(tx: TxRaw)) becomes the "txhash", commonly used as the transaction ID.

FieldTypeLabelDescription
body_bytesbytesbody_bytes is a protobuf serialization of a TxBody that matches the representation in SignDoc.
auth_info_bytesbytesauth_info_bytes is a protobuf serialization of an AuthInfo that matches the representation in SignDoc.
signaturesbytesrepeatedsignatures is a list of signatures that matches the length and order of AuthInfo's signer_infos to allow connecting signature meta information like public key and signing mode by position.

Top

cosmos/vesting/v1beta1/tx.proto

MsgCreateVestingAccount

MsgCreateVestingAccount defines a message that enables creating a vesting account.

FieldTypeLabelDescription
from_addressstring
to_addressstring
amountcosmos.base.v1beta1.Coinrepeated
end_timeint64
delayedbool

MsgCreateVestingAccountResponse

MsgCreateVestingAccountResponse defines the Msg/CreateVestingAccount response type.

Msg

Msg defines the bank Msg service.

Method NameRequest TypeResponse TypeDescription
CreateVestingAccountMsgCreateVestingAccountMsgCreateVestingAccountResponseCreateVestingAccount defines a method that enables creating a vesting account.

Top

cosmos/vesting/v1beta1/vesting.proto

BaseVestingAccount

BaseVestingAccount implements the VestingAccount interface. It contains all the necessary fields needed for any vesting account implementation.

FieldTypeLabelDescription
base_accountcosmos.auth.v1beta1.BaseAccount
original_vestingcosmos.base.v1beta1.Coinrepeated
delegated_freecosmos.base.v1beta1.Coinrepeated
delegated_vestingcosmos.base.v1beta1.Coinrepeated
end_timeint64

ContinuousVestingAccount

ContinuousVestingAccount implements the VestingAccount interface. It continuously vests by unlocking coins linearly with respect to time.

FieldTypeLabelDescription
base_vesting_accountBaseVestingAccount
start_timeint64

DelayedVestingAccount

DelayedVestingAccount implements the VestingAccount interface. It vests all coins after a specific time, but non prior. In other words, it keeps them locked until a specified time.

FieldTypeLabelDescription
base_vesting_accountBaseVestingAccount

Period

Period defines a length of time and amount of coins that will vest.

FieldTypeLabelDescription
lengthint64
amountcosmos.base.v1beta1.Coinrepeated

PeriodicVestingAccount

PeriodicVestingAccount implements the VestingAccount interface. It periodically vests by unlocking coins during each specified period.

FieldTypeLabelDescription
base_vesting_accountBaseVestingAccount
start_timeint64
vesting_periodsPeriodrepeated

Top

cosmos/staking/v1beta1/tx.proto

MsgBeginRedelegate

MsgBeginRedelegate defines a SDK message for performing a redelegation of coins from a delegator and source validator to a destination validator.

FieldTypeLabelDescription
delegator_addressstring
validator_src_addressstring
validator_dst_addressstring
amountcosmos.base.v1beta1.Coin

MsgBeginRedelegateResponse

MsgBeginRedelegateResponse defines the Msg/BeginRedelegate response type.

FieldTypeLabelDescription
completion_timegoogle.protobuf.Timestamp

MsgCreateValidator

MsgCreateValidator defines a SDK message for creating a new validator.

FieldTypeLabelDescription
descriptionDescription
commissionCommissionRates
min_self_delegationstring
delegator_addressstring
validator_addressstring
pubkeystring
valuecosmos.base.v1beta1.Coin

MsgCreateValidatorResponse

MsgCreateValidatorResponse defines the Msg/CreateValidator response type.

MsgDelegate

MsgDelegate defines a SDK message for performing a delegation of coins from a delegator to a validator.

FieldTypeLabelDescription
delegator_addressstring
validator_addressstring
amountcosmos.base.v1beta1.Coin

MsgDelegateResponse

MsgDelegateResponse defines the Msg/Delegate response type.

MsgEditValidator

MsgEditValidator defines a SDK message for editing an existing validator.

FieldTypeLabelDescription
descriptionDescription
validator_addressstring
commission_ratestringWe pass a reference to the new commission rate and min self delegation as it's not mandatory to update. If not updated, the deserialized rate will be zero with no way to distinguish if an update was intended.

REF: #2373 | | min_self_delegation | string | | |

MsgEditValidatorResponse

MsgEditValidatorResponse defines the Msg/EditValidator response type.

MsgUndelegate

MsgUndelegate defines a SDK message for performing an undelegation from a delegate and a validator.

FieldTypeLabelDescription
delegator_addressstring
validator_addressstring
amountcosmos.base.v1beta1.Coin

MsgUndelegateResponse

MsgUndelegateResponse defines the Msg/Undelegate response type.

FieldTypeLabelDescription
completion_timegoogle.protobuf.Timestamp

Msg

Msg defines the staking Msg service.

Method NameRequest TypeResponse TypeDescription
CreateValidatorMsgCreateValidatorMsgCreateValidatorResponseCreateValidator defines a method for creating a new validator.
EditValidatorMsgEditValidatorMsgEditValidatorResponseEditValidator defines a method for editing an existing validator.
DelegateMsgDelegateMsgDelegateResponseDelegate defines a method for performing a delegation of coins from a delegator to a validator.
BeginRedelegateMsgBeginRedelegateMsgBeginRedelegateResponseBeginRedelegate defines a method for performing a redelegation of coins from a delegator and source validator to a destination validator.
UndelegateMsgUndelegateMsgUndelegateResponseUndelegate defines a method for performing an undelegation from a delegate and a validator.

Top

cosmos/staking/v1beta1/query.proto

QueryDelegationRequest

QueryDelegationRequest is request type for the Query/Delegation RPC method.

FieldTypeLabelDescription
delegator_addrstringdelegator_addr defines the delegator address to query for.
validator_addrstringvalidator_addr defines the validator address to query for.

QueryDelegationResponse

QueryDelegationResponse is response type for the Query/Delegation RPC method.

FieldTypeLabelDescription
delegation_responseDelegationResponsedelegation_responses defines the delegation info of a delegation.

QueryDelegatorDelegationsRequest

QueryDelegatorDelegationsRequest is request type for the Query/DelegatorDelegations RPC method.

FieldTypeLabelDescription
delegator_addrstringdelegator_addr defines the delegator address to query for.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryDelegatorDelegationsResponse

QueryDelegatorDelegationsResponse is response type for the Query/DelegatorDelegations RPC method.

FieldTypeLabelDescription
delegation_responsesDelegationResponserepeateddelegation_responses defines all the delegations' info of a delegator.
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

QueryDelegatorUnbondingDelegationsRequest

QueryDelegatorUnbondingDelegationsRequest is request type for the Query/DelegatorUnbondingDelegations RPC method.

FieldTypeLabelDescription
delegator_addrstringdelegator_addr defines the delegator address to query for.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryDelegatorUnbondingDelegationsResponse

QueryUnbondingDelegatorDelegationsResponse is response type for the Query/UnbondingDelegatorDelegations RPC method.

FieldTypeLabelDescription
unbonding_responsesUnbondingDelegationrepeated
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

QueryDelegatorValidatorRequest

QueryDelegatorValidatorRequest is request type for the Query/DelegatorValidator RPC method.

FieldTypeLabelDescription
delegator_addrstringdelegator_addr defines the delegator address to query for.
validator_addrstringvalidator_addr defines the validator address to query for.

QueryDelegatorValidatorResponse

QueryDelegatorValidatorResponse response type for the Query/DelegatorValidator RPC method.

FieldTypeLabelDescription
validatorValidatorvalidator defines the the validator info.

QueryDelegatorValidatorsRequest

QueryDelegatorValidatorsRequest is request type for the Query/DelegatorValidators RPC method.

FieldTypeLabelDescription
delegator_addrstringdelegator_addr defines the delegator address to query for.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryDelegatorValidatorsResponse

QueryDelegatorValidatorsResponse is response type for the Query/DelegatorValidators RPC method.

FieldTypeLabelDescription
validatorsValidatorrepeatedvalidators defines the the validators' info of a delegator.
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

QueryHistoricalInfoRequest

QueryHistoricalInfoRequest is request type for the Query/HistoricalInfo RPC method.

FieldTypeLabelDescription
heightint64height defines at which height to query the historical info.

QueryHistoricalInfoResponse

QueryHistoricalInfoResponse is response type for the Query/HistoricalInfo RPC method.

FieldTypeLabelDescription
histHistoricalInfohist defines the historical info at the given height.

QueryParamsRequest

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

QueryParamsResponse

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

FieldTypeLabelDescription
paramsParamsparams holds all the parameters of this module.

QueryPoolRequest

QueryPoolRequest is request type for the Query/Pool RPC method.

QueryPoolResponse

QueryPoolResponse is response type for the Query/Pool RPC method.

FieldTypeLabelDescription
poolPoolpool defines the pool info.

QueryRedelegationsRequest

QueryRedelegationsRequest is request type for the Query/Redelegations RPC method.

FieldTypeLabelDescription
delegator_addrstringdelegator_addr defines the delegator address to query for.
src_validator_addrstringsrc_validator_addr defines the validator address to redelegate from.
dst_validator_addrstringdst_validator_addr defines the validator address to redelegate to.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryRedelegationsResponse

QueryRedelegationsResponse is response type for the Query/Redelegations RPC method.

FieldTypeLabelDescription
redelegation_responsesRedelegationResponserepeated
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

QueryUnbondingDelegationRequest

QueryUnbondingDelegationRequest is request type for the Query/UnbondingDelegation RPC method.

FieldTypeLabelDescription
delegator_addrstringdelegator_addr defines the delegator address to query for.
validator_addrstringvalidator_addr defines the validator address to query for.

QueryUnbondingDelegationResponse

QueryDelegationResponse is response type for the Query/UnbondingDelegation RPC method.

FieldTypeLabelDescription
unbondUnbondingDelegationunbond defines the unbonding information of a delegation.

QueryValidatorDelegationsRequest

QueryValidatorDelegationsRequest is request type for the Query/ValidatorDelegations RPC method

FieldTypeLabelDescription
validator_addrstringvalidator_addr defines the validator address to query for.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryValidatorDelegationsResponse

QueryValidatorDelegationsResponse is response type for the Query/ValidatorDelegations RPC method

FieldTypeLabelDescription
delegation_responsesDelegationResponserepeated
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

QueryValidatorRequest

QueryValidatorRequest is response type for the Query/Validator RPC method

FieldTypeLabelDescription
validator_addrstringvalidator_addr defines the validator address to query for.

QueryValidatorResponse

QueryValidatorResponse is response type for the Query/Validator RPC method

FieldTypeLabelDescription
validatorValidatorvalidator defines the the validator info.

QueryValidatorUnbondingDelegationsRequest

QueryValidatorUnbondingDelegationsRequest is required type for the Query/ValidatorUnbondingDelegations RPC method

FieldTypeLabelDescription
validator_addrstringvalidator_addr defines the validator address to query for.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryValidatorUnbondingDelegationsResponse

QueryValidatorUnbondingDelegationsResponse is response type for the Query/ValidatorUnbondingDelegations RPC method.

FieldTypeLabelDescription
unbonding_responsesUnbondingDelegationrepeated
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

QueryValidatorsRequest

QueryValidatorsRequest is request type for Query/Validators RPC method.

FieldTypeLabelDescription
statusstringstatus enables to query for validators matching a given status.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryValidatorsResponse

QueryValidatorsResponse is response type for the Query/Validators RPC method

FieldTypeLabelDescription
validatorsValidatorrepeatedvalidators contains all the queried validators.
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

Query

Query defines the gRPC querier service.

Method NameRequest TypeResponse TypeDescription
ValidatorsQueryValidatorsRequestQueryValidatorsResponseValidators queries all validators that match the given status.
ValidatorQueryValidatorRequestQueryValidatorResponseValidator queries validator info for given validator address.
ValidatorDelegationsQueryValidatorDelegationsRequestQueryValidatorDelegationsResponseValidatorDelegations queries delegate info for given validator.
ValidatorUnbondingDelegationsQueryValidatorUnbondingDelegationsRequestQueryValidatorUnbondingDelegationsResponseValidatorUnbondingDelegations queries unbonding delegations of a validator.
DelegationQueryDelegationRequestQueryDelegationResponseDelegation queries delegate info for given validator delegator pair.
UnbondingDelegationQueryUnbondingDelegationRequestQueryUnbondingDelegationResponseUnbondingDelegation queries unbonding info for given validator delegator pair.
DelegatorDelegationsQueryDelegatorDelegationsRequestQueryDelegatorDelegationsResponseDelegatorDelegations queries all delegations of a given delegator address.
DelegatorUnbondingDelegationsQueryDelegatorUnbondingDelegationsRequestQueryDelegatorUnbondingDelegationsResponseDelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address.
RedelegationsQueryRedelegationsRequestQueryRedelegationsResponseRedelegations queries redelegations of given address.
DelegatorValidatorsQueryDelegatorValidatorsRequestQueryDelegatorValidatorsResponseDelegatorValidators queries all validators info for given delegator address.
DelegatorValidatorQueryDelegatorValidatorRequestQueryDelegatorValidatorResponseDelegatorValidator queries validator info for given delegator validator pair.
HistoricalInfoQueryHistoricalInfoRequestQueryHistoricalInfoResponseHistoricalInfo queries the historical info for given height.
PoolQueryPoolRequestQueryPoolResponsePool queries the pool info.
ParamsQueryParamsRequestQueryParamsResponseParameters queries the staking parameters.

Top

cosmos/staking/v1beta1/genesis.proto

GenesisState

GenesisState defines the staking module's genesis state.

FieldTypeLabelDescription
paramsParamsparams defines all the paramaters of related to deposit.
last_total_powerbyteslast_total_power tracks the total amounts of bonded tokens recorded during the previous end block.
last_validator_powersLastValidatorPowerrepeatedlast_validator_powers is a special index that provides a historical list of the last-block's bonded validators.
validatorsValidatorrepeateddelegations defines the validator set at genesis.
delegationsDelegationrepeateddelegations defines the delegations active at genesis.
unbonding_delegationsUnbondingDelegationrepeatedunbonding_delegations defines the unbonding delegations active at genesis.
redelegationsRedelegationrepeatedredelegations defines the redelegations active at genesis.
exportedbool

LastValidatorPower

LastValidatorPower required for validator set update logic.

FieldTypeLabelDescription
addressstringaddress is the address of the validator.
powerint64power defines the power of the validator.

Top

cosmos/staking/v1beta1/staking.proto

Commission

Commission defines commission parameters for a given validator.

FieldTypeLabelDescription
commission_ratesCommissionRates
update_timegoogle.protobuf.Timestamp

CommissionRates

CommissionRates defines the initial commission rates to be used for creating a validator.

FieldTypeLabelDescription
ratestring
max_ratestring
max_change_ratestring

DVPair

DVPair is struct that just has a delegator-validator pair with no other data. It is intended to be used as a marshalable pointer. For example, a DVPair can be used to construct the key to getting an UnbondingDelegation from state.

FieldTypeLabelDescription
delegator_addressstring
validator_addressstring

DVPairs

DVPairs defines an array of DVPair objects.

FieldTypeLabelDescription
pairsDVPairrepeated

DVVTriplet

DVVTriplet is struct that just has a delegator-validator-validator triplet with no other data. It is intended to be used as a marshalable pointer. For example, a DVVTriplet can be used to construct the key to getting a Redelegation from state.

FieldTypeLabelDescription
delegator_addressstring
validator_src_addressstring
validator_dst_addressstring

DVVTriplets

DVVTriplets defines an array of DVVTriplet objects.

FieldTypeLabelDescription
tripletsDVVTripletrepeated

Delegation

Delegation represents the bond with tokens held by an account. It is owned by one delegator, and is associated with the voting power of one validator.

FieldTypeLabelDescription
delegator_addressstring
validator_addressstring
sharesstring

DelegationResponse

DelegationResponse is equivalent to Delegation except that it contains a balance in addition to shares which is more suitable for client responses.

FieldTypeLabelDescription
delegationDelegation
balancecosmos.base.v1beta1.Coin

Description

Description defines a validator description.

FieldTypeLabelDescription
monikerstring
identitystring
websitestring
security_contactstring
detailsstring

HistoricalInfo

HistoricalInfo contains header and validator information for a given block. It is stored as part of staking module's state, which persists the n most recent HistoricalInfo (n is set by the staking module's historical_entries parameter).

FieldTypeLabelDescription
headertendermint.types.Header
valsetValidatorrepeated

Params

Params defines the parameters for the staking module.

FieldTypeLabelDescription
unbonding_timegoogle.protobuf.Duration
max_validatorsuint32
max_entriesuint32
historical_entriesuint32
bond_denomstring

Pool

Pool is used for tracking bonded and not-bonded token supply of the bond denomination.

FieldTypeLabelDescription
not_bonded_tokensstring
bonded_tokensstring

Redelegation

Redelegation contains the list of a particular delegator's redelegating bonds from a particular source validator to a particular destination validator.

FieldTypeLabelDescription
delegator_addressstring
validator_src_addressstring
validator_dst_addressstring
entriesRedelegationEntryrepeatedredelegation entries

RedelegationEntry

RedelegationEntry defines a redelegation object with relevant metadata.

FieldTypeLabelDescription
creation_heightint64
completion_timegoogle.protobuf.Timestamp
initial_balancestring
shares_dststring

RedelegationEntryResponse

RedelegationEntryResponse is equivalent to a RedelegationEntry except that it contains a balance in addition to shares which is more suitable for client responses.

FieldTypeLabelDescription
redelegation_entryRedelegationEntry
balancestring

RedelegationResponse

RedelegationResponse is equivalent to a Redelegation except that its entries contain a balance in addition to shares which is more suitable for client responses.

FieldTypeLabelDescription
redelegationRedelegation
entriesRedelegationEntryResponserepeated

UnbondingDelegation

UnbondingDelegation stores all of a single delegator's unbonding bonds for a single validator in an time-ordered list.

FieldTypeLabelDescription
delegator_addressstring
validator_addressstring
entriesUnbondingDelegationEntryrepeatedunbonding delegation entries

UnbondingDelegationEntry

UnbondingDelegationEntry defines an unbonding object with relevant metadata.

FieldTypeLabelDescription
creation_heightint64
completion_timegoogle.protobuf.Timestamp
initial_balancestring
balancestring

ValAddresses

ValAddresses defines a repeated set of validator addresses.

FieldTypeLabelDescription
addressesstringrepeated

Validator

Validator defines a validator, together with the total amount of the Validator's bond shares and their exchange rate to coins. Slashing results in a decrease in the exchange rate, allowing correct calculation of future undelegations without iterating over delegators. When coins are delegated to this validator, the validator is credited with a delegation whose number of bond shares is based on the amount of coins delegated divided by the current exchange rate. Voting power can be calculated as total bonded shares multiplied by exchange rate.

FieldTypeLabelDescription
operator_addressstring
consensus_pubkeystring
jailedbool
statusBondStatus
tokensstring
delegator_sharesstring
descriptionDescription
unbonding_heightint64
unbonding_timegoogle.protobuf.Timestamp
commissionCommission
min_self_delegationstring

BondStatus

BondStatus is the status of a validator.

NameNumberDescription
BOND_STATUS_UNSPECIFIED0UNSPECIFIED defines an invalid validator status.
BOND_STATUS_UNBONDED1UNBONDED defines a validator that is not bonded.
BOND_STATUS_UNBONDING2UNBONDING defines a validator that is unbonding.
BOND_STATUS_BONDED3BONDED defines a validator that is bonded.

Top

cosmos/genutil/v1beta1/genesis.proto

GenesisState

GenesisState defines the raw genesis transaction in JSON.

FieldTypeLabelDescription
gen_txsbytesrepeatedgen_txs defines the genesis transactions.

Top

cosmos/params/v1beta1/query.proto

QueryParamsRequest

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

FieldTypeLabelDescription
subspacestringsubspace defines the module to query the parameter for.
keystringkey defines the key of the parameter in the subspace.

QueryParamsResponse

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

FieldTypeLabelDescription
paramParamChangeparam defines the queried parameter.

Query

Query defines the gRPC querier service.

Method NameRequest TypeResponse TypeDescription
ParamsQueryParamsRequestQueryParamsResponseParams queries a specific parameter of a module, given its subspace and key.

Top

cosmos/params/v1beta1/params.proto

ParamChange

ParamChange defines an individual parameter change, for use in ParameterChangeProposal.

FieldTypeLabelDescription
subspacestring
keystring
valuestring

ParameterChangeProposal

ParameterChangeProposal defines a proposal to change one or more parameters.

FieldTypeLabelDescription
titlestring
descriptionstring
changesParamChangerepeated

Top

cosmos/slashing/v1beta1/tx.proto

MsgUnjail

MsgUnjail defines the Msg/Unjail request type

FieldTypeLabelDescription
validator_addrstring

MsgUnjailResponse

MsgUnjailResponse defines the Msg/Unjail response type

Msg

Msg defines the slashing Msg service.

Method NameRequest TypeResponse TypeDescription
UnjailMsgUnjailMsgUnjailResponseUnjail defines a method for unjailing a jailed validator, thus returning them into the bonded validator set, so they can begin receiving provisions and rewards again.

Top

cosmos/slashing/v1beta1/slashing.proto

Params

Params represents the parameters used for by the slashing module.

FieldTypeLabelDescription
signed_blocks_windowint64
min_signed_per_windowbytes
downtime_jail_durationgoogle.protobuf.Duration
slash_fraction_double_signbytes
slash_fraction_downtimebytes

ValidatorSigningInfo

ValidatorSigningInfo defines a validator's signing info for monitoring their liveness activity.

FieldTypeLabelDescription
addressstring
start_heightint64height at which validator was first a candidate OR was unjailed
index_offsetint64index offset into signed block bit array
jailed_untilgoogle.protobuf.Timestamptimestamp validator cannot be unjailed until
tombstonedboolwhether or not a validator has been tombstoned (killed out of validator set)
missed_blocks_counterint64missed blocks counter (to avoid scanning the array every time)

Top

cosmos/slashing/v1beta1/query.proto

QueryParamsRequest

QueryParamsRequest is the request type for the Query/Params RPC method

QueryParamsResponse

QueryParamsResponse is the response type for the Query/Params RPC method

FieldTypeLabelDescription
paramsParams

QuerySigningInfoRequest

QuerySigningInfoRequest is the request type for the Query/SigningInfo RPC method

FieldTypeLabelDescription
cons_addressstringcons_address is the address to query signing info of

QuerySigningInfoResponse

QuerySigningInfoResponse is the response type for the Query/SigningInfo RPC method

FieldTypeLabelDescription
val_signing_infoValidatorSigningInfoval_signing_info is the signing info of requested val cons address

QuerySigningInfosRequest

QuerySigningInfosRequest is the request type for the Query/SigningInfos RPC method

FieldTypeLabelDescription
paginationcosmos.base.query.v1beta1.PageRequest

QuerySigningInfosResponse

QuerySigningInfosResponse is the response type for the Query/SigningInfos RPC method

FieldTypeLabelDescription
infoValidatorSigningInforepeatedinfo is the signing info of all validators
paginationcosmos.base.query.v1beta1.PageResponse

Query

Query provides defines the gRPC querier service

Method NameRequest TypeResponse TypeDescription
ParamsQueryParamsRequestQueryParamsResponseParams queries the parameters of slashing module
SigningInfoQuerySigningInfoRequestQuerySigningInfoResponseSigningInfo queries the signing info of given cons address
SigningInfosQuerySigningInfosRequestQuerySigningInfosResponseSigningInfos queries signing info of all validators

Top

cosmos/slashing/v1beta1/genesis.proto

GenesisState

GenesisState defines the slashing module's genesis state.

FieldTypeLabelDescription
paramsParamsparams defines all the paramaters of related to deposit.
signing_infosSigningInforepeatedsigning_infos represents a map between validator addresses and their signing infos.
missed_blocksValidatorMissedBlocksrepeatedsigning_infos represents a map between validator addresses and their missed blocks.

MissedBlock

MissedBlock contains height and missed status as boolean.

FieldTypeLabelDescription
indexint64index is the height at which the block was missed.
missedboolmissed is the missed status.

SigningInfo

SigningInfo stores validator signing info of corresponding address.

FieldTypeLabelDescription
addressstringaddress is the validator address.
validator_signing_infoValidatorSigningInfovalidator_signing_info represents the signing info of this validator.

ValidatorMissedBlocks

ValidatorMissedBlocks contains array of missed blocks of corresponding address.

FieldTypeLabelDescription
addressstringaddress is the validator address.
missed_blocksMissedBlockrepeatedmissed_blocks is an array of missed blocks by the validator.

Top

cosmos/base/abci/v1beta1/abci.proto

ABCIMessageLog

ABCIMessageLog defines a structure containing an indexed tx ABCI message log.

FieldTypeLabelDescription
msg_indexuint32
logstring
eventsStringEventrepeatedEvents contains a slice of Event objects that were emitted during some execution.

Attribute

Attribute defines an attribute wrapper where the key and value are strings instead of raw bytes.

FieldTypeLabelDescription
keystring
valuestring

GasInfo

GasInfo defines tx execution gas context.

FieldTypeLabelDescription
gas_wanteduint64GasWanted is the maximum units of work we allow this tx to perform.
gas_useduint64GasUsed is the amount of gas actually consumed.

MsgData

MsgData defines the data returned in a Result object during message execution.

FieldTypeLabelDescription
msg_typestring
databytes

Result

Result is the union of ResponseFormat and ResponseCheckTx.

FieldTypeLabelDescription
databytesData is any data returned from message or handler execution. It MUST be length prefixed in order to separate data from multiple message executions.
logstringLog contains the log information from message or handler execution.
eventstendermint.abci.EventrepeatedEvents contains a slice of Event objects that were emitted during message or handler execution.

SearchTxsResult

SearchTxsResult defines a structure for querying txs pageable

FieldTypeLabelDescription
total_countuint64Count of all txs
countuint64Count of txs in current page
page_numberuint64Index of current page, start from 1
page_totaluint64Count of total pages
limituint64Max count txs per page
txsTxResponserepeatedList of txs in current page

SimulationResponse

SimulationResponse defines the response generated when a transaction is successfully simulated.

FieldTypeLabelDescription
gas_infoGasInfo
resultResult

StringEvent

StringEvent defines en Event object wrapper where all the attributes contain key/value pairs that are strings instead of raw bytes.

FieldTypeLabelDescription
typestring
attributesAttributerepeated

TxMsgData

TxMsgData defines a list of MsgData. A transaction will have a MsgData object for each message.

FieldTypeLabelDescription
dataMsgDatarepeated

TxResponse

TxResponse defines a structure containing relevant tx data and metadata. The tags are stringified and the log is JSON decoded.

FieldTypeLabelDescription
heightint64The block height
txhashstringThe transaction hash.
codespacestringNamespace for the Code
codeuint32Response code.
datastringResult bytes, if any.
raw_logstringThe output of the application's logger (raw string). May be non-deterministic.
logsABCIMessageLogrepeatedThe output of the application's logger (typed). May be non-deterministic.
infostringAdditional information. May be non-deterministic.
gas_wantedint64Amount of gas requested for transaction.
gas_usedint64Amount of gas consumed by transaction.
txgoogle.protobuf.AnyThe request transaction bytes.
timestampstringTime of the previous block. For heights > 1, it's the weighted median of the timestamps of the valid votes in the block.LastCommit. For height == 1, it's genesis time.

Top

cosmos/base/kv/v1beta1/kv.proto

Pair

Pair defines a key/value bytes tuple.

FieldTypeLabelDescription
keybytes
valuebytes

Pairs

Pairs defines a repeated slice of Pair objects.

FieldTypeLabelDescription
pairsPairrepeated

Top

cosmos/base/snapshots/v1beta1/snapshot.proto

Metadata

Metadata contains SDK-specific snapshot metadata.

FieldTypeLabelDescription
chunk_hashesbytesrepeatedSHA-256 chunk hashes

Snapshot

Snapshot contains Tendermint state sync snapshot info.

FieldTypeLabelDescription
heightuint64
formatuint32
chunksuint32
hashbytes
metadataMetadata

Top

cosmos/base/simulate/v1beta1/simulate.proto

SimulateRequest

SimulateRequest is the request type for the SimulateServiceService.Simulate RPC method.

FieldTypeLabelDescription
txcosmos.tx.v1beta1.Txtx is the transaction to simulate.

SimulateResponse

SimulateResponse is the response type for the SimulateServiceService.SimulateRPC method.

FieldTypeLabelDescription
gas_infocosmos.base.abci.v1beta1.GasInfogas_info is the information about gas used in the simulation.
resultcosmos.base.abci.v1beta1.Resultresult is the result of the simulation.

SimulateService

SimulateService defines a gRPC service for simulating transactions. It may also support querying and broadcasting in the future.

Method NameRequest TypeResponse TypeDescription
SimulateSimulateRequestSimulateResponseSimulate simulates executing a transaction for estimating gas usage.

Top

cosmos/base/v1beta1/coin.proto

Coin

Coin defines a token with a denomination and an amount.

NOTE: The amount field is an Int which implements the custom method signatures required by gogoproto.

FieldTypeLabelDescription
denomstring
amountstring

DecCoin

DecCoin defines a token with a denomination and a decimal amount.

NOTE: The amount field is an Dec which implements the custom method signatures required by gogoproto.

FieldTypeLabelDescription
denomstring
amountstring

DecProto

DecProto defines a Protobuf wrapper around a Dec object.

FieldTypeLabelDescription
decstring

IntProto

IntProto defines a Protobuf wrapper around an Int object.

FieldTypeLabelDescription
intstring

Top

cosmos/base/query/v1beta1/pagination.proto

PageRequest

PageRequest is to be embedded in gRPC request messages for efficient pagination. Ex:

message SomeRequest { Foo some_parameter = 1; PageRequest pagination = 2; }

FieldTypeLabelDescription
keybyteskey is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
offsetuint64offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
limituint64limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
count_totalboolcount_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

PageResponse

PageResponse is to be embedded in gRPC response messages where the corresponding request message has used PageRequest.

message SomeResponse { repeated Bar results = 1; PageResponse page = 2; }

FieldTypeLabelDescription
next_keybytesnext_key is the key to be passed to PageRequest.key to query the next page most efficiently
totaluint64total is total number of results available if PageRequest.count_total was set, its value is undefined otherwise

Top

cosmos/base/store/v1beta1/commit_info.proto

CommitID

CommitID defines the committment information when a specific store is committed.

FieldTypeLabelDescription
versionint64
hashbytes

CommitInfo

CommitInfo defines commit information used by the multi-store when committing a version/height.

FieldTypeLabelDescription
versionint64
store_infosStoreInforepeated

StoreInfo

StoreInfo defines store-specific commit information. It contains a reference between a store name and the commit ID.

FieldTypeLabelDescription
namestring
commit_idCommitID

Top

cosmos/base/store/v1beta1/snapshot.proto

SnapshotIAVLItem

SnapshotIAVLItem is an exported IAVL node.

FieldTypeLabelDescription
keybytes
valuebytes
versionint64
heightint32

SnapshotItem

SnapshotItem is an item contained in a rootmulti.Store snapshot.

FieldTypeLabelDescription
storeSnapshotStoreItem
iavlSnapshotIAVLItem

SnapshotStoreItem

SnapshotStoreItem contains metadata about a snapshotted store.

FieldTypeLabelDescription
namestring

Top

cosmos/base/reflection/v1beta1/reflection.proto

ListAllInterfacesRequest

ListAllInterfacesRequest is the request type of the ListAllInterfaces RPC.

ListAllInterfacesResponse

ListAllInterfacesResponse is the response type of the ListAllInterfaces RPC.

FieldTypeLabelDescription
interface_namesstringrepeatedinterface_names is an array of all the registered interfaces.

ListImplementationsRequest

ListImplementationsRequest is the request type of the ListImplementations RPC.

FieldTypeLabelDescription
interface_namestringinterface_name defines the interface to query the implementations for.

ListImplementationsResponse

ListImplementationsResponse is the response type of the ListImplementations RPC.

FieldTypeLabelDescription
implementation_message_namesstringrepeated

ReflectionService

ReflectionService defines a service for interface reflection.

Method NameRequest TypeResponse TypeDescription
ListAllInterfacesListAllInterfacesRequestListAllInterfacesResponseListAllInterfaces lists all the interfaces registered in the interface registry.
ListImplementationsListImplementationsRequestListImplementationsResponseListImplementations list all the concrete types that implement a given interface.

Top

cosmos/gov/v1beta1/tx.proto

MsgDeposit

MsgDeposit defines a message to submit a deposit to an existing proposal.

FieldTypeLabelDescription
proposal_iduint64
depositorstring
amountcosmos.base.v1beta1.Coinrepeated

MsgDepositResponse

MsgDepositResponse defines the Msg/Deposit response type.

MsgSubmitProposal

MsgSubmitProposal defines an sdk.Msg type that supports submitting arbitrary proposal Content.

FieldTypeLabelDescription
contentgoogle.protobuf.Any
initial_depositcosmos.base.v1beta1.Coinrepeated
proposerstring

MsgSubmitProposalResponse

MsgSubmitProposalResponse defines the Msg/SubmitProposal response type.

FieldTypeLabelDescription
proposal_iduint64

MsgVote

MsgVote defines a message to cast a vote.

FieldTypeLabelDescription
proposal_iduint64
voterstring
optionVoteOption

MsgVoteResponse

MsgVoteResponse defines the Msg/Vote response type.

Msg

Msg defines the bank Msg service.

Method NameRequest TypeResponse TypeDescription
SubmitProposalMsgSubmitProposalMsgSubmitProposalResponseSubmitProposal defines a method to create new proposal given a content.
VoteMsgVoteMsgVoteResponseVote defines a method to add a vote on a specific proposal.
DepositMsgDepositMsgDepositResponseDeposit defines a method to add deposit on a specific proposal.

Top

cosmos/gov/v1beta1/gov.proto

Deposit

Deposit defines an amount deposited by an account address to an active proposal.

FieldTypeLabelDescription
proposal_iduint64
depositorstring
amountcosmos.base.v1beta1.Coinrepeated

DepositParams

DepositParams defines the params for deposits on governance proposals.

FieldTypeLabelDescription
min_depositcosmos.base.v1beta1.CoinrepeatedMinimum deposit for a proposal to enter voting period.
max_deposit_periodgoogle.protobuf.DurationMaximum period for Atom holders to deposit on a proposal. Initial value: 2 months.

Proposal

Proposal defines the core field members of a governance proposal.

FieldTypeLabelDescription
proposal_iduint64
contentgoogle.protobuf.Any
statusProposalStatus
final_tally_resultTallyResult
submit_timegoogle.protobuf.Timestamp
deposit_end_timegoogle.protobuf.Timestamp
total_depositcosmos.base.v1beta1.Coinrepeated
voting_start_timegoogle.protobuf.Timestamp
voting_end_timegoogle.protobuf.Timestamp

TallyParams

TallyParams defines the params for tallying votes on governance proposals.

FieldTypeLabelDescription
quorumbytesMinimum percentage of total stake needed to vote for a result to be considered valid.
thresholdbytesMinimum proportion of Yes votes for proposal to pass. Default value: 0.5.
veto_thresholdbytesMinimum value of Veto votes to Total votes ratio for proposal to be vetoed. Default value: 1/3.

TallyResult

TallyResult defines a standard tally for a governance proposal.

FieldTypeLabelDescription
yesstring
abstainstring
nostring
no_with_vetostring

TextProposal

TextProposal defines a standard text proposal whose changes need to be manually updated in case of approval.

FieldTypeLabelDescription
titlestring
descriptionstring

Vote

Vote defines a vote on a governance proposal. A Vote consists of a proposal ID, the voter, and the vote option.

FieldTypeLabelDescription
proposal_iduint64
voterstring
optionVoteOption

VotingParams

VotingParams defines the params for voting on governance proposals.

FieldTypeLabelDescription
voting_periodgoogle.protobuf.DurationLength of the voting period.

ProposalStatus

ProposalStatus enumerates the valid statuses of a proposal.

NameNumberDescription
PROPOSAL_STATUS_UNSPECIFIED0PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
PROPOSAL_STATUS_DEPOSIT_PERIOD1PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period.
PROPOSAL_STATUS_VOTING_PERIOD2PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
PROPOSAL_STATUS_PASSED3PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed.
PROPOSAL_STATUS_REJECTED4PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected.
PROPOSAL_STATUS_FAILED5PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.

VoteOption

VoteOption enumerates the valid vote options for a given governance proposal.

NameNumberDescription
VOTE_OPTION_UNSPECIFIED0VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
VOTE_OPTION_YES1VOTE_OPTION_YES defines a yes vote option.
VOTE_OPTION_ABSTAIN2VOTE_OPTION_ABSTAIN defines an abstain vote option.
VOTE_OPTION_NO3VOTE_OPTION_NO defines a no vote option.
VOTE_OPTION_NO_WITH_VETO4VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.

Top

cosmos/gov/v1beta1/query.proto

QueryDepositRequest

QueryDepositRequest is the request type for the Query/Deposit RPC method.

FieldTypeLabelDescription
proposal_iduint64proposal_id defines the unique id of the proposal.
depositorstringdepositor defines the deposit addresses from the proposals.

QueryDepositResponse

QueryDepositResponse is the response type for the Query/Deposit RPC method.

FieldTypeLabelDescription
depositDepositdeposit defines the requested deposit.

QueryDepositsRequest

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

FieldTypeLabelDescription
proposal_iduint64proposal_id defines the unique id of the proposal.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryDepositsResponse

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

FieldTypeLabelDescription
depositsDepositrepeated
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

QueryParamsRequest

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

FieldTypeLabelDescription
params_typestringparams_type defines which parameters to query for, can be one of "voting", "tallying" or "deposit".

QueryParamsResponse

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

FieldTypeLabelDescription
voting_paramsVotingParamsvoting_params defines the parameters related to voting.
deposit_paramsDepositParamsdeposit_params defines the parameters related to deposit.
tally_paramsTallyParamstally_params defines the parameters related to tally.

QueryProposalRequest

QueryProposalRequest is the request type for the Query/Proposal RPC method.

FieldTypeLabelDescription
proposal_iduint64proposal_id defines the unique id of the proposal.

QueryProposalResponse

QueryProposalResponse is the response type for the Query/Proposal RPC method.

FieldTypeLabelDescription
proposalProposal

QueryProposalsRequest

QueryProposalsRequest is the request type for the Query/Proposals RPC method.

FieldTypeLabelDescription
proposal_statusProposalStatusproposal_status defines the status of the proposals.
voterstringvoter defines the voter address for the proposals.
depositorstringdepositor defines the deposit addresses from the proposals.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryProposalsResponse

QueryProposalsResponse is the response type for the Query/Proposals RPC method.

FieldTypeLabelDescription
proposalsProposalrepeated
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

QueryTallyResultRequest

QueryTallyResultRequest is the request type for the Query/Tally RPC method.

FieldTypeLabelDescription
proposal_iduint64proposal_id defines the unique id of the proposal.

QueryTallyResultResponse

QueryTallyResultResponse is the response type for the Query/Tally RPC method.

FieldTypeLabelDescription
tallyTallyResulttally defines the requested tally.

QueryVoteRequest

QueryVoteRequest is the request type for the Query/Vote RPC method.

FieldTypeLabelDescription
proposal_iduint64proposal_id defines the unique id of the proposal.
voterstringvoter defines the oter address for the proposals.

QueryVoteResponse

QueryVoteResponse is the response type for the Query/Vote RPC method.

FieldTypeLabelDescription
voteVotevote defined the queried vote.

QueryVotesRequest

QueryVotesRequest is the request type for the Query/Votes RPC method.

FieldTypeLabelDescription
proposal_iduint64proposal_id defines the unique id of the proposal.
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryVotesResponse

QueryVotesResponse is the response type for the Query/Votes RPC method.

FieldTypeLabelDescription
votesVoterepeatedvotes defined the queried votes.
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

Query

Query defines the gRPC querier service for gov module

Method NameRequest TypeResponse TypeDescription
ProposalQueryProposalRequestQueryProposalResponseProposal queries proposal details based on ProposalID.
ProposalsQueryProposalsRequestQueryProposalsResponseProposals queries all proposals based on given status.
VoteQueryVoteRequestQueryVoteResponseVote queries voted information based on proposalID, voterAddr.
VotesQueryVotesRequestQueryVotesResponseVotes queries votes of a given proposal.
ParamsQueryParamsRequestQueryParamsResponseParams queries all parameters of the gov module.
DepositQueryDepositRequestQueryDepositResponseDeposit queries single deposit information based proposalID, depositAddr.
DepositsQueryDepositsRequestQueryDepositsResponseDeposits queries all deposits of a single proposal.
TallyResultQueryTallyResultRequestQueryTallyResultResponseTallyResult queries the tally of a proposal vote.

Top

cosmos/gov/v1beta1/genesis.proto

GenesisState

GenesisState defines the gov module's genesis state.

FieldTypeLabelDescription
starting_proposal_iduint64starting_proposal_id is the ID of the starting proposal.
depositsDepositrepeateddeposits defines all the deposits present at genesis.
votesVoterepeatedvotes defines all the votes present at genesis.
proposalsProposalrepeatedproposals defines all the proposals present at genesis.
deposit_paramsDepositParamsparams defines all the paramaters of related to deposit.
voting_paramsVotingParamsparams defines all the paramaters of related to voting.
tally_paramsTallyParamsparams defines all the paramaters of related to tally.

Top

ibc/core/types/v1/genesis.proto

GenesisState

GenesisState defines the ibc module's genesis state.

FieldTypeLabelDescription
client_genesisibc.core.client.v1.GenesisStateICS002 - Clients genesis state
connection_genesisibc.core.connection.v1.GenesisStateICS003 - Connections genesis state
channel_genesisibc.core.channel.v1.GenesisStateICS004 - Channel genesis state

Top

ibc/core/connection/v1/query.proto

QueryClientConnectionsRequest

QueryClientConnectionsRequest is the request type for the Query/ClientConnections RPC method

FieldTypeLabelDescription
client_idstringclient identifier associated with a connection

QueryClientConnectionsResponse

QueryClientConnectionsResponse is the response type for the Query/ClientConnections RPC method

FieldTypeLabelDescription
connection_pathsstringrepeatedslice of all the connection paths associated with a client.
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightibc.core.client.v1.Heightheight at which the proof was generated

QueryConnectionClientStateRequest

QueryConnectionClientStateRequest is the request type for the Query/ConnectionClientState RPC method

FieldTypeLabelDescription
connection_idstringconnection identifier

QueryConnectionClientStateResponse

QueryConnectionClientStateResponse is the response type for the Query/ConnectionClientState RPC method

FieldTypeLabelDescription
identified_client_stateibc.core.client.v1.IdentifiedClientStateclient state associated with the channel
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightibc.core.client.v1.Heightheight at which the proof was retrieved

QueryConnectionConsensusStateRequest

QueryConnectionConsensusStateRequest is the request type for the Query/ConnectionConsensusState RPC method

FieldTypeLabelDescription
connection_idstringconnection identifier
version_numberuint64
version_heightuint64

QueryConnectionConsensusStateResponse

QueryConnectionConsensusStateResponse is the response type for the Query/ConnectionConsensusState RPC method

FieldTypeLabelDescription
consensus_stategoogle.protobuf.Anyconsensus state associated with the channel
client_idstringclient ID associated with the consensus state
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightibc.core.client.v1.Heightheight at which the proof was retrieved

QueryConnectionRequest

QueryConnectionRequest is the request type for the Query/Connection RPC method

FieldTypeLabelDescription
connection_idstringconnection unique identifier

QueryConnectionResponse

QueryConnectionResponse is the response type for the Query/Connection RPC method. Besides the connection end, it includes a proof and the height from which the proof was retrieved.

FieldTypeLabelDescription
connectionConnectionEndconnection associated with the request identifier
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightibc.core.client.v1.Heightheight at which the proof was retrieved

QueryConnectionsRequest

QueryConnectionsRequest is the request type for the Query/Connections RPC method

FieldTypeLabelDescription
paginationcosmos.base.query.v1beta1.PageRequest

QueryConnectionsResponse

QueryConnectionsResponse is the response type for the Query/Connections RPC method.

FieldTypeLabelDescription
connectionsIdentifiedConnectionrepeatedlist of stored connections of the chain.
paginationcosmos.base.query.v1beta1.PageResponsepagination response
heightibc.core.client.v1.Heightquery block height

Query

Query provides defines the gRPC querier service

Method NameRequest TypeResponse TypeDescription
ConnectionQueryConnectionRequestQueryConnectionResponseConnection queries an IBC connection end.
ConnectionsQueryConnectionsRequestQueryConnectionsResponseConnections queries all the IBC connections of a chain.
ClientConnectionsQueryClientConnectionsRequestQueryClientConnectionsResponseClientConnections queries the connection paths associated with a client state.
ConnectionClientStateQueryConnectionClientStateRequestQueryConnectionClientStateResponseConnectionClientState queries the client state associated with the connection.
ConnectionConsensusStateQueryConnectionConsensusStateRequestQueryConnectionConsensusStateResponseConnectionConsensusState queries the consensus state associated with the connection.

Top

ibc/core/connection/v1/connection.proto

ClientPaths

ClientPaths define all the connection paths for a client state.

FieldTypeLabelDescription
pathsstringrepeatedlist of connection paths

ConnectionEnd

ConnectionEnd defines a stateful object on a chain connected to another separate one. NOTE: there must only be 2 defined ConnectionEnds to establish a connection between two chains.

FieldTypeLabelDescription
client_idstringclient associated with this connection.
versionsstringrepeatedIBC version which can be utilised to determine encodings or protocols for channels or packets utilising this connection
stateStatecurrent state of the connection end.
counterpartyCounterpartycounterparty chain associated with this connection.

ConnectionPaths

ConnectionPaths define all the connection paths for a given client state.

FieldTypeLabelDescription
client_idstringclient state unique identifier
pathsstringrepeatedlist of connection paths

Counterparty

Counterparty defines the counterparty chain associated with a connection end.

FieldTypeLabelDescription
client_idstringidentifies the client on the counterparty chain associated with a given connection.
connection_idstringidentifies the connection end on the counterparty chain associated with a given connection.
prefixibc.core.commitment.v1.MerklePrefixcommitment merkle prefix of the counterparty chain

IdentifiedConnection

IdentifiedConnection defines a connection with additional connection identifier field.

FieldTypeLabelDescription
idstringconnection identifier.
client_idstringclient associated with this connection.
versionsstringrepeatedIBC version which can be utilised to determine encodings or protocols for channels or packets utilising this connection
stateStatecurrent state of the connection end.
counterpartyCounterpartycounterparty chain associated with this connection.

MsgConnectionOpenAck

MsgConnectionOpenAck defines a msg sent by a Relayer to Chain A to acknowledge the change of connection state to TRYOPEN on Chain B.

FieldTypeLabelDescription
connection_idstring
counterparty_connection_idstring
versionstring
client_stategoogle.protobuf.Any
proof_heightibc.core.client.v1.Height
proof_trybytesproof of the initialization the connection on Chain B: UNITIALIZED -> TRYOPEN
proof_clientbytesproof of client state included in message
proof_consensusbytesproof of client consensus state
consensus_heightibc.core.client.v1.Height
signerstring

MsgConnectionOpenAckResponse

MsgConnectionOpenAckResponse defines the Msg/ConnectionOpenAck response type.

MsgConnectionOpenConfirm

MsgConnectionOpenConfirm defines a msg sent by a Relayer to Chain B to acknowledge the change of connection state to OPEN on Chain A.

FieldTypeLabelDescription
connection_idstring
proof_ackbytesproof for the change of the connection state on Chain A: INIT -> OPEN
proof_heightibc.core.client.v1.Height
signerstring

MsgConnectionOpenConfirmResponse

MsgConnectionOpenConfirmResponse defines the Msg/ConnectionOpenConfirm response type.

MsgConnectionOpenInit

MsgConnectionOpenInit defines the msg sent by an account on Chain A to initialize a connection with Chain B.

FieldTypeLabelDescription
client_idstring
connection_idstring
counterpartyCounterparty
versionstring
signerstring

MsgConnectionOpenInitResponse

MsgConnectionOpenInitResponse defines the Msg/ConnectionOpenInit response type.

MsgConnectionOpenTry

MsgConnectionOpenTry defines a msg sent by a Relayer to try to open a connection on Chain B.

FieldTypeLabelDescription
client_idstring
desired_connection_idstring
counterparty_chosen_connection_idstring
client_stategoogle.protobuf.Any
counterpartyCounterparty
counterparty_versionsstringrepeated
proof_heightibc.core.client.v1.Height
proof_initbytesproof of the initialization the connection on Chain A: UNITIALIZED -> INIT
proof_clientbytesproof of client state included in message
proof_consensusbytesproof of client consensus state
consensus_heightibc.core.client.v1.Height
signerstring

MsgConnectionOpenTryResponse

MsgConnectionOpenTryResponse defines the Msg/ConnectionOpenTry response type.

Version

Version defines the versioning scheme used to negotiate the IBC verison in the connection handshake.

FieldTypeLabelDescription
identifierstringunique version identifier
featuresstringrepeatedlist of features compatible with the specified identifier

State

State defines if a connection is in one of the following states: INIT, TRYOPEN, OPEN or UNINITIALIZED.

NameNumberDescription
STATE_UNINITIALIZED_UNSPECIFIED0Default State
STATE_INIT1A connection end has just started the opening handshake.
STATE_TRYOPEN2A connection end has acknowledged the handshake step on the counterparty chain.
STATE_OPEN3A connection end has completed the handshake.

Msg

Msg defines the ibc/connection Msg service.

Method NameRequest TypeResponse TypeDescription
ConnectionOpenInitMsgConnectionOpenInitMsgConnectionOpenInitResponseConnectionOpenInit defines a rpc handler method for MsgConnectionOpenInit.
ConnectionOpenTryMsgConnectionOpenTryMsgConnectionOpenTryResponseConnectionOpenTry defines a rpc handler method for MsgConnectionOpenTry.
ConnectionOpenAckMsgConnectionOpenAckMsgConnectionOpenAckResponseConnectionOpenAck defines a rpc handler method for MsgConnectionOpenAck.
ConnectionOpenConfirmMsgConnectionOpenConfirmMsgConnectionOpenConfirmResponseConnectionOpenConfirm defines a rpc handler method for MsgConnectionOpenConfirm.

Top

ibc/core/connection/v1/genesis.proto

GenesisState

GenesisState defines the ibc connection submodule's genesis state.

FieldTypeLabelDescription
connectionsIdentifiedConnectionrepeated
client_connection_pathsConnectionPathsrepeated

Top

ibc/core/commitment/v1/commitment.proto

Key

Key defines a proof Key

FieldTypeLabelDescription
namebytes
encKeyEncoding

KeyPath

KeyPath defines a slice of keys

FieldTypeLabelDescription
keysKeyrepeated

MerklePath

MerklePath is the path used to verify commitment proofs, which can be an arbitrary structured object (defined by a commitment type).

FieldTypeLabelDescription
key_pathKeyPath

MerklePrefix

MerklePrefix is merkle path prefixed to the key. The constructed key from the Path and the key will be append(Path.KeyPath, append(Path.KeyPrefix, key…))

FieldTypeLabelDescription
key_prefixbytes

MerkleProof

MerkleProof is a wrapper type that contains a merkle proof. It demonstrates membership or non-membership for an element or set of elements, verifiable in conjunction with a known commitment root. Proofs should be succinct.

FieldTypeLabelDescription
prooftendermint.crypto.ProofOps

MerkleRoot

MerkleRoot defines a merkle root hash. In the Cosmos SDK, the AppHash of a block header becomes the root.

FieldTypeLabelDescription
hashbytes

KeyEncoding

KeyEncoding defines the encoding format of a key's bytes.

NameNumberDescription
KEY_ENCODING_URL_UNSPECIFIED0URL encoding
KEY_ENCODING_HEX1Hex encoding

Top

ibc/core/channel/v1/query.proto

QueryChannelClientStateRequest

QueryChannelClientStateRequest is the request type for the Query/ClientState RPC method

FieldTypeLabelDescription
port_idstringport unique identifier
channel_idstringchannel unique identifier

QueryChannelClientStateResponse

QueryChannelClientStateResponse is the Response type for the Query/QueryChannelClientState RPC method

FieldTypeLabelDescription
identified_client_stateibc.core.client.v1.IdentifiedClientStateclient state associated with the channel
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightibc.core.client.v1.Heightheight at which the proof was retrieved

QueryChannelConsensusStateRequest

QueryChannelConsensusStateRequest is the request type for the Query/ConsensusState RPC method

FieldTypeLabelDescription
port_idstringport unique identifier
channel_idstringchannel unique identifier
version_numberuint64version number of the consensus state
version_heightuint64version height of the consensus state

QueryChannelConsensusStateResponse

QueryChannelClientStateResponse is the Response type for the Query/QueryChannelClientState RPC method

FieldTypeLabelDescription
consensus_stategoogle.protobuf.Anyconsensus state associated with the channel
client_idstringclient ID associated with the consensus state
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightibc.core.client.v1.Heightheight at which the proof was retrieved

QueryChannelRequest

QueryChannelRequest is the request type for the Query/Channel RPC method

FieldTypeLabelDescription
port_idstringport unique identifier
channel_idstringchannel unique identifier

QueryChannelResponse

QueryChannelResponse is the response type for the Query/Channel RPC method. Besides the Channel end, it includes a proof and the height from which the proof was retrieved.

FieldTypeLabelDescription
channelChannelchannel associated with the request identifiers
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightibc.core.client.v1.Heightheight at which the proof was retrieved

QueryChannelsRequest

QueryChannelsRequest is the request type for the Query/Channels RPC method

FieldTypeLabelDescription
paginationcosmos.base.query.v1beta1.PageRequestpagination request

QueryChannelsResponse

QueryChannelsResponse is the response type for the Query/Channels RPC method.

FieldTypeLabelDescription
channelsIdentifiedChannelrepeatedlist of stored channels of the chain.
paginationcosmos.base.query.v1beta1.PageResponsepagination response
heightibc.core.client.v1.Heightquery block height

QueryConnectionChannelsRequest

QueryConnectionChannelsRequest is the request type for the Query/QueryConnectionChannels RPC method

FieldTypeLabelDescription
connectionstringconnection unique identifier
paginationcosmos.base.query.v1beta1.PageRequestpagination request

QueryConnectionChannelsResponse

QueryConnectionChannelsResponse is the Response type for the Query/QueryConnectionChannels RPC method

FieldTypeLabelDescription
channelsIdentifiedChannelrepeatedlist of channels associated with a connection.
paginationcosmos.base.query.v1beta1.PageResponsepagination response
heightibc.core.client.v1.Heightquery block height

QueryNextSequenceReceiveRequest

QueryNextSequenceReceiveRequest is the request type for the Query/QueryNextSequenceReceiveRequest RPC method

FieldTypeLabelDescription
port_idstringport unique identifier
channel_idstringchannel unique identifier

QueryNextSequenceReceiveResponse

QuerySequenceResponse is the request type for the Query/QueryNextSequenceReceiveResponse RPC method

FieldTypeLabelDescription
next_sequence_receiveuint64next sequence receive number
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightibc.core.client.v1.Heightheight at which the proof was retrieved

QueryPacketAcknowledgementRequest

QueryPacketAcknowledgementRequest is the request type for the Query/PacketAcknowledgement RPC method

FieldTypeLabelDescription
port_idstringport unique identifier
channel_idstringchannel unique identifier
sequenceuint64packet sequence

QueryPacketAcknowledgementResponse

QueryPacketAcknowledgementResponse defines the client query response for a packet which also includes a proof, its path and the height form which the proof was retrieved

FieldTypeLabelDescription
acknowledgementbytespacket associated with the request fields
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightibc.core.client.v1.Heightheight at which the proof was retrieved

QueryPacketCommitmentRequest

QueryPacketCommitmentRequest is the request type for the Query/PacketCommitment RPC method

FieldTypeLabelDescription
port_idstringport unique identifier
channel_idstringchannel unique identifier
sequenceuint64packet sequence

QueryPacketCommitmentResponse

QueryPacketCommitmentResponse defines the client query response for a packet which also includes a proof, its path and the height form which the proof was retrieved

FieldTypeLabelDescription
commitmentbytespacket associated with the request fields
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightibc.core.client.v1.Heightheight at which the proof was retrieved

QueryPacketCommitmentsRequest

QueryPacketCommitmentsRequest is the request type for the Query/QueryPacketCommitments RPC method

FieldTypeLabelDescription
port_idstringport unique identifier
channel_idstringchannel unique identifier
paginationcosmos.base.query.v1beta1.PageRequestpagination request

QueryPacketCommitmentsResponse

QueryPacketCommitmentsResponse is the request type for the Query/QueryPacketCommitments RPC method

FieldTypeLabelDescription
commitmentsPacketAckCommitmentrepeated
paginationcosmos.base.query.v1beta1.PageResponsepagination response
heightibc.core.client.v1.Heightquery block height

QueryUnreceivedPacketsRequest

QueryUnreceivedPacketsRequest is the request type for the Query/UnreceivedPackets RPC method

FieldTypeLabelDescription
port_idstringport unique identifier
channel_idstringchannel unique identifier
packet_commitment_sequencesuint64repeatedlist of packet sequences

QueryUnreceivedPacketsResponse

QueryUnreceivedPacketsResponse is the response type for the Query/UnreceivedPacketCommitments RPC method

FieldTypeLabelDescription
sequencesuint64repeatedlist of unreceived packet sequences
heightibc.core.client.v1.Heightquery block height

QueryUnrelayedAcksRequest

QueryUnrelayedAcksRequest is the request type for the Query/UnrelayedAcks RPC method

FieldTypeLabelDescription
port_idstringport unique identifier
channel_idstringchannel unique identifier
packet_commitment_sequencesuint64repeatedlist of commitment sequences

QueryUnrelayedAcksResponse

QueryUnrelayedAcksResponse is the response type for the Query/UnrelayedAcks RPC method

FieldTypeLabelDescription
sequencesuint64repeatedlist of unrelayed acknowledgement sequences
heightibc.core.client.v1.Heightquery block height

Query

Query provides defines the gRPC querier service

Method NameRequest TypeResponse TypeDescription
ChannelQueryChannelRequestQueryChannelResponseChannel queries an IBC Channel.
ChannelsQueryChannelsRequestQueryChannelsResponseChannels queries all the IBC channels of a chain.
ConnectionChannelsQueryConnectionChannelsRequestQueryConnectionChannelsResponseConnectionChannels queries all the channels associated with a connection end.
ChannelClientStateQueryChannelClientStateRequestQueryChannelClientStateResponseChannelClientState queries for the client state for the channel associated with the provided channel identifiers.
ChannelConsensusStateQueryChannelConsensusStateRequestQueryChannelConsensusStateResponseChannelConsensusState queries for the consensus state for the channel associated with the provided channel identifiers.
PacketCommitmentQueryPacketCommitmentRequestQueryPacketCommitmentResponsePacketCommitment queries a stored packet commitment hash.
PacketCommitmentsQueryPacketCommitmentsRequestQueryPacketCommitmentsResponsePacketCommitments returns the all the packet commitments hashes associated with a channel.
PacketAcknowledgementQueryPacketAcknowledgementRequestQueryPacketAcknowledgementResponsePacketAcknowledgement queries a stored packet acknowledgement hash.
UnreceivedPacketsQueryUnreceivedPacketsRequestQueryUnreceivedPacketsResponseUnreceivedPackets returns all the unrelayed IBC packets associated with a channel and sequences.
UnrelayedAcksQueryUnrelayedAcksRequestQueryUnrelayedAcksResponseUnrelayedAcks returns all the unrelayed IBC acknowledgements associated with a channel and sequences.
NextSequenceReceiveQueryNextSequenceReceiveRequestQueryNextSequenceReceiveResponseNextSequenceReceive returns the next receive sequence for a given channel.

Top

ibc/core/channel/v1/genesis.proto

GenesisState

GenesisState defines the ibc channel submodule's genesis state.

FieldTypeLabelDescription
channelsIdentifiedChannelrepeated
acknowledgementsPacketAckCommitmentrepeated
commitmentsPacketAckCommitmentrepeated
send_sequencesPacketSequencerepeated
recv_sequencesPacketSequencerepeated
ack_sequencesPacketSequencerepeated

PacketSequence

PacketSequence defines the genesis type necessary to retrieve and store next send and receive sequences.

FieldTypeLabelDescription
port_idstring
channel_idstring
sequenceuint64

Top

ibc/core/channel/v1/channel.proto

Acknowledgement

Acknowledgement is the recommended acknowledgement format to be used by app-specific protocols. NOTE: The field numbers 21 and 22 were explicitly chosen to avoid accidental conflicts with other protobuf message formats used for acknowledgements. The first byte of any message with this format will be the non-ASCII values 0xaa (result) or 0xb2 (error). Implemented as defined by ICS: https://github.com/cosmos/ics/tree/master/spec/ics-004-channel-and-packet-semantics#acknowledgement-envelope

FieldTypeLabelDescription
resultbytes
errorstring

Channel

Channel defines pipeline for exactly-once packet delivery between specific modules on separate blockchains, which has at least one end capable of sending packets and one end capable of receiving packets.

FieldTypeLabelDescription
stateStatecurrent state of the channel end
orderingOrderwhether the channel is ordered or unordered
counterpartyCounterpartycounterparty channel end
connection_hopsstringrepeatedlist of connection identifiers, in order, along which packets sent on this channel will travel
versionstringopaque channel version, which is agreed upon during the handshake

Counterparty

Counterparty defines a channel end counterparty

FieldTypeLabelDescription
port_idstringport on the counterparty chain which owns the other end of the channel.
channel_idstringchannel end on the counterparty chain

IdentifiedChannel

IdentifiedChannel defines a channel with additional port and channel identifier fields.

FieldTypeLabelDescription
stateStatecurrent state of the channel end
orderingOrderwhether the channel is ordered or unordered
counterpartyCounterpartycounterparty channel end
connection_hopsstringrepeatedlist of connection identifiers, in order, along which packets sent on this channel will travel
versionstringopaque channel version, which is agreed upon during the handshake
port_idstringport identifier
channel_idstringchannel identifier

MsgAcknowledgement

MsgAcknowledgement receives incoming IBC acknowledgement

FieldTypeLabelDescription
packetPacket
acknowledgementbytes
proofbytes
proof_heightibc.core.client.v1.Height
signerstring

MsgAcknowledgementResponse

MsgAcknowledgementResponse defines the Msg/Acknowledgement response type.

MsgChannelCloseConfirm

MsgChannelCloseConfirm defines a msg sent by a Relayer to Chain B to acknowledge the change of channel state to CLOSED on Chain A.

FieldTypeLabelDescription
port_idstring
channel_idstring
proof_initbytes
proof_heightibc.core.client.v1.Height
signerstring

MsgChannelCloseConfirmResponse

MsgChannelCloseConfirmResponse defines the Msg/ChannelCloseConfirm response type.

MsgChannelCloseInit

MsgChannelCloseInit defines a msg sent by a Relayer to Chain A to close a channel with Chain B.

FieldTypeLabelDescription
port_idstring
channel_idstring
signerstring

MsgChannelCloseInitResponse

MsgChannelCloseInitResponse defines the Msg/ChannelCloseInit response type.

MsgChannelOpenAck

MsgChannelOpenAck defines a msg sent by a Relayer to Chain A to acknowledge the change of channel state to TRYOPEN on Chain B.

FieldTypeLabelDescription
port_idstring
channel_idstring
counterparty_channel_idstring
counterparty_versionstring
proof_trybytes
proof_heightibc.core.client.v1.Height
signerstring

MsgChannelOpenAckResponse

MsgChannelOpenAckResponse defines the Msg/ChannelOpenAck response type.

MsgChannelOpenConfirm

MsgChannelOpenConfirm defines a msg sent by a Relayer to Chain B to acknowledge the change of channel state to OPEN on Chain A.

FieldTypeLabelDescription
port_idstring
channel_idstring
proof_ackbytes
proof_heightibc.core.client.v1.Height
signerstring

MsgChannelOpenConfirmResponse

MsgChannelOpenConfirmResponse defines the Msg/ChannelOpenConfirm response type.

MsgChannelOpenInit

MsgChannelOpenInit defines an sdk.Msg to initialize a channel handshake. It is called by a relayer on Chain A.

FieldTypeLabelDescription
port_idstring
channel_idstring
channelChannel
signerstring

MsgChannelOpenInitResponse

MsgChannelOpenInitResponse defines the Msg/ChannelOpenInit response type.

MsgChannelOpenTry

MsgChannelOpenInit defines a msg sent by a Relayer to try to open a channel on Chain B.

FieldTypeLabelDescription
port_idstring
desired_channel_idstring
counterparty_chosen_channel_idstring
channelChannel
counterparty_versionstring
proof_initbytes
proof_heightibc.core.client.v1.Height
signerstring

MsgChannelOpenTryResponse

MsgChannelOpenTryResponse defines the Msg/ChannelOpenTry response type.

MsgRecvPacket

MsgRecvPacket receives incoming IBC packet

FieldTypeLabelDescription
packetPacket
proofbytes
proof_heightibc.core.client.v1.Height
signerstring

MsgRecvPacketResponse

MsgRecvPacketResponse defines the Msg/RecvPacket response type.

MsgTimeout

MsgTimeout receives timed-out packet

FieldTypeLabelDescription
packetPacket
proofbytes
proof_heightibc.core.client.v1.Height
next_sequence_recvuint64
signerstring

MsgTimeoutOnClose

MsgTimeoutOnClose timed-out packet upon counterparty channel closure.

FieldTypeLabelDescription
packetPacket
proofbytes
proof_closebytes
proof_heightibc.core.client.v1.Height
next_sequence_recvuint64
signerstring

MsgTimeoutOnCloseResponse

MsgTimeoutOnCloseResponse defines the Msg/TimeoutOnClose response type.

MsgTimeoutResponse

MsgTimeoutResponse defines the Msg/Timeout response type.

Packet

Packet defines a type that carries data across different chains through IBC

FieldTypeLabelDescription
sequenceuint64number corresponds to the order of sends and receives, where a Packet with an earlier sequence number must be sent and received before a Packet with a later sequence number.
source_portstringidentifies the port on the sending chain.
source_channelstringidentifies the channel end on the sending chain.
destination_portstringidentifies the port on the receiving chain.
destination_channelstringidentifies the channel end on the receiving chain.
databytesactual opaque bytes transferred directly to the application module
timeout_heightibc.core.client.v1.Heightblock height after which the packet times out
timeout_timestampuint64block timestamp (in nanoseconds) after which the packet times out

PacketAckCommitment

PacketAckCommitment defines the genesis type necessary to retrieve and store acknowlegements.

FieldTypeLabelDescription
port_idstringchannel port identifier.
channel_idstringchannel unique identifier.
sequenceuint64packet sequence.
hashbytespacket commitment hash.

Order

Order defines if a channel is ORDERED or UNORDERED

NameNumberDescription
ORDER_NONE_UNSPECIFIED0zero-value for channel ordering
ORDER_UNORDERED1packets can be delivered in any order, which may differ from the order in which they were sent.
ORDER_ORDERED2packets are delivered exactly in the order which they were sent

State

State defines if a channel is in one of the following states: CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.

NameNumberDescription
STATE_UNINITIALIZED_UNSPECIFIED0Default State
STATE_INIT1A channel has just started the opening handshake.
STATE_TRYOPEN2A channel has acknowledged the handshake step on the counterparty chain.
STATE_OPEN3A channel has completed the handshake. Open channels are ready to send and receive packets.
STATE_CLOSED4A channel has been closed and can no longer be used to send or receive packets.

Msg

Msg defines the ibc/channel Msg service.

Method NameRequest TypeResponse TypeDescription
ChannelOpenInitMsgChannelOpenInitMsgChannelOpenInitResponseChannelOpenInit defines a rpc handler method for MsgChannelOpenInit.
ChannelOpenTryMsgChannelOpenTryMsgChannelOpenTryResponseChannelOpenTry defines a rpc handler method for MsgChannelOpenTry.
ChannelOpenAckMsgChannelOpenAckMsgChannelOpenAckResponseChannelOpenAck defines a rpc handler method for MsgChannelOpenAck.
ChannelOpenConfirmMsgChannelOpenConfirmMsgChannelOpenConfirmResponseChannelOpenConfirm defines a rpc handler method for MsgChannelOpenConfirm.
ChannelCloseInitMsgChannelCloseInitMsgChannelCloseInitResponseChannelCloseInit defines a rpc handler method for MsgChannelCloseInit.
ChannelCloseConfirmMsgChannelCloseConfirmMsgChannelCloseConfirmResponseChannelCloseConfirm defines a rpc handler method for MsgChannelCloseConfirm.
RecvPacketMsgRecvPacketMsgRecvPacketResponseRecvPacket defines a rpc handler method for MsgRecvPacket.
TimeoutMsgTimeoutMsgTimeoutResponseTimeout defines a rpc handler method for MsgTimeout.
TimeoutOnCloseMsgTimeoutOnCloseMsgTimeoutOnCloseResponseTimeoutOnClose defines a rpc handler method for MsgTimeoutOnClose.
AcknowledgementMsgAcknowledgementMsgAcknowledgementResponseAcknowledgement defines a rpc handler method for MsgAcknowledgement.

Top

ibc/core/client/v1/client.proto

ClientConsensusStates

ClientConsensusStates defines all the stored consensus states for a given client.

FieldTypeLabelDescription
client_idstringclient identifier
consensus_statesConsensusStateWithHeightrepeatedconsensus states and their heights associated with the client

ClientUpdateProposal

ClientUpdateProposal is a governance proposal. If it passes, the client is updated with the provided header. The update may fail if the header is not valid given certain conditions specified by the client implementation.

FieldTypeLabelDescription
titlestringthe title of the update proposal
descriptionstringthe description of the proposal
client_idstringthe client identifier for the client to be updated if the proposal passes
headergoogle.protobuf.Anythe header used to update the client if the proposal passes

ConsensusStateWithHeight

ConsensusStateWithHeight defines a consensus state with an additional height field.

FieldTypeLabelDescription
heightHeightconsensus state height
consensus_stategoogle.protobuf.Anyconsensus state

Height

Height is a monotonically increasing data type that can be compared against another Height for the purposes of updating and freezing clients

Normally the VersionHeight is incremented at each height while keeping version number the same However some consensus algorithms may choose to reset the height in certain conditions e.g. hard forks, state-machine breaking changes In these cases, the version number is incremented so that height continues to be monitonically increasing even as the VersionHeight gets reset

FieldTypeLabelDescription
version_numberuint64the version that the client is currently on
version_heightuint64the height within the given version

IdentifiedClientState

IdentifiedClientState defines a client state with an additional client identifier field.

FieldTypeLabelDescription
client_idstringclient identifier
client_stategoogle.protobuf.Anyclient state

MsgCreateClient

MsgCreateClient defines a message to create an IBC client

FieldTypeLabelDescription
client_idstringclient unique identifier
client_stategoogle.protobuf.Anylight client state
consensus_stategoogle.protobuf.Anyconsensus state associated with the client that corresponds to a given height.
signerstringsigner address

MsgCreateClientResponse

MsgCreateClientResponse defines the Msg/CreateClient response type.

MsgSubmitMisbehaviour

MsgSubmitMisbehaviour defines an sdk.Msg type that submits Evidence for light client misbehaviour.

FieldTypeLabelDescription
client_idstringclient unique identifier
misbehaviourgoogle.protobuf.Anymisbehaviour used for freezing the light client
signerstringsigner address

MsgSubmitMisbehaviourResponse

MsgSubmitMisbehaviourResponse defines the Msg/SubmitMisbehaviour response type.

MsgUpdateClient

MsgUpdateClient defines an sdk.Msg to update a IBC client state using the given header.

FieldTypeLabelDescription
client_idstringclient unique identifier
headergoogle.protobuf.Anyheader to update the light client
signerstringsigner address

MsgUpdateClientResponse

MsgUpdateClientResponse defines the Msg/UpdateClient response type.

MsgUpgradeClient

MsgUpgradeClient defines an sdk.Msg to upgrade an IBC client to a new client state

FieldTypeLabelDescription
client_idstringclient unique identifier
client_stategoogle.protobuf.Anyupgraded client state
upgrade_heightHeightheight at which old chain halts and upgrades (i.e last block executed)
proof_upgradebytesproof that old chain committed to new client
signerstringsigner address

MsgUpgradeClientResponse

MsgUpgradeClientResponse defines the Msg/UpgradeClient response type.

Msg

Msg defines the ibc/client Msg service.

Method NameRequest TypeResponse TypeDescription
CreateClientMsgCreateClientMsgCreateClientResponseCreateClient defines a rpc handler method for MsgCreateClient.
UpdateClientMsgUpdateClientMsgUpdateClientResponseUpdateClient defines a rpc handler method for MsgUpdateClient.
UpgradeClientMsgUpgradeClientMsgUpgradeClientResponseUpgradeClient defines a rpc handler method for MsgUpgradeClient.
SubmitMisbehaviourMsgSubmitMisbehaviourMsgSubmitMisbehaviourResponseSubmitMisbehaviour defines a rpc handler method for MsgSubmitMisbehaviour.

Top

ibc/core/client/v1/query.proto

QueryClientStateRequest

QueryClientStateRequest is the request type for the Query/ClientState RPC method

FieldTypeLabelDescription
client_idstringclient state unique identifier

QueryClientStateResponse

QueryClientStateResponse is the response type for the Query/ClientState RPC method. Besides the client state, it includes a proof and the height from which the proof was retrieved.

FieldTypeLabelDescription
client_stategoogle.protobuf.Anyclient state associated with the request identifier
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightHeightheight at which the proof was retrieved

QueryClientStatesRequest

QueryClientStatesRequest is the request type for the Query/ClientStates RPC method

FieldTypeLabelDescription
paginationcosmos.base.query.v1beta1.PageRequestpagination request

QueryClientStatesResponse

QueryClientStatesResponse is the response type for the Query/ClientStates RPC method.

FieldTypeLabelDescription
client_statesIdentifiedClientStaterepeatedlist of stored ClientStates of the chain.
paginationcosmos.base.query.v1beta1.PageResponsepagination response

QueryConsensusStateRequest

QueryConsensusStateRequest is the request type for the Query/ConsensusState RPC method. Besides the consensus state, it includes a proof and the height from which the proof was retrieved.

FieldTypeLabelDescription
client_idstringclient identifier
version_numberuint64consensus state version number
version_heightuint64consensus state version height
latest_heightboollatest_height overrrides the height field and queries the latest stored ConsensusState

QueryConsensusStateResponse

QueryConsensusStateResponse is the response type for the Query/ConsensusState RPC method

FieldTypeLabelDescription
consensus_stategoogle.protobuf.Anyconsensus state associated with the client identifier at the given height
proofbytesmerkle proof of existence
proof_pathstringmerkle proof path
proof_heightHeightheight at which the proof was retrieved

QueryConsensusStatesRequest

QueryConsensusStatesRequest is the request type for the Query/ConsensusStates RPC method.

FieldTypeLabelDescription
client_idstringclient identifier
paginationcosmos.base.query.v1beta1.PageRequestpagination request

QueryConsensusStatesResponse

QueryConsensusStatesResponse is the response type for the Query/ConsensusStates RPC method

FieldTypeLabelDescription
consensus_statesConsensusStateWithHeightrepeatedconsensus states associated with the identifier
paginationcosmos.base.query.v1beta1.PageResponsepagination response

Query

Query provides defines the gRPC querier service

Method NameRequest TypeResponse TypeDescription
ClientStateQueryClientStateRequestQueryClientStateResponseClientState queries an IBC light client.
ClientStatesQueryClientStatesRequestQueryClientStatesResponseClientStates queries all the IBC light clients of a chain.
ConsensusStateQueryConsensusStateRequestQueryConsensusStateResponseConsensusState queries a consensus state associated with a client state at a given height.
ConsensusStatesQueryConsensusStatesRequestQueryConsensusStatesResponseConsensusStates queries all the consensus state associated with a given client.

Top

ibc/core/client/v1/genesis.proto

GenesisState

GenesisState defines the ibc client submodule's genesis state.

FieldTypeLabelDescription
clientsIdentifiedClientStaterepeatedclient states with their corresponding identifiers
clients_consensusClientConsensusStatesrepeatedconsensus states from each client
create_localhostboolcreate localhost on initialization

Top

ibc/lightclients/solomachine/v1/solomachine.proto

ChannelStateData

ChannelStateData returns the SignBytes data for channel state verification.

FieldTypeLabelDescription
pathbytes
channelibc.core.channel.v1.Channel

ClientState

ClientState defines a solo machine client that tracks the current consensus state and if the client is frozen.

FieldTypeLabelDescription
sequenceuint64latest sequence of the client state
frozen_sequenceuint64frozen sequence of the solo machine
consensus_stateConsensusState
allow_update_after_proposalboolwhen set to true, will allow governance to update a solo machine client. The client will be unfrozen if it is frozen.

ClientStateData

ClientStateData returns the SignBytes data for client state verification.

FieldTypeLabelDescription
pathbytes
client_stategoogle.protobuf.Any

ConnectionStateData

ConnectionStateData returns the SignBytes data for connection state verification.

FieldTypeLabelDescription
pathbytes
connectionibc.core.connection.v1.ConnectionEnd

ConsensusState

ConsensusState defines a solo machine consensus state. The sequence of a consensus state is contained in the "height" key used in storing the consensus state.

FieldTypeLabelDescription
public_keygoogle.protobuf.Anypublic key of the solo machine
diversifierstringdiversifier allows the same public key to be re-used across different solo machine clients (potentially on different chains) without being considered misbehaviour.
timestampuint64

ConsensusStateData

ConsensusStateData returns the SignBytes data for consensus state verification.

FieldTypeLabelDescription
pathbytes
consensus_stategoogle.protobuf.Any

Header defines a solo machine consensus header

FieldTypeLabelDescription
sequenceuint64sequence to update solo machine public key at
timestampuint64
signaturebytes
new_public_keygoogle.protobuf.Any
new_diversifierstring

HeaderData

HeaderData returns the SignBytes data for update verification.

FieldTypeLabelDescription
new_pub_keygoogle.protobuf.Anyheader public key
new_diversifierstringheader diversifier

Misbehaviour

Misbehaviour defines misbehaviour for a solo machine which consists of a sequence and two signatures over different messages at that sequence.

FieldTypeLabelDescription
client_idstring
sequenceuint64
signature_oneSignatureAndData
signature_twoSignatureAndData

NextSequenceRecvData

NextSequenceRecvData returns the SignBytes data for verification of the next sequence to be received.

FieldTypeLabelDescription
pathbytes
next_seq_recvuint64

PacketAcknowledgementData

PacketAcknowledgementData returns the SignBytes data for acknowledgement verification.

FieldTypeLabelDescription
pathbytes
acknowledgementbytes

PacketCommitmentData

PacketCommitmentData returns the SignBytes data for packet commitment verification.

FieldTypeLabelDescription
pathbytes
commitmentbytes

PacketReceiptAbsenceData

PacketReceiptAbsenceData returns the SignBytes data for packet receipt absence verification.

FieldTypeLabelDescription
pathbytes

SignBytes

SignBytes defines the signed bytes used for signature verification.

FieldTypeLabelDescription
sequenceuint64
timestampuint64
diversifierstring
data_typeDataTypetype of the data used
databytesmarshaled data

SignatureAndData

SignatureAndData contains a signature and the data signed over to create that signature.

FieldTypeLabelDescription
signaturebytes
data_typeDataType
databytes
timestampuint64

TimestampedSignatureData

TimestampedSignatureData contains the signature data and the timestamp of the signature.

FieldTypeLabelDescription
signature_databytes
timestampuint64

DataType

DataType defines the type of solo machine proof being created. This is done to preserve uniqueness of different data sign byte encodings.

NameNumberDescription
DATA_TYPE_UNINITIALIZED_UNSPECIFIED0Default State
DATA_TYPE_CLIENT_STATE1Data type for client state verification
DATA_TYPE_CONSENSUS_STATE2Data type for consensus state verification
DATA_TYPE_CONNECTION_STATE3Data type for connection state verification
DATA_TYPE_CHANNEL_STATE4Data type for channel state verification
DATA_TYPE_PACKET_COMMITMENT5Data type for packet commitment verification
DATA_TYPE_PACKET_ACKNOWLEDGEMENT6Data type for packet acknowledgement verification
DATA_TYPE_PACKET_RECEIPT_ABSENCE7Data type for packet receipt absence verification
DATA_TYPE_NEXT_SEQUENCE_RECV8Data type for next sequence recv verification
DATA_TYPE_HEADER9Data type for header verification

Top

ibc/lightclients/tendermint/v1/tendermint.proto

ClientState

ClientState from Tendermint tracks the current validator set, latest height, and a possible frozen height.

FieldTypeLabelDescription
chain_idstring
trust_levelFraction
trusting_periodgoogle.protobuf.Durationduration of the period since the LatestTimestamp during which the submitted headers are valid for upgrade
unbonding_periodgoogle.protobuf.Durationduration of the staking unbonding period
max_clock_driftgoogle.protobuf.Durationdefines how much new (untrusted) header's Time can drift into the future.
frozen_heightibc.core.client.v1.HeightBlock height when the client was frozen due to a misbehaviour
latest_heightibc.core.client.v1.HeightLatest height the client was updated to
consensus_paramstendermint.abci.ConsensusParamsConsensus params of the chain
proof_specsics23.ProofSpecrepeatedProof specifications used in verifying counterparty state
upgrade_pathstringPath at which next upgraded client will be committed
allow_update_after_expiryboolThis flag, when set to true, will allow governance to recover a client which has expired
allow_update_after_misbehaviourboolThis flag, when set to true, will allow governance to unfreeze a client whose chain has experienced a misbehaviour event

ConsensusState

ConsensusState defines the consensus state from Tendermint.

FieldTypeLabelDescription
timestampgoogle.protobuf.Timestamptimestamp that corresponds to the block height in which the ConsensusState was stored.
rootibc.core.commitment.v1.MerkleRootcommitment root (i.e app hash)
next_validators_hashbytes

Fraction

Fraction defines the protobuf message type for tmmath.Fraction

FieldTypeLabelDescription
numeratorint64
denominatorint64

Header

Header defines the Tendermint client consensus Header. It encapsulates all the information necessary to update from a trusted Tendermint ConsensusState. The inclusion of TrustedHeight and TrustedValidators allows this update to process correctly, so long as the ConsensusState for the TrustedHeight exists, this removes race conditions among relayers The SignedHeader and ValidatorSet are the new untrusted update fields for the client. The TrustedHeight is the height of a stored ConsensusState on the client that will be used to verify the new untrusted header. The Trusted ConsensusState must be within the unbonding period of current time in order to correctly verify, and the TrustedValidators must hash to TrustedConsensusState.NextValidatorsHash since that is the last trusted validator set at the TrustedHeight.

FieldTypeLabelDescription
signed_headertendermint.types.SignedHeader
validator_settendermint.types.ValidatorSet
trusted_heightibc.core.client.v1.Height
trusted_validatorstendermint.types.ValidatorSet

Misbehaviour

Misbehaviour is a wrapper over two conflicting Headers that implements Misbehaviour interface expected by ICS-02

FieldTypeLabelDescription
client_idstring
chain_idstring
header_1Header
header_2Header

Top

ibc/lightclients/localhost/v1/localhost.proto

ClientState

ClientState defines a loopback (localhost) client. It requires (read-only) access to keys outside the client prefix.

FieldTypeLabelDescription
chain_idstringself chain ID
heightibc.core.client.v1.Heightself latest block height

Top

ibc/applications/transfer/v1/transfer.proto

DenomTrace

DenomTrace contains the base denomination for ICS20 fungible tokens and the source tracing information path.

FieldTypeLabelDescription
pathstringpath defines the chain of port/channel identifiers used for tracing the source of the fungible token.
base_denomstringbase denomination of the relayed fungible token.

FungibleTokenPacketData

FungibleTokenPacketData defines a struct for the packet payload See FungibleTokenPacketData spec: https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#data-structures

FieldTypeLabelDescription
denomstringthe token denomination to be transferred
amountuint64the token amount to be transferred
senderstringthe sender address
receiverstringthe recipient address on the destination chain

MsgTransfer

MsgTransfer defines a msg to transfer fungible tokens (i.e Coins) between ICS20 enabled chains. See ICS Spec here: https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#data-structures

FieldTypeLabelDescription
source_portstringthe port on which the packet will be sent
source_channelstringthe channel by which the packet will be sent
tokencosmos.base.v1beta1.Cointhe tokens to be transferred
senderstringthe sender address
receiverstringthe recipient address on the destination chain
timeout_heightibc.core.client.v1.HeightTimeout height relative to the current block height. The timeout is disabled when set to 0.
timeout_timestampuint64Timeout timestamp (in nanoseconds) relative to the current block timestamp. The timeout is disabled when set to 0.

MsgTransferResponse

MsgTransferResponse defines the Msg/Transfer response type.

Params

Params defines the set of IBC transfer parameters. NOTE: To prevent a single token from being transferred, set the TransfersEnabled parameter to true and then set the bank module's SendEnabled parameter for the denomination to false.

FieldTypeLabelDescription
send_enabledboolsend_enabled enables or disables all cross-chain token transfers from this chain.
receive_enabledboolreceive_enabled enables or disables all cross-chain token transfers to this chain.

Msg

Msg defines the ibc/transfer Msg service.

Method NameRequest TypeResponse TypeDescription
TransferMsgTransferMsgTransferResponseTransfer defines a rpc handler method for MsgTransfer.

Top

ibc/applications/transfer/v1/query.proto

QueryDenomTraceRequest

QueryDenomTraceRequest is the request type for the Query/DenomTrace RPC method

FieldTypeLabelDescription
hashstringhash (in hex format) of the denomination trace information.

QueryDenomTraceResponse

QueryDenomTraceResponse is the response type for the Query/DenomTrace RPC method.

FieldTypeLabelDescription
denom_traceDenomTracedenom_trace returns the requested denomination trace information.

QueryDenomTracesRequest

QueryConnectionsRequest is the request type for the Query/DenomTraces RPC method

FieldTypeLabelDescription
paginationcosmos.base.query.v1beta1.PageRequestpagination defines an optional pagination for the request.

QueryDenomTracesResponse

QueryConnectionsResponse is the response type for the Query/DenomTraces RPC method.

FieldTypeLabelDescription
denom_tracesDenomTracerepeateddenom_traces returns all denominations trace information.
paginationcosmos.base.query.v1beta1.PageResponsepagination defines the pagination in the response.

QueryParamsRequest

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

QueryParamsResponse

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

FieldTypeLabelDescription
paramsParamsparams defines the parameters of the module.

Query

Query provides defines the gRPC querier service.

Method NameRequest TypeResponse TypeDescription
DenomTraceQueryDenomTraceRequestQueryDenomTraceResponseDenomTrace queries a denomination trace information.
DenomTracesQueryDenomTracesRequestQueryDenomTracesResponseDenomTraces queries all denomination traces.
ParamsQueryParamsRequestQueryParamsResponseParams queries all parameters of the ibc-transfer module.

Top

ibc/applications/transfer/v1/genesis.proto

GenesisState

GenesisState defines the ibc-transfer genesis state

FieldTypeLabelDescription
port_idstring
denom_tracesDenomTracerepeated
paramsParams

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)