Gov - Cosmos Docs

Generated from cosmos/cosmos-sdk@2086680ff8b0 on ref release/v0.55.x.

Queries

A node exposes only the services its application registers:

gRPC on port 9090
REST on port 1317, if the method has an HTTP binding

Run grpcurl -plaintext localhost:9090 list to see what a node serves. Queries are read-only and never pass through consensus. See Queries. Replace <string> placeholders with real values and omit unused filters. Payloads use protobuf JSON, and some string fields accept enum constants listed under Types. Field tables give the encoding each value takes. Examples assume a local node. For TLS endpoints, use port 443 and omit -plaintext. See gRPC services for reflection, address formats, and decimal encoding.

cosmos.gov.v1.Query

Query defines the gRPC querier service for gov module

Constitution

Constitution queries the chain’s constitution.


gRPC	`cosmos.gov.v1.Query/Constitution`
REST	`GET /cosmos/gov/v1/constitution`

Request QueryConstitutionRequest: This message has no fields. Response QueryConstitutionResponse:

Field	Type	Description
`constitution`	`string`

grpcurl -plaintext localhost:9090 cosmos.gov.v1.Query/Constitution

Deposit (Query, v1)

Deposit queries single deposit information based on proposalID, depositAddr.


gRPC	`cosmos.gov.v1.Query/Deposit`
REST	`GET /cosmos/gov/v1/proposals/{proposalId}/deposits/{depositor}`

Request QueryDepositRequest:

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`depositor`	`string`	depositor defines the deposit addresses from the proposals. Encoded as cosmos.AddressString.

Response QueryDepositResponse:

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

grpcurl -plaintext -d '{"proposal_id":"1","depositor":"<string>"}' \
  localhost:9090 cosmos.gov.v1.Query/Deposit

Deposits (v1)

Deposits queries all deposits of a single proposal.


gRPC	`cosmos.gov.v1.Query/Deposits`
REST	`GET /cosmos/gov/v1/proposals/{proposalId}/deposits`

Request QueryDepositsRequest:

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`pagination`	`PageRequest`	pagination defines an optional pagination for the request.

Response QueryDepositsResponse:

Field	Type	Description
`deposits`	`Deposit`[]	deposits defines the requested deposits.
`pagination`	`PageResponse`	pagination defines the pagination in the response.

grpcurl -plaintext -d '{"proposal_id":"1","pagination":{"limit":"1"}}' \
  localhost:9090 cosmos.gov.v1.Query/Deposits

Params (v1)

Params queries all parameters of the gov module.


gRPC	`cosmos.gov.v1.Query/Params`
REST	`GET /cosmos/gov/v1/params/{paramsType}`

Request QueryParamsRequest:

Field	Type	Description
`params_type`	`string`	params_type defines which parameters to query for, can be one of “voting”, “tallying” or “deposit”.

Response QueryParamsResponse:

Field	Type	Description
`voting_params`	`VotingParams`	Deprecated: Prefer to use `params` instead. voting_params defines the parameters related to voting. Deprecated.
`deposit_params`	`DepositParams`	Deprecated: Prefer to use `params` instead. deposit_params defines the parameters related to deposit. Deprecated.
`tally_params`	`TallyParams`	Deprecated: Prefer to use `params` instead. tally_params defines the parameters related to tally. Deprecated.
`params`	`Params`	params defines all the parameters of x/gov module.

grpcurl -plaintext -d '{"params_type":"voting"}' \
  localhost:9090 cosmos.gov.v1.Query/Params

Proposal (v1)

Proposal queries proposal details based on ProposalID.


gRPC	`cosmos.gov.v1.Query/Proposal`
REST	`GET /cosmos/gov/v1/proposals/{proposalId}`

Request QueryProposalRequest:

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

Response QueryProposalResponse:

Field	Type	Description
`proposal`	`Proposal`	proposal is the requested governance proposal.

grpcurl -plaintext -d '{"proposal_id":"1"}' \
  localhost:9090 cosmos.gov.v1.Query/Proposal

Proposals (v1)

Proposals queries all proposals based on given status.


gRPC	`cosmos.gov.v1.Query/Proposals`
REST	`GET /cosmos/gov/v1/proposals`

Request QueryProposalsRequest:

Field	Type	Description
`proposal_status`	`ProposalStatus`	proposal_status defines the status of the proposals.
`voter`	`string`	voter defines the voter address for the proposals. Encoded as cosmos.AddressString.
`depositor`	`string`	depositor defines the deposit addresses from the proposals. Encoded as cosmos.AddressString.
`pagination`	`PageRequest`	pagination defines an optional pagination for the request.

Response QueryProposalsResponse:

Field	Type	Description
`proposals`	`Proposal`[]	proposals defines all the requested governance proposals.
`pagination`	`PageResponse`	pagination defines the pagination in the response.

grpcurl -plaintext -d '{"proposal_status":"PROPOSAL_STATUS_DEPOSIT_PERIOD","voter":"<string>","depositor":"<string>","pagination":{"limit":"1"}}' \
  localhost:9090 cosmos.gov.v1.Query/Proposals

TallyResult (v1)

TallyResult queries the tally of a proposal vote.


gRPC	`cosmos.gov.v1.Query/TallyResult`
REST	`GET /cosmos/gov/v1/proposals/{proposalId}/tally`

