================
CODE SNIPPETS
================
### Get Started with iExec

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

Provides a quick start guide to begin building on iExec. The 'Hello World' tutorial offers a hands-on introduction to the platform's capabilities.

```markdown
layout: home

hero:
  name: 'Build with iExec’s Privacy Stack '
  tagline:
    'Build decentralized applications that combine data governance, privacy, and
    monetization.'
  image:
    src: /iexec-illustration-large.webp
    alt: VitePress
  actions:
    - theme: brand
      text: Get Started
      link: /get-started/welcome
    - theme: alt
      text: Hello World Tutorial
      link: /get-started/helloWorld
```

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

### Install iExec SDK CLI

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

Installs the iExec SDK command-line interface globally using npm. It also shows how to check the installed version and access help documentation.

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

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

### Instantiate Web3Telegram SDK in NodeJS

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

Instantiates the Web3Telegram SDK in a NodeJS environment using a private key to get a web3 provider. Ensure your project is compatible with ESM.

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

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

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

### Install Web3Telegram SDK via Package Managers

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

Installs the Web3Telegram SDK using popular package managers. This package is an ESM package and requires your project to also use ESM.

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

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

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

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

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

### Install @iexec/web3mail SDK

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

Installs the iExec Web3Mail SDK using various package managers. This package is an ESM package, requiring your project to also use ESM.

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

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

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

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

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

### Instantiate Web3Telegram SDK in Browser

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

Instantiates the Web3Telegram SDK in a browser environment using the window.ethereum object. Ensure your project is compatible with ESM.

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

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

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

### Clone Repository and Setup

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

Basic Git commands for forking the repository, cloning the fork, and installing dependencies to begin contributing.

```bash
# Fork this repository
# Clone your fork and install dependencies (`npm install`)
git clone <your-fork-url>
cd documentation
npm install

# Create a feature branch (`git checkout -b feature/your-feature-name`)
git checkout -b feature/my-new-feature

# Make your changes and test locally (`npm run dev`)
# Submit a pull request
```

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

### Combined Component Usage Example

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

An example showcasing the combined usage of `Banner`, VitePress native containers (`info`), `CardWithBorder`, `CardWithoutBorder`, and `tip` containers to structure documentation content effectively.

```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! :::
```

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

### Instantiate SDK with Umbrella Module (Browser)

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

Instantiates the iExec DataProtector SDK using the umbrella module in a browser environment. This provides access to both core and sharing functionalities. It requires the `window.ethereum` object.

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

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

### Instantiate IExecWeb3mail with a Web3 Provider

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

Demonstrates how to instantiate the IExecWeb3mail SDK using a Web3 provider. Supports both browser environments (using window.ethereum) and NodeJS environments (using a private key).

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

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

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

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

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

### Verify iExec CLI Installation

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

Check the installed version of the iExec CLI and view the available commands. This helps ensure the 'iapp' package was installed correctly and is ready for use.

```shell
#checking the version
iapp --version

#checking the available commands
iapp --help
```

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

### Instantiate Core Module Only (Browser)

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

Instantiates only the Core module of the iExec DataProtector SDK in a browser environment, for projects focusing solely on core data protection functions. It requires the `window.ethereum` object.

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

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

### Instantiate Sharing Module Only (Browser)

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

Instantiates only the Sharing module of the iExec DataProtector SDK in a browser environment, for projects that need access management functions specifically. It requires the `window.ethereum` object.

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

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

### Generate iApp CLI Completion

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

Generates shell auto-completion scripts for the `iapp` command-line interface. This enhances user experience by providing command suggestions and reducing typing errors.

```bash
iapp completion
```

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

### Instantiate SDK with Umbrella Module (NodeJS)

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

Instantiates the iExec DataProtector SDK using the umbrella module in a NodeJS environment. This provides access to both core and sharing functionalities. It requires a Web3 provider, obtained here using a private key.

```typescript
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
```

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

### Start Development Server

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

Command to start the local development server for the project.

```bash
npm run dev
```

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

### Instantiate Sharing Module Only (NodeJS)

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

Instantiates only the Sharing module of the iExec DataProtector SDK in a NodeJS environment, for projects that need access management functions specifically. It requires a Web3 provider, obtained here using a private key.

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

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

### Install Project Dependencies

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

Command to install all necessary project dependencies using npm.

```bash
npm install
```

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

### Instantiate Singleton Modules Without Provider

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

