Skip to content

Commit 1dd5853

Browse files
committed
refactor: remove TokenSymbol component and replace with RLC in documentation
1 parent 7ec9bff commit 1dd5853

File tree

12 files changed

+51
-104
lines changed

12 files changed

+51
-104
lines changed

src/components/TokenSymbol.vue

Lines changed: 0 additions & 25 deletions
This file was deleted.

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

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,17 @@ iexec order init --workerpool
4141
Edit the `workerpoolorder` part in `iexec.json` to set the conditions to use
4242
your workerpool:
4343

44-
| key | description |
45-
| ------------------- | ------------------------------------------------------------------------------------- |
46-
| `workerpool` | workerpool address |
47-
| `workerpoolprice` | price to charge the requester for each execution of the app (in nano <TokenSymbol />) |
48-
| `volume` | number of authorized uses, each use decreases this number |
49-
| `tag` | restrict usage to a specific runtime such as **Scone** or **Gramine** TEE frameworks |
50-
| `category` | Order category, will define the deal `workClockTimeRef` and its deadlines |
51-
| `trust` | Trust level of the execution, impacts the number of replicates |
52-
| `apprestrict` | restrict the workerpool usage to a specific app (1) |
53-
| `datasetrestrict` | restrict the workerpool usage to a specific dataset (1) |
54-
| `requesterrestrict` | restrict the workerpool usage to a specific requester (1) |
44+
| key | description |
45+
| ------------------- | ------------------------------------------------------------------------------------ |
46+
| `workerpool` | workerpool address |
47+
| `workerpoolprice` | price to charge the requester for each execution of the app (in nano RLC) |
48+
| `volume` | number of authorized uses, each use decreases this number |
49+
| `tag` | restrict usage to a specific runtime such as **Scone** or **Gramine** TEE frameworks |
50+
| `category` | Order category, will define the deal `workClockTimeRef` and its deadlines |
51+
| `trust` | Trust level of the execution, impacts the number of replicates |
52+
| `apprestrict` | restrict the workerpool usage to a specific app (1) |
53+
| `datasetrestrict` | restrict the workerpool usage to a specific dataset (1) |
54+
| `requesterrestrict` | restrict the workerpool usage to a specific requester (1) |
5555

5656
1. the restriction is disabled by default with
5757
0x0000000000000000000000000000000000000000.
@@ -106,7 +106,3 @@ 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: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,12 @@ 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 <TokenSymbol /> for every properly computed
18-
tasks.
17+
A worker will be rewarded with RLC for every properly computed tasks.
1918

2019
Please note that:
2120

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

2625
## Start a worker
@@ -34,18 +33,14 @@ configuration documentation of the
3433
For security reason, it is **highly recommended** to launch your worker in a
3534
virtual machine.
3635

37-
After loading some <TokenSymbol /> and depositing them to your iExec account,
38-
you can start your worker.
36+
After loading some RLC and depositing them to your iExec account, you can start
37+
your worker.
3938

4039
When the worker initialization process is complete, the worker will start and
4140
you will get: **Your worker is all set**. Your worker will now be able to
42-
compute tasks from the iExec network to earn <TokenSymbol />.
41+
compute tasks from the iExec network to earn RLC.
4342

4443
## Wallet restriction
4544

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

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

Lines changed: 4 additions & 8 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 <TokenSymbol /> for each execution
43+
5. **You automatically receive** payment in RLC 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 <TokenSymbol /> per execution
235-
- `"500000000"` - 0.5 <TokenSymbol /> per execution
234+
- `"1000000000"` - 1 RLC per execution
235+
- `"500000000"` - 0.5 RLC per execution
236236

237237
::: tip
238238

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

241241
:::
242242

@@ -301,7 +301,3 @@ 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: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ yourself!
169169
Set to `0` for free access, or specify a price to monetize your data
170170
automatically.
171171

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

174174
**Want to learn more monetization capabilities?** See our detailed
175175
[Monetize Protected Data guide](/guides/manage-data/monetize-protected-data)
@@ -211,5 +211,4 @@ steps:
211211
<script setup>
212212
import RequiredBadge from '@/components/RequiredBadge.vue'
213213
import OptionalBadge from '@/components/OptionalBadge.vue'
214-
import TokenSymbol from '@/components/TokenSymbol.vue'
215214
</script>

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

Lines changed: 7 additions & 8 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 iApp:
1616

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

@@ -103,8 +103,8 @@ balance is insufficient. This ensures that if the voucher alone doesn't cover
103103
the execution cost, the remaining balance is automatically deducted from your
104104
account.
105105

106-
For additional information on using <TokenSymbol /> for fallback payment in
107-
Web3Mail, refer to the **Using <TokenSymbol /> with Web3Mail** section.
106+
For additional information on using RLC for fallback payment in Web3Mail, refer
107+
to the **Using RLC with Web3Mail** section.
108108

109109
### Step 4: Use Voucher
110110

