Request form
WorldCoin Core
  • Identity
  • Protocol
Docs
Source
ChefGPT

Building the world’s largest identity and financial network as a public utility, giving ownership to everyone.

Ownable2StepUpgradeable.sol
OwnableUpgradeable.sol
draft-IERC1822Upgradeable.sol
IBeaconUpgradeable.sol
ERC1967UpgradeUpgradeable.sol
Initializable.sol
UUPSUpgradeable.sol
AddressUpgradeable.sol
ContextUpgradeable.sol
StorageSlotUpgradeable.sol
Ownable.sol
Ownable2Step.sol
draft-IERC1822.sol
IERC1967.sol
IBeacon.sol
ERC1967Proxy.sol
ERC1967Upgrade.sol
Proxy.sol
Address.sol
Context.sol
StorageSlot.sol
Pairing.sol
ISemaphoreVerifier.sol
WorldIDImpl.sol
WorldIDProxy.sol
VerifierLookupTable.sol
IBaseWorldID.sol
IBridge.sol
ITreeVerifier.sol
IWorldID.sol
IWorldIDGroups.sol
CheckInitialized.sol
SemaphoreTreeDepthValidator.sol
UnimplementedTreeVerifier.sol
WorldIDIdentityManager.sol
WorldIDIdentityManagerImplV1.sol
WorldIDIdentityManagerImplV2.sol
WorldIDRouter.sol
WorldIDRouterImplV1.sol

103 downloads

Chains

Authors

WorldCoin Core
  • Identity
  • Protocol
Info
Source
ChefGPT
Expand
Share

Get Cookin'

103 downloads

Authors

World ID Logo

WorldID Semaphore Contracts

These are the underlying contracts that power World ID. If you're looking to integrate with World ID, you should use the Foundry or Hardhat starter kits.

This repository contains the underlying contracts that make World ID work, powered by the Semaphore library. These contracts are responsible for performing identity operations on chain, and attestation of identities for the purposes of semaphore proofs. Check out user-flows.md for more information on how these contracts relate to the rest of the World ID system.

World ID Logo About World ID

World ID is a protocol that lets you prove a human is doing an action only once without revealing any personal data. Stop bots, stop abuse.

World ID uses a device called the Orb which takes a picture of a person's iris to verify they are a unique and alive human. The protocol only requires a hash-equivalent (i.e. irreversible) of the iris to be stored (which happens on a blockchain). The protocol uses Zero-knowledge proofs so no traceable information is ever public.

World ID is meant for on-chain web3 apps, traditional Cloud applications, and even IRL verifications. Go to the World ID app to get started.

Worldcoin Sign In

Privileged Actions and Trust

The WorldID Identity Manager uses a bifurcated notion of privilege in production. This operates as follows:

  • Owner: The owner is responsible for administrating the contract. In production, the contract's owner will be a multi-signature wallet.
  • Identity Operator: The identity operator is responsible for performing identity operations using the contract. In production, the contract's identity operator will be a wallet associated with OpenZeppelin Relay, ensuring that identities are submitted on-chain reliably and in order.

All other contracts use a simple notion of an "owner", that will be held by a multi-signature wallet in production.

What follows below is a table of privileged operations in the WorldID Identity Manager contract, and which of the owner and identity operator has the permission to perform these actions.

OperationPrivilegesDescription
acceptOwnershipNew OwnerAccepts the transfer of ownership.
disableStateBridgeOwnerTurns off the state bridge.
enableStateBridgeOwnerTurns on the state bridge.
registerIdentitiesIdentity OperatorRegisters new identity commitments into the World ID system.
setIdentitiUpdateVerifierLookupTableOwnerSets the table of verifiers used to verify proofs that correspond to identity updates.
setIdentityOperatorOwnerSets the address that has permission to act as the Identity Operator.
setRegisterIdentitiesVerifierLookupTableOwnerSets the table of verifiers used to verify proofs that correspond to identity insertions.
setRootHistoryExpiryOwnerSets the amount of time it takes for a non-current tree root to expire.
setSemaphoreVerifierOwnerSets the contract used to verify semaphore proofs.
setStateBridgeOwnerSets the address of the state bridge. The state bridge is the contract responsible for sending identity tree updates to other chains.
transferOwnershipOwnerTransfers ownership from the current owner to a new owner using a two-step process.
updateIdentitiesIdentity OperatorUpdates existing identity commitments in the World ID system. Updates are able to remove identities as well.
upgradeToOwnerUpgrades the implementation of the identity manager to a new version.
upgradeToAndCallOwnerUpgrades the implementation of the identity manager to a new version and executes a function call while doing so.

While there have been some discussions pertaining to the implementation of timelocks for sensitive actions, many of these actions are required for administrating the contracts in conjunction with external services (such as the signup sequencer). To this end, timelocks would cause problems due to delays that could risk desynchronisation between the contract and external services.

Development

This repository uses the Foundry smart contract toolkit. You can download the Foundry installer by running curl -L https://foundry.paradigm.xyz | bash, and then install the latest version by running foundryup on a new terminal window (additional instructions are available on the Foundry repo). You'll also need Node.js if you're planning to run the automated tests.

Once you have everything installed, you can run make from the base directory to install all dependencies and build the smart contracts.

Testing

The prover service comes with a way to generate test parameters—a mock insertion of a batch of consecutive commitments into the tree. Assuming you've already run make deploy, the prover service binary should have been downloaded. To generate a test batch, run

./mtb/bin/mtb gen-test-params --tree-depth=... --batch-size=...

where the parameters MUST match the parameters passed for contract deployment. To transform these into a proof, run the prove command, passing the params on stdin:

./mtb/bin/mtb prove --keys-file=mtb/keys < GENERATED_PARAMS

The output of this, together with the relevant parts of the generated test params, should constitute a correct input to the registerIdentities method of the Semaphore contract, as long as it was deployed using the same keys file.

Deployment

Deploying the Semaphore contract will require generating a verifier contract for our batch insertion service. Calling make deploy will guide you through the process of downloading the relevant tools, initializing and creating the required contracts.

Building the world’s largest identity and financial network as a public utility, giving ownership to everyone.
Ownable2StepUpgradeable.sol
OwnableUpgradeable.sol
draft-IERC1822Upgradeable.sol
IBeaconUpgradeable.sol
ERC1967UpgradeUpgradeable.sol
Initializable.sol
UUPSUpgradeable.sol
AddressUpgradeable.sol
ContextUpgradeable.sol
StorageSlotUpgradeable.sol
Ownable.sol
Ownable2Step.sol
draft-IERC1822.sol
IERC1967.sol
IBeacon.sol
ERC1967Proxy.sol
ERC1967Upgrade.sol
Proxy.sol
Address.sol
Context.sol
StorageSlot.sol
Pairing.sol
ISemaphoreVerifier.sol
WorldIDImpl.sol
WorldIDProxy.sol
VerifierLookupTable.sol
IBaseWorldID.sol
IBridge.sol
ITreeVerifier.sol
IWorldID.sol
IWorldIDGroups.sol
CheckInitialized.sol
SemaphoreTreeDepthValidator.sol
UnimplementedTreeVerifier.sol
WorldIDIdentityManager.sol
WorldIDIdentityManagerImplV1.sol
WorldIDIdentityManagerImplV2.sol
WorldIDRouter.sol
WorldIDRouterImplV1.sol