Skip to content

Commit 648f750

Browse files
committed
feat: add TokenSymbol component and update documentation references
1 parent 51bb5f6 commit 648f750

File tree

16 files changed

+111
-82
lines changed

16 files changed

+111
-82
lines changed

src/components/TokenSymbol.vue

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<template>
2+
<span class="font-semibold text-inherit">{{ tokenSymbol }}</span>
3+
</template>
4+
5+
<script setup lang="ts">
6+
import { computed } from 'vue';
7+
import useUserStore from '@/stores/useUser.store';
8+
9+
const userStore = useUserStore();
10+
11+
// Computed property to get the correct token symbol based on selected chain
12+
const tokenSymbol = computed(() => {
13+
const currentChainId = userStore.getCurrentChainId();
14+
15+
// Bellecour (0x86) uses xRLC, Arbitrum (42161) uses RLC
16+
if (currentChainId === 0x86) {
17+
return 'xRLC';
18+
} else if (currentChainId === 42161) {
19+
return 'RLC';
20+
}
21+
22+
// Default fallback
23+
return 'RLC';
24+
});
25+
</script>

src/get-started/overview/what-is-iexec.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ providing a decentralized infrastructure that combines:
3838
3. **⚙️ Worker Network**
3939
- Distributed computing providers
4040
- Execute iApps securely
41-
- Earn RLC tokens for contributions
41+
- Earn <TokenSymbol /> tokens for contributions
4242

4343
## 🚀 **Key Features**
4444

4545
- **TEE (Trusted Execution Environment)** support
4646
- **Zero-knowledge computation**
4747
- **Decentralized marketplace** for computing resources
48-
- **RLC token** for payments and governance
48+
- **<TokenSymbol /> token** for payments and governance
4949
- **Cross-chain compatibility**
5050

5151
## 🔗 **Get Started**
@@ -55,3 +55,7 @@ Ready to explore iExec? Check out:
5555
- [What is Protected Data?](/get-started/overview/what-is-protected-data)
5656
- [What is an iApp?](/get-started/overview/what-is-iapp)
5757
- [Hello World Tutorial](/get-started/helloWorld)
58+
59+
<script setup>
60+
import TokenSymbol from '@/components/TokenSymbol.vue'
61+
</script>

src/get-started/protocol/worker/manage-access.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ your workerpool:
4444
| key | description |
4545
| ------------------- | ------------------------------------------------------------------------------------ |
4646
| `workerpool` | workerpool address |
47-
| `workerpoolprice` | price to charge the requester for each execution of the app (in nRLC) |
47+
| `workerpoolprice` | price to charge the requester for each execution of the app (in nano <TokenSymbol />) |
4848
| `volume` | number of authorized uses, each use decreases this number |
4949
| `tag` | restrict usage to a specific runtime such as **Scone** or **Gramine** TEE frameworks |
5050
| `category` | Order category, will define the deal `workClockTimeRef` and its deadlines |
@@ -106,3 +106,7 @@ cancel command.
106106
```bash
107107
iexec order cancel --workerpool <orderHash>
108108
```
109+
110+
<script setup>
111+
import TokenSymbol from '@/components/TokenSymbol.vue'
112+
</script>

src/get-started/protocol/worker/quick-start.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ The iExec Worker participates in a workerpool by computing tasks purchased by
1414
requesters on the iExec marketplace. The iExec Worker must connect to the iExec
1515
Core Scheduler of the workerpool to actively participate in the computation.
1616

17-
A worker will be rewarded with RLC for every properly computed tasks.
17+
A worker will be rewarded with <TokenSymbol /> for every properly computed tasks.
1818

1919
Please note that:
2020

21-
- your wallet must be loaded with RLC. Some RLC must be deposited to your iExec
21+
- your wallet must be loaded with <TokenSymbol />. Some <TokenSymbol /> must be deposited to your iExec
2222
account in order to stake for incoming tasks.
2323
- your computer needs at least 2 CPUs.
2424

@@ -33,14 +33,18 @@ configuration documentation of the
3333
For security reason, it is **highly recommended** to launch your worker in a
3434
virtual machine.
3535

36-
After having loaded some RLC and deposited them to your iExec account, you can
36+
After having loaded some <TokenSymbol /> and deposited them to your iExec account, you can
3737
start your worker.
3838

3939
When the worker initialization process is complete, the worker will be started
4040
and you will get something like: **You worker is all set**. Your worker will now
41-
be able to compute some tasks coming from the iExec network to earn some RLCs.
41+
be able to compute some tasks coming from the iExec network to earn some <TokenSymbol />s.
4242

4343
## Wallet restriction
4444

4545
An exclusive wallet must be associated to your worker. You need N wallets if you
4646
want N workers.
47+
48+
<script setup>
49+
import TokenSymbol from '@/components/TokenSymbol.vue'
50+
</script>

