1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
//! Sindri Rust SDK
//!
//! A library for generating zero-knowledge proofs with [Sindri](https://sindri.app).
//!
//! # Overview
//!
//! The main entry point of this library is the [`client::SindriClient`] struct, which encapsulates
//! all methods for interacting with the Sindri API. The client handles request/response management
//! and includes built-in robustness features like automatic retries for transient errors.
//!
//! # Quick Start
//!
//! Generate your first zero-knowledge proof in just a few lines of code:
//!
//! ```
//! use std::collections::HashMap;
//! use sindri::{client::SindriClient, CircuitInfo};
//!
//! let client = SindriClient::default();
//! // Use tags and project metadata to organize and annotate your project builds
//! let tags: Option<Vec<String>> = None;
//! let project_metadata: Option<HashMap<String, String>> = None;
//! # let tags = Some(vec!["tester".to_string()]);
//! let circuit = client.create_circuit_blocking(
//! "../cli/tests/factory/circuit.tar.gz".to_string(),
//! tags,
//! project_metadata
//! ).unwrap();
//!
//! // Use proof metadata to annotate proofs with additional information and
//! // pass conditional flags to control whether server-side verification is enabled
//! let input = r#"{"a": 1, "b": 2}"#;
//! let proof_metadata: Option<HashMap<String, String>> = None;
//! let verify: Option<bool> = None;
//! let proof = client.prove_circuit_blocking(
//! circuit.id(),
//! input,
//! proof_metadata,
//! verify,
//! None, // The default prover implementation is generally recommended
//! ).unwrap();
//! ```
//!
//! # Key Features
//!
//! - **Project Management**: Create circuits and proofs with methods like
//! [`create_circuit`](client::SindriClient::create_circuit) and
//! [`prove_circuit`](client::SindriClient::prove_circuit)
//!
//! - **Collaboration**: Share and reuse public circuits using
//! [`clone_circuit`](client::SindriClient::clone_circuit)
//!
//! - **Seamless Integration**: Works with popular Rust-based DSLs and zkVMs including:
//! - Halo2
//! - Plonky2
//! - Jolt
//! - Sp1
//!
//! For more detailed documentation, refer to the [`client::SindriClient`] struct.
//!
pub
pub
pub
pub
pub use *;