-
Notifications
You must be signed in to change notification settings - Fork 7
/
proposal.go
229 lines (178 loc) · 6.44 KB
/
proposal.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
package keeper
import (
"fmt"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
gov "github.com/cosmos/cosmos-sdk/x/gov"
"github.com/anathatech/project-anatha/x/governance/internal/types"
"strconv"
)
func (k Keeper) SubmitProposal(ctx sdk.Context, proposer sdk.AccAddress, content gov.Content) error {
if ! k.IsGovernor(ctx, proposer) {
return sdkerrors.Wrap(types.ErrNotGovernor, proposer.String())
}
if ! k.router.HasRoute(content.ProposalRoute()) {
return sdkerrors.Wrap(types.ErrNoProposalHandlerExists, content.ProposalRoute())
}
cacheCtx, _ := ctx.CacheContext()
handler := k.router.GetRoute(content.ProposalRoute())
if err := handler(cacheCtx, content); err != nil {
return sdkerrors.Wrap(types.ErrInvalidProposalContent, err.Error())
}
proposalID, err := k.GetProposalID(ctx)
if err != nil {
return err
}
votingPeriod := k.GetVotingParams(ctx).VotingPeriod
proposal := types.NewProposal(content, proposalID)
proposal.Status = types.StatusVotingPeriod
proposal.VotingStartTime = ctx.BlockHeader().Time
proposal.VotingEndTime = proposal.VotingStartTime.Add(votingPeriod)
k.SetProposal(ctx, proposal)
k.InsertActiveProposalQueue(ctx, proposal.ProposalID, proposal.VotingEndTime)
k.SetProposalID(ctx, proposalID + 1)
ctx.EventManager().EmitEvents(sdk.Events{
sdk.NewEvent(
types.EventTypeSubmitProposal,
sdk.NewAttribute(types.AttributeKeyProposalId, strconv.Itoa(int(proposalID))),
sdk.NewAttribute(types.AttributeKeyContent, content.String()),
sdk.NewAttribute(types.AttributeKeyStatus, proposal.Status.String()),
sdk.NewAttribute(types.AttributeKeyVotingStartTime, proposal.VotingStartTime.String()),
sdk.NewAttribute(types.AttributeKeyVotingEndTime, proposal.VotingEndTime.String()),
),
sdk.NewEvent(
sdk.EventTypeMessage,
sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueModule),
sdk.NewAttribute(types.AttributeKeySender, proposer.String()),
),
})
return nil
}
func (k Keeper) ExecuteProposal(ctx sdk.Context, proposal types.Proposal) (status types.ProposalStatus) {
handler := k.Router().GetRoute(proposal.ProposalRoute())
cacheCtx, writeCache := ctx.CacheContext()
err := handler(cacheCtx, proposal.Content)
if err == nil {
status = types.StatusPassed
ctx.EventManager().EmitEvents(cacheCtx.EventManager().Events())
writeCache()
} else {
status = types.StatusFailed
}
return
}
func (k Keeper) HandleProposal(ctx sdk.Context, proposal types.Proposal, expedited bool) {
passes, _ := k.Tally(ctx, proposal)
if passes {
proposal.Status = k.ExecuteProposal(ctx, proposal)
} else {
proposal.Status = types.StatusRejected
}
proposal.ExecutionTime = ctx.BlockTime()
k.SetProposal(ctx, proposal)
if expedited {
k.RemoveFromExpeditedProposalQueue(ctx, proposal.ProposalID)
} else {
k.RemoveFromActiveProposalQueue(ctx, proposal.ProposalID, proposal.VotingEndTime)
}
// TODO: events
}
func (k Keeper) CanBeExpedited(ctx sdk.Context, proposal types.Proposal) bool {
governorCount := k.GetGovernorCount(ctx)
totalVotes := proposal.TallyResult.Yes.Add(proposal.TallyResult.No)
tallyParams := k.GetTallyParams(ctx)
if totalVotes.ToDec().Quo(governorCount.ToDec()).GTE(tallyParams.Quorum) {
// quorum condition fulfilled
if proposal.TallyResult.Yes.ToDec().Quo(governorCount.ToDec()).GTE(tallyParams.Threshold) {
/*
Proportion of Yes votes relative to the total amount of possible voters surpassed the threshold
meaning that the vote can not be overturned.
Calculation based on the following inequality:
x - number of No votes
y - number of Yes votes
n - total voters (governors)
t - vote threshold
not_voted = n - (x + y)
(y + not_voted) / (x + n) >= t
which equals to
y / n >= t
https://desmos.com/calculator/kfhbqao95m
*/
return true
}
}
return false
}
func (k Keeper) HandleExpedite(ctx sdk.Context, proposalId uint64) error {
proposal, err := k.GetProposal(ctx, proposalId)
if err != nil {
return sdkerrors.Wrapf(types.ErrUnknownProposal, "%d", proposalId)
}
if proposal.Status != types.StatusVotingPeriod {
return sdkerrors.Wrapf(types.ErrInactiveProposal, "%d", proposalId)
}
if k.CanBeExpedited(ctx, proposal) {
proposal.Status = types.StatusExpediting
proposal.Expedited = true
k.RemoveFromActiveProposalQueue(ctx, proposal.ProposalID, proposal.VotingEndTime)
k.InsertExpeditedProposalQueue(ctx, proposal.ProposalID)
}
k.SetProposal(ctx, proposal)
return nil
}
func (k Keeper) GetProposal(ctx sdk.Context, proposalID uint64) (types.Proposal, error) {
store := ctx.KVStore(k.storeKey)
bz := store.Get(types.ProposalKey(proposalID))
if bz == nil {
return types.Proposal{}, types.ErrUnknownProposal
}
var proposal types.Proposal
k.cdc.MustUnmarshalBinaryBare(bz, &proposal)
return proposal, nil
}
func (k Keeper) SetProposal(ctx sdk.Context, proposal types.Proposal) {
store := ctx.KVStore(k.storeKey)
bz := k.cdc.MustMarshalBinaryBare(proposal)
store.Set(types.ProposalKey(proposal.ProposalID), bz)
}
func (k Keeper) DeleteProposal(ctx sdk.Context, proposalID uint64) {
store := ctx.KVStore(k.storeKey)
proposal, err := k.GetProposal(ctx, proposalID)
if err != nil {
panic(fmt.Sprintf("couldn't find proposal with id#%d", proposalID))
}
k.RemoveFromActiveProposalQueue(ctx, proposalID, proposal.VotingEndTime)
store.Delete(types.ProposalKey(proposalID))
}
func (k Keeper) IterateProposals(ctx sdk.Context, cb func(proposal types.Proposal) (stop bool)) {
store := ctx.KVStore(k.storeKey)
iterator := sdk.KVStorePrefixIterator(store, types.ProposalsKeyPrefix)
defer iterator.Close()
for ; iterator.Valid(); iterator.Next() {
var proposal types.Proposal
k.cdc.MustUnmarshalBinaryBare(iterator.Value(), &proposal)
if cb(proposal) {
break
}
}
}
func (k Keeper) GetProposals(ctx sdk.Context) (proposals types.Proposals) {
k.IterateProposals(ctx, func(proposal types.Proposal) bool {
proposals = append(proposals, proposal)
return false
})
return
}
func (k Keeper) GetProposalID(ctx sdk.Context) (proposalID uint64, err error) {
store := ctx.KVStore(k.storeKey)
bz := store.Get(types.ProposalIDKey)
if bz == nil {
return 0, sdkerrors.Wrap(types.ErrInvalidGenesis, "initial proposal ID hasn't been set")
}
proposalID = types.GetProposalIDFromBytes(bz)
return proposalID, nil
}
func (k Keeper) SetProposalID(ctx sdk.Context, proposalID uint64) {
store := ctx.KVStore(k.storeKey)
store.Set(types.ProposalIDKey, types.GetProposalIDBytes(proposalID))
}