@@ -161,10 +161,10 @@ const result = await dataProtectorCore.processProtectedData({
161161

162162
::: tip
163163

164-
If your voucher doesn't have enough <TokenSymbol /> to cover the deal, the SDK
165-
will automatically get the required amount to your iExec account. Ensure that
166-
your voucher is authorized to access your iExec account and that your account
167-
has sufficient funds for this transfer to proceed.
164+
If your voucher doesn't have enough RLC to cover the deal, the SDK will
165+
automatically get the required amount to your iExec account. Ensure that your
166+
voucher is authorized to access your iExec account and that your account has
167+
sufficient funds for this transfer to proceed.
168168

169169
:::
170170

@@ -239,7 +239,6 @@ Now that you understand payment methods:
239239

240240
<script setup>
241241
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
242-
import TokenSymbol from '@/components/TokenSymbol.vue'
243242
import ImageViewer from '@/components/ImageViewer.vue';
244243

245244
// Assets

src/guides/use-iapp/introduction.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,7 @@ When a deal is triggered, the following sequence occurs:
5353
7. **Result Generation**: Computation results are generated
5454
8. **Result Delivery**: Results are returned to the requester through the
5555
network
56-
9. **Payment Settlement**: <TokenSymbol /> tokens are distributed to all
57-
participants
56+
9. **Payment Settlement**: RLC tokens are distributed to all participants
5857

5958
### Network Architecture Diagram
6059

@@ -71,8 +70,8 @@ When a deal is triggered, the following sequence occurs:
7170
5. **Data Access**: iApp requests access to protected data through secure
7271
channels
7372
6. **Computation**: iApp processes data within the TEE, maintaining privacy
74-
7. **Payment Distribution**: <TokenSymbol /> tokens are distributed to all
75-
participants based on completed tasks
73+
7. **Payment Distribution**: RLC tokens are distributed to all participants
74+
based on completed tasks
7675

7776
This decentralized architecture ensures that no single entity has control over
7877
the entire process, while the use of TEEs guarantees that sensitive data remains
@@ -83,7 +82,3 @@ protected throughout the computation.
8382
Ready to start using iApp? Check out our
8483
[Getting Started Guide](/guides/use-iapp/getting-started) to learn how to find,
8584
execute, and interact with iApp on the iExec network.
86-
87-
<script setup>
88-
import TokenSymbol from '@/components/TokenSymbol.vue'
89-
</script>

src/references/dataProtector/dataProtectorCore/grantAccess.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ const grantedAccess = await dataProtectorCore.grantAccess({
165165
::: tip
166166

167167
`pricePerAccess` is expressed in nano RLC (nRLC). nRLC is the smallest
168-
subdivision of the <TokenSymbol /> token, 1 <TokenSymbol /> equals to 10^9 nRLC.
168+
subdivision of the RLC token, 1 RLC equals to 10^9 nRLC.
169169

170170
When provided, `pricePerAccess` must be a non-negative integer value.
171171

@@ -254,5 +254,4 @@ The result of this method confirms the new access grant. It consists of a JSON
254254
<script setup>
255255
import RequiredBadge from '@/components/RequiredBadge.vue'
256256
import OptionalBadge from '@/components/OptionalBadge.vue'
257-
import TokenSymbol from '@/components/TokenSymbol.vue'
258257
</script>

src/references/dataProtector/dataProtectorCore/processProtectedData.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,10 @@ const processProtectedDataResponse =
154154

155155
::: tip
156156

157-
If your voucher doesn't have enough <TokenSymbol /> to cover the deal, the SDK
158-
will automatically get the required amount to your iExec account. Ensure that
159-
your voucher is authorized to access your iExec account and that your account
160-
has sufficient funds for this transfer to proceed.
157+
If your voucher doesn't have enough RLC to cover the deal, the SDK will
158+
automatically get the required amount to your iExec account. Ensure that your
159+
voucher is authorized to access your iExec account and that your account has
160+
sufficient funds for this transfer to proceed.
161161

162162
:::
163163

@@ -501,5 +501,4 @@ processed during the task.
501501
import RequiredBadge from '@/components/RequiredBadge.vue'
502502
import OptionalBadge from '@/components/OptionalBadge.vue'
503503
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
504-
import TokenSymbol from '@/components/TokenSymbol.vue'
505504
</script>

src/references/dataProtector/types.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Types in DataProtector.
1717

1818
### datasetprice: <span class="text-yellow">`string`</span>
1919

20-
- Price (in n<TokenSymbol />) to charge the user specified in
21-
`requesterrestrict` for each use of this `protectedData`
20+
- Price (in nRLC) to charge the user specified in `requesterrestrict` for each
21+
use of this `protectedData`
2222

2323
### volume: <span class="text-yellow">`string`</span>
2424

@@ -123,7 +123,3 @@ _Hash example:_ `0xc9c2d58fc01fe54149b7daf49a0026d4ab1fdd3d10fb7c76350790fff03fe
123123

124124
You can read more about he iExec Explorer
125125
[here](https://protocol.docs.iex.ec/for-developers/toolbox/iexec-explorer).
126-
127-
<script setup>
128-
import TokenSymbol from '@/components/TokenSymbol.vue'
129-
</script>

0 commit comments

Comments
 (0)