-
Notifications
You must be signed in to change notification settings - Fork 105
/
types.go
342 lines (282 loc) · 8.88 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
package types
import (
"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"
"github.com/axelarnetwork/axelar-core/x/vote/exported"
"github.com/axelarnetwork/utils/slices"
)
//go:generate moq -out ./mock/types.go -pkg mock . Store VoteRouter
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)
}
// 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) exported.PollMetadata {
return exported.PollMetadata{
Key: key,
ExpiresAt: 0,
Result: nil,
VotingThreshold: threshold,
State: exported.Pending,
MinVoterCount: 0,
Voters: voters,
TotalVotingPower: slices.Reduce(voters, sdk.ZeroInt(), func(total sdk.Int, voter exported.Voter) sdk.Int {
return total.AddRaw(voter.VotingPower)
}),
GracePeriod: 0,
CompletedAt: 0,
}
}
var _ exported.Poll = &Poll{}
// Poll represents a poll with write-in voting
type Poll struct {
exported.PollMetadata
Store
logger log.Logger
}
// Store enables a poll to communicate with the keeper
type Store interface {
SetVote(voter sdk.ValAddress, data codec.ProtoMarshaler, votingPower int64, isLate bool)
GetVote(hash string) (TalliedVote, bool)
HasVoted(voter sdk.ValAddress) bool
HasVotedLate(voter sdk.ValAddress) bool
GetVotes() []TalliedVote
SetMetadata(metadata exported.PollMetadata)
EnqueuePoll(metadata exported.PollMetadata)
GetPoll(key exported.PollKey) exported.Poll
DeletePoll()
}
// NewPoll creates a new poll
func NewPoll(meta exported.PollMetadata, store Store) *Poll {
return &Poll{
PollMetadata: meta,
Store: store,
logger: utils.NewNOPLogger(),
}
}
// 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)
}
// SetExpired sets the poll to be expired
func (p Poll) SetExpired() {
if !p.Is(exported.NonExistent) {
p.State |= exported.Expired
}
p.SetMetadata(p.PollMetadata)
}
// 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(blockHeight int64) error {
if err := p.Validate(); err != nil {
return err
}
if p.ExpiresAt <= blockHeight {
return fmt.Errorf(
"cannot create poll %s that expires at block %d which is less than or equal to the current block height",
p.Key,
p.ExpiresAt,
)
}
if !p.Is(exported.Pending) {
return fmt.Errorf("cannot create poll %s that is not pending", p.Key)
}
if p.CompletedAt != 0 {
return fmt.Errorf("cannot create poll %s that is already completed", p.Key)
}
other := p.Store.GetPoll(p.Key)
if err := other.Delete(); err != nil {
return err
}
p.EnqueuePoll(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) isWithinGracePeriod(blockHeight int64) bool {
return !p.Is(exported.Expired) &&
p.Is(exported.Completed) &&
blockHeight <= p.CompletedAt+int64(p.GracePeriod)
}
// Vote records the given vote
func (p *Poll) Vote(voter sdk.ValAddress, blockHeight int64, data codec.ProtoMarshaler) (codec.ProtoMarshaler, bool, error) {
if p.Is(exported.NonExistent) {
return nil, false, fmt.Errorf("poll does not exist")
}
if p.HasVoted(voter) {
return nil, false, fmt.Errorf("voter %s has voted already", voter)
}
switch {
case p.Is(exported.Failed):
return nil, false, nil
case p.Is(exported.Expired):
return nil, false, fmt.Errorf("poll %s has expired already", p.GetKey().String())
case p.Is(exported.Completed) && p.isWithinGracePeriod(blockHeight):
votingPower := p.getVotingPower(voter)
if votingPower == 0 {
return nil, false, fmt.Errorf("address %s is not eligible to Vote in this poll", voter)
}
p.SetVote(voter, data, votingPower, true)
p.logger.Debug("received late vote for poll",
"voter", voter.String(),
"poll", p.GetKey().String(),
)
return nil, true, nil
case p.Is(exported.Completed):
return nil, false, nil
}
votingPower := p.getVotingPower(voter)
if votingPower == 0 {
return nil, false, fmt.Errorf("address %s is not eligible to Vote in this poll", voter)
}
p.SetVote(voter, data, votingPower, false)
p.logger.Debug("received vote for poll",
"voter", voter.String(),
"poll", p.GetKey().String(),
)
majorityVote := p.getMajorityVote()
switch {
case p.hasEnoughVotes(majorityVote.Tally):
p.Result = majorityVote.Data
p.State = exported.Completed
p.CompletedAt = blockHeight
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,
))
p.SetMetadata(p.PollMetadata)
return p.GetResult(), true, nil
case p.cannotWin(majorityVote.Tally):
p.State = exported.Failed
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)
fallthrough
default:
return nil, true, 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
}
// HasVotedCorrectly returns true if the give voter has voted correctly for the poll, false otherwise
func (p Poll) HasVotedCorrectly(voter sdk.ValAddress) bool {
majorityVote := p.getMajorityVote()
return p.Is(exported.Completed) &&
p.HasVoted(voter) &&
slices.Any(majorityVote.Voters, func(v sdk.ValAddress) bool {
return voter.Equals(v)
})
}
// GetTotalVotingPower returns the total voting power of the poll
func (p Poll) GetTotalVotingPower() sdk.Int {
return p.TotalVotingPower
}
// GetRewardPoolName returns the name of the attached reward pool, if any
func (p Poll) GetRewardPoolName() (string, bool) {
return p.RewardPoolName, len(p.RewardPoolName) > 0
}
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) &&
p.getVoterCount() >= p.MinVoterCount
}
func (p *Poll) cannotWin(majority sdk.Int) bool {
alreadyTallied := p.getTalliedVotingPower()
missingVotingPower := p.GetTotalVotingPower().Sub(alreadyTallied)
return !p.hasEnoughVotes(majority.Add(missingVotingPower))
}
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
}