Skip to content

Commit 4951a3a

Browse files
committed
make documentation rely more on guides
1 parent 0b75ae9 commit 4951a3a

File tree

8 files changed

+281
-260
lines changed

8 files changed

+281
-260
lines changed

src/assets/use-iapp/iexec-actors-diagram.svg

Lines changed: 103 additions & 0 deletions
Loading

src/use-iapp/getting-started.md

Lines changed: 43 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -6,145 +6,75 @@ description:
66

77
# 🚀 Getting Started with iApps
88

9-
Welcome to the world of secure, privacy-preserving computation! This guide will
10-
walk you through the essential steps to start using iApps on the iExec network.
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.
1110

1211
## Prerequisites
1312

1413
Before you begin, make sure you have:
1514

1615
- A Web3 wallet (MetaMask, WalletConnect, etc.)
17-
- Some RLC tokens for paying computation fees (or access to free vouchers
18-
through learning programs)
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+
- **Note**: On Arbitrum, you'll need AETH (Arbitrum ETH) instead of RLC
1918
- Basic understanding of blockchain transactions
19+
- iExec SDK installed
2020

21-
### 🆓 Use Our Stack for Free!
21+
::: code-group
2222

23-
Good news! You can start using iApps **completely free** through our learning
24-
programs:
25-
26-
- **Learn Web3 Program**: Get free access to our entire stack, including
27-
vouchers for iApp executions
28-
- **Free Vouchers**: Pre-funded computation credits provided through learning
29-
initiatives
30-
- **No RLC Required**: Start experimenting and building without any upfront
31-
costs
32-
33-
### 💰 Getting Started Without RLC
34-
35-
Don't have RLC tokens yet? No problem! Our learning programs provide everything
36-
you need:
37-
38-
- **Free Vouchers**: Access to pre-funded computation credits
39-
- **Full Stack Access**: Use all iExec tools and infrastructure at no cost
40-
- **Educational Support**: Learn while you build with our community
41-
42-
Ready to dive in? Let's get started with finding and executing your first iApp!
43-
44-
## Step 1: Find Available iApps
45-
46-
The first step is discovering what iApps are available for your use case. You
47-
can find iApps through several methods:
48-
49-
1. Visit the [iExec Explorer](https://explorer.iex.ec)
50-
2. Navigate to the "Apps" section
51-
3. Browse available applications by category or search by name
52-
4. Check the app's description, requirements, and pricing
53-
54-
## Step 2: Understand App Requirements
55-
56-
Before executing an iApp, understand what it needs:
57-
58-
- **Protected Data**: Some apps require specific types of protected data
59-
- **Input Parameters**: Check if the app needs command-line arguments
60-
- **Input Files**: Some apps require additional files (URLs to public files)
61-
- **Secrets**: Certain apps need requester secrets for API keys, etc.
62-
63-
## Step 3: Prepare Your Data
64-
65-
If the iApp requires protected data:
66-
67-
1. **Protect Your Data**: Use the
68-
[Data Protector](/manage-data/dataProtector/dataProtectorCore/protectData) to
69-
encrypt your sensitive information
70-
2. **Grant Access**: Ensure the iApp has permission to access your protected
71-
data using
72-
[grantAccess](/manage-data/dataProtector/dataProtectorCore/grantAccess)
73-
74-
## Step 4: Execute the iApp
75-
76-
### Using the DataProtector SDK
77-
78-
```typescript
79-
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';
80-
81-
const web3Provider = getWeb3Provider(window.ethereum);
82-
const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
83-
84-
// Execute the iApp with protected data
85-
const result = await dataProtectorCore.processProtectedData({
86-
protectedData: '0x123abc...', // Your protected data address
87-
app: '0x456def...', // The iApp address
88-
args: 'optional arguments',
89-
maxPrice: 10, // Maximum price in nRLC
90-
});
23+
```sh [npm]
24+
npm install -g iexec
9125
```
9226

93-
### Using the CLI
27+
```sh [yarn]
28+
yarn global add iexec
29+
```
9430

95-
```bash
96-
# Execute an iApp with protected data
97-
iexec app run 0x456def... --dataset 0x123abc... --args "your arguments"
31+
```sh [pnpm]
32+
pnpm add -g iexec
9833
```
9934

100-
## Step 5: Monitor and Retrieve Results
35+
```sh [bun]
36+
bun add -g iexec
37+
```
10138

102-
After submitting your task:
39+
:::
10340

104-
1. **Monitor Progress**: Track your task on the
105-
[iExec Explorer](https://explorer.iex.ec)
106-
2. **Retrieve Results**: Get your results once the task completes
41+
Ready to dive in? Let's get started with finding and executing your first iApp!
10742

108-
### Using the DataProtector SDK
43+
## Overview: How to Use iApps
10944

110-
```typescript
111-
// Retrieve results from a completed task
112-
const taskResult = await dataProtectorCore.getResultFromCompletedTask({
113-
taskId: '0x7ac398...', // Your task ID
114-
});
115-
```
45+
Using iApps involves these main steps:
11646

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

119-
```bash
120-
# Get task result
121-
iexec task show 0x7ac398...
52+
### Understanding Orders
12253

123-
# Download task result
124-
iexec task show 0x7ac398... --download
125-
```
54+
iApps are executed through a marketplace system where different actors publish orders:
55+
- **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
12658

127-
## Step 6: Understand Costs
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.
12860

129-
iApp execution costs include:
61+
## Detailed Guides
13062

131-
- **Application Fee**: Paid to the app developer
132-
- **Data Fee**: Paid to the data owner (if using protected data)
133-
- **Workerpool Fee**: Paid to the computation provider
134-
- **Gas Fees**: Blockchain transaction costs (free on Bellecour sidechain)
63+
For step-by-step instructions, check out these guides:
13564

136-
## Next Steps
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
13770

138-
Now that you understand the basics:
71+
## Quick Start
13972

140-
- Explore our [Guides](./guides/) for detailed tutorials
141-
- Learn about [Different Ways to Execute](./guides/different-ways-to-execute.md)
142-
iApps
143-
- Understand [How to Pay for Executions](./guides/how-to-pay-executions.md)
144-
- Discover how to
145-
[Use iApps with Protected Data](./guides/use-iapp-with-protected-data.md)
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.
14674

147-
## Need Help?
75+
<script setup>
76+
import ImageViewer from '../components/ImageViewer.vue';
14877

149-
- Check the [iExec Explorer](https://explorer.iex.ec) for app details
150-
- Visit our [Discord community](https://discord.gg/iexec) for support
78+
// Assets
79+
import appViewImage from '../assets/tooling-&-explorers/iexec-explorer/app-view.png';
80+
</script>

0 commit comments

Comments
 (0)