Merge pull request #127 from iotaledger/feat/add-real-world-examples

feat: add real-world examples on how to use the hierarchies

Author: itsyaasir

.github/workflows/shared-build-wasm.yml

@@ -58,7 +58,7 @@ jobs:
       - name: Install wasm-bindgen-cli
         uses: jetli/wasm-bindgen-action@24ba6f9fff570246106ac3f80f35185600c3f6c9
         with:
-          version: "0.2.101"
+          version: "0.2.102"
 
       - name: Setup sccache
         uses: "./.github/actions/rust/sccache/setup"

Cargo.lock

@@ -15,6 +15,7 @@ repository = "https://github.com/iotaledger/hierarchies"
 anyhow = "1.0"
 async-trait = "0.1"
 bcs = "0.1"
+chrono = { version = "0.4", features = ["serde"] }
 iota-sdk = { git = "https://github.com/iotaledger/iota.git", tag = "v1.6.1", package = "iota-sdk" }
 iota_interaction = { git = "https://github.com/iotaledger/product-core.git", default-features = false, tag = "v0.8.2", package = "iota_interaction" }
 iota_interaction_rust = { git = "https://github.com/iotaledger/product-core.git", default-features = false, tag = "v0.8.2", package = "iota_interaction_rust" }

Cargo.toml

@@ -23,7 +23,7 @@ iota_interaction_ts = { git = "https://github.com/iotaledger/product-core.git",
 js-sys = { version = "0.3" }
 serde = { version = "1.0", features = ["derive"] }
 serde-wasm-bindgen = "0.6"
-wasm-bindgen = { version = "0.2", features = ["serde-serialize"] }
+wasm-bindgen = { version = "=0.2.102", features = ["serde-serialize"] }
 wasm-bindgen-futures = { version = "0.4", default-features = false }
 
 [dependencies.product_common]

bindings/wasm/hierarchies_wasm/Cargo.toml

@@ -16,6 +16,8 @@ describe(
             "01_get_accreditations",
             "02_validate_properties",
             "03_get_properties",
+            "real_world_01_university_degrees",
+            "real_world_02_supply_chain",
         ];
 
         _.each(examples, (example) => {

bindings/wasm/hierarchies_wasm/cypress/e2e/tests.cy.js

@@ -84,6 +84,54 @@ The validation examples show how to verify trust relationships and validate prop
 | [02_validate_properties](src/validation/02_validate_properties.ts) | Shows how to validate if an entity can attest to specific properties.        |
 | [03_get_properties](src/validation/03_get_properties.ts)           | Demonstrates retrieving properties from federations.                         |
 
+## Real-World Examples
+
+These examples demonstrate practical applications of IOTA Hierarchies in real business scenarios with comprehensive TypeScript implementation:
+
+| Name                                                             | Information                                                                |
+| :--------------------------------------------------------------- | :------------------------------------------------------------------------- |
+| [01_university_degrees](src/real-world/01_university_degrees.ts) | University degree verification system with multi-level academic hierarchy. |
+| [02_supply_chain](src/real-world/02_supply_chain.ts)             | Supply chain quality certification system with international standards.    |
+
+### University Degree Verification System
+
+Demonstrates a comprehensive academic credential verification system optimized for web applications:
+
+- University consortium federation management
+- Multi-level hierarchy: University → Faculty → Registrar
+- Academic properties: degrees, fields of study, GPAs, graduation years
+- Cross-institutional credential recognition
+- Degree revocation for academic misconduct
+- Mobile app integration and QR code verification
+
+**Web-Specific Features:**
+
+- Browser-based credential verification
+- Real-time validation without server round-trips
+- QR code integration for mobile verification
+- Progressive Web App (PWA) compatibility
+- Cross-platform TypeScript implementation
+
+### Supply Chain Quality Certification System
+
+Demonstrates a global supply chain certification system designed for web dashboards and e-commerce integration:
+
+- International standards consortium (ISO-style) federation
+- Multi-regional structure with real-time status monitoring
+- Comprehensive certifications with web dashboard integration
+- Consumer-facing QR code verification
+- E-commerce API integration examples
+- Real-time certificate expiry tracking
+
+**Web-Specific Features:**
+
+- Interactive certification dashboard
+- RESTful API integration examples
+- Consumer-facing verification interfaces
+- Real-time compliance monitoring
+- Mobile-responsive design patterns
+- WebAssembly performance optimization
+
 ## Utility Functions
 
 | Name                   | Information                                                                   |

bindings/wasm/hierarchies_wasm/examples/README.md

@@ -10,6 +10,8 @@ import { createAccreditationToAccredit } from "./06_create_accreditation_to_accr
 import { revokeAccreditationToAccredit } from "./07_revoke_accreditation_to_accredit";
 import { revokeRootAuthority } from "./08_revoke_root_authority";
 import { reinstateRootAuthority } from "./09_reinstate_root_authority";
+import { universityDegrees } from "./real-world/01_university_degrees";
+import { supplyChain } from "./real-world/02_supply_chain";
 import { getAccreditations } from "./validation/01_get_accreditations";
 import { validateProperties } from "./validation/02_validate_properties";
 import { getProperties } from "./validation/03_get_properties";
@@ -34,6 +36,8 @@ export async function main(example?: string) {
             await reinstateRootAuthority();
             await getAccreditations();
             await validateProperties();
+            await universityDegrees();
+            await supplyChain();
             return await getProperties();
         case "01_create_federation":
             return await createFederation();
@@ -59,6 +63,10 @@ export async function main(example?: string) {
             return await validateProperties();
         case "03_get_properties":
             return await getProperties();
+        case "real_world_01_university_degrees":
+            return await universityDegrees();
+        case "real_world_02_supply_chain":
+            return await supplyChain();
         default:
             throw "Unknown example name: '" + argument + "'";
     }