Skip to content

rutefig/proof-of-residency

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Proof of Residency

Proof of Residency enables users to generate a verifiable proof of residency from a pdf with an ATCud-signed utility bill (available in Portugal). The project leverages cryptographic techniques to preserve privacy, ensuring that while the country of residence is publicly verifiable, sensitive details like the specific address remain private.

By relying on trusted email sources—such as government communications, utility bills, or legal contracts, this project minimizes reliance on traditional and invasive verification methods.

Features

  • Privacy preservation: Keeps specific address details private while publicly verifying only the country of residence.
  • Recipient verification: Ensures the email recipient is the individual proving residency.
  • Onchain: Supports cryptographic proofs and decentralized validation.

How it works

Components

The Proof of Residency project employs the following technologies:

  • ATCud signature for documents
  • SP1: Extracts and verifies document signatures from emails with attached PDFs; generates proof.
  • Hylé: Adds verifiability to residency proofs.

Step by step

  1. Submit a valid bill: Upload an valid pdf (e.g., a utility bill or government communication) as proof of residence.
  2. Generate proof: Use the system to parse attached PDFs, extract necessary data, and generate a privacy-preserving proof of residency.
  3. Share the proof: Provide verifiable proof to third parties while keeping sensitive details private.

How to install and run

  1. Clone Hylé and start a single node devnet

  2. Build the prover

     cd prover
     cargo build --all --release
  3. Run the server

     cd ../server
     cargo run
  4. Run the client (in another terminal)

     cd web
     npm run dev

Contributing

Contributions are welcome! To get started:

  • Fork this repository.
  • Create a feature branch for your changes.
  • Submit a pull request detailing your improvements.

Sponsor

This project is supported by Hylé, the lean blockchain for your provable apps.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages