package cosmos.staking.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the staking Msg service.

• rpc CreateValidator (MsgCreateValidator, MsgCreateValidatorResponse)

  tx.proto:17

  CreateValidator defines a method for creating a new validator.

  message MsgCreateValidator

  tx.proto:36

  MsgCreateValidator defines a SDK message for creating a new validator.

  • optional Description description = 1

  • optional CommissionRates commission = 2

  • string min_self_delegation = 3

  • string delegator_address = 4

  • string validator_address = 5

  • optional google.protobuf.Any pubkey = 6

  • optional base.v1beta1.Coin value = 7

  message MsgCreateValidatorResponse

  tx.proto:54

  MsgCreateValidatorResponse defines the Msg/CreateValidator response type.

  (message has no fields)

• rpc EditValidator (MsgEditValidator, MsgEditValidatorResponse)

  tx.proto:20

  EditValidator defines a method for editing an existing validator.

  message MsgEditValidator

  tx.proto:57

  MsgEditValidator defines a SDK message for editing an existing validator.

  • optional Description description = 1

  • string validator_address = 2

  • string commission_rate = 3

    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

  • string min_self_delegation = 4

  message MsgEditValidatorResponse

  tx.proto:79

  MsgEditValidatorResponse defines the Msg/EditValidator response type.

  (message has no fields)

• rpc Delegate (MsgDelegate, MsgDelegateResponse)

  tx.proto:24

  Delegate defines a method for performing a delegation of coins from a delegator to a validator.

  message MsgDelegate

  tx.proto:83

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

  • string delegator_address = 1

  • string validator_address = 2

  • optional base.v1beta1.Coin amount = 3

  message MsgDelegateResponse

  tx.proto:92

  MsgDelegateResponse defines the Msg/Delegate response type.

  (message has no fields)

• rpc BeginRedelegate (MsgBeginRedelegate, MsgBeginRedelegateResponse)

  tx.proto:28

  BeginRedelegate defines a method for performing a redelegation of coins from a delegator and source validator to a destination validator.

  message MsgBeginRedelegate

  tx.proto:96

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

  • string delegator_address = 1

  • string validator_src_address = 2

  • string validator_dst_address = 3

  • optional base.v1beta1.Coin amount = 4

  message MsgBeginRedelegateResponse

  tx.proto:106

  MsgBeginRedelegateResponse defines the Msg/BeginRedelegate response type.

  • optional google.protobuf.Timestamp completion_time = 1

• rpc Undelegate (MsgUndelegate, MsgUndelegateResponse)

  tx.proto:32

  Undelegate defines a method for performing an undelegation from a delegate and a validator.

  message MsgUndelegate

  tx.proto:112

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

  • string delegator_address = 1

  • string validator_address = 2

  • optional base.v1beta1.Coin amount = 3

  message MsgUndelegateResponse

  tx.proto:121

  MsgUndelegateResponse defines the Msg/Undelegate response type.

  • optional google.protobuf.Timestamp completion_time = 1

Query defines the gRPC querier service.

• rpc Validators (QueryValidatorsRequest, QueryValidatorsResponse)

  query.proto:14

  Validators queries all validators that match the given status.

  message QueryValidatorsRequest

  query.proto:96

  QueryValidatorsRequest is request type for Query/Validators RPC method.

  • string status = 1

    status enables to query for validators matching a given status.

  • optional base.query.v1beta1.PageRequest pagination = 2

    pagination defines an optional pagination for the request.

  message QueryValidatorsResponse

  query.proto:105

  QueryValidatorsResponse is response type for the Query/Validators RPC method

  • repeated Validator validators = 1

    validators contains all the queried validators.

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

• rpc Validator (QueryValidatorRequest, QueryValidatorResponse)

  query.proto:19

  Validator queries validator info for given validator address.

  message QueryValidatorRequest

  query.proto:114

  QueryValidatorRequest is response type for the Query/Validator RPC method

  • string validator_addr = 1

    validator_addr defines the validator address to query for.

  message QueryValidatorResponse

  query.proto:120

  QueryValidatorResponse is response type for the Query/Validator RPC method

  • optional Validator validator = 1

    validator defines the the validator info.

• rpc ValidatorDelegations (QueryValidatorDelegationsRequest, QueryValidatorDelegationsResponse)

  query.proto:24

  ValidatorDelegations queries delegate info for given validator.

  message QueryValidatorDelegationsRequest

  query.proto:127

  QueryValidatorDelegationsRequest is request type for the Query/ValidatorDelegations RPC method

  • string validator_addr = 1

    validator_addr defines the validator address to query for.

  • optional base.query.v1beta1.PageRequest pagination = 2

    pagination defines an optional pagination for the request.

  message QueryValidatorDelegationsResponse

  query.proto:137

  QueryValidatorDelegationsResponse is response type for the Query/ValidatorDelegations RPC method

  • repeated DelegationResponse delegation_responses = 1

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

