Skip to content

Commit f85de92

Browse files
committed
refactor: streamline advanced iApp documentation and remove deprecated sections
- Removed outdated references and sections from the advanced iApp guides, including the overview and SGX encrypted dataset. - Updated sidebar to reflect the changes in the advanced section. - Enhanced documentation with dynamic chain name integration for commands. - Removed unused image assets and improved clarity in examples.
1 parent 6b8161c commit f85de92

File tree

18 files changed

+175
-508
lines changed

18 files changed

+175
-508
lines changed

.vitepress/sidebar.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -202,10 +202,6 @@ export function getSidebar() {
202202
text: 'Advanced',
203203
collapsed: true,
204204
items: [
205-
{
206-
text: 'Overview',
207-
link: '/guides/build-iapp/advanced/overview',
208-
},
209205
{
210206
text: 'Quick Start for Developers',
211207
link: '/guides/build-iapp/advanced/quick-start-for-developers',
@@ -215,17 +211,13 @@ export function getSidebar() {
215211
link: '/guides/build-iapp/advanced/your-first-app',
216212
},
217213
{
218-
text: 'Build your first SGX app (SCONE)',
214+
text: 'Build your first SGX app',
219215
link: '/guides/build-iapp/advanced/create-your-first-sgx-app',
220216
},
221217
{
222218
text: 'End-to-end Encryption',
223219
link: '/guides/build-iapp/advanced/end-to-end-encryption',
224220
},
225-
{
226-
text: 'SGX Encrypted Dataset',
227-
link: '/guides/build-iapp/advanced/sgx-encrypted-dataset',
228-
},
229221
{
230222
text: 'Access Confidential Assets',
231223
link: '/guides/build-iapp/advanced/access-confidential-assets',
-110 KB
Binary file not shown.

src/guides/build-iapp/advanced/access-confidential-assets.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,18 @@ The SMS currently supports 3 types of secrets:
3131
is not linked to any application. When a requester buys a task, the requester
3232
can declare which secrets can be accessed by the application. Doing so, a
3333
single requester secret can be shared with multiple applications.
34-
3. [Dataset secret](sgx-encrypted-dataset.md): A dataset secret is not directly
35-
accessible from the application but its decrypted content is. If a dataset is
36-
requested and authorized to be used in it, its content will be automatically
37-
decrypted in the application enclave. To monetize such a dataset on iExec,
38-
the original dataset must be encrypted using the iExec SDK, its encrypted
39-
counterpart must be publicly available and its encryption key pushed into the
40-
SMS.
34+
3. [Protected Data secret](/guides/manage-data/manage-access): A protected data
35+
secret is not directly accessible from the application but its decrypted
36+
content is. If a Protected Data is requested and authorized to be used in it,
37+
its content will be automatically decrypted in the application enclave.
4138

4239
Here is a general overview of how confidential assets are used on iExec:
4340

4441
```mermaid
4542
graph TD
4643
Req[Requester] -->|1.a. Push secret| SMS[SMS]
4744
AppDev[Application developer] -->|1.b. Push secret| SMS
48-
DatasetOwn[Dataset owner] -->|1.c. Push secret| SMS
45+
ProtectedDataOwn[ProtectedData owner] -->|1.c. Push secret| SMS
4946
Req --> |2 . Buy task| Chain
5047
Chain[Blockchain] --> |3 . Notify task to compute| Worker[Worker/Workerpool]
5148
Worker --> |4 . Launch TEE application| App[TEE application]
@@ -58,4 +55,4 @@ graph TD
5855
You now understand how these three kinds of confidential assets work on iExec,
5956
you can go one step further by learning how to manipulate them:
6057

61-
- [Access a confidential dataset](sgx-encrypted-dataset.md)
58+
- [Access to a Protected Data](guides/build-iapp/inputs-and-outputs)

src/guides/build-iapp/advanced/create-your-first-sgx-app.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,8 @@ docker run --rm -e SCONE_HASH=1 <docker-hub-user>/tee-scone-hello-world:1.0.0-de
225225

226226
Deploy the app with the standard command:
227227

228-
```bash
229-
iexec app deploy
228+
```bash twoslash
229+
iexec app deploy --chain {{chainName}}
230230
```
231231

232232
### Run the TEE app
@@ -239,18 +239,15 @@ a debug workerpool, use the debug workerpool
239239

240240
You are now ready to run the app
241241

242-
```bash
243-
iexec app run --tag tee,scone --workerpool debug-v8-learn.main.pools.iexec.eth --watch
242+
```bash twoslash
243+
iexec app run --chain {{chainName}} --tag tee,scone --workerpool debug-v8-learn.main.pools.iexec.eth --watch
244244
```
245245

246246
::: info
247247

248248
You noticed we used `debug-v8-learn.main.pools.iexec.eth` instead of an ethereum
249249
address, this is an ENS name.
250250

251-
The [ENS (Ethereum Name Service)](https://ens.domains/) protocol enables
252-
associating decentralized naming to ethereum addresses.
253-
254251
:::
255252

256253
::: info
@@ -269,3 +266,16 @@ may need to use some confidential data to get the full potential of the
269266

270267
- [Access confidential assets from your app](access-confidential-assets.md)
271268
- [Protect the result](end-to-end-encryption.md)
269+
270+
<script setup>
271+
import { computed } from 'vue';
272+
import useUserStore from '@/stores/useUser.store';
273+
import {getChainById} from '@/utils/chain.utils';
274+
275+
// Get current chain and compute explorer info
276+
const userStore = useUserStore();
277+
const selectedChain = computed(() => userStore.getCurrentChainId());
278+
279+
const chainData = computed(() => getChainById(selectedChain.value));
280+
const chainName = computed(() => chainData.value.chainName);
281+
</script>

src/guides/build-iapp/advanced/create-your-first-tdx-app.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🛡️ Build Intel TDX App (Experimental)
1+
# 🛡️ Build Intel TDX App (Experimental) <ChainNotSupportedBadge/>
22

33
In this tutorial, you will learn how to build and run a Confidential Computing
44
application with Intel TDX technology using both traditional deployment and the
@@ -309,3 +309,7 @@ EXPERIMENTAL_TDX_APP=true iapp run <app-address>
309309
in TDX
310310
- **[Advanced iApp Building](/guides/build-iapp/advanced/overview)** - Advanced
311311
development techniques
312+
313+
<script setup>
314+
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
315+
</script>

src/guides/build-iapp/advanced/end-to-end-encryption.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,22 @@ private key in the file `<0x-your-wallet-address>_key`.
6464

6565
Now, push the public key to the SMS:
6666

67-
```bash
68-
iexec result push-encryption-key --tee-framework scone
67+
```bash twoslash
68+
iexec result push-encryption-key --tee-framework --chain {{chainName}} scone
6969
```
7070

7171
And check it using:
7272

73-
```bash
74-
iexec result check-encryption-key --tee-framework scone
73+
```bash twoslash
74+
iexec result check-encryption-key --tee-framework --chain {{chainName}} scone
7575
```
7676

7777
Now to see that in action, you'd need to trigger a task and specify yourself as
7878
the beneficiary in the command:
7979

80-
```bash
80+
```bash twoslash
8181
iexec app run <0x-your-app-address> \
82+
--chain {{chainName}}
8283
--workerpool debug-v8-learn.main.pools.iexec.eth \
8384
--tag tee,scone \
8485
--encrypt-result \
@@ -87,8 +88,8 @@ iexec app run <0x-your-app-address> \
8788

8889
Wait for the task to be `COMPLETED` and download the result:
8990

90-
```bash
91-
iexec task show <0x-your-task-id> --download
91+
```bash twoslash
92+
iexec task show --chain {{chainName}} <0x-your-task-id> --download
9293
```
9394

9495
If you extract the obtained zip and try to read the content of the file
@@ -134,3 +135,16 @@ the dataset, and the result.
134135
135136
You can go to the advanced section and learn more about managing orders on the
136137
iExec to effectively monetize your applications and datasets.
138+
139+
<script setup>
140+
import { computed } from 'vue';
141+
import useUserStore from '@/stores/useUser.store';
142+
import {getChainById} from '@/utils/chain.utils';
143+
144+
// Get current chain and compute explorer info
145+
const userStore = useUserStore();
146+
const selectedChain = computed(() => userStore.getCurrentChainId());
147+
148+
const chainData = computed(() => getChainById(selectedChain.value));
149+
const chainName = computed(() => chainData.value.chainName);
150+
</script>

src/guides/build-iapp/advanced/overview.md

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

src/guides/build-iapp/advanced/quick-start-for-developers.md

Lines changed: 39 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Ethereum wallet. See iExec SDK documentation
6464

6565
Create a new folder for your iExec project and initialize the project:
6666

67-
```text
67+
```bash
6868
mkdir ~/iexec-projects
6969
cd ~/iexec-projects
7070
iexec init --skip-wallet
@@ -87,7 +87,7 @@ for a full list.
8787

8888
You can now check your wallet content:
8989

90-
```text
90+
```bash
9191
iexec wallet show
9292
```
9393

@@ -102,7 +102,7 @@ Let's deploy an iExec app!
102102

103103
Initialize a new application
104104

105-
```text
105+
```bash
106106
iexec app init
107107
```
108108

@@ -134,22 +134,22 @@ iExec.
134134
You will now deploy your app on iExec, this will be your first transaction on
135135
the blockchain:
136136

137-
```text
138-
iexec app deploy
137+
```bash twoslash
138+
iexec app deploy --chain {{chainName}}
139139
```
140140

141141
::: tip
142142

143143
While running `iexec app deploy` you sent your first transaction on the
144-
bellecour blockchain.
144+
{{chainName}} blockchain.
145145

146146
:::
147147

148148
You can check your deployed apps with their index, let's check your last
149149
deployed app:
150150

151-
```text
152-
iexec app show
151+
```bash twoslash
152+
iexec app show --chain {{chainName}}
153153
```
154154

155155
## Run your app on iExec
@@ -173,21 +173,21 @@ At any time you can:
173173

174174
- view your balance
175175

176-
```sh
177-
iexec account show
176+
```bash twoslash
177+
iexec account show --chain {{chainName}}
178178
```
179179

180180
- deposit RLC from your wallet to your iExec Account
181181

182-
```sh
183-
iexec account deposit <amount>
182+
```bash twoslash
183+
iexec account deposit --chain {{chainName}} <amount>
184184
```
185185

186186
- withdraw RLC from your iExec account to your wallet \(only stake can be
187187
withdrawn\)
188188

189-
```sh
190-
iexec account withdraw <amount>
189+
```bash twoslash
190+
iexec account withdraw --chain {{chainName}} <amount>
191191
```
192192

193193
:::
@@ -197,8 +197,8 @@ to pay for the computation.
197197

198198
Everything is ready to run your application!
199199

200-
```text
201-
iexec app run --args <your-name-here> --workerpool prod-v8-learn.main.pools.iexec.eth --watch
200+
```bash twoslash
201+
iexec app run --chain {{chainName}} --args <your-name-here> --workerpool prod-v8-learn.main.pools.iexec.eth --watch
202202
```
203203

204204
::: info
@@ -253,14 +253,14 @@ is a 32Bytes hexadecimal string\).
253253

254254
Download the result of your task
255255

256-
```text
257-
iexec task show <taskid> --download my-result
256+
```bash twoslash
257+
iexec task show --chain {{chainName}} <taskid> --download my-result
258258
```
259259

260260
You can get your taskid with the command:
261261

262-
```text
263-
iexec deal show <dealid>
262+
```bash twoslash
263+
iexec deal show --chain {{chainName}} <dealid>
264264
```
265265

266266
::: info
@@ -274,7 +274,7 @@ produce an text file in `result.txt`.
274274

275275
Let's discover the result of the computation.
276276

277-
```text
277+
```bash
278278
unzip my-result.zip -d my-result
279279
cat my-result/result.txt
280280
```
@@ -301,13 +301,13 @@ The conditions to use an app are defined in the **apporder**.
301301

302302
Publish a new apporder for your application.
303303

304-
```text
305-
iexec app publish
304+
```bash twoslash
305+
iexec app publish --chain {{chainName}}
306306
```
307307

308308
::: info
309309

310-
`iexec app publish` options allows to define custom access rules to the app
310+
`iexec app publish` command allows to define custom access rules to the app
311311
\(run `iexec app publish --help` to discover all the possibilities\).
312312

313313
You will learn more about orders management later, keep the apporder default
@@ -320,18 +320,14 @@ conditions defined in apporder.
320320

321321
You can check the published apporders for your app
322322

323-
```text
324-
iexec orderbook app <your app address>
323+
```bash twoslash
324+
iexec orderbook app --chain {{chainName}} <your app address>
325325
```
326326

327327
Congratulation you just created a decentralized application! Anyone can now
328328
trigger an execution of your application on the iExec decentralized
329329
infrastructure.
330330

331-
- With the iexec SDK CLI
332-
`iexec app run <app address> --workerpool prod-v8-learn.main.pools.iexec.eth`
333-
- On iExec marketplace
334-
335331
## What's next?
336332

337333
You are now familiar with the following key iExec concepts for developers:
@@ -346,3 +342,16 @@ You are now familiar with the following key iExec concepts for developers:
346342
Continue with these guides:
347343

348344
- [Learn how to build your first application running on iExec](your-first-app.md)
345+
346+
<script setup>
347+
import { computed } from 'vue';
348+
import useUserStore from '@/stores/useUser.store';
349+
import {getChainById} from '@/utils/chain.utils';
350+
351+
// Get current chain and compute explorer info
352+
const userStore = useUserStore();
353+
const selectedChain = computed(() => userStore.getCurrentChainId());
354+
355+
const chainData = computed(() => getChainById(selectedChain.value));
356+
const chainName = computed(() => chainData.value.chainName);
357+
</script>

0 commit comments

Comments
 (0)