Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/worldcoin/world-id-lens
Human verification for Lens Protocol with World ID.
https://github.com/worldcoin/world-id-lens
managed-by-terraform
Last synced: about 1 month ago
JSON representation
Human verification for Lens Protocol with World ID.
- Host: GitHub
- URL: https://github.com/worldcoin/world-id-lens
- Owner: worldcoin
- License: mit
- Created: 2022-05-18T20:08:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-27T22:15:14.000Z (7 months ago)
- Last Synced: 2023-11-27T23:30:51.488Z (7 months ago)
- Topics: managed-by-terraform
- Language: Solidity
- Homepage:
- Size: 859 KB
- Stars: 86
- Watchers: 13
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-lens-protocol - World ID Lens - Human verification for Lens Protocol with World ID. (Projects / Open Source)
README
# Human verification for Lens
Assert your Lens profile belongs to an actual human through Worldcoin's [World ID](https://id.worldcoin.org) protocol.
## âšī¸ About
This repository contains the **smart contract** that enables verification of [Lens Protocol](https://lens.xyz) profiles as owned by a unique human.
- The verification is always exposed on-chain.
- Human verification is done via the [World ID](https://id.worldcoin.org) protocol.
- A single human can only have one verified Lens profile. Verifying a new profile will remove the verification from the previous profile.
## đ Deployment
The official World ID <> Lens smart contract can be found at `0x8f9b3A2Eb1dfa6D90dEE7C6373f9C0088FeEebAB` on the Polygon Network. To deploy your own version of this contract, follow these instructions.
1. Get an Action ID from Worldcoin's [Developer Portal](https://developer.worldcoin.org).
2. Run `make`, then `make deploy`.
## đ§âđģ Development & testing
1. Install [Foundry](https://github.com/gakonst/foundry).
```sh
curl -L https://foundry.paradigm.xyz | bash
foundryup # run on a new terminal window; installs latest version
```
2. Install [Node.js](https://nodejs.org/en/) v16 or above (required for tests). We recommend [nvm](https://github.com/nvm-sh/nvm) if you use multiple node versions.
3. Install dependencies & build smart contracts
```sh
make
```
4. Run tests
```sh
make test
```
### Using the contract
To test the contract with your own deployment, we recommend you use World ID's [Staging network](https://id.worldcoin.org/test),
1. Point your smart contract to the World ID's Staging network contract, which can be found at https://developer.worldcoin.org/api/v1/contracts.
2. Register an identity as "verified" using Worldcoin's [Simulator](https://simulator.worldcoin.org). Be sure to click on **verify identity.**
3. Use the hosted World ID's widget & the Simulator to generate a ZKP to execute the humanity check.
- Easiest way is to visit `https://id.worldcoin.org/use?action_id={your_action_id}&signal={lensProfileId}&return_to=https%3A%2F%2Flocalhost%3A8000`
- When you click on the widget you'll get a QR code, copy it and paste it in the simulator.
- After going through the process on the Simulator, you'll get the proof, nullifier hash & Merkle root in your return URL (as query string parameters).
4. Call `HumanCheck.verify(PROFILE_ID, merkle_root, nullifier_hash, proof)` in your contract. The last three parameters are obtained on step 6.
5. You can now check your profile is verified by calling `HumanCheck.isVerified(PROFILE_ID)`.