feat: Update documentation and guides for DataProtector

- Adjusted outline levels in VitePress configuration for better navigation.
- Removed outdated 'Guides' link from sidebar.
- Enhanced README with additional instructions and a TODO section for future improvements.
- Updated package-lock.json and package.json to reflect new project name and version.
- Refined index.md to correct links and improve clarity.
- Enhanced grantAccess.md with clearer instructions and additional notes on access management.
- Expanded getting-started.md with detailed installation steps and SDK usage examples.
- Deleted obsolete guides.md file and integrated relevant content into manage-data/guides.md.
- Revamped manage-data/guides.md to provide a comprehensive overview of DataProtector guides and structured navigation.
- Created detailed create-and-share-access.md guide with installation, data protection, and access granting instructions.
- Developed handle-schemas-dataset-types.md to explain schema functionality and its importance in DataProtector.
- Expanded manage-data-monetization.md to cover monetization strategies, including pay-per-use and DataProtector Sharing models.

Author: Le-Caignec

.vitepress/config.mts

@@ -91,7 +91,7 @@ export default defineConfig({
       { text: 'Core Concept', link: '/core-concept/glossary' },
     ],
     outline: {
-      level: [2, 3],
+      level: [2, 4],
     },
 
     sidebar: getSidebar(),

.vitepress/sidebar.ts

@@ -90,10 +90,6 @@ export function getSidebar() {
                 text: 'Getting Started',
                 link: '/manage-data/dataProtector/getting-started',
               },
-              {
-                text: 'Guides',
-                link: '/manage-data/dataProtector/guides',
-              },
               {
                 text: 'DataProtector Core',
                 link: '/manage-data/dataProtector/dataProtectorCore',

README.md

@@ -97,6 +97,7 @@ Fork this repository and ensure you're working on the `main` branch:
    ```
 
 3. Start the development server:
+
    ```bash
    npm run dev
    ```
@@ -138,14 +139,18 @@ Fork this repository and ensure you're working on the `main` branch:
 > - All pull requests are reviewed by our team before being merged
 > - Feel free to ask questions in the pull request if you need clarification
 
-## 📄 License
-
-This project is part of the iExec ecosystem. Please refer to the main iExec
-repositories for licensing information.
-
 ## 🆘 Support
 
 - 📖 [Documentation](https://docs.iex.ec)
 - 💬 [Discord Community](https://discord.com/invite/pbt9m98wnU)
 - 🐛
   [Issue Tracker](https://github.com/iExecBlockchainComputing/documentation/issues)
+
+## TODO
+
+- Add Arbitrum support
+- Adapt hardcoded address to feat with new contracts deployed on arbitrum
+- complete `use-iapp` section
+- complete `explorer` section
+- complete `build-iapp` section
+- complete `deep-dive`section

package-lock.json

@@ -5,7 +5,6 @@
     "dev": "vitepress dev",
     "build": "vitepress build",
     "preview": "vitepress preview",
-    "check-format": "prettier --ignore-path .gitignore --check .",
     "format": "prettier --ignore-path .gitignore --write ."
   },
   "dependencies": {

package.json

@@ -25,7 +25,7 @@ features:
     details:
       Secure your data with advanced encryption and control access while
       maintaining privacy using DataProtector
-    link: /manage-data/dataProtector/what-is-protected-data
+    link: /manage-data/what-is-protected-data
   - icon: 🤖
     title: Build iApps
     details:

src/index.md

@@ -44,7 +44,8 @@ import { type GrantAccessParams } from '@iexec/dataprotector';
 
 **Type:** `AddressOrENS`
 
-The ethereum address of the protected data supplied by the user.
+The ethereum address of the protected data supplied by the user (returned when
+you created it). **You must own this data** to grant access.
 
 ```ts twoslash
 import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';
@@ -68,9 +69,9 @@ The address of the application you wish to authorize to process the
 single application or an application whitelist. To specify a whitelist, you
 provide the ETH address of an
 [iExec Whitelist Smart Contract](https://github.com/iExecBlockchainComputing/whitelist-smart-contract/tree/main).
-This smart contract aggregates multiple application versions. This allows you to
-introduce new versions of your application without needing to grant access for
-the `protectedData` each time you do so.
+This smart contract should aggregates multiple application versions. This allows
+you to introduce new versions of your application without needing to grant
+access for the `protectedData` each time you do so.
 
 ```ts twoslash
 import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';
@@ -180,12 +181,14 @@ used.
 It is not technically possible to set an unlimited number of accesses, but you
 can set `numberOfAccess` to `10000` for example.
 
-::: info Important Notes: If you attempt to process the protected data more
-times than specified in `numberOfAccess`, you will encounter a **"no dataset
-orders"** error.
+::: info
+
+If you attempt to process the protected data more times than specified in
+`numberOfAccess`, you will encounter a **"no dataset orders"** error.
 
 To prevent this error, ensure the `numberOfAccess` is properly set when calling
-the `grantAccess` method.  
+the `grantAccess` method.
+
 :::
 
 ```ts twoslash

src/manage-data/dataProtector/dataProtectorCore/grantAccess.md

@@ -1,10 +1,241 @@
 ---
 title: Getting Started
-description: DataProtector getting started guide
+description: DataProtector getting started
 ---
 
 # Getting Started
 
-This page is under development.
+[![GitHub package.json version (branch)](https://img.shields.io/badge/npm-2.0.0--beta-green)](https://www.npmjs.com/package/@iexec/dataprotector)
 
-<!-- TODO: Add the getting started guide -->
+## Overview
+
+### Prerequisites
+
+Before getting started, ensure that you have the following installed on your
+system:
+
+\- [**Node.js**](https://nodejs.org/en/) version 18 or higher
+
+\- [**NPM**](https://docs.npmjs.com/) (Node.js package manager)
+
+### Installation
+
+::: code-group
+
+```sh [npm]
+npm install @iexec/dataprotector
+```
+
+```sh [yarn]
+yarn add @iexec/dataprotector
+```
+
+```sh [pnpm]
+pnpm add @iexec/dataprotector
+```
+
+```sh [bun]
+bun add @iexec/dataprotector
+```
+
+:::
+
+**This package is an ESM package. Your project needs to use ESM too.**
+&nbsp;[**Read more**](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c)
+
+If you use it with **Webpack**, some polyfills will be needed. You can find a
+minimal working project
+[here](https://github.com/iExecBlockchainComputing/dataprotector-sdk/tree/115b797cf62dcff0f41e2ba783405d5083d78922/packages/demo/browser-webpack).
+
+### Instantiate SDK
+
+Depending on your project's requirements, you can instantiate the SDK using the
+umbrella module for full functionality or opt for one of the submodules to
+access specific sets of features.
+
+#### Instantiate using the umbrella module
+
+For projects requiring the full functionality of the SDK, including both core
+and sharing functions.
+
+::: code-group
+
+```ts twoslash [Browser]
+declare global {
+  interface Window {
+    ethereum: any;
+  }
+}
+// ---cut---
+import { IExecDataProtector } from '@iexec/dataprotector';
+
+const web3Provider = window.ethereum;
+// Instantiate using the umbrella module for full functionality
+const dataProtector = new IExecDataProtector(web3Provider);
+
+const dataProtectorCore = dataProtector.core;
+const dataProtectorSharing = dataProtector.sharing;
+```
+
+```ts twoslash [NodeJS]
+import { IExecDataProtector, getWeb3Provider } from '@iexec/dataprotector';
+
+// Get Web3 provider from a private key
+const web3Provider = getWeb3Provider('YOUR_PRIVATE_KEY');
+
+// Instantiate using the umbrella module for full functionality
+const dataProtector = new IExecDataProtector(web3Provider);
+
+const dataProtectorCore = dataProtector.core; // access to core methods
+const dataProtectorSharing = dataProtector.sharing; // access to methods
+```
+
+:::
+
+#### Instantiate only the `core` module
+
+For projects focusing solely on core data protection functions.
+
+::: code-group
+
+```ts twoslash [Browser]
+declare global {
+  interface Window {
+    ethereum: any;
+  }
+}
+// ---cut---
+import { IExecDataProtectorCore } from '@iexec/dataprotector';
+
+const web3Provider = window.ethereum;
+// Instantiate only the Core module
+const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
+```
+
+```ts twoslash [NodeJS]
+import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';
+
+// Get Web3 provider from a private key
+const web3Provider = getWeb3Provider('YOUR_PRIVATE_KEY');
+
+// Instantiate only the Core module
+const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
+```
+
+:::
+
+#### Instantiate only the `sharing` module
+
+For projects that need access management functions specifically.
+
+::: code-group
+
+```ts twoslash [Browser]
+declare global {
+  interface Window {
+    ethereum: any;
+  }
+}
+// ---cut---
+import { IExecDataProtectorSharing } from '@iexec/dataprotector';
+
+const web3Provider = window.ethereum;
+// Instantiate only the Sharing module
+const dataProtectorSharing = new IExecDataProtectorSharing(web3Provider);
+```
+
+```ts twoslash [NodeJS]
+import {
+  IExecDataProtectorSharing,
+  getWeb3Provider,
+} from '@iexec/dataprotector';
+
+// Get Web3 provider from a private key
+const web3Provider = getWeb3Provider('YOUR_PRIVATE_KEY');
+
+// Instantiate only the Sharing module
+const dataProtectorSharing = new IExecDataProtectorSharing(web3Provider);
+```
+
+:::
+
+#### Instantiate without a Web3 provider
+
+For projects that only require read functions, you can instantiate the SDK
+without a Web3 provider.
+
+::: code-group
+
+```ts twoslash [Singleton Modules]
+import {
+  IExecDataProtectorSharing,
+  IExecDataProtectorCore,
+} from '@iexec/dataprotector';
+
+// Instantiate only the Core module for read-only core methods
+const dataProtectorCore = new IExecDataProtectorCore();
+// Instantiate only the Sharing module for read-only sharing methods
+const dataProtectorSharing = new IExecDataProtectorSharing();
+```
+
+```ts twoslash [Umbrella Module]
+import { IExecDataProtector } from '@iexec/dataprotector';
+
+// Instantiate using the umbrella module for read-only functions
+const dataProtector = new IExecDataProtector();
+
+// Access to read-only core methods
+const dataProtectorCore = dataProtector.core;
+// Access to read-only sharing methods
+const dataProtectorSharing = dataProtector.sharing;
+```
+
+:::
+
+#### Advanced configuration
+
+To add optional parameters, see
+[advanced configuration](./advanced/advanced-configuration.md).
+
+::: info
+
+🧪 While protected data are processed in **TEE** by **intel SGX** technology by
+default, `@iexec/dataprotector` can be configured to create and process
+protected data in the experimental **intel TDX** environment.
+
+For more details see:
+
+- [configure DataProtector TDX](./advanced/advanced-configuration.md#iexecoptions)
+- [create TDX protected data](./dataProtectorCore/protectData.md#usage)
+- [process TDX protected data](./dataProtectorCore/processProtectedData.md#workerpool)
+
+⚠️ Keep in mind: TDX mode is experimental and can be subject to instabilities or
+discontinuity.
+
+:::
+
+## Sandbox
+
+### Core methods
+
+<a href="https://codesandbox.io/p/github/iExecBlockchainComputing/dataprotector-sandbox/main" target="_blank" rel="noreferrer" class="link-as-block" style="margin-top: 16px">
+  ⚡ &nbsp;Code Sandbox
+</a>
+
+Corresponding GitHub repository:
+
+<a href="https://github.com/iExecBlockchainComputing/dataprotector-sandbox" target="_blank" rel="noreferrer" class="link-as-block">
+  🔎 &nbsp;GitHub repository sandbox
+</a>
+
+### Sharing methods
+
+<a href="https://codesandbox.io/p/github/iExecBlockchainComputing/dataprotector-sharing-sandbox/main" target="_blank" rel="noreferrer" class="link-as-block" style="margin-top: 16px">
+  ⚡ &nbsp;Code Sandbox
+</a>
+
+Corresponding GitHub repository:
+
+<a href="https://github.com/iExecBlockchainComputing/dataprotector-sharing-sandbox" target="_blank" rel="noreferrer" class="link-as-block">
+  🔎 &nbsp;GitHub repository sandbox
+</a>