Expand description
The core library for the World ID Protocol.
Read more in: https://docs.world.org/world-id
Modules§
- api_
types - Re-export api_types for convenience
- primitives
- Re-export of all the World ID primitives
- proof
- Internal proof generation for the World ID Protocol.
- requests
- Contains request/response types and validation helpers for RP proof requests. Module containing all the functionality to handle requests from Relying Parties (RPs) to Authenticators.
- world_
id_ registry - Re-export registry from authenticator for convenience
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. - Initializing
Authenticator - Represents an account in the process of being initialized,
i.e. it is not yet registered in the
WorldIDRegistrycontract. - Signer
- The inner signer which can sign requests for both on-chain and off-chain operations. Both issuers and authenticators use this.
Enums§
- Authenticator
Error - Errors that can occur when interacting with the Authenticator.
- Credential
Version - Version of the
Credentialobject
Traits§
- Onchain
KeyRepresentable - A trait for types that can be represented as a
U256on-chain.