certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
cosmos-sdk/docs/core/proto-docs.md

334 KiB
Raw Blame History

Protobuf Documentation

Table of Contents

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

Field Type Label Description
address string
pub_key google.protobuf.Any
account_number uint64
sequence uint64

ModuleAccount

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

Field Type Label Description
base_account BaseAccount
name string
permissions string repeated

Params

Params defines the parameters for the auth module.

Field Type Label Description
max_memo_characters uint64
tx_sig_limit uint64
tx_size_cost_per_byte uint64
sig_verify_cost_ed25519 uint64
sig_verify_cost_secp256k1 uint64

Top

cosmos/auth/v1beta1/genesis.proto

GenesisState

GenesisState defines the auth module's genesis state.

Field Type Label Description
params Params params defines all the paramaters of the module.
accounts google.protobuf.Any repeated accounts are the accounts present at genesis.

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; }

Field Type Label Description
key bytes key 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.
offset uint64 offset 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.
limit uint64 limit 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_total bool count_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.
reverse bool reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43 |

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; }

Field Type Label Description
next_key bytes next_key is the key to be passed to PageRequest.key to query the next page most efficiently
total uint64 total is total number of results available if PageRequest.count_total was set, its value is undefined otherwise

Top

cosmos/auth/v1beta1/query.proto

AddressBytesToStringRequest

AddressBytesToStringRequest is the request type for AddressString rpc method

Field Type Label Description
address_bytes bytes

AddressBytesToStringResponse

AddressBytesToStringResponse is the response type for AddressString rpc method

Field Type Label Description
address_string string

AddressStringToBytesRequest

AddressStringToBytesRequest is the request type for AccountBytes rpc method

Field Type Label Description
address_string string

AddressStringToBytesResponse

AddressStringToBytesResponse is the response type for AddressBytes rpc method

Field Type Label Description
address_bytes bytes

Bech32PrefixRequest

Bech32PrefixRequest is the request type for Bech32Prefix rpc method

Bech32PrefixResponse

Bech32PrefixResponse is the response type for Bech32Prefix rpc method

Field Type Label Description
bech32_prefix string

QueryAccountRequest

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

Field Type Label Description
address string address defines the address to query for.

QueryAccountResponse

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

Field Type Label Description
account google.protobuf.Any account defines the account of the corresponding address.

QueryAccountsRequest

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

Since: cosmos-sdk 0.43

Field Type Label Description
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryAccountsResponse

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

Since: cosmos-sdk 0.43

Field Type Label Description
accounts google.protobuf.Any repeated accounts are the existing accounts
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryModuleAccountsRequest

QueryModuleAccountsRequest is the request type for the Query/ModuleAccounts RPC method.

QueryModuleAccountsResponse

QueryModuleAccountsResponse is the response type for the Query/ModuleAccounts RPC method.

Field Type Label Description
accounts google.protobuf.Any repeated

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 params defines the parameters of the module.

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Accounts QueryAccountsRequest QueryAccountsResponse Accounts returns all the existing accounts

Since: cosmos-sdk 0.43 | GET|/cosmos/auth/v1beta1/accounts| | Account | QueryAccountRequest | QueryAccountResponse | Account returns account details based on address. | GET|/cosmos/auth/v1beta1/accounts/{address}| | Params | QueryParamsRequest | QueryParamsResponse | Params queries all parameters. | GET|/cosmos/auth/v1beta1/params| | ModuleAccounts | QueryModuleAccountsRequest | QueryModuleAccountsResponse | ModuleAccounts returns all the existing module accounts. | GET|/cosmos/auth/v1beta1/module_accounts| | Bech32Prefix | Bech32PrefixRequest | Bech32PrefixResponse | Bech32 queries bech32Prefix | GET|/cosmos/auth/v1beta1/bech32| | AddressBytesToString | AddressBytesToStringRequest | AddressBytesToStringResponse | AddressBytesToString converts Account Address bytes to string | GET|/cosmos/auth/v1beta1/bech32/{address_bytes}| | AddressStringToBytes | AddressStringToBytesRequest | AddressStringToBytesResponse | AddressStringToBytes converts Address string to bytes | GET|/cosmos/auth/v1beta1/bech32/{address_string}|

Top

cosmos/authz/v1beta1/authz.proto

Since: cosmos-sdk 0.43

GenericAuthorization

GenericAuthorization gives the grantee unrestricted permissions to execute the provided method on behalf of the granter's account.

Field Type Label Description
msg string Msg, identified by it's type URL, to grant unrestricted permissions to execute

Grant

Grant gives permissions to execute the provide method with expiration time.

Field Type Label Description
authorization google.protobuf.Any
expiration google.protobuf.Timestamp

Top

cosmos/authz/v1beta1/event.proto

Since: cosmos-sdk 0.43

EventGrant

EventGrant is emitted on Msg/Grant

Field Type Label Description
msg_type_url string Msg type URL for which an autorization is granted
granter string Granter account address
grantee string Grantee account address

EventRevoke

EventRevoke is emitted on Msg/Revoke

Field Type Label Description
msg_type_url string Msg type URL for which an autorization is revoked
granter string Granter account address
grantee string Grantee account address

Top

cosmos/authz/v1beta1/genesis.proto

Since: cosmos-sdk 0.43

GenesisState

GenesisState defines the authz module's genesis state.

Field Type Label Description
authorization GrantAuthorization repeated

GrantAuthorization

GrantAuthorization defines the GenesisState/GrantAuthorization type.

Field Type Label Description
granter string
grantee string
authorization google.protobuf.Any
expiration google.protobuf.Timestamp

Top

cosmos/authz/v1beta1/query.proto

Since: cosmos-sdk 0.43

QueryGranterGrantsRequest

QueryGranterGrantsRequest is the request type for the Query/GranterGrants RPC method.

Field Type Label Description
granter string
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an pagination for the request.

QueryGranterGrantsResponse

QueryGranterGrantsResponse is the response type for the Query/GranterGrants RPC method.

Field Type Label Description
grants Grant repeated authorizations is a list of grants granted for grantee by granter.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines an pagination for the response.

QueryGrantsRequest

QueryGrantsRequest is the request type for the Query/Grants RPC method.

Field Type Label Description
granter string
grantee string
msg_type_url string Optional, msg_type_url, when set, will query only grants matching given msg type.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an pagination for the request.

QueryGrantsResponse

QueryGrantsResponse is the response type for the Query/Authorizations RPC method.

Field Type Label Description
grants Grant repeated authorizations is a list of grants granted for grantee by granter.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines an pagination for the response.

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Grants QueryGrantsRequest QueryGrantsResponse Returns list of Authorization, granted to the grantee by the granter. GET /cosmos/authz/v1beta1/grants
GranterGrants QueryGranterGrantsRequest QueryGranterGrantsResponse GranterGrants returns list of Authorization, granted by granter. GET /cosmos/authz/v1beta1/grants/{granter}

Top

cosmos/base/abci/v1beta1/abci.proto

ABCIMessageLog

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

Field Type Label Description
msg_index uint32
log string
events StringEvent repeated Events 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.

Field Type Label Description
key string
value string

GasInfo

GasInfo defines tx execution gas context.

Field Type Label Description
gas_wanted uint64 GasWanted is the maximum units of work we allow this tx to perform.
gas_used uint64 GasUsed is the amount of gas actually consumed.

MsgData

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

Field Type Label Description
msg_type string
data bytes

Result

Result is the union of ResponseFormat and ResponseCheckTx.

Field Type Label Description
data bytes Data is any data returned from message or handler execution. It MUST be length prefixed in order to separate data from multiple message executions.
log string Log contains the log information from message or handler execution.
events tendermint.abci.Event repeated Events contains a slice of Event objects that were emitted during message or handler execution.

SearchTxsResult

SearchTxsResult defines a structure for querying txs pageable

Field Type Label Description
total_count uint64 Count of all txs
count uint64 Count of txs in current page
page_number uint64 Index of current page, start from 1
page_total uint64 Count of total pages
limit uint64 Max count txs per page
txs TxResponse repeated List of txs in current page

SimulationResponse

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

Field Type Label Description
gas_info GasInfo
result Result

StringEvent

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

Field Type Label Description
type string
attributes Attribute repeated

TxMsgData

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

Field Type Label Description
data MsgData repeated

TxResponse

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

Field Type Label Description
height int64 The block height
txhash string The transaction hash.
codespace string Namespace for the Code
code uint32 Response code.
data string Result bytes, if any.
raw_log string The output of the application's logger (raw string). May be non-deterministic.
logs ABCIMessageLog repeated The output of the application's logger (typed). May be non-deterministic.
info string Additional information. May be non-deterministic.
gas_wanted int64 Amount of gas requested for transaction.
gas_used int64 Amount of gas consumed by transaction.
tx google.protobuf.Any The request transaction bytes.
timestamp string Time 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/authz/v1beta1/tx.proto

Since: cosmos-sdk 0.43

MsgExec

MsgExec attempts to execute the provided messages using authorizations granted to the grantee. Each message should have only one signer corresponding to the granter of the authorization.

Field Type Label Description
grantee string
msgs google.protobuf.Any repeated Authorization Msg requests to execute. Each msg must implement Authorization interface The x/authz will try to find a grant matching (msg.signers[0], grantee, MsgTypeURL(msg)) triple and validate it.

MsgExecResponse

MsgExecResponse defines the Msg/MsgExecResponse response type.

Field Type Label Description
results bytes repeated

MsgGrant

MsgGrant is a request type for Grant method. It declares authorization to the grantee on behalf of the granter with the provided expiration time.

Field Type Label Description
granter string
grantee string
grant Grant

MsgGrantResponse

MsgGrantResponse defines the Msg/MsgGrant response type.

MsgRevoke

MsgRevoke revokes any authorization with the provided sdk.Msg type on the granter's account with that has been granted to the grantee.

Field Type Label Description
granter string
grantee string
msg_type_url string

MsgRevokeResponse

MsgRevokeResponse defines the Msg/MsgRevokeResponse response type.

Msg

Msg defines the authz Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Grant MsgGrant MsgGrantResponse Grant grants the provided authorization to the grantee on the granter's account with the provided expiration time. If there is already a grant for the given (granter, grantee, Authorization) triple, then the grant will be overwritten.
Exec MsgExec MsgExecResponse Exec attempts to execute the provided messages using authorizations granted to the grantee. Each message should have only one signer corresponding to the granter of the authorization.
Revoke MsgRevoke MsgRevokeResponse Revoke revokes any authorization corresponding to the provided method name on the granter's account that has been granted to the grantee.

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.

Field Type Label Description
denom string
amount string

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.

Field Type Label Description
denom string
amount string

DecProto

DecProto defines a Protobuf wrapper around a Dec object.

Field Type Label Description
dec string

IntProto

IntProto defines a Protobuf wrapper around an Int object.

Field Type Label Description
int string

Top

cosmos/bank/v1beta1/authz.proto

SendAuthorization

SendAuthorization allows the grantee to spend up to spend_limit coins from the granter's account.

Since: cosmos-sdk 0.43

Field Type Label Description
spend_limit cosmos.base.v1beta1.Coin repeated

Top

cosmos/bank/v1beta1/bank.proto

DenomUnit

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

Field Type Label Description
denom string denom represents the string name of the given denom unit (e.g uatom).
exponent uint32 exponent 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).
aliases string repeated aliases is a list of string aliases for the given denom

Input

Input models transaction input.

Field Type Label Description
address string
coins cosmos.base.v1beta1.Coin repeated

Metadata

Metadata represents a struct that describes a basic token.

Field Type Label Description
description string
denom_units DenomUnit repeated denom_units represents the list of DenomUnit's for a given coin
base string base represents the base denom (should be the DenomUnit with exponent = 0).
display string display indicates the suggested denom that should be displayed in clients.
name string name defines the name of the token (eg: Cosmos Atom)

Since: cosmos-sdk 0.43 | | symbol | string | | symbol is the token symbol usually shown on exchanges (eg: ATOM). This can be the same as the display.

Since: cosmos-sdk 0.43 | | uri | string | | URI to a document (on or off-chain) that contains additional information. Optional.

Since: cosmos-sdk 0.45 | | uri_hash | string | | URIHash is a sha256 hash of a document pointed by URI. It's used to verify that the document didn't change. Optional.

Since: cosmos-sdk 0.45 |

Output

Output models transaction outputs.

Field Type Label Description
address string
coins cosmos.base.v1beta1.Coin repeated

Params

Params defines the parameters for the bank module.

Field Type Label Description
send_enabled SendEnabled repeated
default_send_enabled bool

SendEnabled

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

Field Type Label Description
denom string
enabled bool

Supply

Supply represents a struct that passively keeps track of the total supply amounts in the network. This message is deprecated now that supply is indexed by denom.

Field Type Label Description
total cosmos.base.v1beta1.Coin repeated

Top

cosmos/bank/v1beta1/genesis.proto

Balance

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

Field Type Label Description
address string address is the address of the balance holder.
coins cosmos.base.v1beta1.Coin repeated coins defines the different coins this balance holds.

GenesisState

GenesisState defines the bank module's genesis state.

Field Type Label Description
params Params params defines all the paramaters of the module.
balances Balance repeated balances is an array containing the balances of all the accounts.
supply cosmos.base.v1beta1.Coin repeated supply represents the total supply. If it is left empty, then supply will be calculated based on the provided balances. Otherwise, it will be used to validate that the sum of the balances equals this amount.
denom_metadata Metadata repeated denom_metadata defines the metadata of the differents coins.

Top

cosmos/bank/v1beta1/query.proto

DenomOwner

DenomOwner defines structure representing an account that owns or holds a particular denominated token. It contains the account address and account balance of the denominated token.

Field Type Label Description
address string address defines the address that owns a particular denomination.
balance cosmos.base.v1beta1.Coin balance is the balance of the denominated coin for an account.

QueryAllBalancesRequest

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

Field Type Label Description
address string address is the address to query balances for.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryAllBalancesResponse

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

Field Type Label Description
balances cosmos.base.v1beta1.Coin repeated balances is the balances of all the coins.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryBalanceRequest

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

Field Type Label Description
address string address is the address to query balances for.
denom string denom is the coin denom to query balances for.

QueryBalanceResponse

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

Field Type Label Description
balance cosmos.base.v1beta1.Coin balance is the balance of the coin.

QueryDenomMetadataRequest

QueryDenomMetadataRequest is the request type for the Query/DenomMetadata RPC method.

Field Type Label Description
denom string denom is the coin denom to query the metadata for.

QueryDenomMetadataResponse

QueryDenomMetadataResponse is the response type for the Query/DenomMetadata RPC method.

Field Type Label Description
metadata Metadata metadata describes and provides all the client information for the requested token.

QueryDenomOwnersRequest

QueryDenomOwnersRequest defines the request type for the DenomOwners RPC query, which queries for a paginated set of all account holders of a particular denomination.

Field Type Label Description
denom string denom defines the coin denomination to query all account holders for.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryDenomOwnersResponse

QueryDenomOwnersResponse defines the RPC response of a DenomOwners RPC query.

Field Type Label Description
denom_owners DenomOwner repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryDenomsMetadataRequest

QueryDenomsMetadataRequest is the request type for the Query/DenomsMetadata RPC method.

Field Type Label Description
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryDenomsMetadataResponse

QueryDenomsMetadataResponse is the response type for the Query/DenomsMetadata RPC method.

Field Type Label Description
metadatas Metadata repeated metadata provides the client information for all the registered tokens.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryParamsRequest

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

