Skip to content

Copywriting - Initial Review #33

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

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
697 changes: 697 additions & 0 deletions COPYWRITING.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions src/build-iapp/guides/build-&-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ description:
# Create and Deploy an iApp

iApps (iExec Applications) are decentralized applications that run on the iExec
network. They leverage confidential computing to ensure data privacy and
security while providing scalable off-chain computation.
network. They use confidential computing to ensure data privacy and security
while providing scalable off-chain computation.

## About iApp Generator

Expand Down
4 changes: 2 additions & 2 deletions src/build-iapp/guides/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ except Exception as e:

Continue improving your iApps:

- **[Inputs and Outputs](/build_iapp/guides/inputs-and-outputs)** - Handle data
- **[Inputs and Outputs](/build-iapp/guides/inputs-and-outputs)** - Handle data
in TEE
- **[How to Get and Decrypt Results](/build_iapp/guides/how-to-get-and-decrypt-results)** -
- **[How to Get and Decrypt Results](/build-iapp/guides/how-to-get-and-decrypt-results)** -
Retrieve results
2 changes: 1 addition & 1 deletion src/build-iapp/guides/how-to-get-and-decrypt-results.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,6 @@ Integrate result handling into your applications:

### Advanced Topics

- **[DataProtector SDK](/manage_data/dataProtector)** - Complete SDK
- **[DataProtector SDK](/manage-data/dataProtector)** - Complete SDK
documentation
- **[SDK Deep Dive](/deep_dive/sdk)** - Advanced result handling techniques
86 changes: 43 additions & 43 deletions src/build-iapp/iapp-generator.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
title: iApp Generator
description:
Build privacy-first applications that run in secure TEE environments. Your
complete toolkit for creating, testing, and deploying confidential iApps on
the iExec network.
iApp Generator CLI toolkit for building confidential computing applications.
Create privacy-preserving AI, data analysis, and Web3 apps that run in secure
TEE environments. Deploy in minutes.
keywords:
iApp Generator, confidential computing CLI, TEE applications,
privacy-preserving development, secure AI development, Web3 privacy tools,
trusted execution environment, iExec development
---

# 🤖 iApp Generator

**Build privacy-first applications that run in secure TEE environments.** iApp
Generator is your complete toolkit for creating, testing, and deploying
confidential iApps on the iExec network.

Transform your ideas into production-ready privacy-preserving applications in
minutes, not months.
**Here's the tool, what it does, and how to use it.** iApp Generator is a CLI
that builds applications running inside TEEs. You write code, we handle the
confidential computing setup.

## What is iApp Generator?

**iApp Generator** is a CLI tool that simplifies building **iExec Applications
(iApps)** - applications that run inside **Trusted Execution Environments
(TEE)** for maximum privacy and security.
**iApp Generator** builds confidential applications. Your code runs in Intel
SGX/TDX secure enclaves where data stays private during processing.

### What you Can Build

Expand All @@ -28,69 +28,69 @@ minutes, not months.
- **Custom algorithms** with confidential inputs and outputs
- **Privacy-preserving services** for Web3 applications

### What iApp Generator Provides
### What you get

- **Project scaffolding** - Complete iApp structure ready to deploy
- **Local testing** - Debug and iterate quickly in simulation mode
- ✅ **One-click deployment** - Deploy to TEE workers with a single command
- ✅ **Input/output handling** - Seamless integration with protected data
- **Project scaffolding** - Complete setup, ready to deploy
- **Local testing** - Debug in simulation mode before going live
- **Simple deployment** - One command deploys to TEE workers
- **Data integration** - Works with encrypted datasets out of the box

## Quick Start Path

### 1. **Learn the Concepts**

Start here to understand what iApps are and how they work:

- **[What Is an iApp?](/build_iapp/iapp-generator/what-is-iapp)** - Core
- **[What Is an iApp?](/build-iapp/iapp-generator/what-is-iapp)** - Core
concepts and TEE overview
- **[Getting Started](/build_iapp/iapp-generator/getting-started)** - Your first
- **[Getting Started](/build-iapp/iapp-generator/getting-started)** - Your first
iApp in 15 minutes
- **[Building Your iApp](/build_iapp/iapp-generator/building-your-iexec-app)** -
- **[Building Your iApp](/build-iapp/iapp-generator/building-your-iexec-app)** -
Complete development guide

### 2. **Master the Development Workflow**

Once you've built your first iApp, level up with these practical guides:

- **[Inputs and Outputs](/build_iapp/guides/inputs-and-outputs)** - Handle data
- **[Inputs and Outputs](/build-iapp/guides/inputs-and-outputs)** - Handle data
flow in TEE environment
- **[Debugging Your iApp](/build_iapp/guides/debugging-your-iapp)** -
- **[Debugging Your iApp](/build-iapp/guides/debugging-your-iapp)** -
Troubleshoot execution issues
- **[App Access Control and Pricing](/build_iapp/guides/orders)** - Control who
- **[App Access Control and Pricing](/build-iapp/guides/orders)** - Control who
can use your iApp
- **[How to Get and Decrypt Results](/build_iapp/guides/how-to-get-and-decrypt-results)** -
- **[How to Get and Decrypt Results](/build-iapp/guides/how-to-get-and-decrypt-results)** -
Retrieve and use outputs