• rpc ValidatorUnbondingDelegations (QueryValidatorUnbondingDelegationsRequest, QueryValidatorUnbondingDelegationsResponse)

  query.proto:29

  ValidatorUnbondingDelegations queries unbonding delegations of a validator.

  message QueryValidatorUnbondingDelegationsRequest

  query.proto:147

  QueryValidatorUnbondingDelegationsRequest is required type for the Query/ValidatorUnbondingDelegations RPC method

  • string validator_addr = 1

    validator_addr defines the validator address to query for.

  • optional base.query.v1beta1.PageRequest pagination = 2

    pagination defines an optional pagination for the request.

  message QueryValidatorUnbondingDelegationsResponse

  query.proto:157

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

  • repeated UnbondingDelegation unbonding_responses = 1

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

• rpc Delegation (QueryDelegationRequest, QueryDelegationResponse)

  query.proto:36

  Delegation queries delegate info for given validator delegator pair.

  message QueryDelegationRequest

  query.proto:165

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

  • string delegator_addr = 1

    delegator_addr defines the delegator address to query for.

  • string validator_addr = 2

    validator_addr defines the validator address to query for.

  message QueryDelegationResponse

  query.proto:177

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

  • optional DelegationResponse delegation_response = 1

    delegation_responses defines the delegation info of a delegation.

• rpc UnbondingDelegation (QueryUnbondingDelegationRequest, QueryUnbondingDelegationResponse)

  query.proto:43

  UnbondingDelegation queries unbonding info for given validator delegator pair.

  message QueryUnbondingDelegationRequest

  query.proto:184

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

  • string delegator_addr = 1

    delegator_addr defines the delegator address to query for.

  • string validator_addr = 2

    validator_addr defines the validator address to query for.

  message QueryUnbondingDelegationResponse

  query.proto:197

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

  • optional UnbondingDelegation unbond = 1

    unbond defines the unbonding information of a delegation.

• rpc DelegatorDelegations (QueryDelegatorDelegationsRequest, QueryDelegatorDelegationsResponse)

  query.proto:49

  DelegatorDelegations queries all delegations of a given delegator address.

  message QueryDelegatorDelegationsRequest

  query.proto:204

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

  • string delegator_addr = 1

    delegator_addr defines the delegator address to query for.

  • optional base.query.v1beta1.PageRequest pagination = 2

    pagination defines an optional pagination for the request.

  message QueryDelegatorDelegationsResponse

  query.proto:217

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

  • repeated DelegationResponse delegation_responses = 1

    delegation_responses defines all the delegations' info of a delegator.

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

• rpc DelegatorUnbondingDelegations (QueryDelegatorUnbondingDelegationsRequest, QueryDelegatorUnbondingDelegationsResponse)

  query.proto:55

  DelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address.

  message QueryDelegatorUnbondingDelegationsRequest

  query.proto:227

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

  • string delegator_addr = 1

    delegator_addr defines the delegator address to query for.

  • optional base.query.v1beta1.PageRequest pagination = 2

    pagination defines an optional pagination for the request.

  message QueryDelegatorUnbondingDelegationsResponse

  query.proto:240

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

  • repeated UnbondingDelegation unbonding_responses = 1

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

• rpc Redelegations (QueryRedelegationsRequest, QueryRedelegationsResponse)

  query.proto:62

  Redelegations queries redelegations of given address.

  message QueryRedelegationsRequest

  query.proto:249

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

  • string delegator_addr = 1

    delegator_addr defines the delegator address to query for.

  • string src_validator_addr = 2

    src_validator_addr defines the validator address to redelegate from.

  • string dst_validator_addr = 3

    dst_validator_addr defines the validator address to redelegate to.

  • optional base.query.v1beta1.PageRequest pagination = 4

    pagination defines an optional pagination for the request.

  message QueryRedelegationsResponse

  query.proto:268

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

  • repeated RedelegationResponse redelegation_responses = 1

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

• rpc DelegatorValidators (QueryDelegatorValidatorsRequest, QueryDelegatorValidatorsResponse)

  query.proto:68

  DelegatorValidators queries all validators info for given delegator address.

  message QueryDelegatorValidatorsRequest

  query.proto:277

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

  • string delegator_addr = 1

    delegator_addr defines the delegator address to query for.

  • optional base.query.v1beta1.PageRequest pagination = 2

    pagination defines an optional pagination for the request.

  message QueryDelegatorValidatorsResponse

  query.proto:290

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

  • repeated Validator validators = 1

    validators defines the the validators' info of a delegator.

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