QueryParamsResponse

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

Field Type Label Description
params Params

QuerySupplyOfRequest

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

Field Type Label Description
denom string denom is the coin denom to query balances for.

QuerySupplyOfResponse

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

Field Type Label Description
amount cosmos.base.v1beta1.Coin amount is the supply of the coin.

QueryTotalSupplyRequest

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

Field Type Label Description
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

Since: cosmos-sdk 0.43 |

QueryTotalSupplyResponse

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

Field Type Label Description
supply cosmos.base.v1beta1.Coin repeated supply is the supply of the coins
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

Since: cosmos-sdk 0.43 |

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Balance QueryBalanceRequest QueryBalanceResponse Balance queries the balance of a single coin for a single account. GET /cosmos/bank/v1beta1/balances/{address}/{denom}
AllBalances QueryAllBalancesRequest QueryAllBalancesResponse AllBalances queries the balance of all coins for a single account. GET /cosmos/bank/v1beta1/balances/{address}
TotalSupply QueryTotalSupplyRequest QueryTotalSupplyResponse TotalSupply queries the total supply of all coins. GET /cosmos/bank/v1beta1/supply
SupplyOf QuerySupplyOfRequest QuerySupplyOfResponse SupplyOf queries the supply of a single coin. GET /cosmos/bank/v1beta1/supply/{denom}
Params QueryParamsRequest QueryParamsResponse Params queries the parameters of x/bank module. GET /cosmos/bank/v1beta1/params
DenomMetadata QueryDenomMetadataRequest QueryDenomMetadataResponse DenomsMetadata queries the client metadata of a given coin denomination. GET /cosmos/bank/v1beta1/denoms_metadata/{denom}
DenomsMetadata QueryDenomsMetadataRequest QueryDenomsMetadataResponse DenomsMetadata queries the client metadata for all registered coin denominations. GET /cosmos/bank/v1beta1/denoms_metadata
DenomOwners QueryDenomOwnersRequest QueryDenomOwnersResponse DenomOwners queries for all account addresses that own a particular token denomination. GET /cosmos/bank/v1beta1/denom_owners/{denom}

Top

cosmos/bank/v1beta1/tx.proto

MsgMultiSend

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

Field Type Label Description
inputs Input repeated
outputs Output repeated

MsgMultiSendResponse

MsgMultiSendResponse defines the Msg/MultiSend response type.

MsgSend

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

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

MsgSendResponse

MsgSendResponse defines the Msg/Send response type.

Msg

Msg defines the bank Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Send MsgSend MsgSendResponse Send defines a method for sending coins from one account to another account.
MultiSend MsgMultiSend MsgMultiSendResponse MultiSend defines a method for sending coins from some accounts to other accounts.

Top

cosmos/base/kv/v1beta1/kv.proto

Pair

Pair defines a key/value bytes tuple.

Field Type Label Description
key bytes
value bytes

Pairs

Pairs defines a repeated slice of Pair objects.

Field Type Label Description
pairs Pair repeated

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.

Field Type Label Description
interface_names string repeated interface_names is an array of all the registered interfaces.

ListImplementationsRequest

ListImplementationsRequest is the request type of the ListImplementations RPC.

Field Type Label Description
interface_name string interface_name defines the interface to query the implementations for.

ListImplementationsResponse

ListImplementationsResponse is the response type of the ListImplementations RPC.

Field Type Label Description
implementation_message_names string repeated

ReflectionService

ReflectionService defines a service for interface reflection.

Method Name Request Type Response Type Description HTTP Verb Endpoint
ListAllInterfaces ListAllInterfacesRequest ListAllInterfacesResponse ListAllInterfaces lists all the interfaces registered in the interface registry. GET /cosmos/base/reflection/v1beta1/interfaces
ListImplementations ListImplementationsRequest ListImplementationsResponse ListImplementations list all the concrete types that implement a given interface. GET /cosmos/base/reflection/v1beta1/interfaces/{interface_name}/implementations

Top

cosmos/base/reflection/v2alpha1/reflection.proto

Since: cosmos-sdk 0.43

AppDescriptor

AppDescriptor describes a cosmos-sdk based application

Field Type Label Description
authn AuthnDescriptor AuthnDescriptor provides information on how to authenticate transactions on the application NOTE: experimental and subject to change in future releases.
chain ChainDescriptor chain provides the chain descriptor
codec CodecDescriptor codec provides metadata information regarding codec related types
configuration ConfigurationDescriptor configuration provides metadata information regarding the sdk.Config type
query_services QueryServicesDescriptor query_services provides metadata information regarding the available queriable endpoints
tx TxDescriptor tx provides metadata information regarding how to send transactions to the given application

AuthnDescriptor

AuthnDescriptor provides information on how to sign transactions without relying on the online RPCs GetTxMetadata and CombineUnsignedTxAndSignatures

Field Type Label Description
sign_modes SigningModeDescriptor repeated sign_modes defines the supported signature algorithm

ChainDescriptor

ChainDescriptor describes chain information of the application

Field Type Label Description
id string id is the chain id

CodecDescriptor

CodecDescriptor describes the registered interfaces and provides metadata information on the types

Field Type Label Description
interfaces InterfaceDescriptor repeated interfaces is a list of the registerted interfaces descriptors

ConfigurationDescriptor

ConfigurationDescriptor contains metadata information on the sdk.Config

Field Type Label Description
bech32_account_address_prefix string bech32_account_address_prefix is the account address prefix

GetAuthnDescriptorRequest

GetAuthnDescriptorRequest is the request used for the GetAuthnDescriptor RPC

GetAuthnDescriptorResponse

GetAuthnDescriptorResponse is the response returned by the GetAuthnDescriptor RPC

Field Type Label Description
authn AuthnDescriptor authn describes how to authenticate to the application when sending transactions

GetChainDescriptorRequest

GetChainDescriptorRequest is the request used for the GetChainDescriptor RPC

GetChainDescriptorResponse

GetChainDescriptorResponse is the response returned by the GetChainDescriptor RPC

Field Type Label Description
chain ChainDescriptor chain describes application chain information

GetCodecDescriptorRequest

GetCodecDescriptorRequest is the request used for the GetCodecDescriptor RPC

GetCodecDescriptorResponse

GetCodecDescriptorResponse is the response returned by the GetCodecDescriptor RPC

Field Type Label Description
codec CodecDescriptor codec describes the application codec such as registered interfaces and implementations

GetConfigurationDescriptorRequest

GetConfigurationDescriptorRequest is the request used for the GetConfigurationDescriptor RPC

GetConfigurationDescriptorResponse

GetConfigurationDescriptorResponse is the response returned by the GetConfigurationDescriptor RPC

Field Type Label Description
config ConfigurationDescriptor config describes the application's sdk.Config

GetQueryServicesDescriptorRequest

GetQueryServicesDescriptorRequest is the request used for the GetQueryServicesDescriptor RPC

GetQueryServicesDescriptorResponse

GetQueryServicesDescriptorResponse is the response returned by the GetQueryServicesDescriptor RPC

Field Type Label Description
queries QueryServicesDescriptor queries provides information on the available queryable services

GetTxDescriptorRequest

GetTxDescriptorRequest is the request used for the GetTxDescriptor RPC

GetTxDescriptorResponse

GetTxDescriptorResponse is the response returned by the GetTxDescriptor RPC

Field Type Label Description
tx TxDescriptor tx provides information on msgs that can be forwarded to the application alongside the accepted transaction protobuf type

InterfaceAcceptingMessageDescriptor

InterfaceAcceptingMessageDescriptor describes a protobuf message which contains an interface represented as a google.protobuf.Any

Field Type Label Description
fullname string fullname is the protobuf fullname of the type containing the interface
field_descriptor_names string repeated field_descriptor_names is a list of the protobuf name (not fullname) of the field which contains the interface as google.protobuf.Any (the interface is the same, but it can be in multiple fields of the same proto message)

InterfaceDescriptor

InterfaceDescriptor describes the implementation of an interface

Field Type Label Description
fullname string fullname is the name of the interface
interface_accepting_messages InterfaceAcceptingMessageDescriptor repeated interface_accepting_messages contains information regarding the proto messages which contain the interface as google.protobuf.Any field
interface_implementers InterfaceImplementerDescriptor repeated interface_implementers is a list of the descriptors of the interface implementers

InterfaceImplementerDescriptor

InterfaceImplementerDescriptor describes an interface implementer

Field Type Label Description
fullname string fullname is the protobuf queryable name of the interface implementer
type_url string type_url defines the type URL used when marshalling the type as any this is required so we can provide type safe google.protobuf.Any marshalling and unmarshalling, making sure that we don't accept just 'any' type in our interface fields

MsgDescriptor

MsgDescriptor describes a cosmos-sdk message that can be delivered with a transaction

Field Type Label Description
msg_type_url string msg_type_url contains the TypeURL of a sdk.Msg.

QueryMethodDescriptor

QueryMethodDescriptor describes a queryable method of a query service no other info is provided beside method name and tendermint queryable path because it would be redundant with the grpc reflection service

Field Type Label Description
name string name is the protobuf name (not fullname) of the method
full_query_path string full_query_path is the path that can be used to query this method via tendermint abci.Query

QueryServiceDescriptor

QueryServiceDescriptor describes a cosmos-sdk queryable service

Field Type Label Description
fullname string fullname is the protobuf fullname of the service descriptor
is_module bool is_module describes if this service is actually exposed by an application's module
methods QueryMethodDescriptor repeated methods provides a list of query service methods

QueryServicesDescriptor

QueryServicesDescriptor contains the list of cosmos-sdk queriable services

Field Type Label Description
query_services QueryServiceDescriptor repeated query_services is a list of cosmos-sdk QueryServiceDescriptor

SigningModeDescriptor

SigningModeDescriptor provides information on a signing flow of the application NOTE(fdymylja): here we could go as far as providing an entire flow on how to sign a message given a SigningModeDescriptor, but it's better to think about this another time

Field Type Label Description
name string name defines the unique name of the signing mode
number int32 number is the unique int32 identifier for the sign_mode enum
authn_info_provider_method_fullname string authn_info_provider_method_fullname defines the fullname of the method to call to get the metadata required to authenticate using the provided sign_modes

TxDescriptor

TxDescriptor describes the accepted transaction type

Field Type Label Description
fullname string fullname is the protobuf fullname of the raw transaction type (for instance the tx.Tx type) it is not meant to support polymorphism of transaction types, it is supposed to be used by reflection clients to understand if they can handle a specific transaction type in an application.
msgs MsgDescriptor repeated msgs lists the accepted application messages (sdk.Msg)

ReflectionService

ReflectionService defines a service for application reflection.

Method Name Request Type Response Type Description HTTP Verb Endpoint
GetAuthnDescriptor GetAuthnDescriptorRequest GetAuthnDescriptorResponse GetAuthnDescriptor returns information on how to authenticate transactions in the application NOTE: this RPC is still experimental and might be subject to breaking changes or removal in future releases of the cosmos-sdk. GET /cosmos/base/reflection/v1beta1/app_descriptor/authn
GetChainDescriptor GetChainDescriptorRequest GetChainDescriptorResponse GetChainDescriptor returns the description of the chain GET /cosmos/base/reflection/v1beta1/app_descriptor/chain
GetCodecDescriptor GetCodecDescriptorRequest GetCodecDescriptorResponse GetCodecDescriptor returns the descriptor of the codec of the application GET /cosmos/base/reflection/v1beta1/app_descriptor/codec
GetConfigurationDescriptor GetConfigurationDescriptorRequest GetConfigurationDescriptorResponse GetConfigurationDescriptor returns the descriptor for the sdk.Config of the application GET /cosmos/base/reflection/v1beta1/app_descriptor/configuration
GetQueryServicesDescriptor GetQueryServicesDescriptorRequest GetQueryServicesDescriptorResponse GetQueryServicesDescriptor returns the available gRPC queryable services of the application GET /cosmos/base/reflection/v1beta1/app_descriptor/query_services
GetTxDescriptor GetTxDescriptorRequest GetTxDescriptorResponse GetTxDescriptor returns information on the used transaction object and available msgs that can be used GET /cosmos/base/reflection/v1beta1/app_descriptor/tx_descriptor

Top

cosmos/base/snapshots/v1beta1/snapshot.proto

Metadata

Metadata contains SDK-specific snapshot metadata.

Field Type Label Description
chunk_hashes bytes repeated SHA-256 chunk hashes

Snapshot

Snapshot contains Tendermint state sync snapshot info.

Field Type Label Description
height uint64
format uint32
chunks uint32
hash bytes
metadata Metadata

Top

cosmos/base/store/v1beta1/commit_info.proto

CommitID

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

Field Type Label Description
version int64
hash bytes

CommitInfo

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

Field Type Label Description
version int64
store_infos StoreInfo repeated

StoreInfo

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

Field Type Label Description
name string
commit_id CommitID

Top

cosmos/base/store/v1beta1/listening.proto

StoreKVPair

StoreKVPair is a KVStore KVPair used for listening to state changes (Sets and Deletes) It optionally includes the StoreKey for the originating KVStore and a Boolean flag to distinguish between Sets and Deletes

Since: cosmos-sdk 0.43

Field Type Label Description
store_key string the store key for the KVStore this pair originates from
delete bool true indicates a delete operation, false indicates a set operation
key bytes
value bytes

Top

cosmos/base/store/v1beta1/snapshot.proto

SnapshotIAVLItem

SnapshotIAVLItem is an exported IAVL node.

Field Type Label Description
key bytes
value bytes
version int64
height int32

SnapshotItem

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

Field Type Label Description
store SnapshotStoreItem
iavl SnapshotIAVLItem

SnapshotStoreItem

SnapshotStoreItem contains metadata about a snapshotted store.

Field Type Label Description
name string

Top

cosmos/base/tendermint/v1beta1/query.proto

GetBlockByHeightRequest

GetBlockByHeightRequest is the request type for the Query/GetBlockByHeight RPC method.

Field Type Label Description
height int64

GetBlockByHeightResponse

GetBlockByHeightResponse is the response type for the Query/GetBlockByHeight RPC method.

Field Type Label Description
block_id tendermint.types.BlockID
block tendermint.types.Block

GetLatestBlockRequest

GetLatestBlockRequest is the request type for the Query/GetLatestBlock RPC method.

GetLatestBlockResponse

GetLatestBlockResponse is the response type for the Query/GetLatestBlock RPC method.

Field Type Label Description
block_id tendermint.types.BlockID
block tendermint.types.Block

GetLatestValidatorSetRequest

GetLatestValidatorSetRequest is the request type for the Query/GetValidatorSetByHeight RPC method.

Field Type Label Description
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an pagination for the request.

GetLatestValidatorSetResponse

GetLatestValidatorSetResponse is the response type for the Query/GetValidatorSetByHeight RPC method.

Field Type Label Description
block_height int64
validators Validator repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines an pagination for the response.

GetNodeInfoRequest

GetNodeInfoRequest is the request type for the Query/GetNodeInfo RPC method.

GetNodeInfoResponse

GetNodeInfoResponse is the response type for the Query/GetNodeInfo RPC method.

Field Type Label Description
default_node_info tendermint.p2p.DefaultNodeInfo
application_version VersionInfo

GetSyncingRequest

GetSyncingRequest is the request type for the Query/GetSyncing RPC method.

GetSyncingResponse

GetSyncingResponse is the response type for the Query/GetSyncing RPC method.

Field Type Label Description
syncing bool

GetValidatorSetByHeightRequest

