iExec

https://github.com/iexecblockchaincomputing/documentation
Admin
iExec is a decentralized cloud computing platform that leverages blockchain technology to provide...
Tokens:101,709
Snippets:1,080
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize a New iApp Project

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/build-&-test.md

Use the 'iapp init' command to start a new iApp project. The CLI will guide you through project name, language, and template selection.

```bash
iapp init
```

--------------------------------

### Install DataProtector

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/manage-data/manage-access.md

Install the DataProtector library using your preferred package manager.

```bash
npm install @iexec/dataprotector
```

```bash
yarn add @iexec/dataprotector
```

```bash
pnpm add @iexec/dataprotector
```

```bash
bun add @iexec/dataprotector
```

--------------------------------

### Set up .env file

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/CONTRIBUTING.md

Copy the example environment file to create your local configuration.

```bash
cp .env.example .env
```

--------------------------------

### App Order Configuration Example

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/manage-access.md

An example of the `apporder` section within `iexec.json`, showing parameters to be edited for your specific app order.

```json
{
  "apporder": {
    "app": "0xYourAppAddress",
    "appprice": "1000000000",
    "volume": "100",
    "tag": "0x0000000000000000000000000000000000000000000000000000000000000009",
    "datasetrestrict": "0x0000000000000000000000000000000000000000",
    "workerpoolrestrict": "0x0000000000000000000000000000000000000000",
    "requesterrestrict": "0x0000000000000000000000000000000000000000"
  }
}
```

--------------------------------

### Install iExec SDK CLI

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/advanced/quick-start.md

Install the iExec SDK command-line interface globally using npm. After installation, you can verify the version and view help information.

```bash
npm -g install iexec
iexec --version
iexec --help
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/README.md

Installs all necessary packages for the project using npm.

```bash
npm install
```

--------------------------------

### Install @iexec/dataprotector-deserializer with bun

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/iapp-generator/deserializer.md

Install the deserializer package using bun. Ensure Node.js version 14 or higher is installed.

```sh
bun add @iexec/dataprotector-deserializer
```

--------------------------------

### Install Web3Telegram SDK

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3telegram/getting-started.md

Install the package using your preferred Node.js package manager.

```npm
npm install @iexec/web3telegram
```

```yarn
yarn add @iexec/web3telegram
```

```pnpm
pnpm add @iexec/web3telegram
```

```bun
bun add @iexec/web3telegram
```

--------------------------------

### Create and Configure .env File

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/README.md

Copies the example environment file and sets the VITE_REOWN_PROJECT_ID.

```bash
cp .env.example .env
VITE_REOWN_PROJECT_ID=your_project_id_here
```

--------------------------------

### Start Development Server

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/README.md

Launches the development server for local testing and previewing the documentation site.

```bash
npm run dev
```

--------------------------------

### Running PyTorch Docker Example

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/protocol/ai.md

Commands to navigate to the PyTorch example directory within the cloned repository, build its Docker image, and run the container.

```bash
# Try PyTorch example
cd ../pytorch
docker build -t hello-pytorch .
docker run --rm hello-pytorch
```

--------------------------------

### Initialize iExec Project

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md

Initializes a new iExec project directory and skips wallet setup.

```bash
cd ~/iexec-projects
mkdir tee-hello-world-tdx && cd tee-hello-world-tdx
iexec init --skip-wallet
mkdir src
touch Dockerfile
```

--------------------------------

### Install @iexec/dataprotector-deserializer with npm

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/iapp-generator/deserializer.md

Install the deserializer package using npm. Ensure Node.js version 14 or higher is installed.

```sh
npm install @iexec/dataprotector-deserializer
```

--------------------------------

### Install iExec SDK

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/sdk.md

Install the iExec package using your preferred package manager.

```sh
npm install iexec
```

```sh
yarn add iexec
```

```sh
pnpm add iexec
```

```sh
bun add iexec
```

--------------------------------

### Install DataProtector SDK

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/getting-started.md

Install the package using your preferred Node.js package manager.

```npm
npm install @iexec/dataprotector
```

```yarn
yarn add @iexec/dataprotector
```

```pnpm
pnpm add @iexec/dataprotector
```

```bun
bun add @iexec/dataprotector
```

--------------------------------

### Cloning and Running TensorFlow Docker Example

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/protocol/ai.md

Commands to clone the AI frameworks repository, navigate to the TensorFlow example directory, build the Docker image, and run the container.

```bash
# Clone the repository
git clone https://github.com/iExecBlockchainComputing/ai-frameworks-hello-world.git
cd ai-frameworks-hello-world