### 3. **Explore Advanced Features**

Ready for production? Dive into specialized topics:

- **[Using TDX (Experimental)](/build_iapp/guides/using-tdx-experimental)** -
- **[Using TDX (Experimental)](/build-iapp/guides/using-tdx-experimental)** -
Next-gen TEE technology
- **[Complete Guides Overview](/build_iapp/guides)** - All development guides in
- **[Complete Guides Overview](/build-iapp/guides)** - All development guides in
one place

## Why Choose iApp Generator?

### 🔒 **Privacy by Design**
### Privacy without infrastructure overhead

Your applications run in hardware-secured enclaves where even the infrastructure
provider can't access your data or code.
Your code runs in Intel SGX/TDX enclaves. Even the worker running your app can't
see what's happening inside.

### ⚡ **Developer-Friendly**
### You build, we handle the TEE complexity

Focus on your application logic while iApp Generator handles the complex TEE
setup, deployment, and execution infrastructure.
Write normal application code. iApp Generator handles secure deployment, worker
coordination, and result encryption.

### 🌍 **Decentralized Infrastructure**
### Runs everywhere TEEs exist

Deploy on a global network of TEE-enabled workers without managing servers or
cloud infrastructure.
Deploy across Intel-enabled workers globally. No server management, no cloud
provider lock-in.

### 🔧 **Complete Toolkit**
### Complete toolkit

From local development to production deployment, everything you need is included
in one CLI tool.
Development, testing, deployment, and execution - everything included in one
CLI.

## Ready to Build?

Expand All @@ -99,16 +99,16 @@ applications:

::: tip Quick Path

1. **[Getting Started](/build_iapp/iapp-generator/getting-started)** - Build
1. **[Getting Started](/build-iapp/iapp-generator/getting-started)** - Build
your first iApp (15 minutes)
2. **[Inputs and Outputs](/build_iapp/guides/inputs-and-outputs)** - Handle data
2. **[Inputs and Outputs](/build-iapp/guides/inputs-and-outputs)** - Handle data
properly
3. **[Debugging](/build_iapp/guides/debugging-your-iapp)** - Fix issues quickly
4. **[App Access Control](/build_iapp/guides/orders)** - Go to production :::
3. **[Debugging](/build-iapp/guides/debugging-your-iapp)** - Fix issues quickly
4. **[App Access Control](/build-iapp/guides/orders)** - Go to production :::

### Need Help?

