zkstd 0.0.22

zero knowledge proof standard library
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

mod construction;

macro_rules! limbs_test {
    ($test_name:ident, $test_bits:ident, $test_mod:ident, $limbs_type:ident, $one:expr, $two:expr) => {
        #[cfg(test)]
        mod $test_name {
            use super::*;
            use construction::$test_mod::*;
            use paste::paste;
            use rand_core::OsRng;
            use zkstd::arithmetic::$test_bits::*;

            fn arb_field() -> $limbs_type {
                random(OsRng)
            }

            paste! {
                #[test]
                fn [< $test_name _add_test >]() {
                    let a = arb_field();
                    let b = a;
                    let c = a;

                    // a + a = a * 2
                    let d = add(a, b, MODULUS);
                    let e = double(c, MODULUS);
                    assert_eq!(d, e);
                }
            }

            paste! {
                #[test]
                fn [< $test_name _sub_test >]() {
                    let a = arb_field();
                    let b = a;
                    let c = a;
                    let d = a;

                    // a - a = a * 2 - a * 2
                    let e = sub(a, b, MODULUS);

                    let cc = double(c, MODULUS);
                    let dd = double(d, MODULUS);
                    let f = sub(cc, dd, MODULUS);

                    assert_eq!(e, f);
                }
            }

            paste! {
            #[test]
                fn [< $test_name _mul_test >]() {
                    let a = arb_field();
                    let b = arb_field();
                    let c = arb_field();

                    // a * b + a * c
                    let ab = mul(a, b, MODULUS, INV);
                    let ac = mul(a, c, MODULUS, INV);
                    let d = add(ab, ac, MODULUS);

                    // a * (b + c)
                    let bc = add(b, c, MODULUS);
                    let e = mul(a, bc, MODULUS, INV);

                    assert_eq!(d, e);
                }
            }

            paste! {
                #[test]
                fn [< $test_name _square_test >]() {
                    let a = arb_field();
                    let b = arb_field();

                    // (a * a) * (b * b)
                    let aa = mul(a, a, MODULUS, INV);
                    let bb = mul(b, b, MODULUS, INV);
                    let c = mul(aa, bb, MODULUS, INV);

                    // a^2 * b^2
                    let aa = square(a, MODULUS, INV);
                    let bb = square(b, MODULUS, INV);
                    let d = mul(aa, bb, MODULUS, INV);

                    assert_eq!(c, d);
                }
            }

            paste! {
                #[test]
                fn [< $test_name _invert_test >]() {
                    let a = arb_field();
                    let one = from_raw($one);
                    let inv = invert(a, sub(zero(), $two, MODULUS), one, MODULUS, INV);

                    if let Some(x) = inv {
                        let b = mul(a, x, MODULUS, INV);
                        assert_eq!(b, one)
                    }
                }
            }

            paste! {
                #[test]
                fn [< $test_name _power_test >]() {
                    let a = arb_field();
                    let one = from_raw($one);
                    let identity = pow(a, sub(zero(), $one, MODULUS), one, MODULUS, INV);
                    let zero_power = pow(a, zero(), one, MODULUS, INV);

                    assert_eq!(one, identity);
                    assert_eq!(one, zero_power);
                }
            }
        }
    };
}

use construction::{Bits256Limbs, Bits384Limbs};

limbs_test!(
    jubjub_limbs_tests,
    bits_256,
    jubjub_field,
    Bits256Limbs,
    [1, 0, 0, 0],
    [2, 0, 0, 0]
);
limbs_test!(
    bls12_381_limbs_tests,
    bits_384,
    bls12_381_field,
    Bits384Limbs,
    [1, 0, 0, 0, 0, 0],
    [2, 0, 0, 0, 0, 0]
);