Request QueryTallyResultRequest:

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

Response QueryTallyResultResponse:

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

grpcurl -plaintext -d '{"proposal_id":"1"}' \
  localhost:9090 cosmos.gov.v1.Query/TallyResult

Vote (Query, v1)

Vote queries voted information based on proposalID, voterAddr.


gRPC	`cosmos.gov.v1.Query/Vote`
REST	`GET /cosmos/gov/v1/proposals/{proposalId}/votes/{voter}`

Request QueryVoteRequest:

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`voter`	`string`	voter defines the voter address for the proposals. Encoded as cosmos.AddressString.

Response QueryVoteResponse:

Field	Type	Description
`vote`	`Vote`	vote defines the queried vote.

grpcurl -plaintext -d '{"proposal_id":"1","voter":"<string>"}' \
  localhost:9090 cosmos.gov.v1.Query/Vote

Votes (v1)

Votes queries votes of a given proposal.


gRPC	`cosmos.gov.v1.Query/Votes`
REST	`GET /cosmos/gov/v1/proposals/{proposalId}/votes`

Request QueryVotesRequest:

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`pagination`	`PageRequest`	pagination defines an optional pagination for the request.

Response QueryVotesResponse:

Field	Type	Description
`votes`	`Vote`[]	votes defines the queried votes.
`pagination`	`PageResponse`	pagination defines the pagination in the response.

grpcurl -plaintext -d '{"proposal_id":"1","pagination":{"limit":"1"}}' \
  localhost:9090 cosmos.gov.v1.Query/Votes

cosmos.gov.v1beta1.Query

Query defines the gRPC querier service for gov module

Deposit (Query, v1beta1)

Deposit queries single deposit information based on proposalID, depositor address.


gRPC	`cosmos.gov.v1beta1.Query/Deposit`
REST	`GET /cosmos/gov/v1beta1/proposals/{proposalId}/deposits/{depositor}`

Request QueryDepositRequest:

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`depositor`	`string`	depositor defines the deposit addresses from the proposals. Encoded as cosmos.AddressString.

Response QueryDepositResponse:

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

grpcurl -plaintext -d '{"proposal_id":"1","depositor":"<string>"}' \
  localhost:9090 cosmos.gov.v1beta1.Query/Deposit

Deposits (v1beta1)

Deposits queries all deposits of a single proposal.


gRPC	`cosmos.gov.v1beta1.Query/Deposits`
REST	`GET /cosmos/gov/v1beta1/proposals/{proposalId}/deposits`

Request QueryDepositsRequest:

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`pagination`	`PageRequest`	pagination defines an optional pagination for the request.

Response QueryDepositsResponse:

Field	Type	Description
`deposits`	`Deposit`[]	deposits defines the requested deposits.
`pagination`	`PageResponse`	pagination defines the pagination in the response.

grpcurl -plaintext -d '{"proposal_id":"1","pagination":{"limit":"1"}}' \
  localhost:9090 cosmos.gov.v1beta1.Query/Deposits

Params (v1beta1)

Params queries all parameters of the gov module.


gRPC	`cosmos.gov.v1beta1.Query/Params`
REST	`GET /cosmos/gov/v1beta1/params/{paramsType}`

Request QueryParamsRequest:

Field	Type	Description
`params_type`	`string`	params_type defines which parameters to query for, can be one of “voting”, “tallying” or “deposit”.

Response QueryParamsResponse:

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

grpcurl -plaintext -d '{"params_type":"voting"}' \
  localhost:9090 cosmos.gov.v1beta1.Query/Params

Proposal (v1beta1)

Proposal queries proposal details based on ProposalID.


gRPC	`cosmos.gov.v1beta1.Query/Proposal`
REST	`GET /cosmos/gov/v1beta1/proposals/{proposalId}`

Request QueryProposalRequest:

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

Response QueryProposalResponse:

Field	Type	Description
`proposal`	`Proposal`

grpcurl -plaintext -d '{"proposal_id":"1"}' \
  localhost:9090 cosmos.gov.v1beta1.Query/Proposal

Proposals (v1beta1)

Proposals queries all proposals based on given status.


gRPC	`cosmos.gov.v1beta1.Query/Proposals`
REST	`GET /cosmos/gov/v1beta1/proposals`

Request QueryProposalsRequest:

Field	Type	Description
`proposal_status`	`ProposalStatus`	proposal_status defines the status of the proposals.
`voter`	`string`	voter defines the voter address for the proposals. Encoded as cosmos.AddressString.
`depositor`	`string`	depositor defines the deposit addresses from the proposals. Encoded as cosmos.AddressString.
`pagination`	`PageRequest`	pagination defines an optional pagination for the request.

Response QueryProposalsResponse:

Field	Type	Description
`proposals`	`Proposal`[]	proposals defines all the requested governance proposals.
`pagination`	`PageResponse`	pagination defines the pagination in the response.

grpcurl -plaintext -d '{"proposal_status":"PROPOSAL_STATUS_DEPOSIT_PERIOD","voter":"<string>","depositor":"<string>","pagination":{"limit":"1"}}' \
  localhost:9090 cosmos.gov.v1beta1.Query/Proposals

TallyResult (v1beta1)

TallyResult queries the tally of a proposal vote.


