sybil-form: A TypeScript repository from dabit3

Sybil Resistant Forms with Gitcoin Passport, EXM, and Next.js

This is full stack forkable project for building Sybil-resistant forms, using the Gitcoin Passport to score users for your app and implement a secure, sybil-resistant, form and EXM (a protocol built on Arweave) for storing the form data.

Gitcoin Passport is a tool that enables developers to build Sybil resistant applications while preserving privacy. The Scorer API used in this example gives developers an easy way of retrieving a wallet's Passport score.

Project Overview

This app consists of two pages:

The landing page (/) will allow users to access the form if they have met the threshold score you require in your app, and they will then be able to submit their form entry. In the server routes (pages/api/post, pages/api/set-nonce) they will be verified again using a wallet signature and a nonce to verify their identity before being able to post.
The Admin route (/admin) will allow a whitelisted array of admins to be able to access the form data securely. If they are an admin, they will be able to view the results, if they are not, they will not be allowed to view the results.

Getting started

Gitcon Passport API variables

To get started, you must first create an environment variable and community using the Gitcoin Scorer API.

You can look through this codebase to see what a simple integration with Gitcoin Passport looks like. For more detailed information check out the documentation.
EXM API Key

You also need to create an EXM API Key and have it ready for the next steps.

Running the app

Clone the repo and install the dependencies:

git clone git@github.com:dabit3/nextjs-gitcoin-passport.git

cd nextjs-gitcoin-passport

npm install

Configure the environment variables for your:

a. Gitcoin Community ID
b. Gitcoin API Key
c. EXM API Key
d. Minimum score for your form

In a file named .env.local. (see example configuration at .example.env.local)
```
NEXT_PUBLIC_GC_API_KEY=<your-api-key>
NEXT_PUBLIC_GC_COMMUNITY_ID=<your-community-id>
EXM_API_KEY=<your-exm-api-key>
NEXT_PUBLIC_THRESHOLD=<your-minimum-score>
```

Deploy the EXM function

export EXM_API_KEY=<your-exm-api-key>

node deploy.js

Run the app
```
npm run dev
```

Next Steps

Once you've gotten a handle on how the integration works, check out some of the following links for more information on how to integrate Gitcoin Passport into your own application.

Getting Involved