Expand description
../README.md
Modules§
- defaults
- Default configuration values for each
Environment. - error
- Contains error outputs from
WalletKit - issuers
- Credential issuers for World ID (NFC, etc.) Logic for different specific issuers of Credentials in World ID.
- logger
- Contains logging functionality that can be integrated with foreign language bindings.
- proof_
request_ credential_ constraints_ check - Pre-flight check of whether stored credentials can satisfy a
requests::ProofRequest. Pre-flight check of whether the credential store can satisfy a proof request. - requests
- Proof requests and responses in World ID v4.
- storage
- Credential storage primitives for World ID v4.
- user_
agent - User agent for HTTP requests. User agent for HTTP requests.
Structs§
- Authenticator
- The Authenticator is the main component with which users interact with the World ID Protocol.
- Credential
- A wrapper around
CoreCredentialto enable FFI interoperability. - Field
Element - A wrapper around
FieldElementto enable FFI interoperability. - Groth16
Materials - ZK Proof material for both Groth16 proofs (query & nullifier proofs)
- Initializing
Authenticator - Represents an Authenticator in the process of being initialized.
- Ownership
Proof - A WIP-103 Ownership Proof available to foreign bindings
- Recovery
Data - Identity material derived from a seed for use during account recovery.
- Recovery
Update Signature - The signature and signing nonce returned by
Authenticator::danger_sign_initiate_recovery_agent_update. - User
Agent - Represents a User-Agent string.
- User
Agent Builder - Builds the
UserAgentstring sent as the HTTPUser-Agentheader.
Enums§
- Environment
- Represents the environment in which a World ID is being presented and used.
- Region
- Region for node selection.
- Registration
Status - Registration status for a World ID being created through the gateway.