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
mod funding;
mod lottery;

use crate::{community_advisors::models::AdvisorReviewRow, types::advisor_review::ReviewRanking};
use lottery::{CasWinnings, TicketsDistribution};
use rand::{Rng, SeedableRng};
use rand_chacha::{ChaCha8Rng, ChaChaRng};

use std::collections::{BTreeMap, BTreeSet};

pub use crate::rewards::{community_advisors::funding::ProposalRewardSlots, Funds, Rewards};
pub use funding::FundSetting;

pub type Seed = <ChaChaRng as SeedableRng>::Seed;
pub type CommunityAdvisor = String;
pub type ProposalId = String;

pub type ProposalsReviews = BTreeMap<ProposalId, Vec<AdvisorReviewRow>>;
pub type ApprovedProposals = BTreeMap<ProposalId, Funds>;

const LEGACY_MAX_WINNING_TICKETS: u64 = 3;

#[derive(Debug)]
struct ProposalRewards {
    per_ticket_reward: Rewards,
    tickets: ProposalTickets,
}

#[derive(Debug)]
enum ProposalTickets {
    Legacy {
        eligible_assessors: BTreeSet<CommunityAdvisor>,
        winning_tkts: u64,
    },
    Fund7 {
        excellent_tkts: TicketsDistribution,
        good_tkts: TicketsDistribution,
        excellent_winning_tkts: u64,
        good_winning_tkts: u64,
    },
}

fn get_tickets_per_proposal(
    proposal_reviews: ProposalsReviews,
    rewards_slots: &ProposalRewardSlots,
) -> (u64, BTreeMap<ProposalId, ProposalTickets>) {
    let (winning_tickets, proposals_tickets): (Vec<_>, _) = proposal_reviews
        .into_iter()
        .map(|(id, reviews)| {
            let filtered = reviews
                .into_iter()
                .filter(|review| !matches!(review.score(), ReviewRanking::FilteredOut))
                .collect::<Vec<_>>();
            let tickets = load_tickets_from_reviews(&filtered, rewards_slots);
            let winning_tickets = match tickets {
                ProposalTickets::Legacy { winning_tkts, .. } => {
                    // it would be a bit harder to track it otherwise, and we don't need this additional
                    // complexity now
                    assert_eq!(
                        0,
                        rewards_slots.max_winning_tickets() % LEGACY_MAX_WINNING_TICKETS
                    );
                    winning_tkts
                        * (rewards_slots.max_winning_tickets() / LEGACY_MAX_WINNING_TICKETS)
                }
                ProposalTickets::Fund7 {
                    excellent_winning_tkts,
                    good_winning_tkts,
                    ..
                } => excellent_winning_tkts + good_winning_tkts,
            };

            (winning_tickets, (id, tickets))
        })
        .unzip();

    (winning_tickets.into_iter().sum(), proposals_tickets)
}

fn calculate_rewards_per_proposal(
    proposals_tickets: BTreeMap<ProposalId, ProposalTickets>,
    bonus_rewards: &BTreeMap<ProposalId, Rewards>,
    base_ticket_reward: Rewards,
    rewards_slots: &ProposalRewardSlots,
) -> Vec<ProposalRewards> {
    proposals_tickets
        .into_iter()
        .map(|(id, tickets)| {
            let bonus_reward = bonus_rewards.get(&id).copied().unwrap_or_default();
            let per_ticket_reward = match tickets {
                ProposalTickets::Legacy { winning_tkts, .. } => {
                    base_ticket_reward * Rewards::from(rewards_slots.max_winning_tickets())
                        / Rewards::from(LEGACY_MAX_WINNING_TICKETS)
                        + bonus_reward / Rewards::from(winning_tkts)
                }
                ProposalTickets::Fund7 {
                    excellent_winning_tkts,
                    good_winning_tkts,
                    ..
                } => {
                    base_ticket_reward
                        + bonus_reward / Rewards::from(excellent_winning_tkts + good_winning_tkts)
                }
            };
            ProposalRewards {
                tickets,
                per_ticket_reward,
            }
        })
        .collect()
}

fn load_tickets_from_reviews(
    proposal_reviews: &[AdvisorReviewRow],
    rewards_slots: &ProposalRewardSlots,
) -> ProposalTickets {
    let is_legacy = proposal_reviews
        .iter()
        .any(|rev| matches!(rev.score(), ReviewRanking::NotReviewedByVCA));

    if is_legacy {
        return ProposalTickets::Legacy {
            eligible_assessors: proposal_reviews
                .iter()
                .map(|rev| rev.assessor.clone())
                .collect(),
            winning_tkts: std::cmp::min(proposal_reviews.len() as u64, LEGACY_MAX_WINNING_TICKETS),
        };
    }

    // assuming only one review per assessor in a single proposal
    let (excellent_tkts, good_tkts): (TicketsDistribution, TicketsDistribution) =
        // a full match is used so that we don't forget to consider new review types which may be added in the future
        proposal_reviews.iter().map(|rev| match rev.score() {
            ReviewRanking::Excellent => (rev.assessor.clone(), rewards_slots.excellent_slots),
            ReviewRanking::Good => (rev.assessor.clone(), rewards_slots.good_slots),
            _ => unreachable!("we've already filtered out other review scores"),
        }).partition(|(_ca, tkts)| *tkts == rewards_slots.excellent_slots);

    let excellent_winning_tkts = std::cmp::min(
        excellent_tkts.len() as u64,
        rewards_slots.max_excellent_reviews,
    ) * rewards_slots.excellent_slots;
    let good_winning_tkts = std::cmp::min(good_tkts.len() as u64, rewards_slots.max_good_reviews)
        * rewards_slots.good_slots;

    ProposalTickets::Fund7 {
        excellent_winning_tkts,
        good_winning_tkts,
        excellent_tkts,
        good_tkts,
    }
}