- **[Complete Guides](/build_iapp/guides)** - All development guides
- **[Complete Guides](/build-iapp/guides)** - All development guides
- **[iExec Discord](https://discord.com/invite/pbt9m98wnU)** - Community support
- **[Protocol Documentation](https://protocol.docs.iex.ec)** - Technical deep
dive
Expand Down
2 changes: 1 addition & 1 deletion src/build-iapp/iapp-generator/building-your-iexec-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ securely within a **Trusted Execution Environment (TEE)**.

::: info

🧪 While **TEE** iApp are base on **intel SGX** technology by default, iApp has
🧪 While **TEE** iApp are based on **intel SGX** technology by default, iApp has
an experimental support for **intel TDX** applications.

TDX mode is enabled by setting the environment variable
Expand Down
4 changes: 2 additions & 2 deletions src/build-iapp/iapp-generator/deserializer.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ schema.

To simplify this process, you can use our lightweight utility package,
`@iexec/dataprotector-deserializer`, in your iApp. This package streamlines the
deserialization of protected data, making it easy for you to access and utilize
the information securely.
deserialization of protected data, making it easy for you to access and use the
information securely.

## Overview

Expand Down
62 changes: 39 additions & 23 deletions src/build-iapp/what-is-iapp.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
---
title: What is an iApp?
description: Privacy-first applications that run on decentralized infrastructure
description:
Learn about iExec Applications (iApps) - confidential computing apps that
process sensitive data in secure TEE environments. Build privacy-preserving
AI, data analysis, and Web3 apps.
keywords:
iApp, iExec application, confidential computing, TEE, trusted execution
environment, privacy-preserving apps, secure data processing, Web3 development
---

# 🚀 What is an iApp?

An iExec Application (iApp) is your regular application code (Python script, AI
model, data processor, ...) that can securely process protected data (created by
[DataProtector](/manage-data/dataProtector)) inside a confidential computing
environment called TEE (a Trusted Execution Environment).
An iExec Application (iApp) brings Turnkey Privacy to your regular application
code. Your Python scripts, AI models, or data processors can securely process
protected data inside a TEE (Trusted Execution Environment).

## Why iApps Matter ?

iApps let you process sensitive data while keeping it private and secure.
iApps provide Turnkey Privacy capabilities. Process sensitive data while keeping
it private and secure.

Imagine you want to build:

Expand All @@ -37,8 +43,10 @@ Imagine you want to build:
</div>
</div>

Users have this data, but they won't give it to your regular app. **With iApps,
they will.**
Users have this data, but they won't trust your regular app with it. **With
Turnkey Privacy iApps, they will.**

**You gain their trust. They gain their privacy. Everyone wins.**

## Key Concepts

Expand All @@ -63,13 +71,12 @@ they will.**

## How it Works

Your code runs in a Trusted Execution Environment (TEE), a secure area inside
specific processors (Intel SGX/TDX chipset). Everything that happens there stays
private and protected, even from the operating system.
Your code runs in a Trusted Execution Environment (TEE). This secure area exists
inside specific processors (Intel SGX/TDX chipset). Everything stays private and
protected there, even from the operating system.

An authorized user can trigger an iApp that processes someone's protected data
inside this private environment. The data is used, but never exposed, not even
to the person running the app.
Authorized users trigger iApps that process protected data inside this private
environment. Your iApp uses the data but never exposes it, not even to you.

<div class="bg-[var(--vp-c-bg-soft)] rounded-[6px] p-6 mb-6">
<div class="flex flex-col gap-3">
Expand All @@ -93,9 +100,9 @@ to the person running the app.
</div>

Your iApp can send emails, update contracts, make transactions, trigger
notifications - anything your code needs to do with the protected data. This
isn't about trust - it's about **cryptographic and hardware-enforced
guarantees** that privacy is preserved within the TEE execution environment.
notifications - anything your code needs. This isn't about trust. We provide
**cryptographic and hardware-enforced guarantees** that preserve privacy within
the TEE execution environment.

## Use Cases

Expand Down Expand Up @@ -143,7 +150,7 @@ be an iApp.

:::

::: details ⚡How fast are iApps?
::: details ⚡ How fast are iApps?

Initial task scheduling takes a few seconds (depending on the resources the
worker download, congestion etc), then your code runs at normal speed depending
Expand All @@ -167,9 +174,11 @@ Try our [Hello World](/overview/helloWorld) for a quick start, or check the

::: details 🔧 What programming languages are supported?

iApps can be built in any language that runs in Docker (Python, JavaScript, R,
You can build iApps in any language that runs in Docker (Python, JavaScript, R,
Java, Go, etc.). However, **iApp Generator** currently supports only Python and
Node.js for simplified development.
uns in Docker (Python, JavaScript, R, Java, Go, etc.). However, **iApp
Generator** currently supports only Python and Node.js for simplified
development.

:::

Expand All @@ -182,14 +191,14 @@ Node.js for simplified development.
<div>📚</div>
<div>
Learn More - iApp Generator:
<a href="/build-iapp/iapp-generator">Complete DataProtector Documentation</a>
<a href="/build-iapp/iapp-generator">Complete iApp Generator Documentation</a>
</div>
</div>
<div class="flex items-start gap-3">
<div>🚀</div>
<div>
Getting Started - deploy your first iApp:
<a href="/build-iapp/guides/build-&-deploy-iapp">DataProtector Quick Start Guide</a>
<a href="/build-iapp/guides/build-&-deploy-iapp">iApp Quick Start Guide</a>
</div>
</div>
</div>
Expand All @@ -199,4 +208,11 @@ Node.js for simplified development.
---

**TL;DR**: iApps = Your code + Secure execution + User privacy + Verifiable
results. Cloud computing, but nobody can spy on your stuff. 🔒
results.

**Cloud computing where privacy is guaranteed, not hoped for.** 🔒

<div class="bg-gradient-to-r from-green-400/10 to-green-400/5 rounded-[6px] p-6 border-l-4 border-green-600 mt-6">
<h4 class="!mt-0 !mb-2">💪 You're Building the Future</h4>
<p class="!mb-0">Every iApp you create **empowers users to take control of their data** while still benefiting from powerful applications. You're not just building software—**you're building trust, privacy, and digital sovereignty for the next billion users**.</p>
</div>
16 changes: 8 additions & 8 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,20 @@ features:
- icon: 🔐
title: Protect & Manage Data
details:
Secure your data with advanced encryption and control access while
maintaining privacy using DataProtector
DataProtector encrypts and controls access to your sensitive data.
Ready-to-use privacy toolkit for developers.
link: /manage-data/what-is-protected-data
- icon: 🤖
title: Build iApps
details:
Create decentralized applications that run on confidential computing
infrastructure with our iApp Generator
iApp Generator builds confidential applications that run in secure TEEs.
Custom confidentiality integration without managing infrastructure.
link: /build-iapp/what-is-iapp
- icon: ⚡
title: Use iApps
details:
Execute existing iApps including Web3Mail, Web3Telegram for your
applications
Execute privacy-preserving apps like Web3Mail and Web3Telegram. Use what
others built, extend what you need.
link: /use-iapp/introduction
- icon: 💰
title: Monetize Data
Expand All @@ -47,7 +47,7 @@ features:
- icon: 🧠
title: Protocols
details:
Deep dive into the core concepts of the protocol and understand how iExec
enables privacy, governance, and monetization
Deep dive into core protocol concepts. Understand how iExec enables
privacy, governance, and monetization.
link: /protocol/sdk
---
Loading