• rpc DelegatorValidator (QueryDelegatorValidatorRequest, QueryDelegatorValidatorResponse)

  query.proto:74

  DelegatorValidator queries validator info for given delegator validator pair.

  message QueryDelegatorValidatorRequest

  query.proto:300

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

  • string delegator_addr = 1

    delegator_addr defines the delegator address to query for.

  • string validator_addr = 2

    validator_addr defines the validator address to query for.

  message QueryDelegatorValidatorResponse

  query.proto:313

  QueryDelegatorValidatorResponse response type for the Query/DelegatorValidator RPC method.

  • optional Validator validator = 1

    validator defines the the validator info.

• rpc HistoricalInfo (QueryHistoricalInfoRequest, QueryHistoricalInfoResponse)

  query.proto:80

  HistoricalInfo queries the historical info for given height.

  message QueryHistoricalInfoRequest

  query.proto:320

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

  • int64 height = 1

    height defines at which height to query the historical info.

  message QueryHistoricalInfoResponse

  query.proto:327

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

  • optional HistoricalInfo hist = 1

    hist defines the historical info at the given height.

• rpc Pool (QueryPoolRequest, QueryPoolResponse)

  query.proto:85

  Pool queries the pool info.

  message QueryPoolRequest

  query.proto:333

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

  (message has no fields)

  message QueryPoolResponse

  query.proto:336

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

  • optional Pool pool = 1

    pool defines the pool info.

• rpc Params (QueryParamsRequest, QueryParamsResponse)

  query.proto:90

  Parameters queries the staking parameters.

  message QueryParamsRequest

  query.proto:342

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

  (message has no fields)

  message QueryParamsResponse

  query.proto:345

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

  • optional Params params = 1

    params holds all the parameters of this module.

AuthorizationType defines the type of staking module authorization type Since: cosmos-sdk 0.43

Used in: StakeAuthorization

• 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

BondStatus is the status of a validator.

Used in: 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.

Commission defines commission parameters for a given validator.

Used in: Validator

• optional CommissionRates commission_rates = 1

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

• optional google.protobuf.Timestamp update_time = 2

  update_time is the last time the commission rate was changed.

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

Used in: Commission, MsgCreateValidator

• string rate = 1

  rate is the commission rate charged to delegators, as a fraction.

• string max_rate = 2

  max_rate defines the maximum commission rate which validator can ever charge, as a fraction.

• string max_change_rate = 3

  max_change_rate defines the maximum daily increase of the validator commission, as a fraction.

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.

Used in: DVPairs

• string delegator_address = 1

• string validator_address = 2

DVPairs defines an array of DVPair objects.

• repeated DVPair pairs = 1

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.

Used in: DVVTriplets

• string delegator_address = 1

• string validator_src_address = 2

• string validator_dst_address = 3

DVVTriplets defines an array of DVVTriplet objects.

• repeated DVVTriplet triplets = 1

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.

Used in: DelegationResponse, GenesisState

• string delegator_address = 1

  delegator_address is the bech32-encoded address of the delegator.

• string validator_address = 2

  validator_address is the bech32-encoded address of the validator.

• string shares = 3

  shares define the delegation shares received.

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

Used in: QueryDelegationResponse, QueryDelegatorDelegationsResponse, QueryValidatorDelegationsResponse

• optional Delegation delegation = 1

• optional base.v1beta1.Coin balance = 2

Description defines a validator description.

Used in: MsgCreateValidator, MsgEditValidator, Validator

• string moniker = 1

  moniker defines a human-readable name for the validator.

• string identity = 2

  identity defines an optional identity signature (ex. UPort or Keybase).

• string website = 3

  website defines an optional website link.

• string security_contact = 4

  security_contact defines an optional email for security contact.

• string details = 5

  details define other optional details.

GenesisState defines the staking module's genesis state.

• optional Params params = 1

  params defines all the paramaters of related to deposit.

• bytes last_total_power = 2

  last_total_power tracks the total amounts of bonded tokens recorded during the previous end block.

• repeated LastValidatorPower last_validator_powers = 3

  last_validator_powers is a special index that provides a historical list of the last-block's bonded validators.

• repeated Validator validators = 4

  delegations defines the validator set at genesis.

• repeated Delegation delegations = 5

  delegations defines the delegations active at genesis.

• repeated UnbondingDelegation unbonding_delegations = 6

  unbonding_delegations defines the unbonding delegations active at genesis.

• repeated Redelegation redelegations = 7

  redelegations defines the redelegations active at genesis.

• bool exported = 8

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

Used in: QueryHistoricalInfoResponse

• optional tendermint.types.Header header = 1

• repeated Validator valset = 2

LastValidatorPower required for validator set update logic.

Used in: GenesisState

• string address = 1

  address is the address of the validator.

• int64 power = 2

  power defines the power of the validator.