gRPC	`cosmos.gov.v1beta1.Query/TallyResult`
REST	`GET /cosmos/gov/v1beta1/proposals/{proposalId}/tally`

Request QueryTallyResultRequest:

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

Response QueryTallyResultResponse:

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

grpcurl -plaintext -d '{"proposal_id":"1"}' \
  localhost:9090 cosmos.gov.v1beta1.Query/TallyResult

Vote (Query, v1beta1)

Vote queries voted information based on proposalID, voterAddr.


gRPC	`cosmos.gov.v1beta1.Query/Vote`
REST	`GET /cosmos/gov/v1beta1/proposals/{proposalId}/votes/{voter}`

Request QueryVoteRequest:

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`voter`	`string`	voter defines the voter address for the proposals. Encoded as cosmos.AddressString.

Response QueryVoteResponse:

Field	Type	Description
`vote`	`Vote`	vote defines the queried vote.

grpcurl -plaintext -d '{"proposal_id":"1","voter":"<string>"}' \
  localhost:9090 cosmos.gov.v1beta1.Query/Vote

Votes (v1beta1)

Votes queries votes of a given proposal.


gRPC	`cosmos.gov.v1beta1.Query/Votes`
REST	`GET /cosmos/gov/v1beta1/proposals/{proposalId}/votes`

Request QueryVotesRequest:

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`pagination`	`PageRequest`	pagination defines an optional pagination for the request.

Response QueryVotesResponse:

Field	Type	Description
`votes`	`Vote`[]	votes defines the queried votes.
`pagination`	`PageResponse`	pagination defines the pagination in the response.

grpcurl -plaintext -d '{"proposal_id":"1","pagination":{"limit":"1"}}' \
  localhost:9090 cosmos.gov.v1beta1.Query/Votes

Transaction messages

These messages are included in signed transactions, not called as endpoints. See Transactions for the execution model, and Sending transactions for the envelope they go into. Examples use CLI transaction JSON. Decimal fields use values such as "0.05", even when their proto type is bytes. The gRPC TxEncode method instead requires the scaled value "50000000000000000". See scalar encodings.

Handler: Generated client method
Signer: Account that must sign
Amino name: Legacy identifier used by hardware wallets and other Amino signers

CancelProposal

CancelProposal defines a method to cancel governance proposal


Type URL	`/cosmos.gov.v1.MsgCancelProposal`
Handler	`cosmos.gov.v1.Msg/CancelProposal`
Signer	`proposer`
Amino name	none registered

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`proposer`	`string`	proposer is the account address of the proposer. Encoded as cosmos.AddressString.

In a transaction:

{
  "@type": "/cosmos.gov.v1.MsgCancelProposal",
  "proposal_id": "1",
  "proposer": "<string>"
}

Response MsgCancelProposalResponse:

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`canceled_time`	`Timestamp`	canceled_time is the time when proposal is canceled.
`canceled_height`	`uint64`	canceled_height defines the block height at which the proposal is canceled.

Deposit (Msg, v1)

Deposit defines a method to add deposit on a specific proposal.


Type URL	`/cosmos.gov.v1.MsgDeposit`
Handler	`cosmos.gov.v1.Msg/Deposit`
Signer	`depositor`
Amino name	`cosmos-sdk/v1/MsgDeposit`

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`depositor`	`string`	depositor defines the deposit addresses from the proposals. Encoded as cosmos.AddressString.
`amount`	`Coin`[]	amount to be deposited by depositor.

In a transaction:

{
  "@type": "/cosmos.gov.v1.MsgDeposit",
  "proposal_id": "1",
  "depositor": "<string>",
  "amount": [
    {
      "denom": "<string>",
      "amount": "<string>"
    }
  ]
}

Response MsgDepositResponse: This message has no fields.

ExecLegacyContent

ExecLegacyContent defines a Msg to be in included in a MsgSubmitProposal to execute a legacy content-based proposal.


Type URL	`/cosmos.gov.v1.MsgExecLegacyContent`
Handler	`cosmos.gov.v1.Msg/ExecLegacyContent`
Signer	`authority`
Amino name	`cosmos-sdk/v1/MsgExecLegacyContent`

The signer is the governance module account, which no user holds a key for. This message executes only through a passed governance proposal, not as a transaction you submit directly.

Field	Type	Description
`content`	`Any`	content is the proposal’s content. One of: `/cosmos.distribution.v1beta1.CommunityPoolSpendProposal`, `/cosmos.distribution.v1beta1.CommunityPoolSpendProposalWithDeposit`, `/cosmos.gov.v1beta1.TextProposal`, `/cosmos.upgrade.v1beta1.CancelSoftwareUpgradeProposal`, `/cosmos.upgrade.v1beta1.SoftwareUpgradeProposal`.
`authority`	`string`	authority must be the gov module address.

In a transaction:

{
  "@type": "/cosmos.gov.v1.MsgExecLegacyContent",
  "content": {
    "@type": "/cosmos.example.v1.MsgExample",
    "...": "the fields of that message, inline"
  },
  "authority": "<string>"
}

Response MsgExecLegacyContentResponse: This message has no fields.

SubmitProposal (v1)

SubmitProposal defines a method to create new proposal given the messages.