// Run a two stage lottery to reward community advisors
//
// In the first round, only excellent reviews will be taken into consideration
// In the second, losing tickets from the first round will compete with good review
fn double_lottery<R: Rng>(
    stage1: TicketsDistribution,
    mut stage2: TicketsDistribution,
    distribute_first_round: u64,
    distribute_second_round: u64,
    rng: &mut R,
) -> CasWinnings {
    let (mut stage1_winners, stage1_losers) =
        lottery::lottery_distribution(stage1, distribute_first_round, rng);
    stage2.extend(stage1_losers);
    let (stage2_winners, _stage2_losers) =
        lottery::lottery_distribution(stage2, distribute_second_round, rng);
    for (ca, winnings) in stage2_winners {
        *stage1_winners.entry(ca).or_default() += winnings;
    }
    assert_eq!(
        stage1_winners.values().sum::<u64>(),
        distribute_second_round + distribute_first_round
    );
    stage1_winners
}

fn calculate_ca_rewards_for_proposal<R: Rng>(
    proposal_reward: ProposalRewards,
    rng: &mut R,
) -> BTreeMap<CommunityAdvisor, Rewards> {
    let ProposalRewards {
        tickets,
        per_ticket_reward,
    } = proposal_reward;

    let rewards = match tickets {
        ProposalTickets::Fund7 {
            excellent_winning_tkts,
            good_winning_tkts,
            excellent_tkts,
            good_tkts,
        } => double_lottery(
            excellent_tkts,
            good_tkts,
            excellent_winning_tkts,
            good_winning_tkts,
            rng,
        ),
        ProposalTickets::Legacy {
            eligible_assessors,
            winning_tkts,
        } => {
            lottery::lottery_distribution(
                eligible_assessors.into_iter().map(|ca| (ca, 1)).collect(),
                winning_tkts,
                rng,
            )
            .0
        }
    };

    rewards
        .into_iter()
        .map(|(ca, tickets_won)| (ca, Rewards::from(tickets_won) * per_ticket_reward))
        .collect()
}

pub struct CaRewards {
    pub rewards: BTreeMap<CommunityAdvisor, Rewards>,
    pub base_ticket_reward: Rewards,
    pub bonus_rewards: BTreeMap<ProposalId, Rewards>,
}