Instantiate the iExec DataProtector SDK's core and sharing modules individually for read-only operations. This method is suitable when only specific read functions are needed and no Web3 provider is available.

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

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

### Instantiate Core Module Only (NodeJS)

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

Instantiates only the Core module of the iExec DataProtector SDK in a NodeJS environment, for projects focusing solely on core data protection functions. It requires a Web3 provider, obtained here using a private key.

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

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

### Vue.js Setup for iExec Documentation

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

This script setup block configures a Vue.js application for iExec documentation. It imports necessary components like InfoIcon, CLIDemo, Banner, and Container, and sets up stores and computed properties for managing chain selection and deployment steps.

```vue
<script setup>
import InfoIcon from '@/components/InfoIcon.vue'
import CLIDemo from '@/components/CLIDemo.vue';
import { computed } from 'vue';
import useUserStore from '@/stores/useUser.store';
import Banner from '../../components/Banner.vue'
import Container from '../../components/Container.vue'

const userStore = useUserStore();
const selectedChain = computed(() => userStore.getCurrentChainId());

const arbitrumSteps = [
  {
    showAt: 2,
    question: 'Using chain arbitrum-mainnet',
    answer: '',
    showTyping: false,
    isComplete: true
  },
  {
    showAt: 3,
    question: 'This method requires sending blockchain transactions, transaction fees will be applied. Would you like to continue?',
    answer: 'Yes',
    options: [
      { label: 'Yes', selected: true },
      { label: 'no', selected: false }
    ],
    highlighted: false,
    showTyping: false,
    isComplete: false
  },
  {
    showAt: 4,
    question: 'Using saved walletPrivateKey (from iapp.config.json)',
    answer: '',
    showTyping: false,
    isComplete: true
  },
  {
    showAt: 5,
    completeAt: 7,
    question: 'What is your username on DockerHub? (It will be used to properly tag the Docker image)',
    answer: 'bob',
    showTyping: true,
    isComplete: false
  },
  {
    showAt: 7,
    completeAt: 9,
    question: 'What is your DockerHub access token?',
    answer: '**********************',
    showTyping: true,
    isComplete: false
  },
  {
    showAt: 9,
    completeAt: 11,
    question: 'What is the version of your iApp?',
    answer: '0.0.1',
    showTyping: true,
    isComplete: false
  },
  {
    showAt: 11,
    question: 'Docker image built (sha256:a53fc4c480f482c384a13266ea2cb6cc5572733c866c44a5f604f4bfab3a744a) and tagged bob/hello-world:0.0.1',
    answer: '',
    showTyping: false,
    isComplete: true
  },
  {
    showAt: 12,
    question: 'Pushed image bob/hello-world:0.0.1 on dockerhub',
    answer: '',
    showTyping: false,
    isComplete: true
  },
  {
    showAt: 13,
    question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7 on dockerhub',
    answer: '',
    showTyping: false,
    isComplete: true
  },
  {
    showAt: 14,
    question: 'TEE app deployed',
    answer: '',
    showTyping: false,
    isComplete: true
  }
];

const bellecourSteps = [
  {
    showAt: 2,
    question: 'Using chain bellecour',
    answer: '',
    showTyping: false,
    isComplete: true
  },
  {
    showAt: 3,
    question: 'Using saved walletPrivateKey (from iapp.config.json)',
    answer: '',
    showTyping: false,
    isComplete: true
  },
  {
    showAt: 4,
    completeAt: 6,
    question: 'What is your username on DockerHub? (It will be used to properly tag the Docker image)',
    answer: 'bob',
    showTyping: true,
    isComplete: false
  },
  {
    showAt: 6,
    completeAt: 8,
    question: 'What is your DockerHub access token?',
    answer: '**********************',
    showTyping: true,
    isComplete: false
  },
  {
    showAt: 8,
    completeAt: 10,
    question: 'What is the version of your iApp?',
    answer: '0.0.1',
    showTyping: true,
    isComplete: false
  },
  {
    showAt: 10,
    question: 'Docker image built (sha256:a53fc4c480f482c384a13266ea2cb6cc5572733c866c44a5f604f4bfab3a744a) and tagged bob/hello-world:0.0.1',
    answer: '',
    showTyping: false,
    isComplete: true
  },
  {
    showAt: 11,
    question: 'Pushed image bob/hello-world:0.0.1 on dockerhub',
    answer: '',
    showTyping: false,
    isComplete: true
  },
  {
    showAt: 12,
    question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7 on dockerhub',
    answer: '',
    showTyping: false,
    isComplete: true
  },
  {
    showAt: 13,
    question: 'TEE app deployed',
    answer: '',
    showTyping: false,
    isComplete: true
  }
];

const arbitrumCompletionItems = [
  '└ Docker image: bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7',
  '└ iApp address: 0x1f80DCebc2EAAff0Db7156413C43B7e88D189923'
];

const bellecourCompletionItems = [
  '└ Docker image: bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7',
  '└ iApp address: 0x1f80DCebc2EAAff0Db7156413C43B7e88D189923'
];
</script>
```

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

