package cosmos.gov.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the gov Msg service.

• rpc SubmitProposal (MsgSubmitProposal, MsgSubmitProposalResponse)

  tx.proto:20

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

  message MsgSubmitProposal

  tx.proto:44

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

  • repeated google.protobuf.Any messages = 1

    messages are the arbitrary messages to be executed if proposal passes.

  • repeated base.v1beta1.Coin initial_deposit = 2

    initial_deposit is the deposit value that must be paid at proposal submission.

  • string proposer = 3

    proposer is the account address of the proposer.

  • string metadata = 4

    metadata is any arbitrary metadata attached to the proposal.

  • string title = 5

    title is the title of the proposal. Since: cosmos-sdk 0.47

  • string summary = 6

    summary is the summary of the proposal Since: cosmos-sdk 0.47

  message MsgSubmitProposalResponse

  tx.proto:72

  MsgSubmitProposalResponse defines the Msg/SubmitProposal response type.

  • uint64 proposal_id = 1

    proposal_id defines the unique id of the proposal.

• rpc ExecLegacyContent (MsgExecLegacyContent, MsgExecLegacyContentResponse)

  tx.proto:24

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

  message MsgExecLegacyContent

  tx.proto:79

  MsgExecLegacyContent is used to wrap the legacy content field into a message. This ensures backwards compatibility with v1beta1.MsgSubmitProposal.

  • optional google.protobuf.Any content = 1

    content is the proposal's content.

  • string authority = 2

    authority must be the gov module address.

  message MsgExecLegacyContentResponse

  tx.proto:90

  MsgExecLegacyContentResponse defines the Msg/ExecLegacyContent response type.

  (message has no fields)

• rpc Vote (MsgVote, MsgVoteResponse)

  tx.proto:27

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

  message MsgVote

  tx.proto:93

  MsgVote defines a message to cast a vote.

  • uint64 proposal_id = 1

    proposal_id defines the unique id of the proposal.

  • string voter = 2

    voter is the voter address for the proposal.

  • VoteOption option = 3

    option defines the vote option.

  • string metadata = 4

    metadata is any arbitrary metadata attached to the Vote.

  message MsgVoteResponse

  tx.proto:111

  MsgVoteResponse defines the Msg/Vote response type.

  (message has no fields)

• rpc VoteWeighted (MsgVoteWeighted, MsgVoteWeightedResponse)

  tx.proto:30

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

  message MsgVoteWeighted

  tx.proto:114

  MsgVoteWeighted defines a message to cast a vote.

  • uint64 proposal_id = 1

    proposal_id defines the unique id of the proposal.

  • string voter = 2

    voter is the voter address for the proposal.

  • repeated WeightedVoteOption options = 3

    options defines the weighted vote options.

  • string metadata = 4

    metadata is any arbitrary metadata attached to the VoteWeighted.

  message MsgVoteWeightedResponse

  tx.proto:132

  MsgVoteWeightedResponse defines the Msg/VoteWeighted response type.

  (message has no fields)

• rpc Deposit (MsgDeposit, MsgDepositResponse)

  tx.proto:33

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

  message MsgDeposit

  tx.proto:135

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

  • uint64 proposal_id = 1

    proposal_id defines the unique id of the proposal.

  • string depositor = 2

    depositor defines the deposit addresses from the proposals.

  • repeated base.v1beta1.Coin amount = 3

    amount to be deposited by depositor.

  message MsgDepositResponse

  tx.proto:150

  MsgDepositResponse defines the Msg/Deposit response type.

  (message has no fields)

• rpc UpdateParams (MsgUpdateParams, MsgUpdateParamsResponse)

  tx.proto:39

  UpdateParams defines a governance operation for updating the x/gov module parameters. The authority is defined in the keeper. Since: cosmos-sdk 0.47

  message MsgUpdateParams

  tx.proto:155

  MsgUpdateParams is the Msg/UpdateParams request type. Since: cosmos-sdk 0.47

  • string authority = 1

    authority is the address that controls the module (defaults to x/gov unless overwritten).

  • optional Params params = 2

    params defines the x/gov parameters to update. NOTE: All parameters must be supplied.

  message MsgUpdateParamsResponse

  tx.proto:172

  MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message. Since: cosmos-sdk 0.47

  (message has no fields)

Query defines the gRPC querier service for gov module

• rpc Proposal (QueryProposalRequest, QueryProposalResponse)

  query.proto:16

  Proposal queries proposal details based on ProposalID.

  message QueryProposalRequest

  query.proto:57

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

  • uint64 proposal_id = 1

    proposal_id defines the unique id of the proposal.

  message QueryProposalResponse

  query.proto:63

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

  • optional Proposal proposal = 1

    proposal is the requested governance proposal.

