Merge pull request #214 from 0xPolygonID/develop

Syncing main from develop

Author: 0xpulkit

docs/issuer/issuer-configuration.md

@@ -33,7 +33,7 @@ The first step in setting up the issuer node is to define the networks it will s
 The github repository provides an example file called `resolvers_setting_sample.yaml` this file can be used as a reference to configure the issuer node networks.
 You must create a file called resolvers_settings.yaml which must be in the root directory.
 
-Let's see an example of how to configure the issuer node for the Polygon amoy network.
+Let's see an example of how to configure the issuer node for the Polygon amoy network and [Privado Identity Chain](/docs/privado-identity-chain.md)
 ```yaml
 polygon:
   amoy:
@@ -55,7 +55,33 @@ polygon:
       rhsUrl: https://rhs-staging.polygonid.me # RHS URL (setup this if you are using OffChain or All mode)
       chainID: 80002 # Polygon amoy chain ID
       publishingKey: pbkey # Publishing key path. Left this value as this.
+
+privado:
+  main:
+    contractAddress: 0x3C9acB2205Aa72A05F6D77d708b5Cf85FCa3a896
+    networkURL: https://rpc-mainnet.privado.id
+    defaultGasLimit: 600000
+    confirmationTimeout: 10s
+    confirmationBlockCount: 5
+    receiptTimeout: 600s
+    minGasPrice: 0
+    maxGasPrice: 1000000
+    rpcResponseTimeout: 5s
+    waitReceiptCycleTime: 30s
+    waitBlockCycleTime: 30s
+    gasLess: false
+    rhsSettings:
+      mode: None
+      contractAddress: 0x7dF78ED37d0B39Ffb6d4D527Bb1865Bf85B60f81
+      rhsUrl: https://rhs-staging.polygonid.me
+      chainID: 21000
+      publishingKey: pbke
 ```
+
+:::note
+Configuring Privado Idenity Chain (privado:main) is necessary as identities on the Privado ID Web Wallet and the Privado ID Wallet App are asociated to this chain. This configuration ensures issuance of credentials to these identities.
+:::
+
 Notes about **rhsSettings** mode:
 Types:
 * Iden3commRevocationStatusV1.0: Centralized mode

docs/issuer/migration-v1-v2.md renamed to docs/issuer/migration-v2-v3.md

@@ -1,14 +1,14 @@
 ---
 id: issuer-migration-guide
-title: Migration Guide (v1 to v2)
-sidebar_label: Migration Guide (v1 to v2)
-description: Guide for migrating from issuer node v1 to v2
+title: Migration Guide (v2 to v3)
+sidebar_label: Migration Guide (v2 to v3)
+description: Guide for migrating from issuer node v2 to v3
 keywords:
   - docs
   - privado id
   - issuer node
-  - v1
   - v2
+  - v3
   - core
   - API
   - UI
@@ -18,24 +18,24 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Migration Guide: Upgrading from Issuer Node v1 to v2
+# Migration Guide: Upgrading from Issuer Node v2 to v3
 
-We are excited to announce the release of Issuer Node v2. If you are currently running Issuer Node v1, we recommend migrating to the new version as soon as possible.
+We are excited to announce the release of Issuer Node v3. If you are currently running Issuer Node v2, we recommend migrating to the new version as soon as possible.
 
 :::note
 The migration process is designed to be seamless, with no disruption to previously issued credentials, connections, or the overall functionality of your system.
 :::
 
-## Key Enhancements in Issuer Node v2
+## Key Enhancements in Issuer Node v3
 
-- **Unified API**: The previous two separate APIs (Core API and UI API) have been consolidated into a single, unified API. This simplifies development, enhances developer experience, and introduces new features like improved credentials status check while retaining all functionalities from v1.
-- **Streamlined Credential Issuance**: Issuer Node v2 introduces a simplified credential issuance flow. Now, users can authenticate and receive credentials in a single step using universal links.
-- **Flexible Key Management**: The vault setup is now optional, giving developers the freedom to choose their preferred key management tool. Additionally, Issuer Node v2 supports AWS Key Management Service (KMS).
+- **Unified API** (v2): The previous two separate APIs (Core API and UI API) have been consolidated into a single, unified API. This simplifies development, enhances developer experience, and introduces new features like improved credentials status check while retaining all functionalities from API v1.
+- **Streamlined Credential Issuance**: Issuer Node v3 introduces a simplified credential issuance flow. Now, users can authenticate and receive credentials in a single step using universal links.
+- **Flexible Key Management**: The vault setup is now optional, giving developers the freedom to choose their preferred key management tool. Additionally, Issuer Node v3 supports AWS Key Management Service (KMS).
 - **Enhanced UI**: The new UI enables the creation of multiple identities supported on multiple networks for an issuer and supports credential issuance through universal links, all seamlessly integrated with the Unified API.
 
 ## Migration Steps
 
-If you were using Docker to run Issuer Node and wish to migrate to v2, please follow these steps after backing up your project folder.
+If you were using Docker to run Issuer Node and wish to migrate to 3, please follow these steps after backing up your project folder.
 
 #### 1. **Backup Your Database**
 
@@ -61,7 +61,7 @@ make stop
 
 #### 4. **Pull Changes**
 
-Pull the latest changes for v2 from the main branch of the repository
+Pull the latest changes for v3 from the main branch of the repository
 ```bash
 git pull
 ```
@@ -129,10 +129,10 @@ make run-all
 ## Additional Notes
 
 - New makefile commands have been added in this release. We recommend reviewing the README file for a comprehensive list.
-- Issuer Node v2 continues to support the following endpoints from v1 to ensure compatibility with previously issued credentials:
+- Issuer Node API v2 continues to support the following endpoints from v1 to ensure compatibility with previously issued credentials:
     - /v1/agent (API reference here)
     - /v1/{identifier}/claims/revocation/status/{nonce} (API reference here)
-- By following these steps, you should be able to migrate to Issuer Node v2 smoothly and take advantage of the new features and improvements.
+- By following these steps, you should be able to migrate to Issuer Node v3 smoothly and take advantage of the new features and improvements.
 
 
 

docs/issuer/setup-issuer-core.md

@@ -21,9 +21,9 @@ This article details the steps to set up your own Issuer Node API.
 
 :::caution
 
-Issuer Node v2 is now available, bringing enhanced features and optimizations. If you are using the previous version of Issuer Node (v1), we recommend upgrading to the latest version as soon as possible. To ensure a smooth transition, please follow the migration guide provided [<ins> here </ins>](migration-v1-v2.md/).
+Issuer Node v3 is now available, bringing enhanced features and optimizations. If you are using the previous version of Issuer Node (v2), we recommend upgrading to the latest version as soon as possible. To ensure a smooth transition, please follow the migration guide provided [<ins> here </ins>](issuer-migration-guide).
 
-Below is the installation guide for Issuer Node v2.
+Below is the installation guide for Issuer Node v3.
 
 :::
 
@@ -136,7 +136,7 @@ cp .env-issuer.sample .env-issuer
 
 [How to Set Up Issuer Node UI Guide](setup-issuer-ui.md)
 
-[Migrating from Issuer Node v1 to v2 Guide](migration-v1-v2.md)
+[Migrating from Issuer Node v2 to v3 Guide](issuer-migration-guide)