### Vue Setup Imports

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

This script block imports necessary components from '@iconify/vue' and local paths for building the iExec DApp tutorial interface. It sets up the foundational elements for the user interface.

```javascript
import { Icon } from '@iconify/vue';
import InfoIcon from '@/components/InfoIcon.vue'
import Banner from '../components/Banner.vue'
import Container from '../components/Container.vue'
import CardWithBorder from '../components/CardWithBorder.vue'
import CardGrid from '../components/CardGrid.vue'
import Badge from '../components/Badge.vue'
import TutorialCard from '../components/TutorialCard.vue'
```

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

### Instantiate Umbrella Module Without Provider

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

Instantiate the iExec DataProtector SDK using the umbrella module for all read-only functions. This approach provides access to both core and sharing methods through a single instance when no Web3 provider is available.

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

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

### Install iExec CLI (npm, yarn, pnpm, bun)

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

Install the iExec 'iapp' package globally using different package managers. This command-line tool is essential for building, testing, and deploying iExec applications.

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

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

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

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

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

### iExec Features Overview

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

Outlines the core features of the iExec platform, including a quick start guide, data protection with DataProtector, iApp generation, and decentralized task execution using iExec Workers.

```markdown
features:
  - icon:
      <svg class="_stroke" width="36" height="36" viewBox="0 0 36 36"
      fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M10.81
      29.1774H8.8733C7.84604 29.1774 6.86085 28.7694 6.13446 28.043C5.40808
      27.3166 5 26.3314 5 25.3041V7.87428C5 6.84702 5.40808 5.86183 6.13446
      5.13544C6.86085 4.40906 7.84604 4.00098 8.8733 4.00098H26.3032C27.3304
      4.00098 28.3156 4.40906 29.042 5.13544C29.7684 5.86183 30.1765 6.84702
      30.1765 7.87428V9.81093" stroke-width="2" stroke-linecap="round"
      stroke-linejoin="round"/> <path d="M22.5187 8.82727L10.9795
      22.6743H21.3648L20.2109 31.9057L31.7501 18.0586H21.3648L22.5187 8.82727Z"
      stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/> </svg>
    title: Quick Start
    details: Jump in and start building on iExec in minutes.
    link: /get-started/helloWorld
  - icon:
      <svg class="_stroke" width="38" height="36" viewBox="0 0 38 36"
      fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M5.16675
      10.5C5.16675 7.18629 7.85304 4.5 11.1667 4.5H26.1667C29.4805 4.5 32.1667
      7.18629 32.1667 10.5V25.5C32.1667 28.8137 29.4805 31.5 26.1667
      31.5H11.1667C7.85304 31.5 5.16675 28.8137 5.16675 25.5V10.5Z"
      stroke-width="2"/> <path d="M11.6667 12L11.6667 24" stroke-width="2"
      stroke-linecap="round"/> <path d="M15.6667 16.5L15.6667 24" stroke-width="2"
      stroke-linecap="round"/> <path d="M19.6667 25C19.6667
      21.6863 22.353 19 25.6667 19C28.9805 19 31.6667 21.6863 31.6667 25C31.6667
      28.3137 28.9805 31 25.6667 31C22.353 31 19.6667 28.3137 19.6667 25Z"
      stroke-width="2"/> <path d="M28.6667 20V16C28.6667 14.3431 27.3236 13
      25.6667 13C24.0099 13 22.6667 14.3431 22.6667 16V20" stroke-width="2"/>
      <path d="M25.6667 23.9996V25.9996" stroke-width="2"
      stroke-linecap="round"/> </svg>
    title: Protect & Manage Data
    details:
      DataProtector encrypts and allows you to control access to your sensitive
      data. Ready-to-use privacy toolkit for developers.
    link: /guides/manage-data/manage-access
  - icon:
      <svg class="_stroke" width="37" height="36" viewBox="0 0 37 36"
      fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M7.8335 9C7.8335
      6.51472 9.84821 4.5 12.3335 4.5H20.0909C20.8865 4.5 21.6496 4.81607
      22.2122 5.37868L27.9548 11.1213C28.5174 11.6839 28.8335 12.447 28.8335
      13.2426V27C28.8335 29.4853 26.8188 31.5 24.3335 31.5H12.3335C9.84822 31.5
      7.8335 29.4853 7.8335 27V9Z" stroke-width="2"/> <path d="M19.8335
      4V7C19.8335 10.3137 22.5198 13 25.8335 13H28.8335" stroke-width="2"/>
      <path d="M16.2282 17.6052L12.8335 21L16.2282 24.3947" stroke-width="1.5"
      stroke-linecap="round" stroke-linejoin="round"/> <path d="M20.2283
      24.3947L23.623 21L20.2283 17.6052" stroke-width="1.5"
      stroke-linecap="round" stroke-linejoin="round"/> </svg>
    title: Build iApp
    details:
      iApp Generator builds confidential applications that run in secure TEEs.
      Custom confidentiality integration without managing infrastructure.
    link: /guides/build-iapp/build-&-test
  - icon:
      <svg width="36" height="36" viewBox="0 0 36 36" fill="none"
      xmlns="http://www.w3.org/2000/svg"> <path class="_stroke" d="M30.4659
      27.7988H22.9899L20.4979 30.3488H15.5139L13.0219 27.7988H5.5459"
      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/> <path
      class="_stroke" d="M7.24329 24.6963L5.00049 27.633V32.7477C5.00049 33.1998
      5.27445 33.6335 5.76211 33.9532C6.24977 34.2729 6.91118 34.4526 7.60084
      34.4526H28.4037C29.0933 34.4526 29.7547 34.2729 30.2424 33.9532C30.73
      33.6335 31.004 33.1998 31.004 32.7477V27.633L28.7612 24.6963"
      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/> <path
      class="_fill" d="M30.5286 13.7324C31.0053 13.7324 31.3918 13.3548 31.3918
      12.8892C31.3918 12.4234 31.0053 12.0459 30.5286
      12.0459H28.9253V8.914H30.5286C31.0053 8.914 31.3918 8.53644 31.3918
      8.07078C31.3918 7.60505 31.0053 7.22757 30.5286
      7.22757H28.9253V5.17976C28.9253 3.65209 27.6528 2.40919 26.0888
      2.40919H23.9922V0.843216C23.9922 0.37752 23.6056 0 23.1289 0C22.6521 0
      22.2656 0.37752 22.2656 0.843216V2.40919H19.0591V0.843216C19.0591 0.37752
      18.6726 0 18.1958 0C17.7191 0 17.3325 0.37752 17.3325
      0.843216V2.40919H14.126V0.843216C14.126 0.37752 13.7395 0 13.2627 0C12.786
```

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

