walletkit_core/
lib.rs

1//! `walletkit-core` contains the basic primitives for using a World ID.
2//! It enables basic usage of a World ID to generate ZKPs using different credentials.
3//!
4//! # Examples
5//! ```rust
6//! use walletkit_core::{proof::ProofContext, CredentialType, Environment, world_id::WorldId};
7//! async fn example() {
8//!     let world_id = WorldId::new(b"not_a_real_secret", &Environment::Staging);
9//!     let context = ProofContext::new("app_ce4cb73cb75fc3b73b71ffb4de178410", Some("my_action".to_string()), None, CredentialType::Orb);
10//!     let proof = world_id.generate_proof(&context).await.unwrap();
11//!     println!("{}", proof.to_json().unwrap()); // the JSON output can be passed to the Developer Portal, World ID contracts, etc. for verification
12//! }
13//! ```
14#![deny(
15    clippy::all,
16    clippy::pedantic,
17    clippy::nursery,
18    missing_docs,
19    dead_code
20)]
21
22use strum::EnumString;
23
24/// Represents the environment in which a World ID is being presented and used.
25///
26/// Each environment uses different sources of truth for the World ID credentials.
27///
28/// More information on testing for the World ID Protocol can be found in: `https://docs.world.org/world-id/quick-start/testing`
29#[derive(Debug, Clone, PartialEq, Eq, EnumString)]
30#[cfg_attr(feature = "ffi", derive(uniffi::Enum))]
31#[strum(serialize_all = "lowercase")]
32pub enum Environment {
33    /// For testing purposes ONLY.
34    Staging,
35    /// Live production environment. World ID Tree: `id.worldcoin.eth`
36    Production,
37}
38
39mod credential_type;
40pub use credential_type::CredentialType;
41
42/// Contains error outputs from `WalletKit`
43pub mod error;
44
45/// Contains logging functionality that can be integrated with foreign language bindings.
46pub mod logger;
47
48/// Contains all components to interact and use a World ID
49pub mod world_id;
50
51/// This module handles World ID proof generation
52pub mod proof;
53
54/// This module exposes helper functions to interact with common apps & contracts related to the World ID Protocol.
55#[cfg(feature = "common-apps")]
56pub mod common_apps;
57
58mod u256;
59pub use u256::U256Wrapper;
60
61////////////////////////////////////////////////////////////////////////////////
62// Private modules
63////////////////////////////////////////////////////////////////////////////////
64
65mod merkle_tree;
66mod request;
67
68#[cfg(feature = "ffi")]
69uniffi::setup_scaffolding!("walletkit_core");
walletkit_core/lib.rs

walletkit_core/
lib.rs
