Skip to content

Commit 4de4349

Browse files
committed
fix: update iApp documentation for improved accuracy and clarity
- Changed "Verifiable Execution" to "Trusted Execution" to reflect the use of Trusted Execution Environments (TEEs) for secure code execution. - Revised the description of "Zero Trust Architecture" to emphasize hardware-based TEEs for data protection. - Updated terminology from "personal data" to "private data" for consistency and clarity. - Enhanced real-world examples of iApps with additional context and code snippets in both Python and Node.js, ensuring better understanding of their functionality and privacy preservation.
1 parent 6f44adf commit 4de4349

File tree

2 files changed

+64
-14
lines changed

2 files changed

+64
-14
lines changed

src/build-iapp/guides/build-&-deploy-iapp.md

Lines changed: 59 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,32 +34,82 @@ iapp deploy
3434

3535
## Real Examples
3636

37+
Here are some real-world examples of iApps to help you understand how they work
38+
in practice.
39+
3740
**Email Notification iApp**
3841

39-
```python
42+
This iApp lets you send updates to your contacts without ever seeing their email
43+
addresses, privacy is preserved by design.
44+
45+
::: code-group
46+
47+
```python [Python]
4048
# User runs: "Send updates to my contacts about my project"
4149
contacts = load_protecteddata() # User's protected contact list
4250
for contact in contacts:
43-
send_email(contact, project_update_message)
51+
send_email(contact, project_update_message)
4452
# → Emails sent directly, you never see the addresses
4553
```
4654

55+
```js [Node.js]
56+
/* User runs: "Send updates to my contacts about my project" */
57+
const contacts = loadProtectedData(); // User's protected contact list
58+
contacts.forEach((contact) => {
59+
sendEmail(contact, projectUpdateMessage);
60+
});
61+
// → Emails sent directly, you never see the addresses
62+
```
63+
64+
:::
65+
4766
**Oracle Update iApp**
4867

49-
```python
68+
This iApp securely updates a price oracle using private trading data, ensuring
69+
sensitive information stays confidential.
70+
71+
::: code-group
72+
73+
```python [Python]
5074
# User runs: "Update price oracle with my private trading data"
5175
trading_data = load_protecteddata() # User's protected trading history
5276
average_price = calculate_weighted_average(trading_data)
5377
update_oracle_contract(average_price)
5478
# → Oracle updated with real data, trading history stays private
5579
```
5680

81+
```js [Node.js]
82+
/* User runs: "Update price oracle with my private trading data" */
83+
const tradingData = loadProtectedData(); // User's protected trading history
84+
const averagePrice = calculateWeightedAverage(tradingData);
85+
updateOracleContract(averagePrice);
86+
// → Oracle updated with real data, trading history stays private
87+
```
88+
89+
:::
90+
5791
**Automated Transactions iApp**
5892

59-
```python
60-
# User runs: "Buy tokens when my portfolio meets certain conditions"
61-
portfolio = load_protecteddata() # User's protected portfolio data
62-
if should_buy_tokens(portfolio):
63-
execute_trade(token_address, amount)
64-
# → Trade executed based on private data, portfolio details stay hidden
93+
This iApp automates monthly payments using protected payment details, so
94+
financial information remains private.
95+
96+
::: code-group
97+
98+
```python [Python]
99+
# User runs: "Automate payments every month"
100+
payment_info = load_protecteddata() # User's payment details
101+
for month in range(12):
102+
process_payment(payment_info)
103+
# → Payments processed, payment details stay private
104+
```
105+
106+
```js [Node.js]
107+
/* User runs: "Automate payments every month" */
108+
const paymentInfo = loadProtectedData(); // User's payment details
109+
for (let month = 0; month < 12; month++) {
110+
processPayment(paymentInfo);
111+
}
112+
// → Payments processed, payment details stay private
65113
```
114+
115+
:::

src/build-iapp/what-is-iapp.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ they will.**
4949
</div>
5050
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-4 flex items-center gap-3">
5151
<span class="text-green-500 text-xl">✅</span>
52-
<p class="m-0"><strong>Verifiable Execution:</strong> Cryptographic proof that your code ran exactly as intended. No black box execution.</p>
52+
<p class="m-0"><strong>Trusted Execution:</strong> iExec ensures that your code runs inside a Trusted Execution Environment (TEE), which guarantees that only the specified Docker image is executed in a secure and isolated environment.</p>
5353
</div>
5454
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-4 flex items-center gap-3">
5555
<span class="text-green-500 text-xl">✅</span>
5656
<p class="m-0"><strong>Decentralized Infrastructure:</strong> No single point of failure. Your app runs across a distributed network of workers.</p>
5757
</div>
5858
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-4 flex items-center gap-3">
5959
<span class="text-green-500 text-xl">✅</span>
60-
<p class="m-0"><strong>Zero Trust Architecture:</strong> Users don't need to trust you with their data. The protocol guarantees privacy.</p>
60+
<p class="m-0"><strong>Zero Trust Architecture:</strong> User data is protected by hardware-based TEEs, which keep data confidential and inaccessible to the host, cloud provider, or operating system during execution.</p>
6161
</div>
6262
</div>
6363

@@ -75,7 +75,7 @@ to the person running the app.
7575
<div class="flex flex-col gap-3">
7676
<div class="flex items-center gap-3">
7777
<span class="bg-blue-500 text-white rounded-full w-6 h-6 flex items-center justify-center text-xs font-bold">1</span>
78-
<span>User provides personal data</span>
78+
<span>User provides private data</span>
7979
</div>
8080
<div class="flex items-center gap-3">
8181
<span class="bg-blue-500 text-white rounded-full w-6 h-6 flex items-center justify-center text-xs font-bold">2</span>
@@ -129,15 +129,15 @@ preserved.
129129
<span>🤖</span>
130130
<h3 class="font-semibold m-0!">Personal AI Assistants</h3>
131131
</div>
132-
<p class="text-sm m-0!">Users let AI models perform actions based on their private data - trading, scheduling, recommendations.</p>
132+
<p class="text-sm m-0!">Users let AI models perform actions based on their private data - trading, scheduling, recommendations...</p>
133133
</div>
134134

135135
<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 flex flex-col gap-2">
136136
<div class="flex items-baseline gap-2 text-lg">
137137
<span>⚡</span>
138138
<h3 class="font-semibold m-0!">Automated Actions</h3>
139139
</div>
140-
<p class="text-sm m-0!">Users set up automated workflows that use their private data to trigger actions, transactions, or updates.</p>
140+
<p class="text-sm m-0!">Users let AI models perform actions based on their private data - trading, scheduling, recommendations...</p>
141141
</div>
142142
</div>
143143

0 commit comments

Comments
 (0)