Type URL	`/cosmos.gov.v1.MsgSubmitProposal`
Handler	`cosmos.gov.v1.Msg/SubmitProposal`
Signer	`proposer`
Amino name	`cosmos-sdk/v1/MsgSubmitProposal`

Field	Type	Description
`messages`	`Any`[]	messages are the arbitrary messages to be executed if proposal passes.
`initial_deposit`	`Coin`[]	initial_deposit is the deposit value that must be paid at proposal submission.
`proposer`	`string`	proposer is the account address of the proposer. Encoded as cosmos.AddressString.
`metadata`	`string`	metadata is any arbitrary metadata attached to the proposal.
`title`	`string`	title is the title of the proposal.
`summary`	`string`	summary is the summary of the proposal
`expedited`	`bool`	expedited defines if the proposal is expedited or not

In a transaction:

{
  "@type": "/cosmos.gov.v1.MsgSubmitProposal",
  "messages": [
    {
      "@type": "/cosmos.example.v1.MsgExample",
      "...": "the fields of that message, inline"
    }
  ],
  "initial_deposit": [
    {
      "denom": "<string>",
      "amount": "<string>"
    }
  ],
  "proposer": "<string>",
  "metadata": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "expedited": false
}

Response MsgSubmitProposalResponse:

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

UpdateParams

UpdateParams defines a governance operation for updating the x/gov module parameters. The authority is defined in the keeper.


Type URL	`/cosmos.gov.v1.MsgUpdateParams`
Handler	`cosmos.gov.v1.Msg/UpdateParams`
Signer	`authority`
Amino name	`cosmos-sdk/x/gov/v1/MsgUpdateParams`

The signer is the governance module account, which no user holds a key for. This message executes only through a passed governance proposal, not as a transaction you submit directly.

Field	Type	Description
`authority`	`string`	authority is the address that controls the module (defaults to x/gov unless overwritten). Encoded as cosmos.AddressString.
`params`	`Params`	params defines the x/gov parameters to update. NOTE: All parameters must be supplied.

In a transaction:

{
  "@type": "/cosmos.gov.v1.MsgUpdateParams",
  "authority": "<string>",
  "params": {
    "min_deposit": [
      {
        "denom": "<string>",
        "amount": "<string>"
      }
    ],
    "max_deposit_period": "0s",
    "voting_period": "0s",
    "quorum": "<string>",
    "threshold": "<string>",
    "veto_threshold": "<string>",
    "min_initial_deposit_ratio": "<string>",
    "proposal_cancel_ratio": "<string>",
    "proposal_cancel_dest": "<string>",
    "expedited_voting_period": "0s",
    "expedited_threshold": "<string>",
    "expedited_min_deposit": [
      {
        "denom": "<string>",
        "amount": "<string>"
      }
    ],
    "burn_vote_quorum": false,
    "burn_proposal_deposit_prevote": false,
    "burn_vote_veto": false,
    "min_deposit_ratio": "<string>"
  }
}

Response MsgUpdateParamsResponse: This message has no fields.

Vote (Msg, v1)

Vote defines a method to add a vote on a specific proposal.


Type URL	`/cosmos.gov.v1.MsgVote`
Handler	`cosmos.gov.v1.Msg/Vote`
Signer	`voter`
Amino name	`cosmos-sdk/v1/MsgVote`

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`voter`	`string`	voter is the voter address for the proposal. Encoded as cosmos.AddressString.
`option`	`VoteOption`	option defines the vote option.
`metadata`	`string`	metadata is any arbitrary metadata attached to the Vote.

In a transaction:

{
  "@type": "/cosmos.gov.v1.MsgVote",
  "proposal_id": "1",
  "voter": "<string>",
  "option": "VOTE_OPTION_YES",
  "metadata": "<string>"
}

Response MsgVoteResponse: This message has no fields.

VoteWeighted (v1)

VoteWeighted defines a method to add a weighted vote on a specific proposal.


Type URL	`/cosmos.gov.v1.MsgVoteWeighted`
Handler	`cosmos.gov.v1.Msg/VoteWeighted`
Signer	`voter`
Amino name	`cosmos-sdk/v1/MsgVoteWeighted`

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`voter`	`string`	voter is the voter address for the proposal. Encoded as cosmos.AddressString.
`options`	`WeightedVoteOption`[]	options defines the weighted vote options.
`metadata`	`string`	metadata is any arbitrary metadata attached to the VoteWeighted.

In a transaction:

{
  "@type": "/cosmos.gov.v1.MsgVoteWeighted",
  "proposal_id": "1",
  "voter": "<string>",
  "options": [
    {
      "option": "VOTE_OPTION_YES",
      "weight": "<string>"
    }
  ],
  "metadata": "<string>"
}

Response MsgVoteWeightedResponse: This message has no fields.

Deposit (Msg, v1beta1)

Deposit defines a method to add deposit on a specific proposal.


Type URL	`/cosmos.gov.v1beta1.MsgDeposit`
Handler	`cosmos.gov.v1beta1.Msg/Deposit`
Signer	`depositor`
Amino name	`cosmos-sdk/MsgDeposit`

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`depositor`	`string`	depositor defines the deposit addresses from the proposals. Encoded as cosmos.AddressString.
`amount`	`Coin`[]	amount to be deposited by depositor.

In a transaction:

