Skip to main content

reallyme_zk_api/
lib.rs

1// SPDX-FileCopyrightText: Copyright © 2026 ReallyMe Technologies Limited. All rights reserved
2//
3// SPDX-License-Identifier: MIT OR Apache-2.0
4
5//! Proof-system-agnostic ZK API for ReallyMe identity, protocol, wallet, and policy crates.
6//! Concrete proving backends remain outside this crate.
7//!
8//! Public contracts are grouped by domain. Type names remain descriptive when
9//! imported into applications, and verification state is explicit in each type.
10//! Start with [`circuits`], [`proofs`], and [`claim_bundle`]; use [`common_root`]
11//! or [`persona_evidence`] for the corresponding presentation protocol.
12mod artifact_digest;
13mod bundle;
14mod bundle_statement;
15/// Circuit capabilities and the security properties callers may rely on.
16pub mod capabilities;
17mod circuit;
18mod circuit_registry;
19mod claim_proof_bundle_verification;
20mod common_credential_root;
21mod common_credential_root_active_set;
22mod common_credential_root_active_status;
23mod common_credential_root_attestation;
24mod common_credential_root_claim_commitment;
25mod common_credential_root_credential_binding;
26#[cfg(any(feature = "native", feature = "wasm"))]
27mod common_credential_root_holder_assurance;
28mod common_credential_root_issuer_status;
29mod common_credential_root_joins;
30mod common_credential_root_lineage;
31mod common_credential_root_persona;
32mod common_credential_root_status_snapshot;
33mod common_credential_root_verification;
34mod credential_status_verification;
35mod error;
36mod error_reason;
37/// Authenticated issuer-status sources and credential-status proof contracts.
38pub mod issuer_status;
39mod metadata;
40mod persona_credential_evidence;
41mod persona_credential_evidence_claim_selector;
42mod persona_credential_evidence_credential_binding;
43mod persona_credential_evidence_exports;
44mod persona_credential_evidence_joins;
45mod persona_credential_evidence_public_inputs;
46mod persona_credential_evidence_replay;
47mod persona_credential_evidence_token_authorization;
48mod persona_credential_evidence_verification;
49mod proof;
50mod public_inputs;
51mod public_key;
52mod suite;
53mod traits;
54
55/// Integrity identities for manifests and exact proving-artifact sets.
56#[path = "public_api/artifacts.rs"]
57pub mod artifacts;
58/// Canonical circuit identity, source stages, revisions, and credential hash algorithms.
59#[path = "public_api/circuits.rs"]
60pub mod circuits;
61/// Four-stage claim proof composition, request-bound status, and verification results.
62#[path = "public_api/claim_bundle.rs"]
63pub mod claim_bundle;
64/// Common-credential-root proof composition, joins, commitments, and assurance.
65#[path = "public_api/common_root.rs"]
66pub mod common_root;
67/// Typed, non-sensitive failures shared by ZK operations and transport adapters.
68#[path = "public_api/errors.rs"]
69pub mod errors;
70/// Public-key representations with distinct issuer, persona, and authority roles.
71#[path = "public_api/keys.rs"]
72pub mod keys;
73/// Persona credential evidence, current status, live-auth prerequisites, and replay contracts.
74#[path = "public_api/persona_evidence.rs"]
75pub mod persona_evidence;
76/// Backend-independent proofs, secret witnesses, public inputs, and session bindings.
77#[path = "public_api/proofs.rs"]
78pub mod proofs;