Integrate sponge API from marlin/poly-commit PRs (#13)

Co-authored-by: Will Lin <[email protected]> Co-authored-by: Tom Shen <[email protected]> Co-authored-by: Dev Ojha <[email protected]>
arkworks-rs · May 29, 2021 · 38f9011 · 38f9011
1 parent 9d47db9
commit 38f9011
Show file tree

Hide file tree

Showing 9 changed files with 2,643 additions and 204 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,8 +11,25 @@ incremental = true
 panic = 'abort'
 
 [dependencies]
-ark-ff = { version = "0.2.0", default_features = false }
+ark-ec = { version = "^0.2.0", default_features = false }
+ark-ff = { version = "^0.2.0", default_features = false }
+ark-serialize = { version = "0.2.0", default_features = false}
+ark-std = { version = "^0.2.0", default-features = false }
+derivative = { version = "2.1.1", features = [ "use_core" ] }
+digest = { version = "0.9.0", default_features = false }
+rand_core = { version = "0.5" }
+rand_chacha = { version = "0.2.1", default-features = false }
+
+# Dependencies for r1cs
+ark-nonnative-field = { version = "^0.2.0", default-features = false, optional = true }
+ark-r1cs-std = { version = "^0.2.0", default-features = false, optional = true }
+ark-relations = { version = "^0.2.0", default-features = false, optional = true }
+tracing = { version = "0.1", default-features = false, features = [ "attributes" ], optional = true }
+
+[dev-dependencies]
+ark-test-curves = {version = "0.2.0", features = ["bls12_381_curve", "mnt4_753_curve"]}
 
 [features]
-default = ["std"]
-std = [ "ark-ff/std" ]
+default = [ "r1cs", "std" ]
+r1cs = [ "ark-nonnative-field", "ark-relations", "ark-r1cs-std", "tracing" ]
+std = [ "ark-ec/std", "ark-ff/std", "ark-nonnative-field/std", "ark-r1cs-std/std", "ark-relations/std", "ark-std/std", "ark-serialize/std" ]
diff --git a/README.md b/README.md
@@ -1 +1,65 @@
-# Ark::Sponge
+<h1 align="center">Cryptographic Sponges</h1>
+
+<p align="center">
+    <a href="https://github.com/arkworks-rs/sponge/blob/master/LICENSE-APACHE">
+        <img src="https://img.shields.io/badge/license-APACHE-blue.svg"></a>
+    <a href="https://github.com/arkworks-rs/sponge/blob/master/LICENSE-MIT">
+        <img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+</p>
+
+`ark-sponge` is a Rust library that provides infrastructure for implementing 
+*cryptographic sponges*. This library is released under the MIT License
+and the Apache v2 License (see [License](#license)).
+
+**WARNING:** This is an academic prototype, and in particular has not received careful code review.
+This implementation is NOT ready for production use.
+
+## Overview
+
+A cryptographic sponge is a cryptographic primitive that has two basic operations, *absorb* and *squeeze*. A sponge
+accepts byte or field element inputs through its "absorb" operation. At any time, a user can invoke the "squeeze" operation on a sponge to obtain byte or field
+element outputs. The sponge is stateful, so that squeezed outputs are dependent on previous inputs and previous outputs.
+
+The library offers infrastructure for building cryptographic sponges and using them with different types of inputs.
+## Build guide
+
+The 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:
+```bash
+rustup install stable
+```
+
+After that, use `cargo` (the standard Rust build tool) to build the library:
+```bash
+git clone https://github.com/arkworks-rs/sponge.git
+cd sponge 
+cargo build --release
+```
+
+This library comes with some unit and integration tests. Run these tests with:
+```bash
+cargo test
+```
+
+## License
+
+This library is licensed under either of the following licenses, at your discretion.
+
+ * [Apache License Version 2.0](LICENSE-APACHE)
+ * [MIT License](LICENSE-MIT)
+
+Unless you explicitly state otherwise, any contribution that you submit to this library shall be
+dual licensed as above (as defined in the Apache v2 License), without any additional terms or
+conditions.
+
+## Reference papers
+
+[Fractal: Post-Quantum and Transparent Recursive Proofs from Holography][cos20]     
+Alessandro Chiesa, Dev Ojha, Nicholas Spooner     
+
+[POSEIDON: A New Hash Function For Zero-Knowledge Proof Systems][gkrrs19]
+Lorenzo Grassi, Dmitry Khovratovich, Christian Rechberger, Arnab Roy, Markus Schofnegger
+
+[cos20]: https://eprint.iacr.org/2019/1076
+[gkrrs19]: https://eprint.iacr.org/2019/458