|
1 | | -# Identity Tokens — Project Workflow |
| 1 | +# 📘 WORKFLOWS |
2 | 2 |
|
3 | | - |
| 3 | +This document provides an overview of all major workflows in the system. Each section includes a brief explanation and a visual diagram to help you quickly understand how different parts of the platform interact. |
4 | 4 |
|
5 | | -## Overview |
| 5 | +--- |
6 | 6 |
|
7 | | -- **Self-issued identity token minting:** Users create and mint their own identity tokens, optionally attaching metadata. No central issuer is required. |
| 7 | +## 🔗 Connect Wallet |
8 | 8 |
|
9 | | -- **On-chain identity storage:** Identity tokens and their metadata are stored on-chain (e.g. as ERC-721 NFTs), providing a portable, verifiable record. |
| 9 | +This is the entry point for users. By connecting a wallet, users can securely interact with the platform, sign transactions, and access features like token creation and endorsements. |
10 | 10 |
|
11 | | -- **Endorsement by other identity holders:** Holders of identity tokens can endorse other identities on-chain, building a graph of attestations and trust. |
| 11 | +<p align="center"> |
| 12 | + <img src="../public/assets/workflows/connect.png" width="600"/> |
| 13 | +</p> |
12 | 14 |
|
13 | | -- **Optional revocation:** Endorsements or credentials can support revocation (e.g. via a registry or expiry), so trust can be updated or withdrawn when needed. |
| 15 | +--- |
14 | 16 |
|
15 | | -- **Frontend reading on-chain data:** The frontend reads identity and endorsement data from the chain (e.g. via RPC and events) to display profiles, endorsements, and status. |
| 17 | +## 🪙 Create DIT Token (Using Platform) |
16 | 18 |
|
17 | | -- **External services verifying identity:** Third-party services can verify identity and endorsements by reading the same on-chain data, enabling use cases like access control or credential checks without relying on the frontend alone. |
| 19 | +Users can create a DIT token through a simple and guided UI. The platform handles contract interaction, metadata setup, and transaction flow, making it beginner-friendly. |
| 20 | + |
| 21 | +<p align="center"> |
| 22 | + <img src="../public/assets/workflows/create-token.png" width="600"/> |
| 23 | +</p> |
| 24 | + |
| 25 | +--- |
| 26 | + |
| 27 | +## ⚙️ Create DIT Token (Without Platform) |
| 28 | + |
| 29 | +This workflow is for advanced users who prefer direct interaction with smart contracts. It involves manually calling contract functions and handling parameters without the platform UI. |
| 30 | + |
| 31 | +<p align="center"> |
| 32 | + <img src="../public/assets/workflows/create-token-N.png" width="600"/> |
| 33 | +</p> |
| 34 | + |
| 35 | +--- |
| 36 | + |
| 37 | +## 🔄 Internal Flow for Token Creation |
| 38 | + |
| 39 | +This flow explains what happens behind the scenes when a token is created — including contract deployment/interactions, metadata linking, and backend processes (if any). |
| 40 | + |
| 41 | +<p align="center"> |
| 42 | + <img src="../public/assets/workflows/Internal-flow-create.png" width="600"/> |
| 43 | +</p> |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +## 📦 Fetch Token Metadata |
| 48 | + |
| 49 | +This workflow shows how token metadata is retrieved using the token URI. It includes fetching details like title, description, and other attributes stored off-chain or on-chain. |
| 50 | + |
| 51 | +<p align="center"> |
| 52 | + <img src="../public/assets/workflows/fetch-token-metadata.png" width="600"/> |
| 53 | +</p> |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +## 👍 Endorsement Flow |
| 58 | + |
| 59 | +Users can endorse a token to validate or support it. This process includes wallet confirmation, on-chain verification, and updating the endorsement state. |
| 60 | + |
| 61 | +<p align="center"> |
| 62 | + <img src="../public/assets/workflows/endorsement-flow.png" width="600"/> |
| 63 | +</p> |
| 64 | + |
| 65 | +--- |
| 66 | + |
| 67 | +## 🔄 Un-Endorsement Flow |
| 68 | + |
| 69 | +This flow allows users to remove their endorsement. It ensures proper validation and updates the blockchain state accordingly while maintaining data integrity. |
| 70 | + |
| 71 | +<p align="center"> |
| 72 | + <img src="../public/assets/workflows/unEndorsement-flow.png" width="600"/> |
| 73 | +</p> |
| 74 | + |
| 75 | +--- |
| 76 | + |
| 77 | +## 🔍 Auto-fetch Metadata via Token URI |
| 78 | + |
| 79 | +Wallets and applications can automatically fetch token metadata using the token URI. This improves usability by displaying token details without manual input. |
| 80 | + |
| 81 | +<p align="center"> |
| 82 | + <img src="../public/assets/workflows/tokenUri.png" width="600"/> |
| 83 | +</p> |
| 84 | + |
| 85 | +--- |
| 86 | + |
| 87 | +> 💡 These workflows provide a clear understanding of how users and the system interact, covering both user-facing actions and internal processes. |
0 commit comments