psibase 0.29.0

Library and command-line tool for interacting with psibase networks
Documentation 
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

use std::{collections::HashMap, hash::Hash};

use super::constants::PPM;
use crate::abort_message;

/// Distributes each group's `total` across its members according to their
/// PPM shares (via [`allocations`]) and sums each member's per-group
/// amounts into a single map.
pub fn combine_group_scores<Groups, Scores, Member: Eq + Hash>(
    groups: Groups,
) -> HashMap<Member, u32>
where
    Groups: IntoIterator<Item = (u32, Scores)>,
    Scores: IntoIterator<Item = (Member, u32)>,
{
    let mut member_allocations: HashMap<Member, u32> = HashMap::new();

    for (total, member_shares) in groups {
        for (member, allocation) in allocations(member_shares, total as u64) {
            *member_allocations.entry(member).or_insert(0u32) += allocation as u32;
        }
    }
    member_allocations
}

/// Yields `(element, amount)` pairs, where `amount = (share / PPM) * total`
/// (integer-floored). Elements whose computed amount is zero are skipped.
///
/// Aborts if the cumulative shares exceed `PPM`.
pub fn allocations<I, Element>(
    element_shares: I,
    total: u64,
) -> impl Iterator<Item = (Element, u64)>
where
    I: IntoIterator<Item = (Element, u32)>,
{
    let mut total_shares = 0u64;
    element_shares
        .into_iter()
        .filter_map(move |(element, share)| {
            total_shares += share as u64;
            if total_shares > PPM as u64 {
                abort_message("provided shares exceed 100%");
            }
            let amount = ((share as u128 * total as u128) / PPM as u128) as u64;
            (amount > 0).then_some((element, amount))
        })
}