GetValidatorSetByHeightRequest is the request type for the Query/GetValidatorSetByHeight RPC method.

Field Type Label Description
height int64
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an pagination for the request.

GetValidatorSetByHeightResponse

GetValidatorSetByHeightResponse is the response type for the Query/GetValidatorSetByHeight RPC method.

Field Type Label Description
block_height int64
validators Validator repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines an pagination for the response.

Module

Module is the type for VersionInfo

Field Type Label Description
path string module path
version string module version
sum string checksum

Validator

Validator is the type for the validator-set.

Field Type Label Description
address string
pub_key google.protobuf.Any
voting_power int64
proposer_priority int64

VersionInfo

VersionInfo is the type for the GetNodeInfoResponse message.

Field Type Label Description
name string
app_name string
version string
git_commit string
build_tags string
go_version string
build_deps Module repeated
cosmos_sdk_version string Since: cosmos-sdk 0.43

Service

Service defines the gRPC querier service for tendermint queries.

Method Name Request Type Response Type Description HTTP Verb Endpoint
GetNodeInfo GetNodeInfoRequest GetNodeInfoResponse GetNodeInfo queries the current node info. GET /cosmos/base/tendermint/v1beta1/node_info
GetSyncing GetSyncingRequest GetSyncingResponse GetSyncing queries node syncing. GET /cosmos/base/tendermint/v1beta1/syncing
GetLatestBlock GetLatestBlockRequest GetLatestBlockResponse GetLatestBlock returns the latest block. GET /cosmos/base/tendermint/v1beta1/blocks/latest
GetBlockByHeight GetBlockByHeightRequest GetBlockByHeightResponse GetBlockByHeight queries block for given height. GET /cosmos/base/tendermint/v1beta1/blocks/{height}
GetLatestValidatorSet GetLatestValidatorSetRequest GetLatestValidatorSetResponse GetLatestValidatorSet queries latest validator-set. GET /cosmos/base/tendermint/v1beta1/validatorsets/latest
GetValidatorSetByHeight GetValidatorSetByHeightRequest GetValidatorSetByHeightResponse GetValidatorSetByHeight queries validator-set at a given height. GET /cosmos/base/tendermint/v1beta1/validatorsets/{height}

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.

Field Type Label Description
index uint64

CapabilityOwners

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

Field Type Label Description
owners Owner repeated

Owner

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

Field Type Label Description
module string
name string

Top

cosmos/capability/v1beta1/genesis.proto

GenesisOwners

GenesisOwners defines the capability owners with their corresponding index.

Field Type Label Description
index uint64 index is the index of the capability owner.
index_owners CapabilityOwners index_owners are the owners at the given index.

GenesisState

GenesisState defines the capability module's genesis state.

Field Type Label Description
index uint64 index is the capability global index.
owners GenesisOwners repeated owners represents a map from index to owners of the capability index index key is string to allow amino marshalling.

Top

cosmos/crisis/v1beta1/genesis.proto

GenesisState

GenesisState defines the crisis module's genesis state.

Field Type Label Description
constant_fee cosmos.base.v1beta1.Coin constant_fee is the fee used to verify the invariant in the crisis module.

Top

cosmos/crisis/v1beta1/tx.proto

MsgVerifyInvariant

MsgVerifyInvariant represents a message to verify a particular invariance.

Field Type Label Description
sender string
invariant_module_name string
invariant_route string

MsgVerifyInvariantResponse

MsgVerifyInvariantResponse defines the Msg/VerifyInvariant response type.

Msg

Msg defines the bank Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
VerifyInvariant MsgVerifyInvariant MsgVerifyInvariantResponse VerifyInvariant defines a method to verify a particular invariance.

Top

cosmos/crypto/ed25519/keys.proto

PrivKey

Deprecated: PrivKey defines a ed25519 private key. NOTE: ed25519 keys must not be used in SDK apps except in a tendermint validator context.

Field Type Label Description
key bytes

PubKey

PubKey is an ed25519 public key for handling Tendermint keys in SDK. It's needed for Any serialization and SDK compatibility. It must not be used in a non Tendermint key context because it doesn't implement ADR-28. Nevertheless, you will like to use ed25519 in app user level then you must create a new proto message and follow ADR-28 for Address construction.

Field Type Label Description
key bytes

Top

cosmos/crypto/hd/v1/hd.proto

BIP44Params

BIP44Params is used as path field in ledger item in Record.

Field Type Label Description
purpose uint32 purpose is a constant set to 44' (or 0x8000002C) following the BIP43 recommendation
coin_type uint32 coin_type is a constant that improves privacy
account uint32 account splits the key space into independent user identities
change bool change is a constant used for public derivation. Constant 0 is used for external chain and constant 1 for internal chain.
address_index uint32 address_index is used as child index in BIP32 derivation

Top

cosmos/crypto/keyring/v1/record.proto

Record

Record is used for representing a key in the keyring.

Field Type Label Description
name string name represents a name of Record
pub_key google.protobuf.Any pub_key represents a public key in any format
local Record.Local local stores the public information about a locally stored key
ledger Record.Ledger ledger stores the public information about a Ledger key
multi Record.Multi Multi does not store any information.
offline Record.Offline Offline does not store any information.

Record.Ledger

Ledger item

Field Type Label Description
path cosmos.crypto.hd.v1.BIP44Params

Record.Local

Item is a keyring item stored in a keyring backend. Local item

Field Type Label Description
priv_key google.protobuf.Any
priv_key_type string

Record.Multi

Multi item

Record.Offline

Offline item

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 uint32
public_keys google.protobuf.Any repeated

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 uint32
elems bytes

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 bytes repeated

Top

cosmos/crypto/secp256k1/keys.proto

PrivKey

PrivKey defines a secp256k1 private key.

Field Type Label Description
key bytes

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
key bytes

Top

cosmos/crypto/secp256r1/keys.proto

Since: cosmos-sdk 0.43

PrivKey

PrivKey defines a secp256r1 ECDSA private key.

Field Type Label Description
secret bytes secret number serialized using big-endian encoding

PubKey

PubKey defines a secp256r1 ECDSA public key.

Field Type Label Description
key bytes Point on secp256r1 curve in a compressed representation as specified in section 4.3.6 of ANSI X9.62: https://webstore.ansi.org/standards/ascx9/ansix9621998

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.

Field Type Label Description
title string
description string
recipient string
amount cosmos.base.v1beta1.Coin repeated

CommunityPoolSpendProposalWithDeposit

CommunityPoolSpendProposalWithDeposit defines a CommunityPoolSpendProposal with a deposit

Field Type Label Description
title string
description string
recipient string
amount string
deposit string

DelegationDelegatorReward

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

Field Type Label Description
validator_address string
reward cosmos.base.v1beta1.DecCoin repeated

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.

Field Type Label Description
previous_period uint64
stake string
height uint64

FeePool

FeePool is the global fee pool for distribution.

Field Type Label Description
community_pool cosmos.base.v1beta1.DecCoin repeated

Params

Params defines the set of params for the distribution module.

Field Type Label Description
community_tax string
base_proposer_reward string
bonus_proposer_reward string
withdraw_addr_enabled bool

ValidatorAccumulatedCommission

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

Field Type Label Description
commission cosmos.base.v1beta1.DecCoin repeated

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.

Field Type Label Description
rewards cosmos.base.v1beta1.DecCoin repeated
period uint64

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
Field Type Label Description
cumulative_reward_ratio cosmos.base.v1beta1.DecCoin repeated
reference_count uint32

ValidatorOutstandingRewards

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

Field Type Label Description
rewards cosmos.base.v1beta1.DecCoin repeated

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.

Field Type Label Description
validator_period uint64
fraction string

ValidatorSlashEvents

ValidatorSlashEvents is a collection of ValidatorSlashEvent messages.

Field Type Label Description
validator_slash_events ValidatorSlashEvent repeated

Top

cosmos/distribution/v1beta1/genesis.proto

DelegatorStartingInfoRecord

DelegatorStartingInfoRecord used for import / export via genesis json.

Field Type Label Description
delegator_address string delegator_address is the address of the delegator.
validator_address string validator_address is the address of the validator.
starting_info DelegatorStartingInfo starting_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.

Field Type Label Description
delegator_address string delegator_address is the address of the delegator.
withdraw_address string withdraw_address is the address to withdraw the delegation rewards to.

GenesisState

GenesisState defines the distribution module's genesis state.

Field Type Label Description
params Params params defines all the paramaters of the module.
fee_pool FeePool fee_pool defines the fee pool at genesis.
delegator_withdraw_infos DelegatorWithdrawInfo repeated fee_pool defines the delegator withdraw infos at genesis.
previous_proposer string fee_pool defines the previous proposer at genesis.
outstanding_rewards ValidatorOutstandingRewardsRecord repeated fee_pool defines the outstanding rewards of all validators at genesis.
validator_accumulated_commissions ValidatorAccumulatedCommissionRecord repeated fee_pool defines the accumulated commisions of all validators at genesis.
validator_historical_rewards ValidatorHistoricalRewardsRecord repeated fee_pool defines the historical rewards of all validators at genesis.
validator_current_rewards ValidatorCurrentRewardsRecord repeated fee_pool defines the current rewards of all validators at genesis.
delegator_starting_infos DelegatorStartingInfoRecord repeated fee_pool defines the delegator starting infos at genesis.
validator_slash_events ValidatorSlashEventRecord repeated fee_pool defines the validator slash events at genesis.

ValidatorAccumulatedCommissionRecord

ValidatorAccumulatedCommissionRecord is used for import / export via genesis json.

Field Type Label Description
validator_address string validator_address is the address of the validator.
accumulated ValidatorAccumulatedCommission accumulated is the accumulated commission of a validator.

ValidatorCurrentRewardsRecord

ValidatorCurrentRewardsRecord is used for import / export via genesis json.

Field Type Label Description
validator_address string validator_address is the address of the validator.
rewards ValidatorCurrentRewards rewards defines the current rewards of a validator.

ValidatorHistoricalRewardsRecord

ValidatorHistoricalRewardsRecord is used for import / export via genesis json.

Field Type Label Description
validator_address string validator_address is the address of the validator.
period uint64 period defines the period the historical rewards apply to.
rewards ValidatorHistoricalRewards rewards defines the historical rewards of a validator.

ValidatorOutstandingRewardsRecord

ValidatorOutstandingRewardsRecord is used for import/export via genesis json.

Field Type Label Description
validator_address string validator_address is the address of the validator.
outstanding_rewards cosmos.base.v1beta1.DecCoin repeated outstanding_rewards represents the oustanding rewards of a validator.

ValidatorSlashEventRecord

ValidatorSlashEventRecord is used for import / export via genesis json.

Field Type Label Description
validator_address string validator_address is the address of the validator.
height uint64 height defines the block height at which the slash event occured.
period uint64 period is the period of the slash event.
validator_slash_event ValidatorSlashEvent validator_slash_event describes the slash event.

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.

Field Type Label Description
pool cosmos.base.v1beta1.DecCoin repeated pool defines community pool's coins.

QueryDelegationRewardsRequest

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

Field Type Label Description
delegator_address string delegator_address defines the delegator address to query for.
validator_address string validator_address defines the validator address to query for.

QueryDelegationRewardsResponse

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

Field Type Label Description
rewards cosmos.base.v1beta1.DecCoin repeated rewards defines the rewards accrued by a delegation.

QueryDelegationTotalRewardsRequest

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

Field Type Label Description
delegator_address string delegator_address defines the delegator address to query for.

QueryDelegationTotalRewardsResponse

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

Field Type Label Description
rewards DelegationDelegatorReward repeated rewards defines all the rewards accrued by a delegator.
total cosmos.base.v1beta1.DecCoin repeated total defines the sum of all the rewards.

QueryDelegatorValidatorsRequest

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

Field Type Label Description
delegator_address string delegator_address defines the delegator address to query for.

QueryDelegatorValidatorsResponse

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

Field Type Label Description
validators string repeated validators defines the validators a delegator is delegating for.

QueryDelegatorWithdrawAddressRequest

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

Field Type Label Description
delegator_address string delegator_address defines the delegator address to query for.

QueryDelegatorWithdrawAddressResponse

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

Field Type Label Description
withdraw_address string withdraw_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.

Field Type Label Description
params Params params defines the parameters of the module.

QueryValidatorCommissionRequest

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

Field Type Label Description
validator_address string validator_address defines the validator address to query for.

QueryValidatorCommissionResponse

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

Field Type Label Description
commission ValidatorAccumulatedCommission commission defines the commision the validator received.

QueryValidatorOutstandingRewardsRequest

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

Field Type Label Description
validator_address string validator_address defines the validator address to query for.

QueryValidatorOutstandingRewardsResponse

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

Field Type Label Description
rewards ValidatorOutstandingRewards

QueryValidatorSlashesRequest

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

Field Type Label Description
validator_address string validator_address defines the validator address to query for.
starting_height uint64 starting_height defines the optional starting height to query the slashes.
ending_height uint64 starting_height defines the optional ending height to query the slashes.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryValidatorSlashesResponse

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

Field Type Label Description
slashes ValidatorSlashEvent repeated slashes defines the slashes the validator received.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

Query

Query defines the gRPC querier service for distribution module.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries params of the distribution module. GET /cosmos/distribution/v1beta1/params
ValidatorOutstandingRewards QueryValidatorOutstandingRewardsRequest QueryValidatorOutstandingRewardsResponse ValidatorOutstandingRewards queries rewards of a validator address. GET /cosmos/distribution/v1beta1/validators/{validator_address}/outstanding_rewards
ValidatorCommission QueryValidatorCommissionRequest QueryValidatorCommissionResponse ValidatorCommission queries accumulated commission for a validator. GET /cosmos/distribution/v1beta1/validators/{validator_address}/commission
ValidatorSlashes QueryValidatorSlashesRequest QueryValidatorSlashesResponse ValidatorSlashes queries slash events of a validator. GET /cosmos/distribution/v1beta1/validators/{validator_address}/slashes
DelegationRewards QueryDelegationRewardsRequest QueryDelegationRewardsResponse DelegationRewards queries the total rewards accrued by a delegation. GET /cosmos/distribution/v1beta1/delegators/{delegator_address}/rewards/{validator_address}
DelegationTotalRewards QueryDelegationTotalRewardsRequest QueryDelegationTotalRewardsResponse DelegationTotalRewards queries the total rewards accrued by a each validator. GET /cosmos/distribution/v1beta1/delegators/{delegator_address}/rewards
DelegatorValidators QueryDelegatorValidatorsRequest QueryDelegatorValidatorsResponse DelegatorValidators queries the validators of a delegator. GET /cosmos/distribution/v1beta1/delegators/{delegator_address}/validators
DelegatorWithdrawAddress QueryDelegatorWithdrawAddressRequest QueryDelegatorWithdrawAddressResponse DelegatorWithdrawAddress queries withdraw address of a delegator. GET /cosmos/distribution/v1beta1/delegators/{delegator_address}/withdraw_address
CommunityPool QueryCommunityPoolRequest QueryCommunityPoolResponse CommunityPool queries the community pool coins. GET /cosmos/distribution/v1beta1/community_pool

Top

cosmos/distribution/v1beta1/tx.proto

MsgFundCommunityPool

MsgFundCommunityPool allows an account to directly fund the community pool.

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

MsgFundCommunityPoolResponse

MsgFundCommunityPoolResponse defines the Msg/FundCommunityPool response type.

MsgSetWithdrawAddress

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

Field Type Label Description
delegator_address string
withdraw_address string

