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.

Field
Type
Label
Description

extra_bits_stored

elems

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.

Field
Type
Label
Description

signatures

repeated

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.

Field
Type
Label
Description

threshold

public_keys

repeated

Top

cosmos/crypto/secp256k1/keys.proto

PrivKey

PrivKey defines a secp256k1 private key.

Field
Type
Label
Description

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.

Field
Type
Label
Description

Top

cosmos/crypto/ed25519/keys.proto

PrivKey

PrivKey defines a ed25519 private key.

Field
Type
Label
Description

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.

Field
Type
Label
Description

Top

cosmos/upgrade/v1beta1/upgrade.proto

CancelSoftwareUpgradeProposal

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

Field
Type
Label
Description

title

description

Plan

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

Field
Type
Label
Description

name

Sets 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.

time

The time after which the upgrade must be performed. Leave set to its zero value to use a pre-defined Height instead.

height

The height at which the upgrade must be performed. Only used if Time is not set.

info

Any application specific upgrade info to be included on-chain such as a git commit that validators could automatically upgrade to

upgraded_client_state

IBC-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.

Field
Type
Label
Description

title

description

plan

Top

cosmos/upgrade/v1beta1/query.proto

QueryAppliedPlanRequest

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

Field
Type
Label
Description

name

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

QueryAppliedPlanResponse

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

Field
Type
Label
Description

height

height 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.

Field
Type
Label
Description

plan

plan is the current upgrade plan.

Query

Query defines the gRPC upgrade querier service.

Method Name
Request Type
Response Type
Description

CurrentPlan

CurrentPlan queries the current upgrade plan.

AppliedPlan

AppliedPlan 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.

Field
Type
Label
Description

annual_provisions

annual_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.

Field
Type
Label
Description

inflation

inflation 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.

Field
Type
Label
Description

params

params defines the parameters of the module.

Query

Query provides defines the gRPC querier service.

Method Name
Request Type
Response Type
Description

Params

Params returns the total set of minting parameters.

Inflation

Inflation returns the current minting inflation value.

AnnualProvisions

AnnualProvisions current minting annual provisions value.

Top

cosmos/mint/v1beta1/genesis.proto

GenesisState

GenesisState defines the mint module's genesis state.

Field
Type
Label
Description

minter

minter is a space for holding current inflation information.

params

params defines all the paramaters of the module.

Top

cosmos/mint/v1beta1/mint.proto

Minter

Minter represents the minting state.

Field
Type
Label
Description

inflation

current annual inflation rate

annual_provisions

current annual expected provisions

Params

Params holds parameters for the mint module.

Field
Type
Label
Description

mint_denom

type of coin to mint

inflation_rate_change

maximum annual change in inflation rate

inflation_max

maximum inflation rate

inflation_min

minimum inflation rate

goal_bonded

goal of percent bonded atoms

blocks_per_year

expected 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.

Field
Type
Label
Description

submitter

MsgSubmitEvidenceResponse

MsgSubmitEvidenceResponse defines the Msg/SubmitEvidence response type.

Field
Type
Label
Description

hash

hash defines the hash of the evidence.

Msg

Msg defines the evidence Msg service.

Method Name
Request Type
Response Type
Description

SubmitEvidence

SubmitEvidence 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.

Field
Type
Label
Description

height

power

consensus_address

Top

cosmos/evidence/v1beta1/query.proto

QueryAllEvidenceRequest

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

Field
Type
Label
Description

pagination

pagination defines an optional pagination for the request.

QueryAllEvidenceResponse

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

Field
Type
Label
Description

evidence

repeated

evidence returns all evidences.

pagination

pagination defines the pagination in the response.

QueryEvidenceRequest

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

Field
Type
Label
Description

evidence_hash

evidence_hash defines the hash of the requested evidence.

QueryEvidenceResponse

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

Field
Type
Label
Description

evidence