# Try TensorFlow example
cd tensorflow
docker build -t hello-tensorflow .
docker run --rm hello-tensorflow
```

--------------------------------

### Install @iexec/dataprotector-deserializer with pnpm

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/iapp-generator/deserializer.md

Install the deserializer package using pnpm. Ensure Node.js version 14 or higher is installed.

```sh
pnpm add @iexec/dataprotector-deserializer
```

--------------------------------

### Install @iexec/dataprotector-deserializer with yarn

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/iapp-generator/deserializer.md

Install the deserializer package using yarn. Ensure Node.js version 14 or higher is installed.

```sh
yarn add @iexec/dataprotector-deserializer
```

--------------------------------

### Install iExec SDK CLI

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/manage-access.md

Install the iExec SDK using npm, yarn, pnpm, or bun. This is the first step to managing app orders via the command line.

```sh
npm install iexec
```

```sh
yarn add iexec
```

```sh
pnpm add iexec
```

```sh
bun add iexec
```

--------------------------------

### Install Vale on Linux

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/README.md

Installs Vale using Snap for Linux users. Vale is used for documentation linting.

```bash
snap install vale
```

--------------------------------

### Verify iExec SDK Installation

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/manage-access.md

Check if the iExec SDK is installed correctly and view its available commands.

```bash
iexec --version
iexec --help
```

--------------------------------

### Install iExec Web3Mail SDK

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3mail/getting-started.md

Install the package using your preferred Node.js package manager.

```npm
npm install @iexec/web3mail
```

```yarn
yarn add @iexec/web3mail
```

```pnpm
pnpm add @iexec/web3mail
```

```bun
bun add @iexec/web3mail
```

--------------------------------

### Install iApp Generator CLI

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/build-&-test.md

Install the iApp Generator globally using your preferred package manager.

```bash
npm install -g @iexec/iapp
```

```bash
yarn global add @iexec/iapp
```

```bash
pnpm add -g @iexec/iapp
```

```bash
bun add -g @iexec/iapp
```

--------------------------------

### Project File Organization Structure

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/CONTRIBUTING.md

Overview of the project's directory structure for components, guides, and assets.

```bash
src/
├── components/           # Reusable Vue components
├── get-started/         # Getting started guides
├── guides/              # Detailed guides
├── protocol/            # Protocol documentation
├── references/          # API references
└── assets/              # Images and resources
```

--------------------------------

### Check iApp Installation Version

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/get-started/helloWorld/3-buildIApp.md

Verify the successful installation of the iApp package by checking its version.

```sh
iapp --version
```

--------------------------------

### Install iApp Generator with npm

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/iapp-generator/getting-started.md

Install the iApp Generator globally using npm. This is the recommended method for Node.js environments.

```bash
npm install -g @iexec/iapp
```

--------------------------------

### prepareEmailCampaign with Optional Parameters

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3mail/methods/prepareEmailCampaign.md

This example demonstrates how to use the prepareEmailCampaign method with several optional parameters to customize the campaign. It shows how to set `maxProtectedDataPerTask`, `workerpoolAddress`, `workerpoolMaxPrice`, `label`, `dataMaxPrice`, and `appMaxPrice`.

```APIDOC
## prepareEmailCampaign

### Description
Prepares an email campaign by setting up the necessary parameters for bulk sending. It allows for customization of various aspects of the campaign, such as data processing limits, workerpool selection, pricing constraints, and an optional campaign label.

### Method
`prepareEmailCampaign(params)`

### Parameters
#### Request Body
- **grantedAccesses** (GrantedAccess[]) - Required - An array of granted access objects.
- **emailSubject** (string) - Required - The subject line of the email.
- **emailContent** (string) - Required - The content of the email.
- **maxProtectedDataPerTask** (number | undefined) - Optional - Limits the number of protected data items processed per task. Defaults to 100.
- **workerpoolAddress** (Address | undefined) - Optional - The address of the workerpool that will execute the bulk campaign tasks. Defaults to the chain configuration's default workerpool.
- **workerpoolMaxPrice** (number | undefined) - Optional - The maximum amount (in nRLC) you are willing to pay the workerpool provider. Defaults to 0.
- **label** (string | undefined) - Optional - An optional label to identify or categorize the campaign.
- **dataMaxPrice** (number | undefined) - Optional - The maximum amount (in nRLC) you are willing to pay for accessing the protected data. Defaults to 0.
- **appMaxPrice** (number | undefined) - Optional - The maximum amount (in nRLC) you are willing to pay the Web3Mail app provider. Defaults to 0.

### Return Value
#### Success Response
- **campaignRequest** (BulkRequest) - The prepared bulk request object containing all necessary information to process the bulk campaign. This object should be passed to `sendEmailCampaign`.

### Request Example
```ts
import { IExecWeb3mail, type GrantedAccess } from '@iexec/web3mail';

const web3mail = new IExecWeb3mail(signer);
const grantedAccessArray: GrantedAccess[] = [
  // ... your granted access objects
];

const emailCampaign = await web3mail.prepareEmailCampaign({
  grantedAccesses: grantedAccessArray,
  emailSubject: 'My email subject',
  emailContent: 'My email content',
  maxProtectedDataPerTask: 10,
  workerpoolAddress: '0xa5de76...',
  workerpoolMaxPrice: 0.1 * 1e9, // 0.1 RLC in nRLC
  label: 'Newsletter Campaign',
  dataMaxPrice: 0.1 * 1e9, // 0.1 RLC in nRLC
  appMaxPrice: 0.1 * 1e9, // 0.1 RLC in nRLC
});
```

### Response Example
```json
{
  "campaignRequest": {
    "id": "some-campaign-id",
    "tasks": [
      // ... task details
    ]
  }
}
```
```

--------------------------------

### Install Vale on Windows

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/README.md

Installs Vale using Chocolatey for Windows users. Vale is used for documentation linting.

```bash
choco install vale
```

--------------------------------

### Combined Component Usage Example

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/CONTRIBUTING.md

Demonstrates the combined usage of Banner, VitePress containers, CardWithBorder, and CardWithoutBorder components.

```markdown
<Banner>