MsgSetWithdrawAddressResponse

MsgSetWithdrawAddressResponse defines the Msg/SetWithdrawAddress response type.

MsgWithdrawDelegatorReward

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

Field Type Label Description
delegator_address string
validator_address string

MsgWithdrawDelegatorRewardResponse

MsgWithdrawDelegatorRewardResponse defines the Msg/WithdrawDelegatorReward response type.

MsgWithdrawValidatorCommission

MsgWithdrawValidatorCommission withdraws the full commission to the validator address.

Field Type Label Description
validator_address string

MsgWithdrawValidatorCommissionResponse

MsgWithdrawValidatorCommissionResponse defines the Msg/WithdrawValidatorCommission response type.

Msg

Msg defines the distribution Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
SetWithdrawAddress MsgSetWithdrawAddress MsgSetWithdrawAddressResponse SetWithdrawAddress defines a method to change the withdraw address for a delegator (or validator self-delegation).
WithdrawDelegatorReward MsgWithdrawDelegatorReward MsgWithdrawDelegatorRewardResponse WithdrawDelegatorReward defines a method to withdraw rewards of delegator from a single validator.
WithdrawValidatorCommission MsgWithdrawValidatorCommission MsgWithdrawValidatorCommissionResponse WithdrawValidatorCommission defines a method to withdraw the full commission to the validator address.
FundCommunityPool MsgFundCommunityPool MsgFundCommunityPoolResponse FundCommunityPool defines a method to allow an account to directly fund the community pool.

Top

cosmos/evidence/v1beta1/evidence.proto

Equivocation

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

Field Type Label Description
height int64
time google.protobuf.Timestamp
power int64
consensus_address string

Top

cosmos/evidence/v1beta1/genesis.proto

GenesisState

GenesisState defines the evidence module's genesis state.

Field Type Label Description
evidence google.protobuf.Any repeated evidence defines all the evidence at genesis.

Top

cosmos/evidence/v1beta1/query.proto

QueryAllEvidenceRequest

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

Field Type Label Description
pagination cosmos.base.query.v1beta1.PageRequest 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 google.protobuf.Any repeated evidence returns all evidences.
pagination cosmos.base.query.v1beta1.PageResponse 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 bytes 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 google.protobuf.Any evidence returns the requested evidence.

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Evidence QueryEvidenceRequest QueryEvidenceResponse Evidence queries evidence based on evidence hash. GET /cosmos/evidence/v1beta1/evidence/{evidence_hash}
AllEvidence QueryAllEvidenceRequest QueryAllEvidenceResponse AllEvidence queries all evidence. GET /cosmos/evidence/v1beta1/evidence

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 string
evidence google.protobuf.Any

MsgSubmitEvidenceResponse

MsgSubmitEvidenceResponse defines the Msg/SubmitEvidence response type.

Field Type Label Description
hash bytes hash defines the hash of the evidence.

Msg

Msg defines the evidence Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
SubmitEvidence MsgSubmitEvidence MsgSubmitEvidenceResponse SubmitEvidence submits an arbitrary Evidence of misbehavior such as equivocation or counterfactual signing.

Top

cosmos/feegrant/v1beta1/feegrant.proto

Since: cosmos-sdk 0.43

AllowedMsgAllowance

AllowedMsgAllowance creates allowance only for specified message types.

Field Type Label Description
allowance google.protobuf.Any allowance can be any of basic and filtered fee allowance.
allowed_messages string repeated allowed_messages are the messages for which the grantee has the access.

BasicAllowance

BasicAllowance implements Allowance with a one-time grant of tokens that optionally expires. The grantee can use up to SpendLimit to cover fees.

Field Type Label Description
spend_limit cosmos.base.v1beta1.Coin repeated spend_limit specifies the maximum amount of tokens that can be spent by this allowance and will be updated as tokens are spent. If it is empty, there is no spend limit and any amount of coins can be spent.
expiration google.protobuf.Timestamp expiration specifies an optional time when this allowance expires

Grant

Grant is stored in the KVStore to record a grant with full context

Field Type Label Description
granter string granter is the address of the user granting an allowance of their funds.
grantee string grantee is the address of the user being granted an allowance of another user's funds.
allowance google.protobuf.Any allowance can be any of basic and filtered fee allowance.

PeriodicAllowance

PeriodicAllowance extends Allowance to allow for both a maximum cap, as well as a limit per time period.

Field Type Label Description
basic BasicAllowance basic specifies a struct of BasicAllowance
period google.protobuf.Duration period specifies the time duration in which period_spend_limit coins can be spent before that allowance is reset
period_spend_limit cosmos.base.v1beta1.Coin repeated period_spend_limit specifies the maximum number of coins that can be spent in the period
period_can_spend cosmos.base.v1beta1.Coin repeated period_can_spend is the number of coins left to be spent before the period_reset time
period_reset google.protobuf.Timestamp period_reset is the time at which this period resets and a new one begins, it is calculated from the start time of the first transaction after the last period ended

Top

cosmos/feegrant/v1beta1/genesis.proto

Since: cosmos-sdk 0.43

GenesisState

GenesisState contains a set of fee allowances, persisted from the store

Field Type Label Description
allowances Grant repeated

Top

cosmos/feegrant/v1beta1/query.proto

Since: cosmos-sdk 0.43

QueryAllowanceRequest

QueryAllowanceRequest is the request type for the Query/Allowance RPC method.

Field Type Label Description
granter string granter is the address of the user granting an allowance of their funds.
grantee string grantee is the address of the user being granted an allowance of another user's funds.

QueryAllowanceResponse

QueryAllowanceResponse is the response type for the Query/Allowance RPC method.

Field Type Label Description
allowance Grant allowance is a allowance granted for grantee by granter.

QueryAllowancesRequest

QueryAllowancesRequest is the request type for the Query/Allowances RPC method.

Field Type Label Description
grantee string
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an pagination for the request.

QueryAllowancesResponse

QueryAllowancesResponse is the response type for the Query/Allowances RPC method.

Field Type Label Description
allowances Grant repeated allowances are allowance's granted for grantee by granter.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines an pagination for the response.

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Allowance QueryAllowanceRequest QueryAllowanceResponse Allowance returns fee granted to the grantee by the granter. GET /cosmos/feegrant/v1beta1/allowance/{granter}/{grantee}
Allowances QueryAllowancesRequest QueryAllowancesResponse Allowances returns all the grants for address. GET /cosmos/feegrant/v1beta1/allowances/{grantee}

Top

cosmos/feegrant/v1beta1/tx.proto

Since: cosmos-sdk 0.43

MsgGrantAllowance

MsgGrantAllowance adds permission for Grantee to spend up to Allowance of fees from the account of Granter.

Field Type Label Description
granter string granter is the address of the user granting an allowance of their funds.
grantee string grantee is the address of the user being granted an allowance of another user's funds.
allowance google.protobuf.Any allowance can be any of basic and filtered fee allowance.

MsgGrantAllowanceResponse

MsgGrantAllowanceResponse defines the Msg/GrantAllowanceResponse response type.

MsgRevokeAllowance

MsgRevokeAllowance removes any existing Allowance from Granter to Grantee.

Field Type Label Description
granter string granter is the address of the user granting an allowance of their funds.
grantee string grantee is the address of the user being granted an allowance of another user's funds.

MsgRevokeAllowanceResponse

MsgRevokeAllowanceResponse defines the Msg/RevokeAllowanceResponse response type.

Msg

Msg defines the feegrant msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
GrantAllowance MsgGrantAllowance MsgGrantAllowanceResponse GrantAllowance grants fee allowance to the grantee on the granter's account with the provided expiration time.
RevokeAllowance MsgRevokeAllowance MsgRevokeAllowanceResponse RevokeAllowance revokes any fee allowance of granter's account that has been granted to the grantee.

Top

cosmos/genutil/v1beta1/genesis.proto

GenesisState

GenesisState defines the raw genesis transaction in JSON.

Field Type Label Description
gen_txs bytes repeated gen_txs defines the genesis transactions.

Top

cosmos/gov/v1beta1/gov.proto

Deposit

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

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

DepositParams

DepositParams defines the params for deposits on governance proposals.

Field Type Label Description
min_deposit cosmos.base.v1beta1.Coin repeated Minimum deposit for a proposal to enter voting period.
max_deposit_period google.protobuf.Duration Maximum period for Atom holders to deposit on a proposal. Initial value: 2 months.

Proposal

Proposal defines the core field members of a governance proposal.

Field Type Label Description
proposal_id uint64
content google.protobuf.Any
status ProposalStatus
final_tally_result TallyResult
submit_time google.protobuf.Timestamp
deposit_end_time google.protobuf.Timestamp
total_deposit cosmos.base.v1beta1.Coin repeated
voting_start_time google.protobuf.Timestamp
voting_end_time google.protobuf.Timestamp

TallyParams

TallyParams defines the params for tallying votes on governance proposals.

Field Type Label Description
quorum bytes Minimum percentage of total stake needed to vote for a result to be considered valid.
threshold bytes Minimum proportion of Yes votes for proposal to pass. Default value: 0.5.
veto_threshold bytes Minimum 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.

Field Type Label Description
yes string
abstain string
no string
no_with_veto string

TextProposal

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

Field Type Label Description
title string
description string

Vote

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

Field Type Label Description
proposal_id uint64
voter string
option VoteOption Deprecated. Deprecated: Prefer to use options instead. This field is set in queries if and only if len(options) == 1 and that option has weight 1. In all other cases, this field will default to VOTE_OPTION_UNSPECIFIED.
options WeightedVoteOption repeated Since: cosmos-sdk 0.43

VotingParams

VotingParams defines the params for voting on governance proposals.

Field Type Label Description
voting_period google.protobuf.Duration Length of the voting period.

WeightedVoteOption

WeightedVoteOption defines a unit of vote for vote split.

Since: cosmos-sdk 0.43

Field Type Label Description
option VoteOption
weight string

ProposalStatus

ProposalStatus enumerates the valid statuses of a proposal.

Name Number Description
PROPOSAL_STATUS_UNSPECIFIED 0 PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
PROPOSAL_STATUS_DEPOSIT_PERIOD 1 PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period.
PROPOSAL_STATUS_VOTING_PERIOD 2 PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
PROPOSAL_STATUS_PASSED 3 PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed.
PROPOSAL_STATUS_REJECTED 4 PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected.
PROPOSAL_STATUS_FAILED 5 PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.

VoteOption

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

Name Number Description
VOTE_OPTION_UNSPECIFIED 0 VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
VOTE_OPTION_YES 1 VOTE_OPTION_YES defines a yes vote option.
VOTE_OPTION_ABSTAIN 2 VOTE_OPTION_ABSTAIN defines an abstain vote option.
VOTE_OPTION_NO 3 VOTE_OPTION_NO defines a no vote option.
VOTE_OPTION_NO_WITH_VETO 4 VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.

Top

cosmos/gov/v1beta1/genesis.proto

GenesisState

GenesisState defines the gov module's genesis state.

Field Type Label Description
starting_proposal_id uint64 starting_proposal_id is the ID of the starting proposal.
deposits Deposit repeated deposits defines all the deposits present at genesis.
votes Vote repeated votes defines all the votes present at genesis.
proposals Proposal repeated proposals defines all the proposals present at genesis.
deposit_params DepositParams params defines all the paramaters of related to deposit.
voting_params VotingParams params defines all the paramaters of related to voting.
tally_params TallyParams params defines all the paramaters of related to tally.

Top

cosmos/gov/v1beta1/query.proto

QueryDepositRequest

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

Field Type Label Description
proposal_id uint64 proposal_id defines the unique id of the proposal.
depositor string depositor defines the deposit addresses from the proposals.

QueryDepositResponse

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

Field Type Label Description
deposit Deposit deposit defines the requested deposit.

QueryDepositsRequest

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

Field Type Label Description
proposal_id uint64 proposal_id defines the unique id of the proposal.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryDepositsResponse

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

Field Type Label Description
deposits Deposit repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryParamsRequest

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

Field Type Label Description
params_type string params_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.

Field Type Label Description
voting_params VotingParams voting_params defines the parameters related to voting.
deposit_params DepositParams deposit_params defines the parameters related to deposit.
tally_params TallyParams tally_params defines the parameters related to tally.

QueryProposalRequest

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

Field Type Label Description
proposal_id uint64 proposal_id defines the unique id of the proposal.

QueryProposalResponse

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

Field Type Label Description
proposal Proposal

QueryProposalsRequest

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

Field Type Label Description
proposal_status ProposalStatus proposal_status defines the status of the proposals.
voter string voter defines the voter address for the proposals.
depositor string depositor defines the deposit addresses from the proposals.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryProposalsResponse

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

Field Type Label Description
proposals Proposal repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryTallyResultRequest

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

Field Type Label Description
proposal_id uint64 proposal_id defines the unique id of the proposal.

QueryTallyResultResponse

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

Field Type Label Description
tally TallyResult tally defines the requested tally.

QueryVoteRequest

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

Field Type Label Description
proposal_id uint64 proposal_id defines the unique id of the proposal.
voter string voter defines the oter address for the proposals.

QueryVoteResponse

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

Field Type Label Description
vote Vote vote defined the queried vote.

QueryVotesRequest

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

Field Type Label Description
proposal_id uint64 proposal_id defines the unique id of the proposal.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryVotesResponse

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

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

Query

Query defines the gRPC querier service for gov module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Proposal QueryProposalRequest QueryProposalResponse Proposal queries proposal details based on ProposalID. GET /cosmos/gov/v1beta1/proposals/{proposal_id}
Proposals QueryProposalsRequest QueryProposalsResponse Proposals queries all proposals based on given status. GET /cosmos/gov/v1beta1/proposals
Vote QueryVoteRequest QueryVoteResponse Vote queries voted information based on proposalID, voterAddr. GET /cosmos/gov/v1beta1/proposals/{proposal_id}/votes/{voter}
Votes QueryVotesRequest QueryVotesResponse Votes queries votes of a given proposal. GET /cosmos/gov/v1beta1/proposals/{proposal_id}/votes
Params QueryParamsRequest QueryParamsResponse Params queries all parameters of the gov module. GET /cosmos/gov/v1beta1/params/{params_type}
Deposit QueryDepositRequest QueryDepositResponse Deposit queries single deposit information based proposalID, depositAddr. GET /cosmos/gov/v1beta1/proposals/{proposal_id}/deposits/{depositor}
Deposits QueryDepositsRequest QueryDepositsResponse Deposits queries all deposits of a single proposal. GET /cosmos/gov/v1beta1/proposals/{proposal_id}/deposits
TallyResult QueryTallyResultRequest QueryTallyResultResponse TallyResult queries the tally of a proposal vote. GET /cosmos/gov/v1beta1/proposals/{proposal_id}/tally

Top

cosmos/gov/v1beta1/tx.proto

MsgDeposit

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

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

MsgDepositResponse

MsgDepositResponse defines the Msg/Deposit response type.

MsgSubmitProposal

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

Field Type Label Description
content google.protobuf.Any
initial_deposit cosmos.base.v1beta1.Coin repeated
proposer string

MsgSubmitProposalResponse

MsgSubmitProposalResponse defines the Msg/SubmitProposal response type.

Field Type Label Description
proposal_id uint64

MsgVote

MsgVote defines a message to cast a vote.

Field Type Label Description
proposal_id uint64
voter string
option VoteOption

MsgVoteResponse

MsgVoteResponse defines the Msg/Vote response type.

MsgVoteWeighted

