Crate docs

zcash_proofs/src/circuit.rs

@@ -1,3 +1,5 @@
+//! Implementations of the Zcash circuits and Zcash-specific gadgets.
+
 pub mod ecc;
 pub mod pedersen_hash;
 

zcash_proofs/src/circuit/ecc.rs

@@ -1,3 +1,5 @@
+//! Gadgets implementing Jubjub elliptic curve operations.
+
 use ff::Field;
 use pairing::Engine;
 

zcash_proofs/src/circuit/pedersen_hash.rs

@@ -1,3 +1,5 @@
+//! Gadget for Zcash's Pedersen hash.
+
 use super::ecc::{EdwardsPoint, MontgomeryPoint};
 use bellman::gadgets::boolean::Boolean;
 use bellman::gadgets::lookup::*;

zcash_proofs/src/circuit/sapling.rs

@@ -1,3 +1,5 @@
+//! The Sapling circuits.
+
 use ff::{Field, PrimeField, PrimeFieldRepr};
 
 use bellman::{Circuit, ConstraintSystem, SynthesisError};

zcash_proofs/src/circuit/sprout/mod.rs

@@ -1,3 +1,15 @@
+//! The "hybrid Sprout" circuit.
+//!
+//! "Hybrid Sprout" refers to the implementation of the [Sprout statement] in
+//! `bellman` for [`groth16`], instead of the [original implementation][oldimpl]
+//! using [`libsnark`] for [BCTV14].
+//!
+//! [Sprout statement]: https://zips.z.cash/protocol/protocol.pdf#joinsplitstatement
+//! [`groth16`]: bellman::groth16
+//! [oldimpl]: https://github.com/zcash/zcash/tree/v2.0.7/src/zcash/circuit
+//! [`libsnark`]: https://github.com/scipr-lab/libsnark
+//! [BCTV14]: https://eprint.iacr.org/2013/879
+
 use bellman::gadgets::boolean::{AllocatedBit, Boolean};
 use bellman::gadgets::multipack::pack_into_inputs;
 use bellman::{Circuit, ConstraintSystem, LinearCombination, SynthesisError};

zcash_proofs/src/lib.rs

@@ -1,3 +1,8 @@
+//! *Zcash circuits and proofs.*
+//!
+//! `zcash_proofs` contains the zk-SNARK circuits used by Zcash, and the APIs for creating
+//! and verifying proofs.
+
 // Catch documentation errors caused by code changes.
 #![deny(intra_doc_link_resolution_failure)]
 

zcash_proofs/src/sapling/mod.rs

@@ -1,3 +1,5 @@
+//! Helpers for creating Sapling proofs.
+
 use pairing::bls12_381::Bls12;
 use zcash_primitives::jubjub::{
     edwards, fs::FsRepr, FixedGenerators, JubjubBls12, JubjubParams, Unknown,