## Installation Guide

</Banner>

::: info Prerequisites Make sure you have Node.js installed before continuing.
:::

<CardWithBorder>

### Step 1: Installation

```bash npm install ```

</CardWithBorder>

<CardWithoutBorder>

### Step 2: Configuration

Create your .env file based on .env.example.

</CardWithoutBorder>

::: tip Success! Your installation is now complete! :::
```

--------------------------------

### Confidential App Order Example

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/manage-access.md

Example parameters for an app order specifically for a confidential application requiring TEE.

```json
{
  "appprice": "2000000000",
  "volume": "500",
  "tag": "0x0000000000000000000000000000000000000000000000000000000000000009"
}
```

--------------------------------

### Python iApp Logic

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md

Example Python code for an iApp that writes 'Hello, World!' to a file and declares computed output.

```python
import os
import sys
import json

iexec_out = os.environ['IEXEC_OUT']

# Do whatever you want (let's write hello world here)
text = 'Hello, {}!'.format(sys.argv[1] if len(sys.argv) > 1 else "World")
print(text)

# Append some results in /iexec_out/
with open(iexec_out + '/result.txt', 'w+') as fout:
    fout.write(text)

# Declare everything is computed
with open(iexec_out + '/computed.json', 'w+') as f:
    json.dump({ "deterministic-output-path" : iexec_out + '/result.txt' }, f)
```

--------------------------------

### Multi-file Output Example in Python

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/outputs.md

Shows how to generate multiple output files, including a summary, a detailed report, and visualization data, along with the required computed.json metadata. The computed.json should list the deterministic output and any additional files.

```Python
import os
import json

iexec_out = os.environ['IEXEC_OUT']

# Create multiple output files
summary = {"total_processed": 1000, "success_rate": 0.95}
with open(f"{iexec_out}/summary.json", 'w') as f:
    json.dump(summary, f)

# Create a detailed report
with open(f"{iexec_out}/detailed_report.txt", 'w') as f:
    f.write("Detailed analysis results...\n")

# Create visualization data
chart_data = {"labels": ["A", "B", "C"], "values": [10, 20, 30]}
with open(f"{iexec_out}/chart_data.json", 'w') as f:
    json.dump(chart_data, f)

# Required metadata file
computed = {
    "deterministic-output-path": f"{iexec_out}/summary.json",
    "additional-files": [
        f"{iexec_out}/detailed_report.txt",
        f"{iexec_out}/chart_data.json"
    ]
}
with open(f"{iexec_out}/computed.json", 'w') as f:
    json.dump(computed, f)
```

--------------------------------

### Install iApp Package using bun

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/get-started/helloWorld/3-buildIApp.md

Install the iApp package globally using bun. This command is used for Node.js package management with bun.

```sh
bun add -g @iexec/iapp
```

--------------------------------

### Prepare Bulk Request with specific bulkAccesses

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/methods/prepareBulkRequest.md

This example demonstrates how to prepare a bulk request, focusing on the `bulkAccesses` parameter. Ensure that `bulkAccesses` contains `GrantedAccess` objects with `allowBulk: true`.

```typescript
import {
  IExecDataProtectorCore,
  type GrantedAccess,
} from '@iexec/dataprotector';
const dataProtectorCore = {} as IExecDataProtectorCore;
const grantedAccess = [] as GrantedAccess[];
// ---cut---
// @errors: 2304 7034 7005
const { bulkRequest } = await dataProtectorCore.prepareBulkRequest({
  bulkAccesses: grantedAccess, // [!code focus]
  app: '0x456def...',
});
```

--------------------------------

### Initialize a Workerpool Order

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/protocol/worker/manage-access.md

Use this command to start the process of creating a new workerpool order. Configuration is done in `iexec.json`.

```bash
iexec order init --workerpool
```

--------------------------------

### Prepare Email Campaign with Granted Accesses

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3mail/methods/prepareEmailCampaign.md

Example focusing on the `grantedAccesses` parameter for the `prepareEmailCampaign` method. This parameter is required and specifies the recipients for the bulk email.

```typescript
import { IExecWeb3mail, type GrantedAccess } from '@iexec/web3mail';
const web3mail = {} as IExecWeb3mail;
const grantedAccessArray = [] as GrantedAccess[];
// ---cut---
// @errors: 2304 7034 7005
const emailCampaign = await web3mail.prepareEmailCampaign({
  grantedAccesses: grantedAccessArray, // [!code focus]
  emailSubject: 'My subject',
  emailContent: 'My content',
});
```

--------------------------------

### Install Vale on macOS

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/README.md

Installs Vale using Homebrew for macOS users. Vale is used for documentation linting.

```bash
brew install Vale/tap/vale
```

--------------------------------

### Prepare Bulk Request with specific app address

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/methods/prepareBulkRequest.md

This example shows how to prepare a bulk request, highlighting the `app` parameter. Provide the ETH address of the iExec application that will process the data.

```typescript
import {
  IExecDataProtectorCore,
  type GrantedAccess,
} from '@iexec/dataprotector';
const dataProtectorCore = {} as IExecDataProtectorCore;
const grantedAccess = [] as GrantedAccess[];
// ---cut---
// @errors: 2304 7034 7005
const { bulkRequest } = await dataProtectorCore.prepareBulkRequest({
  bulkAccesses: grantedAccess,
  app: '0x456def...', // [!code focus]
});
```

--------------------------------

### Install iApp Package using npm

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/get-started/helloWorld/3-buildIApp.md

Install the iApp package globally using npm. This command is used for Node.js package management.

```sh
npm i -g @iexec/iapp
```

--------------------------------

### AI Frameworks Hello World Repository Structure

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/protocol/ai.md

This snippet shows the directory structure of the AI Frameworks Hello World repository, indicating the location of examples for various AI frameworks.

```tree
ai-frameworks-hello-world/
├── tensorflow/     # TensorFlow 2.19.0 example
├── pytorch/        # PyTorch 2.7.0+cu126 example
├── scikit/         # Scikit-learn 1.6.1 example
├── openvino/       # OpenVINO 2024.6.0 example
├── numpy/          # NumPy 2.0.2 example
└── matplotlib/     # Matplotlib 3.9.4 example
```

--------------------------------

### Install iApp Package using yarn

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/get-started/helloWorld/3-buildIApp.md

Install the iApp package globally using yarn. This command is used for Node.js package management with yarn.

```sh
yarn global add @iexec/iapp
```

--------------------------------

### JavaScript iApp Logic

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md

Example JavaScript code for an iApp that writes 'Hello, World!' to a file and declares computed output.

```javascript
const fsPromises = require('fs').promises;

