From bb96aac415d32114065bb5b506790dc1a7fdb5c7 Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Thu, 14 Aug 2025 14:22:55 +0200 Subject: [PATCH 01/27] refactor: update links in navigation and index, remove obsolete build iApp guide --- .vitepress/config.mts | 2 +- src/guides/build-iapp/index.md | 42 ---------------------------------- src/index.md | 4 ++-- 3 files changed, 3 insertions(+), 45 deletions(-) delete mode 100644 src/guides/build-iapp/index.md diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 3aa45736..cf397fc8 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -99,7 +99,7 @@ export default defineConfig({ // https://vitepress.dev/reference/default-theme-config nav: [ { text: 'Get Started', link: '/get-started/welcome' }, - { text: 'Guides', link: '/guides/build-iapp/' }, + { text: 'Guides', link: '/guides/build-iapp/build-&-deploy' }, { text: 'References', link: '/references/dataProtector' }, { component: 'ChainSelector', diff --git a/src/guides/build-iapp/index.md b/src/guides/build-iapp/index.md deleted file mode 100644 index b9fc823a..00000000 --- a/src/guides/build-iapp/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Build iApp Guides -description: Complete guide collection for building privacy-first iApps on iExec ---- - -# 🛠️ Build iApp Guides - -Welcome to the complete collection of guides for building privacy-first -applications on iExec. These guides will walk you through every aspect of -creating, testing, and deploying confidential iApps. - -## 🚀 Getting Started - -- **[Build & Deploy](/guides/build-iapp/build-&-deploy)** - Your first iApp in - 15 minutes -- **[Inputs and Outputs](/guides/build-iapp/inputs-and-outputs)** - Handle data - flow in TEE environment -- **[Debugging](/guides/build-iapp/debugging)** - Troubleshoot execution issues - -## 🔐 Access Control & Management - -- **[Manage Access](/guides/build-iapp/manage-access)** - Control who can use - your iApp -- **[How to Get and Decrypt Results](/guides/build-iapp/how-to-get-and-decrypt-results)** - - Retrieve and use outputs - -## 🧪 Advanced Features - -- **[Using TDX (Experimental)](/guides/build-iapp/using-tdx)** - Next-gen TEE - technology - -## 📚 What's Next? - -After mastering these guides, explore: - -- **[iApp Generator](/references/iapp-generator)** - Complete development - toolkit -- **[What is an iApp?](/get-started/overview/what-is-iapp)** - Core concepts and - TEE overview - -Ready to build your first privacy-preserving application? Start with the -[Build & Deploy](/guides/build-iapp/build-&-deploy) guide! diff --git a/src/index.md b/src/index.md index 8d7bf0ac..6124f3d5 100644 --- a/src/index.md +++ b/src/index.md @@ -25,13 +25,13 @@ features: details: Secure your data with advanced encryption and control access while maintaining privacy using DataProtector - link: /get-started/overview/what-is-protected-data + link: /guides/manage-data/manage-access - icon: 🤖 title: Build iApps details: Create decentralized applications that run on confidential computing infrastructure with our iApp Generator - link: /get-started/overview/what-is-iapp + link: /guides/build-iapp/build-&-deploy - icon: ⚡ title: Use iApps details: From 31c836ac0a1d9560ccb4f8625f34c82df6daf039 Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Thu, 14 Aug 2025 14:27:48 +0200 Subject: [PATCH 02/27] refactor: update payment link in index to point to executions guide --- src/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/index.md b/src/index.md index 6124f3d5..b894152e 100644 --- a/src/index.md +++ b/src/index.md @@ -43,7 +43,7 @@ features: details: Create revenue streams from your data while maintaining full control and privacy - link: /guides/use-iapp/how-to-pay/how-to-pay-for-web3mail + link: /guides/use-iapp/how-to-pay-executions - icon: 🧠 title: Protocols details: From 864defbfcde53e086642c72d7a95a65e87d0ae11 Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Thu, 14 Aug 2025 14:30:50 +0200 Subject: [PATCH 03/27] chore: remove obsolete build iApp guide --- src/build-iapp/guides/build-&-deploy.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 src/build-iapp/guides/build-&-deploy.md diff --git a/src/build-iapp/guides/build-&-deploy.md b/src/build-iapp/guides/build-&-deploy.md deleted file mode 100644 index e69de29b..00000000 From f35b3c6e982d8497a87eb394a86205d51d23ca39 Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Thu, 14 Aug 2025 15:09:57 +0200 Subject: [PATCH 04/27] feat: enhance iApp deployment guide with chain selection and dynamic steps Updated the deployment process to support multiple chains by introducing a conditional template for Arbitrum and Bellecour. Added dynamic steps and completion items for each chain to improve user experience during deployment. --- src/guides/build-iapp/build-&-deploy.md | 270 +++++++++++++++++------- 1 file changed, 190 insertions(+), 80 deletions(-) diff --git a/src/guides/build-iapp/build-&-deploy.md b/src/guides/build-iapp/build-&-deploy.md index a655b1ad..c037f4b1 100644 --- a/src/guides/build-iapp/build-&-deploy.md +++ b/src/guides/build-iapp/build-&-deploy.md @@ -194,86 +194,31 @@ After your tests pass and the package is built, you can deploy your iApp to a supported network. During deployment, you'll enter your DockerHub credentials, specify your app version, and push both standard and TEE-compatible images: - + + + ## Real Examples @@ -359,4 +304,169 @@ for month in range(12): From 2c795553492d486eab1e25bab4e8ba58ec26a19d Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Thu, 14 Aug 2025 16:42:53 +0200 Subject: [PATCH 05/27] fix: update badges in processProtectedData documentation Modified the documentation to include a ChainNotSupportedBadge for the useVoucher parameter and corrected the formatting for the app parameter. Added a script section for badge imports to enhance clarity and maintainability. --- src/components/ChainNotSupportedBadge.vue | 29 +++++++++++++++++++ .../dataProtectorCore/processProtectedData.md | 10 +++++-- 2 files changed, 37 insertions(+), 2 deletions(-) create mode 100644 src/components/ChainNotSupportedBadge.vue diff --git a/src/components/ChainNotSupportedBadge.vue b/src/components/ChainNotSupportedBadge.vue new file mode 100644 index 00000000..1bea99e8 --- /dev/null +++ b/src/components/ChainNotSupportedBadge.vue @@ -0,0 +1,29 @@ + + + diff --git a/src/references/dataProtector/dataProtectorCore/processProtectedData.md b/src/references/dataProtector/dataProtectorCore/processProtectedData.md index de1ca5b0..6289ba4d 100644 --- a/src/references/dataProtector/dataProtectorCore/processProtectedData.md +++ b/src/references/dataProtector/dataProtectorCore/processProtectedData.md @@ -64,7 +64,7 @@ const processProtectedDataResponse = }); ``` -### app {#app-param} +### app **Type:** `AddressOrENS` @@ -128,7 +128,7 @@ const processProtectedDataResponse = }); ``` -### useVoucher +### useVoucher **Type:** `boolean` **Default:** `false` @@ -495,3 +495,9 @@ include a file named **content**, which corresponds to the protected data processed during the task. ::: + + From 9904b8c7f6d65dffbb70004bb6f043a3db971522 Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Thu, 14 Aug 2025 17:18:36 +0200 Subject: [PATCH 06/27] fix: update background color for ChainNotSupportedBadge Adjusted the background color of the ChainNotSupportedBadge component to improve visibility and consistency with design standards. --- src/components/ChainNotSupportedBadge.vue | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/ChainNotSupportedBadge.vue b/src/components/ChainNotSupportedBadge.vue index 1bea99e8..27737ebc 100644 --- a/src/components/ChainNotSupportedBadge.vue +++ b/src/components/ChainNotSupportedBadge.vue @@ -21,7 +21,7 @@ const shouldShow = computed(() => isArbitrumSelected.value); text="Not Supported for this Chain" style=" color: var(--vp-c-orange-1); - background-color: hsla(0, 100%, 50%, 8%); + background-color: hsla(0, 100%, 70%, 8%); margin-top: 1px; margin-right: 4px; " From 57eee4b3aee8baf87490dcfeefdedda6fd1c31b5 Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Thu, 14 Aug 2025 17:18:43 +0200 Subject: [PATCH 07/27] docs: update README and enhance data protection documentation Added explanations for TDX vs SGX, a recap of Workerpool addresses for chains, and noted ENS support on Bellecour in the README. Enhanced various data protection documentation files by importing RequiredBadge and OptionalBadge components for better clarity and consistency. --- README.md | 3 +++ src/components/ChainNotSupportedBadge.vue | 2 +- src/guides/manage-data/manage-access.md | 5 +++++ .../advanced/apps-whitelist/addAppToAddOnlyAppWhitelist.md | 4 ++++ .../advanced/apps-whitelist/getUserAddOnlyAppWhitelist.md | 4 ++++ .../dataProtector/dataProtectorCore/getGrantedAccess.md | 4 ++++ .../dataProtector/dataProtectorCore/getProtectedData.md | 4 ++++ .../dataProtectorCore/getResultFromCompletedTask.md | 7 +++++++ .../dataProtector/dataProtectorCore/grantAccess.md | 5 +++++ .../dataProtector/dataProtectorCore/protectData.md | 2 ++ .../dataProtector/dataProtectorCore/revokeAllAccess.md | 5 +++++ .../dataProtector/dataProtectorCore/revokeOneAccess.md | 4 ++++ .../dataProtector/dataProtectorCore/transferOwnership.md | 4 ++++ .../dataProtectorSharing/collection/addToCollection.md | 5 +++++ .../dataProtectorSharing/collection/removeCollection.md | 4 ++++ .../collection/removeProtectedDataFromCollection.md | 4 ++++ .../dataProtectorSharing/consume/consumeProtectedData.md | 2 ++ .../dataProtectorSharing/read/getCollectionOwners.md | 4 ++++ .../read/getCollectionSubscriptions.md | 4 ++++ .../dataProtectorSharing/read/getCollectionsByOwner.md | 5 +++++ .../read/getProtectedDataInCollections.md | 4 ++++ .../read/getProtectedDataPricingParams.md | 4 ++++ .../dataProtector/dataProtectorSharing/read/getRentals.md | 4 ++++ .../renting/removeProtectedDataFromRenting.md | 4 ++++ .../dataProtectorSharing/renting/rentProtectedData.md | 4 ++++ .../renting/setProtectedDataToRenting.md | 4 ++++ .../dataProtectorSharing/selling/buyProtectedData.md | 5 +++++ .../selling/removeProtectedDataForSale.md | 4 ++++ .../selling/setProtectedDataForSale.md | 4 ++++ .../subscription/removeProtectedDataFromSubscription.md | 4 ++++ .../subscription/setProtectedDataToSubscription.md | 4 ++++ .../subscription/setSubscriptionParams.md | 4 ++++ .../subscription/subscribeToCollection.md | 4 ++++ src/references/web3mail/methods/fetchMyContacts.md | 4 ++++ src/references/web3mail/methods/fetchUserContacts.md | 4 ++++ src/references/web3mail/methods/sendEmail.md | 5 +++++ src/references/web3telegram/methods/fetchMyContacts.md | 4 ++++ src/references/web3telegram/methods/fetchUserContacts.md | 4 ++++ src/references/web3telegram/methods/sendTelegram.md | 6 ++++++ 39 files changed, 160 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cedd359a..d189c831 100644 --- a/README.md +++ b/README.md @@ -192,3 +192,6 @@ for input parameters: - migrate github SDK doc here - migrate pay-per-task page into a guide - check pages (introduction & getting-started) for use-iapp guide +- explain TDX vs SGX +- Give recap of Workerpool address fo chains +- Talk about ENS on Bellecour(it's not supported on arbitrum) diff --git a/src/components/ChainNotSupportedBadge.vue b/src/components/ChainNotSupportedBadge.vue index 27737ebc..bae437a2 100644 --- a/src/components/ChainNotSupportedBadge.vue +++ b/src/components/ChainNotSupportedBadge.vue @@ -21,7 +21,7 @@ const shouldShow = computed(() => isArbitrumSelected.value); text="Not Supported for this Chain" style=" color: var(--vp-c-orange-1); - background-color: hsla(0, 100%, 70%, 8%); + background-color: hsla(15, 100%, 40%, 8%); margin-top: 1px; margin-right: 4px; " diff --git a/src/guides/manage-data/manage-access.md b/src/guides/manage-data/manage-access.md index 7486e25e..d0d0deb1 100644 --- a/src/guides/manage-data/manage-access.md +++ b/src/guides/manage-data/manage-access.md @@ -228,3 +228,8 @@ steps: [schemas and dataset types](/guides/manage-data/handle-schemas-dataset-types) - **Monetize data**: Explore [data monetization strategies](/guides/manage-data/monetize-protected-data) + + diff --git a/src/references/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist.md b/src/references/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist.md index e56acb39..f6e93993 100644 --- a/src/references/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist.md +++ b/src/references/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist.md @@ -96,3 +96,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist.md b/src/references/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist.md index 9472a2b3..fe34dafb 100644 --- a/src/references/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist.md +++ b/src/references/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist.md @@ -59,3 +59,7 @@ import { type GetUserAppWhitelistResponse } from '@iexec/dataprotector'; // Child types import { type AddOnlyAppWhitelist } from '@iexec/dataprotector'; ``` + + diff --git a/src/references/dataProtector/dataProtectorCore/getGrantedAccess.md b/src/references/dataProtector/dataProtectorCore/getGrantedAccess.md index 2ee47134..a2755b91 100644 --- a/src/references/dataProtector/dataProtectorCore/getGrantedAccess.md +++ b/src/references/dataProtector/dataProtectorCore/getGrantedAccess.md @@ -217,3 +217,7 @@ smaller than the page size. **Type:** GrantedAccess See [`GrantedAccess`](../types.md#grantedaccess) + + diff --git a/src/references/dataProtector/dataProtectorCore/getProtectedData.md b/src/references/dataProtector/dataProtectorCore/getProtectedData.md index a25f42ae..b8578125 100644 --- a/src/references/dataProtector/dataProtectorCore/getProtectedData.md +++ b/src/references/dataProtector/dataProtectorCore/getProtectedData.md @@ -191,3 +191,7 @@ import { type ProtectedData } from '@iexec/dataprotector'; ``` See [`ProtectedData`](../types.md#protecteddata) + + diff --git a/src/references/dataProtector/dataProtectorCore/getResultFromCompletedTask.md b/src/references/dataProtector/dataProtectorCore/getResultFromCompletedTask.md index 121b5152..3ee3eacc 100644 --- a/src/references/dataProtector/dataProtectorCore/getResultFromCompletedTask.md +++ b/src/references/dataProtector/dataProtectorCore/getResultFromCompletedTask.md @@ -134,3 +134,10 @@ import { type GetResultFromCompletedTaskResponse } from '@iexec/dataprotector'; `ArrayBuffer` The actual content of the protected file. + +``` + + diff --git a/src/references/dataProtector/dataProtectorCore/grantAccess.md b/src/references/dataProtector/dataProtectorCore/grantAccess.md index cfa8e79f..effb7a4f 100644 --- a/src/references/dataProtector/dataProtectorCore/grantAccess.md +++ b/src/references/dataProtector/dataProtectorCore/grantAccess.md @@ -250,3 +250,8 @@ The result of this method confirms the new access grant. It consists of a JSON `grantedAccess` object. [`GrantedAccess`](../types.md#grantedaccess) + + diff --git a/src/references/dataProtector/dataProtectorCore/protectData.md b/src/references/dataProtector/dataProtectorCore/protectData.md index 16c798f3..1f047598 100644 --- a/src/references/dataProtector/dataProtectorCore/protectData.md +++ b/src/references/dataProtector/dataProtectorCore/protectData.md @@ -439,4 +439,6 @@ To further check your data was correctly created, you can inspect it on the diff --git a/src/references/dataProtector/dataProtectorCore/revokeAllAccess.md b/src/references/dataProtector/dataProtectorCore/revokeAllAccess.md index becf31c3..3275ea34 100644 --- a/src/references/dataProtector/dataProtectorCore/revokeAllAccess.md +++ b/src/references/dataProtector/dataProtectorCore/revokeAllAccess.md @@ -141,3 +141,8 @@ import { type RevokedAccess } from '@iexec/dataprotector'; ``` [`RevokedAccess[]`](../types.md#revokedaccess) + + diff --git a/src/references/dataProtector/dataProtectorCore/revokeOneAccess.md b/src/references/dataProtector/dataProtectorCore/revokeOneAccess.md index 866de9fe..5ff6909a 100644 --- a/src/references/dataProtector/dataProtectorCore/revokeOneAccess.md +++ b/src/references/dataProtector/dataProtectorCore/revokeOneAccess.md @@ -89,3 +89,7 @@ import { type RevokedAccess } from '@iexec/dataprotector'; ``` [`RevokedAccess`](../types.md#revokedaccess) + + diff --git a/src/references/dataProtector/dataProtectorCore/transferOwnership.md b/src/references/dataProtector/dataProtectorCore/transferOwnership.md index 9ce7f33b..41d89eed 100644 --- a/src/references/dataProtector/dataProtectorCore/transferOwnership.md +++ b/src/references/dataProtector/dataProtectorCore/transferOwnership.md @@ -103,3 +103,7 @@ The ETH address of the new owner of the `protectedData`. The ID of the transaction that happened on iExec's side chain. You may view details on the transaction using the [iExec explorer](https://explorer.iex.ec). + + diff --git a/src/references/dataProtector/dataProtectorSharing/collection/addToCollection.md b/src/references/dataProtector/dataProtectorSharing/collection/addToCollection.md index 05ccde21..72249928 100644 --- a/src/references/dataProtector/dataProtectorSharing/collection/addToCollection.md +++ b/src/references/dataProtector/dataProtectorSharing/collection/addToCollection.md @@ -164,3 +164,8 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/collection/removeCollection.md b/src/references/dataProtector/dataProtectorSharing/collection/removeCollection.md index 64a24b3f..b34454ab 100644 --- a/src/references/dataProtector/dataProtectorSharing/collection/removeCollection.md +++ b/src/references/dataProtector/dataProtectorSharing/collection/removeCollection.md @@ -68,3 +68,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/collection/removeProtectedDataFromCollection.md b/src/references/dataProtector/dataProtectorSharing/collection/removeProtectedDataFromCollection.md index fde983da..f6f24e95 100644 --- a/src/references/dataProtector/dataProtectorSharing/collection/removeProtectedDataFromCollection.md +++ b/src/references/dataProtector/dataProtectorSharing/collection/removeProtectedDataFromCollection.md @@ -74,3 +74,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/consume/consumeProtectedData.md b/src/references/dataProtector/dataProtectorSharing/consume/consumeProtectedData.md index 944a7198..aefeedce 100644 --- a/src/references/dataProtector/dataProtectorSharing/consume/consumeProtectedData.md +++ b/src/references/dataProtector/dataProtectorSharing/consume/consumeProtectedData.md @@ -8,6 +8,8 @@ description: # consumeProtectedData diff --git a/src/references/dataProtector/dataProtectorSharing/read/getCollectionOwners.md b/src/references/dataProtector/dataProtectorSharing/read/getCollectionOwners.md index f8bc117b..9bf0320c 100644 --- a/src/references/dataProtector/dataProtectorSharing/read/getCollectionOwners.md +++ b/src/references/dataProtector/dataProtectorSharing/read/getCollectionOwners.md @@ -68,3 +68,7 @@ Type ↗️ `true` if you (logged-in user) have an active subscription to one of the collections. + + diff --git a/src/references/dataProtector/dataProtectorSharing/read/getCollectionSubscriptions.md b/src/references/dataProtector/dataProtectorSharing/read/getCollectionSubscriptions.md index 40f15f26..ce3e0c97 100644 --- a/src/references/dataProtector/dataProtectorSharing/read/getCollectionSubscriptions.md +++ b/src/references/dataProtector/dataProtectorSharing/read/getCollectionSubscriptions.md @@ -104,3 +104,7 @@ import { type CollectionSubscription } from '@iexec/dataprotector'; See Type ↗️ + + diff --git a/src/references/dataProtector/dataProtectorSharing/read/getCollectionsByOwner.md b/src/references/dataProtector/dataProtectorSharing/read/getCollectionsByOwner.md index 06970e70..e8ae57ca 100644 --- a/src/references/dataProtector/dataProtectorSharing/read/getCollectionsByOwner.md +++ b/src/references/dataProtector/dataProtectorSharing/read/getCollectionsByOwner.md @@ -87,3 +87,8 @@ import type { See Type ↗️ + + diff --git a/src/references/dataProtector/dataProtectorSharing/read/getProtectedDataInCollections.md b/src/references/dataProtector/dataProtectorSharing/read/getProtectedDataInCollections.md index 1e77e275..503afa0d 100644 --- a/src/references/dataProtector/dataProtectorSharing/read/getProtectedDataInCollections.md +++ b/src/references/dataProtector/dataProtectorSharing/read/getProtectedDataInCollections.md @@ -227,3 +227,7 @@ import type { See Type ↗️ + + diff --git a/src/references/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams.md b/src/references/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams.md index 68e53d18..7cafca5b 100644 --- a/src/references/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams.md +++ b/src/references/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams.md @@ -63,3 +63,7 @@ import type { SubscriptionParams, RentingParams } from '@iexec/dataprotector'; See Type ↗️ + + diff --git a/src/references/dataProtector/dataProtectorSharing/read/getRentals.md b/src/references/dataProtector/dataProtectorSharing/read/getRentals.md index 7fe042ce..9d4377de 100644 --- a/src/references/dataProtector/dataProtectorSharing/read/getRentals.md +++ b/src/references/dataProtector/dataProtectorSharing/read/getRentals.md @@ -101,3 +101,7 @@ import type { ProtectedDataRental } from '@iexec/dataprotector'; See Type ↗️ + + diff --git a/src/references/dataProtector/dataProtectorSharing/renting/removeProtectedDataFromRenting.md b/src/references/dataProtector/dataProtectorSharing/renting/removeProtectedDataFromRenting.md index 7bc1b923..701e756d 100644 --- a/src/references/dataProtector/dataProtectorSharing/renting/removeProtectedDataFromRenting.md +++ b/src/references/dataProtector/dataProtectorSharing/renting/removeProtectedDataFromRenting.md @@ -64,3 +64,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/renting/rentProtectedData.md b/src/references/dataProtector/dataProtectorSharing/renting/rentProtectedData.md index d717bfbb..8d023c85 100644 --- a/src/references/dataProtector/dataProtectorSharing/renting/rentProtectedData.md +++ b/src/references/dataProtector/dataProtectorSharing/renting/rentProtectedData.md @@ -137,3 +137,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/renting/setProtectedDataToRenting.md b/src/references/dataProtector/dataProtectorSharing/renting/setProtectedDataToRenting.md index c430fbfb..2f50f299 100644 --- a/src/references/dataProtector/dataProtectorSharing/renting/setProtectedDataToRenting.md +++ b/src/references/dataProtector/dataProtectorSharing/renting/setProtectedDataToRenting.md @@ -116,3 +116,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/selling/buyProtectedData.md b/src/references/dataProtector/dataProtectorSharing/selling/buyProtectedData.md index 7a8bd0c9..c50c5435 100644 --- a/src/references/dataProtector/dataProtectorSharing/selling/buyProtectedData.md +++ b/src/references/dataProtector/dataProtectorSharing/selling/buyProtectedData.md @@ -162,3 +162,8 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale.md b/src/references/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale.md index 73b7b71a..568a45bd 100644 --- a/src/references/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale.md +++ b/src/references/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale.md @@ -60,3 +60,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/selling/setProtectedDataForSale.md b/src/references/dataProtector/dataProtectorSharing/selling/setProtectedDataForSale.md index 7d0081d9..76d7cdde 100644 --- a/src/references/dataProtector/dataProtectorSharing/selling/setProtectedDataForSale.md +++ b/src/references/dataProtector/dataProtectorSharing/selling/setProtectedDataForSale.md @@ -87,3 +87,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/subscription/removeProtectedDataFromSubscription.md b/src/references/dataProtector/dataProtectorSharing/subscription/removeProtectedDataFromSubscription.md index a093cdb0..035f5f64 100644 --- a/src/references/dataProtector/dataProtectorSharing/subscription/removeProtectedDataFromSubscription.md +++ b/src/references/dataProtector/dataProtectorSharing/subscription/removeProtectedDataFromSubscription.md @@ -75,3 +75,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/subscription/setProtectedDataToSubscription.md b/src/references/dataProtector/dataProtectorSharing/subscription/setProtectedDataToSubscription.md index 34673ef0..2576461a 100644 --- a/src/references/dataProtector/dataProtectorSharing/subscription/setProtectedDataToSubscription.md +++ b/src/references/dataProtector/dataProtectorSharing/subscription/setProtectedDataToSubscription.md @@ -64,3 +64,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/subscription/setSubscriptionParams.md b/src/references/dataProtector/dataProtectorSharing/subscription/setSubscriptionParams.md index 0d360eda..a414c15f 100644 --- a/src/references/dataProtector/dataProtectorSharing/subscription/setSubscriptionParams.md +++ b/src/references/dataProtector/dataProtectorSharing/subscription/setSubscriptionParams.md @@ -112,3 +112,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/dataProtector/dataProtectorSharing/subscription/subscribeToCollection.md b/src/references/dataProtector/dataProtectorSharing/subscription/subscribeToCollection.md index 2ea2eac2..624bf2a5 100644 --- a/src/references/dataProtector/dataProtectorSharing/subscription/subscribeToCollection.md +++ b/src/references/dataProtector/dataProtectorSharing/subscription/subscribeToCollection.md @@ -133,3 +133,7 @@ import { type SuccessWithTransactionHash } from '@iexec/dataprotector'; ``` See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash) + + diff --git a/src/references/web3mail/methods/fetchMyContacts.md b/src/references/web3mail/methods/fetchMyContacts.md index 5b90ff02..2df575e3 100644 --- a/src/references/web3mail/methods/fetchMyContacts.md +++ b/src/references/web3mail/methods/fetchMyContacts.md @@ -65,3 +65,7 @@ import { type Contact } from '@iexec/web3mail'; ``` [`Contact[]`](/references/dataProtector/types#contact) + + diff --git a/src/references/web3mail/methods/fetchUserContacts.md b/src/references/web3mail/methods/fetchUserContacts.md index f030a46f..e128c857 100644 --- a/src/references/web3mail/methods/fetchUserContacts.md +++ b/src/references/web3mail/methods/fetchUserContacts.md @@ -85,3 +85,7 @@ import { type Contact } from '@iexec/web3mail'; ``` [`Contract[]`](/references/dataProtector/types#contact) + + diff --git a/src/references/web3mail/methods/sendEmail.md b/src/references/web3mail/methods/sendEmail.md index 02cce046..fc9d7e0d 100644 --- a/src/references/web3mail/methods/sendEmail.md +++ b/src/references/web3mail/methods/sendEmail.md @@ -390,3 +390,8 @@ For any other errors, you'll get a `WorkflowError` error in the form of: errorCause: } ``` + + diff --git a/src/references/web3telegram/methods/fetchMyContacts.md b/src/references/web3telegram/methods/fetchMyContacts.md index 9cfaec5f..ae976356 100644 --- a/src/references/web3telegram/methods/fetchMyContacts.md +++ b/src/references/web3telegram/methods/fetchMyContacts.md @@ -65,3 +65,7 @@ import { type Contact } from '@iexec/web3telegram'; ``` [`Contact[]`](/references/dataProtector/types#contact) + + diff --git a/src/references/web3telegram/methods/fetchUserContacts.md b/src/references/web3telegram/methods/fetchUserContacts.md index 8cf0011d..815514a3 100644 --- a/src/references/web3telegram/methods/fetchUserContacts.md +++ b/src/references/web3telegram/methods/fetchUserContacts.md @@ -85,3 +85,7 @@ import { type Contact } from '@iexec/web3telegram'; ``` [`Contract[]`](/references/dataProtector/types#contact) + + diff --git a/src/references/web3telegram/methods/sendTelegram.md b/src/references/web3telegram/methods/sendTelegram.md index 88f43340..90a0c6bf 100644 --- a/src/references/web3telegram/methods/sendTelegram.md +++ b/src/references/web3telegram/methods/sendTelegram.md @@ -293,3 +293,9 @@ import { type SendTelegramResponse } from '@iexec/web3telegram'; This uniquely identifies the telegram task on the iExec side chain. You can view the status of the `sendTelegram` method by monitoring the task on the [iExec Explorer](https://explorer.iex.ec/bellecour). + +``` + + From f13ac50009d3fc3ba2840c6261459e376d95da73 Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Thu, 14 Aug 2025 17:27:12 +0200 Subject: [PATCH 08/27] docs: add ChainNotSupportedBadge to payment guides and methods Updated the payment guides for Web3Mail, Web3Telegram, and execution methods to include the ChainNotSupportedBadge for the useVoucher section. Enhanced clarity by importing the badge component in relevant script sections. --- src/guides/use-iapp/how-to-pay-executions.md | 6 +++++- src/guides/use-iapp/how-to-pay/how-to-pay-for-web3mail.md | 3 ++- .../use-iapp/how-to-pay/how-to-pay-for-web3telegram.md | 3 ++- .../dataProtectorCore/getResultFromCompletedTask.md | 1 + src/references/web3mail/methods/sendEmail.md | 3 ++- src/references/web3telegram/methods/sendTelegram.md | 5 ++--- 6 files changed, 14 insertions(+), 7 deletions(-) diff --git a/src/guides/use-iapp/how-to-pay-executions.md b/src/guides/use-iapp/how-to-pay-executions.md index db41b230..86f7a76b 100644 --- a/src/guides/use-iapp/how-to-pay-executions.md +++ b/src/guides/use-iapp/how-to-pay-executions.md @@ -86,7 +86,7 @@ iexec account show iexec account deposit 100 ``` -## Method 2: Paying with Vouchers +## Method 2: Paying with Vouchers Vouchers are pre-funded payment instruments that simplify the payment process and can be shared with others. @@ -493,3 +493,7 @@ Now that you understand payment methods: - Learn about [Adding Inputs to Execution](./add-inputs-to-execution.md) - Explore [Using iApps with Protected Data](./use-iapp-with-protected-data.md) - Review the pricing information above for detailed cost analysis + + diff --git a/src/guides/use-iapp/how-to-pay/how-to-pay-for-web3mail.md b/src/guides/use-iapp/how-to-pay/how-to-pay-for-web3mail.md index f74b1ee4..dea0db5f 100644 --- a/src/guides/use-iapp/how-to-pay/how-to-pay-for-web3mail.md +++ b/src/guides/use-iapp/how-to-pay/how-to-pay-for-web3mail.md @@ -16,7 +16,7 @@ messages, ensuring secure and decentralized email exchanges. This guide explains how to pay for Web3Mail's computing power using **vouchers** and **xRLC**, detailing the steps for each method. -## Using Vouchers for Web3Mail +## Using Vouchers for Web3Mail ### Step 1: Obtain a Voucher @@ -162,4 +162,5 @@ iexec.account.withdraw(RLC_amount); diff --git a/src/guides/use-iapp/how-to-pay/how-to-pay-for-web3telegram.md b/src/guides/use-iapp/how-to-pay/how-to-pay-for-web3telegram.md index a22702db..2227bb68 100644 --- a/src/guides/use-iapp/how-to-pay/how-to-pay-for-web3telegram.md +++ b/src/guides/use-iapp/how-to-pay/how-to-pay-for-web3telegram.md @@ -17,7 +17,7 @@ send messages, ensuring secure and decentralized email exchanges. This guide explains how to pay for Web3Telegram's computing power using **vouchers** and **xRLC**, detailing the steps for each method. -## Using Vouchers for Web3Telegram +## Using Vouchers for Web3Telegram ### Step 1: Obtain a Voucher @@ -175,4 +175,5 @@ iexec.account.withdraw(RLC_amount); diff --git a/src/references/dataProtector/dataProtectorCore/getResultFromCompletedTask.md b/src/references/dataProtector/dataProtectorCore/getResultFromCompletedTask.md index 3ee3eacc..6d1d869b 100644 --- a/src/references/dataProtector/dataProtectorCore/getResultFromCompletedTask.md +++ b/src/references/dataProtector/dataProtectorCore/getResultFromCompletedTask.md @@ -141,3 +141,4 @@ The actual content of the protected file. import RequiredBadge from '@/components/RequiredBadge.vue' import OptionalBadge from '@/components/OptionalBadge.vue' +``` diff --git a/src/references/web3mail/methods/sendEmail.md b/src/references/web3mail/methods/sendEmail.md index fc9d7e0d..cb4e3083 100644 --- a/src/references/web3mail/methods/sendEmail.md +++ b/src/references/web3mail/methods/sendEmail.md @@ -112,7 +112,7 @@ const sendEmail = await web3mail.sendEmail({ }); ``` -### useVoucher +### useVoucher **Type:** `boolean` **Default:** `false` @@ -394,4 +394,5 @@ For any other errors, you'll get a `WorkflowError` error in the form of: diff --git a/src/references/web3telegram/methods/sendTelegram.md b/src/references/web3telegram/methods/sendTelegram.md index 90a0c6bf..3801dacc 100644 --- a/src/references/web3telegram/methods/sendTelegram.md +++ b/src/references/web3telegram/methods/sendTelegram.md @@ -117,7 +117,7 @@ const sendTelegram = await web3telegram.sendTelegram({ }); ``` -### useVoucher +### useVoucher **Type:** `boolean` **Default:** `false` @@ -294,8 +294,7 @@ This uniquely identifies the telegram task on the iExec side chain. You can view the status of the `sendTelegram` method by monitoring the task on the [iExec Explorer](https://explorer.iex.ec/bellecour). -``` - From fb5b1c3f8b2578d799cb44f842b0362d73f3ceb9 Mon Sep 17 00:00:00 2001 From: Le-Caignec Date: Thu, 14 Aug 2025 17:34:11 +0200 Subject: [PATCH 09/27] refactor: update ChainNotSupportedBadge styling and text Changed the badge type from warning to tip and updated the text for improved clarity. Adjusted the color scheme to enhance visibility and align with design standards. --- src/components/ChainNotSupportedBadge.vue | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/components/ChainNotSupportedBadge.vue b/src/components/ChainNotSupportedBadge.vue index bae437a2..d7f88c0b 100644 --- a/src/components/ChainNotSupportedBadge.vue +++ b/src/components/ChainNotSupportedBadge.vue @@ -17,11 +17,11 @@ const shouldShow = computed(() => isArbitrumSelected.value);