Skip to content

Commit 126b3b4

Browse files
64ix64ix
committed
Refactor iApp, Protected Data, and Workerpool docs
Renamed and updated overview pages for iApps, Protected Data, and Workerpools for clarity and consistency. Updated sidebar, internal links, and references to match new filenames and titles. Added detailed content for the Workerpools page and removed the placeholder Workerpool doc. Reworked the What is iExec page for a better tech explanation
1 parent ee3111c commit 126b3b4

File tree

11 files changed

+257
-63
lines changed

11 files changed

+257
-63
lines changed

‎.vitepress/sidebar.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,16 @@ export function getSidebar() {
6060
link: '/get-started/overview/what-is-iexec',
6161
},
6262
{
63-
text: '❓  What is Protected Data ?',
64-
link: '/get-started/overview/what-is-protected-data',
63+
text: '🔐 Protected Data',
64+
link: '/get-started/overview/protected-data',
6565
},
6666
{
67-
text: '❓ What is an iApp ?',
68-
link: '/get-started/overview/what-is-iapp',
67+
text: '🚀 iApps',
68+
link: '/get-started/overview/iapps',
6969
},
7070
{
71-
text: '❓ What is a Workerpool ?',
72-
link: '/get-started/overview/what-is-workerpool',
71+
text: '⚡ Workerpools',
72+
link: '/get-started/overview/workerpools',
7373
},
7474
{
7575
text: '🪙 RLC Token',

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,3 +192,4 @@ for input parameters:
192192
- migrate github SDK doc here
193193
- migrate pay-per-task page into a guide
194194
- check pages (introduction & getting-started) for use-iapp guide
195+
- Schema what is iexec to do and implement

src/get-started/overview/what-is-iapp.md renamed to src/get-started/overview/iapps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: What is an iApp?
2+
title: iApps
33
description: Privacy-first applications that run on decentralized infrastructure
44
---
55

6-
# 🚀 What is an iApp?
6+
# iApps
77

88
An iExec Application (iApp) is your regular application code (Python script, AI
99
model, data processor, ...) that can securely process protected data (created by

src/get-started/overview/what-is-protected-data.md renamed to src/get-started/overview/protected-data.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: What is Protected Data?
2+
title: Protected Data
33
description: Understanding iExec's data protection mechanisms
44
---
55

6-
# ❓ What is Protected Data?
6+
# Protected Data
77

88
Protected Data refers to any data encrypted using the **iExec Data Protector
99
tool**. This end-to-end encryption solution enables users to protect, manage and
@@ -15,7 +15,7 @@ monetize their data within the Web3 ecosystem.
1515

1616
## Key Concepts
1717

18-
### 👑 Data Governance
18+
### Data Governance
1919

2020
<div class="mb-4"></div>
2121

@@ -42,7 +42,7 @@ monetize their data within the Web3 ecosystem.
4242
</div>
4343
</div>
4444

45-
### 🔒 Privacy-preserving Computation
45+
### Privacy-preserving Computation
4646

4747
<div class="mb-4"></div>
4848

@@ -69,7 +69,7 @@ monetize their data within the Web3 ecosystem.
6969
</div>
7070
</div>
7171

72-
### 💰 Monetization
72+
### Monetization
7373

7474
<div class="mb-4"></div>
7575

‎src/get-started/overview/what-is-iexec.md‎

Lines changed: 72 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -11,47 +11,87 @@ iExec is a **decentralized computing platform** that enables developers to build
1111
and deploy privacy-preserving applications using confidential computing
1212
technology.
1313

14-
## 🎯 **Mission**
14+
## The Protocol (Simple Version)
1515

16-
iExec's mission is to democratize access to **confidential computing** by
17-
providing a decentralized infrastructure that combines:
16+
### Step 1: Protect Data
1817

19-
- **🔐 Privacy Protection** - Data remains encrypted during computation
20-
- **⚡ Scalable Computing** - Access to distributed computing resources
21-
- **💰 Monetization** - Fair compensation for computing providers
22-
- **🌐 Decentralization** - No single point of failure or control
18+
Your sensitive data gets encrypted and stored online. Only you control who can
19+
access it.
2320

24-
## 🏗️ **Core Architecture**
21+
→ **Devtool**: [DataProtector](/references/dataProtector) handles this for you
2522

26-
### **Three Main Components:**
23+
### Step 2: Secure Computing (Workers)
2724

28-
1. **🤖 iApps (iExec Applications)**
29-
- Confidential computing applications
30-
- Run in secure enclaves (TEEs)
31-
- Process encrypted data without exposing it
25+
Code runs inside **secure enclaves** (TEEs) on iExec workers. The worker can
26+
access your data to process it, but only within the privacy-safe TEE
27+
environment - your data never leaves the secure bubble.
3228

33-
2. **🔐 DataProtector**
34-
- End-to-end encryption solution
35-
- Manage data access and sharing
36-
- Monetize protected datasets
29+
### Step 3: Run iApps
3730

38-
3. **⚙️ Worker Network**
39-
- Distributed computing providers
40-
- Execute iApps securely
41-
- Earn RLC tokens for contributions
31+
You submit a **Task** = "Run this iApp on this protected data". The protocol
32+
finds available workers and executes everything confidentially.
4233

43-
## 🚀 **Key Features**
34+
→ **Devtool**: [iApp Generator](/references/iapp-generator) helps you create and
35+
deploy iApps
4436

45-
- **TEE (Trusted Execution Environment)** support
46-
- **Zero-knowledge computation**
47-
- **Decentralized marketplace** for computing resources
48-
- **RLC token** for payments and governance
49-
- **Cross-chain compatibility**
37+
### 📦 Step 4: Get Results
5038

51-
## 🔗 **Get Started**
39+
Results come back **encrypted to you**. Workers never see raw data, you never
40+
lose control.
5241

53-
Ready to explore iExec? Check out:
42+
```
43+
Protected Data + iApp + Worker = Task → Encrypted Result
44+
```
5445

55-
- [What is Protected Data?](/get-started/overview/what-is-protected-data)
56-
- [What is an iApp?](/get-started/overview/what-is-iapp)
57-
- [Hello World Tutorial](/get-started/helloWorld)
46+
## What Each Piece Does
47+
48+
### **Protected Data**
49+
50+
Your data, encrypted. You set the rules: "Only these apps can use it, only for
51+
these purposes."
52+
53+
### **iApps**
54+
55+
Your code, packaged to run on workers. Can be AI models, data processing
56+
scripts, any computation.
57+
58+
### **Workers (Secure Enclaves)**
59+
60+
Computers that process your data inside privacy-safe TEE environments. They can
61+
access your data to work with it, but the TEE ensures it stays confidential and
62+
tamper-proof.
63+
64+
### **Deals**
65+
66+
A job request: "Execute iApp X on protected data Y, send results to Z." The
67+
protocol handles the rest.
68+
69+
## Real Example Walkthrough
70+
71+
**AI Model Training (Private)**
72+
73+
1. **Protect**: Medical researchers upload patient data → becomes Protected Data
74+
2. **Deploy**: AI company packages their model → becomes iApp
75+
3. **Execute**: Someone submits Task → "Train model on this data"
76+
4. **Result**: Model gets trained, researcher gets insights, raw data never
77+
leaves enclave
78+
79+
**Web3 Email**
80+
81+
1. **Protect**: Users upload email contacts → Protected Data
82+
2. **Execute**: App submits Task → "Send email via Web3Mail iApp"
83+
3. **Result**: Email sent, addresses stay private, sender/receiver authenticated
84+
85+
## Start Building
86+
87+
Now that you get the protocol, pick your devtools:
88+
89+
- **📧 Quick Win**: Add [Web3Mail](/references/web3mail) or
90+
[Web3Telegram](/references/web3telegram) to your project ! (uses the protocol
91+
under the hood)
92+
- **🛡️ Protect Data**: Try [DataProtector](/references/dataProtector) to encrypt
93+
your first dataset
94+
- **🚀 Build iApps**: Create confidential compute with
95+
[iApp Generator](/references/iapp-generator)
96+
- **👋 Hands-On**: Follow our [Hello World](/get-started/helloWorld) to see all
97+
devtools working together

‎src/get-started/overview/what-is-workerpool.md‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎src/get-started/overview/workerpools.md‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
---
2+
title: Workerpools
3+
description:
4+
Learn about workerpools in iExec - the computing resources that execute iApps
5+
---
6+
7+
# Workerpools
8+
9+
A **Workerpool** is a group of computing machines (workers) managed by a
10+
**Workerpool Manager** that provides computational resources to execute iApps in
11+
secure environments on the iExec network.
12+
13+
<div class="bg-gradient-to-r from-blue-400/10 to-blue-400/5 rounded-[6px] p-6 border-l-4 border-blue-700 mb-6">
14+
<p class="m-0!">Think of workerpools as <span class="text-blue-700 font-semibold">computing clusters</span> where your iApps run. Each workerpool consists of multiple workers (machines) coordinated by a manager who ensures tasks are executed efficiently and securely.</p>
15+
</div>
16+
17+
## Key Concepts
18+
19+
### Workerpool Manager
20+
21+
<div class="mb-4"></div>
22+
23+
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
24+
<div class="flex flex-col gap-3">
25+
<div class="flex items-center gap-3">
26+
<span>•</span>
27+
<div>
28+
<strong>Resource Coordinator:</strong> Manages and organizes available computing resources
29+
</div>
30+
</div>
31+
<div class="flex items-center gap-3">
32+
<span>•</span>
33+
<div>
34+
<strong>Task Scheduler:</strong> Distributes tasks among available workers
35+
</div>
36+
</div>
37+
<div class="flex items-center gap-3">
38+
<span>•</span>
39+
<div>
40+
<strong>Network Interface:</strong> Connects the workerpool to the iExec marketplace
41+
</div>
42+
</div>
43+
</div>
44+
</div>
45+
46+
### Workers (Computing Machines)
47+
48+
<div class="mb-4"></div>
49+
50+
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
51+
<div class="flex flex-col gap-3">
52+
<div class="flex items-center gap-3">
53+
<span>•</span>
54+
<div>
55+
<strong>TEE-enabled Hardware:</strong> Machines equipped with Trusted Execution Environments
56+
</div>
57+
</div>
58+
<div class="flex items-center gap-3">
59+
<span>•</span>
60+
<div>
61+
<strong>Task Execution:</strong> Run iApps and process protected data securely
62+
</div>
63+
</div>
64+
<div class="flex items-center gap-3">
65+
<span>•</span>
66+
<div>
67+
<strong>RLC Rewards:</strong> Earn RLC tokens for successfully completed tasks
68+
</div>
69+
</div>
70+
</div>
71+
</div>
72+
73+
### Security & Privacy
74+
75+
<div class="mb-4"></div>
76+
77+
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
78+
<div class="flex flex-col gap-3">
79+
<div class="flex items-center gap-3">
80+
<span>•</span>
81+
<div>
82+
<strong>TEE Protection:</strong> All computations happen inside secure enclaves
83+
</div>
84+
</div>
85+
<div class="flex items-center gap-3">
86+
<span>•</span>
87+
<div>
88+
<strong>Data Isolation:</strong> Protected data never leaves the secure environment
89+
</div>
90+
</div>
91+
<div class="flex items-center gap-3">
92+
<span>•</span>
93+
<div>
94+
<strong>Proof of Contribution:</strong> Cryptographic verification of task completion
95+
</div>
96+
</div>
97+
</div>
98+
</div>
99+
100+
## How Workerpools Work
101+
102+
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
103+
<div class="flex flex-col gap-4">
104+
<div class="flex items-center gap-3">
105+
<span class="text-xl font-bold text-blue-700">1.</span>
106+
<div>
107+
<strong>Task Request:</strong> User submits a task to execute an iApp on protected data
108+
</div>
109+
</div>
110+
<div class="flex items-center gap-3">
111+
<span class="text-xl font-bold text-blue-700">2.</span>
112+
<div>
113+
<strong>Workerpool Selection:</strong> PoCo system matches request with available workerpool
114+
</div>
115+
</div>
116+
<div class="flex items-center gap-3">
117+
<span class="text-xl font-bold text-blue-700">3.</span>
118+
<div>
119+
<strong>Task Distribution:</strong> Workerpool manager assigns task to an available worker
120+
</div>
121+
</div>
122+
<div class="flex items-center gap-3">
123+
<span class="text-xl font-bold text-blue-700">4.</span>
124+
<div>
125+
<strong>Secure Execution:</strong> Worker downloads iApp and executes it in TEE environment
126+
</div>
127+
</div>
128+
<div class="flex items-center gap-3">
129+
<span class="text-xl font-bold text-blue-700">5.</span>
130+
<div>
131+
<strong>Result Delivery:</strong> Encrypted results are returned to the requester
132+
</div>
133+
</div>
134+
</div>
135+
</div>
136+
137+
## Getting Started
138+
139+
<div class="bg-gradient-to-r from-green-400/10 to-green-400/5 rounded-[6px] p-6 border-l-4 border-green-600 mb-6">
140+
<p class="m-0!">Want to <span class="text-green-700 font-semibold">use workerpools</span>? Start building iApps and the protocol will handle workerpool selection automatically. Want to <span class="text-green-700 font-semibold">operate a workerpool</span>? Check our deployment guides.</p>
141+
</div>
142+
143+
## Next Steps
144+
145+
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
146+
<div class="flex flex-col gap-4">
147+
<div class="flex items-start gap-3">
148+
<span class="text-xl">🚀</span>
149+
<div>
150+
<strong>Start Using:</strong> <a href="/get-started/helloWorld" class="text-blue-700 hover:text-blue-600">Build your first iApp</a> and see workerpools in action
151+
</div>
152+
</div>
153+
<div class="flex items-start gap-3">
154+
<span class="text-xl">⚙️</span>
155+
<div>
156+
<strong>Join as Worker:</strong> <a href="https://discord.com/invite/pbt9m98wnU" target="_blank" class="text-blue-700 hover:text-blue-600">Contact us on Discord</a> for guidance and support
157+
</div>
158+
</div>
159+
<div class="flex items-start gap-3">
160+
<span class="text-xl">🏭</span>
161+
<div>
162+
<strong>Manage Workerpool:</strong> <a href="https://discord.com/invite/pbt9m98wnU" target="_blank" class="text-blue-700 hover:text-blue-600">Contact us on Discord</a> for deployment assistance
163+
</div>
164+
</div>
165+
</div>
166+
</div>

‎src/guides/build-iapp/index.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ After mastering these guides, explore:
3535

3636
- **[iApp Generator](/references/iapp-generator)** - Complete development
3737
toolkit
38-
- **[What is an iApp?](/get-started/overview/what-is-iapp)** - Core concepts and
39-
TEE overview
38+
- **[iApps](/get-started/overview/iapps)** - Core concepts and TEE overview
4039

4140
Ready to build your first privacy-preserving application? Start with the
4241
[Build & Deploy](/guides/build-iapp/build-&-deploy) guide!

‎src/guides/use-iapp/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ orders:
6767
When you execute an iApp, the system matches your request with available orders
6868
from all three categories. For a deeper understanding of how orders work and how
6969
to manage them, see the
70-
[Build & Deploy guide](/build-iapp/guides/build-&-deploy) in the Build iApp
70+
[Build & Deploy guide](/guides/build-iapp/build-&-deploy) in the Build iApp
7171
section.
7272

7373
## Detailed Guides

0 commit comments

Comments
 (0)