Skip to content

Commit 0f0ab4b

Browse files
committed
fix format
1 parent 4951a3a commit 0f0ab4b

File tree

5 files changed

+95
-51
lines changed

5 files changed

+95
-51
lines changed

src/use-iapp/getting-started.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,17 @@ description:
66

77
# 🚀 Getting Started with iApps
88

9-
Welcome to the world of secure, privacy-preserving computation! This guide gives you a high-level overview of how to use iApps on the iExec network.
9+
Welcome to the world of secure, privacy-preserving computation! This guide gives
10+
you a high-level overview of how to use iApps on the iExec network.
1011

1112
## Prerequisites
1213

1314
Before you begin, make sure you have:
1415

1516
- A Web3 wallet (MetaMask, WalletConnect, etc.)
16-
- Some RLC tokens for paying computation fees (or access to free vouchers through learning programs) - [Learn about RLC tokens](/overview/rlc) and [how to bridge them](/overview/tooling-and-explorers/bridge)
17+
- Some RLC tokens for paying computation fees (or access to free vouchers
18+
through learning programs) - [Learn about RLC tokens](/overview/rlc) and
19+
[how to bridge them](/overview/tooling-and-explorers/bridge)
1720
- **Note**: On Arbitrum, you'll need AETH (Arbitrum ETH) instead of RLC
1821
- Basic understanding of blockchain transactions
1922
- iExec SDK installed
@@ -44,33 +47,49 @@ Ready to dive in? Let's get started with finding and executing your first iApp!
4447

4548
Using iApps involves these main steps:
4649

47-
1. **Find iApps** - Browse available applications in the [iExec Explorer](/overview/tooling-and-explorers/iexec-explorer)
50+
1. **Find iApps** - Browse available applications in the
51+
[iExec Explorer](/overview/tooling-and-explorers/iexec-explorer)
4852
2. **Prepare Data** - Set up any required protected data or inputs
4953
3. **Execute** - Run the iApp
5054
4. **Get Results** - Retrieve your computation results
5155

5256
### Understanding Orders
5357

54-
iApps are executed through a marketplace system where different actors publish orders:
58+
iApps are executed through a marketplace system where different actors publish
59+
orders:
60+
5561
- **App orders** - Published by developers with pricing and availability
56-
- **Workerpool orders** - Published by computation providers with capacity and pricing
57-
- **Dataset orders** - Published by data owners with access conditions and pricing
62+
- **Workerpool orders** - Published by computation providers with capacity and
63+
pricing
64+
- **Dataset orders** - Published by data owners with access conditions and
65+
pricing
5866