MsgVoteWeighted defines a message to cast a vote.

Since: cosmos-sdk 0.43

Field Type Label Description
proposal_id uint64
voter string
options WeightedVoteOption repeated

MsgVoteWeightedResponse

MsgVoteWeightedResponse defines the Msg/VoteWeighted response type.

Since: cosmos-sdk 0.43

Msg

Msg defines the bank Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
SubmitProposal MsgSubmitProposal MsgSubmitProposalResponse SubmitProposal defines a method to create new proposal given a content.
Vote MsgVote MsgVoteResponse Vote defines a method to add a vote on a specific proposal.
VoteWeighted MsgVoteWeighted MsgVoteWeightedResponse VoteWeighted defines a method to add a weighted vote on a specific proposal.

Since: cosmos-sdk 0.43 | | | Deposit | MsgDeposit | MsgDepositResponse | Deposit defines a method to add deposit on a specific proposal. | |

Top

cosmos/group/v1beta1/types.proto

GroupAccountInfo

GroupAccountInfo represents the high-level on-chain information for a group account.

Field Type Label Description
address string address is the group account address.
group_id uint64 group_id is the unique ID of the group.
admin string admin is the account address of the group admin.
metadata bytes metadata is any arbitrary metadata to attached to the group account.
version uint64 version is used to track changes to a group's GroupAccountInfo structure that would create a different result on a running proposal.
decision_policy google.protobuf.Any decision_policy specifies the group account's decision policy.
derivation_key bytes derivation_key is the "derivation" key of the group account, which is needed to derive the group root module key and execute proposals.

GroupInfo

GroupInfo represents the high-level on-chain information for a group.

Field Type Label Description
group_id uint64 group_id is the unique ID of the group.
admin string admin is the account address of the group's admin.
metadata bytes metadata is any arbitrary metadata to attached to the group.
version uint64 version is used to track changes to a group's membership structure that would break existing proposals. Whenever any members weight is changed, or any member is added or removed this version is incremented and will cause proposals based on older versions of this group to fail
total_weight string total_weight is the sum of the group members' weights.

GroupMember

GroupMember represents the relationship between a group and a member.

Field Type Label Description
group_id uint64 group_id is the unique ID of the group.
member Member member is the member data.

Member

Member represents a group member with an account address, non-zero weight and metadata.

Field Type Label Description
address string address is the member's account address.
weight string weight is the member's voting weight that should be greater than 0.
metadata bytes metadata is any arbitrary metadata to attached to the member.

Members

Members defines a repeated slice of Member objects.

Field Type Label Description
members Member repeated members is the list of members.

Proposal

Proposal defines a group proposal. Any member of a group can submit a proposal for a group account to decide upon. A proposal consists of a set of sdk.Msgs that will be executed if the proposal passes as well as some optional metadata associated with the proposal.

Field Type Label Description
proposal_id uint64 proposal_id is the unique id of the proposal.
address string address is the group account address.
metadata bytes metadata is any arbitrary metadata to attached to the proposal.
proposers string repeated proposers are the account addresses of the proposers.
submitted_at google.protobuf.Timestamp submitted_at is a timestamp specifying when a proposal was submitted.
group_version uint64 group_version tracks the version of the group that this proposal corresponds to. When group membership is changed, existing proposals from previous group versions will become invalid.
group_account_version uint64 group_account_version tracks the version of the group account that this proposal corresponds to. When a decision policy is changed, existing proposals from previous policy versions will become invalid.
status Proposal.Status Status represents the high level position in the life cycle of the proposal. Initial value is Submitted.
result Proposal.Result result is the final result based on the votes and election rule. Initial value is unfinalized. The result is persisted so that clients can always rely on this state and not have to replicate the logic.
vote_state Tally vote_state contains the sums of all weighted votes for this proposal.
timeout google.protobuf.Timestamp timeout is the timestamp of the block where the proposal execution times out. Header times of the votes and execution messages must be before this end time to be included in the election. After the timeout timestamp the proposal can not be executed anymore and should be considered pending delete.
executor_result Proposal.ExecutorResult executor_result is the final result based on the votes and election rule. Initial value is NotRun.
msgs google.protobuf.Any repeated msgs is a list of Msgs that will be executed if the proposal passes.

Tally

Tally represents the sum of weighted votes.

Field Type Label Description
yes_count string yes_count is the weighted sum of yes votes.
no_count string no_count is the weighted sum of no votes.
abstain_count string abstain_count is the weighted sum of abstainers
veto_count string veto_count is the weighted sum of vetoes.

ThresholdDecisionPolicy

ThresholdDecisionPolicy implements the DecisionPolicy interface

Field Type Label Description
threshold string threshold is the minimum weighted sum of yes votes that must be met or exceeded for a proposal to succeed.
timeout google.protobuf.Duration timeout is the duration from submission of a proposal to the end of voting period Within this times votes and exec messages can be submitted.

Vote

Vote represents a vote for a proposal.

Field Type Label Description
proposal_id uint64 proposal is the unique ID of the proposal.
voter string voter is the account address of the voter.
choice Choice choice is the voter's choice on the proposal.
metadata bytes metadata is any arbitrary metadata to attached to the vote.
submitted_at google.protobuf.Timestamp submitted_at is the timestamp when the vote was submitted.

Choice

Choice defines available types of choices for voting.

Name Number Description
CHOICE_UNSPECIFIED 0 CHOICE_UNSPECIFIED defines a no-op voting choice.
CHOICE_NO 1 CHOICE_NO defines a no voting choice.
CHOICE_YES 2 CHOICE_YES defines a yes voting choice.
CHOICE_ABSTAIN 3 CHOICE_ABSTAIN defines an abstaining voting choice.
CHOICE_VETO 4 CHOICE_VETO defines a voting choice with veto.

Proposal.ExecutorResult

ExecutorResult defines types of proposal executor results.

Name Number Description
EXECUTOR_RESULT_UNSPECIFIED 0 An empty value is not allowed.
EXECUTOR_RESULT_NOT_RUN 1 We have not yet run the executor.
EXECUTOR_RESULT_SUCCESS 2 The executor was successful and proposed action updated state.
EXECUTOR_RESULT_FAILURE 3 The executor returned an error and proposed action didn't update state.

Proposal.Result

Result defines types of proposal results.

Name Number Description
RESULT_UNSPECIFIED 0 An empty value is invalid and not allowed
RESULT_UNFINALIZED 1 Until a final tally has happened the status is unfinalized
RESULT_ACCEPTED 2 Final result of the tally
RESULT_REJECTED 3 Final result of the tally

Proposal.Status

Status defines proposal statuses.

Name Number Description
STATUS_UNSPECIFIED 0 An empty value is invalid and not allowed.
STATUS_SUBMITTED 1 Initial status of a proposal when persisted.
STATUS_CLOSED 2 Final status of a proposal when the final tally was executed.
STATUS_ABORTED 3 Final status of a proposal when the group was modified before the final tally.

Top

cosmos/group/v1beta1/query.proto

QueryGroupAccountInfoRequest

QueryGroupAccountInfoRequest is the Query/GroupAccountInfo request type.

Field Type Label Description
address string address is the account address of the group account.

QueryGroupAccountInfoResponse

QueryGroupAccountInfoResponse is the Query/GroupAccountInfo response type.

Field Type Label Description
info GroupAccountInfo info is the GroupAccountInfo for the group account.

QueryGroupAccountsByAdminRequest

QueryGroupAccountsByAdminRequest is the Query/GroupAccountsByAdmin request type.

Field Type Label Description
admin string admin is the admin address of the group account.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryGroupAccountsByAdminResponse

QueryGroupAccountsByAdminResponse is the Query/GroupAccountsByAdmin response type.

Field Type Label Description
group_accounts GroupAccountInfo repeated group_accounts are the group accounts info with provided admin.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryGroupAccountsByGroupRequest

QueryGroupAccountsByGroupRequest is the Query/GroupAccountsByGroup request type.

Field Type Label Description
group_id uint64 group_id is the unique ID of the group account's group.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryGroupAccountsByGroupResponse

QueryGroupAccountsByGroupResponse is the Query/GroupAccountsByGroup response type.

Field Type Label Description
group_accounts GroupAccountInfo repeated group_accounts are the group accounts info associated with the provided group.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryGroupInfoRequest

QueryGroupInfoRequest is the Query/GroupInfo request type.

Field Type Label Description
group_id uint64 group_id is the unique ID of the group.

QueryGroupInfoResponse

QueryGroupInfoResponse is the Query/GroupInfo response type.

Field Type Label Description
info GroupInfo info is the GroupInfo for the group.

QueryGroupMembersRequest

QueryGroupMembersRequest is the Query/GroupMembersRequest request type.

Field Type Label Description
group_id uint64 group_id is the unique ID of the group.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryGroupMembersResponse

QueryGroupMembersResponse is the Query/GroupMembersResponse response type.

Field Type Label Description
members GroupMember repeated members are the members of the group with given group_id.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryGroupsByAdminRequest

QueryGroupsByAdminRequest is the Query/GroupsByAdminRequest request type.

Field Type Label Description
admin string admin is the account address of a group's admin.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryGroupsByAdminResponse

QueryGroupsByAdminResponse is the Query/GroupsByAdminResponse response type.

Field Type Label Description
groups GroupInfo repeated groups are the groups info with the provided admin.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryProposalRequest

QueryProposalRequest is the Query/Proposal request type.

Field Type Label Description
proposal_id uint64 proposal_id is the unique ID of a proposal.

QueryProposalResponse

QueryProposalResponse is the Query/Proposal response type.

Field Type Label Description
proposal Proposal proposal is the proposal info.

QueryProposalsByGroupAccountRequest

QueryProposalsByGroupAccountRequest is the Query/ProposalByGroupAccount request type.

Field Type Label Description
address string address is the group account address related to proposals.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryProposalsByGroupAccountResponse

QueryProposalsByGroupAccountResponse is the Query/ProposalByGroupAccount response type.

Field Type Label Description
proposals Proposal repeated proposals are the proposals with given group account.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryVoteByProposalVoterRequest

QueryVoteByProposalVoterResponse is the Query/VoteByProposalVoter request type.

Field Type Label Description
proposal_id uint64 proposal_id is the unique ID of a proposal.
voter string voter is a proposal voter account address.

QueryVoteByProposalVoterResponse

QueryVoteByProposalVoterResponse is the Query/VoteByProposalVoter response type.

Field Type Label Description
vote Vote vote is the vote with given proposal_id and voter.

QueryVotesByProposalRequest

QueryVotesByProposalResponse is the Query/VotesByProposal request type.

Field Type Label Description
proposal_id uint64 proposal_id is the unique ID of a proposal.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryVotesByProposalResponse

QueryVotesByProposalResponse is the Query/VotesByProposal response type.

Field Type Label Description
votes Vote repeated votes are the list of votes for given proposal_id.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryVotesByVoterRequest

QueryVotesByVoterResponse is the Query/VotesByVoter request type.

Field Type Label Description
voter string voter is a proposal voter account address.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryVotesByVoterResponse

QueryVotesByVoterResponse is the Query/VotesByVoter response type.

Field Type Label Description
votes Vote repeated votes are the list of votes by given voter.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

Query

Query is the cosmos.group.v1beta1 Query service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
GroupInfo QueryGroupInfoRequest QueryGroupInfoResponse GroupInfo queries group info based on group id.
GroupAccountInfo QueryGroupAccountInfoRequest QueryGroupAccountInfoResponse GroupAccountInfo queries group account info based on group account address.
GroupMembers QueryGroupMembersRequest QueryGroupMembersResponse GroupMembers queries members of a group
GroupsByAdmin QueryGroupsByAdminRequest QueryGroupsByAdminResponse GroupsByAdmin queries groups by admin address.
GroupAccountsByGroup QueryGroupAccountsByGroupRequest QueryGroupAccountsByGroupResponse GroupAccountsByGroup queries group accounts by group id.
GroupAccountsByAdmin QueryGroupAccountsByAdminRequest QueryGroupAccountsByAdminResponse GroupsByAdmin queries group accounts by admin address.
Proposal QueryProposalRequest QueryProposalResponse Proposal queries a proposal based on proposal id.
ProposalsByGroupAccount QueryProposalsByGroupAccountRequest QueryProposalsByGroupAccountResponse ProposalsByGroupAccount queries proposals based on group account address.
VoteByProposalVoter QueryVoteByProposalVoterRequest QueryVoteByProposalVoterResponse VoteByProposalVoter queries a vote by proposal id and voter.
VotesByProposal QueryVotesByProposalRequest QueryVotesByProposalResponse VotesByProposal queries a vote by proposal.
VotesByVoter QueryVotesByVoterRequest QueryVotesByVoterResponse VotesByVoter queries a vote by voter.

Top

cosmos/group/v1beta1/tx.proto

MsgCreateGroupAccountRequest

MsgCreateGroupAccountRequest is the Msg/CreateGroupAccount request type.

Field Type Label Description
admin string admin is the account address of the group admin.
group_id uint64 group_id is the unique ID of the group.
metadata bytes metadata is any arbitrary metadata to attached to the group account.
decision_policy google.protobuf.Any decision_policy specifies the group account's decision policy.

MsgCreateGroupAccountResponse

MsgCreateGroupAccountResponse is the Msg/CreateGroupAccount response type.

Field Type Label Description
address string address is the account address of the newly created group account.

MsgCreateGroupRequest

MsgCreateGroupRequest is the Msg/CreateGroup request type.

Field Type Label Description
admin string admin is the account address of the group admin.
members Member repeated members defines the group members.
metadata bytes metadata is any arbitrary metadata to attached to the group.

MsgCreateGroupResponse

MsgCreateGroupResponse is the Msg/CreateGroup response type.

Field Type Label Description
group_id uint64 group_id is the unique ID of the newly created group.

MsgCreateProposalRequest

MsgCreateProposalRequest is the Msg/CreateProposal request type.

Field Type Label Description
address string address is the group account address.
proposers string repeated proposers are the account addresses of the proposers. Proposers signatures will be counted as yes votes.
metadata bytes metadata is any arbitrary metadata to attached to the proposal.
msgs google.protobuf.Any repeated msgs is a list of Msgs that will be executed if the proposal passes.
exec Exec exec defines the mode of execution of the proposal, whether it should be executed immediately on creation or not. If so, proposers signatures are considered as Yes votes.

MsgCreateProposalResponse

MsgCreateProposalResponse is the Msg/CreateProposal response type.

Field Type Label Description
proposal_id uint64 proposal is the unique ID of the proposal.

MsgExecRequest

MsgExecRequest is the Msg/Exec request type.

Field Type Label Description
proposal_id uint64 proposal is the unique ID of the proposal.
signer string signer is the account address used to execute the proposal.

MsgExecResponse

MsgExecResponse is the Msg/Exec request type.

MsgUpdateGroupAccountAdminRequest

MsgUpdateGroupAccountAdminRequest is the Msg/UpdateGroupAccountAdmin request type.

Field Type Label Description
admin string admin is the account address of the group admin.
address string address is the group account address.
new_admin string new_admin is the new group account admin.

MsgUpdateGroupAccountAdminResponse

MsgUpdateGroupAccountAdminResponse is the Msg/UpdateGroupAccountAdmin response type.

MsgUpdateGroupAccountDecisionPolicyRequest

MsgUpdateGroupAccountDecisionPolicyRequest is the Msg/UpdateGroupAccountDecisionPolicy request type.