### Project File Structure

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

Illustrates the typical directory structure for the iExec documentation project, outlining the purpose of key directories like 'components', 'guides', and 'references'.

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

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

### Install DataProtector with bun

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

Installs the DataProtector library using bun, a new JavaScript runtime and toolkit. This command adds the library as a dependency to your project.

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

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

### Instantiate IExecWeb3mail Without a Web3 Provider

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

Shows how to instantiate the IExecWeb3mail SDK without a Web3 provider, suitable for projects that only require read functions. This method is applicable in both browser and NodeJS environments.

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

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

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

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

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

### Install DataProtector with npm

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

Installs the DataProtector library using npm, a package manager for Node.js. This is the first step to using DataProtector in your project.

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

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

### Local Testing Commands

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

npm commands for building the project, checking syntax, and running documentation tests with Vale.

```bash
# Build the project
npm run build
```

```bash
# Check syntax
npm run lint
```

```bash
# Documentation tests with Vale
vale src/
```

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

### Install Vale Documentation Linter

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

Commands to install the Vale documentation linter on macOS, Linux, and Windows using common package managers.

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

```bash
snap install vale
```

```bash
choco install vale
```

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

### Initialize your iApp

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/iapp-generator/building-your-iexec-app.md

Guides you through the step-by-step initialization process for your iApp using the iApp Generator CLI, ensuring correct configuration for iExec's confidential computing environment.