(async () => {
  try {
    const iexecOut = process.env.IEXEC_OUT;
    // Do whatever you want (let's write hello world here)
    const message = process.argv.length > 2 ? process.argv[2] : 'World';

    const text = `Hello, ${message}!`;
    console.log(text);
    // Append some results in /iexec_out/
    await fsPromises.writeFile(`${iexecOut}/result.txt`, text);
    // Declare everything is computed
    const computedJsonObj = {
      'deterministic-output-path': `${iexecOut}/result.txt`,
    };
    await fsPromises.writeFile(
      `${iexecOut}/computed.json`,
      JSON.stringify(computedJsonObj)
    );
  } catch (e) {
    console.log(e);
    process.exit(1);
  }
})();
```

--------------------------------

### Commit Message Examples

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/CONTRIBUTING.md

Follow these patterns for commit messages to categorize changes effectively.

```text
Add: CardWithBorder component usage guide
Update: VitePress container recommendations
Fix: broken links in getting started guide
```

--------------------------------

### Example Deployment Configuration

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/deploy-&-run.md

This JSON structure represents a saved deployment configuration, typically found in `deployments.json` within the `cache` folder. It details the TEE image, application contract address, owner, and deployment date.

```json
[
  {
    "tdxImage": "robiniexec/iapp:0.0.1-tee-tdx-1.0.0",
    "appContractAddress": "0x9665136c599ec361C8eE627eC4F35A23fBa94897",
    "owner": "0xbabE8270aC9857Af3aaC06877888F1939FbeC578",
    "date": "2025-08-12T13:16:18.252Z"
  },
  ...
]
```

--------------------------------

### Test iApp Locally with iApp Generator

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/inputs.md

Command-line examples for testing your iApp locally using the iApp Generator, including testing arguments, input files, and secrets.

```bash
# Test with different input types
iapp test --args "model=bert threshold=0.8"           # Test with arguments
iapp test --inputFiles "https://example.com/data.json" # Test with input files
iapp test --secrets "key1=value1,key2=value2"        # Test with secrets

# Mock protected data for testing
iapp mock protectedData  # Generate sample protected data

# Test your iApp locally with mocked protected data
iapp test --protectedData "mock_name"
```

--------------------------------

### Prepare Telegram Campaign with grantedAccesses

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3telegram/methods/prepareTelegramCampaign.md

Example showing how to use the `grantedAccesses` parameter when preparing a Telegram campaign. This parameter requires an array of `GrantedAccess` objects.

```typescript
import { IExecWeb3telegram, type GrantedAccess } from '@iexec/web3telegram';
const web3telegram = {} as IExecWeb3telegram;
const grantedAccessArray = [] as GrantedAccess[];
// ---cut---
// @errors: 2304 7034 7005
const telegramCampaign = await web3telegram.prepareTelegramCampaign({
  grantedAccesses: grantedAccessArray, // [!code focus]
  telegramContent: 'My message',
  senderName: 'My App',
});
```

--------------------------------

### Execute iApp with Protected Data

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/inputs.md

Demonstrates how a user initiates iApp execution with specific protected data using the IExecDataProtectorCore. Requires Web3 provider setup.

```TypeScript
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';