{
  "@type": "/cosmos.gov.v1beta1.MsgDeposit",
  "proposal_id": "1",
  "depositor": "<string>",
  "amount": [
    {
      "denom": "<string>",
      "amount": "<string>"
    }
  ]
}

Response MsgDepositResponse: This message has no fields.

SubmitProposal (v1beta1)

SubmitProposal defines a method to create new proposal given a content.


Type URL	`/cosmos.gov.v1beta1.MsgSubmitProposal`
Handler	`cosmos.gov.v1beta1.Msg/SubmitProposal`
Signer	`proposer`
Amino name	`cosmos-sdk/MsgSubmitProposal`

Field	Type	Description
`content`	`Any`	content is the proposal’s content. One of: `/cosmos.distribution.v1beta1.CommunityPoolSpendProposal`, `/cosmos.distribution.v1beta1.CommunityPoolSpendProposalWithDeposit`, `/cosmos.gov.v1beta1.TextProposal`, `/cosmos.upgrade.v1beta1.CancelSoftwareUpgradeProposal`, `/cosmos.upgrade.v1beta1.SoftwareUpgradeProposal`.
`initial_deposit`	`Coin`[]	initial_deposit is the deposit value that must be paid at proposal submission.
`proposer`	`string`	proposer is the account address of the proposer. Encoded as cosmos.AddressString.

In a transaction:

{
  "@type": "/cosmos.gov.v1beta1.MsgSubmitProposal",
  "content": {
    "@type": "/cosmos.example.v1.MsgExample",
    "...": "the fields of that message, inline"
  },
  "initial_deposit": [
    {
      "denom": "<string>",
      "amount": "<string>"
    }
  ],
  "proposer": "<string>"
}

Response MsgSubmitProposalResponse:

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

Vote (Msg, v1beta1)

Vote defines a method to add a vote on a specific proposal.


Type URL	`/cosmos.gov.v1beta1.MsgVote`
Handler	`cosmos.gov.v1beta1.Msg/Vote`
Signer	`voter`
Amino name	`cosmos-sdk/MsgVote`

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`voter`	`string`	voter is the voter address for the proposal. Encoded as cosmos.AddressString.
`option`	`VoteOption`	option defines the vote option.

In a transaction:

{
  "@type": "/cosmos.gov.v1beta1.MsgVote",
  "proposal_id": "1",
  "voter": "<string>",
  "option": "VOTE_OPTION_YES"
}

Response MsgVoteResponse: This message has no fields.

VoteWeighted (v1beta1)

VoteWeighted defines a method to add a weighted vote on a specific proposal.


Type URL	`/cosmos.gov.v1beta1.MsgVoteWeighted`
Handler	`cosmos.gov.v1beta1.Msg/VoteWeighted`
Signer	`voter`
Amino name	`cosmos-sdk/MsgVoteWeighted`

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`voter`	`string`	voter is the voter address for the proposal. Encoded as cosmos.AddressString.
`options`	`WeightedVoteOption`[]	options defines the weighted vote options.

In a transaction:

{
  "@type": "/cosmos.gov.v1beta1.MsgVoteWeighted",
  "proposal_id": "1",
  "voter": "<string>",
  "options": [
    {
      "option": "VOTE_OPTION_YES",
      "weight": "<string>"
    }
  ]
}

Response MsgVoteWeightedResponse: This message has no fields.

Types

Messages referenced by the fields above. Protocol buffers version 3 has no required fields, so every field is optional on the wire, and a [] suffix marks a repeated field.

cosmos.base.query.v1beta1.PageRequest

PageRequest is to be embedded in gRPC request messages for efficient pagination. Ex: message SomeRequest { Foo some_parameter = 1; PageRequest pagination = 2; }

Field	Type	Description
`key`	`bytes`	key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
`offset`	`uint64`	offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
`limit`	`uint64`	limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
`count_total`	`bool`	count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
`reverse`	`bool`	reverse is set to true if results are to be returned in the descending order.

cosmos.base.query.v1beta1.PageResponse

PageResponse is to be embedded in gRPC response messages where the corresponding request message has used PageRequest. message SomeResponse { repeated Bar results = 1; PageResponse page = 2; }

Field	Type	Description
`next_key`	`bytes`	next_key is the key to be passed to PageRequest.key to query the next page most efficiently. It will be empty if there are no more results.
`total`	`uint64`	total is total number of results available if PageRequest.count_total was set, its value is undefined otherwise

cosmos.base.v1beta1.Coin

Coin defines a token with a denomination and an amount. NOTE: The amount field is an Int which implements the custom method signatures required by gogoproto.

Field	Type	Description
`denom`	`string`
`amount`	`string`	Encoded as cosmos.Int.

cosmos.gov.v1.Deposit

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

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`depositor`	`string`	depositor defines the deposit addresses from the proposals. Encoded as cosmos.AddressString.
`amount`	`Coin`[]	amount to be deposited by depositor.

cosmos.gov.v1.DepositParams

DepositParams defines the params for deposits on governance proposals.

Field	Type	Description
`min_deposit`	`Coin`[]	Minimum deposit for a proposal to enter voting period.
`max_deposit_period`	`Duration`	Maximum period for Atom holders to deposit on a proposal. Initial value: 2 months.

cosmos.gov.v1.Params

