Skip to content
This repository has been archived by the owner on Mar 7, 2024. It is now read-only.

Commit

Permalink
Merge pull request #70 from 0xPolygonID/quick-start-demo
Browse files Browse the repository at this point in the history
add Quick Start demo
  • Loading branch information
cerberushades authored Jul 19, 2023
2 parents 39c4179 + f0076a4 commit 5806a56
Show file tree
Hide file tree
Showing 20 changed files with 159 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added mkdocs/docs/imgs/quick-start-demo/new-schema.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added mkdocs/docs/imgs/quick-start-demo/qr-code.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
156 changes: 156 additions & 0 deletions mkdocs/docs/quick-start-demo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
This tutorial is a quick demonstration of some of Polygon ID's main functionalities. To illustrate how Polygon ID works, we will walk you through some of its products and tools by following along a simple POAP use case.
POAP stands for Proof of Attendance Protocol, which is used to prove that someone has taken part in a given event.

This guide will briefly touch on the 3 roles of the [Triangle of Trust](index.md#core-concepts-of-polygon-id-verifiable-credentials-identity-holder-issuer-and-verifier-triangle-of-trust), namely the Identity Holder, the Issuer and the Verifier. For that, we will take the case of an individual who needs to prove that they were able to participate in a particular event.

These are the steps we will cover in this article:

1. [Set up a Polygon ID wallet](#set-up-a-polygon-id-wallet)
2. [Issue a new credential to attest to the ID Holder's attendance to the event](#issue-a-new-credential-to-attest-to-the-id-holders-age)
3. [Fetch the newly created credential](#fetch-the-newly-created-credential)
4. [Verify the credential validity](#verify-the-credential-validity)

## Set up a Polygon ID wallet
As an Identity Holder, the individual who wants to have a credential to prove his age, for example, will need an application that can hold their credentials. In our case, we will be using the Polygon ID Wallet.

!!!note
You can also use any Polygon ID compatible wallet. Please, check our [Ecosystem page](https://ecosystem.polygon.technology/PolygonID/) for other options.

To get started with the Polygon ID Wallet, download the Polygon ID Wallet App and create an Identity:

- For Android: <a href="https://play.google.com/store/apps/details?id=com.polygonid.wallet" target="_blank">Polygon ID on Google Play</a>
- For iOS: <a href="https://apps.apple.com/us/app/polygon-id/id1629870183" target="_blank">Polygon ID on the App Store</a>

!!!note
Polygon ID wallet is an implementation of the Wallet SDK, as a way of showcasing its possibilities. Head to [the Polygon ID SDK documentation](./wallet/wallet-sdk/polygonid-sdk/polygonid-sdk-overview.md) to know more about how it works.

The process from downloading to creating an identity on the Polygon ID Wallet is just as it is shown below. You need to download the app, create a wallet, set up a PIN number and the wallet is ready to be used.

![Quick start demo wallet](./imgs/quick-start-demo/quick-start-demo-wallet.png)

!!!warning
This demo is using Polygon's Mumbai testnet. Go to the gear icon at the top right and ensure "Polygon Mumbai" is selected instead of "Polygon Main".
<div align="center">
<img width="300" src="../imgs/quick-start-demo/settings-mumbai.jpeg"></img>
</div>

## Issue a new credential to attest to the ID Holder's event attendance
A trusted entity, for instance, a private institution will now play the role of an issuer. It will be responsible for creating the credential and sending it to the ID Holder.

We are using a testing environment to manage credentials: [https://issuer-ui.polygonid.me](https://issuer-ui.polygonid.me). This is the place where the trusted entity can create credentials, manage schemas and generate connections.

However, if you are using a new credential type, you actually need to create a schema for that credential, which basically is the set of JSON files that gather all the attributes of that specific credential.

To facilitate this issuance process, we have already created the credential schema whose URLs are the following:

- JSON schema URL
`ipfs://QmTSwnuCB9grYMB2z5EKXDagfChurK5MiMCS6efrRbsyVX`
- JSON-LD Context
`ipfs://QmdH1Vu79p2NcZLFbHxzJnLuUHJiMZnBeT7SNpLaqK7k9X`

!!!note
To learn how to set up your own issuer environment by deploying an issuer node, visit the [Issuer section in the documentation](./issuer/issuer-overview.md).

!!!info
Learn more about creating new schemas on the [Schema Builder UI guide](./issuer/schema-builder.md)

### Issue the credential
With the new schema in hand, the issuer should now be able to generate a credential.

1. First, go to the [Issuer Node UI testing environment](https://issuer-ui.polygonid.me).

Provide the following login data:

- user: `user-ui`
- password: `password-ui`

!!!warning
This Issuer Node is publicly available and used only for testing purposes. Do not use personal or sensitive data. All data is deleted every 48 hours.

2. Now you need to import the schema. Click on **Import Schema** and paste our previously generated schema IPFS address `ipfs://QmTSwnuCB9grYMB2z5EKXDagfChurK5MiMCS6efrRbsyVX`:

<div align="center">
<img width="100%" src="../imgs/quick-start-demo/import-schema.png"></img>
</div>

You may preview the schema and then Import it.

3. You can go ahead and click on **Issue Credential** in the top righ-hand corner. Choose **Credential Link** on the next page and your schema on the dropdown menu ("POAP01", in our case). For this credential, we are providing a proof of attendance to an event in Paris:

<div align="center">
<img width="500" src="../imgs/quick-start-demo/create-credential.png"></img>
</div>

4. After you click on **Create Credential Link**, you can also click on **View Link** on the next screen to check the generated QR code.

<div align="center">
<img width="500" src="../imgs/quick-start-demo/qr-code.png"></img>
</div>

## Fetch the newly created credential
Now we are back to the ID Holder role. They will use their mobile application to authenticate themselves by scanning the QR code generated by the issuer in the last step.

<div align="center">
<img width="300" src="../imgs/quick-start-demo/quick-fetch-1.jpeg"></img>
</div>

Connect to the issuer:

<div align="center">
<img width="300" src="../imgs/quick-start-demo/quick-fetch-2.jpeg"></img>
</div>

This will instantly trigger a notification on the mobile which will look like this:

<div align="center">
<img width="300" src="../imgs/quick-start-demo/quick-notification.jpeg"></img>
</div>

Accept the credential:

<div align="center">
<img width="300" src="../imgs/quick-start-demo/quick-fetch-4.jpeg"></img>
</div>

The ID Holder successfully retrieved the credential and it is visible on the app:

<div align="center">
<img width="300" src="../imgs/quick-start-demo/quick-fetch-6.jpeg"></img>
</div>

## Verify the ID holder credential
Here comes the third role in this tutorial: the verifier. This could be represented by an organization that needs to check the accuracy of someone's credentials. In our use case, this organization wants to verify whether the ID holder actually attended our made-up Paris event.

Here are the steps to verify the credential:

1. Visit the [Verifier website](https://verifier-v2.polygonid.me/). As we are using a newly-created credential type, you need to choose **Custom** on the dropdown menu. Click on **Sign In**.

<div align="center">
<img width="600" src="../imgs/quick-start-demo/verifier-lp.png"></img>
</div>

2. Now you will again make use of the JSON-LD URL we have also provided: `ipfs://QmdH1Vu79p2NcZLFbHxzJnLuUHJiMZnBeT7SNpLaqK7k9X`. Here is how the query should look like:

<div align="center">
<img width="600" src="../imgs/quick-start-demo/verifier-query.png"></img>
</div>

3. After clicking on **Submit**, you should scan the resulting QR code and follow the instructions on the mobile app.

<div align="center">
<img width="300" src="../imgs/quick-start-demo/verifier-request.jpeg"></img>
</div>


4. The process of generating the proof is then started:

<div align="center">
<img width="300" src="../imgs/quick-start-demo/verifier-proof.jpeg"></img>
</div>

5. And finally, the proof will be validated by the Verifier.

!!!info
This was a quick demonstration of Polygon ID's basic functionalities. However, Polygon ID is far more complex than this. It offers a range of SSI-focused tools that allow for decentralized identity and verifiable credentials management.


4 changes: 3 additions & 1 deletion mkdocs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ markdown_extensions:
- pymdownx.superfences

nav:
- Home: "index.md"
- Home:
- Overview: "index.md"
- Quick Start Demo: "quick-start-demo.md"
- Issuer:
- Overview: "issuer/issuer-overview.md"
- Issuer Node Core API:
Expand Down

0 comments on commit 5806a56

Please sign in to comment.