const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL');
const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
// ---cut---
// User provides the protected data they want to use for processing
const response = await dataProtectorCore.processProtectedData({
  protectedData: '0x123abc...', // Address of the protected data
  app: '0x456def...', // Your iApp address
});
```

--------------------------------

### Initialize a New iApp Project

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/get-started/helloWorld/3-buildIApp.md

Use `iapp init` to set up the working directory for your iApp. This command creates the necessary project structure and files, prompting you for project name, language, and project type.

```sh
mkdir iexec-test
cd iexec-test
iapp init
```

--------------------------------

### Processing Bulk Request with Default Options

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/methods/processBulkRequest.md

This example shows how to process a bulk request using default options, where `waitForResult` is false, and the method returns immediately with task IDs.

```typescript
import { IExecDataProtectorCore, type BulkRequest } from '@iexec/dataprotector';
const dataProtectorCore = {} as IExecDataProtectorCore;
const bulkRequest = {} as BulkRequest;
// ---cut---
// @errors: 2304 7034 7005
const { tasks } = await dataProtectorCore.processBulkRequest({
  bulkRequest: bulkRequest,
});
```

--------------------------------

### Instantiate with a Web3 Provider

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3mail/getting-started.md

Initialize the SDK using an existing Web3 provider from the browser or a private key in Node.js.

```Browser
declare global {
  interface Window {
    ethereum: any;
  }
}
// ---cut---
import { IExecWeb3mail } from '@iexec/web3mail';

const web3Provider = window.ethereum;
// instantiate
const web3mail = new IExecWeb3mail(web3Provider);
```

```NodeJS
import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';

// get web3 provider from a private key
const web3Provider = getWeb3Provider('YOUR_PRIVATE_KEY', 'RPC_URL');
// instantiate
const web3mail = new IExecWeb3mail(web3Provider);
```

--------------------------------

### Example App Order Structure

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/manage-access.md

This JSON object represents a typical app order, defining parameters such as the iApp address, price per execution, authorized volume, and security tags.

```json
{
  "app": "0x123abc...", // Your iApp address
  "appprice": "1000000000", // 1 RLC per execution
  "volume": "100", // 100 authorized uses
  "tag": "0x0000000000000000000000000000000000000000000000000000000000000009", // Tee Tdx required
  "datasetrestrict": "0x0000000000000000000000000000000000000000",
  "workerpoolrestrict": "0x0000000000000000000000000000000000000000",
  "requesterrestrict": "0x0000000000000000000000000000000000000000"
}
```

--------------------------------

### Create Local Input/Output Directories

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md

Sets up local directories to simulate the input and output volumes for the iExec application container.

```bash
mkdir -p ./tmp/iexec_in
mkdir -p ./tmp/iexec_out
```

--------------------------------

### Instantiate SDK with Web3 Provider

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/getting-started.md

Initialize the SDK using a Web3 provider for browser or Node.js environments.

```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);
```

```NodeJS
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';

// Get Web3 provider from a private key
const web3Provider = getWeb3Provider('YOUR_PRIVATE_KEY', 'RPC_URL');

// Instantiate the Core module
const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
```

--------------------------------

### Initialize App Order Configuration

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/manage-access.md

Initialize the app order section in your `iexec.json` file. This prepares the configuration for creating a new app order.

```bash
iexec order init --app
```

--------------------------------

### Instantiate Web3Telegram SDK

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3telegram/getting-started.md

Initialize the SDK using a browser provider or a private key for server-side applications.

```Browser
declare global {
  interface Window {
    ethereum: any;
  }
}
// ---cut---
import { IExecWeb3telegram } from '@iexec/web3telegram';

const web3Provider = window.ethereum;
// instantiate
const web3telegram = new IExecWeb3telegram(web3Provider);
```

```NodeJS
import { IExecWeb3telegram, getWeb3Provider } from '@iexec/web3telegram';