• rpc Proposals (QueryProposalsRequest, QueryProposalsResponse)

  query.proto:21

  Proposals queries all proposals based on given status.

  message QueryProposalsRequest

  query.proto:69

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

  • ProposalStatus proposal_status = 1

    proposal_status defines the status of the proposals.

  • string voter = 2

    voter defines the voter address for the proposals.

  • string depositor = 3

    depositor defines the deposit addresses from the proposals.

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

    pagination defines an optional pagination for the request.

  message QueryProposalsResponse

  query.proto:85

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

  • repeated Proposal proposals = 1

    proposals defines all the requested governance proposals.

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

    pagination defines the pagination in the response.

• rpc Vote (QueryVoteRequest, QueryVoteResponse)

  query.proto:26

  Vote queries voted information based on proposalID, voterAddr.

  message QueryVoteRequest

  query.proto:94

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

  • uint64 proposal_id = 1

    proposal_id defines the unique id of the proposal.

  • string voter = 2

    voter defines the voter address for the proposals.

  message QueryVoteResponse

  query.proto:103

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

  • optional Vote vote = 1

    vote defines the queried vote.

• rpc Votes (QueryVotesRequest, QueryVotesResponse)

  query.proto:31

  Votes queries votes of a given proposal.

  message QueryVotesRequest

  query.proto:109

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

  • uint64 proposal_id = 1

    proposal_id defines the unique id of the proposal.

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

    pagination defines an optional pagination for the request.

  message QueryVotesResponse

  query.proto:118

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

  • repeated Vote votes = 1

    votes defines the queried votes.

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

    pagination defines the pagination in the response.

• rpc Params (QueryParamsRequest, QueryParamsResponse)

  query.proto:36

  Params queries all parameters of the gov module.

  message QueryParamsRequest

  query.proto:127

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

  • string params_type = 1

    params_type defines which parameters to query for, can be one of "voting", "tallying" or "deposit".

  message QueryParamsResponse

  query.proto:134

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

  • optional VotingParams voting_params = 1

    Deprecated: Prefer to use `params` instead. voting_params defines the parameters related to voting.

  • optional DepositParams deposit_params = 2

    Deprecated: Prefer to use `params` instead. deposit_params defines the parameters related to deposit.

  • optional TallyParams tally_params = 3

    Deprecated: Prefer to use `params` instead. tally_params defines the parameters related to tally.

  • optional Params params = 4

    params defines all the paramaters of x/gov module. Since: cosmos-sdk 0.47

• rpc Deposit (QueryDepositRequest, QueryDepositResponse)

  query.proto:41

  Deposit queries single deposit information based proposalID, depositAddr.

  message QueryDepositRequest

  query.proto:151

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

  • uint64 proposal_id = 1

    proposal_id defines the unique id of the proposal.

  • string depositor = 2

    depositor defines the deposit addresses from the proposals.

  message QueryDepositResponse

  query.proto:160

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

  • optional Deposit deposit = 1

    deposit defines the requested deposit.

• rpc Deposits (QueryDepositsRequest, QueryDepositsResponse)

  query.proto:46

  Deposits queries all deposits of a single proposal.

  message QueryDepositsRequest

  query.proto:166

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

  • uint64 proposal_id = 1

    proposal_id defines the unique id of the proposal.

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

    pagination defines an optional pagination for the request.

  message QueryDepositsResponse

  query.proto:175

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

  • repeated Deposit deposits = 1

    deposits defines the requested deposits.

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

    pagination defines the pagination in the response.

• rpc TallyResult (QueryTallyResultRequest, QueryTallyResultResponse)

  query.proto:51

  TallyResult queries the tally of a proposal vote.

  message QueryTallyResultRequest

  query.proto:184

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

  • uint64 proposal_id = 1

    proposal_id defines the unique id of the proposal.

  message QueryTallyResultResponse

  query.proto:190

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

  • optional TallyResult tally = 1

    tally defines the requested tally.

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

Used in: GenesisState, QueryDepositResponse, QueryDepositsResponse

• uint64 proposal_id = 1

  proposal_id defines the unique id of the proposal.

• string depositor = 2

  depositor defines the deposit addresses from the proposals.

• repeated base.v1beta1.Coin amount = 3

  amount to be deposited by depositor.

DepositParams defines the params for deposits on governance proposals.

Used in: GenesisState, QueryParamsResponse

• repeated base.v1beta1.Coin min_deposit = 1

  Minimum deposit for a proposal to enter voting period.

• optional google.protobuf.Duration max_deposit_period = 2

  Maximum period for Atom holders to deposit on a proposal. Initial value: 2 months.

GenesisState defines the gov module's genesis state.

• uint64 starting_proposal_id = 1

  starting_proposal_id is the ID of the starting proposal.

• repeated Deposit deposits = 2

  deposits defines all the deposits present at genesis.

• repeated Vote votes = 3

  votes defines all the votes present at genesis.

• repeated Proposal proposals = 4

  proposals defines all the proposals present at genesis.

• optional DepositParams deposit_params = 5

  Deprecated: Prefer to use `params` instead. deposit_params defines all the paramaters of related to deposit.

