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
use super::{Rewards, Threshold, VoteCount};
use crate::utils::assert_are_close;
use jormungandr_lib::crypto::account::Identifier;
use rust_decimal::Decimal;
use snapshot_lib::{SnapshotInfo, VotingGroup};
use std::collections::{BTreeMap, HashSet};
use thiserror::Error;

#[derive(Debug, Error)]
pub enum Error {
    #[error("Value overflowed its maximum value")]
    Overflow,
    #[error("Multiple snapshot entries per voter are not supported")]
    MultipleEntries,
}

fn filter_requirements(
    mut dreps: Vec<SnapshotInfo>,
    votes: VoteCount,
    top_dreps_to_reward: usize,
    votes_threshold: Threshold,
) -> Vec<SnapshotInfo> {
    // only the top `top_dreps_to_reward` representatives get rewards
    dreps.sort_by_key(|v| v.hir.voting_power);
    dreps.reverse();
    dreps.truncate(top_dreps_to_reward);

    dreps
        .into_iter()
        .filter_map(|d| votes.get(&d.hir.voting_key).map(|d_votes| (d, d_votes)))
        .filter(|(_d, d_votes)| votes_threshold.filter(d_votes))
        .map(|(d, _d_votes)| d)
        .collect()
}

pub fn calc_dreps_rewards(
    snapshot: Vec<SnapshotInfo>,
    votes: VoteCount,
    drep_voting_group: VotingGroup,
    top_dreps_to_reward: usize,
    dreps_votes_threshold: Threshold,
    total_rewards: Decimal,
) -> Result<BTreeMap<Identifier, Rewards>, Error> {
    let total_active_stake = snapshot
        .iter()
        .try_fold(0u64, |acc, x| acc.checked_add(x.hir.voting_power.into()))
        .ok_or(Error::Overflow)?;

    let dreps = snapshot
        .into_iter()
        .filter(|v| v.hir.voting_group == drep_voting_group)
        .collect::<Vec<_>>();

    let total_dreps_stake = dreps
        .iter()
        .map(|d| u64::from(d.hir.voting_power))
        .sum::<u64>();

    let unique_dreps = dreps
        .iter()
        .map(|s| s.hir.voting_key.clone())
        .collect::<HashSet<_>>();
    if unique_dreps.len() != dreps.len() {
        return Err(Error::MultipleEntries);
    }

    let filtered = filter_requirements(dreps, votes, top_dreps_to_reward, dreps_votes_threshold);

    let res = filtered
        .into_iter()
        .map(|d| {
            let reward = if let Some(reward) = Decimal::from(u64::from(d.hir.voting_power))
                .checked_div(Decimal::from(total_active_stake))
            {
                reward * total_rewards
            } else {
                Decimal::ZERO
            };
            (d.hir.voting_key, reward)
        })
        .collect::<BTreeMap<_, _>>();

    let expected_rewards = if let Some(stake) =
        Decimal::from(total_dreps_stake).checked_div(Decimal::from(total_active_stake))
    {
        total_rewards * stake
    } else {
        Decimal::ZERO
    };
    assert_are_close(res.values().sum(), expected_rewards);

    Ok(res)
}

#[cfg(test)]
mod tests {
    use super::*;
    use jormungandr_lib::crypto::hash::Hash;
    use proptest::prop_assert_eq;
    use snapshot_lib::*;
    use std::collections::HashMap;
    use test_strategy::proptest;

    #[proptest]
    fn test_small(snapshot: Snapshot) {
        let voting_keys = snapshot.voting_keys().collect::<Vec<_>>();

        let votes_count = voting_keys
            .iter()
            .enumerate()
            .map(|(i, &key)| {
                (
                    key.to_owned(),
                    if i % 2 == 0 {
                        HashSet::from([Hash::from([0u8; 32])])
                    } else {
                        HashSet::new()
                    },
                )
            })
            .collect::<VoteCount>();
        let voters = snapshot.to_full_snapshot_info();
        let voters_active = voters
            .clone()
            .into_iter()
            .enumerate()
            .filter(|(i, _utxo)| i % 2 == 0)
            .map(|(_, utxo)| utxo)
            .collect::<Vec<_>>();

        let rewards = calc_dreps_rewards(
            voters,
            votes_count.clone(),
            String::new(),
            voting_keys.len(),
            Threshold::new(1, HashMap::new(), Vec::new()).unwrap(),
            Rewards::ONE,
        )
        .unwrap();
        let rewards_no_inactive = calc_dreps_rewards(
            voters_active,
            votes_count,
            String::new(),
            voting_keys.len(),
            Threshold::new(1, HashMap::new(), Vec::new()).unwrap(),
            Rewards::ONE,
        )
        .unwrap();
        // Rewards should ignore inactive voters
        prop_assert_eq!(rewards, rewards_no_inactive);
    }

    #[proptest]
    fn test_threshold(snapshot: Snapshot) {
        let voters = snapshot.to_full_snapshot_info();

        let rewards = calc_dreps_rewards(
            voters.clone(),
            VoteCount::new(),
            String::new(),
            1,
            Threshold::new(0, HashMap::new(), Vec::new()).unwrap(),
            Rewards::ONE,
        )
        .unwrap();
        prop_assert_eq!(rewards.len(), 0)
    }

    #[proptest]
    fn test_per_category_threshold(snapshot: Snapshot) {
        use vit_servicing_station_tests::common::data::ArbitrarySnapshotGenerator;

        let voters = snapshot.to_full_snapshot_info();

        let snapshot = ArbitrarySnapshotGenerator::default().snapshot();
        let proposals = snapshot.proposals();

        let proposals_by_challenge =
            proposals
                .iter()
                .fold(<HashMap<_, Vec<_>>>::new(), |mut acc, prop| {
                    acc.entry(prop.proposal.challenge_id)
                        .or_default()
                        .push(Hash::from(
                            crate::rewards::chain_proposal_id_bytes(
                                &prop.proposal.chain_proposal_id,
                            )
                            .unwrap(),
                        ));
                    acc
                });
        let per_challenge_threshold = proposals_by_challenge
            .iter()
            .map(|(challenge, p)| (*challenge, p.len()))
            .collect::<HashMap<_, _>>();

        let mut votes_count = voters
            .iter()
            .map(|v| {
                (
                    v.hir.voting_key.clone(),
                    proposals_by_challenge
                        .values()
                        .flat_map(|p| p.iter())
                        .cloned()
                        .collect::<HashSet<_>>(),
                )
            })
            .collect::<Vec<_>>();
        let (_, inactive) = votes_count.split_at_mut(voters.len() / 2);
        for v in inactive {
            v.1.remove(&v.1.iter().next().unwrap().clone());
        }

        let only_active = votes_count
            .clone()
            .into_iter()
            .take(voters.len() / 2)
            .collect::<HashMap<_, _>>();
        let votes_count = votes_count.into_iter().collect::<HashMap<_, _>>();

        let rewards = calc_dreps_rewards(
            voters.clone(),
            votes_count,
            String::new(),
            voters.len(),
            Threshold::new(
                1,
                per_challenge_threshold.clone(),
                proposals.clone().into_iter().map(Into::into).collect(),
            )
            .unwrap(),
            Rewards::ONE,
        )
        .unwrap();

        let rewards_only_active = calc_dreps_rewards(
            voters.clone(),
            only_active,
            String::new(),
            voters.len(),
            Threshold::new(
                1,
                per_challenge_threshold,
                proposals.into_iter().map(Into::into).collect(),
            )
            .unwrap(),
            Rewards::ONE,
        )
        .unwrap();

        prop_assert_eq!(rewards_only_active, rewards);
    }
}