DataProtector Deserializer
If you want to build your own iDapp (iExec TEE Dapp), you may need to access protected data that your wallet and iDapp are authorized to use. To achieve this, you must deserialize the content of the protected data with the expected data schema.
To simplify this process, you can use our lightweight utility package, @iexec/dataprotector-deserializer, in your iDapp. This package streamlines the deserialization of protected data, making it easy for you to access and utilize the information securely.
Overview
This deserializer is built on the Borsh technical specification. We developed this JavaScript library to simplify deserialization in your iDapp built with JavaScript.
WARNING
If you want to build your iDapp in another language, you need to know how to deserialize a protected data.
Under the hood, protected data are zip files replicating the tree structure of the original data object. Each value is stored in a dedicated file, binary values are stored as is while boolean, numbers, and strings are serialized with borsh.
To access a value from a protected data, your app will need to unzip the iExec dataset file at $IEXEC_IN/$IEXEC_DATASET_FILENAME. Then for 'bool', 'f64', 'i128' or 'string' types, use the Borsh deserialization specification to recover the original value. Borsh has implementations in various languages, check your favorite one.
Prerequisites
Before getting started, ensure that you have the following installed on your system:
- Node.js version 14 or higher
- NPM (Node.js package manager)
Installation
npm install @iexec/dataprotector-deserializeryarn add @iexec/dataprotector-deserializerpnpm add @iexec/dataprotector-deserializerbun add @iexec/dataprotector-deserializerInstantiate SDK
import { IExecDataProtectorDeserializer } from '@iexec/dataprotector-deserializer';
const deserializer = new IExecDataProtectorDeserializer();