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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
use cosmwasm_std::{Decimal, Uint128};
use dao_voting::status::Status;
use dao_voting::threshold::{PercentageThreshold, Threshold};
use dao_voting::voting::Vote;
use rand::{prelude::SliceRandom, Rng};

/// If a test vote should execute. Used for fuzzing and checking that
/// votes after a proposal has completed aren't allowed.
pub enum ShouldExecute {
    /// This should execute.
    Yes,
    /// This should not execute.
    No,
    /// Doesn't matter.
    Meh,
}

pub struct TestSingleChoiceVote {
    /// The address casting the vote.
    pub voter: String,
    /// Position on the vote.
    pub position: Vote,
    /// Voting power of the address.
    pub weight: Uint128,
    /// If this vote is expected to execute.
    pub should_execute: ShouldExecute,
}

pub fn test_simple_votes<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::Yes,
            weight: Uint128::new(10),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(100)),
        },
        Status::Passed,
        None,
    );

    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::No,
            weight: Uint128::new(10),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(100)),
        },
        Status::Rejected,
        None,
    )
}

pub fn test_simple_vote_no_overflow<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::Yes,
            weight: Uint128::new(u128::max_value()),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(100)),
        },
        Status::Passed,
        None,
    );
}

pub fn test_vote_no_overflow<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::Yes,
            weight: Uint128::new(u128::max_value()),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(100)),
        },
        Status::Passed,
        None,
    );

    do_votes(
        vec![
            TestSingleChoiceVote {
                voter: "zeke".to_string(),
                position: Vote::No,
                weight: Uint128::new(1),
                should_execute: ShouldExecute::Yes,
            },
            TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::Yes,
                weight: Uint128::new(u128::max_value() - 1),
                should_execute: ShouldExecute::Yes,
            },
        ],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(99)),
        },
        Status::Passed,
        None,
    )
}

pub fn test_simple_early_rejection<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    do_votes(
        vec![TestSingleChoiceVote {
            voter: "zeke".to_string(),
            position: Vote::No,
            weight: Uint128::new(1),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(100)),
        },
        Status::Rejected,
        None,
    );

    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::No,
            weight: Uint128::new(1),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(99)),
        },
        Status::Open,
        Some(Uint128::from(u128::max_value())),
    );
}

pub fn test_vote_abstain_only<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::Abstain,
            weight: Uint128::new(u64::max_value().into()),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(100)),
        },
        Status::Rejected,
        None,
    );

    // The quorum shouldn't matter here in determining if the vote is
    // rejected.
    for i in 0..101 {
        do_votes(
            vec![TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::Abstain,
                weight: Uint128::new(u64::max_value().into()),
                should_execute: ShouldExecute::Yes,
            }],
            Threshold::ThresholdQuorum {
                threshold: PercentageThreshold::Percent(Decimal::percent(100)),
                quorum: PercentageThreshold::Percent(Decimal::percent(i)),
            },
            Status::Rejected,
            None,
        );
    }
}

pub fn test_tricky_rounding<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    // This tests the smallest possible round up for passing
    // thresholds we can have. Specifically, a 1% passing threshold
    // and 1 total vote. This should round up and only pass if there
    // are more than 1 yes votes.
    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::Yes,
            weight: Uint128::new(1),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(1)),
        },
        Status::Passed,
        Some(Uint128::new(100)),
    );

    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::Yes,
            weight: Uint128::new(10),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(1)),
        },
        Status::Passed,
        Some(Uint128::new(1000)),
    );

    // HIGH PERCISION
    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::Yes,
            weight: Uint128::new(9999999),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(1)),
        },
        Status::Open,
        Some(Uint128::new(1000000000)),
    );

    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::Abstain,
            weight: Uint128::new(1),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(1)),
        },
        Status::Rejected,
        None,
    );
}

pub fn test_no_double_votes<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    do_votes(
        vec![
            TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::Abstain,
                weight: Uint128::new(2),
                should_execute: ShouldExecute::Yes,
            },
            TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::Yes,
                weight: Uint128::new(2),
                should_execute: ShouldExecute::No,
            },
        ],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(100)),
        },
        // NOTE: Updating our cw20-base version will cause this to
        // fail. In versions of cw20-base before Feb 15 2022 (the one
        // we use at the time of writing) it was allowed to have an
        // initial balance that repeats for a given address but it
        // would cause miscalculation of the total supply. In this
        // case the total supply is miscumputed to be 4 so this is
        // assumed to have 2 abstain votes out of 4 possible votes.
        Status::Open,
        Some(Uint128::new(10)),
    )
}

