Skip to content

Commit d874900

Browse files
Le-CaignecCopilot
andauthored
Feat/integrate faucet into documentation (#83)
Co-authored-by: Copilot <[email protected]>
1 parent ee3533e commit d874900

File tree

10 files changed

+137
-6
lines changed

10 files changed

+137
-6
lines changed

.vitepress/sidebar.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,10 @@ export function getSidebar() {
9292
text: 'RLC Bridge',
9393
link: '/get-started/tooling-and-explorers/bridge',
9494
},
95+
{
96+
text: 'RLC Faucet',
97+
link: '/get-started/tooling-and-explorers/faucet',
98+
},
9599
{
96100
text: 'Subgraph Explorer',
97101
link: '/get-started/tooling-and-explorers/subgraph-explorer',
44.3 KB
Loading

src/get-started/helloWorld/3-buildIApp.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ create, test and deploy iApp with just a few commands.
2020
</Banner>
2121

2222
If you wanna explore and deep dive in the command-line tool. You can check the
23-
[iApp Generator ](https://github.com/iExecBlockchainComputing/iapp/tree/main/cli)
23+
[iApp Generator](https://github.com/iExecBlockchainComputing/iapp/tree/main/cli)
2424
GitHub repository. Follow the instructions carefully for a smooth development
2525
experience.
2626

@@ -401,6 +401,24 @@ If you set the wrong Docker username, you can change it by editing the
401401

402402
:::
403403

404+
### 💰 Getting RLC Tokens
405+
406+
To deploy and run your iApp, you'll need RLC tokens to pay for:
407+
408+
- **Workerpool execution costs** for running your iApp on decentralized compute
409+
resources
410+
- **Protected Data access fees** if your iApp requires confidential datasets
411+
(and you're not the data provider)
412+
- **iApp execution costs** if you're not the owner of the iApp you're running
413+
414+
**Getting RLC tokens:**
415+
416+
- **For Testing**: Get free RLC tokens on Arbitrum Sepolia testnet using the
417+
[iExec RLC Faucet](https://explorer.iex.ec/arbitrum-sepolia-testnet/faucet)
418+
- **For Production**: Purchase RLC from [exchanges](/get-started/overview/rlc)
419+
or bridge from Ethereum using the
420+
[RLC Bridge](/get-started/tooling-and-explorers/bridge)
421+
404422
## 🏃 Run your iApp
405423

406424
Now you can run your application:

src/get-started/overview/rlc.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,16 +111,16 @@ You can acquire RLC tokens through several methods:
111111
title="Decentralized Exchanges"
112112
:features="[
113113
{ text: 'ETH: RLC/ETH on Uniswap', link: 'https://app.uniswap.org/explore/pools/ethereum/0x56Ea002B411FD5887E55329852D5777EcB170713' },
114-
'ARB: RLC/ETH (coming soon)',
114+
{ text: 'ARB: RLC/WETH on Uniswap', link: 'https://app.uniswap.org/explore/pools/arbitrum/0x0EB43B37539a4261Aa1860f9476094Bb2C00A894' },
115115
'High liquidity DEX trading'
116116
]"
117117
/>
118118

119119
<FeatureCard
120120
title="Cross-Chain Bridging"
121121
:features="[
122-
'Bellecour Bridge',
123-
'Stargate Bridge (Arbitrum)',
122+
{ text: 'Bellecour Bridge', link: 'https://bridge-bellecour.iex.ec/' },
123+
{ text: 'Stargate Bridge (Arbitrum)', link: 'https://stargate.finance/bridge' }
124124
]"
125125
/>
126126

src/get-started/quick-start.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,9 @@ learning and prototyping.
9898
React/Vue options
9999
2. **Experiment**: Try the interactive sandboxes to understand core concepts
100100
3. **Build**: Integrate the features you need into your application
101-
4. **Deploy**: Use our deployment guides for production-ready applications
101+
4. **Get RLC Tokens**: Use the
102+
[iExec RLC Faucet](https://explorer.iex.ec/arbitrum-sepolia-testnet/faucet)
103+
5. **Deploy**: Use our deployment guides for production-ready applications
102104

103105
<script setup>
104106
import CardGrid from '@/components/CardGrid.vue';

src/get-started/tooling-and-explorers/bridge.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,16 @@ the iExec confidential computing network.
1414
This guide helps you bridge RLC tokens to **Bellecour** (becoming xRLC) and
1515
**Arbitrum** networks using the Bellecour Bridge and Stargate Bridge.
1616

17+
::: tip 🧪 Testing on Arbitrum Sepolia
18+
19+
For development and testing purposes, you can get free RLC tokens on **Arbitrum
20+
Sepolia testnet** using the
21+
[iExec RLC Faucet](https://explorer.iex.ec/arbitrum-sepolia-testnet/faucet).
22+
This allows you to test your iApps, pay for workerpool executions, and access
23+
protected datasets without spending real tokens.
24+
25+
:::
26+
1727
## 🗂️ Available Bridges
1828

1929
iExec provides officially supported bridges for seamless token transfer across
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: RLC Faucet
3+
description:
4+
Get free RLC tokens on Arbitrum Sepolia testnet for testing your iApps,
5+
workerpools, and protected datasets without spending real tokens.
6+
---
7+
8+
# 🚰 RLC Faucet
9+
10+
Get free RLC tokens on **Arbitrum Sepolia testnet** to test your iApps, pay for
11+
workerpool executions, and access protected datasets without spending real
12+
tokens.
13+
14+
## What are RLC Tokens Used For?
15+
16+
In the iExec ecosystem, RLC tokens are used to pay for various services:
17+
18+
- **Pay Workerpools** - Compensate computational resources for executing your
19+
iApps
20+
- **Pay Protected Data Providers** - Access and use protected datasets in your
21+
applications
22+
- **Pay iApp Providers** - Use decentralized applications deployed on the
23+
network
24+
25+
These testnet RLC tokens allow you to test all these payment flows without
26+
spending real tokens.
27+
28+
## Eligibility Requirements
29+
30+
To be eligible for RLC claims, builders must meet these criteria:
31+
32+
- **GitHub or Google login** required for verification
33+
- **Maximum 1 RLC** in your wallet to claim (prevents abuse and ensures fair
34+
distribution)
35+
- **One claim per 24 hours** per authenticated account
36+
37+
## 💰 Claim Details
38+
39+
<UseCaseCard
40+
title="🚰 iExec RLC Faucet"
41+
description="Get 5 RLC tokens per claim on Arbitrum Sepolia testnet for testing your iExec applications and services."
42+
:image-url="faucetImage"
43+
image-alt="iExec RLC Faucet Interface"
44+
:features="[
45+
'5 RLC per claim',
46+
'GitHub/Google authentication',
47+
'24-hour cooldown period',
48+
'Balance verification (max 1 RLC)',
49+
'Arbitrum Sepolia testnet only'
50+
]"
51+
demo-url="https://explorer.iex.ec/arbitrum-sepolia-testnet/faucet"
52+
demo-icon="mdi:water"
53+
demo-label="Access Faucet"
54+
/>
55+
56+
::: tip 💡 Development Workflow
57+
58+
Use the RLC Faucet for development and testing, then bridge real RLC tokens when
59+
ready for production deployment on Arbitrum mainnet.
60+
61+
:::
62+
63+
<script setup>
64+
import UseCaseCard from '@/components/UseCaseCard.vue';
65+
66+
// Assets
67+
import faucetImage from '@/assets/tooling-&-explorers/faucet/faucet.png';
68+
</script>

src/guides/build-iapp/deploy-&-run.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,28 @@ description:
1010
It's time to run your iApp! After building and testing, you'll need to deploy it
1111
to a supported network and then execute it.
1212

13+
## Prerequisites
14+
15+
Before deploying and running your iApp, ensure you have sufficient RLC tokens to
16+
cover:
17+
18+
- **Workerpool execution costs** for running your iApp on decentralized compute
19+
resources
20+
- **Protected Data access fees** if your iApp requires confidential datasets
21+
(and you're not the data provider)
22+
- **iApp execution costs** if you're not the owner of the iApp you're running
23+
24+
**Getting RLC tokens:**
25+
26+
- **Arbitrum Mainnet**: Purchase RLC from [exchanges](/get-started/overview/rlc)
27+
or bridge from Ethereum using the
28+
[RLC Bridge](/get-started/tooling-and-explorers/bridge)
29+
- **Arbitrum Sepolia Testnet**: Get free RLC tokens from the
30+
[iExec RLC Faucet](https://explorer.iex.ec/arbitrum-sepolia-testnet/faucet)
31+
for testing purposes
32+
- **Bellecour**: Bridge RLC from Ethereum using the
33+
[RLC Bridge](/get-started/tooling-and-explorers/bridge)
34+
1335
## Deploy your iApp
1436

1537
After your tests pass and the package is built, you can deploy your iApp to a

src/modules/helloWorld/ReownButton.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ const logout = async () => {
5858
5959
watch(
6060
async () => isConnected.value,
61-
async (newIsConnected) => {
61+
async () => {
6262
if (status.value === 'connected') {
6363
const provider = await connector.value?.getProvider();
6464
emit('connected', provider);

src/references/iapp-generator/getting-started.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ Before using the iApp Generator, make sure you have:
3737
</div>
3838
<a target="_blank" href="https://hub.docker.com/" class="no-underline! text-sm ml-auto hover:underline!">Sign Up →</a>
3939
</div>
40+
41+
<div class="flex items-center gap-4 text-left">
42+
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
43+
💰 RLC Tokens
44+
</div>
45+
<a href="/get-started/overview/rlc" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
46+
</div>
4047
</div>
4148

4249
::: tip 🔍 Verify Docker Compatibility

0 commit comments

Comments
 (0)