avalanche-consensus 0.1.1

Avalanche consensus
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
49
50
51
52
53
54
55
56
57
58

//! Snowball consensus.
pub mod binary;
pub mod tree;
pub mod unary;

use avalanche_types::ids::{bag::Bag, Id};

/// Represents a node interface for binary trie.
/// ref. "avalanchego/snow/consensus/snowball/tree.go#node"
#[derive(Clone, Debug)]
pub enum Node {
    Unary(unary::node::Node),
    Binary(binary::node::Node),
}

impl Node {
    /// Returns the preferred choice of this sub-tree.
    pub fn preference(&self) -> Id {
        match self {
            Node::Unary(n) => n.preference(),
            Node::Binary(n) => n.preference(),
        }
    }

    /// Returns the number of assumed decided bits of this node.
    /// Patricia trie places into each node the bit index to be tested
    /// in order to decide which path to take out of that node.
    /// Thus, it can skip directly to the bit where a significant
    /// decision is to be made by tracking "decided_prefix".
    pub fn decided_prefix(&self) -> i64 {
        match self {
            Node::Unary(n) => n.decided_prefix(),
            Node::Binary(n) => n.decided_prefix(),
        }
    }

    /// Returns "true" when the consensus has been reached on this node.
    pub fn finalized(&self) -> bool {
        match self {
            Node::Unary(n) => n.finalized(),
            Node::Binary(n) => n.finalized(),
        }
    }

    pub fn add(&mut self, new_choice: &Id) -> Node {
        match self {
            Node::Unary(n) => n.add(new_choice),
            Node::Binary(n) => n.add(new_choice),
        }
    }

    pub fn record_poll(&mut self, votes: Bag, reset: bool) -> (Node, bool) {
        match self {
            Node::Unary(n) => n.record_poll(votes, reset),
            Node::Binary(n) => n.record_poll(votes, reset),
        }
    }
}