@iexec/web3mail 0.2.0 → 0.4.0

package/dist/config/config.d.ts

@@ -4,3 +4,5 @@ export declare const DATAPROTECTOR_SUBGRAPH_ENDPOINT = "https://thegraph-product
 export declare const MAX_DESIRED_APP_ORDER_PRICE = 0;
 export declare const MAX_DESIRED_WORKERPOOL_ORDER_PRICE = 0;
 export declare const DEFAULT_CONTENT_TYPE = "text/plain";
+export declare const IPFS_UPLOAD_URL = "/dns4/ipfs-upload.v8-bellecour.iex.ec/https";
+export declare const DEFAULT_IPFS_GATEWAY = "https://ipfs-gateway.v8-bellecour.iex.ec";

package/dist/config/config.js

@@ -4,3 +4,5 @@ export const DATAPROTECTOR_SUBGRAPH_ENDPOINT = 'https://thegraph-product.iex.ec/
 export const MAX_DESIRED_APP_ORDER_PRICE = 0;
 export const MAX_DESIRED_WORKERPOOL_ORDER_PRICE = 0;
 export const DEFAULT_CONTENT_TYPE = 'text/plain';
+export const IPFS_UPLOAD_URL = '/dns4/ipfs-upload.v8-bellecour.iex.ec/https';
+export const DEFAULT_IPFS_GATEWAY = 'https://ipfs-gateway.v8-bellecour.iex.ec';

package/dist/utils/generateUniqueId.d.ts

@@ -1 +1 @@
-export declare function generateSecureUniqueId(length: number): string;
+export declare function generateSecureUniqueId(length: any): string;

package/dist/utils/generateUniqueId.js

@@ -1,5 +1,5 @@
-import crypto from 'crypto';
+import { randomBytes } from '@ethersproject/random';
+import { hexlify } from '@ethersproject/bytes';
 export function generateSecureUniqueId(length) {
-    const buffer = crypto.randomBytes(length);
-    return buffer.toString('hex');
+    return hexlify(randomBytes(length));
 }

package/dist/utils/ipfs-service.d.ts

@@ -0,0 +1,7 @@
+declare const get: (cid: any, { ipfsGateway }?: {
+    ipfsGateway?: string;
+}) => Promise<Uint8Array>;
+declare const add: (content: any, { ipfsGateway }?: {
+    ipfsGateway?: string;
+}) => Promise<any>;
+export { add, get };

package/dist/utils/ipfs-service.js

@@ -0,0 +1,28 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { create } from 'kubo-rpc-client';
+import { DEFAULT_IPFS_GATEWAY, IPFS_UPLOAD_URL } from './../config/config.js';
+const get = (cid, { ipfsGateway = DEFAULT_IPFS_GATEWAY } = {}) => __awaiter(void 0, void 0, void 0, function* () {
+    const multiaddr = `/ipfs/${cid.toString()}`;
+    const publicUrl = `${ipfsGateway}${multiaddr}`;
+    const res = yield fetch(publicUrl);
+    if (!res.ok) {
+        throw Error(`Failed to load content from ${publicUrl}`);
+    }
+    const arrayBuffer = yield res.arrayBuffer();
+    return new Uint8Array(arrayBuffer);
+});
+const add = (content, { ipfsGateway = DEFAULT_IPFS_GATEWAY } = {}) => __awaiter(void 0, void 0, void 0, function* () {
+    const ipfsClient = create(IPFS_UPLOAD_URL);
+    const { cid } = yield ipfsClient.add(content);
+    yield get(cid.toString(), { ipfsGateway });
+    return cid.toString();
+});
+export { add, get };

package/dist/utils/validators.d.ts

@@ -3,3 +3,4 @@ export declare const addressOrEnsSchema: () => import("yup").StringSchema<string
 export declare const emailSubjectSchema: () => import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
 export declare const emailContentSchema: () => import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
 export declare const contentTypeSchema: () => import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
+export declare const senderNameSchema: () => import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;

package/dist/utils/validators.js

@@ -12,8 +12,10 @@ export const addressOrEnsSchema = () => string()
     .test('is-address-or-ens', '${path} should be an ethereum address or a ENS name', (value) => isUndefined(value) || isAddressTest(value) || isEnsTest(value));
 // 78 char length for email subject (rfc2822)
 export const emailSubjectSchema = () => string().max(78).strict();