Params defines the parameters for the x/gov module.

Field	Type	Description
`min_deposit`	`Coin`[]	Minimum deposit for a proposal to enter voting period.
`max_deposit_period`	`Duration`	Maximum period for Atom holders to deposit on a proposal. Initial value: 2 months.
`voting_period`	`Duration`	Duration of the voting period.
`quorum`	`string`	Minimum percentage of total stake needed to vote for a result to be considered valid. Encoded as cosmos.Dec, a decimal string.
`threshold`	`string`	Minimum proportion of Yes votes for proposal to pass. Default value: 0.5. Encoded as cosmos.Dec, a decimal string.
`veto_threshold`	`string`	Minimum value of Veto votes to Total votes ratio for proposal to be vetoed. Default value: 1/3. Encoded as cosmos.Dec, a decimal string.
`min_initial_deposit_ratio`	`string`	The ratio representing the proportion of the deposit value that must be paid at proposal submission. Encoded as cosmos.Dec, a decimal string.
`proposal_cancel_ratio`	`string`	The cancel ratio which will not be returned back to the depositors when a proposal is cancelled. Encoded as cosmos.Dec, a decimal string.
`proposal_cancel_dest`	`string`	The address which will receive (proposal_cancel_ratio * deposit) proposal deposits. If empty, the (proposal_cancel_ratio * deposit) proposal deposits will be burned. Encoded as cosmos.AddressString.
`expedited_voting_period`	`Duration`	Duration of the voting period of an expedited proposal.
`expedited_threshold`	`string`	Minimum proportion of Yes votes for proposal to pass. Default value: 0.67. Encoded as cosmos.Dec, a decimal string.
`expedited_min_deposit`	`Coin`[]	Minimum expedited deposit for a proposal to enter voting period.
`burn_vote_quorum`	`bool`	burn deposits if a proposal does not meet quorum
`burn_proposal_deposit_prevote`	`bool`	burn deposits if the proposal does not enter voting period
`burn_vote_veto`	`bool`	burn deposits if quorum with vote type no_veto is met
`min_deposit_ratio`	`string`	The ratio representing the proportion of the deposit value minimum that must be met when making a deposit. Default value: 0.01. Meaning that for a chain with a min_deposit of 100stake, a deposit of 1stake would be required. Encoded as cosmos.Dec, a decimal string.

cosmos.gov.v1.Proposal

Proposal defines the core field members of a governance proposal.

Field	Type	Description
`id`	`uint64`	id defines the unique id of the proposal.
`messages`	`Any`[]	messages are the arbitrary messages to be executed if the proposal passes.
`status`	`ProposalStatus`	status defines the proposal status.
`final_tally_result`	`TallyResult`	final_tally_result is the final tally result of the proposal. When querying a proposal via gRPC, this field is not populated until the proposal’s voting period has ended.
`submit_time`	`Timestamp`	submit_time is the time of proposal submission.
`deposit_end_time`	`Timestamp`	deposit_end_time is the end time for deposition.
`total_deposit`	`Coin`[]	total_deposit is the total deposit on the proposal.
`voting_start_time`	`Timestamp`	voting_start_time is the starting time to vote on a proposal.
`voting_end_time`	`Timestamp`	voting_end_time is the end time of voting on a proposal.
`metadata`	`string`	metadata is any arbitrary metadata attached to the proposal. the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/gov#proposal-3
`title`	`string`	title is the title of the proposal
`summary`	`string`	summary is a short summary of the proposal
`proposer`	`string`	proposer is the address of the proposal submitter Encoded as cosmos.AddressString.
`expedited`	`bool`	expedited defines if the proposal is expedited
`failed_reason`	`string`	failed_reason defines the reason why the proposal failed

cosmos.gov.v1.ProposalStatus

Written as a quoted string in JSON.

Value
`PROPOSAL_STATUS_UNSPECIFIED`	Zero value. Handlers reject it.
`PROPOSAL_STATUS_DEPOSIT_PERIOD`
`PROPOSAL_STATUS_VOTING_PERIOD`
`PROPOSAL_STATUS_PASSED`
`PROPOSAL_STATUS_REJECTED`
`PROPOSAL_STATUS_FAILED`

cosmos.gov.v1.TallyParams

TallyParams defines the params for tallying votes on governance proposals.

Field	Type	Description
`quorum`	`string`	Minimum percentage of total stake needed to vote for a result to be considered valid. Encoded as cosmos.Dec, a decimal string.
`threshold`	`string`	Minimum proportion of Yes votes for proposal to pass. Default value: 0.5. Encoded as cosmos.Dec, a decimal string.
`veto_threshold`	`string`	Minimum value of Veto votes to Total votes ratio for proposal to be vetoed. Default value: 1/3. Encoded as cosmos.Dec, a decimal string.

cosmos.gov.v1.TallyResult

TallyResult defines a standard tally for a governance proposal.

Field	Type	Description
`yes_count`	`string`	yes_count is the number of yes votes on a proposal. Encoded as cosmos.Int.
`abstain_count`	`string`	abstain_count is the number of abstain votes on a proposal. Encoded as cosmos.Int.
`no_count`	`string`	no_count is the number of no votes on a proposal. Encoded as cosmos.Int.
`no_with_veto_count`	`string`	no_with_veto_count is the number of no with veto votes on a proposal. Encoded as cosmos.Int.

