-
-
Notifications
You must be signed in to change notification settings - Fork 16
[Update]: workflow documentation for better clarity and system understanding #95
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,87 @@ | ||
| # Identity Tokens — Project Workflow | ||
| # 📘 WORKFLOWS | ||
|
|
||
|  | ||
| 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. | ||
|
|
||
| ## Overview | ||
| --- | ||
|
|
||
| - **Self-issued identity token minting:** Users create and mint their own identity tokens, optionally attaching metadata. No central issuer is required. | ||
| ## 🔗 Connect Wallet | ||
|
|
||
| - **On-chain identity storage:** Identity tokens and their metadata are stored on-chain (e.g. as ERC-721 NFTs), providing a portable, verifiable record. | ||
| 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. | ||
|
|
||
| - **Endorsement by other identity holders:** Holders of identity tokens can endorse other identities on-chain, building a graph of attestations and trust. | ||
| <p align="center"> | ||
| <img src="../public/assets/workflows/connect.png" width="600"/> | ||
| </p> | ||
|
|
||
| - **Optional revocation:** Endorsements or credentials can support revocation (e.g. via a registry or expiry), so trust can be updated or withdrawn when needed. | ||
| --- | ||
|
|
||
| - **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. | ||
| ## 🪙 Create DIT Token (Using Platform) | ||
|
|
||
| - **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. | ||
| 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. | ||
|
|
||
| <p align="center"> | ||
| <img src="../public/assets/workflows/create-token.png" width="600"/> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| ## ⚙️ Create DIT Token (Without Platform) | ||
|
|
||
| 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. | ||
|
|
||
| <p align="center"> | ||
| <img src="../public/assets/workflows/create-token-N.png" width="600"/> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| ## 🔄 Internal Flow for Token Creation | ||
|
|
||
| This flow explains what happens behind the scenes when a token is created — including contract deployment/interactions, metadata linking, and backend processes (if any). | ||
|
|
||
| <p align="center"> | ||
| <img src="../public/assets/workflows/Internal-flow-create.png" width="600"/> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| ## 📦 Fetch Token Metadata | ||
|
|
||
| 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. | ||
|
|
||
| <p align="center"> | ||
| <img src="../public/assets/workflows/fetch-token-metadata.png" width="600"/> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| ## 👍 Endorsement Flow | ||
|
|
||
| Users can endorse a token to validate or support it. This process includes wallet confirmation, on-chain verification, and updating the endorsement state. | ||
|
|
||
| <p align="center"> | ||
| <img src="../public/assets/workflows/endorsement-flow.png" width="600"/> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| ## 🔄 Un-Endorsement Flow | ||
|
|
||
| This flow allows users to remove their endorsement. It ensures proper validation and updates the blockchain state accordingly while maintaining data integrity. | ||
|
|
||
| <p align="center"> | ||
| <img src="../public/assets/workflows/unEndorsement-flow.png" width="600"/> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| ## 🔍 Auto-fetch Metadata via Token URI | ||
|
|
||
| Wallets and applications can automatically fetch token metadata using the token URI. This improves usability by displaying token details without manual input. | ||
|
|
||
| <p align="center"> | ||
| <img src="../public/assets/workflows/tokenUri.png" width="600"/> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| > 💡 These workflows provide a clear understanding of how users and the system interact, covering both user-facing actions and internal processes. | ||
|
Comment on lines
+1
to
+87
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Missing link to contract repository workflows as stated in PR objectives. Issue Consider adding a section (perhaps at the end or beginning) that links to the contract repository's workflow documentation for developers who need the complete picture. 📎 Suggested additionAdd a new section near the end of the document: ---
## 🔗 Related Resources
For a complete end-to-end understanding of the system, including smart contract workflows and backend processes, please refer to:
👉 [Contract Repository Workflows](https://github.com/StabilityNexus/IdentityTokens-EVM-Contracts/blob/main/docs/workflow.md)
---🧰 Tools🪛 markdownlint-cli2 (0.21.0)[warning] 12-12: Images should have alternate text (alt text) (MD045, no-alt-text) [warning] 22-22: Images should have alternate text (alt text) (MD045, no-alt-text) [warning] 32-32: Images should have alternate text (alt text) (MD045, no-alt-text) [warning] 42-42: Images should have alternate text (alt text) (MD045, no-alt-text) [warning] 52-52: Images should have alternate text (alt text) (MD045, no-alt-text) [warning] 62-62: Images should have alternate text (alt text) (MD045, no-alt-text) [warning] 72-72: Images should have alternate text (alt text) (MD045, no-alt-text) [warning] 82-82: Images should have alternate text (alt text) (MD045, no-alt-text) 🤖 Prompt for AI Agents |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add alt text to all workflow diagrams for accessibility compliance.
All eight workflow images are missing alt text, which prevents screen readers from describing these diagrams to visually impaired users. This is a WCAG accessibility violation that blocks users with visual disabilities from understanding the documented workflows.
♿ Proposed fix to add descriptive alt text
Apply similar descriptive alt text to all other images:
alt="Workflow diagram for creating DIT token using the platform UI"alt="Workflow diagram for creating DIT token via direct smart contract interaction"alt="Internal flow diagram showing backend token creation process"alt="Workflow diagram for fetching token metadata using token URI"alt="Workflow diagram showing the endorsement process"alt="Workflow diagram showing the un-endorsement process"alt="Workflow diagram for auto-fetching metadata via token URI"Also applies to: 22-22, 32-32, 42-42, 52-52, 62-62, 72-72, 82-82
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 12-12: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents