Skip to content

Commit

Permalink
Merge pull request #166 from 0xPolygonID/brand
Browse files Browse the repository at this point in the history
Branding Change
  • Loading branch information
0xpulkit authored Jun 12, 2024
2 parents 177b315 + e9dbeaa commit ab46f00
Show file tree
Hide file tree
Showing 15 changed files with 296 additions and 159 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<br>

<p align="center">
<img align="center" src="/static/img/polygon-id-logo.svg">
<img align="center" src="/static/img/privado_logo.svg">
</p>

<br>
Expand Down
34 changes: 15 additions & 19 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
id: introduction
title: Introduction to Polygon ID
title: Introduction to Privado iD (prev. Polygon ID)
sidebar_label: Introduction
description: Polygon ID main concepts.
description: Privado iD main concepts.
keywords:
- docs
- polygon id
- privado id
- holder
- issuer
- verifier
Expand All @@ -15,36 +15,32 @@ keywords:

import useBaseUrl from '@docusaurus/useBaseUrl';

<div align="center">
<img src={useBaseUrl("img/logo.svg")} align="center" width="128px"/>
<br /><br />
</div>

Polygon ID’s identity infrastructure facilitates trusted and secure relationships between apps and users, following the principles of self-sovereign identity and privacy by default. Polygon ID enables organizations on one side to issue verifiable credentials about users, and organizations, on the other side, to verify those claims via a suite of tools created for each member of the SSI ecosystem.
Privado iD’s identity infrastructure facilitates trusted and secure relationships between apps and users, following the principles of self-sovereign identity and privacy by default. Privado iD enables organizations on one side to issue verifiable credentials about users, and organizations, on the other side, to verify those claims via a suite of tools created for each member of the SSI ecosystem.

## Why Polygon ID?
## Why Privado iD?

