An end-to-end, self-contained demo of the Polygon ID JS SDK.
It shows the following setup and interactions between 3 entities: a credential issuer, a holder (aka user), and a verifier:
- key and identity creation for issuer and holder
- issuer issues a requested credential to holder
- verifier presents an authorization request with a given query (e.g. is user an adult?)
- holder responds to the request:
- holder selects a matching credential (e.g. KYC Age credential with birthday prior to 21 years ago)
- holder generates a Zero Knowledge Proof that the query is satisfied, revealing no private details
- holder sends the response as a JWZ token to the verifier
Note that the verifier and issuer do not communicate directly, though credential revocations are managed using a shared Revocation Hash Service.
npm i
Place the compiled circuits and keys under app/circuits
. You can download the latest files from https://iden3-circuits-bucket.s3.eu-west-1.amazonaws.com/latest.zip.
Or check instructions at https://github.com/iden3/polygonid-js-sdk-examples
For convenience, you can run:
npm run circuits:download
npm run circuits:extract
rm ./circuits.zip
Copy .env.example
to .env
and edit it.
To create a random value for SESSION_SECRET
, you can use:
node -p 'Math.random().toString(36).slice(2)'
See also app/config.server.ts
, where these are used.
Reference: https://cloud.google.com/build/docs/build-push-docker-image
# first time setup
brew install google-cloud-sdk # on Mac
gcloud init
gcloud components install kubectl
gcloud builds submit --region=europe-west1 --tag europe-west1-docker.pkg.dev/$GCLOUD_ORG_ID/polygon-id-js-sdk-demo/$IMAGE_NAME_FOR_SERVER
Example IMAGE_NAME_FOR_SERVER
: v0.2-20230421-for-server:tag1
.
A Docker image named <IMAGE_NAME_FOR_SERVER>
is built from the Dockerfile
and pushed to the Artifact Registry. Then, in the k8s.yaml
file, replace the image name defined aboved in spec.template.spec.containers.image
and execute:
kubectl apply -f k8s.yaml
To list the deployed pod(s):
kubectl get pod --namespace=github-polygon
To show detailed info for the pod:
kubectl get pod <POD_NAME> --namespace=github-polygon
This is built using the Remix Run framework's Indie Stack.
The remainder of this document describes the example blog app from which this demo was derived. The blog and post routes have been deleted, but the user routes and and password management remain.
- Fly app deployment with Docker
- Production-ready SQLite Database
- Healthcheck endpoint for Fly backups region fallbacks
- GitHub Actions for deploy on merge to production and staging environments
- Email/Password Authentication with cookie-based sessions
- Database ORM with Prisma
- Styling with Tailwind
- End-to-end testing with Cypress
- Local third party request mocking with MSW
- Unit testing with Vitest and Testing Library
- Code formatting with Prettier
- Linting with ESLint
- Static Types with TypeScript
-
This step only applies if you've opted out of having the CLI install dependencies for you:
npx remix init
-
Initial setup: If you just generated this project, this step has been done for you.
npm run setup
-
Start dev server:
npm run dev
This starts your app in development mode, rebuilding assets on file changes.
The database seed script creates a new user with some data you can use to get started:
- Email:
[email protected]
- Password:
racheliscool
This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Prisma and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes.
- creating users, and logging in and out ./app/models/user.server.ts
- user sessions, and verifying them ./app/session.server.ts
- creating, and deleting notes ./app/models/note.server.ts
This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments.
Prior to your first deployment, you'll need to do a few things:
-
Sign up and log in to Fly
fly auth signup
Note: If you have more than one Fly account, ensure that you are signed into the same account in the Fly CLI as you are in the browser. In your terminal, run
fly auth whoami
and ensure the email matches the Fly account signed into the browser. -
Create two apps on Fly, one for staging and one for production:
fly apps create blog-tutorial-9ac7 fly apps create blog-tutorial-9ac7-staging
Note: Make sure this name matches the
app
set in yourfly.toml
file. Otherwise, you will not be able to deploy.- Initialize Git.
git init
-
Create a new GitHub Repository, and then add it as the remote for your project. Do not push your app yet!
git remote add origin <ORIGIN_URL>
-
Add a
FLY_API_TOKEN
to your GitHub repo. To do this, go to your user settings on Fly and create a new token, then add it to your repo secrets with the nameFLY_API_TOKEN
. -
Add a
SESSION_SECRET
to your fly app secrets, to do this you can run the following commands:fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app blog-tutorial-9ac7 fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app blog-tutorial-9ac7-staging
If you don't have openssl installed, you can also use 1password to generate a random secret, just replace
$(openssl rand -hex 32)
with the generated secret. -
Create a persistent volume for the sqlite database for both your staging and production environments. Run the following:
fly volumes create data --size 1 --app blog-tutorial-9ac7 fly volumes create data --size 1 --app blog-tutorial-9ac7-staging
Now that everything is set up you can commit and push your changes to your repo. Every commit to your main
branch will trigger a deployment to your production environment, and every commit to your dev
branch will trigger a deployment to your staging environment.
The sqlite database lives at /data/sqlite.db
in your deployed application. You can connect to the live database by running fly ssh console -C database-cli
.
If you run into any issues deploying to Fly, make sure you've followed all of the steps above and if you have, then post as many details about your deployment (including your app name) to the Fly support community. They're normally pretty responsive over there and hopefully can help resolve any of your deployment issues and questions.
We use GitHub Actions for continuous integration and deployment. Anything that gets into the main
branch will be deployed to production after running tests/build/etc. Anything in the dev
branch will be deployed to staging.
We use Cypress for our End-to-End tests in this project. You'll find those in the cypress
directory. As you make changes, add to an existing file or create a new file in the cypress/e2e
directory to test your changes.
We use @testing-library/cypress
for selecting elements on the page semantically.
To run these tests in development, run npm run test:e2e:dev
which will start the dev server for the app as well as the Cypress client. Make sure the database is running in docker as described above.
We have a utility for testing authenticated features without having to go through the login flow:
cy.login();
// you are now logged in as a new user
We also have a utility to auto-delete the user at the end of your test. Just make sure to add this in each test file:
afterEach(() => {
cy.cleanupUser();
});
That way, we can keep your local db clean and keep your tests isolated from one another.
For lower level tests of utilities and individual components, we use vitest
. We have DOM-specific assertion helpers via @testing-library/jest-dom
.
This project uses TypeScript. It's recommended to get TypeScript set up for your editor to get a really great in-editor experience with type checking and auto-complete. To run type checking across the whole project, run npm run typecheck
.
This project uses ESLint for linting. That is configured in .eslintrc.js
.
We use Prettier for auto-formatting in this project. It's recommended to install an editor plugin (like the VSCode Prettier plugin) to get auto-formatting on save. There's also a npm run format
script you can run to format all files in the project.