cosmos.gov.v1.Vote

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

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`voter`	`string`	voter is the voter address of the proposal. Encoded as cosmos.AddressString.
`options`	`WeightedVoteOption`[]	options is the weighted vote options.
`metadata`	`string`	metadata is any arbitrary metadata attached to the vote. the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/gov#vote-5

cosmos.gov.v1.VoteOption

Written as a quoted string in JSON.

Value
`VOTE_OPTION_UNSPECIFIED`	Zero value. Handlers reject it.
`VOTE_OPTION_YES`
`VOTE_OPTION_ABSTAIN`
`VOTE_OPTION_NO`
`VOTE_OPTION_NO_WITH_VETO`

cosmos.gov.v1.VotingParams

VotingParams defines the params for voting on governance proposals.

Field	Type	Description
`voting_period`	`Duration`	Duration of the voting period.

cosmos.gov.v1.WeightedVoteOption

WeightedVoteOption defines a unit of vote for vote split.

Field	Type	Description
`option`	`VoteOption`	option defines the valid vote options, it must not contain duplicate vote options.
`weight`	`string`	weight is the vote weight associated with the vote option. Encoded as cosmos.Dec, a decimal string.

cosmos.gov.v1beta1.Deposit

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

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`depositor`	`string`	depositor defines the deposit addresses from the proposals. Encoded as cosmos.AddressString.
`amount`	`Coin`[]	amount to be deposited by depositor.

cosmos.gov.v1beta1.DepositParams

DepositParams defines the params for deposits on governance proposals.

Field	Type	Description
`min_deposit`	`Coin`[]	Minimum deposit for a proposal to enter voting period.
`max_deposit_period`	`Duration`	Maximum period for Atom holders to deposit on a proposal. Initial value: 2 months.

cosmos.gov.v1beta1.Proposal

Proposal defines the core field members of a governance proposal.

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`content`	`Any`	content is the proposal’s content. One of: `/cosmos.distribution.v1beta1.CommunityPoolSpendProposal`, `/cosmos.distribution.v1beta1.CommunityPoolSpendProposalWithDeposit`, `/cosmos.gov.v1beta1.TextProposal`, `/cosmos.upgrade.v1beta1.CancelSoftwareUpgradeProposal`, `/cosmos.upgrade.v1beta1.SoftwareUpgradeProposal`.
`status`	`ProposalStatus`	status defines the proposal status.
`final_tally_result`	`TallyResult`	final_tally_result is the final tally result of the proposal. When querying a proposal via gRPC, this field is not populated until the proposal’s voting period has ended.
`submit_time`	`Timestamp`	submit_time is the time of proposal submission.
`deposit_end_time`	`Timestamp`	deposit_end_time is the end time for deposition.
`total_deposit`	`Coin`[]	total_deposit is the total deposit on the proposal.
`voting_start_time`	`Timestamp`	voting_start_time is the starting time to vote on a proposal.
`voting_end_time`	`Timestamp`	voting_end_time is the end time of voting on a proposal.

cosmos.gov.v1beta1.ProposalStatus

Written as a quoted string in JSON.

Value
`PROPOSAL_STATUS_UNSPECIFIED`	Zero value. Handlers reject it.
`PROPOSAL_STATUS_DEPOSIT_PERIOD`
`PROPOSAL_STATUS_VOTING_PERIOD`
`PROPOSAL_STATUS_PASSED`
`PROPOSAL_STATUS_REJECTED`
`PROPOSAL_STATUS_FAILED`

cosmos.gov.v1beta1.TallyParams

TallyParams defines the params for tallying votes on governance proposals.

Field	Type	Description
`quorum`	`bytes`	Minimum percentage of total stake needed to vote for a result to be considered valid. Encoded as cosmos.Dec, read back as base64 of an integer string scaled by 10^18 over gRPC.
`threshold`	`bytes`	Minimum proportion of Yes votes for proposal to pass. Default value: 0.5. Encoded as cosmos.Dec, read back as base64 of an integer string scaled by 10^18 over gRPC.
`veto_threshold`	`bytes`	Minimum value of Veto votes to Total votes ratio for proposal to be vetoed. Default value: 1/3. Encoded as cosmos.Dec, read back as base64 of an integer string scaled by 10^18 over gRPC.

cosmos.gov.v1beta1.TallyResult

TallyResult defines a standard tally for a governance proposal.

Field	Type	Description
`yes`	`string`	yes is the number of yes votes on a proposal. Encoded as cosmos.Int.
`abstain`	`string`	abstain is the number of abstain votes on a proposal. Encoded as cosmos.Int.
`no`	`string`	no is the number of no votes on a proposal. Encoded as cosmos.Int.
`no_with_veto`	`string`	no_with_veto is the number of no with veto votes on a proposal. Encoded as cosmos.Int.

cosmos.gov.v1beta1.Vote

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

Field	Type	Description
`proposal_id`	`uint64`	proposal_id defines the unique id of the proposal.
`voter`	`string`	voter is the voter address of the proposal. Encoded as cosmos.AddressString.
`option`	`VoteOption`	Deprecated: Prefer to use `options` instead. This field is set in queries if and only if `len(options) == 1` and that option has weight 1. In all other cases, this field will default to VOTE_OPTION_UNSPECIFIED. Deprecated.
`options`	`WeightedVoteOption`[]	options is the weighted vote options.