Field Type Label Description
admin string admin is the account address of the group admin.
address string address is the group account address.
decision_policy google.protobuf.Any decision_policy is the updated group account decision policy.

MsgUpdateGroupAccountDecisionPolicyResponse

MsgUpdateGroupAccountDecisionPolicyResponse is the Msg/UpdateGroupAccountDecisionPolicy response type.

MsgUpdateGroupAccountMetadataRequest

MsgUpdateGroupAccountMetadataRequest is the Msg/UpdateGroupAccountMetadata request type.

Field Type Label Description
admin string admin is the account address of the group admin.
address string address is the group account address.
metadata bytes metadata is the updated group account metadata.

MsgUpdateGroupAccountMetadataResponse

MsgUpdateGroupAccountMetadataResponse is the Msg/UpdateGroupAccountMetadata response type.

MsgUpdateGroupAdminRequest

MsgUpdateGroupAdminRequest is the Msg/UpdateGroupAdmin request type.

Field Type Label Description
admin string admin is the current account address of the group admin.
group_id uint64 group_id is the unique ID of the group.
new_admin string new_admin is the group new admin account address.

MsgUpdateGroupAdminResponse

MsgUpdateGroupAdminResponse is the Msg/UpdateGroupAdmin response type.

MsgUpdateGroupMembersRequest

MsgUpdateGroupMembersRequest is the Msg/UpdateGroupMembers request type.

Field Type Label Description
admin string admin is the account address of the group admin.
group_id uint64 group_id is the unique ID of the group.
member_updates Member repeated member_updates is the list of members to update, set weight to 0 to remove a member.

MsgUpdateGroupMembersResponse

MsgUpdateGroupMembersResponse is the Msg/UpdateGroupMembers response type.

MsgUpdateGroupMetadataRequest

MsgUpdateGroupMetadataRequest is the Msg/UpdateGroupMetadata request type.

Field Type Label Description
admin string admin is the account address of the group admin.
group_id uint64 group_id is the unique ID of the group.
metadata bytes metadata is the updated group's metadata.

MsgUpdateGroupMetadataResponse

MsgUpdateGroupMetadataResponse is the Msg/UpdateGroupMetadata response type.

MsgVoteRequest

MsgVoteRequest is the Msg/Vote request type.

Field Type Label Description
proposal_id uint64 proposal is the unique ID of the proposal.
voter string voter is the voter account address.
choice Choice choice is the voter's choice on the proposal.
metadata bytes metadata is any arbitrary metadata to attached to the vote.
exec Exec exec defines whether the proposal should be executed immediately after voting or not.

MsgVoteResponse

MsgVoteResponse is the Msg/Vote response type.

Exec

Exec defines modes of execution of a proposal on creation or on new vote.

Name Number Description
EXEC_UNSPECIFIED 0 An empty value means that there should be a separate MsgExec request for the proposal to execute.
EXEC_TRY 1 Try to execute the proposal immediately. If the proposal is not allowed per the DecisionPolicy, the proposal will still be open and could be executed at a later point.

Msg

Msg is the cosmos.group.v1beta1 Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
CreateGroup MsgCreateGroupRequest MsgCreateGroupResponse CreateGroup creates a new group with an admin account address, a list of members and some optional metadata.
UpdateGroupMembers MsgUpdateGroupMembersRequest MsgUpdateGroupMembersResponse UpdateGroupMembers updates the group members with given group id and admin address.
UpdateGroupAdmin MsgUpdateGroupAdminRequest MsgUpdateGroupAdminResponse UpdateGroupAdmin updates the group admin with given group id and previous admin address.
UpdateGroupMetadata MsgUpdateGroupMetadataRequest MsgUpdateGroupMetadataResponse UpdateGroupMetadata updates the group metadata with given group id and admin address.
CreateGroupAccount MsgCreateGroupAccountRequest MsgCreateGroupAccountResponse CreateGroupAccount creates a new group account using given DecisionPolicy.
UpdateGroupAccountAdmin MsgUpdateGroupAccountAdminRequest MsgUpdateGroupAccountAdminResponse UpdateGroupAccountAdmin updates a group account admin.
UpdateGroupAccountDecisionPolicy MsgUpdateGroupAccountDecisionPolicyRequest MsgUpdateGroupAccountDecisionPolicyResponse UpdateGroupAccountDecisionPolicy allows a group account decision policy to be updated.
UpdateGroupAccountMetadata MsgUpdateGroupAccountMetadataRequest MsgUpdateGroupAccountMetadataResponse UpdateGroupAccountMetadata updates a group account metadata.
CreateProposal MsgCreateProposalRequest MsgCreateProposalResponse CreateProposal submits a new proposal.
Vote MsgVoteRequest MsgVoteResponse Vote allows a voter to vote on a proposal.
Exec MsgExecRequest MsgExecResponse Exec executes a proposal.

Top

cosmos/mint/v1beta1/mint.proto

Minter

Minter represents the minting state.

Field Type Label Description
inflation string current annual inflation rate
annual_provisions string current annual expected provisions

Params

Params holds parameters for the mint module.

Field Type Label Description
mint_denom string type of coin to mint
inflation_rate_change string maximum annual change in inflation rate
inflation_max string maximum inflation rate
inflation_min string minimum inflation rate
goal_bonded string goal of percent bonded atoms
blocks_per_year uint64 expected blocks per year

Top

cosmos/mint/v1beta1/genesis.proto

GenesisState

GenesisState defines the mint module's genesis state.

Field Type Label Description
minter Minter minter is a space for holding current inflation information.
params Params params defines all the paramaters of the module.

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 bytes 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 bytes 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 params defines the parameters of the module.

Query

Query provides defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params returns the total set of minting parameters. GET /cosmos/mint/v1beta1/params
Inflation QueryInflationRequest QueryInflationResponse Inflation returns the current minting inflation value. GET /cosmos/mint/v1beta1/inflation
AnnualProvisions QueryAnnualProvisionsRequest QueryAnnualProvisionsResponse AnnualProvisions current minting annual provisions value. GET /cosmos/mint/v1beta1/annual_provisions

Top

cosmos/nft/v1beta1/event.proto

EventBurn

EventBurn is emitted on Burn

Field Type Label Description
class_id string
id string
owner string

EventMint

EventMint is emitted on Mint

Field Type Label Description
class_id string
id string
owner string

EventSend

EventSend is emitted on Msg/Send

Field Type Label Description
class_id string
id string
sender string
receiver string

Top

cosmos/nft/v1beta1/nft.proto

Class

Class defines the class of the nft type.

Field Type Label Description
id string id defines the unique identifier of the NFT classification, similar to the contract address of ERC721
name string name defines the human-readable name of the NFT classification
symbol string symbol is an abbreviated name for nft classification
description string description is a brief description of nft classification
uri string uri is a URI may point to a JSON file that conforms to the nft classification Metadata JSON Schema.
uri_hash string uri_hash is a hash of the document pointed to uri

NFT

NFT defines the NFT.

Field Type Label Description
class_id string class_id defines the unique identifier of the NFT classification, similar to the contract address of ERC721
id string id defines the unique identification of NFT
uri string uri defines NFT's metadata storage address outside the chain
uri_hash string uri_hash is a hash of the document pointed to uri
data google.protobuf.Any data is the metadata of the NFT

Top

cosmos/nft/v1beta1/genesis.proto

Entry

Entry Defines all nft owned by a person

Field Type Label Description
owner string owner is the owner address of the following nft
nfts NFT repeated nfts is a group of nfts of the same owner

GenesisState

GenesisState defines the nft module's genesis state.

Field Type Label Description
classes Class repeated class defines the class of the nft type.
entries Entry repeated

Top

cosmos/nft/v1beta1/query.proto

QueryBalanceRequest

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

Field Type Label Description
class_id string
owner string

QueryBalanceResponse

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

Field Type Label Description
amount uint64

QueryClassRequest

QueryClassRequest is the request type for the Query/Class RPC method

Field Type Label Description
class_id string

QueryClassResponse

QueryClassResponse is the response type for the Query/Class RPC method

Field Type Label Description
class Class

QueryClassesRequest

QueryClassesRequest is the request type for the Query/Classes RPC method

Field Type Label Description
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryClassesResponse

QueryClassesResponse is the response type for the Query/Classes RPC method

Field Type Label Description
classes Class repeated
pagination cosmos.base.query.v1beta1.PageResponse

QueryNFTRequest

QueryNFTRequest is the request type for the Query/NFT RPC method

Field Type Label Description
class_id string
id string

QueryNFTResponse

QueryNFTResponse is the response type for the Query/NFT RPC method

Field Type Label Description
nft NFT

QueryNFTsOfClassRequest

QueryNFTsOfClassRequest is the request type for the Query/NFTsOfClass RPC method

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

QueryNFTsOfClassResponse

QueryNFTsOfClassResponse is the response type for the Query/NFTsOfClass and Query/NFTsOfClassByOwner RPC methods

Field Type Label Description
nfts NFT repeated
pagination cosmos.base.query.v1beta1.PageResponse

QueryOwnerRequest

QueryOwnerRequest is the request type for the Query/Owner RPC method

Field Type Label Description
class_id string
id string

QueryOwnerResponse

QueryOwnerResponse is the response type for the Query/Owner RPC method

Field Type Label Description
owner string

QuerySupplyRequest

QuerySupplyRequest is the request type for the Query/Supply RPC method

Field Type Label Description
class_id string

QuerySupplyResponse

QuerySupplyResponse is the response type for the Query/Supply RPC method

Field Type Label Description
amount uint64

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Balance QueryBalanceRequest QueryBalanceResponse Balance queries the number of NFTs of a given class owned by the owner, same as balanceOf in ERC721 GET /cosmos/nft/v1beta1/balance/{class_id}/{owner}
Owner QueryOwnerRequest QueryOwnerResponse Owner queries the owner of the NFT based on its class and id, same as ownerOf in ERC721 GET /cosmos/nft/v1beta1/owner/{class_id}/{id}
Supply QuerySupplyRequest QuerySupplyResponse Supply queries the number of NFTs from the given class, same as totalSupply of ERC721. GET /cosmos/nft/v1beta1/supply/{class_id}
NFTsOfClass QueryNFTsOfClassRequest QueryNFTsOfClassResponse NFTsOfClass queries all NFTs of a given class or optional owner, similar to tokenByIndex in ERC721Enumerable GET /cosmos/nft/v1beta1/nfts/{class_id}
NFT QueryNFTRequest QueryNFTResponse NFT queries an NFT based on its class and id. GET /cosmos/nft/v1beta1/nfts/{class_id}/{id}
Class QueryClassRequest QueryClassResponse Class queries an NFT class based on its id GET /cosmos/nft/v1beta1/classes/{class_id}
Classes QueryClassesRequest QueryClassesResponse Classes queries all NFT classes GET /cosmos/nft/v1beta1/classes

Top

cosmos/nft/v1beta1/tx.proto

MsgSend

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

Field Type Label Description
class_id string class_id defines the unique identifier of the nft classification, similar to the contract address of ERC721
id string id defines the unique identification of nft
sender string sender is the address of the owner of nft
receiver string receiver is the receiver address of nft

MsgSendResponse

MsgSendResponse defines the Msg/Send response type.

Msg

Msg defines the nft Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Send MsgSend MsgSendResponse Send defines a method to send a nft from one account to another account.

Top

cosmos/params/v1beta1/params.proto

ParamChange

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

Field Type Label Description
subspace string
key string
value string

ParameterChangeProposal

ParameterChangeProposal defines a proposal to change one or more parameters.

Field Type Label Description
title string
description string
changes ParamChange repeated

Top

cosmos/params/v1beta1/query.proto

QueryParamsRequest

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

Field Type Label Description
subspace string subspace defines the module to query the parameter for.
key string key defines the key of the parameter in the subspace.

QueryParamsResponse

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

Field Type Label Description
param ParamChange param defines the queried parameter.

QuerySubspacesRequest

QuerySubspacesRequest defines a request type for querying for all registered subspaces and all keys for a subspace.

QuerySubspacesResponse

QuerySubspacesResponse defines the response types for querying for all registered subspaces and all keys for a subspace.

Field Type Label Description
subspaces Subspace repeated

Subspace

Subspace defines a parameter subspace name and all the keys that exist for the subspace.

Field Type Label Description
subspace string
keys string repeated

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries a specific parameter of a module, given its subspace and key. GET /cosmos/params/v1beta1/params
Subspaces QuerySubspacesRequest QuerySubspacesResponse Subspaces queries for all registered subspaces and all keys for a subspace. GET /cosmos/params/v1beta1/subspaces

Top

cosmos/slashing/v1beta1/slashing.proto

Params

Params represents the parameters used for by the slashing module.

Field Type Label Description
signed_blocks_window int64
min_signed_per_window bytes
downtime_jail_duration google.protobuf.Duration
slash_fraction_double_sign bytes
slash_fraction_downtime bytes

ValidatorSigningInfo

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

Field Type Label Description
address string
start_height int64 Height at which validator was first a candidate OR was unjailed
index_offset int64 Index which is incremented each time the validator was a bonded in a block and may have signed a precommit or not. This in conjunction with the SignedBlocksWindow param determines the index in the MissedBlocksBitArray.
jailed_until google.protobuf.Timestamp Timestamp until which the validator is jailed due to liveness downtime.
tombstoned bool Whether or not a validator has been tombstoned (killed out of validator set). It is set once the validator commits an equivocation or for any other configured misbehiavor.
missed_blocks_counter int64 A counter kept to avoid unnecessary array reads. Note that Sum(MissedBlocksBitArray) always equals MissedBlocksCounter.

Top

cosmos/slashing/v1beta1/genesis.proto

GenesisState

GenesisState defines the slashing module's genesis state.

Field Type Label Description
params Params params defines all the paramaters of related to deposit.
signing_infos SigningInfo repeated signing_infos represents a map between validator addresses and their signing infos.
missed_blocks ValidatorMissedBlocks repeated missed_blocks represents a map between validator addresses and their missed blocks.

MissedBlock

MissedBlock contains height and missed status as boolean.

Field Type Label Description
index int64 index is the height at which the block was missed.
missed bool missed is the missed status.

SigningInfo

SigningInfo stores validator signing info of corresponding address.

Field Type Label Description
address string address is the validator address.
validator_signing_info ValidatorSigningInfo validator_signing_info represents the signing info of this validator.

ValidatorMissedBlocks

ValidatorMissedBlocks contains array of missed blocks of corresponding address.

Field Type Label Description
address string address is the validator address.
missed_blocks MissedBlock repeated missed_blocks is an array of missed blocks by the validator.

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

Field Type Label Description
params Params

QuerySigningInfoRequest

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

Field Type Label Description
cons_address string cons_address is the address to query signing info of

QuerySigningInfoResponse

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

Field Type Label Description
val_signing_info ValidatorSigningInfo val_signing_info is the signing info of requested val cons address

QuerySigningInfosRequest

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

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

QuerySigningInfosResponse

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

Field Type Label Description
info ValidatorSigningInfo repeated info is the signing info of all validators
pagination cosmos.base.query.v1beta1.PageResponse

Query

Query provides defines the gRPC querier service

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries the parameters of slashing module GET /cosmos/slashing/v1beta1/params
SigningInfo QuerySigningInfoRequest QuerySigningInfoResponse SigningInfo queries the signing info of given cons address GET /cosmos/slashing/v1beta1/signing_infos/{cons_address}
SigningInfos QuerySigningInfosRequest QuerySigningInfosResponse SigningInfos queries signing info of all validators GET /cosmos/slashing/v1beta1/signing_infos

