r1cs/
lib.rs

1// TODO: Copy some examples etc. here when the API is more stable.
2
3//! This is a rust library for building R1CS gadgets over prime fields, which are useful in SNARKs
4//! and other argument systems.
5//!
6//! See the [readme](https://github.com/mir-protocol/r1cs) for more information and examples.
7
8#![cfg_attr(not(feature = "std"), no_std)]
9
10#[cfg(feature = "std")]
11#[macro_use]
12extern crate std;
13
14#[cfg(not(feature = "std"))]
15#[macro_use]
16extern crate core as std;
17
18#[cfg(not(feature = "std"))]
19#[macro_use]
20extern crate alloc;
21
22pub use num;
23
24pub use constraint::*;
25pub use curve::*;
26pub use davies_meyer::*;
27pub use embedded_curve::*;
28pub use expression::*;
29pub use field::*;
30pub use gadget::*;
31pub use gadget_builder::*;
32pub use gadget_traits::*;
33pub use lcg::*;
34pub use matrices::*;
35pub use merkle_damgard::*;
36pub use merkle_trees::*;
37pub use mimc::*;
38pub use miyaguchi_preneel::*;
39pub use permutations::*;
40pub use poseidon::*;
41pub use rescue::*;
42pub use sponge::*;
43pub use wire::*;
44pub use wire_values::*;
45pub use witness_generator::*;
46
47#[macro_use]
48mod wire_values;
49
50mod bimap_util;
51mod binary_arithmetic;
52mod bitwise_operations;
53mod boolean_algebra;
54mod comparisons;
55mod constraint;
56mod curve;
57mod davies_meyer;
58mod embedded_curve;
59mod expression;
60mod field;
61mod field_arithmetic;
62mod gadget;
63mod gadget_builder;
64mod gadget_traits;
65mod lcg;
66mod matrices;
67mod merkle_damgard;
68mod merkle_trees;
69mod mimc;
70mod miyaguchi_preneel;
71mod permutations;
72mod poseidon;
73mod random_access;
74mod rescue;
75mod signature;
76mod sorting;
77mod splitting;
78mod sponge;
79mod util;
80mod verify_permutation;
81mod wire;
82mod witness_generator;
83
84#[cfg(test)]
85mod test_util;
r1cs/lib.rs

r1cs/
lib.rs