cosmos.gov.v1beta1.VoteOption

Written as a quoted string in JSON.

Value
`VOTE_OPTION_UNSPECIFIED`	Zero value. Handlers reject it.
`VOTE_OPTION_YES`
`VOTE_OPTION_ABSTAIN`
`VOTE_OPTION_NO`
`VOTE_OPTION_NO_WITH_VETO`

cosmos.gov.v1beta1.VotingParams

VotingParams defines the params for voting on governance proposals.

Field	Type	Description
`voting_period`	`Duration`	Duration of the voting period.

cosmos.gov.v1beta1.WeightedVoteOption

WeightedVoteOption defines a unit of vote for vote split.

Field	Type	Description
`option`	`VoteOption`	option defines the valid vote options, it must not contain duplicate vote options.
`weight`	`string`	weight is the vote weight associated with the vote option. Encoded as cosmos.Dec, read back as an integer string scaled by 10^18 over gRPC.

​Queries

​cosmos.gov.v1.Query

​Constitution

​Deposit (Query, v1)

​Deposits (v1)

​Params (v1)

​Proposal (v1)

​Proposals (v1)

​TallyResult (v1)

​Vote (Query, v1)

​Votes (v1)

​cosmos.gov.v1beta1.Query

​Deposit (Query, v1beta1)

​Deposits (v1beta1)

​Params (v1beta1)

​Proposal (v1beta1)

​Proposals (v1beta1)

​TallyResult (v1beta1)

​Vote (Query, v1beta1)

​Votes (v1beta1)

​Transaction messages

​CancelProposal

​Deposit (Msg, v1)

​ExecLegacyContent

​SubmitProposal (v1)

​UpdateParams

​Vote (Msg, v1)

​VoteWeighted (v1)

​Deposit (Msg, v1beta1)

​SubmitProposal (v1beta1)

​Vote (Msg, v1beta1)

​VoteWeighted (v1beta1)

​Types

​cosmos.base.query.v1beta1.PageRequest

​cosmos.base.query.v1beta1.PageResponse

​cosmos.base.v1beta1.Coin

​cosmos.gov.v1.Deposit

​cosmos.gov.v1.DepositParams

​cosmos.gov.v1.Params

​cosmos.gov.v1.Proposal

​cosmos.gov.v1.ProposalStatus

​cosmos.gov.v1.TallyParams

​cosmos.gov.v1.TallyResult

​cosmos.gov.v1.Vote

​cosmos.gov.v1.VoteOption

​cosmos.gov.v1.VotingParams

​cosmos.gov.v1.WeightedVoteOption

​cosmos.gov.v1beta1.Deposit

​cosmos.gov.v1beta1.DepositParams

​cosmos.gov.v1beta1.Proposal

​cosmos.gov.v1beta1.ProposalStatus

​cosmos.gov.v1beta1.TallyParams

​cosmos.gov.v1beta1.TallyResult

​cosmos.gov.v1beta1.Vote

​cosmos.gov.v1beta1.VoteOption

​cosmos.gov.v1beta1.VotingParams

​cosmos.gov.v1beta1.WeightedVoteOption

Queries

cosmos.gov.v1.Query

Constitution

Deposit (Query, v1)

Deposits (v1)

Params (v1)

Proposal (v1)

Proposals (v1)

TallyResult (v1)

Vote (Query, v1)

Votes (v1)

cosmos.gov.v1beta1.Query

Deposit (Query, v1beta1)

Deposits (v1beta1)

Params (v1beta1)

Proposal (v1beta1)

Proposals (v1beta1)

TallyResult (v1beta1)

Vote (Query, v1beta1)

Votes (v1beta1)

Transaction messages

CancelProposal

Deposit (Msg, v1)

ExecLegacyContent

SubmitProposal (v1)

UpdateParams

Vote (Msg, v1)

VoteWeighted (v1)

Deposit (Msg, v1beta1)

SubmitProposal (v1beta1)

Vote (Msg, v1beta1)

VoteWeighted (v1beta1)

Types

cosmos.base.query.v1beta1.PageRequest

cosmos.base.query.v1beta1.PageResponse

cosmos.base.v1beta1.Coin

cosmos.gov.v1.Deposit

cosmos.gov.v1.DepositParams

cosmos.gov.v1.Params

cosmos.gov.v1.Proposal

cosmos.gov.v1.ProposalStatus

cosmos.gov.v1.TallyParams

cosmos.gov.v1.TallyResult

cosmos.gov.v1.Vote

cosmos.gov.v1.VoteOption

cosmos.gov.v1.VotingParams

cosmos.gov.v1.WeightedVoteOption

cosmos.gov.v1beta1.Deposit

cosmos.gov.v1beta1.DepositParams

cosmos.gov.v1beta1.Proposal

cosmos.gov.v1beta1.ProposalStatus

cosmos.gov.v1beta1.TallyParams

cosmos.gov.v1beta1.TallyResult

cosmos.gov.v1beta1.Vote

cosmos.gov.v1beta1.VoteOption

cosmos.gov.v1beta1.VotingParams

cosmos.gov.v1beta1.WeightedVoteOption