🚧 WIP: world-id-protocol

Caution

This project is work in progress and unaudited. DO NOT USE IN PRODUCTION. Releases may contain breaking changes at any time.

Prerequisites

• Rust toolchain (rustup, cargo) – pinned via rust-toolchain.toml
• Foundry (forge/cast/anvil): curl -L https://foundry.paradigm.xyz | bash then foundryup
• For running the Rust services look at the specific READMEs of each service.

🗃️ Deployments

Warning

These deployments are the current most up-to-date version, but this project is still WIP and deployments may change at any time.

Deployments are tracked in contracts/deployments/

Environment	Chain	Config
Staging	World Chain (480)	contracts/deployments/staging.json

Services

Service	URL
world-id-indexer	https://world-id-indexer.stage-crypto.worldcoin.org
world-id-gateway	https://world-id-gateway.stage-crypto.worldcoin.org

🏗️ Project Structure

This repo is organized into the following top-level components:

• circom/: Circom circuits for zero-knowledge proofs
• contracts/: Solidity smart contracts (see contracts/README.md)
• crates/: Rust libraries providing protocol functionality
• services/: Deployable services (gateway, indexer, oprf-node)
• docs/: Protocol documentation (see docs/README.md)

📦 Crates Organization

The Rust crates are logically separated to ensure proper integration without feature flag conflicts:

world-id-primitives
└── functionality-specific crates
    └── world-id-core

• world-id-primitives: Foundation layer containing only raw types with minimal implementation logic except for hashing mechanisms. Has an optional openapi feature for OpenAPI schema derives.
• Functionality-specific crates: Providing focused use cases for authenticator, issuer, and RP operations.
• world-id-core: Top-level integration layer which exposes all functionality.

🚀 Releasing

Versioning and releases are managed separately for crates and services.

Crates

Crate releases are automated using release-plz.

How it works:

1. Commits to main follow conventional commits. To override the version, simply update the PR.
2. release-plz creates/updates a release PR with:
   • Version bumps in Cargo.toml files
   • Updated CHANGELOG.md for each crate
3. When the release PR is merged:
   • Crates are published to crates.io using trusted publishing
   • GitHub releases are created for each updated crate (e.g., world-id-core-v0.2.0)

Services

Information coming soon.