```APIDOC
## Initialize your iApp

The iApp (iExec App) Generator command-line tool simplifies the setup of your iApp by guiding you through a step-by-step initialization process. This ensures your iApp is correctly configured and compatible with iExec's confidential computing environment.

### Define your project

The `iapp init` command interactively prompts you for:

- **Project name**: Creates a folder for your project files.
- **Language**: Choose between JavaScript, Python, etc.
- **Project mode**: Choose Basic (Hello-World setup) or Advanced mode.

### Configure your iApp

Set up the following configurations:

- **Arguments (Args)**: Public parameters for your iApp.
- **Input Files**: Files dynamically downloaded during execution (from a specific URL).
- **Requester Secrets**: Confidential authentication strings.
- **Protected Data**: Encrypted data accessible only inside the TEE.
- **App Secret**: Immutable secret provisioned by the iApp owner.

Refer to the [Inputs documentation](/guides/build-iapp/inputs) for more details.
```

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

### Install DataProtector with yarn

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

Installs the DataProtector library using yarn, an alternative package manager for Node.js. This command is equivalent to the npm install command.

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

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

### Verify iExec SDK Installation

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

Checks if the iExec SDK has been installed correctly and displays its version and available commands.

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

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

### Install Latest iExec DataProtector Package

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/dataProtector/migrate-from-v1.md

Installs the latest version of the @iexec/dataprotector npm package. This is the first step in migrating to v2.

```shell
npm install @iexec/dataprotector@latest
```

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

### Configure Environment Variables

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

Commands to copy the example environment file and set the VITE_REOWN_PROJECT_ID variable.

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

```env
VITE_REOWN_PROJECT_ID=your_project_id_here
```

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

### Install iExec SDK (npm, yarn, pnpm, bun)

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

Installs the iExec SDK command-line interface using different package managers. This is the first step to managing app orders via the CLI.

```sh
npm install iexec
```

```sh
yarn add iexec
```

```sh
pnpm add iexec
```

```sh
bun add iexec
```

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

### App Order Example (JSON)

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

An example JSON structure representing an app order, defining parameters like app address, price, volume, and restrictions.

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

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

### View Deployment Details (JSON)

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

An example JSON structure showing details of a deployed iApp. It includes the Sconified image, the iApp contract address, the owner, and the deployment date.

```json
[
  {
    "sconifiedImage": "robiniexec/iapp:0.0.1-tee-scone-5.9.1-v16-5aea8b4aa71d",
    "appContractAddress": "0x9665136c599ec361C8eE627eC4F35A23fBa94897",
    "owner": "0xbabE8270aC9857Af3aaC06877888F1939FbeC578",
    "date": "2025-08-12T13:16:18.252Z"
  },
  ...
]
```

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

### Clone iExec Documentation Repository

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

Clones the iExec documentation repository from GitHub to your local machine. Requires Git and a GitHub account.

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

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

### Install DataProtector with pnpm

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

Installs the DataProtector library using pnpm, a performant package manager for Node.js. This is another alternative for managing project dependencies.

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

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

### Show Deployed iApp Details

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

Retrieves and displays the details of a deployed iApp on a specified iExec chain. This is useful for verifying the deployment and getting the app's index.

```bash
iexec app show --chain arbitrum-mainnet
```

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

### Install iApp Generator CLI

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

Installs the iApp Generator CLI tool globally using npm, yarn, pnpm, or bun. This tool is essential for bootstrapping iExec applications.

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

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

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

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

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

### Install DataProtector using npm, yarn, pnpm, or bun

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

Install the '@iexec/dataprotector' package using your preferred package manager. This command makes the DataProtector library available for use in your project.

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

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

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

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

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

### Initialize iExec Project Configuration

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

Initializes the iExec configuration files (`iexec.json`, `chain.json`) within your project directory, skipping wallet setup for initial configuration.

```bash
# In your iApp Generator project folder
iexec init --skip-wallet
```

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

### Install iExec SDK (bun)

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/use-iapp/run-iapp-without-ProtectedData.md

Installs the iExec SDK using bun, a fast JavaScript runtime and package manager. This is required to use the iExec SDK.

```sh
bun add iexec
```

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

### Vale Usage Commands

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

Commands for using the Vale linter, including syncing configurations, checking files, and generating reports.

```bash
# Download external configurations
vale sync
```

```bash
# Check all documentation files
vale src/
```

```bash
# Check specific files
vale src/get-started/helloWorld/1-overview.md
```

```bash
# Get detailed output
vale --output=line src/
```

```bash
# Generate comprehensive report with statistics
vale --output=line src/ > vale-report.txt 2>&1
```

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

