|
1 | 1 | --- |
2 | 2 | title: Getting Started with iApps |
3 | 3 | description: |
4 | | - Learn the basics of finding and executing iApps on the iExec network |
| 4 | + Your first steps to discover and execute existing iApps on the iExec platform |
5 | 5 | --- |
6 | 6 |
|
7 | | -# 🚀 Getting Started with iApps |
| 7 | +# 🚀 Getting Started |
8 | 8 |
|
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 | +This page is under development. |
11 | 10 |
|
12 | | -## Prerequisites |
13 | | - |
14 | | -Before you begin, make sure you have: |
15 | | - |
16 | | -- A Web3 wallet (MetaMask, WalletConnect, etc.) |
17 | | -- Some RLC tokens for paying computation fees (or access to free vouchers |
18 | | - through learning programs) |
19 | | -- Basic understanding of blockchain transactions |
20 | | - |
21 | | -### 🆓 Use Our Stack for Free! |
22 | | - |
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](/documentation/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](/documentation/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 | | -}); |
91 | | -``` |
92 | | - |
93 | | -### Using the CLI |
94 | | - |
95 | | -```bash |
96 | | -# Execute an iApp with protected data |
97 | | -iexec app run 0x456def... --dataset 0x123abc... --args "your arguments" |
98 | | -``` |
99 | | - |
100 | | -## Step 5: Monitor and Retrieve Results |
101 | | - |
102 | | -After submitting your task: |
103 | | - |
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 |
107 | | - |
108 | | -### Using the DataProtector SDK |
109 | | - |
110 | | -```typescript |
111 | | -// Retrieve results from a completed task |
112 | | -const taskResult = await dataProtectorCore.getResultFromCompletedTask({ |
113 | | - taskId: '0x7ac398...', // Your task ID |
114 | | -}); |
115 | | -``` |
116 | | - |
117 | | -### Using the CLI |
118 | | - |
119 | | -```bash |
120 | | -# Get task result |
121 | | -iexec task show 0x7ac398... |
122 | | - |
123 | | -# Download task result |
124 | | -iexec task show 0x7ac398... --download |
125 | | -``` |
126 | | - |
127 | | -## Step 6: Understand Costs |
128 | | - |
129 | | -iApp execution costs include: |
130 | | - |
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) |
135 | | - |
136 | | -## Next Steps |
137 | | - |
138 | | -Now that you understand the basics: |
139 | | - |
140 | | -- Explore our [Guides](/documentation/use-iapp/guides/) for detailed tutorials |
141 | | -- Learn about [Different Ways to Execute](/documentation/use-iapp/guides/different-ways-to-execute) |
142 | | - iApps |
143 | | -- Understand [How to Pay for Executions](/documentation/use-iapp/guides/how-to-pay-executions) |
144 | | -- Discover how to |
145 | | - [Use iApps with Protected Data](/documentation/use-iapp/guides/use-iapp-with-protected-data) |
146 | | - |
147 | | -## Need Help? |
148 | | - |
149 | | -- Check the [iExec Explorer](https://explorer.iex.ec) for app details |
150 | | -- Visit our [Discord community](https://discord.gg/iexec) for support |
| 11 | +<!-- TODO: Add the iApps getting started guide --> |
0 commit comments