Quick start

1. Sandbox

https://codesandbox.io/p/github/iExecBlockchainComputing/dataprotector-sandbox/main?file=%2Fsrc%2Fmain.tsx%3A18%2C7&preventWorkspaceRedirect=true

2. Getting started

2.1. Prerequisites

Before getting started, ensure that you have the following installed on your system:

- Node.js version 18 or higher

- NPM (Node.js package manager)

2.2. Start a new project

In this section, we will show you how to set up and call the different methods of the SDK in a React.js app.

You can reach the following open-source GitHub project, clone it and start from there.

You can find the project here.

2.3. Basic installation

Install dataProtectorSDK .

npm

npm install @iexec/dataprotector

yarn

yarn add @iexec/dataprotector

pnpm

pnpm add @iexec/dataprotector

bun

bun add @iexec/dataprotector

This package is an ESM package. Your project needs to be ESM too. Read more.

If you use it with Webpack, you need the latest Webpack version and ensure you configure it correctly for ESM.

2.4. Instantiate SDK

Browser

Instantiate the SDK in your frontend project:

2.4.1. Basic Instantiation

import { IExecDataProtector } from "@iexec/dataprotector";

const web3Provider = window.ethereum;
// instantiate
const dataProtector = new IExecDataProtector(web3Provider);

NodeJS

Instantiate the SDK in your backend project:

2.4.1. Basic Instantiation

import { IExecDataProtector, getWeb3Provider } from "@iexec/dataprotector";

const { PRIVATE_KEY } = process.env; 
// get web3 provider from a private key
const web3Provider = getWeb3Provider(PRIVATE_KEY);

// instantiate
const dataProtector = new IExecDataProtector(web3Provider);