src/guides/build-iapp/manage-access.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Here's the simplified process:
4040
2. **You sign the order** with your wallet
4141
3. **You publish the order** on the iExec marketplace
4242
4. **Users can discover** and execute your iApp according to your conditions
43-
5. **You automatically receive** payment in RLC for each execution
43+
5. **You automatically receive** payment in <TokenSymbol /> for each execution
4444

4545
```
4646
Deployed iApp + Signed App Order = Application accessible on iExec
@@ -231,12 +231,12 @@ Here's the detailed description of each parameter:
231231
**Common values:**
232232

233233
- `"0"` - Free
234-
- `"1000000000"` - 1 RLC per execution
235-
- `"500000000"` - 0.5 RLC per execution
234+
- `"1000000000"` - 1 <TokenSymbol /> per execution
235+
- `"500000000"` - 0.5 <TokenSymbol /> per execution
236236

237237
::: tip
238238

239-
1 RLC = 1,000,000,000 nRLC (10^9)
239+
1 <TokenSymbol /> = 1,000,000,000 nano <TokenSymbol /> (10^9)
240240

241241
:::
242242

@@ -301,3 +301,7 @@ Next steps:
301301
Complete CLI reference
302302
- **[Official Orders Documentation](https://protocol.docs.iex.ec/for-developers/advanced/manage-your-apporders)** -
303303
Protocol-level order management
304+
305+
<script setup>
306+
import TokenSymbol from '@/components/TokenSymbol.vue'
307+
</script>

src/guides/manage-data/manage-access.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ yourself!
190190
Set to `0` for free access, or specify a price to monetize your data
191191
automatically.
192192

193-
**Example**: `pricePerAccess: 1_000_000_000` = 1 RLC per access
193+
**Example**: `pricePerAccess: 1_000_000_000` = 1 <TokenSymbol /> per access
194194

195195
**Want to learn more monetization capabilities?** See our detailed
196196
[Monetize Protected Data guide](/guides/manage-data/monetize-protected-data)
@@ -232,4 +232,5 @@ steps:
232232
<script setup>
233233
import RequiredBadge from '@/components/RequiredBadge.vue'
234234
import OptionalBadge from '@/components/OptionalBadge.vue'
235+
import TokenSymbol from '@/components/TokenSymbol.vue'
235236
</script>

src/guides/use-iapp/getting-started.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ Before you begin, make sure you have:
1717
- Some RLC tokens for paying computation fees (or access to free vouchers
1818
through learning programs) - [Learn about RLC tokens](/get-started/rlc) and
1919
[how to bridge them](/get-started/tooling-and-explorers/bridge)
20-
- **Note**: On Arbitrum, you'll need AETH (Arbitrum ETH) instead of RLC
2120
- Basic understanding of blockchain transactions
2221
- iExec SDK installed
2322

src/guides/use-iapp/how-to-pay-executions.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ and cost management strategies.
1414

1515
iExec supports multiple payment methods for executing iApps:
1616

17-
1. **RLC Tokens**: Direct payment using RLC (Request Compute Language) tokens
17+
1. **RLC Tokens**: Direct payment using <TokenSymbol /> tokens
1818
2. **Vouchers**: Pre-funded vouchers for simplified payment
1919
3. **Mixed Payment**: Combination of RLC and vouchers
2020

@@ -120,7 +120,7 @@ const result = await dataProtectorCore.processProtectedData({
120120

121121
::: tip
122122

123-
If your voucher doesn't have enough xRLC to cover the deal, the SDK will
123+
If your voucher doesn't have enough <TokenSymbol /> to cover the deal, the SDK will
124124
automatically get the required amount to your iExec account. Ensure that your
125125
voucher is authorized to access your iExec account and that your account has
126126
sufficient funds for this transfer to proceed.
@@ -496,4 +496,5 @@ Now that you understand payment methods:
496496

497497
<script setup>
498498
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
499+
import TokenSymbol from '@/components/TokenSymbol.vue'
499500
</script>

src/guides/use-iapp/how-to-pay/how-to-pay-for-web3mail.md

Lines changed: 16 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: How to Pay for Web3Mail
33
description:
44
Learn how to pay for Web3Mail's confidential computing power using vouchers
5-
and xLC for secure, blockchain-based email communication.
5+
and RLC for secure, blockchain-based email communication.
66
---
77

88
# How to Pay for Web3Mail
@@ -14,7 +14,7 @@ The `sendEmail` function uses confidential computing power to encrypt and send
1414
messages, ensuring secure and decentralized email exchanges.
1515

1616
This guide explains how to pay for Web3Mail's computing power using **vouchers**
17-
and **xRLC**, detailing the steps for each method.
17+
and **<TokenSymbol />**, detailing the steps for each method.
1818

1919
## Using Vouchers for Web3Mail <ChainNotSupportedBadge />
2020

@@ -52,8 +52,8 @@ contract to debit your account if the voucher balance is insufficient. This
5252
ensures that if the voucher alone doesn't cover the execution cost, the
5353
remaining balance is automatically deducted from your account.
5454

55-
For additional information on using xRLC for fallback payment in Web3Mail, refer
56-
to the **Using xRLC with Web3Mail** section.
55+
For additional information on using <TokenSymbol /> for fallback payment in Web3Mail, refer
56+
to the **Using <TokenSymbol /> with Web3Mail** section.
5757

5858
### Step 4: Execute Web3Mail's SendEmail Function
5959

@@ -73,17 +73,17 @@ const sendEmail = await web3mail.sendEmail({
7373
});
7474
```
7575