Polygon ID, with the help of zero-knowledge proofs, lets users prove their identity without the need of exposing their private information. This ensures both the **Freedom of Expression** and **Privacy by Default** (user's identities are secured by zero-knowledge cryptography).
Privado iD, with the help of zero-knowledge proofs, lets users prove their identity without the need of exposing their private information. This ensures both the **Freedom of Expression** and **Privacy by Default** (user's identities are secured by zero-knowledge cryptography).

## Core Concepts of Polygon ID: Verifiable Credentials, Identity Holder, Issuer and Verifier
## Core Concepts of Privado iD: Verifiable Credentials, Identity Holder, Issuer and Verifier

Every identity is identified by a unique identifier called [DID (Decentralized Identifier)](https://www.w3.org/TR/did-core/). Every identity-based information is represented via [Verifiable Credentials (VCs)](https://www.w3.org/TR/vc-data-model/). In the simplest terms, a VC represents any type of information related to an individual/enterprise/object. The VC could be as simple as the age of the entity or the highest degree held by it. It could also be a membership certificate issued by a DAO, for instance.

:::note

The toolset made available by Polygon ID is fully compliant with the W3C standards. We have a [<ins>definition spec. for the Polygon ID DID method</ins>](https://github.com/0xPolygonID/did-polygonid).
The toolset made available by Privado iD (prev. Polygon ID) is fully compliant with the W3C standards. We have a [<ins>definition spec. for the Polygon ID DID method</ins>](https://github.com/0xPolygonID/did-polygonid).

:::

The architecture of the framework is composed of three modules: Identity Holder, Issuer, and Verifier. These three, together, form what we call the **Triangle of Trust**. Let us see what role each entity plays in Polygon ID.
The architecture of the framework is composed of three modules: Identity Holder, Issuer, and Verifier. These three, together, form what we call the **Triangle of Trust**. Let us see what role each entity plays in Privado iD.

1. **Identity Holder**: An entity that holds claims in its [Wallet](./wallet/wallet-overview.md). A VC, as mentioned above, is issued by an Issuer to the Holder. The Identity Holder generates zero-knowledge proofs of the VCs issued and presents these proofs to the Verifier, which verifies that the proof is authentic and matches specific criteria.

2. [**Issuer**](./issuer/issuer-overview.md): An entity (person, organization, or thing) that issues VCs to the Holders. VCs are cryptographically signed by the Issuer. Every VC comes from an Issuer.

3. [**Verifier**](./verifier/verifier-overview.md): A Verifier verifies the proof presented by a Holder. It requests the Holder to send a proof based on the VCs they hold in their wallet. While verifying a proof, the Verifier performs a set of checks, for example that the VC was signed by the expected Issuer and that the VC matches the criteria requested by the Verifier. This verification process can happen either off-chain or on-chain.

The simplest example of a Verifier is a bar that wants to verify if a client is over 18. In the real world, the Identity Holder would need to provide an ID and show all their personal information. With Polygon ID, they only need to pass a proof.
The simplest example of a Verifier is a bar that wants to verify if a client is over 18. In the real world, the Identity Holder would need to provide an ID and show all their personal information. With Privado iD, they only need to pass a proof.

A core concept here is the _trust_ that must exist between a Verifier and an Issuer: the fact that the information contained inside a VC is cryptographically verifiable doesn't guarantee it's true. The Issuer must be a trusted and reputable party so that Verifier can consume the VCs originated by that Issuer.

Expand All @@ -56,22 +52,22 @@ A core concept here is the _trust_ that must exist between a Verifier and an Iss

A [Wallet](./wallet/wallet-overview.md) plays a crucial role in the seamless exchange of VCs with the Issuer, on one hand, and proofs with the Verifier, on the other. As stated above, an Identity Holder carries their personal data, in the form of VC, within their wallet. At its core, the wallet stores the private key of a user, fetch VCs from the Issuer, and create zero-knowledge proofs to be presented to the Verifier. Being the carrier of the sensitive information, the Wallet has been designed to ensure that the identity of its Holder is protected and preserved, and no sensitive data can be revealed to the third party without the consent of the Holder.

## What Can you Achieve Using Polygon ID?
## What Can you Achieve Using Privado iD?

1. **Privacy using Zero-Knowledge Proofs**: An Identity Holder, using zero-knowledge proofs, can keep thier personal data private. During the process of VC verification, it just needs to show a proof that they are the owner of a VC that matches certain criteria without letting the Verifier know of the actual VC. For example, an Identity Holder can prove to a Verifier authority that they are above 18 years of age by presenting the proof without revealing their actual age. This ensures minimum data exposure and hence confirms the safety of any sensitive data.
Another aspect of privacy comes from the fact that the Issuer would not be able to track the usage of VCs by an individual once it has been issued.

2. **Off-Chain and On-Chain Verification**: Verification of proofs can be done either off-chain or on-chain via Smart Contracts. For example, developers can set up a contract that airdrops tokens only to users that meet certain criteria based on their VCs.

3. **Self-Sovereignty**: Polygon ID renders self-sovereignty in the hands of the user. The user is the only custodian of their private keys; user-controlled data can be shared with third parties without taking any permission from the Issuer that has issued the VCs to the user.
3. **Self-Sovereignty**: Privado iD renders self-sovereignty in the hands of the user. The user is the only custodian of their private keys; user-controlled data can be shared with third parties without taking any permission from the Issuer that has issued the VCs to the user.

4. **Transitive Trust**: A transitive trust between the actors of the triangle means that the trust between two entities in one domain or context can be easily extended to other domains or contexts. For instance, the information generated by an Issuer can be conveniently used by more than one Verifier without asking for permission. Along similar lines, an Identity Holder can build up their trust by collecting multiple credentials from different Issuers in one digital wallet.

## Polygon ID and Iden3
## Privado iD and Iden3

<a href="https://iden3.io/" target="_blank">Iden3</a> is the open-source protocol at the basis of Polygon ID. The protocol defines on a low-level how the parties listed above communicate and interact with each other. Polygon ID is an abstraction layer to enable developers to build applications leveraging the Iden3 protocol.
<a href="https://iden3.io/" target="_blank">Iden3</a> is the open-source protocol at the basis of Privado iD. The protocol defines on a low-level how the parties listed above communicate and interact with each other. Privado iD is an abstraction layer to enable developers to build applications leveraging the Iden3 protocol.

## Further Resources On Polygon ID
## Further Resources On Privado iD (prev. Polygon ID)

- [Polygon University - Courses on Polygon ID](https://university.polygon.technology/polygonid/)
- [Polygon ID Youtube Playlists](https://www.youtube.com/@0xPolygonTV/playlists?view=50&sort=dd&shelf_id=5)
Expand Down
14 changes: 7 additions & 7 deletions docs/quick-start-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
id: quick-start-demo
title: Quick Start Demo
sidebar_label: Quick Start Demo
description: A quick demonstration of Polygon ID's main features.
description: A quick demonstration of Privado iD's main features.
keywords:
- docs
- polygon id
- privado id
- ID holder
- issuer
- verifier
Expand All @@ -16,10 +16,10 @@ keywords:

import useBaseUrl from '@docusaurus/useBaseUrl';

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.
This tutorial is a quick demonstration of some of Privado iD's main functionalities. To illustrate how Privado 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](introduction.md#core-concepts-of-polygon-id-verifiable-credentials-identity-holder-issuer-and-verifier), 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.
This guide will briefly touch on the 3 roles of the [Triangle of Trust](introduction.md#core-concepts-of-privado-id-verifiable-credentials-identity-holder-issuer-and-verifier), 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:

Expand All @@ -45,7 +45,7 @@ To get started with the Polygon ID Wallet, download the Polygon ID Wallet App an

:::note

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

:::

Expand Down Expand Up @@ -88,7 +88,7 @@ To learn how to set up your own issuer environment by deploying an issuer node,

:::info

The schema used in this demo was built using the Polygon ID Schema Builder and is available on [<ins>the Polygon ID Schema Explorer</ins>](https://schema-builder.polygonid.me/schemas/1fa99457-b2ae-4884-ae12-d658bd6abf69). Learn more about creating new schemas on [<ins>the Schema Builder UI guide</ins>](https://devs.polygonid.com/docs/issuer/schema-builder/).
The schema used in this demo was built using the Privado iD Schema Builder and is available on [<ins>the Privado iD Schema Explorer</ins>](https://schema-builder.polygonid.me/schemas/1fa99457-b2ae-4884-ae12-d658bd6abf69). Learn more about creating new schemas on [<ins>the Schema Builder UI guide</ins>](https://devs.polygonid.com/docs/issuer/schema-builder/).

:::

Expand Down Expand Up @@ -200,6 +200,6 @@ Here are the steps to verify the credential:

:::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.
This was a quick demonstration of Privado iD's basic functionalities. However, Privado iD is far more complex than this. It offers a range of SSI-focused tools that allow for decentralized identity and verifiable credentials management.

:::
29 changes: 10 additions & 19 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ const katex = require("rehype-katex");
require("dotenv").config();

module.exports = {
title: "Polygon ID Documentation",
tagline: "The official developer documentation hub for Polygon ID.",
title: "Privado iD Documentation",
tagline: "The official developer documentation hub for Privado iD.",
url: "https://devs.polygonid.com",
baseUrl: "/",
favicon: "/img/logo-round-purple.png",
favicon: "/img/privado_favicon.png",
organizationName: "0xPolygonID",
projectName: "docs",
customFields: {
description: "Build your next blockchain dApp using Polygon ID.",
description: "Build your next blockchain dApp using Privado iD.",
},
i18n: {
defaultLocale: "en",
Expand All @@ -34,13 +34,13 @@ module.exports = {
content:
'Polygon Mumbai support ended! Please, migrate to Amoy <a class="announcement-link" rel="noopener noreferrer" href="/docs/mumbai-to-amoy-migration"> Learn more</a>',
backgroundColor: "#20232a",
textColor: "#fff",
textColor: "#131313",
isCloseable: false,
},
metadata: [
{
name: "description",
content: "Welcome to Polygon ID Documentation, the official documentation for Polygon ID.",
content: "Welcome to Privado iD Documentation, the official documentation for Privado iD.",
},
],
colorMode: {
Expand Down Expand Up @@ -74,9 +74,9 @@ module.exports = {
navbar: {
hideOnScroll: true,
logo: {
alt: "Polygon logo",
src: "img/polygon-id-logo-white.svg",
srcDark: "img/polygon-id-logo-white.svg",
alt: "Privado logo",
src: "img/privado_logo.svg",
srcDark: "img/privado_logo.svg",
href: "/",
target: "_self",
},
Expand Down Expand Up @@ -127,10 +127,6 @@ module.exports = {
href: "https://jwz.polygonid.me",
label: "JWZ Validator",
},
{
href: "https://web-wallet-demo.internal-polygonid-prod.com/",
label: "Web Wallet",
},
],
},
{
Expand All @@ -151,7 +147,7 @@ module.exports = {
},
{
href: "https://www.youtube.com/playlist?list=PLRD3rkREa7mIgx_RHZdin74vEb2A1Evek",
label: "Inside Polygon ID",
label: "Inside Privado iD",
},
],
},
Expand Down Expand Up @@ -190,11 +186,6 @@ module.exports = {
position: "right",
className: "header-twitter-link",
},
{
href: "https://discord.com/channels/635865020172861441/1052090291743637504",
position: "right",
className: "header-discord-link",
},
],
},
},
Expand Down
5 changes: 0 additions & 5 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@

module.exports = {
polygonid: [
{
type: 'html',
value: 'Polygon ID',
className: 'sidebar-title',
},
"introduction",
"quick-start-demo",
{
Expand Down
Loading

0 comments on commit ab46f00

Please sign in to comment.