-// 4096 bytes is the current max length for iExec SMS secrets
-export const emailContentSchema = () => string().max(4096).strict();
+// Limit of 512,000 bytes (512 kilo-bytes)
+export const emailContentSchema = () => string().max(512000);
 // Valid content types for the variable 'contentType'
 const validContentTypes = ['text/plain', 'text/html'];
 export const contentTypeSchema = () => string().oneOf(validContentTypes, 'Invalid contentType').optional();
+// Minimum of 3 characters and max of 20 to avoid sender being flagged as spam
+export const senderNameSchema = () => string().trim().min(3).max(20).optional();

package/dist/web3mail/sendEmail.d.ts

@@ -1,2 +1,2 @@
 import { IExecConsumer, SendEmailParams, SendEmailResponse, SubgraphConsumer } from './types.js';
-export declare const sendEmail: ({ graphQLClient, iexec, emailSubject, emailContent, contentType, protectedData, }: IExecConsumer & SubgraphConsumer & SendEmailParams) => Promise<SendEmailResponse>;
+export declare const sendEmail: ({ graphQLClient, iexec, emailSubject, emailContent, contentType, senderName, protectedData, }: IExecConsumer & SubgraphConsumer & SendEmailParams) => Promise<SendEmailResponse>;

package/dist/web3mail/sendEmail.js

