diff --git a/src/lib.rs b/src/lib.rs index 901a619..9f566c6 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,10 +1,29 @@ +//! Rust bindings for rapidsnark proving. +//! +//! Prebuilt binaries are provided for the following platforms: +//! - aarch64-apple-ios +//! - aarch64-apple-ios-sim +//! - aarch64-apple-darwin +//! - x86_64-apple-ios +//! - x86_64 +//! - aarch64 +//! +//! If a specific target is not included the sysytem will fallback to +//! the generic architecture, which may cause problems. e.g. if you compile +//! for aarch64-linux-generic, the system will fallback to aarch64. +//! + use std::collections::HashMap; use std::str::FromStr; use anyhow::Result; use num_bigint::BigInt; + +/// A function that converts named inputs to a full witness. This should be generated using e.g. +/// [rust-witness](https://crates.io/crates/rust-witness). pub type WtnsFn = fn(HashMap>) -> Vec; +/// A structure representing a proof and public signals. #[derive(Debug)] pub struct ProofResult { pub proof: String,