76-
## Using xRLC for Web3Mail
76+
## Using <TokenSymbol /> for Web3Mail
7777

78-
If you choose to use xRLC to cover the computational cost of Web3Mail (or if you
78+
If you choose to use <TokenSymbol /> to cover the computational cost of Web3Mail (or if you
7979
need to cover data access costs such as retrieving the recipient's email
8080
address), follow these steps:
8181

8282
### Install the iExec SDK
8383

8484
To manage RLC tokens, developers must use the iExec SDK, which offers all the
8585
necessary tools for interacting with the iExec platform. This includes
86-
depositing, withdrawing, and checking balances of RLC and xRLC
86+
depositing, withdrawing, and checking balances of RLC and <TokenSymbol />
8787

8888
- In your JS/TS project npm install iexec
8989
- Instantiate the iExec SDK (see the
@@ -97,32 +97,19 @@ const iexec = new IExec({ ethProvider: window.ethereum });
9797

9898
### Purchase RLC
9999

100-
Obtain RLC tokens from a supported cryptocurrency exchange.
100+
Obtain RLC tokens from a supported cryptocurrency exchange. For detailed information on how to buy RLC tokens, see our [RLC Token guide](/get-started/rlc) which covers all available DEX and CEX supported.
101101

102-
### Convert to xRLC
102+
For detailed instructions on how to bridge RLC tokens between networks, see our [Bridge guide](/get-started/tooling-and-explorers/bridge) which covers all supported networks and bridging methods.
103103

104-
Use the iExec Bridge to convert your RLC into xRLC for use on iExec's sidechain.
105-
The bridging operation follows the lock & mint / burn & unlock principle. When
106-
sending tokens from Mainnet to Bellecour, the bridge locks the initial amount on
107-
the source chain and mints the equivalent on the destination chain. When going
108-
in the other direction, it burns tokens on the Sidechain and unlocks the same
109-
amount on Mainnet. The bridged asset is called xRLC on Bellecour.
104+
### Deposit <TokenSymbol />
110105

111-
Users can send tokens from the Ethereum Mainnet to the iExec Sidechain or
112-
vice-versa using the Account Manager
113-
([iExec Explorer](https://explorer.iex.ec/bellecour) or
114-
[POA Bridge UI](https://bridge-bellecour.iex.ec/)) available across all iExec
115-
products.
116-
117-
### Deposit xRLC
118-
119-
Deposit the xRLC into your iExec account using the command:
106+
Deposit the <TokenSymbol /> into your iExec account using the command:
120107

121108
```javascript
122-
iexec.account.deposit(xRLC_amount);
109+
iexec.account.deposit(RLC_amount);
123110
```
124111

125-
This converts xRLC into sRLC, used as proof of funds for task execution.
112+
This converts <TokenSymbol /> into sRLC, used as proof of funds for task execution.
126113

127114
### Check sRLC Balance
128115

@@ -135,7 +122,7 @@ iexec.account.show();
135122
### Execute sendEmail
136123

137124
Set the `useVoucher` parameter to `false` when using Web3Mail's sendEmail
138-
function to pay with xRLC:
125+
function to pay with <TokenSymbol />:
139126

140127
```ts twoslash
141128
import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';
@@ -153,7 +140,7 @@ const sendEmail = await web3mail.sendEmail({
153140

154141
### Withdraw sRLC (If Desired)
155142

156-
Convert sRLC back to xRLC and withdraw to your wallet using:
143+
Convert sRLC back to <TokenSymbol /> and withdraw to your wallet using:
157144

158145
```javascript
159146
iexec.account.withdraw(RLC_amount);
@@ -163,4 +150,5 @@ iexec.account.withdraw(RLC_amount);
163150
// Assets
164151
import builderDashboardImage from '@/assets/tooling-&-explorers/builder-dashboard/builder-dashboard.png';
165152
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
153+
import TokenSymbol from '@/components/TokenSymbol.vue'
166154
</script>

0 commit comments

Comments
 (0)