pub fn test_votes_favor_yes<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    do_votes(
        vec![
            TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::Abstain,
                weight: Uint128::new(10),
                should_execute: ShouldExecute::Yes,
            },
            TestSingleChoiceVote {
                voter: "keze".to_string(),
                position: Vote::No,
                weight: Uint128::new(5),
                should_execute: ShouldExecute::Yes,
            },
            TestSingleChoiceVote {
                voter: "ezek".to_string(),
                position: Vote::Yes,
                weight: Uint128::new(5),
                should_execute: ShouldExecute::Yes,
            },
        ],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(50)),
        },
        Status::Passed,
        None,
    );

    do_votes(
        vec![
            TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::Abstain,
                weight: Uint128::new(10),
                should_execute: ShouldExecute::Yes,
            },
            TestSingleChoiceVote {
                voter: "keze".to_string(),
                position: Vote::Yes,
                weight: Uint128::new(5),
                should_execute: ShouldExecute::Yes,
            },
        ],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(50)),
        },
        Status::Passed,
        None,
    );

    do_votes(
        vec![
            TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::Abstain,
                weight: Uint128::new(10),
                should_execute: ShouldExecute::Yes,
            },
            TestSingleChoiceVote {
                voter: "keze".to_string(),
                position: Vote::Yes,
                weight: Uint128::new(5),
                should_execute: ShouldExecute::Yes,
            },
            // Can vote up to expiration time.
            TestSingleChoiceVote {
                voter: "ezek".to_string(),
                position: Vote::No,
                weight: Uint128::new(5),
                should_execute: ShouldExecute::Yes,
            },
        ],
        Threshold::AbsolutePercentage {
            percentage: PercentageThreshold::Percent(Decimal::percent(50)),
        },
        Status::Passed,
        None,
    );
}

pub fn test_votes_low_threshold<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    do_votes(
        vec![
            TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::No,
                weight: Uint128::new(10),
                should_execute: ShouldExecute::Yes,
            },
            TestSingleChoiceVote {
                voter: "keze".to_string(),
                position: Vote::Yes,
                weight: Uint128::new(5),
                should_execute: ShouldExecute::Yes,
            },
        ],
        Threshold::ThresholdQuorum {
            threshold: PercentageThreshold::Percent(Decimal::percent(10)),
            quorum: PercentageThreshold::Majority {},
        },
        Status::Passed,
        None,
    );

    do_votes(
        vec![
            TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::No,
                weight: Uint128::new(10),
                should_execute: ShouldExecute::Yes,
            },
            TestSingleChoiceVote {
                voter: "keze".to_string(),
                position: Vote::Yes,
                weight: Uint128::new(5),
                should_execute: ShouldExecute::Yes,
            },
            // Can vote up to expiration time.
            TestSingleChoiceVote {
                voter: "ezek".to_string(),
                position: Vote::No,
                weight: Uint128::new(10),
                should_execute: ShouldExecute::Yes,
            },
        ],
        Threshold::ThresholdQuorum {
            threshold: PercentageThreshold::Percent(Decimal::percent(10)),
            quorum: PercentageThreshold::Majority {},
        },
        Status::Passed,
        None,
    );
}

pub fn test_majority_vs_half<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    do_votes(
        vec![
            TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::No,
                weight: Uint128::new(10),
                should_execute: ShouldExecute::Yes,
            },
            TestSingleChoiceVote {
                voter: "keze".to_string(),
                position: Vote::Yes,
                weight: Uint128::new(10),
                should_execute: ShouldExecute::Yes,
            },
        ],
        Threshold::ThresholdQuorum {
            threshold: PercentageThreshold::Percent(Decimal::percent(50)),
            quorum: PercentageThreshold::Majority {},
        },
        Status::Passed,
        None,
    );

    do_votes(
        vec![
            TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::No,
                weight: Uint128::new(10),
                should_execute: ShouldExecute::Yes,
            },
            // Can vote up to expiration time, even if it already rejected.
            TestSingleChoiceVote {
                voter: "keze".to_string(),
                position: Vote::Yes,
                weight: Uint128::new(10),
                should_execute: ShouldExecute::Yes,
            },
        ],
        Threshold::ThresholdQuorum {
            threshold: PercentageThreshold::Majority {},
            quorum: PercentageThreshold::Majority {},
        },
        Status::Rejected,
        None,
    );
}