@@ -11,8 +11,9 @@ import { DEFAULT_CONTENT_TYPE, MAX_DESIRED_APP_ORDER_PRICE, MAX_DESIRED_WORKERPO
 import { WorkflowError } from '../utils/errors.js';
 import { generateSecureUniqueId } from '../utils/generateUniqueId.js';
 import { checkProtectedDataValidity } from '../utils/subgraphQuery.js';
-import { addressOrEnsSchema, contentTypeSchema, emailContentSchema, emailSubjectSchema, throwIfMissing, } from '../utils/validators.js';
-export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMissing(), emailSubject, emailContent, contentType = DEFAULT_CONTENT_TYPE, protectedData, }) => __awaiter(void 0, void 0, void 0, function* () {
+import { addressOrEnsSchema, contentTypeSchema, emailContentSchema, emailSubjectSchema, senderNameSchema, throwIfMissing, } from '../utils/validators.js';
+import * as ipfs from './../utils/ipfs-service.js';
+export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMissing(), emailSubject, emailContent, contentType = DEFAULT_CONTENT_TYPE, senderName, protectedData, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b, _c, _d, _e;
     try {
         const vDatasetAddress = addressOrEnsSchema()
@@ -31,6 +32,9 @@ export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMis
             .required()
             .label('contentType')
             .validateSync(contentType);
+        const vSenderName = senderNameSchema()
+            .label('senderName')
+            .validateSync(senderName);
         // Check protected data validity through subgraph
         const isValidProtectedData = yield checkProtectedDataValidity(graphQLClient, vDatasetAddress);
         if (!isValidProtectedData) {
@@ -91,9 +95,22 @@ export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMis
         const emailContentId = generateSecureUniqueId(16);
         const optionsId = generateSecureUniqueId(16);
         yield iexec.secrets.pushRequesterSecret(emailSubjectId, vEmailSubject);
-        yield iexec.secrets.pushRequesterSecret(emailContentId, vEmailContent);
-        yield iexec.secrets.pushRequesterSecret(optionsId, JSON.stringify({ contentType: vContentType }));
-        // Create and sign request order
+        const emailContentEncryptionKey = iexec.dataset.generateEncryptionKey();
+        const encryptedFile = yield iexec.dataset
+            .encrypt(Buffer.from(vEmailContent, 'utf8'), emailContentEncryptionKey)
+            .catch((e) => {
+            throw new WorkflowError('Failed to encrypt email content', e);
+        });
+        const cid = yield ipfs.add(encryptedFile).catch((e) => {
+            throw new WorkflowError('Failed to upload encrypted email content', e);
+        });
+        const multiaddr = `/ipfs/${cid}`;
+        yield iexec.secrets.pushRequesterSecret(emailContentId, multiaddr);
+        yield iexec.secrets.pushRequesterSecret(optionsId, JSON.stringify({
+            contentType: vContentType,
+            senderName: vSenderName,
+            emailContentEncryptionKey,
+        }));
         const requestorderToSign = yield iexec.order.createRequestorder({
             app: WEB3_MAIL_DAPP_ADDRESS,
             category: desiredPriceWorkerpoolOrder.category,

package/dist/web3mail/types.d.ts

@@ -16,6 +16,7 @@ export type SendEmailParams = {
     emailContent: string;
     protectedData: Address;
     contentType?: string;
+    senderName?: string;
 };
 export type SendEmailResponse = {
     taskId: Address;

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@iexec/web3mail",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "This product enables users to confidentially store data–such as mail address, documents, personal information ...",
-  "main": "./dist/bundle.js",
+  "main": "./dist/index.js",
   "type": "module",
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "node": "./dist/index.js",
-      "default": "./dist/bundle.js"
+      "default": "./dist/index.js"
     }
   },
   "files": [
@@ -18,8 +18,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "rm -rf dist && tsc && webpack",
-    "start": "node dist/bundle.js",
+    "build": "rm -rf dist && tsc",
     "test": "rm -rf dist && tsc && NODE_OPTIONS=--experimental-vm-modules npx jest --coverage",
     "lint": "eslint . --ext .ts",
     "format": "prettier --write \"src/**/*.ts\"",
@@ -40,11 +39,8 @@
   "homepage": "https://github.com/iExecBlockchainComputing/web3mail-sdk#readme",
   "devDependencies": {
     "@iexec/dataprotector": "^0.1.0",
-    "@types/jest": "^29.5.1",
+    "@types/jest": "^29.5.4",
     "@typescript-eslint/eslint-plugin": "^5.54.0",
-    "assert": "^2.0.0",
-    "constants-browserify": "^1.0.0",
-    "crypto-browserify": "^3.12.0",
     "eslint": "^8.35.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-config-standard-with-typescript": "^34.0.0",
@@ -53,15 +49,16 @@
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.5.0",
     "prettier": "^2.8.4",
-    "stream-browserify": "^3.0.0",
     "ts-jest": "^29.1.0",
     "ts-loader": "^9.4.2",
-    "typescript": "^4.9.5",
-    "webpack-cli": "^5.0.1"
+    "typescript": "^4.9.5"
   },
   "dependencies": {
+    "@ethersproject/bytes": "^5.7.0",
+    "@ethersproject/random": "^5.7.0",
     "graphql-request": "^6.1.0",
-    "iexec": "^8.1.5",
+    "iexec": "^8.2.1",
+    "kubo-rpc-client": "^3.0.1",
     "yup": "^1.1.1"
   }
 }

package/src/config/config.ts

@@ -5,3 +5,5 @@ export const DATAPROTECTOR_SUBGRAPH_ENDPOINT =
 export const MAX_DESIRED_APP_ORDER_PRICE = 0;
 export const MAX_DESIRED_WORKERPOOL_ORDER_PRICE = 0;
 export const DEFAULT_CONTENT_TYPE = 'text/plain';
+export const IPFS_UPLOAD_URL = '/dns4/ipfs-upload.v8-bellecour.iex.ec/https';
+export const DEFAULT_IPFS_GATEWAY = 'https://ipfs-gateway.v8-bellecour.iex.ec';

package/src/utils/generateUniqueId.ts

@@ -1,6 +1,6 @@
-import crypto from 'crypto';
+import { randomBytes } from '@ethersproject/random';
+import { hexlify } from '@ethersproject/bytes';
 
-export function generateSecureUniqueId(length: number): string {
-  const buffer = crypto.randomBytes(length);
-  return buffer.toString('hex');
+export function generateSecureUniqueId(length) {
+  return hexlify(randomBytes(length));
 }

package/src/utils/ipfs-service.ts

@@ -0,0 +1,22 @@
+import { create } from 'kubo-rpc-client';
+import { DEFAULT_IPFS_GATEWAY, IPFS_UPLOAD_URL } from './../config/config.js';
+
+const get = async (cid, { ipfsGateway = DEFAULT_IPFS_GATEWAY } = {}) => {
+  const multiaddr = `/ipfs/${cid.toString()}`;
+  const publicUrl = `${ipfsGateway}${multiaddr}`;
+  const res = await fetch(publicUrl);
+  if (!res.ok) {
+    throw Error(`Failed to load content from ${publicUrl}`);
+  }
+  const arrayBuffer = await res.arrayBuffer();
+  return new Uint8Array(arrayBuffer);
+};
+
+const add = async (content, { ipfsGateway = DEFAULT_IPFS_GATEWAY } = {}) => {
+  const ipfsClient = create(IPFS_UPLOAD_URL);
+  const { cid } = await ipfsClient.add(content);
+  await get(cid.toString(), { ipfsGateway });
+  return cid.toString();
+};
+
+export { add, get };

package/src/utils/validators.ts

@@ -23,11 +23,14 @@ export const addressOrEnsSchema = () =>
 // 78 char length for email subject (rfc2822)
 export const emailSubjectSchema = () => string().max(78).strict();
 
-// 4096 bytes is the current max length for iExec SMS secrets
-export const emailContentSchema = () => string().max(4096).strict();
+// Limit of 512,000 bytes (512 kilo-bytes)
+export const emailContentSchema = () => string().max(512000);
 
 // Valid content types for the variable 'contentType'
 const validContentTypes = ['text/plain', 'text/html'];
 
 export const contentTypeSchema = () =>
   string().oneOf(validContentTypes, 'Invalid contentType').optional();
+
+// Minimum of 3 characters and max of 20 to avoid sender being flagged as spam
+export const senderNameSchema = () => string().trim().min(3).max(20).optional();

package/src/web3mail/sendEmail.ts

@@ -13,6 +13,7 @@ import {
   contentTypeSchema,
   emailContentSchema,
   emailSubjectSchema,
+  senderNameSchema,
   throwIfMissing,
 } from '../utils/validators.js';
 import {
@@ -21,6 +22,7 @@ import {
   SendEmailResponse,
   SubgraphConsumer,
 } from './types.js';
+import * as ipfs from './../utils/ipfs-service.js';
 
 export const sendEmail = async ({
   graphQLClient = throwIfMissing(),
@@ -28,6 +30,7 @@ export const sendEmail = async ({
   emailSubject,
   emailContent,
   contentType = DEFAULT_CONTENT_TYPE,
+  senderName,
   protectedData,
 }: IExecConsumer &
   SubgraphConsumer &
@@ -45,11 +48,13 @@ export const sendEmail = async ({
       .required()
       .label('emailContent')
       .validateSync(emailContent);
-
     const vContentType = contentTypeSchema()
       .required()
       .label('contentType')
       .validateSync(contentType);
+    const vSenderName = senderNameSchema()
+      .label('senderName')
+      .validateSync(senderName);
 
     // Check protected data validity through subgraph
     const isValidProtectedData = await checkProtectedDataValidity(
@@ -137,13 +142,30 @@ export const sendEmail = async ({
     const emailSubjectId = generateSecureUniqueId(16);
     const emailContentId = generateSecureUniqueId(16);
     const optionsId = generateSecureUniqueId(16);
+
     await iexec.secrets.pushRequesterSecret(emailSubjectId, vEmailSubject);
-    await iexec.secrets.pushRequesterSecret(emailContentId, vEmailContent);
+
+    const emailContentEncryptionKey = iexec.dataset.generateEncryptionKey();
+    const encryptedFile = await iexec.dataset
+      .encrypt(Buffer.from(vEmailContent, 'utf8'), emailContentEncryptionKey)
+      .catch((e) => {
+        throw new WorkflowError('Failed to encrypt email content', e);
+      });
+    const cid = await ipfs.add(encryptedFile).catch((e) => {
+      throw new WorkflowError('Failed to upload encrypted email content', e);
+    });
+    const multiaddr = `/ipfs/${cid}`;
+
+    await iexec.secrets.pushRequesterSecret(emailContentId, multiaddr);
     await iexec.secrets.pushRequesterSecret(
       optionsId,
-      JSON.stringify({ contentType: vContentType })
+      JSON.stringify({
+        contentType: vContentType,
+        senderName: vSenderName,
+        emailContentEncryptionKey,
+      })
     );
-    // Create and sign request order
+
     const requestorderToSign = await iexec.order.createRequestorder({
       app: WEB3_MAIL_DAPP_ADDRESS,
       category: desiredPriceWorkerpoolOrder.category,

package/src/web3mail/types.ts

@@ -21,6 +21,7 @@ export type SendEmailParams = {
   emailContent: string;
   protectedData: Address;
   contentType?: string;
+  senderName?: string;
 };
 
 export type SendEmailResponse = {