Crate world_id_primitives 

This crate contains the raw base types (without implementation) for the World ID Protocol.

It implements basic primitives such as field elements, proofs, the format of requests and responses, etc.

Importantly, this crate keeps dependencies to a minimum and does not implement any logic beyond serialization and deserialization.

Re-exports

pub use credential::Credential;

pub use credential::CredentialVersion;

pub use proof::WorldIdProof;

Modules

authenticator

Contains types related to the Authenticator.

circuit_inputs

Contains the raw circuit input types for the World ID Protocol.

credential

Base definition of a “Credential” in the World ID Protocol.

merkle

Contains base types for operations with Merkle trees.

oprf

Contains types specifically related to the OPRF services.

proof

Contains the quintessential proof type.

rp

Contains types specifically related to relying parties.

serde_utils

Serialization utilities for consistent hex encoding across the protocol.

sponge

SAFE-style sponge utilities and helpers.

Structs

Config

Global configuration to interact with the different components of the Protocol.

FieldElement

Represents a field element of the base field (Fq) in the World ID Protocol.

Enums

PrimitiveError

Generic errors that may occur with basic serialization and deserialization.

Constants

TREE_DEPTH

The depth of the Merkle tree used in the World ID Protocol for the WorldIDRegistry contract.

Type Aliases

ScalarField

The scalar field used in the World ID Protocol.