Params defines the parameters for the staking module.

Used in: GenesisState, QueryParamsResponse

• optional google.protobuf.Duration unbonding_time = 1

  unbonding_time is the time duration of unbonding.

• uint32 max_validators = 2

  max_validators is the maximum number of validators.

• uint32 max_entries = 3

  max_entries is the max entries for either unbonding delegation or redelegation (per pair/trio).

• uint32 historical_entries = 4

  historical_entries is the number of historical entries to persist.

• string bond_denom = 5

  bond_denom defines the bondable coin denomination.

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

Used in: QueryPoolResponse

• string not_bonded_tokens = 1

• string bonded_tokens = 2

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

Used in: GenesisState, RedelegationResponse

• string delegator_address = 1

  delegator_address is the bech32-encoded address of the delegator.

• string validator_src_address = 2

  validator_src_address is the validator redelegation source operator address.

• string validator_dst_address = 3

  validator_dst_address is the validator redelegation destination operator address.

• repeated RedelegationEntry entries = 4

  entries are the redelegation entries.

  redelegation entries

RedelegationEntry defines a redelegation object with relevant metadata.

Used in: Redelegation, RedelegationEntryResponse

• int64 creation_height = 1

  creation_height defines the height which the redelegation took place.

• optional google.protobuf.Timestamp completion_time = 2

  completion_time defines the unix time for redelegation completion.

• string initial_balance = 3

  initial_balance defines the initial balance when redelegation started.

• string shares_dst = 4

  shares_dst is the amount of destination-validator shares created by redelegation.

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

Used in: RedelegationResponse

• optional RedelegationEntry redelegation_entry = 1

• string balance = 4

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

Used in: QueryRedelegationsResponse

• optional Redelegation redelegation = 1

• repeated RedelegationEntryResponse entries = 2

StakeAuthorization defines authorization for delegate/undelegate/redelegate. Since: cosmos-sdk 0.43

• optional base.v1beta1.Coin max_tokens = 1

  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.

• oneof validators

  validators is the oneof that represents either allow_list or deny_list

  • StakeAuthorization.Validators allow_list = 2

    allow_list specifies list of validator addresses to whom grantee can delegate tokens on behalf of granter's account.

  • StakeAuthorization.Validators deny_list = 3

    deny_list specifies list of validator addresses to whom grantee can not delegate tokens.

• AuthorizationType authorization_type = 4

  authorization_type defines one of AuthorizationType.

Validators defines list of validator addresses.

Used in: StakeAuthorization

• repeated string address = 1

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

Used in: GenesisState, QueryDelegatorUnbondingDelegationsResponse, QueryUnbondingDelegationResponse, QueryValidatorUnbondingDelegationsResponse

• string delegator_address = 1

  delegator_address is the bech32-encoded address of the delegator.

• string validator_address = 2

  validator_address is the bech32-encoded address of the validator.

• repeated UnbondingDelegationEntry entries = 3

  entries are the unbonding delegation entries.

  unbonding delegation entries

UnbondingDelegationEntry defines an unbonding object with relevant metadata.

Used in: UnbondingDelegation

• int64 creation_height = 1

  creation_height is the height which the unbonding took place.

• optional google.protobuf.Timestamp completion_time = 2

  completion_time is the unix time for unbonding completion.

• string initial_balance = 3

  initial_balance defines the tokens initially scheduled to receive at completion.

• string balance = 4

  balance defines the tokens to receive at completion.

ValAddresses defines a repeated set of validator addresses.

• repeated string addresses = 1

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.

Used in: GenesisState, HistoricalInfo, QueryDelegatorValidatorResponse, QueryDelegatorValidatorsResponse, QueryValidatorResponse, QueryValidatorsResponse

• string operator_address = 1

  operator_address defines the address of the validator's operator; bech encoded in JSON.

• optional google.protobuf.Any consensus_pubkey = 2

  consensus_pubkey is the consensus public key of the validator, as a Protobuf Any.

• bool jailed = 3

  jailed defined whether the validator has been jailed from bonded status or not.

• BondStatus status = 4

  status is the validator status (bonded/unbonding/unbonded).

• string tokens = 5

  tokens define the delegated tokens (incl. self-delegation).

• string delegator_shares = 6

  delegator_shares defines total shares issued to a validator's delegators.

• optional Description description = 7

  description defines the description terms for the validator.

• int64 unbonding_height = 8

  unbonding_height defines, if unbonding, the height at which this validator has begun unbonding.

• optional google.protobuf.Timestamp unbonding_time = 9

  unbonding_time defines, if unbonding, the min time for the validator to complete unbonding.

• optional Commission commission = 10

  commission defines the commission parameters.

• string min_self_delegation = 11

  min_self_delegation is the validator's self declared minimum self delegation.