Protocol Documentation
Table of Contents
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.
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.
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.
cosmos/crypto/secp256k1/keys.proto
PrivKey
PrivKey defines a secp256k1 private key.
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.
cosmos/crypto/ed25519/keys.proto
PrivKey
PrivKey defines a ed25519 private key.
PubKey
PubKey defines a ed25519 public key Key is the compressed form of the pubkey. The first byte depends is a 0x02 byte if the y-coordinate is the lexicographically largest of the two associated with the x-coordinate. Otherwise the first byte is a 0x03. This prefix is followed with the x-coordinate.
cosmos/upgrade/v1beta1/upgrade.proto
CancelSoftwareUpgradeProposal
CancelSoftwareUpgradeProposal is a gov Content type for cancelling a software upgrade.
Plan
Plan specifies information about a planned upgrade and when it should occur.
name
Sets the name for the upgrade. This name will be used by the upgraded version of the software to apply any special "on-upgrade" commands during the first BeginBlock method after the upgrade is applied. It is also used to detect whether a software version can handle a given upgrade. If no upgrade handler with this name has been set in the software, it will be assumed that the software is out-of-date when the upgrade Time or Height is reached and the software will exit.
time
The time after which the upgrade must be performed. Leave set to its zero value to use a pre-defined Height instead.
info
Any application specific upgrade info to be included on-chain such as a git commit that validators could automatically upgrade to
upgraded_client_state
IBC-enabled chains can opt-in to including the upgraded client state in its upgrade plan This will make the chain commit to the correct upgraded (self) client state before the upgrade occurs, so that connecting chains can verify that the new upgraded client is valid by verifying a proof on the previous version of the chain. This will allow IBC connections to persist smoothly across planned chain upgrades
SoftwareUpgradeProposal
SoftwareUpgradeProposal is a gov Content type for initiating a software upgrade.
cosmos/upgrade/v1beta1/query.proto
QueryAppliedPlanRequest
QueryCurrentPlanRequest is the request type for the Query/AppliedPlan RPC method.
QueryAppliedPlanResponse
QueryAppliedPlanResponse is the response type for the Query/AppliedPlan RPC method.
QueryCurrentPlanRequest
QueryCurrentPlanRequest is the request type for the Query/CurrentPlan RPC method.
QueryCurrentPlanResponse
QueryCurrentPlanResponse is the response type for the Query/CurrentPlan RPC method.
Query
Query defines the gRPC upgrade querier service.
CurrentPlan
CurrentPlan queries the current upgrade plan.
AppliedPlan
AppliedPlan queries a previously applied upgrade plan by its name.
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.
QueryInflationRequest
QueryInflationRequest is the request type for the Query/Inflation RPC method.
QueryInflationResponse
QueryInflationResponse is the response type for the Query/Inflation RPC method.
QueryParamsRequest
QueryParamsRequest is the request type for the Query/Params RPC method.
QueryParamsResponse
QueryParamsResponse is the response type for the Query/Params RPC method.
Query
Query provides defines the gRPC querier service.
Inflation
Inflation returns the current minting inflation value.
AnnualProvisions
AnnualProvisions current minting annual provisions value.
cosmos/mint/v1beta1/genesis.proto
GenesisState
GenesisState defines the mint module's genesis state.
cosmos/mint/v1beta1/mint.proto
Minter
Minter represents the minting state.
Params
Params holds parameters for the mint module.
cosmos/evidence/v1beta1/tx.proto
MsgSubmitEvidence
MsgSubmitEvidence represents a message that supports submitting arbitrary Evidence of misbehavior such as equivocation or counterfactual signing.
MsgSubmitEvidenceResponse
MsgSubmitEvidenceResponse defines the Msg/SubmitEvidence response type.
Msg
Msg defines the evidence Msg service.
SubmitEvidence
SubmitEvidence submits an arbitrary Evidence of misbehavior such as equivocation or counterfactual signing.
cosmos/evidence/v1beta1/evidence.proto
Equivocation
Equivocation implements the Evidence interface and defines evidence of double signing misbehavior.
cosmos/evidence/v1beta1/query.proto
QueryAllEvidenceRequest
QueryEvidenceRequest is the request type for the Query/AllEvidence RPC method.
pagination
pagination defines an optional pagination for the request.
QueryAllEvidenceResponse
QueryAllEvidenceResponse is the response type for the Query/AllEvidence RPC method.
QueryEvidenceRequest
QueryEvidenceRequest is the request type for the Query/Evidence RPC method.
QueryEvidenceResponse
QueryEvidenceResponse is the response type for the Query/Evidence RPC method.
Query
Query defines the gRPC querier service.
cosmos/evidence/v1beta1/genesis.proto
GenesisState
GenesisState defines the evidence module's genesis state.
cosmos/auth/v1beta1/query.proto
QueryAccountRequest
QueryAccountRequest is the request type for the Query/Account RPC method.
QueryAccountResponse
QueryAccountResponse is the response type for the Query/Account RPC method.
QueryParamsRequest
QueryParamsRequest is the request type for the Query/Params RPC method.
QueryParamsResponse
QueryParamsResponse is the response type for the Query/Params RPC method.
Query
Query defines the gRPC querier service.
cosmos/auth/v1beta1/genesis.proto
GenesisState
GenesisState defines the auth module's genesis state.
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).
ModuleAccount
ModuleAccount defines an account for modules that holds coins on a pool.
Params
Params defines the parameters for the auth module.
cosmos/bank/v1beta1/tx.proto
MsgMultiSend
MsgMultiSend represents an arbitrary multi-in, multi-out send message.
MsgMultiSendResponse
MsgMultiSendResponse defines the Msg/MultiSend response type.
MsgSend
MsgSend represents a message to send coins from one account to another.
MsgSendResponse
MsgSendResponse defines the Msg/Send response type.
Msg
Msg defines the bank Msg service.
Send
Send defines a method for sending coins from one account to another account.
MultiSend
MultiSend defines a method for sending coins from some accounts to other accounts.
cosmos/bank/v1beta1/bank.proto
DenomUnit
DenomUnit represents a struct that describes a given denomination unit of the basic token.
exponent
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).
Input
Input models transaction input.
Metadata
Metadata represents a struct that describes a basic token.
Output
Output models transaction outputs.
Params
Params defines the parameters for the bank module.
SendEnabled
SendEnabled maps coin denom to a send_enabled status (whether a denom is sendable).
Supply
Supply represents a struct that passively keeps track of the total supply amounts in the network.
cosmos/bank/v1beta1/query.proto
QueryAllBalancesRequest
QueryBalanceRequest is the request type for the Query/AllBalances RPC method.
pagination
pagination defines an optional pagination for the request.
QueryAllBalancesResponse
QueryAllBalancesResponse is the response type for the Query/AllBalances RPC method.
QueryBalanceRequest
QueryBalanceRequest is the request type for the Query/Balance RPC method.
QueryBalanceResponse
QueryBalanceResponse is the response type for the Query/Balance RPC method.
QueryParamsRequest
QueryParamsRequest defines the request type for querying x/bank parameters.
QueryParamsResponse
QueryParamsResponse defines the response type for querying x/bank parameters.
QuerySupplyOfRequest
QuerySupplyOfRequest is the request type for the Query/SupplyOf RPC method.
QuerySupplyOfResponse
QuerySupplyOfResponse is the response type for the Query/SupplyOf RPC method.
QueryTotalSupplyRequest
QueryTotalSupplyRequest is the request type for the Query/TotalSupply RPC method.
QueryTotalSupplyResponse
QueryTotalSupplyResponse is the response type for the Query/TotalSupply RPC method
Query
Query defines the gRPC querier service.
Balance
Balance queries the balance of a single coin for a single account.
AllBalances
AllBalances queries the balance of all coins for a single account.
TotalSupply
TotalSupply queries the total supply of all coins.
cosmos/bank/v1beta1/genesis.proto
Balance
Balance defines an account address and balance pair used in the bank module's genesis state.
GenesisState
GenesisState defines the bank module's genesis state.
cosmos/capability/v1beta1/capability.proto
Capability
Capability defines an implementation of an object capability. The index provided to a Capability must be globally unique.
CapabilityOwners
CapabilityOwners defines a set of owners of a single Capability. The set of owners must be unique.
Owner
Owner defines a single capability owner. An owner is defined by the name of capability and the module name.
cosmos/capability/v1beta1/genesis.proto
GenesisOwners
GenesisOwners defines the capability owners with their corresponding index.
GenesisState
GenesisState defines the capability module's genesis state.
owners
repeated
owners represents a map from index to owners of the capability index index key is string to allow amino marshalling.
cosmos/distribution/v1beta1/tx.proto
MsgFundCommunityPool
MsgFundCommunityPool allows an account to directly fund the community pool.
MsgFundCommunityPoolResponse
MsgFundCommunityPoolResponse defines the Msg/FundCommunityPool response type.
MsgSetWithdrawAddress
MsgSetWithdrawAddress sets the withdraw address for a delegator (or validator self-delegation).
MsgSetWithdrawAddressResponse
MsgSetWithdrawAddressResponse defines the Msg/SetWithdrawAddress response type.
MsgWithdrawDelegatorReward
MsgWithdrawDelegatorReward represents delegation withdrawal to a delegator from a single validator.
MsgWithdrawDelegatorRewardResponse
MsgWithdrawDelegatorRewardResponse defines the Msg/WithdrawDelegatorReward response type.
MsgWithdrawValidatorCommission
MsgWithdrawValidatorCommission withdraws the full commission to the validator address.
MsgWithdrawValidatorCommissionResponse
MsgWithdrawValidatorCommissionResponse defines the Msg/WithdrawValidatorCommission response type.
Msg
Msg defines the distribution Msg service.
SetWithdrawAddress
SetWithdrawAddress defines a method to change the withdraw address for a delegator (or validator self-delegation).
WithdrawDelegatorReward
WithdrawDelegatorReward defines a method to withdraw rewards of delegator from a single validator.
WithdrawValidatorCommission
WithdrawValidatorCommission defines a method to withdraw the full commission to the validator address.
FundCommunityPool
FundCommunityPool defines a method to allow an account to directly fund the community pool.
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.
CommunityPoolSpendProposalWithDeposit
CommunityPoolSpendProposalWithDeposit defines a CommunityPoolSpendProposal with a deposit
DelegationDelegatorReward
DelegationDelegatorReward represents the properties of a delegator's delegation reward.
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.
FeePool
FeePool is the global fee pool for distribution.
Params
Params defines the set of params for the distribution module.
ValidatorAccumulatedCommission
ValidatorAccumulatedCommission represents accumulated commission for a validator kept as a running counter, can be withdrawn at any time.
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.
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
ValidatorOutstandingRewards
ValidatorOutstandingRewards represents outstanding (un-withdrawn) rewards for a validator inexpensive to track, allows simple sanity checks.
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.
ValidatorSlashEvents
ValidatorSlashEvents is a collection of ValidatorSlashEvent messages.
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.
QueryDelegationRewardsRequest
QueryDelegationRewardsRequest is the request type for the Query/DelegationRewards RPC method.
QueryDelegationRewardsResponse
QueryDelegationRewardsResponse is the response type for the Query/DelegationRewards RPC method.
QueryDelegationTotalRewardsRequest
QueryDelegationTotalRewardsRequest is the request type for the Query/DelegationTotalRewards RPC method.
QueryDelegationTotalRewardsResponse
QueryDelegationTotalRewardsResponse is the response type for the Query/DelegationTotalRewards RPC method.
QueryDelegatorValidatorsRequest
QueryDelegatorValidatorsRequest is the request type for the Query/DelegatorValidators RPC method.
QueryDelegatorValidatorsResponse
QueryDelegatorValidatorsResponse is the response type for the Query/DelegatorValidators RPC method.
QueryDelegatorWithdrawAddressRequest
QueryDelegatorWithdrawAddressRequest is the request type for the Query/DelegatorWithdrawAddress RPC method.
QueryDelegatorWithdrawAddressResponse
QueryDelegatorWithdrawAddressResponse is the response type for the Query/DelegatorWithdrawAddress RPC method.
QueryParamsRequest
QueryParamsRequest is the request type for the Query/Params RPC method.
QueryParamsResponse
QueryParamsResponse is the response type for the Query/Params RPC method.
QueryValidatorCommissionRequest
QueryValidatorCommissionRequest is the request type for the Query/ValidatorCommission RPC method
QueryValidatorCommissionResponse
QueryValidatorCommissionResponse is the response type for the Query/ValidatorCommission RPC method
QueryValidatorOutstandingRewardsRequest
QueryValidatorOutstandingRewardsRequest is the request type for the Query/ValidatorOutstandingRewards RPC method.
QueryValidatorOutstandingRewardsResponse
QueryValidatorOutstandingRewardsResponse is the response type for the Query/ValidatorOutstandingRewards RPC method.
QueryValidatorSlashesRequest
QueryValidatorSlashesRequest is the request type for the Query/ValidatorSlashes RPC method
pagination
pagination defines an optional pagination for the request.
QueryValidatorSlashesResponse
QueryValidatorSlashesResponse is the response type for the Query/ValidatorSlashes RPC method.
Query
Query defines the gRPC querier service for distribution module.
ValidatorOutstandingRewards
ValidatorOutstandingRewards queries rewards of a validator address.
ValidatorCommission
ValidatorCommission queries accumulated commission for a validator.
ValidatorSlashes
ValidatorSlashes queries slash events of a validator.
DelegationRewards
DelegationRewards queries the total rewards accrued by a delegation.
DelegationTotalRewards
DelegationTotalRewards queries the total rewards accrued by a each validator.
DelegatorValidators
DelegatorValidators queries the validators of a delegator.
DelegatorWithdrawAddress
DelegatorWithdrawAddress queries withdraw address of a delegator.
CommunityPool
CommunityPool queries the community pool coins.
cosmos/distribution/v1beta1/genesis.proto
DelegatorStartingInfoRecord
DelegatorStartingInfoRecord used for import / export via genesis json.
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.
GenesisState
GenesisState defines the distribution module's genesis state.
delegator_withdraw_infos
repeated
fee_pool defines the delegator withdraw infos at genesis.
outstanding_rewards
repeated
fee_pool defines the outstanding rewards of all validators at genesis.
validator_accumulated_commissions
repeated
fee_pool defines the accumulated commisions of all validators at genesis.
validator_historical_rewards
repeated
fee_pool defines the historical rewards of all validators at genesis.
validator_current_rewards
repeated
fee_pool defines the current rewards of all validators at genesis.
delegator_starting_infos
repeated
fee_pool defines the delegator starting infos at genesis.
validator_slash_events
repeated
fee_pool defines the validator slash events at genesis.
ValidatorAccumulatedCommissionRecord
ValidatorAccumulatedCommissionRecord is used for import / export via genesis json.
ValidatorCurrentRewardsRecord
ValidatorCurrentRewardsRecord is used for import / export via genesis json.
ValidatorHistoricalRewardsRecord
ValidatorHistoricalRewardsRecord is used for import / export via genesis json.
ValidatorOutstandingRewardsRecord
ValidatorOutstandingRewardsRecord is used for import/export via genesis json.
outstanding_rewards
repeated
outstanding_rewards represents the oustanding rewards of a validator.
ValidatorSlashEventRecord
ValidatorSlashEventRecord is used for import / export via genesis json.
cosmos/crisis/v1beta1/tx.proto
MsgVerifyInvariant
MsgVerifyInvariant represents a message to verify a particular invariance.
MsgVerifyInvariantResponse
MsgVerifyInvariantResponse defines the Msg/VerifyInvariant response type.
Msg
Msg defines the bank Msg service.
VerifyInvariant
VerifyInvariant defines a method to verify a particular invariance.
cosmos/crisis/v1beta1/genesis.proto
GenesisState
GenesisState defines the crisis module's genesis state.
constant_fee
constant_fee is the fee used to verify the invariant in the crisis module.
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.
sequence
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
SignatureDescriptor.Data.Multi
Multi is the signature data for a multisig public key
bitarray
bitarray specifies which keys within the multisig are signing
SignatureDescriptor.Data.Single
Single is the signature data for a single signer
SignatureDescriptors
SignatureDescriptors wraps multiple SignatureDescriptor's.
SignMode
SignMode represents a signing mode with its own security guarantees.
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
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
cosmos/tx/v1beta1/tx.proto
AuthInfo
AuthInfo describes the fee and signer modes that are used to sign a transaction.
signer_infos
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 is the fee and gas limit for the transaction. The first signer is the primary signer and the one which pays the fee. The fee can be calculated based on the cost of evaluating the body and doing signature verification of the signers. This can be estimated via simulation.
Fee
Fee includes the amount of coins paid in fees and the maximum gas to be used by the transaction. The ratio yields an effective "gasprice", which must be above some miminum to be accepted into the mempool.
gas_limit
gas_limit is the maximum gas that can be used in transaction processing before an out of gas error occurs
payer
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
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.
ModeInfo.Multi
Multi is the mode info for a multisig public key
bitarray
bitarray specifies which keys within the multisig are signing
mode_infos
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
SignDoc
SignDoc is the type used for generating sign bytes for SIGN_MODE_DIRECT.
body_bytes
body_bytes is protobuf serialization of a TxBody that matches the representation in TxRaw.
auth_info_bytes
auth_info_bytes is a protobuf serialization of an AuthInfo that matches the representation in TxRaw.
chain_id
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
SignerInfo
SignerInfo describes the public key and signing mode of a single top-level signer.
public_key
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
mode_info describes the signing mode of the signer and is a nested structure to support nested multisig pubkey's
sequence
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.
Tx
Tx is the standard type used for broadcasting transactions.
auth_info
auth_info is the authorization related content of the transaction, specifically signers, signer modes and fee
signatures
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.
messages
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 memo to be added to the transaction | | timeout_height | uint64 | | timeout is the block height after which this transaction will not be processed by the chain | | extension_options | google.protobuf.Any | repeated | extension_options are arbitrary options that can be added by chains when the default options are not sufficient. If any of these are present and can't be handled, the transaction will be rejected | | non_critical_extension_options | google.protobuf.Any | repeated | extension_options are arbitrary options that can be added by chains when the default options are not sufficient. If any of these are present and can't be handled, they will be ignored |
TxRaw
TxRaw is a variant of Tx that pins the signer's exact binary representation of body and auth_info. This is used for signing, broadcasting and verification. The binary serialize(tx: TxRaw)
is stored in Tendermint and the hash sha256(serialize(tx: TxRaw))
becomes the "txhash", commonly used as the transaction ID.
body_bytes
body_bytes is a protobuf serialization of a TxBody that matches the representation in SignDoc.
auth_info_bytes
auth_info_bytes is a protobuf serialization of an AuthInfo that matches the representation in SignDoc.
signatures
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.
cosmos/vesting/v1beta1/tx.proto
MsgCreateVestingAccount
MsgCreateVestingAccount defines a message that enables creating a vesting account.
MsgCreateVestingAccountResponse
MsgCreateVestingAccountResponse defines the Msg/CreateVestingAccount response type.
Msg
Msg defines the bank Msg service.
CreateVestingAccount
CreateVestingAccount defines a method that enables creating a vesting account.
cosmos/vesting/v1beta1/vesting.proto
BaseVestingAccount
BaseVestingAccount implements the VestingAccount interface. It contains all the necessary fields needed for any vesting account implementation.
ContinuousVestingAccount
ContinuousVestingAccount implements the VestingAccount interface. It continuously vests by unlocking coins linearly with respect to time.
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.
Period
Period defines a length of time and amount of coins that will vest.
PeriodicVestingAccount
PeriodicVestingAccount implements the VestingAccount interface. It periodically vests by unlocking coins during each specified period.
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.
MsgBeginRedelegateResponse
MsgBeginRedelegateResponse defines the Msg/BeginRedelegate response type.
MsgCreateValidator
MsgCreateValidator defines a SDK message for creating a new validator.
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.
MsgDelegateResponse
MsgDelegateResponse defines the Msg/Delegate response type.
MsgEditValidator
MsgEditValidator defines a SDK message for editing an existing validator.
commission_rate
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.
MsgUndelegateResponse
MsgUndelegateResponse defines the Msg/Undelegate response type.
Msg
Msg defines the staking Msg service.
CreateValidator
CreateValidator defines a method for creating a new validator.
EditValidator
EditValidator defines a method for editing an existing validator.
Delegate
Delegate defines a method for performing a delegation of coins from a delegator to a validator.
BeginRedelegate
BeginRedelegate defines a method for performing a redelegation of coins from a delegator and source validator to a destination validator.
Undelegate
Undelegate defines a method for performing an undelegation from a delegate and a validator.
cosmos/staking/v1beta1/query.proto
QueryDelegationRequest
QueryDelegationRequest is request type for the Query/Delegation RPC method.
QueryDelegationResponse
QueryDelegationResponse is response type for the Query/Delegation RPC method.
delegation_response
delegation_responses defines the delegation info of a delegation.
QueryDelegatorDelegationsRequest
QueryDelegatorDelegationsRequest is request type for the Query/DelegatorDelegations RPC method.
pagination
pagination defines an optional pagination for the request.
QueryDelegatorDelegationsResponse
QueryDelegatorDelegationsResponse is response type for the Query/DelegatorDelegations RPC method.
delegation_responses
repeated
delegation_responses defines all the delegations' info of a delegator.
QueryDelegatorUnbondingDelegationsRequest
QueryDelegatorUnbondingDelegationsRequest is request type for the Query/DelegatorUnbondingDelegations RPC method.
pagination
pagination defines an optional pagination for the request.
QueryDelegatorUnbondingDelegationsResponse
QueryUnbondingDelegatorDelegationsResponse is response type for the Query/UnbondingDelegatorDelegations RPC method.
QueryDelegatorValidatorRequest
QueryDelegatorValidatorRequest is request type for the Query/DelegatorValidator RPC method.
QueryDelegatorValidatorResponse
QueryDelegatorValidatorResponse response type for the Query/DelegatorValidator RPC method.
QueryDelegatorValidatorsRequest
QueryDelegatorValidatorsRequest is request type for the Query/DelegatorValidators RPC method.
pagination
pagination defines an optional pagination for the request.
QueryDelegatorValidatorsResponse
QueryDelegatorValidatorsResponse is response type for the Query/DelegatorValidators RPC method.
QueryHistoricalInfoRequest
QueryHistoricalInfoRequest is request type for the Query/HistoricalInfo RPC method.
QueryHistoricalInfoResponse
QueryHistoricalInfoResponse is response type for the Query/HistoricalInfo RPC method.
QueryParamsRequest
QueryParamsRequest is request type for the Query/Params RPC method.
QueryParamsResponse
QueryParamsResponse is response type for the Query/Params RPC method.
QueryPoolRequest
QueryPoolRequest is request type for the Query/Pool RPC method.
QueryPoolResponse
QueryPoolResponse is response type for the Query/Pool RPC method.
QueryRedelegationsRequest
QueryRedelegationsRequest is request type for the Query/Redelegations RPC method.
pagination
pagination defines an optional pagination for the request.
QueryRedelegationsResponse
QueryRedelegationsResponse is response type for the Query/Redelegations RPC method.
QueryUnbondingDelegationRequest
QueryUnbondingDelegationRequest is request type for the Query/UnbondingDelegation RPC method.
QueryUnbondingDelegationResponse
QueryDelegationResponse is response type for the Query/UnbondingDelegation RPC method.
QueryValidatorDelegationsRequest
QueryValidatorDelegationsRequest is request type for the Query/ValidatorDelegations RPC method
pagination
pagination defines an optional pagination for the request.
QueryValidatorDelegationsResponse
QueryValidatorDelegationsResponse is response type for the Query/ValidatorDelegations RPC method
QueryValidatorRequest
QueryValidatorRequest is response type for the Query/Validator RPC method
QueryValidatorResponse
QueryValidatorResponse is response type for the Query/Validator RPC method
QueryValidatorUnbondingDelegationsRequest
QueryValidatorUnbondingDelegationsRequest is required type for the Query/ValidatorUnbondingDelegations RPC method
pagination
pagination defines an optional pagination for the request.
QueryValidatorUnbondingDelegationsResponse
QueryValidatorUnbondingDelegationsResponse is response type for the Query/ValidatorUnbondingDelegations RPC method.
QueryValidatorsRequest
QueryValidatorsRequest is request type for Query/Validators RPC method.
pagination
pagination defines an optional pagination for the request.
QueryValidatorsResponse
QueryValidatorsResponse is response type for the Query/Validators RPC method
Query
Query defines the gRPC querier service.
Validators
Validators queries all validators that match the given status.
Validator
Validator queries validator info for given validator address.
ValidatorDelegations
ValidatorDelegations queries delegate info for given validator.
ValidatorUnbondingDelegations
ValidatorUnbondingDelegations queries unbonding delegations of a validator.
Delegation
Delegation queries delegate info for given validator delegator pair.
UnbondingDelegation
UnbondingDelegation queries unbonding info for given validator delegator pair.
DelegatorDelegations
DelegatorDelegations queries all delegations of a given delegator address.
DelegatorUnbondingDelegations
DelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address.
Redelegations
Redelegations queries redelegations of given address.
DelegatorValidators
DelegatorValidators queries all validators info for given delegator address.
DelegatorValidator
DelegatorValidator queries validator info for given delegator validator pair.
HistoricalInfo
HistoricalInfo queries the historical info for given height.
cosmos/staking/v1beta1/genesis.proto
GenesisState
GenesisState defines the staking module's genesis state.
last_total_power
last_total_power tracks the total amounts of bonded tokens recorded during the previous end block.
last_validator_powers
repeated
last_validator_powers is a special index that provides a historical list of the last-block's bonded validators.
unbonding_delegations
repeated
unbonding_delegations defines the unbonding delegations active at genesis.
LastValidatorPower
LastValidatorPower required for validator set update logic.
cosmos/staking/v1beta1/staking.proto
Commission
Commission defines commission parameters for a given validator.
CommissionRates
CommissionRates defines the initial commission rates to be used for creating a validator.
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.
DVPairs
DVPairs defines an array of DVPair objects.
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.
DVVTriplets
DVVTriplets defines an array of DVVTriplet objects.
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.
DelegationResponse
DelegationResponse is equivalent to Delegation except that it contains a balance in addition to shares which is more suitable for client responses.
Description
Description defines a validator description.
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).
Params
Params defines the parameters for the staking module.
Pool
Pool is used for tracking bonded and not-bonded token supply of the bond denomination.
Redelegation
Redelegation contains the list of a particular delegator's redelegating bonds from a particular source validator to a particular destination validator.
RedelegationEntry
RedelegationEntry defines a redelegation object with relevant metadata.
RedelegationEntryResponse
RedelegationEntryResponse is equivalent to a RedelegationEntry except that it contains a balance in addition to shares which is more suitable for client responses.
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.
UnbondingDelegation
UnbondingDelegation stores all of a single delegator's unbonding bonds for a single validator in an time-ordered list.
UnbondingDelegationEntry
UnbondingDelegationEntry defines an unbonding object with relevant metadata.
ValAddresses
ValAddresses defines a repeated set of validator addresses.
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.
BondStatus
BondStatus is the status of a validator.
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.
cosmos/genutil/v1beta1/genesis.proto
GenesisState
GenesisState defines the raw genesis transaction in JSON.
cosmos/params/v1beta1/query.proto
QueryParamsRequest
QueryParamsRequest is request type for the Query/Params RPC method.
QueryParamsResponse
QueryParamsResponse is response type for the Query/Params RPC method.
Query
Query defines the gRPC querier service.
Params
Params queries a specific parameter of a module, given its subspace and key.
cosmos/params/v1beta1/params.proto
ParamChange
ParamChange defines an individual parameter change, for use in ParameterChangeProposal.
ParameterChangeProposal
ParameterChangeProposal defines a proposal to change one or more parameters.
cosmos/slashing/v1beta1/tx.proto
MsgUnjail
MsgUnjail defines the Msg/Unjail request type
MsgUnjailResponse
MsgUnjailResponse defines the Msg/Unjail response type
Msg
Msg defines the slashing Msg service.
Unjail
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.
cosmos/slashing/v1beta1/slashing.proto
Params
Params represents the parameters used for by the slashing module.
ValidatorSigningInfo
ValidatorSigningInfo defines a validator's signing info for monitoring their liveness activity.
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
QuerySigningInfoRequest
QuerySigningInfoRequest is the request type for the Query/SigningInfo RPC method
QuerySigningInfoResponse
QuerySigningInfoResponse is the response type for the Query/SigningInfo RPC method
val_signing_info
val_signing_info is the signing info of requested val cons address
QuerySigningInfosRequest
QuerySigningInfosRequest is the request type for the Query/SigningInfos RPC method
QuerySigningInfosResponse
QuerySigningInfosResponse is the response type for the Query/SigningInfos RPC method
Query
Query provides defines the gRPC querier service
SigningInfo
SigningInfo queries the signing info of given cons address
SigningInfos
SigningInfos queries signing info of all validators
cosmos/slashing/v1beta1/genesis.proto
GenesisState
GenesisState defines the slashing module's genesis state.
signing_infos
repeated
signing_infos represents a map between validator addresses and their signing infos.
missed_blocks
repeated
signing_infos represents a map between validator addresses and their missed blocks.
MissedBlock
MissedBlock contains height and missed status as boolean.
SigningInfo
SigningInfo stores validator signing info of corresponding address.
validator_signing_info
validator_signing_info represents the signing info of this validator.
ValidatorMissedBlocks
ValidatorMissedBlocks contains array of missed blocks of corresponding address.
cosmos/base/abci/v1beta1/abci.proto
ABCIMessageLog
ABCIMessageLog defines a structure containing an indexed tx ABCI message log.
events
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.
GasInfo
GasInfo defines tx execution gas context.
MsgData
MsgData defines the data returned in a Result object during message execution.
Result
Result is the union of ResponseFormat and ResponseCheckTx.
data
Data is any data returned from message or handler execution. It MUST be length prefixed in order to separate data from multiple message executions.
events
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
SimulationResponse
SimulationResponse defines the response generated when a transaction is successfully simulated.
StringEvent
StringEvent defines en Event object wrapper where all the attributes contain key/value pairs that are strings instead of raw bytes.
TxMsgData
TxMsgData defines a list of MsgData. A transaction will have a MsgData object for each message.
TxResponse
TxResponse defines a structure containing relevant tx data and metadata. The tags are stringified and the log is JSON decoded.
timestamp
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.
cosmos/base/kv/v1beta1/kv.proto
Pair
Pair defines a key/value bytes tuple.
Pairs
Pairs defines a repeated slice of Pair objects.
cosmos/base/snapshots/v1beta1/snapshot.proto
Metadata
Metadata contains SDK-specific snapshot metadata.
Snapshot
Snapshot contains Tendermint state sync snapshot info.
cosmos/base/simulate/v1beta1/simulate.proto
SimulateRequest
SimulateRequest is the request type for the SimulateServiceService.Simulate RPC method.
SimulateResponse
SimulateResponse is the response type for the SimulateServiceService.SimulateRPC method.
gas_info
gas_info is the information about gas used in the simulation.
SimulateService
SimulateService defines a gRPC service for simulating transactions. It may also support querying and broadcasting in the future.
Simulate
Simulate simulates executing a transaction for estimating gas usage.
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.
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.
DecProto
DecProto defines a Protobuf wrapper around a Dec object.
IntProto
IntProto defines a Protobuf wrapper around an Int object.
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; }
key
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
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
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
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.
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; }
cosmos/base/store/v1beta1/commit_info.proto
CommitID
CommitID defines the committment information when a specific store is committed.
CommitInfo
CommitInfo defines commit information used by the multi-store when committing a version/height.
StoreInfo
StoreInfo defines store-specific commit information. It contains a reference between a store name and the commit ID.
cosmos/base/store/v1beta1/snapshot.proto
SnapshotIAVLItem
SnapshotIAVLItem is an exported IAVL node.
SnapshotItem
SnapshotItem is an item contained in a rootmulti.Store snapshot.
SnapshotStoreItem
SnapshotStoreItem contains metadata about a snapshotted store.
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.
ListImplementationsRequest
ListImplementationsRequest is the request type of the ListImplementations RPC.
ListImplementationsResponse
ListImplementationsResponse is the response type of the ListImplementations RPC.
ReflectionService
ReflectionService defines a service for interface reflection.
ListAllInterfaces
ListAllInterfaces lists all the interfaces registered in the interface registry.
ListImplementations
ListImplementations list all the concrete types that implement a given interface.
cosmos/gov/v1beta1/tx.proto
MsgDeposit
MsgDeposit defines a message to submit a deposit to an existing proposal.
MsgDepositResponse
MsgDepositResponse defines the Msg/Deposit response type.
MsgSubmitProposal
MsgSubmitProposal defines an sdk.Msg type that supports submitting arbitrary proposal Content.
MsgSubmitProposalResponse
MsgSubmitProposalResponse defines the Msg/SubmitProposal response type.
MsgVote
MsgVote defines a message to cast a vote.
MsgVoteResponse
MsgVoteResponse defines the Msg/Vote response type.
Msg
Msg defines the bank Msg service.
SubmitProposal
SubmitProposal defines a method to create new proposal given a content.
cosmos/gov/v1beta1/gov.proto
Deposit
Deposit defines an amount deposited by an account address to an active proposal.
DepositParams
DepositParams defines the params for deposits on governance proposals.
max_deposit_period
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.
TallyParams
TallyParams defines the params for tallying votes on governance proposals.
TallyResult
TallyResult defines a standard tally for a governance proposal.
TextProposal
TextProposal defines a standard text proposal whose changes need to be manually updated in case of approval.
Vote
Vote defines a vote on a governance proposal. A Vote consists of a proposal ID, the voter, and the vote option.
VotingParams
VotingParams defines the params for voting on governance proposals.
ProposalStatus
ProposalStatus enumerates the valid statuses of a proposal.
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.
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.
cosmos/gov/v1beta1/query.proto
QueryDepositRequest
QueryDepositRequest is the request type for the Query/Deposit RPC method.
QueryDepositResponse
QueryDepositResponse is the response type for the Query/Deposit RPC method.
QueryDepositsRequest
QueryDepositsRequest is the request type for the Query/Deposits RPC method.
pagination
pagination defines an optional pagination for the request.
QueryDepositsResponse
QueryDepositsResponse is the response type for the Query/Deposits RPC method.
QueryParamsRequest
QueryParamsRequest is the request type for the Query/Params RPC method.
params_type
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.
QueryProposalRequest
QueryProposalRequest is the request type for the Query/Proposal RPC method.
QueryProposalResponse
QueryProposalResponse is the response type for the Query/Proposal RPC method.
QueryProposalsRequest
QueryProposalsRequest is the request type for the Query/Proposals RPC method.
pagination
pagination defines an optional pagination for the request.
QueryProposalsResponse
QueryProposalsResponse is the response type for the Query/Proposals RPC method.
QueryTallyResultRequest
QueryTallyResultRequest is the request type for the Query/Tally RPC method.
QueryTallyResultResponse
QueryTallyResultResponse is the response type for the Query/Tally RPC method.
QueryVoteRequest
QueryVoteRequest is the request type for the Query/Vote RPC method.
QueryVoteResponse
QueryVoteResponse is the response type for the Query/Vote RPC method.
QueryVotesRequest
QueryVotesRequest is the request type for the Query/Votes RPC method.
pagination
pagination defines an optional pagination for the request.
QueryVotesResponse
QueryVotesResponse is the response type for the Query/Votes RPC method.
Query
Query defines the gRPC querier service for gov module
Proposal
Proposal queries proposal details based on ProposalID.
Proposals
Proposals queries all proposals based on given status.
Deposit
Deposit queries single deposit information based proposalID, depositAddr.
Deposits
Deposits queries all deposits of a single proposal.
TallyResult
TallyResult queries the tally of a proposal vote.
cosmos/gov/v1beta1/genesis.proto
GenesisState
GenesisState defines the gov module's genesis state.
ibc/core/types/v1/genesis.proto
GenesisState
GenesisState defines the ibc module's genesis state.
ibc/core/connection/v1/query.proto
QueryClientConnectionsRequest
QueryClientConnectionsRequest is the request type for the Query/ClientConnections RPC method
QueryClientConnectionsResponse
QueryClientConnectionsResponse is the response type for the Query/ClientConnections RPC method
QueryConnectionClientStateRequest
QueryConnectionClientStateRequest is the request type for the Query/ConnectionClientState RPC method
QueryConnectionClientStateResponse
QueryConnectionClientStateResponse is the response type for the Query/ConnectionClientState RPC method
identified_client_state
client state associated with the channel
QueryConnectionConsensusStateRequest
QueryConnectionConsensusStateRequest is the request type for the Query/ConnectionConsensusState RPC method
QueryConnectionConsensusStateResponse
QueryConnectionConsensusStateResponse is the response type for the Query/ConnectionConsensusState RPC method
QueryConnectionRequest
QueryConnectionRequest is the request type for the Query/Connection RPC method
QueryConnectionResponse
QueryConnectionResponse is the response type for the Query/Connection RPC method. Besides the connection end, it includes a proof and the height from which the proof was retrieved.
QueryConnectionsRequest
QueryConnectionsRequest is the request type for the Query/Connections RPC method
QueryConnectionsResponse
QueryConnectionsResponse is the response type for the Query/Connections RPC method.
Query
Query provides defines the gRPC querier service
Connections
Connections queries all the IBC connections of a chain.
ClientConnections
ClientConnections queries the connection paths associated with a client state.
ConnectionClientState
ConnectionClientState queries the client state associated with the connection.
ConnectionConsensusState
ConnectionConsensusState queries the consensus state associated with the connection.
ibc/core/connection/v1/connection.proto
ClientPaths
ClientPaths define all the connection paths for a client state.
ConnectionEnd
ConnectionEnd defines a stateful object on a chain connected to another separate one. NOTE: there must only be 2 defined ConnectionEnds to establish a connection between two chains.
versions
repeated
IBC version which can be utilised to determine encodings or protocols for channels or packets utilising this connection
ConnectionPaths
ConnectionPaths define all the connection paths for a given client state.
Counterparty
Counterparty defines the counterparty chain associated with a connection end.
connection_id
identifies the connection end on the counterparty chain associated with a given connection.
IdentifiedConnection
IdentifiedConnection defines a connection with additional connection identifier field.
versions
repeated
IBC version which can be utilised to determine encodings or protocols for channels or packets utilising this connection
MsgConnectionOpenAck
MsgConnectionOpenAck defines a msg sent by a Relayer to Chain A to acknowledge the change of connection state to TRYOPEN on Chain B.
MsgConnectionOpenAckResponse
MsgConnectionOpenAckResponse defines the Msg/ConnectionOpenAck response type.
MsgConnectionOpenConfirm
MsgConnectionOpenConfirm defines a msg sent by a Relayer to Chain B to acknowledge the change of connection state to OPEN on Chain A.
MsgConnectionOpenConfirmResponse
MsgConnectionOpenConfirmResponse defines the Msg/ConnectionOpenConfirm response type.
MsgConnectionOpenInit
MsgConnectionOpenInit defines the msg sent by an account on Chain A to initialize a connection with Chain B.
MsgConnectionOpenInitResponse
MsgConnectionOpenInitResponse defines the Msg/ConnectionOpenInit response type.
MsgConnectionOpenTry
MsgConnectionOpenTry defines a msg sent by a Relayer to try to open a connection on Chain B.
MsgConnectionOpenTryResponse
MsgConnectionOpenTryResponse defines the Msg/ConnectionOpenTry response type.
Version
Version defines the versioning scheme used to negotiate the IBC verison in the connection handshake.
State
State defines if a connection is in one of the following states: INIT, TRYOPEN, OPEN or UNINITIALIZED.
STATE_UNINITIALIZED_UNSPECIFIED
0
Default State
STATE_INIT
1
A connection end has just started the opening handshake.
STATE_TRYOPEN
2
A connection end has acknowledged the handshake step on the counterparty chain.
STATE_OPEN
3
A connection end has completed the handshake.
Msg
Msg defines the ibc/connection Msg service.
ConnectionOpenInit
ConnectionOpenInit defines a rpc handler method for MsgConnectionOpenInit.
ConnectionOpenTry
ConnectionOpenTry defines a rpc handler method for MsgConnectionOpenTry.
ConnectionOpenAck
ConnectionOpenAck defines a rpc handler method for MsgConnectionOpenAck.
ConnectionOpenConfirm
ConnectionOpenConfirm defines a rpc handler method for MsgConnectionOpenConfirm.
ibc/core/connection/v1/genesis.proto
GenesisState
GenesisState defines the ibc connection submodule's genesis state.
ibc/core/commitment/v1/commitment.proto
Key
Key defines a proof Key
KeyPath
KeyPath defines a slice of keys
MerklePath
MerklePath is the path used to verify commitment proofs, which can be an arbitrary structured object (defined by a commitment type).
MerklePrefix
MerklePrefix is merkle path prefixed to the key. The constructed key from the Path and the key will be append(Path.KeyPath, append(Path.KeyPrefix, key...))
MerkleProof
MerkleProof is a wrapper type that contains a merkle proof. It demonstrates membership or non-membership for an element or set of elements, verifiable in conjunction with a known commitment root. Proofs should be succinct.
MerkleRoot
MerkleRoot defines a merkle root hash. In the Cosmos SDK, the AppHash of a block header becomes the root.
KeyEncoding
KeyEncoding defines the encoding format of a key's bytes.
KEY_ENCODING_URL_UNSPECIFIED
0
URL encoding
KEY_ENCODING_HEX
1
Hex encoding
ibc/core/channel/v1/query.proto
QueryChannelClientStateRequest
QueryChannelClientStateRequest is the request type for the Query/ClientState RPC method
QueryChannelClientStateResponse
QueryChannelClientStateResponse is the Response type for the Query/QueryChannelClientState RPC method
identified_client_state
client state associated with the channel
QueryChannelConsensusStateRequest
QueryChannelConsensusStateRequest is the request type for the Query/ConsensusState RPC method
QueryChannelConsensusStateResponse
QueryChannelClientStateResponse is the Response type for the Query/QueryChannelClientState RPC method
QueryChannelRequest
QueryChannelRequest is the request type for the Query/Channel RPC method
QueryChannelResponse
QueryChannelResponse is the response type for the Query/Channel RPC method. Besides the Channel end, it includes a proof and the height from which the proof was retrieved.
QueryChannelsRequest
QueryChannelsRequest is the request type for the Query/Channels RPC method
QueryChannelsResponse
QueryChannelsResponse is the response type for the Query/Channels RPC method.
QueryConnectionChannelsRequest
QueryConnectionChannelsRequest is the request type for the Query/QueryConnectionChannels RPC method
QueryConnectionChannelsResponse
QueryConnectionChannelsResponse is the Response type for the Query/QueryConnectionChannels RPC method
QueryNextSequenceReceiveRequest
QueryNextSequenceReceiveRequest is the request type for the Query/QueryNextSequenceReceiveRequest RPC method
QueryNextSequenceReceiveResponse
QuerySequenceResponse is the request type for the Query/QueryNextSequenceReceiveResponse RPC method
QueryPacketAcknowledgementRequest
QueryPacketAcknowledgementRequest is the request type for the Query/PacketAcknowledgement RPC method
QueryPacketAcknowledgementResponse
QueryPacketAcknowledgementResponse defines the client query response for a packet which also includes a proof, its path and the height form which the proof was retrieved
QueryPacketCommitmentRequest
QueryPacketCommitmentRequest is the request type for the Query/PacketCommitment RPC method
QueryPacketCommitmentResponse
QueryPacketCommitmentResponse defines the client query response for a packet which also includes a proof, its path and the height form which the proof was retrieved
QueryPacketCommitmentsRequest
QueryPacketCommitmentsRequest is the request type for the Query/QueryPacketCommitments RPC method
QueryPacketCommitmentsResponse
QueryPacketCommitmentsResponse is the request type for the Query/QueryPacketCommitments RPC method
QueryUnreceivedPacketsRequest
QueryUnreceivedPacketsRequest is the request type for the Query/UnreceivedPackets RPC method
QueryUnreceivedPacketsResponse
QueryUnreceivedPacketsResponse is the response type for the Query/UnreceivedPacketCommitments RPC method
QueryUnrelayedAcksRequest
QueryUnrelayedAcksRequest is the request type for the Query/UnrelayedAcks RPC method
QueryUnrelayedAcksResponse
QueryUnrelayedAcksResponse is the response type for the Query/UnrelayedAcks RPC method
Query
Query provides defines the gRPC querier service
ConnectionChannels
ConnectionChannels queries all the channels associated with a connection end.
ChannelClientState
ChannelClientState queries for the client state for the channel associated with the provided channel identifiers.
ChannelConsensusState
ChannelConsensusState queries for the consensus state for the channel associated with the provided channel identifiers.
PacketCommitment
PacketCommitment queries a stored packet commitment hash.
PacketCommitments
PacketCommitments returns the all the packet commitments hashes associated with a channel.
PacketAcknowledgement
PacketAcknowledgement queries a stored packet acknowledgement hash.
UnreceivedPackets
UnreceivedPackets returns all the unrelayed IBC packets associated with a channel and sequences.
UnrelayedAcks
UnrelayedAcks returns all the unrelayed IBC acknowledgements associated with a channel and sequences.
NextSequenceReceive
NextSequenceReceive returns the next receive sequence for a given channel.
ibc/core/channel/v1/genesis.proto
GenesisState
GenesisState defines the ibc channel submodule's genesis state.
PacketSequence
PacketSequence defines the genesis type necessary to retrieve and store next send and receive sequences.
ibc/core/channel/v1/channel.proto
Acknowledgement
Acknowledgement is the recommended acknowledgement format to be used by app-specific protocols. NOTE: The field numbers 21 and 22 were explicitly chosen to avoid accidental conflicts with other protobuf message formats used for acknowledgements. The first byte of any message with this format will be the non-ASCII values 0xaa
(result) or 0xb2
(error). Implemented as defined by ICS: https://github.com/cosmos/ics/tree/master/spec/ics-004-channel-and-packet-semantics#acknowledgement-envelope
Channel
Channel defines pipeline for exactly-once packet delivery between specific modules on separate blockchains, which has at least one end capable of sending packets and one end capable of receiving packets.
connection_hops
repeated
list of connection identifiers, in order, along which packets sent on this channel will travel
Counterparty
Counterparty defines a channel end counterparty
IdentifiedChannel
IdentifiedChannel defines a channel with additional port and channel identifier fields.
connection_hops
repeated
list of connection identifiers, in order, along which packets sent on this channel will travel
MsgAcknowledgement
MsgAcknowledgement receives incoming IBC acknowledgement
MsgAcknowledgementResponse
MsgAcknowledgementResponse defines the Msg/Acknowledgement response type.
MsgChannelCloseConfirm
MsgChannelCloseConfirm defines a msg sent by a Relayer to Chain B to acknowledge the change of channel state to CLOSED on Chain A.
MsgChannelCloseConfirmResponse
MsgChannelCloseConfirmResponse defines the Msg/ChannelCloseConfirm response type.
MsgChannelCloseInit
MsgChannelCloseInit defines a msg sent by a Relayer to Chain A to close a channel with Chain B.
MsgChannelCloseInitResponse
MsgChannelCloseInitResponse defines the Msg/ChannelCloseInit response type.
MsgChannelOpenAck
MsgChannelOpenAck defines a msg sent by a Relayer to Chain A to acknowledge the change of channel state to TRYOPEN on Chain B.
MsgChannelOpenAckResponse
MsgChannelOpenAckResponse defines the Msg/ChannelOpenAck response type.
MsgChannelOpenConfirm
MsgChannelOpenConfirm defines a msg sent by a Relayer to Chain B to acknowledge the change of channel state to OPEN on Chain A.
MsgChannelOpenConfirmResponse
MsgChannelOpenConfirmResponse defines the Msg/ChannelOpenConfirm response type.
MsgChannelOpenInit
MsgChannelOpenInit defines an sdk.Msg to initialize a channel handshake. It is called by a relayer on Chain A.
MsgChannelOpenInitResponse
MsgChannelOpenInitResponse defines the Msg/ChannelOpenInit response type.
MsgChannelOpenTry
MsgChannelOpenInit defines a msg sent by a Relayer to try to open a channel on Chain B.
MsgChannelOpenTryResponse
MsgChannelOpenTryResponse defines the Msg/ChannelOpenTry response type.
MsgRecvPacket
MsgRecvPacket receives incoming IBC packet
MsgRecvPacketResponse
MsgRecvPacketResponse defines the Msg/RecvPacket response type.
MsgTimeout
MsgTimeout receives timed-out packet
MsgTimeoutOnClose
MsgTimeoutOnClose timed-out packet upon counterparty channel closure.
MsgTimeoutOnCloseResponse
MsgTimeoutOnCloseResponse defines the Msg/TimeoutOnClose response type.
MsgTimeoutResponse
MsgTimeoutResponse defines the Msg/Timeout response type.
Packet
Packet defines a type that carries data across different chains through IBC
sequence
number corresponds to the order of sends and receives, where a Packet with an earlier sequence number must be sent and received before a Packet with a later sequence number.
PacketAckCommitment
PacketAckCommitment defines the genesis type necessary to retrieve and store acknowlegements.
Order
Order defines if a channel is ORDERED or UNORDERED
ORDER_NONE_UNSPECIFIED
0
zero-value for channel ordering
ORDER_UNORDERED
1
packets can be delivered in any order, which may differ from the order in which they were sent.
ORDER_ORDERED
2
packets are delivered exactly in the order which they were sent
State
State defines if a channel is in one of the following states: CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.
STATE_UNINITIALIZED_UNSPECIFIED
0
Default State
STATE_INIT
1
A channel has just started the opening handshake.
STATE_TRYOPEN
2
A channel has acknowledged the handshake step on the counterparty chain.
STATE_OPEN
3
A channel has completed the handshake. Open channels are ready to send and receive packets.
STATE_CLOSED
4
A channel has been closed and can no longer be used to send or receive packets.
Msg
Msg defines the ibc/channel Msg service.
ChannelOpenInit
ChannelOpenInit defines a rpc handler method for MsgChannelOpenInit.
ChannelOpenTry
ChannelOpenTry defines a rpc handler method for MsgChannelOpenTry.
ChannelOpenAck
ChannelOpenAck defines a rpc handler method for MsgChannelOpenAck.
ChannelOpenConfirm
ChannelOpenConfirm defines a rpc handler method for MsgChannelOpenConfirm.
ChannelCloseInit
ChannelCloseInit defines a rpc handler method for MsgChannelCloseInit.
ChannelCloseConfirm
ChannelCloseConfirm defines a rpc handler method for MsgChannelCloseConfirm.
RecvPacket
RecvPacket defines a rpc handler method for MsgRecvPacket.
TimeoutOnClose
TimeoutOnClose defines a rpc handler method for MsgTimeoutOnClose.
Acknowledgement
Acknowledgement defines a rpc handler method for MsgAcknowledgement.
ibc/core/client/v1/client.proto
ClientConsensusStates
ClientConsensusStates defines all the stored consensus states for a given client.
consensus_states
repeated
consensus states and their heights associated with the client
ClientUpdateProposal
ClientUpdateProposal is a governance proposal. If it passes, the client is updated with the provided header. The update may fail if the header is not valid given certain conditions specified by the client implementation.
ConsensusStateWithHeight
ConsensusStateWithHeight defines a consensus state with an additional height field.
Height
Height is a monotonically increasing data type that can be compared against another Height for the purposes of updating and freezing clients
Normally the VersionHeight is incremented at each height while keeping version number the same However some consensus algorithms may choose to reset the height in certain conditions e.g. hard forks, state-machine breaking changes In these cases, the version number is incremented so that height continues to be monitonically increasing even as the VersionHeight gets reset
IdentifiedClientState
IdentifiedClientState defines a client state with an additional client identifier field.
MsgCreateClient
MsgCreateClient defines a message to create an IBC client
consensus_state
consensus state associated with the client that corresponds to a given height.
MsgCreateClientResponse
MsgCreateClientResponse defines the Msg/CreateClient response type.
MsgSubmitMisbehaviour
MsgSubmitMisbehaviour defines an sdk.Msg type that submits Evidence for light client misbehaviour.
MsgSubmitMisbehaviourResponse
MsgSubmitMisbehaviourResponse defines the Msg/SubmitMisbehaviour response type.
MsgUpdateClient
MsgUpdateClient defines an sdk.Msg to update a IBC client state using the given header.
MsgUpdateClientResponse
MsgUpdateClientResponse defines the Msg/UpdateClient response type.
MsgUpgradeClient
MsgUpgradeClient defines an sdk.Msg to upgrade an IBC client to a new client state
MsgUpgradeClientResponse
MsgUpgradeClientResponse defines the Msg/UpgradeClient response type.
Msg
Msg defines the ibc/client Msg service.
CreateClient
CreateClient defines a rpc handler method for MsgCreateClient.
UpdateClient
UpdateClient defines a rpc handler method for MsgUpdateClient.
UpgradeClient
UpgradeClient defines a rpc handler method for MsgUpgradeClient.
SubmitMisbehaviour
SubmitMisbehaviour defines a rpc handler method for MsgSubmitMisbehaviour.
ibc/core/client/v1/query.proto
QueryClientStateRequest
QueryClientStateRequest is the request type for the Query/ClientState RPC method
QueryClientStateResponse
QueryClientStateResponse is the response type for the Query/ClientState RPC method. Besides the client state, it includes a proof and the height from which the proof was retrieved.
QueryClientStatesRequest
QueryClientStatesRequest is the request type for the Query/ClientStates RPC method
QueryClientStatesResponse
QueryClientStatesResponse is the response type for the Query/ClientStates RPC method.
QueryConsensusStateRequest
QueryConsensusStateRequest is the request type for the Query/ConsensusState RPC method. Besides the consensus state, it includes a proof and the height from which the proof was retrieved.
QueryConsensusStateResponse
QueryConsensusStateResponse is the response type for the Query/ConsensusState RPC method
consensus_state
consensus state associated with the client identifier at the given height
QueryConsensusStatesRequest
QueryConsensusStatesRequest is the request type for the Query/ConsensusStates RPC method.
QueryConsensusStatesResponse
QueryConsensusStatesResponse is the response type for the Query/ConsensusStates RPC method
Query
Query provides defines the gRPC querier service
ClientStates
ClientStates queries all the IBC light clients of a chain.
ConsensusState
ConsensusState queries a consensus state associated with a client state at a given height.
ConsensusStates
ConsensusStates queries all the consensus state associated with a given client.
ibc/core/client/v1/genesis.proto
GenesisState
GenesisState defines the ibc client submodule's genesis state.
ibc/lightclients/solomachine/v1/solomachine.proto
ChannelStateData
ChannelStateData returns the SignBytes data for channel state verification.
ClientState
ClientState defines a solo machine client that tracks the current consensus state and if the client is frozen.
allow_update_after_proposal
when set to true, will allow governance to update a solo machine client. The client will be unfrozen if it is frozen.
ClientStateData
ClientStateData returns the SignBytes data for client state verification.
ConnectionStateData
ConnectionStateData returns the SignBytes data for connection state verification.
ConsensusState
ConsensusState defines a solo machine consensus state. The sequence of a consensus state is contained in the "height" key used in storing the consensus state.
diversifier
diversifier allows the same public key to be re-used across different solo machine clients (potentially on different chains) without being considered misbehaviour.
ConsensusStateData
ConsensusStateData returns the SignBytes data for consensus state verification.
Header
Header defines a solo machine consensus header
HeaderData
HeaderData returns the SignBytes data for update verification.
Misbehaviour
Misbehaviour defines misbehaviour for a solo machine which consists of a sequence and two signatures over different messages at that sequence.
NextSequenceRecvData
NextSequenceRecvData returns the SignBytes data for verification of the next sequence to be received.
PacketAcknowledgementData
PacketAcknowledgementData returns the SignBytes data for acknowledgement verification.
PacketCommitmentData
PacketCommitmentData returns the SignBytes data for packet commitment verification.
PacketReceiptAbsenceData
PacketReceiptAbsenceData returns the SignBytes data for packet receipt absence verification.
SignBytes
SignBytes defines the signed bytes used for signature verification.
SignatureAndData
SignatureAndData contains a signature and the data signed over to create that signature.
TimestampedSignatureData
TimestampedSignatureData contains the signature data and the timestamp of the signature.
DataType
DataType defines the type of solo machine proof being created. This is done to preserve uniqueness of different data sign byte encodings.
DATA_TYPE_UNINITIALIZED_UNSPECIFIED
0
Default State
DATA_TYPE_CLIENT_STATE
1
Data type for client state verification
DATA_TYPE_CONSENSUS_STATE
2
Data type for consensus state verification
DATA_TYPE_CONNECTION_STATE
3
Data type for connection state verification
DATA_TYPE_CHANNEL_STATE
4
Data type for channel state verification
DATA_TYPE_PACKET_COMMITMENT
5
Data type for packet commitment verification
DATA_TYPE_PACKET_ACKNOWLEDGEMENT
6
Data type for packet acknowledgement verification
DATA_TYPE_PACKET_RECEIPT_ABSENCE
7
Data type for packet receipt absence verification
DATA_TYPE_NEXT_SEQUENCE_RECV
8
Data type for next sequence recv verification
DATA_TYPE_HEADER
9
Data type for header verification
ibc/lightclients/tendermint/v1/tendermint.proto
ClientState
ClientState from Tendermint tracks the current validator set, latest height, and a possible frozen height.
trusting_period
duration of the period since the LatestTimestamp during which the submitted headers are valid for upgrade
max_clock_drift
defines how much new (untrusted) header's Time can drift into the future.
allow_update_after_expiry
This flag, when set to true, will allow governance to recover a client which has expired
allow_update_after_misbehaviour
This flag, when set to true, will allow governance to unfreeze a client whose chain has experienced a misbehaviour event
ConsensusState
ConsensusState defines the consensus state from Tendermint.
timestamp
timestamp that corresponds to the block height in which the ConsensusState was stored.
Fraction
Fraction defines the protobuf message type for tmmath.Fraction
Header
Header defines the Tendermint client consensus Header. It encapsulates all the information necessary to update from a trusted Tendermint ConsensusState. The inclusion of TrustedHeight and TrustedValidators allows this update to process correctly, so long as the ConsensusState for the TrustedHeight exists, this removes race conditions among relayers The SignedHeader and ValidatorSet are the new untrusted update fields for the client. The TrustedHeight is the height of a stored ConsensusState on the client that will be used to verify the new untrusted header. The Trusted ConsensusState must be within the unbonding period of current time in order to correctly verify, and the TrustedValidators must hash to TrustedConsensusState.NextValidatorsHash since that is the last trusted validator set at the TrustedHeight.
Misbehaviour
Misbehaviour is a wrapper over two conflicting Headers that implements Misbehaviour interface expected by ICS-02
ibc/lightclients/localhost/v1/localhost.proto
ClientState
ClientState defines a loopback (localhost) client. It requires (read-only) access to keys outside the client prefix.
ibc/applications/transfer/v1/transfer.proto
DenomTrace
DenomTrace contains the base denomination for ICS20 fungible tokens and the source tracing information path.
FungibleTokenPacketData
FungibleTokenPacketData defines a struct for the packet payload See FungibleTokenPacketData spec: https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#data-structures
MsgTransfer
MsgTransfer defines a msg to transfer fungible tokens (i.e Coins) between ICS20 enabled chains. See ICS Spec here: https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#data-structures
timeout_height
Timeout height relative to the current block height. The timeout is disabled when set to 0.
timeout_timestamp
Timeout timestamp (in nanoseconds) relative to the current block timestamp. The timeout is disabled when set to 0.
MsgTransferResponse
MsgTransferResponse defines the Msg/Transfer response type.
Params
Params defines the set of IBC transfer parameters. NOTE: To prevent a single token from being transferred, set the TransfersEnabled parameter to true and then set the bank module's SendEnabled parameter for the denomination to false.
Msg
Msg defines the ibc/transfer Msg service.
ibc/applications/transfer/v1/query.proto
QueryDenomTraceRequest
QueryDenomTraceRequest is the request type for the Query/DenomTrace RPC method
QueryDenomTraceResponse
QueryDenomTraceResponse is the response type for the Query/DenomTrace RPC method.
QueryDenomTracesRequest
QueryConnectionsRequest is the request type for the Query/DenomTraces RPC method
pagination
pagination defines an optional pagination for the request.
QueryDenomTracesResponse
QueryConnectionsResponse is the response type for the Query/DenomTraces RPC method.
QueryParamsRequest
QueryParamsRequest is the request type for the Query/Params RPC method.
QueryParamsResponse
QueryParamsResponse is the response type for the Query/Params RPC method.
Query
Query provides defines the gRPC querier service.
DenomTrace
DenomTrace queries a denomination trace information.
DenomTraces
DenomTraces queries all denomination traces.
Params
Params queries all parameters of the ibc-transfer module.
ibc/applications/transfer/v1/genesis.proto
GenesisState
GenesisState defines the ibc-transfer genesis state
Scalar Value Types
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)
Last updated