1<h1 align="center">ark-r1cs-std</h1>
 2
 3<p align="center">
 4    <img src="https://github.com/arkworks-rs/r1cs-std/workflows/CI/badge.svg?branch=master">
 5    <a href="https://github.com/arkworks-rs/r1cs-std/blob/master/LICENSE-APACHE"><img src="https://img.shields.io/badge/license-APACHE-blue.svg"></a>
 6    <a href="https://github.com/arkworks-rs/r1cs-std/blob/master/LICENSE-MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
 7    <a href="https://deps.rs/repo/github/arkworks-rs/r1cs-std"><img src="https://deps.rs/repo/github/arkworks-rs/r1cs-std/status.svg"></a>
 8</p>
 9
10The arkworks ecosystem consist of Rust libraries for designing and working with __zero knowledge succinct non-interactive arguments (zkSNARKs)__. This repository contains efficient implementations of constraint "gadgets" that enable checking common computations inside SNARKs, such as bit operations, finite field arithmetic, elliptic curve arithmetic, and pairings.
11
12This library is released under the MIT License and the Apache v2 License (see [License](#license)).
13
14**WARNING:** This is an academic proof-of-concept prototype, and in particular has not received careful code review. This implementation is NOT ready for production use.
15
16## Build guide
17
18The library compiles on the `stable` toolchain of the Rust compiler. To install the latest version of Rust, first install `rustup` by following the instructions [here](https://rustup.rs/), or via your platform's package manager. Once `rustup` is installed, install the Rust toolchain by invoking:
19```bash
20rustup install stable
21```
22
23After that, use `cargo`, the standard Rust build tool, to build the library:
24```bash
25git clone https://github.com/arkworks-rs/r1cs-std.git
26cargo build --release
27```
28
29This library comes with unit tests for each of the provided crates. Run the tests with:
30```bash
31cargo test
32```
33
34## License
35
36This library is licensed under either of the following licenses, at your discretion.
37
38 * Apache License Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
39 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
40
41Unless you explicitly state otherwise, any contribution submitted for inclusion in this library by you shall be dual licensed as above (as defined in the Apache v2 License), without any additional terms or conditions.
42
43## Acknowledgements
44
45This work was supported by:
46a Google Faculty Award;
47the National Science Foundation;
48the UC Berkeley Center for Long-Term Cybersecurity;
49and donations from the Ethereum Foundation, the Interchain Foundation, and Qtum.
50
51An earlier version of this library was developed as part of the paper *"[ZEXE: Enabling Decentralized Private Computation][zexe]"*.
52
53[zexe]: https://ia.cr/2018/962