-
Notifications
You must be signed in to change notification settings - Fork 113
/
types.go
349 lines (287 loc) · 9.13 KB
/
types.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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
package types
import (
"bytes"
"crypto/sha256"
"fmt"
"github.com/cosmos/cosmos-sdk/codec"
codectypes "github.com/cosmos/cosmos-sdk/codec/types"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/tendermint/tendermint/libs/log"
"github.com/axelarnetwork/axelar-core/utils"
reward "github.com/axelarnetwork/axelar-core/x/reward/exported"
"github.com/axelarnetwork/axelar-core/x/vote/exported"
)
//go:generate moq -out ./mock/types.go -pkg mock . Store
var _ codectypes.UnpackInterfacesMessage = TalliedVote{}
// Voters is a type alias necessary to unmarshal TalliedVote
type Voters []sdk.ValAddress
// NewTalliedVote is the constructor for TalliedVote
func NewTalliedVote(voter sdk.ValAddress, votingPower int64, data codec.ProtoMarshaler) TalliedVote {
if voter == nil {
panic("voter cannot be nil")
}
d, err := codectypes.NewAnyWithValue(data)
if err != nil {
panic(err)
}
return TalliedVote{
Tally: sdk.NewInt(votingPower),
Data: d,
Voters: Voters{voter},
}
}
// UnpackInterfaces implements UnpackInterfacesMessage
func (m TalliedVote) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error {
var data codec.ProtoMarshaler
return unpacker.UnpackAny(m.Data, &data)
}
// Hash returns the hash of the value of the vote
func (m TalliedVote) Hash() string {
return hash(m.Data.GetCachedValue().(codec.ProtoMarshaler))
}
// NewPollMetaData is the constructor for PollMetadata.
// It is not in the exported package to make it clear that only the vote module is supposed to use it.
func NewPollMetaData(key exported.PollKey, threshold utils.Threshold, voters []exported.Voter, totalVotingPower sdk.Int) exported.PollMetadata {
return exported.PollMetadata{
Key: key,
ExpiresAt: -1,
Result: nil,
VotingThreshold: threshold,
State: exported.Pending,
MinVoterCount: 0,
Voters: voters,
TotalVotingPower: totalVotingPower,
}
}
var _ exported.Poll = &Poll{}
// Poll represents a poll with write-in voting
type Poll struct {
exported.PollMetadata
Store
logger log.Logger
rewardPool reward.RewardPool
}
// Store enables a poll to communicate with the keeper
type Store interface {
SetVote(voter sdk.ValAddress, vote TalliedVote)
GetVote(hash string) (TalliedVote, bool)
HasVoted(voter sdk.ValAddress) bool
GetVotes() []TalliedVote
SetMetadata(metadata exported.PollMetadata)
GetPoll(key exported.PollKey) exported.Poll
DeletePoll()
}
// NewPoll creates a new poll
func NewPoll(ctx sdk.Context, meta exported.PollMetadata, store Store, rewarder Rewarder) *Poll {
poll := &Poll{
PollMetadata: meta,
Store: store,
logger: utils.NewNOPLogger(),
}
if meta.RewardPoolName != "" {
poll.rewardPool = rewarder.GetPool(ctx, meta.RewardPoolName)
}
poll.updateExpiry(ctx.BlockHeight())
return poll
}
// WithLogger sets a logger for the poll
func (p *Poll) WithLogger(logger log.Logger) *Poll {
p.logger = logger
return p
}
// Is checks if the poll is in the given state
func (p Poll) Is(state exported.PollState) bool {
return p.PollMetadata.Is(state)
}
// AllowOverride makes it possible to delete the poll, regardless of which state it is in
func (p Poll) AllowOverride() {
if !p.Is(exported.NonExistent) {
p.State |= exported.AllowOverride
}
p.SetMetadata(p.PollMetadata)
}
// GetResult returns the result of the poll. Returns nil if the poll is not completed.
func (p Poll) GetResult() codec.ProtoMarshaler {
if p.Result == nil {
return nil
}
return p.Result.GetCachedValue().(codec.ProtoMarshaler)
}
// Initialize initializes the poll
func (p Poll) Initialize() error {
sumVotingPower := sdk.ZeroInt()
for _, voter := range p.Voters {
sumVotingPower = sumVotingPower.AddRaw(voter.VotingPower)
}
if utils.NewThreshold(sumVotingPower.Int64(), p.TotalVotingPower.Int64()).LT(p.VotingThreshold) {
return fmt.Errorf("cannot create poll %s due to it being impossible to pass", p.Key.String())
}
other := p.Store.GetPoll(p.Key)
if err := other.Delete(); err != nil {
return err
}
p.SetMetadata(p.PollMetadata)
return nil
}
func (p *Poll) getVotingPower(v sdk.ValAddress) int64 {
for _, voter := range p.PollMetadata.Voters {
if v.Equals(voter.Validator) {
return voter.VotingPower
}
}
return 0
}
func (p *Poll) handleRewards() error {
majorityVote := p.getMajorityVote()
for _, vote := range p.GetVotes() {
if bytes.Equal(vote.Data.Value, majorityVote.Data.Value) {
for _, voter := range vote.Voters {
if err := p.rewardPool.ReleaseRewards(voter); err != nil {
return err
}
}
} else {
for _, voter := range vote.Voters {
p.logger.Debug("penalizing voter due to incorrect vote",
"voter", voter.String(),
"poll", p.PollMetadata.Key.String(),
"expected", majorityVote.Data.String(),
"actual", vote.Data.String())
p.rewardPool.ClearRewards(voter)
}
}
}
return nil
}
// Vote records the given vote
func (p *Poll) Vote(voter sdk.ValAddress, data codec.ProtoMarshaler) error {
if p.Is(exported.NonExistent) {
return fmt.Errorf("poll does not exist")
}
// if the poll is already decided there is no need to keep track of further votes
if p.Is(exported.Completed) || p.Is(exported.Failed) {
return nil
}
votingPower := p.getVotingPower(voter)
if votingPower == 0 {
return fmt.Errorf("address %s is not eligible to Vote in this poll", voter)
}
if p.HasVoted(voter) {
return fmt.Errorf("voter %s has already voted", voter.String())
}
p.SetVote(voter, p.tally(voter, votingPower, data))
majorityVote := p.getMajorityVote()
if p.hasEnoughVotes(majorityVote.Tally) {
if p.rewardPool != nil {
p.handleRewards()
}
p.Result = majorityVote.Data
p.State = exported.Completed
p.logger.Debug(fmt.Sprintf("poll %s (threshold: %d/%d, min voter count: %d) completed",
p.Key,
p.VotingThreshold.Numerator,
p.VotingThreshold.Denominator,
p.MinVoterCount,
))
} else if p.cannotWin(majorityVote.Tally) {
p.State = exported.Failed | exported.AllowOverride
p.logger.Debug(fmt.Sprintf("poll %s (threshold: %d/%d, min voter count: %d) failed, voters could not agree on single value",
p.Key,
p.VotingThreshold.Numerator,
p.VotingThreshold.Denominator,
p.MinVoterCount,
))
}
p.SetMetadata(p.PollMetadata)
return nil
}
// Delete deletes the poll. Returns error if the poll is in a state that does not allow deletion
func (p Poll) Delete() error {
switch {
case p.Is(exported.NonExistent):
return nil
case p.Is(exported.AllowOverride):
p.logger.Debug(fmt.Sprintf("deleting poll %s in state %s", p.Key.String(), p.State))
p.Store.DeletePoll()
return nil
default:
return fmt.Errorf("cannot delete existing poll %s with state %s, must be allowed to be overridden", p.Key, p.State)
}
}
// GetKey returns the poll's key
func (p *Poll) GetKey() exported.PollKey {
return p.Key
}
// GetVoters returns the poll's voters
func (p *Poll) GetVoters() []exported.Voter {
return p.Voters
}
// GetTotalVotingPower returns the total voting power of the poll
func (p *Poll) GetTotalVotingPower() sdk.Int {
return p.TotalVotingPower
}
func (p *Poll) updateExpiry(currentBlockHeight int64) {
if p.ExpiresAt != -1 && p.ExpiresAt <= currentBlockHeight && p.Is(exported.Pending) {
p.State |= exported.Expired | exported.AllowOverride
if p.rewardPool != nil {
// Penalize voters who failed to vote
for _, voter := range p.Voters {
if !p.HasVoted(voter.Validator) {
p.logger.Debug("penalizing voter due to timeout", "voter", voter.Validator.String(), "poll", p.PollMetadata.Key.String())
p.rewardPool.ClearRewards(voter.Validator)
}
}
}
}
}
func (p *Poll) tally(voter sdk.ValAddress, votingPower int64, data codec.ProtoMarshaler) TalliedVote {
var talliedVote TalliedVote
if existingVote, ok := p.GetVote(hash(data)); !ok {
talliedVote = NewTalliedVote(voter, votingPower, data)
} else {
talliedVote = existingVote
talliedVote.Tally = talliedVote.Tally.AddRaw(votingPower)
talliedVote.Voters = append(talliedVote.Voters, voter)
}
return talliedVote
}
func (p Poll) getVoterCount() int64 {
var count int64
for _, talliedVote := range p.GetVotes() {
count += int64(len(talliedVote.Voters))
}
return count
}
func (p *Poll) hasEnoughVotes(majority sdk.Int) bool {
return utils.NewThreshold(majority.Int64(), p.GetTotalVotingPower().Int64()).GTE(p.VotingThreshold) &&
(int64(len(p.Voters)) < p.MinVoterCount || p.getVoterCount() >= p.MinVoterCount)
}
func (p *Poll) cannotWin(majority sdk.Int) bool {
alreadyTallied := p.getTalliedVotingPower()
missingVotingPower := p.GetTotalVotingPower().Sub(alreadyTallied)
return utils.NewThreshold(majority.Add(missingVotingPower).Int64(), p.GetTotalVotingPower().Int64()).LT(p.VotingThreshold)
}
func (p Poll) getMajorityVote() TalliedVote {
var result TalliedVote
for i, talliedVote := range p.GetVotes() {
if i == 0 || talliedVote.Tally.GT(result.Tally) {
result = talliedVote
}
}
return result
}
func (p Poll) getTalliedVotingPower() sdk.Int {
result := sdk.ZeroInt()
for _, talliedVote := range p.GetVotes() {
result = result.Add(talliedVote.Tally)
}
return result
}
func hash(data codec.ProtoMarshaler) string {
bz, err := data.Marshal()
if err != nil {
panic(err)
}
h := sha256.Sum256(bz)
return string(h[:])
}