dapol 0.4.0

DAPOL+ Proof of Liabilities protocol
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

//! Various accumulator variants of the DAPOL+ protocol.
//!
//! An accumulator defines how the binary tree is built. There are different
//! types of accumulators, which can all be found under this module.

use clap::ValueEnum;
use curve25519_dalek::{ristretto::RistrettoPoint, scalar::Scalar};
use primitive_types::H256;
use serde::{Deserialize, Serialize};
use std::fmt;

mod ndm_smt;
pub use ndm_smt::{NdmSmt, NdmSmtError, RandomXCoordGenerator};

use crate::Height;

/// Supported accumulators, with their linked data.
#[derive(Debug, Serialize, Deserialize)]
pub enum Accumulator {
    NdmSmt(ndm_smt::NdmSmt),
    // TODO add other accumulators..
}

impl Accumulator {
    /// Height of the binary tree.
    pub fn height(&self) -> &Height {
        match self {
            Accumulator::NdmSmt(ndm_smt) => ndm_smt.height(),
        }
    }

    /// Return the accumulator type.
    pub fn get_type(&self) -> AccumulatorType {
        match self {
            Self::NdmSmt(_) => AccumulatorType::NdmSmt,
        }
    }

    #[doc = include_str!("./shared_docs/root_hash.md")]
    pub fn root_hash(&self) -> &H256 {
        match self {
            Self::NdmSmt(ndm_smt) => ndm_smt.root_hash(),
        }
    }

    #[doc = include_str!("./shared_docs/root_commitment.md")]
    pub fn root_commitment(&self) -> &RistrettoPoint {
        match self {
            Self::NdmSmt(ndm_smt) => ndm_smt.root_commitment(),
        }
    }

    #[doc = include_str!("./shared_docs/root_liability.md")]
    pub fn root_liability(&self) -> u64 {
        match self {
            Self::NdmSmt(ndm_smt) => ndm_smt.root_liability(),
        }
    }

    #[doc = include_str!("./shared_docs/root_blinding_factor.md")]
    pub fn root_blinding_factor(&self) -> &Scalar {
        match self {
            Self::NdmSmt(ndm_smt) => ndm_smt.root_blinding_factor(),
        }
    }
}

/// Various supported accumulator types.
#[derive(Clone, Deserialize, Debug, ValueEnum, PartialEq)]
#[serde(rename_all = "kebab-case")]
pub enum AccumulatorType {
    NdmSmt,
    // TODO add other accumulators..
}

impl fmt::Display for AccumulatorType {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            AccumulatorType::NdmSmt => write!(f, "NDM-SMT"),
        }
    }
}