Skip to content

Commit

Permalink
rm title case
Browse files Browse the repository at this point in the history
  • Loading branch information
ihordiachenko committed Feb 1, 2024
1 parent 23b4f5c commit 607a1b2
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 20 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
---

# Guide: How to Set Up A Credentials Issuer
# Guide: How to set up a credentials issuer

This article details the steps to set up a Credentials Issuer, create your credentials schema, and issue the first credentials.

Expand Down Expand Up @@ -36,50 +36,50 @@ After cloning the repository, you should do the following:
1. Run `sudo make private_key=YOUR_ETHEREUM_PRIVATE_KEY run-all` with the issuer's private key.
1. Check that `localhost:3001` (Issuer API) and `localhost:3002` (Issuer UI) are available.

## How to create Credentials Schemas
## How to create credential schemas

If you need to create your own Credentials Schemas (some of the schemas can be found <a href="https://github.com/iden3/claim-schema-vocab/tree/main/schemas" target="_blank" rel="noreferrer noopener">here</a>) you can use either <a href="https://schema-builder.polygonid.me/builder" target="_blank" rel="noreferrer noopener">Polygon ID Schema Builder</a> (recommended option) or you can write it by yourself and import it, using Issuer UI API.

### Creating a Schema with Polygon ID Schema Builder
### Creating a schema with Polygon ID Schema Builder

To create the schema using Polygon ID Builder, follow these steps:

1. Enter the title, type, version, and description of your schema
![Schema data](/img/schema-builder-1.png)
1. Define the attributes. Let's add the date of birth and the full name for this example.
![Schema attributes](/img/schema-builder-2.png)
1. After clicking on "Add" button, a new attribute will appear, and you need to change its name, title, type, and description and set the checkbox, whether it is required or not
1. After clicking on **Add** button, a new attribute will appear, and you need to change its name, title, type, and description and set the checkbox, whether it is required or not
![New Attribute](/img/schema-builder-3.png)
1. You can also set additional restrictions by clicking on the "Advanced" button
1. You can also set additional restrictions by clicking on the **Advanced** button
![Advanced settings](/img/schema-builder-4.png)
1. After you've finished, you can copy it from the right window or download it by pressing on the "Download JSON" button below the properties
1. After you've finished, you can copy it from the right window or download it by pressing on the **Download JSON** button below the properties
![Receiving the Schema](/img/schema-builder-5.png)
1. Publish it somewhere (e.g., on GitHub or IPFS) and paste the link into `url` field at the `Import JSON schema` in the Issuer UI API.
1. Publish it somewhere (e.g., on GitHub or IPFS) and paste the link into **url** field at the **Import JSON schema** in the Issuer UI API.
You should also copy the type, title, description, and version from the posted schema
![Importing](/img/schema-builder-6.png)

## Issuing Credentials
## Issuing credentials

Once the issuer is ready, we can issue our first credentials.

### Using the Issuer UI
### Using the issuer UI

1. The Issuer is also an identity, so we need to create one.
To do that, open `localhost:3001` and select "Create Identity" in the left sidebar.
To do that, open `localhost:3001` and select **Create Identity** in the left sidebar.
![Identity Creation](/img/issuer-issue-1.png)
1. Fill in the `method`, `blockchain`, and `network` fields.
The `method` field is required.
We will use the method `iden3` without specifying blockchain and network.
1. Fill in the **method**, **blockchain**, and **network** fields.
The **method** field is required.
We will use the method **iden3** without specifying blockchain and network.
We will also create an identity for the user so we can issue credentials to him.
![Identity Created, using iden3 method](/img/issuer-issue-2.png)
1. We can issue our first claim after creating both identities (or receiving the user's identity from him).
To do that, press the "Create Claim" button and paste the Issuer identifier (our first generated ID) and user's ID in the `id` field below:
To do that, press the **Create Claim** button and paste the Issuer identifier (our first generated ID) and user's ID in the **id** field below:
![Create Claim](/img/issuer-issue-3.png)
1. We can check our claim using the "Get Claim" endpoint:
1. We can check our claim using the **Get Claim** endpoint:
![Get Claim](/img/issuer-issue-4.png)
1. The last thing we need to do is publish the state of our issuer on-chain
![State publishing](/img/issuer-issue-5.png)
1. Now, we can send to the user MTP of Claim inclusion in the tree, using "Get Claim MTP"
1. Now, we can send to the user MTP of Claim inclusion in the tree, using **Get Claim MTP**
![MTP Of Claim Inclusion](/img/issuer-issue-6.png)

### Issuing via API
Expand Down

This file was deleted.

6 changes: 3 additions & 3 deletions docs/products/identity-protocol/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: The Rarimo Identity Protocol is a cross-chain identity solution tha

# Identity Protocol

## Problem Statement
## Problem statement

Decentralized identity is a crucial building block for Web 3 applications such as social graphs, games, regulation-compliant DeFi, and many more. Moving on from centralized solutions like OAuth, the crypto community has come up with several solutions:

Expand All @@ -24,11 +24,11 @@ The Rarimo Identity Protocol builds upon the base interchain layer to address th

## Features

### Own Your Identity
### Own your identity

The Protocol implements the <a href="https://www.w3.org/TR/did-core/" target="_blank" rel="noreferrer noopener">W3C DID Self-Sovereign Identity standard</a>, meaning all credentials stay on the user's device, and no third party can access them.

### Keep Privacy With Zero-Knowledge Proofs
### Keep privacy with zero-knowledge proofs

To enable the usage of user credentials in a privacy-preserving manner, zero-knowledge proofs have been integrated into the protocol. DApps can verify specific attributes of user identity on-chain without compromising the sensitive data. For example, users can prove they're over 21 without revealing their age. The security is ensured by the proven <a href="https://docs.iden3.io/" target="_blank" rel="noreferrer noopener">Iden3 Protocol</a>.

Expand Down

0 comments on commit 607a1b2

Please sign in to comment.