59-
When you execute an iApp, the system matches your request with available orders from all three categories. For a deeper understanding of how orders work and how to manage them, see the [Manage Orders guide](/build-iapp/guides/manage-access#manage-orders) in the Build iApp section.
67+
When you execute an iApp, the system matches your request with available orders
68+
from all three categories. For a deeper understanding of how orders work and how
69+
to manage them, see the
70+
[Manage Orders guide](/build-iapp/guides/manage-access#manage-orders) in the
71+
Build iApp section.
6072

6173
## Detailed Guides
6274

6375
For step-by-step instructions, check out these guides:
6476

65-
- **[Find iApps](./guides/find-iapps.md)** - How to discover and evaluate available applications
66-
- **[Different Ways to Execute](./guides/different-ways-to-execute.md)** - iExec cli, lib, and other execution methods
67-
- **[Use iApps with Protected Data](./guides/use-iapp-with-protected-data.md)** - Working with sensitive data securely
68-
- **[Add Inputs to Execution](./guides/add-inputs-to-execution.md)** - How to provide data and parameters to iApps
69-
- **[How to Pay for Executions](./guides/how-to-pay-executions.md)** - Understanding costs and payment options
77+
- **[Find iApps](./guides/find-iapps.md)** - How to discover and evaluate
78+
available applications
79+
- **[Different Ways to Execute](./guides/different-ways-to-execute.md)** - iExec
80+
cli, lib, and other execution methods
81+
- **[Use iApps with Protected Data](./guides/use-iapp-with-protected-data.md)** -
82+
Working with sensitive data securely
83+
- **[Add Inputs to Execution](./guides/add-inputs-to-execution.md)** - How to
84+
provide data and parameters to iApps
85+
- **[How to Pay for Executions](./guides/how-to-pay-executions.md)** -
86+
Understanding costs and payment options
7087

7188
## Quick Start
7289

73-
Ready to jump in? Start with our [Find iApps guide](./guides/find-iapps.md) to discover what's available, then follow the execution guides for detailed instructions.
90+
Ready to jump in? Start with our [Find iApps guide](./guides/find-iapps.md) to
91+
discover what's available, then follow the execution guides for detailed
92+
instructions.
7493

7594
<script setup>
7695
import ImageViewer from '../components/ImageViewer.vue';

src/use-iapp/guides/add-inputs-to-execution.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,18 @@ iApps can accept various types of inputs to customize their behavior and provide
1111
necessary data for processing. This guide covers all the different ways to add
1212
inputs to your iApp executions using various iExec tools and SDKs.
1313

14-
::: tip ENS Addresses
14+
<!-- prettier-ignore-start -->
15+
::: tip ENS Addresses
1516
**ENS (Ethereum Name Service)** is a naming system for
1617
Ethereum addresses that allows you to use human-readable names instead of long
1718
hexadecimal addresses. For example, instead of using `0x1234567890abcdef...`,
1819
you can use `debug-v8-learn.main.pools.iexec.eth`.
1920

2021
In the examples below, we use `debug-v8-learn.main.pools.iexec.eth` which is
2122
iExec's official debug workerpool ENS address. This workerpool is specifically
22-
designed for testing and development purposes on the Bellecour testnet.
23+
designed for testing and development purposes on the Bellecour testnet.
2324
:::
25+
<!-- prettier-ignore-end -->
2426

2527
## Types of Inputs
2628

@@ -230,21 +232,18 @@ const datasetOrders = await orderbookModule.fetchDatasetOrderbook({
230232
dataset: '0x123abc...', // Filter by specific dataset
231233
});
232234
```
235+
233236
const workerpoolOrders = await orderbookModule.fetchWorkerpoolOrderbook({
234-
workerpool: 'debug-v8-learn.main.pools.iexec.eth', // Filter by specific workerpool ENS
235-
});
237+
workerpool: 'debug-v8-learn.main.pools.iexec.eth', // Filter by specific
238+
workerpool ENS });
236239

237-
const taskId = await orderModule.matchOrders({
238-
requestorder: requestOrder,
239-
apporder: appOrders[0],
240-
datasetorder: datasetOrders[0],
241-
workerpoolorder: workerpoolOrders[0],
242-
inputFiles: [
243-
'https://raw.githubusercontent.com/user/repo/main/config.json',
244-
'https://example.com/public-data.csv',
245-
],
246-
});
247-
```
240+
const taskId = await orderModule.matchOrders({ requestorder: requestOrder,
241+
apporder: appOrders[0], datasetorder: datasetOrders[0], workerpoolorder:
242+
workerpoolOrders[0], inputFiles: [
243+
'https://raw.githubusercontent.com/user/repo/main/config.json',
244+
'https://example.com/public-data.csv', ], });
245+
246+
````
248247
249248
### Using SDK CLI
250249
@@ -257,7 +256,7 @@ iexec app run 0x456def... --protectedData 0x123abc... --inputFiles "https://exam
257256
258257
# Multiple input files (space-separated)
259258
iexec app run 0x456def... --protectedData 0x123abc... --inputFiles "https://example.com/config.json" --inputFiles "https://example.com/template.html"
260-
```
259+
````
261260

262261
### Using DataProtector
263262

src/use-iapp/guides/different-ways-to-execute.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,18 @@ There are multiple ways to execute iApps on the iExec network. This guide covers
1010
the basic execution methods. For advanced features like protected data,
1111
arguments, and input files, see the dedicated guides.
1212

13-
::: tip ENS Addresses
13+
<!-- prettier-ignore-start -->
14+
::: tip ENS Addresses
1415
**ENS (Ethereum Name Service)** is a naming system for
1516
Ethereum addresses that allows you to use human-readable names instead of long
1617
hexadecimal addresses. For example, instead of using `0x1234567890abcdef...`,
1718
you can use `debug-v8-learn.main.pools.iexec.eth`.
1819

1920
In the examples below, we use `debug-v8-learn.main.pools.iexec.eth` which is
2021
iExec's official debug workerpool ENS address. This workerpool is specifically
21-
designed for testing and development purposes on the Bellecour testnet.
22+
designed for testing and development purposes on the Bellecour testnet.
2223
:::
24+
<!-- prettier-ignore-end -->
2325

2426
## Method 1: Using the iExec SDK Library
2527

@@ -77,7 +79,8 @@ iexec app run 0x456def...
7779
The iApp Generator CLI provides a streamlined way to execute iApps, especially
7880
for developers who have built their own iApps.
7981

80-
> **Note**: For installation instructions, see the [iApp Generator Getting Started guide](/build-iapp/iapp-generator/getting-started).
82+
> **Note**: For installation instructions, see the
83+
> [iApp Generator Getting Started guide](/build-iapp/iapp-generator/getting-started).
8184
8285
### Basic Execution
8386

src/use-iapp/guides/find-iapps.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ available iApps on the iExec network.
1111

1212
## Using the iExec Explorer
1313

14-
The [iExec Explorer](/overview/tooling-and-explorers/iexec-explorer) is the primary tool for
15-
discovering iApps. For detailed instructions on how to browse and filter iApps, see the [📱 iApps Listing section](/overview/tooling-and-explorers/iexec-explorer#📱-iapps-listing).
14+
The [iExec Explorer](/overview/tooling-and-explorers/iexec-explorer) is the
15+
primary tool for discovering iApps. For detailed instructions on how to browse
16+
and filter iApps, see the
17+
[📱 iApps Listing section](/overview/tooling-and-explorers/iexec-explorer#📱-iapps-listing).
1618

1719
### What to Look For
1820

@@ -23,7 +25,9 @@ When evaluating an iApp, check these key details:
2325
- **Usage Statistics**: How often is it used?
2426
- **Orders Availability**: Are there active orders available for execution?
2527

26-
> **Note**: Detailed descriptions and specific requirements are not available in the iExec explorer. You may need to check the developer's documentation, community forums, or contact the developer directly for this information.
28+
> **Note**: Detailed descriptions and specific requirements are not available in
29+
> the iExec explorer. You may need to check the developer's documentation,
30+
> community forums, or contact the developer directly for this information.
2731
2832
## Using the iExec CLI
2933

src/use-iapp/introduction.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,52 @@ description:
77

88
# 📝 Introduction to Using iApps
99

10-
In the iExec network, multiple actors work together in a coordinated process to ensure secure, decentralized computation. Here's how the ecosystem operates:
10+
In the iExec network, multiple actors work together in a coordinated process to
11+
ensure secure, decentralized computation. Here's how the ecosystem operates:
1112

1213
### Key Actors in the Network
1314

1415
- **👤 Requesters**: Users who need computation performed on protected data
15-
- **🏭 Workerpool Managers**: Operators who manage groups of workers and coordinate task execution
16+
- **🏭 Workerpool Managers**: Operators who manage groups of workers and
17+
coordinate task execution
1618
- **⚙️ Workers**: Individual machines that execute the actual computations
17-
- **👨‍💻 iApp Developers**: Developers who create and deploy applications to the iExec marketplace
19+
- **👨‍💻 iApp Developers**: Developers who create and deploy applications to the
20+
iExec marketplace
1821
- **🔐 Data Providers**: Users who own and protect the data being processed
1922

2023
### Network Assets
2124

2225
- **📱 iApps**: Applications that process the data securely
2326
- **💾 Data**: Protected information that needs to be processed
2427
- **⚡ Computational Power**: Processing resources provided by workers
25-
- **💰 PoCo**: Proof of Contribution system that matches all actors through marketplace
28+
- **💰 PoCo**: Proof of Contribution system that matches all actors through
29+
marketplace
2630

2731
### Network Coordination
2832

29-
The iExec network coordinates all actors through the PoCo (Proof of Contribution) system, which automatically matches requesters with the appropriate applications, data, and computational resources based on availability, requirements, and pricing.
33+
The iExec network coordinates all actors through the PoCo (Proof of
34+
Contribution) system, which automatically matches requesters with the
35+
appropriate applications, data, and computational resources based on
36+
availability, requirements, and pricing.
3037

3138
### Deal Execution Flow
3239

3340
When a deal is triggered, the following sequence occurs:
3441

3542
1. **Request Creation**: Requester submits a computation request with parameters
36-
2. **Resource Matching**: PoCo system matches the request with available applications, data, and computational resources
37-
3. **Deal Creation**: When compatible resources are found, a deal is created containing multiple tasks
38-
4. **Task Distribution**: Selected workerpool manager distributes tasks to their workers
39-
5. **Secure Execution**: Workers download the iApp and execute it in TEE environments
40-
6. **Data Processing**: iApp processes protected data without accessing raw content
43+
2. **Resource Matching**: PoCo system matches the request with available
44+
applications, data, and computational resources
45+
3. **Deal Creation**: When compatible resources are found, a deal is created
46+
containing multiple tasks
47+
4. **Task Distribution**: Selected workerpool manager distributes tasks to their
48+
workers
49+
5. **Secure Execution**: Workers download the iApp and execute it in TEE
50+
environments
51+
6. **Data Processing**: iApp processes protected data without accessing raw
52+
content
4153
7. **Result Generation**: Computation results are generated
42-
8. **Result Delivery**: Results are returned to the requester through the network
54+
8. **Result Delivery**: Results are returned to the requester through the
55+
network
4356
9. **Payment Settlement**: RLC tokens are distributed to all participants
4457

4558
### Network Architecture Diagram
@@ -48,15 +61,21 @@ When a deal is triggered, the following sequence occurs:
4861

4962
### Detailed Interaction Flow
5063

51-
1. **Request Submission**: Requester creates a request specifying the iApp, Protected Data, etc.
64+
1. **Request Submission**: Requester creates a request specifying the iApp,
65+
Protected Data, etc.
5266
2. **PoCo Processing**: PoCo system validates the request and matches resources
5367
3. **Deal Creation**: When resources are matched, PoCo creates a deal
54-
4. **Secure Environment Setup**: Workers initialize TEE environments and download the iApp
55-
5. **Data Access**: iApp requests access to protected data through secure channels
68+
4. **Secure Environment Setup**: Workers initialize TEE environments and
69+
download the iApp
70+
5. **Data Access**: iApp requests access to protected data through secure
71+
channels
5672
6. **Computation**: iApp processes data within the TEE, maintaining privacy
57-
7. **Payment Distribution**: RLC tokens are distributed to all participants based on completed tasks
73+
7. **Payment Distribution**: RLC tokens are distributed to all participants
74+
based on completed tasks
5875

59-
This decentralized architecture ensures that no single entity has control over the entire process, while the use of TEEs guarantees that sensitive data remains protected throughout the computation.
76+
This decentralized architecture ensures that no single entity has control over
77+
the entire process, while the use of TEEs guarantees that sensitive data remains
78+
protected throughout the computation.
6079

6180
## Getting Started
6281

0 commit comments

Comments
 (0)