|
1 | 1 | --- |
2 | 2 | title: Getting Started with iApps |
3 | | -description: Getting started with iApps |
| 3 | +description: Learn the basics of finding and executing iApps on the iExec network |
4 | 4 | --- |
5 | 5 |
|
6 | | -# 🚀 Getting Started |
| 6 | +# 🚀 Getting Started with iApps |
7 | 7 |
|
8 | | -This page is under development. |
| 8 | +Welcome to the world of secure, privacy-preserving computation! This guide will walk you through the essential steps to start using iApps on the iExec network. |
9 | 9 |
|
10 | | -<!-- TODO: Add the iApps getting started guide --> |
| 10 | +## Prerequisites |
| 11 | + |
| 12 | +Before you begin, make sure you have: |
| 13 | + |
| 14 | +- A Web3 wallet (MetaMask, WalletConnect, etc.) |
| 15 | +- Some RLC tokens for paying computation fees (or access to free vouchers through learning programs) |
| 16 | +- Basic understanding of blockchain transactions |
| 17 | + |
| 18 | +### 🆓 Use Our Stack for Free! |
| 19 | + |
| 20 | +Good news! You can start using iApps **completely free** through our learning programs: |
| 21 | + |
| 22 | +- **Learn Web3 Program**: Get free access to our entire stack, including vouchers for iApp executions |
| 23 | +- **Free Vouchers**: Pre-funded computation credits provided through learning initiatives |
| 24 | +- **No RLC Required**: Start experimenting and building without any upfront costs |
| 25 | + |
| 26 | +### 💰 Getting Started Without RLC |
| 27 | + |
| 28 | +Don't have RLC tokens yet? No problem! Our learning programs provide everything you need: |
| 29 | + |
| 30 | +- **Free Vouchers**: Access to pre-funded computation credits |
| 31 | +- **Full Stack Access**: Use all iExec tools and infrastructure at no cost |
| 32 | +- **Educational Support**: Learn while you build with our community |
| 33 | + |
| 34 | +Ready to dive in? Let's get started with finding and executing your first iApp! |
| 35 | + |
| 36 | +## Step 1: Find Available iApps |
| 37 | + |
| 38 | +The first step is discovering what iApps are available for your use case. You can find iApps through several methods: |
| 39 | + |
| 40 | +1. Visit the [iExec Explorer](https://explorer.iex.ec) |
| 41 | +2. Navigate to the "Apps" section |
| 42 | +3. Browse available applications by category or search by name |
| 43 | +4. Check the app's description, requirements, and pricing |
| 44 | + |
| 45 | +## Step 2: Understand App Requirements |
| 46 | + |
| 47 | +Before executing an iApp, understand what it needs: |
| 48 | + |
| 49 | +- **Protected Data**: Some apps require specific types of protected data |
| 50 | +- **Input Parameters**: Check if the app needs command-line arguments |
| 51 | +- **Input Files**: Some apps require additional files (URLs to public files) |
| 52 | +- **Secrets**: Certain apps need requester secrets for API keys, etc. |
| 53 | + |
| 54 | +## Step 3: Prepare Your Data |
| 55 | + |
| 56 | +If the iApp requires protected data: |
| 57 | + |
| 58 | +1. **Protect Your Data**: Use the [Data Protector](/manage-data/dataProtector/dataProtectorCore/protectData) to encrypt your sensitive information |
| 59 | +2. **Grant Access**: Ensure the iApp has permission to access your protected data using [grantAccess](/manage-data/dataProtector/dataProtectorCore/grantAccess) |
| 60 | + |
| 61 | +## Step 4: Execute the iApp |
| 62 | + |
| 63 | +### Using the DataProtector SDK |
| 64 | + |
| 65 | +```typescript |
| 66 | +import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; |
| 67 | + |
| 68 | +const web3Provider = getWeb3Provider(window.ethereum); |
| 69 | +const dataProtectorCore = new IExecDataProtectorCore(web3Provider); |
| 70 | + |
| 71 | +// Execute the iApp with protected data |
| 72 | +const result = await dataProtectorCore.processProtectedData({ |
| 73 | + protectedData: '0x123abc...', // Your protected data address |
| 74 | + app: '0x456def...', // The iApp address |
| 75 | + args: 'optional arguments', |
| 76 | + maxPrice: 10, // Maximum price in nRLC |
| 77 | +}); |
| 78 | +``` |
| 79 | + |
| 80 | +### Using the CLI |
| 81 | + |
| 82 | +```bash |
| 83 | +# Execute an iApp with protected data |
| 84 | +iexec app run 0x456def... --dataset 0x123abc... --args "your arguments" |
| 85 | +``` |
| 86 | + |
| 87 | +## Step 5: Monitor and Retrieve Results |
| 88 | + |
| 89 | +After submitting your task: |
| 90 | + |
| 91 | +1. **Monitor Progress**: Track your task on the [iExec Explorer](https://explorer.iex.ec) |
| 92 | +2. **Retrieve Results**: Get your results once the task completes |
| 93 | + |
| 94 | +### Using the DataProtector SDK |
| 95 | + |
| 96 | +```typescript |
| 97 | +// Retrieve results from a completed task |
| 98 | +const taskResult = await dataProtectorCore.getResultFromCompletedTask({ |
| 99 | + taskId: '0x7ac398...', // Your task ID |
| 100 | +}); |
| 101 | +``` |
| 102 | + |
| 103 | +### Using the CLI |
| 104 | + |
| 105 | +```bash |
| 106 | +# Get task result |
| 107 | +iexec task show 0x7ac398... |
| 108 | + |
| 109 | +# Download task result |
| 110 | +iexec task show 0x7ac398... --download |
| 111 | +``` |
| 112 | + |
| 113 | +## Step 6: Understand Costs |
| 114 | + |
| 115 | +iApp execution costs include: |
| 116 | + |
| 117 | +- **Application Fee**: Paid to the app developer |
| 118 | +- **Data Fee**: Paid to the data owner (if using protected data) |
| 119 | +- **Workerpool Fee**: Paid to the computation provider |
| 120 | +- **Gas Fees**: Blockchain transaction costs (free on Bellecour sidechain) |
| 121 | + |
| 122 | +## Next Steps |
| 123 | + |
| 124 | +Now that you understand the basics: |
| 125 | + |
| 126 | +- Explore our [Guides](./guides/) for detailed tutorials |
| 127 | +- Learn about [Different Ways to Execute](./guides/different-ways-to-execute.md) iApps |
| 128 | +- Understand [How to Pay for Executions](./guides/how-to-pay-executions.md) |
| 129 | +- Discover how to [Use iApps with Protected Data](./guides/use-iapp-with-protected-data.md) |
| 130 | + |
| 131 | +## Need Help? |
| 132 | + |
| 133 | +- Check the [iExec Explorer](https://explorer.iex.ec) for app details |
| 134 | +- Visit our [Discord community](https://discord.gg/iexec) for support |
0 commit comments