Struct sn_farming::utils::RewardCounterSet

pub struct RewardCounterSet { /* fields omitted */ }

A util for calculating the median of a vec of RewardCounters. Implements Into, since the semantics of this set is that it basically represents a single value, which we derive by taking the median of the set.

Implementations

impl RewardCounterSet

The semantics of RewardCounterSet is that it basically represents a single value, as perceived by a fix set of different actors working as a group. We get the agreed value, by taking the median of the set. With at least 2/3 correctly working actors (e2e), we are ensured BFT.

pub fn new(
    expected_counters: usize,
    counters: Vec<RewardCounter>
) -> Result<Self>

The number of expected counters determines when we have an agreed value. Must be uneven. The vec can be empty or contain any number already.

pub fn len(&self) -> usize

Returns the length of the set.

pub fn is_empty(&self) -> bool

Returns whether the set is empty.

pub fn add(&mut self, counter: RewardCounter)

Adds a counter to the set.

pub fn agreed_value(&self) -> Option<RewardCounter>

Returns the agreed value between all, interpreted through the median value.