// get web3 provider from a private key
const web3Provider = getWeb3Provider('YOUR_PRIVATE_KEY', 'RPC_URL');
// instantiate
const web3telegram = new IExecWeb3telegram(web3Provider);
```

--------------------------------

### Interactive iApp Initialization

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/get-started/helloWorld/3-buildIApp.md

This interactive CLI demo shows the prompts and user selections during the `iapp init` process, including project name, language (JavaScript/Python), and project type (Hello World/advanced).

```javascript
const cliDemoInit = {
  initialCommand: "iapp init",
  asciiText: "iApp",
  steps: [
    {
      showAt: 2,
      completeAt: 4,
      question: 'What is your project name? (A folder with this name will be created)',
      answer: 'hello-world',
      showTyping: true,
      isComplete: false
    },
    {
      showAt: 4,
      completeAt: 6,
      question: 'Which language do you want to use?',
      answer: 'JavaScript',
      options: [
        { label: 'JavaScript', selected: true },
        { label: 'Python', selected: false }
      ],
      highlighted: false,
      isComplete: false
    },
    {
      showAt: 6,
      completeAt: 8,
      question: 'What kind of project do you want to init?',
      answer: 'Hello World',
      options: [
        { label: 'Hello World - iapp quick start', selected: true },
        { label: 'advanced', selected: false }
      ],
      highlighted: false,
      isComplete: false
    }
  ],
  completionStep: 8,
  completionMessage: "'Generating your iApp...'",
  completionItems: [
    '📁 Created hello-world/',
    '📄 Added package.json',
    '🐳 Added Dockerfile',
    '⚙️ Added iExec configuration'
  ],
  successMessage: "'Your iApp is ready'"
};
```

--------------------------------

### Email Schema Error Example

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3mail/methods/sendEmail.md

This is an example of the error structure received when the protected data does not contain the required 'email:string' in its schema.

```json
{
  message: 'Failed to sendEmail',
  errorCause: Error('This protected data does not contain "email:string" in its schema.')
}
```

--------------------------------

### Build Project for Production

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/README.md

Generates a production-ready build of the project.

```bash
npm run build
```

--------------------------------

### iApp Deployment Steps (Arbitrum Sepolia Testnet)

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/deploy-&-run.md

Shows the initial step for deploying an iApp on the Arbitrum Sepolia testnet, indicating the selected chain.

```javascript
const arbitrumSepoliaSteps = [
  {
    showAt: 2,
    question: 'Using chain arbitrum-sepolia-testnet',
    answer: '',
    showTyping: false,
    isComplete: true
  },
  {
    showAt: 3,

```

--------------------------------

### Install iApp Package using pnpm

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/get-started/helloWorld/3-buildIApp.md

Install the iApp package globally using pnpm. This command is used for Node.js package management with pnpm.

```sh
pnpm add -g @iexec/iapp
```

--------------------------------

### Basic Output Generation in Python

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/outputs.md

Demonstrates how to create a main result file and the mandatory computed.json metadata file in Python. Ensure the computed.json points to your deterministic output.

```Python
import os
import json

# Get output directory
iexec_out = os.environ['IEXEC_OUT']

# Create your result file
result_data = {
    "analysis": "positive sentiment",
    "confidence": 0.92,
    "processed_at": "2024-01-15T10:30:00Z"
}

# Save main result
with open(f"{iexec_out}/result.json", 'w') as f:
    json.dump(result_data, f)

# REQUIRED: Create `computed.json` metadata
computed_metadata = {
    "deterministic-output-path": f"{iexec_out}/result.json",
    "execution-timestamp": "2024-01-15T10:30:00Z",
    "app-version": "1.0.0"
}

with open(f"{iexec_out}/computed.json", 'w') as f:
    json.dump(computed_metadata, f)
```

--------------------------------

### Get Supported Chains Utility

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/get-started/tooling-and-explorers/important-addresses.md

This script imports a utility function to get supported chain data, which can be used for dynamic content generation in the application.

```javascript
import { getSupportedChains } from '@/utils/chain.utils';
```

--------------------------------

### Run Docker Container with Input Files

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md

Simulates an iExec application with multiple input files by creating files in the local input volume and setting corresponding environment variables.

```bash
touch ./tmp/iexec_in/file1 && \
    touch ./tmp/iexec_in/file2 && \
    docker run \
    -v ./tmp/iexec_in:/iexec_in \
    -v ./tmp/iexec_out:/iexec_out \
    -e IEXEC_IN=/iexec_in \
    -e IEXEC_OUT=/iexec_out \
    -e IEXEC_INPUT_FILE_NAME_1=file1 \
    -e IEXEC_INPUT_FILE_NAME_2=file2 \
    -e IEXEC_INPUT_FILES_NUMBER=2 \
    <docker-hub-user>/hello-world:1.0.0 \
    arg1 arg2 arg3
```

--------------------------------

### Instantiate iExec SDK

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/sdk.md

Initialize the SDK instance using either a browser-injected provider or a private key in a Node.js environment.

```ts
declare global {
  interface Window {
    ethereum: any;
  }
}
// ---cut---
import { IExec } from 'iexec';

// Connect to injected provider
const iexec = new IExec({ ethProvider: window.ethereum });
```

```ts
import { IExec, utils } from 'iexec';

const ethProvider = utils.getSignerFromPrivateKey(
  'http://localhost:8545', // blockchain node URL
  'YOUR_PRIVATE_KEY'
);
const iexec = new IExec({
  ethProvider,
});
```

--------------------------------

### Get Task Debug Information

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/protocol/debugging.md

Retrieve the on-chain and off-chain statuses of a specific iExec task using its ID.

```bash
iexec task debug <taskid>
```

--------------------------------

### iExec Protocol Error Example

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3mail/methods/sendEmail.md

This structure represents an error originating from the iExec protocol, indicating a temporary unavailability of a service.

```json
{
  message: "A service in the iExec protocol appears to be unavailable. You can retry later or contact iExec's technical support for help.",
  errorCause: <Original error>,
  isProtocolError: true
}
```

--------------------------------

### Build Docker Image (Standard)

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md

Builds a Docker image with a specific tag, suitable for deployment on iExec.

```bash
docker build --tag <docker-hub-user>/hello-world:1.0.0 .
```

--------------------------------

### Interactive iApp Testing Simulation

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/get-started/helloWorld/3-buildIApp.md

This interactive CLI demo illustrates the output and prompts during the `iapp test` command execution. It shows the build process, execution status, and options to view logs or results.

```javascript
const cliDemoTest = {
  initialCommand: "iapp test",
  steps: [
    {
      showAt: 2,
      question: 'No app secret is configured (from iapp.config.json)',
      answer: '',
      showTyping: false,
      isComplete: true
    },
    {
      showAt: 3,
      question: 'App docker image built (sha256:9cc0de820aaaf8f86700a3ec4082fe69b9e9a48a117ebb0ade0d82d0879cbe41)',
      answer: '',
      showTyping: false,
      isComplete: true
    },
    {
      showAt: 4,
      question: 'App docker image ran and exited successfully.',
      answer: '',
      showTyping: false,
      isComplete: true
    },
    {
      showAt: 5,
      completeAt: 6,
      question: 'Would you like to see the app logs? (12 lines)',
      answer: 'no',
      options: [
        { label: 'yes', selected: false },
        { label: 'no', selected: true }
      ],
      highlighted: false,
      showTyping: false,
      isComplete: false
    },
    {
      showAt: 7,
      question: 'Checked app output',
      answer: '',
      showTyping: false,
      isComplete: true
    },
    {
      showAt: 8,
      completeAt: 10,
      question: 'Would you like to see the result? (View ./output/)',
      answer: 'yes',
      options: [
        { label: 'yes', selected: true },
        { label: 'no', selected: false }
      ],
      highlighted: false,
      showTyping: false,
      isComplete: false
    }
  ],
  completionStep: 11,
  completionMessage: "'📁 output directory content:'",
  completionItems: [
    '└ computed.json',
    '└ result.txt'
  ],
  successMessage: "'hello world'",
  autoRestart: true
};
```

--------------------------------

### Build Docker Image for Mac (Apple Silicon)

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md

Builds a Docker image for the linux/arm64 platform using buildx, suitable for local testing on Mac with Apple Silicon.

```bash
brew install buildkit
# ARM64 variant for local testing only
docker buildx build --platform linux/arm64 --tag <docker-hub-user>/hello-world .
# AMD64 variant to deploy on iExec
docker buildx build --platform linux/amd64 --tag <docker-hub-user>/hello-world:1.0.0 --load .
```

--------------------------------

### Filter Granted Access by Authorized User

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/methods/getGrantedAccess.md

Get granted access details filtered by a specific authorized user address.

```typescript
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';

const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL');
const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
// ---cut---
const listGrantedAccess = await dataProtectorCore.getGrantedAccess({
  authorizedUser: '0x789cba...', // [!code focus]
});
```

--------------------------------

### Get Task Debug Logs

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/protocol/debugging.md

Retrieve the application logs produced by workers for a specific iExec task using its ID.

```bash
iexec task debug <taskid> --logs
```

--------------------------------

### Fetch User Contacts

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3mail/methods/fetchUserContacts.md

Initializes the IExecWeb3mail service and fetches a list of user contacts. Ensure you have the necessary provider setup.

```typescript
import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';

const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL');
const web3mail = new IExecWeb3mail(web3Provider);
// ---cut---
const contactsList = await web3mail.fetchUserContacts({
  userAddress: '0x789cba...'
});
```

--------------------------------

### General Workflow Error Example

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3mail/methods/sendEmail.md

This is the general error structure for any other issues encountered during the sendEmail operation, including the original error cause.

```json
{
  message: 'Failed to sendEmail',
  errorCause: <Original error>
}
```

--------------------------------

### Instantiate Without a Web3 Provider

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3mail/getting-started.md

Initialize the SDK using only an RPC URL for read-only operations.

```Browser
import { IExecWeb3mail } from '@iexec/web3mail';

// instantiate
const web3mail = new IExecWeb3mail('RPC_URL');
```

```NodeJS
import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';

// instantiate
const web3mail = new IExecWeb3mail('RPC_URL');
```

--------------------------------

### Specify Workerpool for Bulk Request

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/methods/processBulkRequest.md

This example shows how to specify a workerpool address when processing a bulk request. If not provided, a default workerpool is used.

```typescript
import { IExecDataProtectorCore, type BulkRequest } from '@iexec/dataprotector';
const dataProtectorCore = {} as IExecDataProtectorCore;
const bulkRequest = {} as BulkRequest;
// ---cut---
const { tasks } = await dataProtectorCore.processBulkRequest({
  bulkRequest: bulkRequest,
  workerpool: '0xa5de76...', // [!code focus]
});
```

--------------------------------

### Instantiate SDK for Read-Only Access

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/getting-started.md

Initialize the SDK without a Web3 provider for read-only operations.

```Singleton Modules
import { IExecDataProtectorCore } from '@iexec/dataprotector';

// Instantiate only the Core module for read-only core methods
const dataProtectorCore = new IExecDataProtectorCore('RPC_URL');
```

```Umbrella Module
import { IExecDataProtector } from '@iexec/dataprotector';

// Instantiate using the umbrella module for read-only functions
const dataProtector = new IExecDataProtector('RPC_URL');

// Access to read-only core methods
const dataProtectorCore = dataProtector.core;
```

--------------------------------

### Execute iApp with Requester Secrets

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/inputs.md

Example of a user executing an iApp and providing Requester Secrets. These secrets are specific to the user's execution.

```typescript
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';

const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL');
const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
// ---cut---
// Example: User executes your iApp with all input types
const processProtectedDataResponse =
  await dataProtectorCore.processProtectedData({
    protectedData: '0x123abc...', // Protected data address
    app: '0x456def...', // Your iApp address
    args: 'model=bert threshold=0.8', // Public arguments
    secrets: {
      // Requester secrets
      1: 'sk-1234567890abcdef', // API key
      2: 'mydbpassword123', // DB password
    },
  });
```

--------------------------------

### Local Testing Commands

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/CONTRIBUTING.md

Commands to build the project, check code syntax with linting, and run documentation tests using Vale.

```bash
# Build the project
npm run build

# Check syntax
npm run lint

# Documentation tests with Vale
vale src/
```

--------------------------------

### Process Protected Data with Specific Workerpool

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/methods/processProtectedData.md

Example of processing protected data with a specified workerpool address. Ensure the workerpool address is valid and accessible.

```typescript
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';

const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL');
const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
// ---cut---
const processProtectedDataResponse =
  await dataProtectorCore.processProtectedData({
    protectedData: '0x123abc...',
    app: '0x456def...',
    workerpool: '0xa5de76...',
  });
```

--------------------------------

### Get Only Bulk Granted Access

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/methods/getGrantedAccess.md

Filters the results to retrieve only granted accesses that were created with the 'allowBulk: true' option. Useful for preparing bulk requests.

```typescript
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';

const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL');
const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
// ---cut---
const { grantedAccess } = await dataProtectorCore.getGrantedAccess({
  bulkOnly: true, // [!code focus]
});
```

--------------------------------

### Get Result from Completed Task

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/methods/getResultFromCompletedTask.md

Use this snippet to retrieve the result of a completed task by providing its ID. Ensure you have initialized the IExecDataProtectorCore with a web3 provider.

```typescript
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';

const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL');
const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
// ---cut---
const completedTaskResult = await dataProtectorCore.getResultFromCompletedTask({
  taskId: '0x7ac398...',
});
```

--------------------------------

### Get All Granted Access

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/methods/getGrantedAccess.md

Retrieve a list of all granted access details for a protected data object, optionally filtering by application and user, and controlling pagination.

```typescript
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';

const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL');
const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
// ---cut---
const listGrantedAccess = await dataProtectorCore.getGrantedAccess({
  protectedData: '0x123abc...',
  authorizedApp: '0x456def...',
  authorizedUser: '0x789cba...',
  page: 1,
  pageSize: 100,
});
```

--------------------------------

### Send Email with Web3Mail

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3mail/methods/sendEmail.md

Demonstrates how to initialize IExecWeb3mail and send a basic email using the sendEmail method. Ensure you have the necessary provider and address.

```typescript
import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';

const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL');
const web3mail = new IExecWeb3mail(web3Provider);
// ---cut---
const sendEmail = await web3mail.sendEmail({
  protectedData: '0x123abc...',
  emailSubject: 'My email subject',
  emailContent: 'My email content',
});
```

--------------------------------

### Basic Output Generation in JavaScript

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/outputs.md

Demonstrates how to create a main result file and the mandatory computed.json metadata file in JavaScript. Ensure the computed.json points to your deterministic output.

```JavaScript
const fs = require('fs');
const path = require('path');

// Get output directory
const iexecOut = process.env.IEXEC_OUT;

// Create your result file
const resultData = {
  analysis: 'positive sentiment',
  confidence: 0.92,
  processed_at: '2024-01-15T10:30:00Z',
};

// Save main result
fs.writeFileSync(
  path.join(iexecOut, 'result.json'),
  JSON.stringify(resultData, null, 2)
);

// REQUIRED: Create computed.json metadata
const computedMetadata = {
  'deterministic-output-path': path.join(iexecOut, 'result.json'),
  'execution-timestamp': '2024-01-15T10:30:00Z',
  'app-version': '1.0.0',
};

fs.writeFileSync(
  path.join(iexecOut, 'computed.json'),
  JSON.stringify(computedMetadata, null, 2)
);
```

--------------------------------

### Fetch All Authorized Contacts

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/web3mail/methods/fetchMyContacts.md

Initializes the IExecWeb3mail instance and fetches a list of all users who have previously authorized you to send them emails. Ensure you have the necessary provider setup.

```typescript
import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';

const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL');
const web3mail = new IExecWeb3mail(web3Provider);
// ---cut---
const contactsList = await web3mail.fetchMyContacts();
```

--------------------------------

### Revoke Access for Specific Protected Data

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/methods/revokeAllAccess.md

This example shows how to revoke access for a specific protected data entity by providing its address. Initialization of IExecDataProtectorCore is required.

```typescript
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';

const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL');
const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
// ---cut---
const revokeAllAccessResult = await dataProtectorCore.revokeAllAccess({
  protectedData: '0x123abc...', // [!code focus]
});
```

--------------------------------

### Clone iExec Documentation Repository

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/CONTRIBUTING.md

Clone your forked repository to your local machine and navigate into the directory.

```bash
git clone https://github.com/YOUR_USERNAME/documentation.git
cd documentation
```

--------------------------------

### Import an Existing iExec Wallet

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/manage-access.md

Import an existing iExec wallet using its private key.

```bash
iexec wallet import <private-key>
```

--------------------------------

### Initialize TDX iApp Deployment

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md

Initializes the iExec application deployment process, specifying the TDX framework.

```bash
iexec app init --tee-framework tdx
```

--------------------------------

### Environment Variable Configuration

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/CONTRIBUTING.md

Fill in your project-specific values into the .env file.

```env
VITE_REOWN_PROJECT_ID=your_project_id_here
```
Tokens:
Raw