pub fn calculate_ca_rewards(
    proposal_reviews: ProposalsReviews,
    approved_proposals: ApprovedProposals,
    funding: &FundSetting,
    rewards_slots: &ProposalRewardSlots,
    seed: Seed,
) -> CaRewards {
    let bonus_funds = funding.bonus_funds();
    let total_approved_budget = approved_proposals.values().sum::<Funds>();
    let (total_tickets, proposals_tickets) =
        get_tickets_per_proposal(proposal_reviews, rewards_slots);

    let base_ticket_reward = funding.proposal_funds() / Rewards::from(total_tickets);

    let bonus_rewards = approved_proposals
        .into_iter()
        .map(|(proposal, budget)| (proposal, bonus_funds * budget / total_approved_budget))
        .collect::<BTreeMap<_, _>>();

    let proposal_rewards = calculate_rewards_per_proposal(
        proposals_tickets,
        &bonus_rewards,
        base_ticket_reward,
        rewards_slots,
    );
    let mut rewards = BTreeMap::new();
    let mut rng = ChaCha8Rng::from_seed(seed);

    for proposal_reward in proposal_rewards {
        let rew = calculate_ca_rewards_for_proposal(proposal_reward, &mut rng);

        for (ca, rew) in rew {
            *rewards.entry(ca).or_insert(Rewards::ZERO) += rew;
        }
    }

    CaRewards {
        rewards,
        bonus_rewards,
        base_ticket_reward,
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn gen_dummy_reviews(n_excellent: u32, n_good: u32, n_na: u32) -> Vec<AdvisorReviewRow> {
        (0..n_excellent)
            .map(|_| AdvisorReviewRow::dummy(ReviewRanking::Excellent))
            .chain((0..n_good).map(|_| AdvisorReviewRow::dummy(ReviewRanking::Good)))
            .chain((0..n_na).map(|_| AdvisorReviewRow::dummy(ReviewRanking::NotReviewedByVCA)))
            .collect()
    }

    #[test]
    fn test_legacy_mode() {
        let reviews = gen_dummy_reviews(5, 10, 1);
        assert!(matches!(
            load_tickets_from_reviews(&reviews, &ProposalRewardSlots::default()),
            ProposalTickets::Legacy {
                winning_tkts: LEGACY_MAX_WINNING_TICKETS,
                ..
            }
        ));
    }

    macro_rules! check_fund6_winning_tkts {
        ($excellent:expr, $good:expr, $expected:expr) => {
            let p = gen_dummy_reviews($excellent, $good, 0);
            match load_tickets_from_reviews(&p, &Default::default()) {
                ProposalTickets::Fund7 {
                    excellent_winning_tkts,
                    good_winning_tkts,
                    ..
                } => assert_eq!(excellent_winning_tkts + good_winning_tkts, $expected),
                _ => panic!("invalid lottery setup"),
            }
        };
    }

    #[test]
    fn test_reviews_limits() {
        // testcases taken from presentation slides
        check_fund6_winning_tkts!(3, 2, 32);
        check_fund6_winning_tkts!(5, 5, 36);
        check_fund6_winning_tkts!(1, 3, 24);
        check_fund6_winning_tkts!(5, 0, 24);
        check_fund6_winning_tkts!(0, 3, 12);
    }

    fn are_close(a: Funds, b: Funds) -> bool {
        const DECIMAL_PRECISION: u32 = 10;
        a.round_dp(DECIMAL_PRECISION) == b.round_dp(DECIMAL_PRECISION)
    }

    #[test]
    fn test_underbudget_redistribution() {
        let mut proposals = BTreeMap::new();
        proposals.insert("1".into(), gen_dummy_reviews(1, 5, 0)); // winning tickets: 24
        proposals.insert("2".into(), gen_dummy_reviews(2, 3, 0)); // winning tickets: 32
        let res = calculate_ca_rewards(
            proposals,
            ApprovedProposals::new(),
            &FundSetting {
                proposal_ratio: 100,
                bonus_ratio: 0,
                total: Funds::from(100),
            },
            &Default::default(),
            [0; 32],
        )
        .rewards;
        assert!(are_close(res.values().sum::<Funds>(), Funds::from(100)));
    }

    #[test]
    fn test_bonus_distribution() {
        let mut proposals = BTreeMap::new();
        proposals.insert("1".into(), gen_dummy_reviews(1, 5, 0)); // winning tickets: 24
        proposals.insert("2".into(), gen_dummy_reviews(1, 1, 0)); // winning tickets: 16
        proposals.insert("3".into(), gen_dummy_reviews(2, 3, 0)); // winning tickets: 32
        let res = calculate_ca_rewards(
            proposals,
            vec![("1".into(), Funds::from(2)), ("2".into(), Funds::from(1))]
                .into_iter()
                .collect(),
            &FundSetting {
                proposal_ratio: 80,
                bonus_ratio: 20,
                total: Funds::from(100),
            },
            &Default::default(),
            [0; 32],
        )
        .rewards;
        assert!(are_close(res.values().sum::<Funds>(), Funds::from(100)));
    }

    #[test]
    fn test_all() {
        use rand::RngCore;

        let mut proposals = BTreeMap::new();
        let mut approved_proposals = ApprovedProposals::new();
        let mut rng = ChaChaRng::from_seed([0; 32]);
        for i in 0..100 {
            proposals.insert(
                i.to_string(),
                gen_dummy_reviews(rng.next_u32() % 10, rng.next_u32() % 10, rng.next_u32() % 2),
            );
            if rng.gen_bool(0.5) {
                approved_proposals.insert(i.to_string(), Funds::from(rng.next_u32() % 1000));
            }
        }
        let res = calculate_ca_rewards(
            proposals,
            approved_proposals,
            &FundSetting {
                proposal_ratio: 80,
                bonus_ratio: 20,
                total: Funds::from(100),
            },
            &Default::default(),
            [0; 32],
        )
        .rewards;
        assert!(are_close(res.values().sum::<Funds>(), Funds::from(100)));
    }

    #[test]
    fn test_double_stage_lottery() {
        let mut proposals = BTreeMap::new();
        let reviews = gen_dummy_reviews(1, 500, 0); // winning tickets: 24
        let excellent_assessor = reviews[0].assessor.clone();
        proposals.insert("1".into(), reviews);
        let res = calculate_ca_rewards(
            proposals,
            vec![("1".into(), Funds::from(2))].into_iter().collect(),
            &FundSetting {
                proposal_ratio: 80,
                bonus_ratio: 20,
                total: Funds::from(240),
            },
            &Default::default(),
            [0; 32],
        )
        .rewards;
        assert!(are_close(res.values().sum::<Funds>(), Funds::from(240)));
        assert!(are_close(
            *res.get(&excellent_assessor).unwrap(),
            Funds::from(120)
        ));
    }
}