### Test iApp Locally

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/references/iapp-generator/building-your-iexec-app.md

Provides examples of testing an iApp locally using the 'iapp test' command. It shows how to pass arguments, specify protected data, provide input files via URLs, and set requester secrets.

```bash
iapp test --args "input_param=value" --inputFile "http://example.com/data.csv" --requesterSecret "MY_SECRET=12345"
```

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

### Install @iexec/dataprotector-deserializer with Package Managers

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

This snippet shows how to install the @iexec/dataprotector-deserializer package using various package managers like npm, yarn, pnpm, and bun.

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

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

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

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

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

### Install iExec SDK (pnpm)

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/use-iapp/run-iapp-without-ProtectedData.md

Installs the iExec SDK using pnpm, another package manager for Node.js. This ensures the SDK is available for use.

```sh
pnpm add iexec
```

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

### Initialize iApp Project with CLI

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

Bootstrap a new iApp project by creating a directory, navigating into it, and running the `iapp init` command. This sets up the project structure and prompts for project name, programming language (JavaScript/Python), and project type (Hello World/advanced).

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

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

### Install iExec SDK (yarn)

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/use-iapp/run-iapp-without-ProtectedData.md

Installs the iExec SDK using yarn, an alternative package manager for Node.js. This step is necessary before utilizing the SDK.

```sh
yarn add iexec
```

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

### Install iExec SDK (npm)

Source: https://github.com/iexecblockchaincomputing/documentation/blob/main/src/guides/use-iapp/run-iapp-without-ProtectedData.md

Installs the iExec SDK using npm, a package manager for Node.js. This is a prerequisite for using the SDK's functionalities.

```sh
npm install iexec
```

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

### Vue Component Setup for Web3Telegram

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

This script setup block is used in a Vue.js component to import the Icon component from '@iconify/vue'. This is likely used for displaying icons within the Web3Telegram interface, such as the demo link.

```javascript
import { Icon } from '@iconify/vue';

```

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

### Commit Changes to Git

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

Stages all changes and commits them with a descriptive message. Requires Git.

```bash
git add .
git commit -m "Add: description of your changes"
```

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

### App Order Configuration in iexec.json

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

An example of how the app order parameters are structured within the `iexec.json` configuration file.

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

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

### Cloning AI Frameworks Hello World Repository

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

Clones the iExec AI Frameworks Hello World repository from GitHub. This is the initial step to access the example Docker configurations for various AI frameworks.

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

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

### Initialize iExec Project and Set Up Directory Structure - Bash

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

Initializes a new iExec project for a Scone-based application and sets up the necessary directory structure and files. This includes creating a project directory, a source directory, and essential configuration files like Dockerfile and sconify.sh.

```bash
cd ~/iexec-projects
mkdir tee-hello-world-app && cd tee-hello-world-app
iexec init --skip-wallet
mkdir src
touch Dockerfile
touch sconify.sh
chmod +x sconify.sh
```

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

### Docker Build and Run for TensorFlow

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

Builds a Docker image for the TensorFlow example and runs it. This demonstrates how to containerize and execute a TensorFlow application within the iExec environment.

```bash
cd tensorflow
docker build -t hello-tensorflow .
docker run --rm hello-tensorflow
```

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

### Vue.js Script Setup for iExec Project

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

This snippet demonstrates the setup of a Vue.js component, importing necessary UI components like ImageViewer, CardGrid, and ProjectCard. It also imports various assets including logos and images used within the iExec project, such as the iExec logo, Arbitrum logo, bridge images, and the Halborn logo.

```javascript
<script setup>
import ImageViewer from '@/components/ImageViewer.vue';
import CardGrid from '@/components/CardGrid.vue';
import ProjectCard from '@/components/ProjectCard.vue';

// Assets
import iexecLogoIcon from '@/assets/icons/iexec-logo.png';
import arbitrumLogoIcon from '@/assets/icons/arbitrum.svg';
import bellecourBridgeImage from '@/assets/tooling-&-explorers/bridge/bellecour-bridge.png';
import stargateBridgeImage from '@/assets/tooling-&-explorers/bridge/stargate-bridge.png';
import halbornLogoIcon from '@/assets/icons/halborn.svg';
</script>
```

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

### Docker Build and Run for PyTorch

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

Builds a Docker image for the PyTorch example and runs it. This showcases the process of containerizing and executing a PyTorch application for iExec.

```bash
cd ../pytorch
docker build -t hello-pytorch .
docker run --rm hello-pytorch
```