https://github.com/vpavlin/perun
https://github.com/vpavlin/perun
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vpavlin/perun
- Owner: vpavlin
- License: mit
- Created: 2023-11-03T16:04:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-05T11:33:55.000Z (over 1 year ago)
- Last Synced: 2025-01-23T03:45:08.255Z (4 months ago)
- Language: TypeScript
- Homepage: https://perun.vercel.app
- Size: 5.3 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Perun - Privacy-Enabled Running App
Introducing Perun, the Privacy-Enabled Running App, where your personal data remains as hidden as the secrets of an ancient, mystical forest. Just as the Slavic god Perun protected the enigmatic Dark Forest, our app safeguards your running data with the utmost care. Your runs, routes, and achievements are yours and yours alone, hidden from prying eyes. With Perun, you can explore the world, keep your privacy intact, and run with the confidence that your data is as secure as the secrets of the universe's cosmic dark forest.
* Go for a run with [perun.vercel.app](http://perun.vercel.app/)
* Watch the [video](https://www.youtube.com/watch?v=WF2rh0EYK0o)
* Enjoy our [pitch deck](https://docs.google.com/presentation/d/1_LVesAwXZBD1TXg7vTo4KNkaReKcfJ_AbxxmZSW-8EQ/edit#slide=id.g1ea7ee2b0a5_4_24)
## Motivation
We, the runners, willingly share private information (our precise location at precise times, our physical condition including detailed output from medical devices) with centralized third party companies while having no control over our data.
Apart from that, there are other risks, like revealing "hot spots" of activity in places where there should be none, like [secret military bases](https://www.theguardian.com/world/2018/jan/28/fitness-tracking-app-gives-away-location-of-secret-us-army-bases).
We belive our data should be considered private by default and only revieled based on our own consideration and decision.
At the same time we understand that people are competitive and for that, they need to be able to verifiably produce a reasonable level of aggregated outputs about their activities - to share with friends, colleages or simply for themselves as a badge of honor and achievement.
We would also like introduce privacy into group runs where only the runner is responsible for revealing the participation. At the same time we see the importance of being able to show the attendance for the organizers - to gain sponsors or future participants.
For that we are proposing and showcasing a privacy enabled (and focused) run tracker.
## Main features
* Track your run with live map updates and detailed run overview after it is finished
* No data uploads to third party servers
* All data stored locally on your device(s)
* Secure pairing and synchronization over [Waku](https://waku.org)
* Proof-of-Run allowing you to share verified statistics from your runs
## Future features
* Privacy preserving group runs
* NFT/POAP minting with Proof-of-Run (for single and group runs)
* ZK or iExec based proof generation
* Leaderboards
## Integrated Sponsors
* WalletConnect - to be able to interact with iExec DataProtector
* iExec DataProtector and Confidential Computing - to be able to process data securely and confidentially without revealing them to 3rd parties
* CoreDAO - to mint NFT based on Proof-of-Run
## Proposed Solutions & Encountered Problems
Since we were not able to leverage any ZK technology to generate Proof-of-Run, we wanted to rely on iExec DataProtector and iExec task. The workflow would be as follows:
### Prerequisities
* A task [Docker image is created](./iexec/), pushed and deployed on iExec platform.
* A prover key is uploaded to [SMS](https://protocol.docs.iex.ec/for-developers/confidential-computing/access-confidential-assets).
### Flow
* User uses the app to track a run
* User connects a wallet via Web3Modal
* User requests a proof-of-run
* Run log (GPS coordinates + metadata) is uploaded to DataProtector (using the connected wallet) to not reveal any data to third parties
* A task is executed
* Task fetches the run log from DataProtector
* Processes the data and generates a proof-of-run object
* In the post-TEE section of the task, the proof is signed by a prover account (the prover PrivateKey is fetched from SMS)
* User recieves the signed Proof-of-Run without revealing the data to a third party
* User can mint an NFT which has the Proof-of-Run attached
### Problems
* The Web3Modal integration has been done mainly to be able to communicate (and sign transactions) for iEXEC DataProtector, but that sadly did not work out
* Would were not able to deploy our task due to a need to [sconify](https://protocol.docs.iex.ec/for-developers/confidential-computing/choose-your-tee-framework/create-your-first-sgx-app) the image - which was, based on discussion with iEXEC representatives, not possible during the hackathon
* We could not use DataProtector SDK due to conflicting verions of `ethers.js` package
* Even if the above were resolved, we were not able to find a flow how to execute the task from browser (i.e. upon user request to generate the proof)
* We could not get the NFT minting working due to issues with contract deployment and function execution on CoreDAO
## Run the App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).