• optional VotingParams voting_params = 6

  Deprecated: Prefer to use `params` instead. voting_params defines all the paramaters of related to voting.

• optional TallyParams tally_params = 7

  Deprecated: Prefer to use `params` instead. tally_params defines all the paramaters of related to tally.

• optional Params params = 8

  params defines all the paramaters of x/gov module. Since: cosmos-sdk 0.47

Params defines the parameters for the x/gov module. Since: cosmos-sdk 0.47

Used in: GenesisState, MsgUpdateParams, QueryParamsResponse

• repeated base.v1beta1.Coin min_deposit = 1

  Minimum deposit for a proposal to enter voting period.

• optional google.protobuf.Duration max_deposit_period = 2

  Maximum period for Atom holders to deposit on a proposal. Initial value: 2 months.

• optional google.protobuf.Duration voting_period = 3

  Duration of the voting period.

• string quorum = 4

  Minimum percentage of total stake needed to vote for a result to be considered valid.

• string threshold = 5

  Minimum proportion of Yes votes for proposal to pass. Default value: 0.5.

• string veto_threshold = 6

  Minimum value of Veto votes to Total votes ratio for proposal to be vetoed. Default value: 1/3.

• string min_initial_deposit_ratio = 7

  The ratio representing the proportion of the deposit value that must be paid at proposal submission.

• bool burn_vote_quorum = 13

  burn deposits if a proposal does not meet quorum

• bool burn_proposal_deposit_prevote = 14

  burn deposits if the proposal does not enter voting period

• bool burn_vote_veto = 15

  burn deposits if quorum with vote type no_veto is met

Proposal defines the core field members of a governance proposal.

Used in: GenesisState, QueryProposalResponse, QueryProposalsResponse

• uint64 id = 1

  id defines the unique id of the proposal.

• repeated google.protobuf.Any messages = 2

  messages are the arbitrary messages to be executed if the proposal passes.

• ProposalStatus status = 3

  status defines the proposal status.

• optional TallyResult final_tally_result = 4

  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.

• optional google.protobuf.Timestamp submit_time = 5

  submit_time is the time of proposal submission.

• optional google.protobuf.Timestamp deposit_end_time = 6

  deposit_end_time is the end time for deposition.

• repeated base.v1beta1.Coin total_deposit = 7

  total_deposit is the total deposit on the proposal.

• optional google.protobuf.Timestamp voting_start_time = 8

  voting_start_time is the starting time to vote on a proposal.

• optional google.protobuf.Timestamp voting_end_time = 9

  voting_end_time is the end time of voting on a proposal.

• string metadata = 10

  metadata is any arbitrary metadata attached to the proposal.

• string title = 11

  title is the title of the proposal Since: cosmos-sdk 0.47

• string summary = 12

  summary is a short summary of the proposal Since: cosmos-sdk 0.47

• string proposer = 13

  Proposer is the address of the proposal sumbitter Since: cosmos-sdk 0.47

ProposalStatus enumerates the valid statuses of a proposal.

Used in: Proposal, QueryProposalsRequest

• PROPOSAL_STATUS_UNSPECIFIED = 0

  PROPOSAL_STATUS_UNSPECIFIED defines the default proposal 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.

TallyParams defines the params for tallying votes on governance proposals.

Used in: GenesisState, QueryParamsResponse

• string quorum = 1

  Minimum percentage of total stake needed to vote for a result to be considered valid.

• string threshold = 2

  Minimum proportion of Yes votes for proposal to pass. Default value: 0.5.

• string veto_threshold = 3

  Minimum value of Veto votes to Total votes ratio for proposal to be vetoed. Default value: 1/3.

TallyResult defines a standard tally for a governance proposal.

Used in: Proposal, QueryTallyResultResponse

• string yes_count = 1

  yes_count is the number of yes votes on a proposal.

• string abstain_count = 2

  abstain_count is the number of abstain votes on a proposal.

• string no_count = 3

  no_count is the number of no votes on a proposal.

• string no_with_veto_count = 4

  no_with_veto_count is the number of no with veto votes on a proposal.

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

Used in: GenesisState, QueryVoteResponse, QueryVotesResponse

• uint64 proposal_id = 1

  proposal_id defines the unique id of the proposal.

• string voter = 2

  voter is the voter address of the proposal.

• repeated WeightedVoteOption options = 4

  options is the weighted vote options.

• string metadata = 5

  metadata is any arbitrary metadata to attached to the vote.

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

Used in: MsgVote, WeightedVoteOption

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

VotingParams defines the params for voting on governance proposals.

Used in: GenesisState, QueryParamsResponse

• optional google.protobuf.Duration voting_period = 1

  Duration of the voting period.

WeightedVoteOption defines a unit of vote for vote split.

Used in: MsgVoteWeighted, Vote

• VoteOption option = 1

  option defines the valid vote options, it must not contain duplicate vote options.

• string weight = 2

  weight is the vote weight associated with the vote option.