Top

cosmos/slashing/v1beta1/tx.proto

MsgUnjail

MsgUnjail defines the Msg/Unjail request type

Field Type Label Description
validator_addr string

MsgUnjailResponse

MsgUnjailResponse defines the Msg/Unjail response type

Msg

Msg defines the slashing Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Unjail MsgUnjail MsgUnjailResponse Unjail 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/staking/v1beta1/authz.proto

StakeAuthorization

StakeAuthorization defines authorization for delegate/undelegate/redelegate.

Since: cosmos-sdk 0.43

Field Type Label Description
max_tokens cosmos.base.v1beta1.Coin max_tokens specifies the maximum amount of tokens can be delegate to a validator. If it is empty, there is no spend limit and any amount of coins can be delegated.
allow_list StakeAuthorization.Validators allow_list specifies list of validator addresses to whom grantee can delegate tokens on behalf of granter's account.
deny_list StakeAuthorization.Validators deny_list specifies list of validator addresses to whom grantee can not delegate tokens.
authorization_type AuthorizationType authorization_type defines one of AuthorizationType.

StakeAuthorization.Validators

Validators defines list of validator addresses.

Field Type Label Description
address string repeated

AuthorizationType

AuthorizationType defines the type of staking module authorization type

Since: cosmos-sdk 0.43

Name Number Description
AUTHORIZATION_TYPE_UNSPECIFIED 0 AUTHORIZATION_TYPE_UNSPECIFIED specifies an unknown authorization type
AUTHORIZATION_TYPE_DELEGATE 1 AUTHORIZATION_TYPE_DELEGATE defines an authorization type for Msg/Delegate
AUTHORIZATION_TYPE_UNDELEGATE 2 AUTHORIZATION_TYPE_UNDELEGATE defines an authorization type for Msg/Undelegate
AUTHORIZATION_TYPE_REDELEGATE 3 AUTHORIZATION_TYPE_REDELEGATE defines an authorization type for Msg/BeginRedelegate

Top

cosmos/staking/v1beta1/staking.proto

Commission

Commission defines commission parameters for a given validator.

Field Type Label Description
commission_rates CommissionRates commission_rates defines the initial commission rates to be used for creating a validator.
update_time google.protobuf.Timestamp update_time is the last time the commission rate was changed.

CommissionRates

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

Field Type Label Description
rate string rate is the commission rate charged to delegators, as a fraction.
max_rate string max_rate defines the maximum commission rate which validator can ever charge, as a fraction.
max_change_rate string max_change_rate defines the maximum daily increase of the validator commission, as a fraction.

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.

Field Type Label Description
delegator_address string
validator_address string

DVPairs

DVPairs defines an array of DVPair objects.

Field Type Label Description
pairs DVPair repeated

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.

Field Type Label Description
delegator_address string
validator_src_address string
validator_dst_address string

DVVTriplets

DVVTriplets defines an array of DVVTriplet objects.

Field Type Label Description
triplets DVVTriplet repeated

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.

Field Type Label Description
delegator_address string delegator_address is the bech32-encoded address of the delegator.
validator_address string validator_address is the bech32-encoded address of the validator.
shares string shares define the delegation shares received.

DelegationResponse

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

Field Type Label Description
delegation Delegation
balance cosmos.base.v1beta1.Coin

Description

Description defines a validator description.

Field Type Label Description
moniker string moniker defines a human-readable name for the validator.
identity string identity defines an optional identity signature (ex. UPort or Keybase).
website string website defines an optional website link.
security_contact string security_contact defines an optional email for security contact.
details string details define other optional details.

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

Field Type Label Description
header tendermint.types.Header
valset Validator repeated

Params

Params defines the parameters for the staking module.

Field Type Label Description
unbonding_time google.protobuf.Duration unbonding_time is the time duration of unbonding.
max_validators uint32 max_validators is the maximum number of validators.
max_entries uint32 max_entries is the max entries for either unbonding delegation or redelegation (per pair/trio).
historical_entries uint32 historical_entries is the number of historical entries to persist.
bond_denom string bond_denom defines the bondable coin denomination.

Pool

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

Field Type Label Description
not_bonded_tokens string
bonded_tokens string

Redelegation

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

Field Type Label Description
delegator_address string delegator_address is the bech32-encoded address of the delegator.
validator_src_address string validator_src_address is the validator redelegation source operator address.
validator_dst_address string validator_dst_address is the validator redelegation destination operator address.
entries RedelegationEntry repeated entries are the redelegation entries.

redelegation entries |

RedelegationEntry

RedelegationEntry defines a redelegation object with relevant metadata.

Field Type Label Description
creation_height int64 creation_height defines the height which the redelegation took place.
completion_time google.protobuf.Timestamp completion_time defines the unix time for redelegation completion.
initial_balance string initial_balance defines the initial balance when redelegation started.
shares_dst string shares_dst is the amount of destination-validator shares created by redelegation.

RedelegationEntryResponse

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

Field Type Label Description
redelegation_entry RedelegationEntry
balance string

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.

Field Type Label Description
redelegation Redelegation
entries RedelegationEntryResponse repeated

UnbondingDelegation

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

Field Type Label Description
delegator_address string delegator_address is the bech32-encoded address of the delegator.
validator_address string validator_address is the bech32-encoded address of the validator.
entries UnbondingDelegationEntry repeated entries are the unbonding delegation entries.

unbonding delegation entries |

UnbondingDelegationEntry

UnbondingDelegationEntry defines an unbonding object with relevant metadata.

Field Type Label Description
creation_height int64 creation_height is the height which the unbonding took place.
completion_time google.protobuf.Timestamp completion_time is the unix time for unbonding completion.
initial_balance string initial_balance defines the tokens initially scheduled to receive at completion.
balance string balance defines the tokens to receive at completion.

ValAddresses

ValAddresses defines a repeated set of validator addresses.

Field Type Label Description
addresses string repeated

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.

Field Type Label Description
operator_address string operator_address defines the address of the validator's operator; bech encoded in JSON.
consensus_pubkey google.protobuf.Any consensus_pubkey is the consensus public key of the validator, as a Protobuf Any.
jailed bool jailed defined whether the validator has been jailed from bonded status or not.
status BondStatus status is the validator status (bonded/unbonding/unbonded).
tokens string tokens define the delegated tokens (incl. self-delegation).
delegator_shares string delegator_shares defines total shares issued to a validator's delegators.
description Description description defines the description terms for the validator.
unbonding_height int64 unbonding_height defines, if unbonding, the height at which this validator has begun unbonding.
unbonding_time google.protobuf.Timestamp unbonding_time defines, if unbonding, the min time for the validator to complete unbonding.
commission Commission commission defines the commission parameters.
min_self_delegation string min_self_delegation is the validator's self declared minimum self delegation.

BondStatus

BondStatus is the status of a validator.

Name Number Description
BOND_STATUS_UNSPECIFIED 0 UNSPECIFIED defines an invalid validator status.
BOND_STATUS_UNBONDED 1 UNBONDED defines a validator that is not bonded.
BOND_STATUS_UNBONDING 2 UNBONDING defines a validator that is unbonding.
BOND_STATUS_BONDED 3 BONDED defines a validator that is bonded.

Top

cosmos/staking/v1beta1/genesis.proto

GenesisState

GenesisState defines the staking module's genesis state.

Field Type Label Description
params Params params defines all the paramaters of related to deposit.
last_total_power bytes last_total_power tracks the total amounts of bonded tokens recorded during the previous end block.
last_validator_powers LastValidatorPower repeated last_validator_powers is a special index that provides a historical list of the last-block's bonded validators.
validators Validator repeated delegations defines the validator set at genesis.
delegations Delegation repeated delegations defines the delegations active at genesis.
unbonding_delegations UnbondingDelegation repeated unbonding_delegations defines the unbonding delegations active at genesis.
redelegations Redelegation repeated redelegations defines the redelegations active at genesis.
exported bool

LastValidatorPower

LastValidatorPower required for validator set update logic.

Field Type Label Description
address string address is the address of the validator.
power int64 power defines the power of the validator.

Top

cosmos/staking/v1beta1/query.proto

QueryDelegationRequest

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

Field Type Label Description
delegator_addr string delegator_addr defines the delegator address to query for.
validator_addr string validator_addr defines the validator address to query for.

QueryDelegationResponse

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

Field Type Label Description
delegation_response DelegationResponse delegation_responses defines the delegation info of a delegation.

QueryDelegatorDelegationsRequest

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

Field Type Label Description
delegator_addr string delegator_addr defines the delegator address to query for.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryDelegatorDelegationsResponse

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

Field Type Label Description
delegation_responses DelegationResponse repeated delegation_responses defines all the delegations' info of a delegator.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryDelegatorUnbondingDelegationsRequest

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

Field Type Label Description
delegator_addr string delegator_addr defines the delegator address to query for.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryDelegatorUnbondingDelegationsResponse

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

Field Type Label Description
unbonding_responses UnbondingDelegation repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryDelegatorValidatorRequest

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

Field Type Label Description
delegator_addr string delegator_addr defines the delegator address to query for.
validator_addr string validator_addr defines the validator address to query for.

QueryDelegatorValidatorResponse

QueryDelegatorValidatorResponse response type for the Query/DelegatorValidator RPC method.

Field Type Label Description
validator Validator validator defines the the validator info.

QueryDelegatorValidatorsRequest

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

Field Type Label Description
delegator_addr string delegator_addr defines the delegator address to query for.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryDelegatorValidatorsResponse

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

Field Type Label Description
validators Validator repeated validators defines the the validators' info of a delegator.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryHistoricalInfoRequest

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

Field Type Label Description
height int64 height defines at which height to query the historical info.

QueryHistoricalInfoResponse

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

Field Type Label Description
hist HistoricalInfo hist 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.

Field Type Label Description
params Params params 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.

Field Type Label Description
pool Pool pool defines the pool info.

QueryRedelegationsRequest

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

Field Type Label Description
delegator_addr string delegator_addr defines the delegator address to query for.
src_validator_addr string src_validator_addr defines the validator address to redelegate from.
dst_validator_addr string dst_validator_addr defines the validator address to redelegate to.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryRedelegationsResponse

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

Field Type Label Description
redelegation_responses RedelegationResponse repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryUnbondingDelegationRequest

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

Field Type Label Description
delegator_addr string delegator_addr defines the delegator address to query for.
validator_addr string validator_addr defines the validator address to query for.

QueryUnbondingDelegationResponse

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

Field Type Label Description
unbond UnbondingDelegation unbond defines the unbonding information of a delegation.

QueryValidatorDelegationsRequest

QueryValidatorDelegationsRequest is request type for the Query/ValidatorDelegations RPC method

Field Type Label Description
validator_addr string validator_addr defines the validator address to query for.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryValidatorDelegationsResponse

QueryValidatorDelegationsResponse is response type for the Query/ValidatorDelegations RPC method

Field Type Label Description
delegation_responses DelegationResponse repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryValidatorRequest

QueryValidatorRequest is response type for the Query/Validator RPC method

Field Type Label Description
validator_addr string validator_addr defines the validator address to query for.

QueryValidatorResponse

QueryValidatorResponse is response type for the Query/Validator RPC method

Field Type Label Description
validator Validator validator defines the the validator info.

QueryValidatorUnbondingDelegationsRequest

QueryValidatorUnbondingDelegationsRequest is required type for the Query/ValidatorUnbondingDelegations RPC method

Field Type Label Description
validator_addr string validator_addr defines the validator address to query for.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryValidatorUnbondingDelegationsResponse

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

Field Type Label Description
unbonding_responses UnbondingDelegation repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryValidatorsRequest

QueryValidatorsRequest is request type for Query/Validators RPC method.

Field Type Label Description
status string status enables to query for validators matching a given status.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryValidatorsResponse

QueryValidatorsResponse is response type for the Query/Validators RPC method

Field Type Label Description
validators Validator repeated validators contains all the queried validators.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Validators QueryValidatorsRequest QueryValidatorsResponse Validators queries all validators that match the given status. GET /cosmos/staking/v1beta1/validators
Validator QueryValidatorRequest QueryValidatorResponse Validator queries validator info for given validator address. GET /cosmos/staking/v1beta1/validators/{validator_addr}
ValidatorDelegations QueryValidatorDelegationsRequest QueryValidatorDelegationsResponse ValidatorDelegations queries delegate info for given validator. GET /cosmos/staking/v1beta1/validators/{validator_addr}/delegations
ValidatorUnbondingDelegations QueryValidatorUnbondingDelegationsRequest QueryValidatorUnbondingDelegationsResponse ValidatorUnbondingDelegations queries unbonding delegations of a validator. GET /cosmos/staking/v1beta1/validators/{validator_addr}/unbonding_delegations
Delegation QueryDelegationRequest QueryDelegationResponse Delegation queries delegate info for given validator delegator pair. GET /cosmos/staking/v1beta1/validators/{validator_addr}/delegations/{delegator_addr}
UnbondingDelegation QueryUnbondingDelegationRequest QueryUnbondingDelegationResponse UnbondingDelegation queries unbonding info for given validator delegator pair. GET /cosmos/staking/v1beta1/validators/{validator_addr}/delegations/{delegator_addr}/unbonding_delegation
DelegatorDelegations QueryDelegatorDelegationsRequest QueryDelegatorDelegationsResponse DelegatorDelegations queries all delegations of a given delegator address. GET /cosmos/staking/v1beta1/delegations/{delegator_addr}
DelegatorUnbondingDelegations QueryDelegatorUnbondingDelegationsRequest QueryDelegatorUnbondingDelegationsResponse DelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address. GET /cosmos/staking/v1beta1/delegators/{delegator_addr}/unbonding_delegations
Redelegations QueryRedelegationsRequest QueryRedelegationsResponse Redelegations queries redelegations of given address. GET /cosmos/staking/v1beta1/delegators/{delegator_addr}/redelegations
DelegatorValidators QueryDelegatorValidatorsRequest QueryDelegatorValidatorsResponse DelegatorValidators queries all validators info for given delegator address. GET /cosmos/staking/v1beta1/delegators/{delegator_addr}/validators
DelegatorValidator QueryDelegatorValidatorRequest QueryDelegatorValidatorResponse DelegatorValidator queries validator info for given delegator validator pair. GET /cosmos/staking/v1beta1/delegators/{delegator_addr}/validators/{validator_addr}
HistoricalInfo QueryHistoricalInfoRequest QueryHistoricalInfoResponse HistoricalInfo queries the historical info for given height. GET /cosmos/staking/v1beta1/historical_info/{height}
Pool QueryPoolRequest QueryPoolResponse Pool queries the pool info. GET /cosmos/staking/v1beta1/pool
Params QueryParamsRequest QueryParamsResponse Parameters queries the staking parameters. GET /cosmos/staking/v1beta1/params

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.

Field Type Label Description
delegator_address string
validator_src_address string
validator_dst_address string
amount cosmos.base.v1beta1.Coin

MsgBeginRedelegateResponse

MsgBeginRedelegateResponse defines the Msg/BeginRedelegate response type.

Field Type Label Description
completion_time google.protobuf.Timestamp

MsgCreateValidator

MsgCreateValidator defines a SDK message for creating a new validator.

Field Type Label Description
description Description
commission CommissionRates
min_self_delegation string
delegator_address string
validator_address string
pubkey google.protobuf.Any
value cosmos.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.

Field Type Label Description
delegator_address string
validator_address string
amount cosmos.base.v1beta1.Coin

