Skip to content

Commit f07498f

Browse files
committed
refactor: clean up whitespace and improve documentation clarity
1 parent 648f750 commit f07498f

File tree

15 files changed

+92
-91
lines changed

15 files changed

+92
-91
lines changed

src/components/TokenSymbol.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ const userStore = useUserStore();
1111
// Computed property to get the correct token symbol based on selected chain
1212
const tokenSymbol = computed(() => {
1313
const currentChainId = userStore.getCurrentChainId();
14-
14+
1515
// Bellecour (0x86) uses xRLC, Arbitrum (42161) uses RLC
1616
if (currentChainId === 0x86) {
1717
return 'xRLC';
1818
} else if (currentChainId === 42161) {
1919
return 'RLC';
2020
}
21-
21+
2222
// Default fallback
2323
return 'RLC';
2424
});

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

Lines changed: 11 additions & 11 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 specifig 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 <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 specifig 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.

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,13 @@ 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 tasks.
17+
A worker will be rewarded with <TokenSymbol /> for every properly computed
18+
tasks.
1819

1920
Please note that:
2021

21-
- your wallet must be loaded with <TokenSymbol />. Some <TokenSymbol /> must be deposited to your iExec
22-
account in order to stake for incoming tasks.
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.
2324
- your computer needs at least 2 CPUs.
2425

2526
## Start a worker
@@ -33,12 +34,13 @@ configuration documentation of the
3334
For security reason, it is **highly recommended** to launch your worker in a
3435
virtual machine.
3536

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

3940
When the worker initialization process is complete, the worker will be started
4041
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 <TokenSymbol />s.
42+
be able to compute some tasks coming from the iExec network to earn some
43+
<TokenSymbol />s.
4244

4345
## Wallet restriction
4446

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ orders:
6666
When you execute an iApp, the system matches your request with available orders
6767
from all three categories. For a deeper understanding of how orders work and how
6868
to manage them, see the
69-
[Build & Deploy guide](/build-iapp/guides/build-&-deploy) in the Build iApp
69+
[Build & Deploy guide](/guides/build-iapp/build-&-deploy) in the Build iApp
7070
section.
7171

