Skip to content

Commit 3851738

Browse files
64ixLe-Caignec
andauthored
feat: Refactor iApp, Protected Data, and Workerpool docs (#37)
Co-authored-by: Le-Caignec <[email protected]>
1 parent ca6d654 commit 3851738

File tree

9 files changed

+255
-74
lines changed

9 files changed

+255
-74
lines changed

.github/styles/config/vocabularies/Technical/accept.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,10 @@ ethereum
125125
intel
126126
nano
127127
workerpool
128+
Workerpool
128129
protectedData
129130
dataProtector
131+
DataProtector
130132
iApp
131133
sconification
132134
middleware

.vitepress/sidebar.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,20 +56,20 @@ export function getSidebar() {
5656
text: 'iExec OVERVIEW',
5757
items: [
5858
{
59-
text: 'What is iExec ?',
59+
text: 'What is iExec ?',
6060
link: '/get-started/overview/what-is-iexec',
6161
},
6262
{
63-
text: '❓&nbsp;&nbsp;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: 'iApp',
68+
link: '/get-started/overview/iapp',
6969
},
7070
{
71-
text: '❓ What is a Workerpool ?',
72-
link: '/get-started/overview/what-is-workerpool',
71+
text: 'Workerpool',
72+
link: '/get-started/overview/workerpool',
7373
},
7474
{
7575
text: '🪙 RLC Token',

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,7 @@ for input parameters:
246246
- migrate github iexec SDK doc here
247247
- migrate pay-per-task page into a guide
248248
- check pages (introduction & getting-started) for use-iapp guide
249+
- Schema what is iexec to do and implement
249250
- explain TDX vs SGX
250251
- Give recap of Workerpool address fo chains
251252
- Talk about ENS on Bellecour(it's not supported on arbitrum)

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

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description:
66
AI, data analysis, and Web3 apps.
77
---
88

9-
# 🚀 What is an iApp?
9+
# iApp
1010

1111
An iExec Application (iApp) brings Turnkey Privacy to your regular application
1212
code. Your Python scripts, AI models, or data processors can securely process
@@ -22,19 +22,15 @@ Imagine you want to build:
2222
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
2323
<div class="flex flex-col gap-2.5">
2424
<div class="flex items-center gap-2 text-base">
25-
<span>🤖</span>
2625
<span>An AI that analyzes personal health data</span>
2726
</div>
2827
<div class="flex items-center gap-2 text-base">
29-
<span>📧</span>
3028
<span>An email tool that needs access to contact lists</span>
3129
</div>
3230
<div class="flex items-center gap-2 text-base">
33-
<span>💰</span>
3431
<span>A financial advisor that processes bank statements</span>
3532
</div>
3633
<div class="flex items-center gap-2 text-base">
37-
<span>🛡️</span>
3834
<span>A content filter that reads private messages</span>
3935
</div>
4036
</div>
@@ -105,19 +101,19 @@ the TEE execution environment.
105101

106102
<div class="grid grid-cols-1 md:grid-cols-2 gap-4 mb-6">
107103
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-4">
108-
<h4 class="text-lg font-semibold mb-2">🏥 Healthcare</h4>
104+
<h4 class="text-lg font-semibold mb-2">Healthcare</h4>
109105
<p class="text-sm m-0">Process medical data for AI diagnosis without exposing patient information</p>
110106
</div>
111107
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-4">
112-
<h4 class="text-lg font-semibold mb-2">💰 Finance</h4>
108+
<h4 class="text-lg font-semibold mb-2">Finance</h4>
113109
<p class="text-sm m-0">Analyze financial data for credit scoring while maintaining privacy</p>
114110
</div>
115111
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-4">
116-
<h4 class="text-lg font-semibold mb-2">🎬 Media</h4>
112+
<h4 class="text-lg font-semibold mb-2">Media</h4>
117113
<p class="text-sm m-0">Content recommendation engines that don't track user behavior</p>
118114
</div>
119115
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-4">
120-
<h4 class="text-lg font-semibold mb-2">🔬 Research</h4>
116+
<h4 class="text-lg font-semibold mb-2">Research</h4>
121117
<p class="text-sm m-0">Collaborative research on sensitive datasets across institutions</p>
122118
</div>
123119
</div>

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

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description:
66
controls, and secure data monetization.
77
---
88

9-
# ❓ What is Protected Data?
9+
# Protected Data
1010

1111
Protected Data refers to any data encrypted using the **iExec Data Protector
1212
tool**. This Turnkey Privacy encryption solution enables users to protect,
@@ -18,7 +18,7 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
1818

1919
## Key Concepts
2020

21-
### 👑 Data Governance
21+
### Data Governance
2222

2323
<div class="mb-4"></div>
2424

@@ -45,7 +45,7 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
4545
</div>
4646
</div>
4747

48-
### 🔒 Privacy-preserving Computation
48+
### Privacy-preserving Computation
4949

5050
<div class="mb-4"></div>
5151

@@ -72,7 +72,7 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
7272
</div>
7373
</div>
7474

75-
### 💰 Monetization
75+
### Monetization
7676

7777
<div class="mb-4"></div>
7878

@@ -141,7 +141,6 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
141141
<div class="grid grid-cols-1 md:grid-cols-2 gap-6 my-6">
142142
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 flex flex-col gap-2">
143143
<div class="flex items-baseline gap-2 text-lg">
144-
<span>👤</span>
145144
<h3 class="font-semibold m-0!">Personal Data</h3>
146145
</div>
147146
<ul class="list-disc ml-6">
@@ -153,7 +152,6 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
153152

154153
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 flex flex-col gap-2">
155154
<div class="flex items-baseline gap-2 text-lg">
156-
<span>🏢</span>
157155
<h3 class="font-semibold m-0!">Business Intelligence</h3>
158156
</div>
159157
<ul class="list-disc ml-6">
@@ -165,7 +163,6 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
165163

166164
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 flex flex-col gap-2">
167165
<div class="flex items-baseline gap-2 text-lg">
168-
<span>🤖</span>
169166
<h3 class="font-semibold m-0!">AI Training</h3>
170167
</div>
171168
<ul class="list-disc ml-6">
@@ -177,7 +174,6 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
177174

178175
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 flex flex-col gap-2">
179176
<div class="flex items-baseline gap-2 text-lg">
180-
<span>🔬</span>
181177
<h3 class="font-semibold m-0!">Research</h3>
182178
</div>
183179
<ul class="list-disc ml-6">
@@ -197,13 +193,11 @@ manage and monetize their data within the Web3 ecosystem effortlessly.
197193
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
198194
<div class="flex flex-col gap-4">
199195
<div class="flex items-start gap-3">
200-
<span class="text-xl">📚</span>
201196
<div>
202197
<strong>Learn More:</strong> <a href="/guides/manage-data/manage-access" class="text-fuchsia-700 hover:text-fuchsia-600">Complete DataProtector Documentation</a>
203198
</div>
204199
</div>
205200
<div class="flex items-start gap-3">
206-
<span class="text-xl">🚀</span>
207201
<div>
208202
<strong>Getting Started:</strong> <a href="/references/dataProtector/getting-started" class="text-fuchsia-700 hover:text-fuchsia-600">DataProtector Quick Start Guide</a>
209203
</div>

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

Lines changed: 72 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -10,51 +10,88 @@ description:
1010
iExec is a **decentralized confidential computing toolkit** that helps
1111
developers build privacy-preserving applications.
1212

13-
## 🎯 **Mission**
13+
## The Protocol (Simple Version)
1414

15-
iExec democratizes **confidential computing** by providing a toolkit that
16-
combines:
15+
### Step 1: Protect Data
1716

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

23-
## 🏗️ **Core Architecture**
20+
**DevTool**: [DataProtector](/references/dataProtector) handles this for you
2421

25-
### **Three Main Components:**
22+
### Step 2: Secure Computing (Workers)
2623

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

32-
2. **🔐 DataProtector**
33-
- End-to-end encryption solution
34-
- Manage data access and sharing
35-
- Monetize protected datasets
28+
### Step 3: Run iApp
3629

37-
3. **⚙️ Worker Network**
38-
- Distributed computing providers
39-
- Execute iApp securely
40-
- Earn <TokenSymbol /> tokens for contributions
30+
You submit a **Task** = "Run this iApp on this protected data". The protocol
31+
finds available workers and executes everything confidentially.
4132

42-
## 🚀 **Key Features**
33+
**DevTool**: [iApp Generator](/references/iapp-generator) helps you create and
34+
deploy iApp
4335

44-
- **TEE (Trusted Execution Environment)** support
45-
- **Zero-knowledge computation**
46-
- **Decentralized marketplace** for computing resources
47-
- **<TokenSymbol /> token** for payments and governance
48-
- **Cross-chain compatibility**
36+
### Step 4: Get Results
4937

50-
## 🔗 **Get Started**
38+
Results come back **encrypted to you**. Workers never see raw data, you never
39+
lose control.
5140

52-
Ready to explore iExec? Check out:
41+
```
42+
Protected Data + iApp + Worker = Task → Encrypted Result
43+
```
5344

54-
- [What is Protected Data?](/get-started/overview/what-is-protected-data)
55-
- [What is an iApp?](/get-started/overview/what-is-iapp)
56-
- [Hello World Tutorial](/get-started/helloWorld)
45+
## What Each Piece Does
5746

58-
<script setup>
59-
import TokenSymbol from '@/components/TokenSymbol.vue'
60-
</script>
47+
### **Protected Data**
48+
49+
Your data, encrypted. You set the rules: "Only these apps can use it, only for
50+
these purposes."
51+
52+
### **iApp**
53+
54+
Your code, packaged to run on workers. Can be AI models, data processing
55+
scripts, any computation.
56+
57+
### **Workers (Secure Enclaves)**
58+
59+
Computers that process your data inside privacy-safe TEE environments. They can
60+
access your data to work with it, but the TEE ensures it stays confidential and
61+
tamper-proof.
62+
63+
### **Deals**
64+
65+
The execution instruction that unifies the entire flow: "Run this iApp on this
66+
Protected Data using a TEE Worker, then return the encrypted result to me." The
67+
protocol takes care of worker allocation and secure coordination.
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 iApp**: 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.

0 commit comments

Comments
 (0)