tallytree 0.3.4

Merkle Tally Tree
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

use crate::tally::TallyList;
use crate::utilstring::to_hex;
#[cfg(feature = "with-serde")]
use serde::{Deserialize, Serialize};
use std::fmt;

/**
 * Hash used in a merkle proof. If it's a leaf node, its a vote reference,
 * otherwise a node hash.
 *
 * The node hash of a leaf node can be derived from its vote reference.
 */
pub type ProofHash = [u8; 32];

/// A node in the tally merkle tree as represented in a merkle proof,
/// consisting of the node hash and tally.
pub type ProofNode = (ProofHash, Option<TallyList>);
/// Two siblings nodes in a merkle tree proof. If a sibling is None, that means
/// you should be able to derive it from the "above" branches.
pub type ProofBranch = (Option<ProofNode>, Option<ProofNode>);

/// Merkle Tally Proof
#[derive(Debug, Default, PartialEq)]
#[cfg_attr(feature = "with-serde", derive(Serialize, Deserialize))]
pub struct Proof {
    /// Pairs of sibling nodes in a merkle tally leading up to a merkle root
    /// hash, allowing for verifying that a set of nodes belong in a tree.
    pub branches: Vec<ProofBranch>,
}

impl fmt::Display for Proof {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "Proof {{")?;

        for (left, right) in &self.branches {
            let l = if let Some((hash, _tally)) = left {
                to_hex(hash.as_slice()).unwrap()
            } else {
                "None".to_string()
            };
            let r = if let Some((hash, _tally)) = right {
                to_hex(hash.as_slice()).unwrap()
            } else {
                "None".to_string()
            };
            writeln!(f, "  ({}, {}) ", l, r)?;
        }
        write!(f, "}}")
    }
}