MsgDelegateResponse

MsgDelegateResponse defines the Msg/Delegate response type.

MsgEditValidator

MsgEditValidator defines a SDK message for editing an existing validator.

Field Type Label Description
description Description
validator_address string
commission_rate string We 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.

Field Type Label Description
delegator_address string
validator_address string
amount cosmos.base.v1beta1.Coin

MsgUndelegateResponse

MsgUndelegateResponse defines the Msg/Undelegate response type.

Field Type Label Description
completion_time google.protobuf.Timestamp

Msg

Msg defines the staking Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
CreateValidator MsgCreateValidator MsgCreateValidatorResponse CreateValidator defines a method for creating a new validator.
EditValidator MsgEditValidator MsgEditValidatorResponse EditValidator defines a method for editing an existing validator.
Delegate MsgDelegate MsgDelegateResponse Delegate defines a method for performing a delegation of coins from a delegator to a validator.
BeginRedelegate MsgBeginRedelegate MsgBeginRedelegateResponse BeginRedelegate defines a method for performing a redelegation of coins from a delegator and source validator to a destination validator.
Undelegate MsgUndelegate MsgUndelegateResponse Undelegate defines a method for performing an undelegation from a delegate and a validator.

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.

Field Type Label Description
public_key google.protobuf.Any public_key is the public key of the signer
data SignatureDescriptor.Data
sequence uint64 sequence 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

Field Type Label Description
single SignatureDescriptor.Data.Single single represents a single signer
multi SignatureDescriptor.Data.Multi multi represents a multisig signer

SignatureDescriptor.Data.Multi

Multi is the signature data for a multisig public key

Field Type Label Description
bitarray cosmos.crypto.multisig.v1beta1.CompactBitArray bitarray specifies which keys within the multisig are signing
signatures SignatureDescriptor.Data repeated signatures is the signatures of the multi-signature

SignatureDescriptor.Data.Single

Single is the signature data for a single signer

Field Type Label Description
mode SignMode mode is the signing mode of the single signer
signature bytes signature is the raw signature bytes

SignatureDescriptors

SignatureDescriptors wraps multiple SignatureDescriptor's.

Field Type Label Description
signatures SignatureDescriptor repeated signatures are the signature descriptors

SignMode

SignMode represents a signing mode with its own security guarantees.

Name Number Description
SIGN_MODE_UNSPECIFIED 0 SIGN_MODE_UNSPECIFIED specifies an unknown signing mode and will be rejected.
SIGN_MODE_DIRECT 1 SIGN_MODE_DIRECT specifies a signing mode which uses SignDoc and is verified with raw bytes from Tx.
SIGN_MODE_TEXTUAL 2 SIGN_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. It is currently not supported.
SIGN_MODE_DIRECT_AUX 3 SIGN_MODE_DIRECT_AUX specifies a signing mode which uses SignDocDirectAux. As opposed to SIGN_MODE_DIRECT, this sign mode does not require signers signing over other signers' signer_info. It also allows for adding Tips in transactions.
SIGN_MODE_LEGACY_AMINO_JSON 127 SIGN_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.

Field Type Label Description
signer_infos SignerInfo repeated signer_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.
fee Fee Fee 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.
tip Tip Tip is the optional tip used for meta-transactions.

Since: cosmos-sdk 0.45 |

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.

Field Type Label Description
amount cosmos.base.v1beta1.Coin repeated amount is the amount of coins to be paid as a fee
gas_limit uint64 gas_limit is the maximum gas that can be used in transaction processing before an out of gas error occurs
payer string if 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.
granter string if 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.

Field Type Label Description
single ModeInfo.Single single represents a single signer
multi ModeInfo.Multi multi represents a nested multisig signer

ModeInfo.Multi

Multi is the mode info for a multisig public key

Field Type Label Description
bitarray cosmos.crypto.multisig.v1beta1.CompactBitArray bitarray specifies which keys within the multisig are signing
mode_infos ModeInfo repeated mode_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

Field Type Label Description
mode cosmos.tx.signing.v1beta1.SignMode mode is the signing mode of the single signer

SignDoc

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

Field Type Label Description
body_bytes bytes body_bytes is protobuf serialization of a TxBody that matches the representation in TxRaw.
auth_info_bytes bytes auth_info_bytes is a protobuf serialization of an AuthInfo that matches the representation in TxRaw.
chain_id string chain_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_number uint64 account_number is the account number of the account in state

SignDocDirectAux

SignDocDirectAux is the type used for generating sign bytes for SIGN_MODE_DIRECT_AUX.

Field Type Label Description
body_bytes bytes body_bytes is protobuf serialization of a TxBody that matches the representation in TxRaw.
public_key google.protobuf.Any public_key is the public key of the signing account.
chain_id string chain_id is the identifier of the chain this transaction targets. It prevents signed transactions from being used on another chain by an attacker.
account_number uint64 account_number is the account number of the account in state.
sequence uint64 sequence is the sequence number of the signing account.
tip Tip Tip is the optional tip used for meta-transactions. It should be left empty if the signer is not the tipper for this transaction.

SignerInfo

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

Field Type Label Description
public_key google.protobuf.Any public_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_info ModeInfo mode_info describes the signing mode of the signer and is a nested structure to support nested multisig pubkey's
sequence uint64 sequence 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.

Tip

Tip is the tip used for meta-transactions.

Field Type Label Description
amount cosmos.base.v1beta1.Coin repeated amount is the amount of the tip
tipper string tipper is the address of the account paying for the tip

Tx

Tx is the standard type used for broadcasting transactions.

Field Type Label Description
body TxBody body is the processable content of the transaction
auth_info AuthInfo auth_info is the authorization related content of the transaction, specifically signers, signer modes and fee
signatures bytes repeated signatures 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.

Field Type Label Description
messages google.protobuf.Any repeated messages 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 note/comment to be added to the transaction. WARNING: in clients, any publicly exposed text should not be called memo, but should be called note instead (see https://github.com/cosmos/cosmos-sdk/issues/9122).
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.

Field Type Label Description
body_bytes bytes body_bytes is a protobuf serialization of a TxBody that matches the representation in SignDoc.
auth_info_bytes bytes auth_info_bytes is a protobuf serialization of an AuthInfo that matches the representation in SignDoc.
signatures bytes repeated signatures 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/tx/v1beta1/service.proto

BroadcastTxRequest

BroadcastTxRequest is the request type for the Service.BroadcastTxRequest RPC method.

Field Type Label Description
tx_bytes bytes tx_bytes is the raw transaction.
mode BroadcastMode

BroadcastTxResponse

BroadcastTxResponse is the response type for the Service.BroadcastTx method.

Field Type Label Description
tx_response cosmos.base.abci.v1beta1.TxResponse tx_response is the queried TxResponses.

GetTxRequest

GetTxRequest is the request type for the Service.GetTx RPC method.

Field Type Label Description
hash string hash is the tx hash to query, encoded as a hex string.

GetTxResponse

GetTxResponse is the response type for the Service.GetTx method.

Field Type Label Description
tx Tx tx is the queried transaction.
tx_response cosmos.base.abci.v1beta1.TxResponse tx_response is the queried TxResponses.

GetTxsEventRequest

GetTxsEventRequest is the request type for the Service.TxsByEvents RPC method.

Field Type Label Description
events string repeated events is the list of transaction event type.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an pagination for the request.
order_by OrderBy

GetTxsEventResponse

GetTxsEventResponse is the response type for the Service.TxsByEvents RPC method.

Field Type Label Description
txs Tx repeated txs is the list of queried transactions.
tx_responses cosmos.base.abci.v1beta1.TxResponse repeated tx_responses is the list of queried TxResponses.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines an pagination for the response.

SimulateRequest

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

Field Type Label Description
tx Tx Deprecated. tx is the transaction to simulate. Deprecated. Send raw tx bytes instead.
tx_bytes bytes tx_bytes is the raw transaction.

Since: cosmos-sdk 0.43 |

SimulateResponse

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

Field Type Label Description
gas_info cosmos.base.abci.v1beta1.GasInfo gas_info is the information about gas used in the simulation.
result cosmos.base.abci.v1beta1.Result result is the result of the simulation.

BroadcastMode

BroadcastMode specifies the broadcast mode for the TxService.Broadcast RPC method.

Name Number Description
BROADCAST_MODE_UNSPECIFIED 0 zero-value for mode ordering
BROADCAST_MODE_BLOCK 1 BROADCAST_MODE_BLOCK defines a tx broadcasting mode where the client waits for the tx to be committed in a block.
BROADCAST_MODE_SYNC 2 BROADCAST_MODE_SYNC defines a tx broadcasting mode where the client waits for a CheckTx execution response only.
BROADCAST_MODE_ASYNC 3 BROADCAST_MODE_ASYNC defines a tx broadcasting mode where the client returns immediately.

OrderBy

OrderBy defines the sorting order

Name Number Description
ORDER_BY_UNSPECIFIED 0 ORDER_BY_UNSPECIFIED specifies an unknown sorting order. OrderBy defaults to ASC in this case.
ORDER_BY_ASC 1 ORDER_BY_ASC defines ascending order
ORDER_BY_DESC 2 ORDER_BY_DESC defines descending order

Service

Service defines a gRPC service for interacting with transactions.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Simulate SimulateRequest SimulateResponse Simulate simulates executing a transaction for estimating gas usage. POST /cosmos/tx/v1beta1/simulate
GetTx GetTxRequest GetTxResponse GetTx fetches a tx by hash. GET /cosmos/tx/v1beta1/txs/{hash}
BroadcastTx BroadcastTxRequest BroadcastTxResponse BroadcastTx broadcast transaction. POST /cosmos/tx/v1beta1/txs
GetTxsEvent GetTxsEventRequest GetTxsEventResponse GetTxsEvent fetches txs by event. GET /cosmos/tx/v1beta1/txs

Top

cosmos/upgrade/v1beta1/upgrade.proto

CancelSoftwareUpgradeProposal

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

Field Type Label Description
title string
description string

ModuleVersion

ModuleVersion specifies a module and its consensus version.

Since: cosmos-sdk 0.43

Field Type Label Description
name string name of the app module
version uint64 consensus version of the app module

Plan

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

Field Type Label Description
name string 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 google.protobuf.Timestamp Deprecated. Deprecated: Time based upgrades have been deprecated. Time based upgrade logic has been removed from the SDK. If this field is not empty, an error will be thrown.
height int64 The height at which the upgrade must be performed. Only used if Time is not set.
info string Any application specific upgrade info to be included on-chain such as a git commit that validators could automatically upgrade to
upgraded_client_state google.protobuf.Any Deprecated. Deprecated: UpgradedClientState field has been deprecated. IBC upgrade logic has been moved to the IBC module in the sub module 02-client. If this field is not empty, an error will be thrown.

SoftwareUpgradeProposal

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

Field Type Label Description
title string
description string
plan Plan

Top

cosmos/upgrade/v1beta1/query.proto

QueryAppliedPlanRequest

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

Field Type Label Description
name string 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 int64 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 plan is the current upgrade plan.

QueryModuleVersionsRequest

QueryModuleVersionsRequest is the request type for the Query/ModuleVersions RPC method.

Since: cosmos-sdk 0.43

Field Type Label Description
module_name string module_name is a field to query a specific module consensus version from state. Leaving this empty will fetch the full list of module versions from state

QueryModuleVersionsResponse

QueryModuleVersionsResponse is the response type for the Query/ModuleVersions RPC method.

Since: cosmos-sdk 0.43

Field Type Label Description
module_versions ModuleVersion repeated module_versions is a list of module names with their consensus versions.

QueryUpgradedConsensusStateRequest

QueryUpgradedConsensusStateRequest is the request type for the Query/UpgradedConsensusState RPC method.

Field Type Label Description
last_height int64 last height of the current chain must be sent in request as this is the height under which next consensus state is stored

QueryUpgradedConsensusStateResponse

QueryUpgradedConsensusStateResponse is the response type for the Query/UpgradedConsensusState RPC method.

Field Type Label Description
upgraded_consensus_state bytes Since: cosmos-sdk 0.43

Query

Query defines the gRPC upgrade querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
CurrentPlan QueryCurrentPlanRequest QueryCurrentPlanResponse CurrentPlan queries the current upgrade plan. GET /cosmos/upgrade/v1beta1/current_plan
AppliedPlan QueryAppliedPlanRequest QueryAppliedPlanResponse AppliedPlan queries a previously applied upgrade plan by its name. GET /cosmos/upgrade/v1beta1/applied_plan/{name}
UpgradedConsensusState QueryUpgradedConsensusStateRequest QueryUpgradedConsensusStateResponse UpgradedConsensusState queries the consensus state that will serve as a trusted kernel for the next version of this chain. It will only be stored at the last height of this chain. UpgradedConsensusState RPC not supported with legacy querier This rpc is deprecated now that IBC has its own replacement (2c880a22e9/proto/ibc/core/client/v1/query.proto (L54)) GET /cosmos/upgrade/v1beta1/upgraded_consensus_state/{last_height}
ModuleVersions QueryModuleVersionsRequest QueryModuleVersionsResponse ModuleVersions queries the list of module versions from state.

Since: cosmos-sdk 0.43 | GET|/cosmos/upgrade/v1beta1/module_versions|

Top

cosmos/vesting/v1beta1/vesting.proto

BaseVestingAccount

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

Field Type Label Description
base_account cosmos.auth.v1beta1.BaseAccount
original_vesting cosmos.base.v1beta1.Coin repeated
delegated_free cosmos.base.v1beta1.Coin repeated
delegated_vesting cosmos.base.v1beta1.Coin repeated
end_time int64

ContinuousVestingAccount

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

Field Type Label Description
base_vesting_account BaseVestingAccount
start_time int64

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.

Field Type Label Description
base_vesting_account BaseVestingAccount

Period

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

Field Type Label Description
length int64
amount cosmos.base.v1beta1.Coin repeated

PeriodicVestingAccount

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

Field Type Label Description
base_vesting_account BaseVestingAccount
start_time int64
vesting_periods Period repeated

PermanentLockedAccount

PermanentLockedAccount implements the VestingAccount interface. It does not ever release coins, locking them indefinitely. Coins in this account can still be used for delegating and for governance votes even while locked.

Since: cosmos-sdk 0.43

Field Type Label Description
base_vesting_account BaseVestingAccount

Top

cosmos/vesting/v1beta1/tx.proto

MsgCreatePeriodicVestingAccount

MsgCreateVestingAccount defines a message that enables creating a vesting account.

Field Type Label Description
from_address string
to_address string
start_time int64
vesting_periods Period repeated

MsgCreatePeriodicVestingAccountResponse

MsgCreateVestingAccountResponse defines the Msg/CreatePeriodicVestingAccount response type.

MsgCreateVestingAccount

MsgCreateVestingAccount defines a message that enables creating a vesting account.

Field Type Label Description
from_address string
to_address string
amount cosmos.base.v1beta1.Coin repeated
end_time int64
delayed bool

MsgCreateVestingAccountResponse

MsgCreateVestingAccountResponse defines the Msg/CreateVestingAccount response type.

Msg

Msg defines the bank Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
CreateVestingAccount MsgCreateVestingAccount MsgCreateVestingAccountResponse CreateVestingAccount defines a method that enables creating a vesting account.
CreatePeriodicVestingAccount MsgCreatePeriodicVestingAccount MsgCreatePeriodicVestingAccountResponse CreatePeriodicVestingAccount defines a method that enables creating a periodic vesting account.

Scalar Value Types

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