pub fn test_pass_threshold_not_quorum<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::Yes,
            weight: Uint128::new(59),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::ThresholdQuorum {
            threshold: PercentageThreshold::Majority {},
            quorum: PercentageThreshold::Percent(Decimal::percent(60)),
        },
        Status::Open,
        Some(Uint128::new(100)),
    );
    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::No,
            weight: Uint128::new(59),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::ThresholdQuorum {
            threshold: PercentageThreshold::Majority {},
            quorum: PercentageThreshold::Percent(Decimal::percent(60)),
        },
        // As the threshold is 50% and 59% of voters have voted no
        // this is unable to pass.
        Status::Rejected,
        Some(Uint128::new(100)),
    );
}

pub fn test_pass_exactly_quorum<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::Yes,
            weight: Uint128::new(60),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::ThresholdQuorum {
            threshold: PercentageThreshold::Majority {},
            quorum: PercentageThreshold::Percent(Decimal::percent(60)),
        },
        Status::Passed,
        Some(Uint128::new(100)),
    );
    do_votes(
        vec![
            TestSingleChoiceVote {
                voter: "ekez".to_string(),
                position: Vote::Yes,
                weight: Uint128::new(59),
                should_execute: ShouldExecute::Yes,
            },
            // This is an intersting one because in this case the no
            // voter is actually incentivised not to vote. By voting
            // they move the quorum over the threshold and pass the
            // vote. In a DAO with sufficently involved stakeholders
            // no voters should effectively never vote if there is a
            // quorum higher than the threshold as it makes the
            // passing threshold the quorum threshold.
            TestSingleChoiceVote {
                voter: "keze".to_string(),
                position: Vote::No,
                weight: Uint128::new(1),
                should_execute: ShouldExecute::Yes,
            },
        ],
        Threshold::ThresholdQuorum {
            threshold: PercentageThreshold::Majority {},
            quorum: PercentageThreshold::Percent(Decimal::percent(60)),
        },
        Status::Passed,
        Some(Uint128::new(100)),
    );
    do_votes(
        vec![TestSingleChoiceVote {
            voter: "ekez".to_string(),
            position: Vote::No,
            weight: Uint128::new(60),
            should_execute: ShouldExecute::Yes,
        }],
        Threshold::ThresholdQuorum {
            threshold: PercentageThreshold::Majority {},
            quorum: PercentageThreshold::Percent(Decimal::percent(60)),
        },
        Status::Rejected,
        Some(Uint128::new(100)),
    );
}

pub fn fuzz_voting<F>(do_votes: F)
where
    F: Fn(Vec<TestSingleChoiceVote>, Threshold, Status, Option<Uint128>),
{
    let mut rng = rand::thread_rng();
    let dist = rand::distributions::Uniform::<u64>::new(1, 200);
    for _ in 0..10 {
        let yes: Vec<u64> = (0..50).map(|_| rng.sample(dist)).collect();
        let no: Vec<u64> = (0..50).map(|_| rng.sample(dist)).collect();

        let yes_sum: u64 = yes.iter().sum();
        let no_sum: u64 = no.iter().sum();
        let expected_status = match yes_sum.cmp(&no_sum) {
            std::cmp::Ordering::Less => Status::Rejected,
            // Depends on which reaches the threshold first. Ignore for now.
            std::cmp::Ordering::Equal => Status::Rejected,
            std::cmp::Ordering::Greater => Status::Passed,
        };

        let yes = yes
            .into_iter()
            .enumerate()
            .map(|(idx, weight)| TestSingleChoiceVote {
                voter: format!("yes_{idx}"),
                position: Vote::Yes,
                weight: Uint128::new(weight as u128),
                should_execute: ShouldExecute::Meh,
            });
        let no = no
            .into_iter()
            .enumerate()
            .map(|(idx, weight)| TestSingleChoiceVote {
                voter: format!("no_{idx}"),
                position: Vote::No,
                weight: Uint128::new(weight as u128),
                should_execute: ShouldExecute::Meh,
            });
        let mut votes = yes.chain(no).collect::<Vec<_>>();
        votes.shuffle(&mut rng);

        do_votes(
            votes,
            Threshold::AbsolutePercentage {
                percentage: PercentageThreshold::Majority {},
            },
            expected_status,
            None,
        );
    }
}