mirror of
https://github.com/selfxyz/self.git
synced 2026-01-09 14:48:06 -05:00
104 lines
5.9 KiB
Markdown
104 lines
5.9 KiB
Markdown
|
|
|
|
Monorepo for Self.
|
|
|
|
Self is an identity wallet that lets users generate privacy-preserving proofs from government-issued IDs such as passports, ID cards, and Aadhaar cards.
|
|
By scanning the NFC chip in their ID document, users can prove their validity while only revealing specific attributes such as age, nationality or simply humanity.
|
|
Under the hood, Self uses zk-SNARKs to make sure personal data is redacted, but the document is verified.
|
|
|
|
Use cases unlocked include:
|
|
|
|
- **Airdrop protection**: Protect a token distribution from bots
|
|
- **Social media**: Add humanity checks to user's profiles
|
|
- **Quadratic funding**: Prevent farmers from skewing rewards
|
|
- **Wallet recovery**: Safeguard assets using IDs as recovery sources
|
|
- **Compliance**: Check a user is not part of a sanctioned entity list
|
|
|
|
Currently, Self supports electronic passports, biometric ID cards following the ICAO standards, and Aadhaar cards. Support for new identity documents is on the way!
|
|
|
|
[Checkout the docs](https://docs.self.xyz/) to add Self to your project.
|
|
|
|
## FAQ
|
|
|
|
#### Is my document supported?
|
|
|
|
**Passports:** Biometric passports have the [biometric passport logo](https://en.wikipedia.org/wiki/Biometric_passport) on their front cover.
|
|
|
|
**Aadhaar:** Indian [Aadhaar](https://en.wikipedia.org/wiki/Aadhaar) cards are supported for privacy-preserving identity verification. Use the mAadhaar app to generate a QR code and import it into Self.
|
|
|
|
**Coverage:** Checkout our [coverage map here](http://map.self.xyz/) to see supported documents and countries.
|
|
|
|
#### What can I request/prove with Self?
|
|
|
|
When a country issues a passport or a compliant ID document, they sign datagroups that include at least:
|
|
|
|
- First and last name
|
|
- Nationality
|
|
- Date of birth
|
|
- Gender
|
|
- Expiration date
|
|
- Passport number
|
|
- Photo
|
|
|
|
Applications are able to request each of those data points.
|
|
|
|
#### What is the signature algorithm ?
|
|
|
|
Countries use different signature algorithms to sign ID documents. Check out our [coverage map](http://map.self.xyz/) to see which.
|
|
|
|
#### Where can I find the countries' public keys ?
|
|
|
|
The main list of public keys can be downloaded from the [ICAO website](https://download.pkd.icao.int/). We use multiple lists published by different ICAO members.
|
|
|
|
#### What's the ICAO ?
|
|
|
|
The International Civil Aviation Organization (ICAO) is a specialized agency of the United Nations. Among other things, they establish the specifications for passports, that have to be followed by all countries. The full passport specs are available [here](https://www.icao.int/publications/pages/publication.aspx?docnum=9303).
|
|
|
|
## Project Ideas
|
|
|
|
- Combine Self with other identification mechanisms as in [Vitalik's pluralistic identity regime](https://vitalik.eth.limo/general/2025/06/28/zkid.html).
|
|
- Help adding support for other identity documents to Self, such as [Japan's my number cards](https://github.com/MynaWallet/monorepo) or [Taiwan DID](https://github.com/tw-did/tw-did/).
|
|
- Build a social network/anonymous message board for people from one specific country.
|
|
- Create a sybil-resistance tool to protect social networks against spambots.
|
|
- Build an airdrop farming protection tool.
|
|
- Allow DeFi protocols to check if the nationality of a user is included in a set of forbidden states.
|
|
- Gate an adult content website to a specific age.
|
|
- Create a petition system or a survey portal.
|
|
- Passport Wallet: use [active authentication](<https://en.wikipedia.org/wiki/Biometric_passport#:~:text=Active%20Authentication%20(AA),Using%20AA%20is%20optional.>) to build a wallet, a multisig or a recovery module using passport signatures
|
|
|
|
We provide bounties for new and interesting applications using Self.
|
|
|
|
## Development Setup
|
|
|
|
This project requires **Node.js 22.x**. Use the included `.nvmrc` to match the version.
|
|
|
|
Run `yarn install` to bootstrap dependencies and husky hooks.
|
|
Gitleaks will scan staged changes on each commit via `yarn gitleaks`.
|
|
|
|
## Development Documentation
|
|
|
|
> **Note:** We do not accept text-only pull request changes. While we appreciate the feedback, we will not merge external pull requests that only modify markdown files or code comments (e.g., typo fixes in documentation or comments). Pull requests must include functional code changes.
|
|
|
|
For detailed development patterns and conventions, see:
|
|
|
|
- **[Development Patterns](docs/development-patterns.md)** - React Native architecture, navigation, state management, and code organization
|
|
- **[Testing Guide](docs/testing-guide.md)** - Jest configuration, mock patterns, testing strategies, and E2E testing
|
|
|
|
These guides provide comprehensive context for AI-assisted development with ChatGPT Codex, Cursor, and CodeRabbit AI.
|
|
|
|
## Contributing
|
|
|
|
We are actively looking for contributors. Please check the [open issues](https://github.com/selfxyz/self/issues) if you don't know where to start! We offer bounties for significant contributions.
|
|
|
|
> **Important:** Please read and follow the guidelines in [contribute.md](contribute.md) when opening your pull request.
|
|
|
|
## Contact us
|
|
|
|
- [Discord](https://discord.gg/AQ3TrX6dce) for technical support or reporting a bug.
|
|
- [Telegram's Self builder channel](https://t.me/selfprotocolbuilder) for technical questions about the sdk implementation.
|
|
- [Telegram's Self public group](https://t.me/selfxyz) for general questions and updates.
|
|
|
|
Thanks [Rémi](https://github.com/remicolin), [Florent](https://github.com/0xturboblitz), [Ayman](https://github.com/Nesopie), [Justin](https://github.com/transphorm), [Seshanth](https://github.com/seshanthS), [Nico](https://github.com/motemotech) and all other contributors for building Self.
|
|
|
|
Thanks [Aayush](https://twitter.com/yush_g), [Vivek](https://twitter.com/viv_boop), [Andy](https://twitter.com/AndyGuzmanEth) and [Vitalik](https://github.com/vbuterin) for contributing ideas and inspiring us to build this technology, and [PSE](https://pse.dev/) for supporting the initial work through grants!
|