mithril-stm 0.10.5

A Rust implementation of Mithril Stake-based Threshold Multisignatures (STMs).
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
83
84
85
86
87
88
89
90
91
92
93
94
95

//! Core Halo2 circuit primitives and reusable field/curve wrappers for STM.

use std::ops::{Add, AddAssign, Neg, Sub};

use ff::Field;
use midnight_curves::{Fq as MidnightBaseField, JubjubExtended as MidnightJubjub};

use crate::signature_scheme::BaseFieldElement;

/// Shared Midnight field alias used by Halo2 relation/chips.
pub(crate) type CircuitBase = MidnightBaseField;
/// Shared Midnight curve alias used by Halo2 relation/chips.
pub(crate) type CircuitCurve = MidnightJubjub;

/// Field type boundaries:
/// - `BaseFieldElement`: STM/domain field wrapper.
/// - `CircuitBaseField`: circuit statement/input wrapper.
/// - `CircuitBase`: raw proving-library field.
///
/// Circuit-local wrapper for base-field values present in public inputs/witness data.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Default)]
pub struct CircuitBaseField(CircuitBase);

impl CircuitBaseField {
    /// Additive identity in the circuit base field.
    pub const ZERO: Self = Self(CircuitBase::ZERO);
    /// Multiplicative identity in the circuit base field.
    pub const ONE: Self = Self(CircuitBase::ONE);
}

impl From<u64> for CircuitBaseField {
    fn from(value: u64) -> Self {
        Self(CircuitBase::from(value))
    }
}

impl From<CircuitBase> for CircuitBaseField {
    fn from(value: CircuitBase) -> Self {
        Self(value)
    }
}

impl From<CircuitBaseField> for CircuitBase {
    fn from(value: CircuitBaseField) -> Self {
        value.0
    }
}

impl From<BaseFieldElement> for CircuitBaseField {
    fn from(value: BaseFieldElement) -> Self {
        value.0.into()
    }
}

impl From<CircuitBaseField> for BaseFieldElement {
    fn from(value: CircuitBaseField) -> Self {
        Self(value.into())
    }
}

impl From<BaseFieldElement> for CircuitBase {
    fn from(value: BaseFieldElement) -> Self {
        CircuitBaseField::from(value).into()
    }
}

impl Add for CircuitBaseField {
    type Output = Self;

    fn add(self, rhs: Self) -> Self::Output {
        Self(self.0 + rhs.0)
    }
}

impl AddAssign for CircuitBaseField {
    fn add_assign(&mut self, rhs: Self) {
        self.0 += rhs.0;
    }
}

impl Sub for CircuitBaseField {
    type Output = Self;

    fn sub(self, rhs: Self) -> Self::Output {
        Self(self.0 - rhs.0)
    }
}

impl Neg for CircuitBaseField {
    type Output = Self;

    fn neg(self) -> Self::Output {
        Self(-self.0)
    }
}