cosmos-sdk/docs/architecture/adr-037-gov-split-vote.md

105 lines
3.4 KiB
Markdown
Raw Normal View History

2020-11-11 09:35:07 -08:00
# ADR 037: Governance split votes
2020-10-28 06:24:55 -07:00
## Changelog
- 2020/10/28: Intial draft
## Status
Proposed
## Abstract
2020-10-29 11:09:05 -07:00
This ADR defines a modification to the the governance module that would allow a staker to split their votes into several voting options. For example, it could use 70% of its voting power to vote Yes and 30% of its voting power to vote No.
2020-10-28 06:24:55 -07:00
## Context
2020-10-29 11:09:05 -07:00
Currently, an address can cast a vote with only one options (Yes/No/Abstain/NoWithVeto) and use their full voting power behind that choice.
2020-10-28 06:24:55 -07:00
2020-10-29 11:09:05 -07:00
However, often times the entity owning that address might not be a single individual. For example, a company might have different stakeholders who want to vote differently, and so it makes sense to allow them to split their voting power. Another example use case is exchanges. Many centralized exchanges often stake a portion of their users' tokens in their custody. Currently, it is not possible for them to do "passthrough voting" and giving their users voting rights over their tokens. However, with this system, exchanges can poll their users for voting preferences, and then vote on-chain proportionally to the results of the poll.
2020-10-28 06:24:55 -07:00
2020-10-29 11:09:05 -07:00
## Decision
2020-10-28 06:24:55 -07:00
2020-10-29 11:09:05 -07:00
We modify the vote structs to be
2020-10-28 06:24:55 -07:00
2020-10-29 11:09:05 -07:00
```
2020-10-29 13:35:50 -07:00
type WeightedVoteOption struct {
Option string
Weight sdk.Dec
}
type Vote struct {
ProposalID int64
Voter sdk.Address
Options []WeightedVoteOption
2020-10-29 11:09:05 -07:00
}
```
2020-10-28 06:24:55 -07:00
And for backwards compatibility, we introduce `MsgWeightedVote` while keeping `MsgVote`.
```
type MsgVote struct {
ProposalID int64
Voter sdk.Address
Option Option
}
type MsgWeightedVote struct {
ProposalID int64
Voter sdk.Address
Options []WeightedVoteOption
}
```
The `ValidateBasic` of a `MsgWeightedVote` struct would require that
2020-10-29 13:35:50 -07:00
1. The sum of all the Rates is equal to 1.0
2. No Option is repeated
2020-10-29 11:09:05 -07:00
The governance tally function will iterate over all the options in a vote and add to the tally the result of the voter's voting power * the rate for that option.
2020-10-28 06:24:55 -07:00
```
2020-10-29 11:09:05 -07:00
tally() {
2020-10-29 13:35:50 -07:00
results := map[types.VoteOption]sdk.Dec
2020-10-29 11:09:05 -07:00
2020-10-29 13:35:50 -07:00
for _, vote := range votes {
for i, weightedOption := range vote.Options {
results[weightedOption.Option] += getVotingPower(vote.voter) * weightedOption.Weight
2020-10-29 11:09:05 -07:00
}
}
}
2020-10-28 06:24:55 -07:00
```
2020-10-29 11:09:05 -07:00
The CLI command for creating a multi-option vote would be as such:
```sh
simd tx gov vote 1 "yes=0.6,no=0.3,abstain=0.05,no_with_veto=0.05" --from mykey
2020-10-28 06:24:55 -07:00
```
2020-10-29 11:09:05 -07:00
To create a single-option vote a user can do either
2020-10-28 06:24:55 -07:00
```
simd tx gov vote 1 "yes=1" --from mykey
```
2020-10-29 11:09:05 -07:00
or
```sh
simd tx gov vote 1 yes --from mykey
2020-10-28 06:24:55 -07:00
```
2020-10-29 11:09:05 -07:00
to maintain backwards compatibility.
2020-10-28 06:24:55 -07:00
## Consequences
2020-11-02 08:56:45 -08:00
### Backwards Compatibility
- Previous VoteMsg types will remain the same and so clients will not have to update their procedure unless they want to support the WeightedVoteMsg feature.
- When querying a Vote struct from state, its structure will be different, and so clients wanting to display all voters and their respective votes will have to handle the new format and the fact that a single voter can have split votes.
- The result of querying the tally function should have the same API for clients.
2020-10-28 06:24:55 -07:00
### Positive
2020-10-29 13:35:50 -07:00
- Can make the voting process more accurate for addresses representing multiple stakeholders, often some of the largest addresses.
2020-10-28 06:24:55 -07:00
### Negative
2020-11-02 08:56:45 -08:00
- Is more complex than simple voting, and so may be harder to explain to users. However, this is mostly mitigated because the feature is opt-in.
2020-10-28 06:24:55 -07:00
### Neutral
2020-10-29 11:09:05 -07:00
- Relatively minor change to governance tally function.