exochain-proofs 0.2.0-beta

EXOCHAIN zero-knowledge proof skeleton -- UNAUDITED, pedagogical only. See crate README.
Documentation 
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
77
78

// Copyright 2026 Exochain Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0

//! # EXOCHAIN zero-knowledge proof skeleton — **UNAUDITED**.
//!
//! ## ⚠️ NOT PRODUCTION CRYPTOGRAPHY
//!
//! This crate is a pedagogical / structural implementation demonstrating
//! the *shape* of a SNARK / STARK / ZKML proof system. It uses blake3
//! "stand-ins" for elliptic curve points and has not been reviewed by a
//! cryptographer. **Do not rely on it for any production trust claim.**
//!
//! By constitutional rule (EXOCHAIN "never stub" doctrine), every public
//! entry point refuses to execute unless the opt-in Cargo feature
//! `unaudited-pedagogical-proofs` is enabled. Callers who accidentally
//! depend on this crate will fail loudly with
//! [`error::ProofError::UnauditedImplementation`] instead of silently
//! trusting a fake proof.
//!
//! When a production-hardened proof backend lands, remove the feature
//! flag and delete the `UnauditedImplementation` variant.
//!
//! ## Modules
//!
//! - R1CS circuit abstraction (`circuit`)
//! - SNARK proof generation/verification (`snark`) — skeleton
//! - STARK proof system (`stark`) — skeleton
//! - Zero-knowledge ML verification (`zkml`) — skeleton
//! - Unified proof verifier (`verifier`)
//!
//! ## Usage
//!
//! ```toml
//! # Cargo.toml — for tests/demos only
//! [dependencies]
//! exo-proofs = { path = "...", features = ["unaudited-pedagogical-proofs"] }
//! ```
//!
//! Without the feature, every call returns `Err(UnauditedImplementation)`.
//! This is intentional.

#![cfg_attr(test, allow(clippy::expect_used, clippy::unwrap_used))]

pub mod circuit;
pub mod error;
pub mod snark;
pub mod stark;
pub mod verifier;
pub mod zkml;

/// Internal guard used by every public entry point. Returns an error
/// unless the `unaudited-pedagogical-proofs` feature is enabled.
#[doc(hidden)]
#[inline]
pub fn guard_unaudited(api: &'static str) -> Result<(), error::ProofError> {
    #[cfg(feature = "unaudited-pedagogical-proofs")]
    {
        let _ = api;
        Ok(())
    }
    #[cfg(not(feature = "unaudited-pedagogical-proofs"))]
    {
        Err(error::ProofError::UnauditedImplementation { api })
    }
}