Expand description
The core library for the World ID Protocol.
Read more in: https://docs.world.org/world-id
Re-exports§
pub use oprf::ProofError;
Modules§
- account_
registry - This module allows interactions with the
AccountRegistry. - oprf
- vOPRF (Verifiable Threshold Oblivious Pseudorandom Function) client implementation.
- primitives
- Re-export of all the World ID primitives
- proof
- Internal proof generation for the World ID Protocol.
- types
- Generic re-usable types
Structs§
- Authenticator
- An Authenticator is the base layer with which a user interacts with the Protocol.
- Credential
- Base representation of a
Credentialin the World ID Protocol. - EdDSA
Private Key - A private key for the EdDSA signature scheme.
- EdDSA
Public Key - A public key for the EdDSA signature scheme over the BabyJubJubCurve.
- EdDSA
Signature - An EdDSA signature on the Baby Jubjub curve, using Poseidon2 as the internal hash function for the Fiat-Shamir transform.
- Field
Element - Represents a field element of the base field (
Fq) in the World ID Protocol.
Enums§
- Authenticator
Error - Errors that can occur when interacting with the Authenticator.
- Credential
Version - Version of the
Credentialobject
Traits§
- Hashable
Credential - Introduces hashing and signing capabilities to the
Credentialtype. - Onchain
KeyRepresentable - A trait for types that can be represented as a
U256on-chain.