7272
## Detailed Guides

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,10 @@ const result = await dataProtectorCore.processProtectedData({
120120

121121
::: tip
122122

123-
If your voucher doesn't have enough <TokenSymbol /> to cover the deal, the SDK will
124-
automatically get the required amount to your iExec account. Ensure that your
125-
voucher is authorized to access your iExec account and that your account has
126-
sufficient funds for this transfer to proceed.
123+
If your voucher doesn't have enough <TokenSymbol /> to cover the deal, the SDK
124+
will automatically get the required amount to your iExec account. Ensure that
125+
your voucher is authorized to access your iExec account and that your account
126+
has sufficient funds for this transfer to proceed.
127127

128128
:::
129129

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

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -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 <TokenSymbol /> for fallback payment in Web3Mail, refer
56-
to the **Using <TokenSymbol /> with Web3Mail** section.
55+
For additional information on using <TokenSymbol /> for fallback payment in
56+
Web3Mail, refer to the **Using <TokenSymbol /> with Web3Mail** section.
5757

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

@@ -75,9 +75,9 @@ const sendEmail = await web3mail.sendEmail({
7575

7676
## Using <TokenSymbol /> for Web3Mail
7777

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

8282
### Install the iExec SDK
8383

@@ -97,9 +97,14 @@ const iexec = new IExec({ ethProvider: window.ethereum });
9797

9898
### Purchase RLC
9999

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.
100+
Obtain RLC tokens from a supported cryptocurrency exchange. For detailed
101+
information on how to buy RLC tokens, see our
102+
[RLC Token guide](/get-started/rlc) which covers all available DEX and CEX
103+
supported.
101104

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.
105+
For detailed instructions on how to bridge RLC tokens between networks, see our
106+
[Bridge guide](/get-started/tooling-and-explorers/bridge) which covers all
107+
supported networks and bridging methods.
103108

104109
### Deposit <TokenSymbol />
105110

@@ -109,7 +114,8 @@ Deposit the <TokenSymbol /> into your iExec account using the command:
109114
iexec.account.deposit(RLC_amount);
110115
```
111116

112-
This converts <TokenSymbol /> into sRLC, used as proof of funds for task execution.
117+
This converts <TokenSymbol /> into sRLC, used as proof of funds for task
118+
execution.
113119

114120
### Check sRLC Balance
115121

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

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: How to Pay for Web3Telegram
33
description:
4-
Learn how to pay for Web3Telegram's confidential computing power using vouchers
5-
and RLC for secure, blockchain-based email communication.
4+
Learn how to pay for Web3Telegram's confidential computing power using
5+
vouchers and RLC for secure, blockchain-based email communication.
66
---
77

88
# How to Pay for Web3Telegram
@@ -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 <TokenSymbol /> for fallback payment in Web3Telegram,
56-
refer to the **Using <TokenSymbol /> with Web3Telegram** section.
55+
For additional information on using <TokenSymbol /> for fallback payment in
56+
Web3Telegram, refer to the **Using <TokenSymbol /> with Web3Telegram** section.
5757

5858
### Step 4: Execute Web3Telegram's `sendTelegram` Function
5959

@@ -81,9 +81,9 @@ const sendTelegram = await web3telegram.sendTelegram({
8181

8282
## Using <TokenSymbol /> for Web3Telegram
8383

84-
If you choose to use <TokenSymbol /> to cover the computational cost of Web3Telegram (or if
85-
you need to cover data access costs such as retrieving the recipient's Chat Id),
86-
follow these steps:
84+
If you choose to use <TokenSymbol /> to cover the computational cost of
85+
Web3Telegram (or if you need to cover data access costs such as retrieving the
86+
recipient's Chat Id), follow these steps:
8787

8888
### Install the iExec SDK
8989

@@ -103,9 +103,14 @@ const iexec = new IExec({ ethProvider: window.ethereum });
103103

104104
### Purchase RLC
105105

106-
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.
106+
Obtain RLC tokens from a supported cryptocurrency exchange. For detailed
107+
information on how to buy RLC tokens, see our
108+
[RLC Token guide](/get-started/rlc) which covers all available DEX and CEX
109+
supported.
107110

108-
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.
111+
For detailed instructions on how to bridge RLC tokens between networks, see our
112+
[Bridge guide](/get-started/tooling-and-explorers/bridge) which covers all
113+
supported networks and bridging methods.
109114

110115
### Deposit <TokenSymbol />
111116

@@ -115,7 +120,8 @@ Deposit the <TokenSymbol /> into your iExec account using the command:
115120
iexec.account.deposit(RLC_amount);
116121
```
117122

118-
This converts <TokenSymbol /> into sRLC, used as proof of funds for task execution.
123+
This converts <TokenSymbol /> into sRLC, used as proof of funds for task
124+
execution.
119125

120126
### Check sRLC Balance
121127

src/guides/use-iapp/introduction.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ 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 participants
56+
9. **Payment Settlement**: <TokenSymbol /> tokens are distributed to all
57+
participants
5758

5859
### Network Architecture Diagram
5960

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

7677
This decentralized architecture ensures that no single entity has control over
7778
the entire process, while the use of TEEs guarantees that sensitive data remains

src/references/dataProtector/dataProtectorCore/processProtectedData.md

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

154154
::: tip
155155

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

161161
:::
162162

src/references/dataProtector/types.md

Lines changed: 2 additions & 2 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 `requesterrestrict` for each
21-
use of this `protectedData`
20+
- Price (in n<TokenSymbol />) to charge the user specified in
21+
`requesterrestrict` for each use of this `protectedData`
2222

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

0 commit comments

Comments
 (0)