@iexec/web3mail 1.6.0-nightly-b2a0e93 → 1.7.0

package/dist/web3mail/sendEmail.js

@@ -1,53 +1,164 @@
 import { Buffer } from 'buffer';
-import { DEFAULT_CONTENT_TYPE, MAX_DESIRED_APP_ORDER_PRICE, MAX_DESIRED_DATA_ORDER_PRICE, MAX_DESIRED_WORKERPOOL_ORDER_PRICE, } from '../config/config.js';
+import { CALLBACK_WEB3MAIL, DEFAULT_CONTENT_TYPE, MAX_DESIRED_APP_ORDER_PRICE, MAX_DESIRED_DATA_ORDER_PRICE, MAX_DESIRED_WORKERPOOL_ORDER_PRICE, } from '../config/config.js';
 import { handleIfProtocolError, WorkflowError } from '../utils/errors.js';
+import { generateSecureUniqueId } from '../utils/generateUniqueId.js';
 import * as ipfs from '../utils/ipfs-service.js';
 import { checkProtectedDataValidity } from '../utils/subgraphQuery.js';
-import { addressOrEnsSchema, booleanSchema, contentTypeSchema, emailContentSchema, emailSubjectSchema, labelSchema, positiveNumberSchema, senderNameSchema, throwIfMissing, } from '../utils/validators.js';
-export const sendEmail = async ({ graphQLClient = throwIfMissing(), iexec = throwIfMissing(), dataProtector = throwIfMissing(), workerpoolAddressOrEns = throwIfMissing(), dappAddressOrENS, ipfsNode, ipfsGateway, emailSubject, emailContent, contentType = DEFAULT_CONTENT_TYPE, label, dataMaxPrice = MAX_DESIRED_DATA_ORDER_PRICE, appMaxPrice = MAX_DESIRED_APP_ORDER_PRICE, workerpoolMaxPrice = MAX_DESIRED_WORKERPOOL_ORDER_PRICE, senderName, protectedData, grantedAccess, maxProtectedDataPerTask, useVoucher = false, }) => {
+import { addressOrEnsSchema, addressSchema, booleanSchema, contentTypeSchema, emailContentSchema, emailSubjectSchema, labelSchema, positiveNumberSchema, senderNameSchema, throwIfMissing, } from '../utils/validators.js';
+import { checkUserVoucher, filterWorkerpoolOrders, } from './sendEmail.models.js';
+export const sendEmail = async ({ graphQLClient = throwIfMissing(), iexec = throwIfMissing(), workerpoolAddressOrEns, dappAddressOrENS, dappWhitelistAddress, ipfsNode, ipfsGateway, emailSubject, emailContent, contentType = DEFAULT_CONTENT_TYPE, label, dataMaxPrice = MAX_DESIRED_DATA_ORDER_PRICE, appMaxPrice = MAX_DESIRED_APP_ORDER_PRICE, workerpoolMaxPrice = MAX_DESIRED_WORKERPOOL_ORDER_PRICE, senderName, protectedData, useVoucher = false, }) => {
+    const vDatasetAddress = addressOrEnsSchema()
+        .required()
+        .label('protectedData')
+        .validateSync(protectedData);
+    const vEmailSubject = emailSubjectSchema()
+        .required()
+        .label('emailSubject')
+        .validateSync(emailSubject);
+    const vEmailContent = emailContentSchema()
+        .required()
+        .label('emailContent')
+        .validateSync(emailContent);
+    const vContentType = contentTypeSchema()
+        .required()
+        .label('contentType')
+        .validateSync(contentType);
+    const vSenderName = senderNameSchema()
+        .label('senderName')
+        .validateSync(senderName);
+    const vLabel = labelSchema().label('label').validateSync(label);
+    const vWorkerpoolAddressOrEns = addressOrEnsSchema()
+        .required()
+        .label('WorkerpoolAddressOrEns')
+        .validateSync(workerpoolAddressOrEns);
+    const vDappAddressOrENS = addressOrEnsSchema()
+        .required()
+        .label('dappAddressOrENS')
+        .validateSync(dappAddressOrENS);
+    const vDappWhitelistAddress = addressSchema()
+        .required()
+        .label('dappWhitelistAddress')
+        .validateSync(dappWhitelistAddress);
+    const vDataMaxPrice = positiveNumberSchema()
+        .label('dataMaxPrice')
+        .validateSync(dataMaxPrice);
+    const vAppMaxPrice = positiveNumberSchema()
+        .label('appMaxPrice')
+        .validateSync(appMaxPrice);
+    const vWorkerpoolMaxPrice = positiveNumberSchema()
+        .label('workerpoolMaxPrice')
+        .validateSync(workerpoolMaxPrice);
+    const vUseVoucher = booleanSchema()
+        .label('useVoucher')
+        .validateSync(useVoucher);
+    // Check protected data schema through subgraph
+    const isValidProtectedData = await checkProtectedDataValidity(graphQLClient, vDatasetAddress);
+    if (!isValidProtectedData) {
+        throw new Error('This protected data does not contain "email:string" in its schema.');
+    }
+    const requesterAddress = await iexec.wallet.getAddress();
+    let userVoucher;
+    if (vUseVoucher) {
+        try {
+            userVoucher = await iexec.voucher.showUserVoucher(requesterAddress);
+            checkUserVoucher({ userVoucher });
+        }
+        catch (err) {
+            if (err?.message?.startsWith('No Voucher found for address')) {
+                throw new Error('Oops, it seems your wallet is not associated with any voucher. Check on https://builder.iex.ec/');
+            }
+            throw err;
+        }
+    }
     try {
-        const vUseVoucher = booleanSchema()
-            .label('useVoucher')
-            .validateSync(useVoucher);
-        const vWorkerpoolAddressOrEns = addressOrEnsSchema()
-            .required()
-            .label('WorkerpoolAddressOrEns')
-            .validateSync(workerpoolAddressOrEns);
-        const vSenderName = senderNameSchema()
-            .label('senderName')
-            .validateSync(senderName);
-        const vEmailSubject = emailSubjectSchema()
-            .required()
-            .label('emailSubject')
-            .validateSync(emailSubject);
-        const vEmailContent = emailContentSchema()
-            .required()
-            .label('emailContent')
-            .validateSync(emailContent);
-        const vContentType = contentTypeSchema()
-            .required()
-            .label('contentType')
-            .validateSync(contentType);
-        const vLabel = labelSchema().label('label').validateSync(label);
-        const vDappAddressOrENS = addressOrEnsSchema()
-            .required()
-            .label('dappAddressOrENS')
-            .validateSync(dappAddressOrENS);
-        // TODO: remove this once we have a way to pass appWhitelist to processProtectedData function
-        // const vDappWhitelistAddress = addressSchema()
-        //   .required()
-        //   .label('dappWhitelistAddress')
-        //   .validateSync(dappWhitelistAddress);
-        const vDataMaxPrice = positiveNumberSchema()
-            .label('dataMaxPrice')
-            .validateSync(dataMaxPrice);
-        const vAppMaxPrice = positiveNumberSchema()
-            .label('appMaxPrice')
-            .validateSync(appMaxPrice);
-        const vWorkerpoolMaxPrice = positiveNumberSchema()
-            .label('workerpoolMaxPrice')
-            .validateSync(workerpoolMaxPrice);
-        // Encrypt email content
+        const [datasetorderForApp, datasetorderForWhitelist, apporder, workerpoolorder,] = await Promise.all([
+            // Fetch dataset order for web3mail app
+            iexec.orderbook
+                .fetchDatasetOrderbook({
+                dataset: vDatasetAddress,
+                app: dappAddressOrENS,
+                requester: requesterAddress,
+            })
+                .then((datasetOrderbook) => {
+                const desiredPriceDataOrderbook = datasetOrderbook.orders.filter((order) => order.order.datasetprice <= vDataMaxPrice);
+                return desiredPriceDataOrderbook[0]?.order; // may be undefined
+            }),
+            // Fetch dataset order for web3mail whitelist
+            iexec.orderbook
+                .fetchDatasetOrderbook({
+                dataset: vDatasetAddress,
+                app: vDappWhitelistAddress,
+                requester: requesterAddress,
+            })
+                .then((datasetOrderbook) => {
+                const desiredPriceDataOrderbook = datasetOrderbook.orders.filter((order) => order.order.datasetprice <= vDataMaxPrice);
+                return desiredPriceDataOrderbook[0]?.order; // may be undefined
+            }),
+            // Fetch app order
+            iexec.orderbook
+                .fetchAppOrderbook({
+                app: dappAddressOrENS,
+                minTag: ['tee', 'scone'],
+                maxTag: ['tee', 'scone'],
+                workerpool: workerpoolAddressOrEns,
+            })
+                .then((appOrderbook) => {
+                const desiredPriceAppOrderbook = appOrderbook.orders.filter((order) => order.order.appprice <= vAppMaxPrice);
+                const desiredPriceAppOrder = desiredPriceAppOrderbook[0]?.order;
+                if (!desiredPriceAppOrder) {
+                    throw new Error('No App order found for the desired price');
+                }
+                return desiredPriceAppOrder;
+            }),
+            // Fetch workerpool order for App or AppWhitelist
+            Promise.all([
+                // for app
+                iexec.orderbook.fetchWorkerpoolOrderbook({
+                    workerpool: workerpoolAddressOrEns,
+                    app: vDappAddressOrENS,
+                    dataset: vDatasetAddress,
+                    requester: requesterAddress, // public orders + user specific orders
+                    isRequesterStrict: useVoucher, // If voucher, we only want user specific orders
+                    minTag: ['tee', 'scone'],
+                    maxTag: ['tee', 'scone'],
+                    category: 0,
+                }),
+                // for app whitelist
+                iexec.orderbook.fetchWorkerpoolOrderbook({
+                    workerpool: workerpoolAddressOrEns,
+                    app: vDappWhitelistAddress,
+                    dataset: vDatasetAddress,
+                    requester: requesterAddress, // public orders + user specific orders
+                    isRequesterStrict: useVoucher, // If voucher, we only want user specific orders
+                    minTag: ['tee', 'scone'],
+                    maxTag: ['tee', 'scone'],
+                    category: 0,
+                }),
+            ]).then(([workerpoolOrderbookForApp, workerpoolOrderbookForAppWhitelist]) => {
+                const desiredPriceWorkerpoolOrder = filterWorkerpoolOrders({
+                    workerpoolOrders: [
+                        ...workerpoolOrderbookForApp.orders,
+                        ...workerpoolOrderbookForAppWhitelist.orders,
+                    ],
+                    workerpoolMaxPrice: vWorkerpoolMaxPrice,
+                    useVoucher: vUseVoucher,
+                    userVoucher,
+                });
+                if (!desiredPriceWorkerpoolOrder) {
+                    throw new Error('No Workerpool order found for the desired price');
+                }
+                return desiredPriceWorkerpoolOrder;
+            }),
+        ]);
+        if (!workerpoolorder) {
+            throw new Error('No Workerpool order found for the desired price');
+        }
+        const datasetorder = datasetorderForApp || datasetorderForWhitelist;
+        if (!datasetorder) {
+            throw new Error('No Dataset order found for the desired price');
+        }
+        // Push requester secrets
+        const requesterSecretId = generateSecureUniqueId(16);
         const emailContentEncryptionKey = iexec.dataset.generateEncryptionKey();
         const encryptedFile = await iexec.dataset
             .encrypt(Buffer.from(vEmailContent, 'utf8'), emailContentEncryptionKey)
@@ -57,11 +168,10 @@ export const sendEmail = async ({ graphQLClient = throwIfMissing(), iexec = thro
                 errorCause: e,
             });
         });
-        // Push email message to IPFS
         const cid = await ipfs
             .add(encryptedFile, {
-            ipfsNode,
-            ipfsGateway,
+            ipfsNode: ipfsNode,
+            ipfsGateway: ipfsGateway,
         })
             .catch((e) => {
             throw new WorkflowError({
@@ -70,101 +180,47 @@ export const sendEmail = async ({ graphQLClient = throwIfMissing(), iexec = thro
             });
         });
         const multiaddr = `/ipfs/${cid}`;
-        // Prepare secrets for the requester
-        // Use a positive integer as secret ID (required by iexec)
-        // Using "1" as a fixed ID for the requester secret
-        const requesterSecretId = 1;
-        const secrets = {
-            [requesterSecretId]: JSON.stringify({
-                senderName: vSenderName,
-                emailSubject: vEmailSubject,
-                emailContentMultiAddr: multiaddr,
-                contentType: vContentType,
-                emailContentEncryptionKey,
-            }),
-        };
-        // Bulk processing
-        if (grantedAccess) {
-            const vMaxProtectedDataPerTask = positiveNumberSchema()
-                .label('maxProtectedDataPerTask')
-                .validateSync(maxProtectedDataPerTask);
-            const bulkRequest = await dataProtector.prepareBulkRequest({
-                app: vDappAddressOrENS,
-                appMaxPrice: vAppMaxPrice,
-                workerpoolMaxPrice: vWorkerpoolMaxPrice,
-                workerpool: vWorkerpoolAddressOrEns,
-                args: vLabel,
-                inputFiles: [],
-                secrets,
-                bulkAccesses: grantedAccess,
-                maxProtectedDataPerTask: vMaxProtectedDataPerTask,
-            });
-            const processBulkRequestResponse = await dataProtector.processBulkRequest({
-                bulkRequest: bulkRequest.bulkRequest,
-                useVoucher: vUseVoucher,
-                workerpool: vWorkerpoolAddressOrEns,
-            });
-            return {
-                tasks: processBulkRequestResponse.tasks.map((task) => ({
-                    taskId: task.taskId,
-                    dealId: task.dealId,
-                    bulkIndex: task.bulkIndex,
-                })),
-            };
-        }
-        // Single processing mode - protectedData is required
-        const vDatasetAddress = addressOrEnsSchema()
-            .required()
-            .label('protectedData')
-            .validateSync(protectedData);
-        // Check protected data validity through subgraph
-        const isValidProtectedData = await checkProtectedDataValidity(graphQLClient, vDatasetAddress);
-        if (!isValidProtectedData) {
-            throw new Error('This protected data does not contain "email:string" in its schema.');
-        }
-        // Use processProtectedData from dataprotector
-        const result = await dataProtector.processProtectedData({
-            defaultWorkerpool: vWorkerpoolAddressOrEns,
-            protectedData: vDatasetAddress,
+        await iexec.secrets.pushRequesterSecret(requesterSecretId, JSON.stringify({
+            emailSubject: vEmailSubject,
+            emailContentMultiAddr: multiaddr,
+            contentType: vContentType,
+            senderName: vSenderName,
+            emailContentEncryptionKey,
+            useCallback: true,
+        }));
+        const requestorderToSign = await iexec.order.createRequestorder({
             app: vDappAddressOrENS,
-            // userWhitelist: vDappWhitelistAddress, // Removed due to bug in dataprotector v2.0.0-beta.20
-            dataMaxPrice: vDataMaxPrice,
-            appMaxPrice: vAppMaxPrice,
-            workerpoolMaxPrice: vWorkerpoolMaxPrice,
+            category: workerpoolorder.category,
+            dataset: vDatasetAddress,
+            datasetmaxprice: datasetorder.datasetprice,
+            appmaxprice: apporder.appprice,
+            workerpoolmaxprice: workerpoolorder.workerpoolprice,
+            tag: ['tee', 'scone'],
             workerpool: vWorkerpoolAddressOrEns,
-            args: vLabel,
-            inputFiles: [],
-            secrets,
-            useVoucher: vUseVoucher,
-            waitForResult: false,
+            callback: CALLBACK_WEB3MAIL,
+            params: {
+                iexec_secrets: {
+                    1: requesterSecretId,
+                },
+                iexec_args: vLabel,
+            },
         });
+        const requestorder = await iexec.order.signRequestorder(requestorderToSign);
+        // Match orders and compute task ID
+        const { dealid: dealId } = await iexec.order.matchOrders({
+            apporder: apporder,
+            datasetorder: datasetorder,
+            workerpoolorder: workerpoolorder,
+            requestorder: requestorder,
+        }, { useVoucher: vUseVoucher });
+        const taskId = await iexec.deal.computeTaskId(dealId, 0);
         return {
-            taskId: result.taskId,
+            taskId,
+            dealId,
         };
     }
     catch (error) {
-        //  Protocol error detected, re-throwing as-is
-        if (error?.isProtocolError === true) {
-            throw error;
-        }
-        // Handle protocol errors - this will throw if it's an ApiCallError
-        // handleIfProtocolError transforms ApiCallError into a WorkflowError with isProtocolError=true
         handleIfProtocolError(error);
-        // If we reach here, it's not a protocol error
-        // Check if it's a WorkflowError from processProtectedData by checking the message
-        const isProcessProtectedDataError = error instanceof Error &&
-            error.message === 'Failed to process protected data';
-        if (isProcessProtectedDataError) {
-            const cause = error?.cause;
-            // Return unwrapped cause (the actual Error object)
-            // error.cause should be an Error, but ensure it is
-            const unwrappedCause = cause instanceof Error ? cause : error;
-            throw new WorkflowError({
-                message: 'Failed to sendEmail',
-                errorCause: unwrappedCause,
-            });
-        }
-        // For all other errors
         throw new WorkflowError({
             message: 'Failed to sendEmail',
             errorCause: error,

package/dist/web3mail/sendEmail.js.map

@@ -1 +1 @@
-{"version":3,"file":"sendEmail.js","sourceRoot":"","sources":["../../src/web3mail/sendEmail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,4BAA4B,EAC5B,kCAAkC,GACnC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,EACX,oBAAoB,EACpB,gBAAgB,EAChB,cAAc,GACf,MAAM,wBAAwB,CAAC;AAchC,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,EAAE,EAC9B,aAAa,GAAG,cAAc,EAAE,EAChC,KAAK,GAAG,cAAc,EAAE,EACxB,aAAa,GAAG,cAAc,EAAE,EAChC,sBAAsB,GAAG,cAAc,EAAE,EACzC,gBAAgB,EAChB,QAAQ,EACR,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,WAAW,GAAG,oBAAoB,EAClC,KAAK,EACL,YAAY,GAAG,4BAA4B,EAC3C,WAAW,GAAG,2BAA2B,EACzC,kBAAkB,GAAG,kCAAkC,EACvD,UAAU,EACV,aAAa,EACb,aAAa,EACb,uBAAuB,EACvB,UAAU,GAAG,KAAK,GAQG,EAA+C,EAAE;IACtE,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,aAAa,EAAE;aAChC,KAAK,CAAC,YAAY,CAAC;aACnB,YAAY,CAAC,UAAU,CAAC,CAAC;QAC5B,MAAM,uBAAuB,GAAG,kBAAkB,EAAE;aACjD,QAAQ,EAAE;aACV,KAAK,CAAC,wBAAwB,CAAC;aAC/B,YAAY,CAAC,sBAAsB,CAAC,CAAC;QACxC,MAAM,WAAW,GAAG,gBAAgB,EAAE;aACnC,KAAK,CAAC,YAAY,CAAC;aACnB,YAAY,CAAC,UAAU,CAAC,CAAC;QAC5B,MAAM,aAAa,GAAG,kBAAkB,EAAE;aACvC,QAAQ,EAAE;aACV,KAAK,CAAC,cAAc,CAAC;aACrB,YAAY,CAAC,YAAY,CAAC,CAAC;QAC9B,MAAM,aAAa,GAAG,kBAAkB,EAAE;aACvC,QAAQ,EAAE;aACV,KAAK,CAAC,cAAc,CAAC;aACrB,YAAY,CAAC,YAAY,CAAC,CAAC;QAC9B,MAAM,YAAY,GAAG,iBAAiB,EAAE;aACrC,QAAQ,EAAE;aACV,KAAK,CAAC,aAAa,CAAC;aACpB,YAAY,CAAC,WAAW,CAAC,CAAC;QAC7B,MAAM,MAAM,GAAG,WAAW,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAEhE,MAAM,iBAAiB,GAAG,kBAAkB,EAAE;aAC3C,QAAQ,EAAE;aACV,KAAK,CAAC,kBAAkB,CAAC;aACzB,YAAY,CAAC,gBAAgB,CAAC,CAAC;QAClC,6FAA6F;QAC7F,gDAAgD;QAChD,gBAAgB;QAChB,mCAAmC;QACnC,yCAAyC;QACzC,MAAM,aAAa,GAAG,oBAAoB,EAAE;aACzC,KAAK,CAAC,cAAc,CAAC;aACrB,YAAY,CAAC,YAAY,CAAC,CAAC;QAC9B,MAAM,YAAY,GAAG,oBAAoB,EAAE;aACxC,KAAK,CAAC,aAAa,CAAC;aACpB,YAAY,CAAC,WAAW,CAAC,CAAC;QAC7B,MAAM,mBAAmB,GAAG,oBAAoB,EAAE;aAC/C,KAAK,CAAC,oBAAoB,CAAC;aAC3B,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAEpC,wBAAwB;QACxB,MAAM,yBAAyB,GAAG,KAAK,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACxE,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,OAAO;aACtC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,yBAAyB,CAAC;aACtE,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACX,MAAM,IAAI,aAAa,CAAC;gBACtB,OAAO,EAAE,iCAAiC;gBAC1C,UAAU,EAAE,CAAC;aACd,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEL,6BAA6B;QAC7B,MAAM,GAAG,GAAG,MAAM,IAAI;aACnB,GAAG,CAAC,aAAa,EAAE;YAClB,QAAQ;YACR,WAAW;SACZ,CAAC;aACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACX,MAAM,IAAI,aAAa,CAAC;gBACtB,OAAO,EAAE,0CAA0C;gBACnD,UAAU,EAAE,CAAC;aACd,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACL,MAAM,SAAS,GAAG,SAAS,GAAG,EAAE,CAAC;QAEjC,oCAAoC;QACpC,0DAA0D;QAC1D,mDAAmD;QACnD,MAAM,iBAAiB,GAAG,CAAC,CAAC;QAC5B,MAAM,OAAO,GAAG;YACd,CAAC,iBAAiB,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC;gBAClC,UAAU,EAAE,WAAW;gBACvB,YAAY,EAAE,aAAa;gBAC3B,qBAAqB,EAAE,SAAS;gBAChC,WAAW,EAAE,YAAY;gBACzB,yBAAyB;aAC1B,CAAC;SACH,CAAC;QACF,kBAAkB;QAClB,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,wBAAwB,GAAG,oBAAoB,EAAE;iBACpD,KAAK,CAAC,yBAAyB,CAAC;iBAChC,YAAY,CAAC,uBAAuB,CAAC,CAAC;YAEzC,MAAM,WAAW,GAAG,MAAM,aAAa,CAAC,kBAAkB,CAAC;gBACzD,GAAG,EAAE,iBAAiB;gBACtB,WAAW,EAAE,YAAY;gBACzB,kBAAkB,EAAE,mBAAmB;gBACvC,UAAU,EAAE,uBAAuB;gBACnC,IAAI,EAAE,MAAM;gBACZ,UAAU,EAAE,EAAE;gBACd,OAAO;gBACP,YAAY,EAAE,aAAa;gBAC3B,uBAAuB,EAAE,wBAAwB;aAClD,CAAC,CAAC;YACH,MAAM,0BAA0B,GAAG,MAAM,aAAa,CAAC,kBAAkB,CACvE;gBACE,WAAW,EAAE,WAAW,CAAC,WAAW;gBACpC,UAAU,EAAE,WAAW;gBACvB,UAAU,EAAE,uBAAuB;aACpC,CACF,CAAC;YACF,OAAO;gBACL,KAAK,EAAE,0BAA0B,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;oBACrD,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,SAAS,EAAE,IAAI,CAAC,SAAS;iBAC1B,CAAC,CAAC;aAC6C,CAAC;QACrD,CAAC;QAED,qDAAqD;QACrD,MAAM,eAAe,GAAG,kBAAkB,EAAE;aACzC,QAAQ,EAAE;aACV,KAAK,CAAC,eAAe,CAAC;aACtB,YAAY,CAAC,aAAa,CAAC,CAAC;QAC/B,iDAAiD;QACjD,MAAM,oBAAoB,GAAG,MAAM,0BAA0B,CAC3D,aAAa,EACb,eAAe,CAChB,CAAC;QACF,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;QACJ,CAAC;QAED,8CAA8C;QAC9C,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,oBAAoB,CAAC;YACtD,iBAAiB,EAAE,uBAAuB;YAC1C,aAAa,EAAE,eAAe;YAC9B,GAAG,EAAE,iBAAiB;YACtB,8FAA8F;YAC9F,YAAY,EAAE,aAAa;YAC3B,WAAW,EAAE,YAAY;YACzB,kBAAkB,EAAE,mBAAmB;YACvC,UAAU,EAAE,uBAAuB;YACnC,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE,EAAE;YACd,OAAO;YACP,UAAU,EAAE,WAAW;YACvB,aAAa,EAAE,KAAK;SACrB,CAAC,CAAC;QAEH,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,MAAM;SAC2B,CAAC;IACrD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,8CAA8C;QAC9C,IAAK,KAAa,EAAE,eAAe,KAAK,IAAI,EAAE,CAAC;YAC7C,MAAM,KAAK,CAAC;QACd,CAAC;QAED,mEAAmE;QACnE,+FAA+F;QAC/F,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAE7B,8CAA8C;QAC9C,kFAAkF;QAClF,MAAM,2BAA2B,GAC/B,KAAK,YAAY,KAAK;YACtB,KAAK,CAAC,OAAO,KAAK,kCAAkC,CAAC;QAEvD,IAAI,2BAA2B,EAAE,CAAC;YAChC,MAAM,KAAK,GAAI,KAAa,EAAE,KAAK,CAAC;YACpC,mDAAmD;YACnD,mDAAmD;YACnD,MAAM,cAAc,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;YAC9D,MAAM,IAAI,aAAa,CAAC;gBACtB,OAAO,EAAE,qBAAqB;gBAC9B,UAAU,EAAE,cAAc;aAC3B,CAAC,CAAC;QACL,CAAC;QAED,uBAAuB;QACvB,MAAM,IAAI,aAAa,CAAC;YACtB,OAAO,EAAE,qBAAqB;YAC9B,UAAU,EAAE,KAAK;SAClB,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC"}
+{"version":3,"file":"sendEmail.js","sourceRoot":"","sources":["../../src/web3mail/sendEmail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,oBAAoB,EACpB,2BAA2B,EAC3B,4BAA4B,EAC5B,kCAAkC,GACnC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,EACX,oBAAoB,EACpB,gBAAgB,EAChB,cAAc,GACf,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,gBAAgB,EAChB,sBAAsB,GACvB,MAAM,uBAAuB,CAAC;AAa/B,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,EAAE,EAC9B,aAAa,GAAG,cAAc,EAAE,EAChC,KAAK,GAAG,cAAc,EAAE,EACxB,sBAAsB,EACtB,gBAAgB,EAChB,oBAAoB,EACpB,QAAQ,EACR,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,WAAW,GAAG,oBAAoB,EAClC,KAAK,EACL,YAAY,GAAG,4BAA4B,EAC3C,WAAW,GAAG,2BAA2B,EACzC,kBAAkB,GAAG,kCAAkC,EACvD,UAAU,EACV,aAAa,EACb,UAAU,GAAG,KAAK,GAOH,EAA8B,EAAE;IAC/C,MAAM,eAAe,GAAG,kBAAkB,EAAE;SACzC,QAAQ,EAAE;SACV,KAAK,CAAC,eAAe,CAAC;SACtB,YAAY,CAAC,aAAa,CAAC,CAAC;IAE/B,MAAM,aAAa,GAAG,kBAAkB,EAAE;SACvC,QAAQ,EAAE;SACV,KAAK,CAAC,cAAc,CAAC;SACrB,YAAY,CAAC,YAAY,CAAC,CAAC;IAE9B,MAAM,aAAa,GAAG,kBAAkB,EAAE;SACvC,QAAQ,EAAE;SACV,KAAK,CAAC,cAAc,CAAC;SACrB,YAAY,CAAC,YAAY,CAAC,CAAC;IAE9B,MAAM,YAAY,GAAG,iBAAiB,EAAE;SACrC,QAAQ,EAAE;SACV,KAAK,CAAC,aAAa,CAAC;SACpB,YAAY,CAAC,WAAW,CAAC,CAAC;IAE7B,MAAM,WAAW,GAAG,gBAAgB,EAAE;SACnC,KAAK,CAAC,YAAY,CAAC;SACnB,YAAY,CAAC,UAAU,CAAC,CAAC;IAE5B,MAAM,MAAM,GAAG,WAAW,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAEhE,MAAM,uBAAuB,GAAG,kBAAkB,EAAE;SACjD,QAAQ,EAAE;SACV,KAAK,CAAC,wBAAwB,CAAC;SAC/B,YAAY,CAAC,sBAAsB,CAAC,CAAC;IAExC,MAAM,iBAAiB,GAAG,kBAAkB,EAAE;SAC3C,QAAQ,EAAE;SACV,KAAK,CAAC,kBAAkB,CAAC;SACzB,YAAY,CAAC,gBAAgB,CAAC,CAAC;IAElC,MAAM,qBAAqB,GAAG,aAAa,EAAE;SAC1C,QAAQ,EAAE;SACV,KAAK,CAAC,sBAAsB,CAAC;SAC7B,YAAY,CAAC,oBAAoB,CAAC,CAAC;IAEtC,MAAM,aAAa,GAAG,oBAAoB,EAAE;SACzC,KAAK,CAAC,cAAc,CAAC;SACrB,YAAY,CAAC,YAAY,CAAC,CAAC;IAE9B,MAAM,YAAY,GAAG,oBAAoB,EAAE;SACxC,KAAK,CAAC,aAAa,CAAC;SACpB,YAAY,CAAC,WAAW,CAAC,CAAC;IAE7B,MAAM,mBAAmB,GAAG,oBAAoB,EAAE;SAC/C,KAAK,CAAC,oBAAoB,CAAC;SAC3B,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAEpC,MAAM,WAAW,GAAG,aAAa,EAAE;SAChC,KAAK,CAAC,YAAY,CAAC;SACnB,YAAY,CAAC,UAAU,CAAC,CAAC;IAE5B,+CAA+C;IAC/C,MAAM,oBAAoB,GAAG,MAAM,0BAA0B,CAC3D,aAAa,EACb,eAAe,CAChB,CAAC;IAEF,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;IACJ,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAEzD,IAAI,WAAW,CAAC;IAChB,IAAI,WAAW,EAAE,CAAC;QAChB,IAAI,CAAC;YACH,WAAW,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;YACpE,gBAAgB,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,8BAA8B,CAAC,EAAE,CAAC;gBAC7D,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAC;YACJ,CAAC;YACD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED,IAAI,CAAC;QACH,MAAM,CACJ,kBAAkB,EAClB,wBAAwB,EACxB,QAAQ,EACR,eAAe,EAChB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpB,uCAAuC;YACvC,KAAK,CAAC,SAAS;iBACZ,qBAAqB,CAAC;gBACrB,OAAO,EAAE,eAAe;gBACxB,GAAG,EAAE,gBAAgB;gBACrB,SAAS,EAAE,gBAAgB;aAC5B,CAAC;iBACD,IAAI,CAAC,CAAC,gBAAgB,EAAE,EAAE;gBACzB,MAAM,yBAAyB,GAAG,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAC9D,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,IAAI,aAAa,CACrD,CAAC;gBACF,OAAO,yBAAyB,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,mBAAmB;YACjE,CAAC,CAAC;YAEJ,6CAA6C;YAC7C,KAAK,CAAC,SAAS;iBACZ,qBAAqB,CAAC;gBACrB,OAAO,EAAE,eAAe;gBACxB,GAAG,EAAE,qBAAqB;gBAC1B,SAAS,EAAE,gBAAgB;aAC5B,CAAC;iBACD,IAAI,CAAC,CAAC,gBAAgB,EAAE,EAAE;gBACzB,MAAM,yBAAyB,GAAG,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAC9D,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,IAAI,aAAa,CACrD,CAAC;gBACF,OAAO,yBAAyB,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,mBAAmB;YACjE,CAAC,CAAC;YAEJ,kBAAkB;YAClB,KAAK,CAAC,SAAS;iBACZ,iBAAiB,CAAC;gBACjB,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;gBACxB,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;gBACxB,UAAU,EAAE,sBAAsB;aACnC,CAAC;iBACD,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE;gBACrB,MAAM,wBAAwB,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CACzD,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,IAAI,YAAY,CAChD,CAAC;gBACF,MAAM,oBAAoB,GAAG,wBAAwB,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;gBAChE,IAAI,CAAC,oBAAoB,EAAE,CAAC;oBAC1B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;gBAC9D,CAAC;gBACD,OAAO,oBAAoB,CAAC;YAC9B,CAAC,CAAC;YAEJ,iDAAiD;YACjD,OAAO,CAAC,GAAG,CAAC;gBACV,UAAU;gBACV,KAAK,CAAC,SAAS,CAAC,wBAAwB,CAAC;oBACvC,UAAU,EAAE,sBAAsB;oBAClC,GAAG,EAAE,iBAAiB;oBACtB,OAAO,EAAE,eAAe;oBACxB,SAAS,EAAE,gBAAgB,EAAE,uCAAuC;oBACpE,iBAAiB,EAAE,UAAU,EAAE,gDAAgD;oBAC/E,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;oBACxB,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;oBACxB,QAAQ,EAAE,CAAC;iBACZ,CAAC;gBACF,oBAAoB;gBACpB,KAAK,CAAC,SAAS,CAAC,wBAAwB,CAAC;oBACvC,UAAU,EAAE,sBAAsB;oBAClC,GAAG,EAAE,qBAAqB;oBAC1B,OAAO,EAAE,eAAe;oBACxB,SAAS,EAAE,gBAAgB,EAAE,uCAAuC;oBACpE,iBAAiB,EAAE,UAAU,EAAE,gDAAgD;oBAC/E,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;oBACxB,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;oBACxB,QAAQ,EAAE,CAAC;iBACZ,CAAC;aACH,CAAC,CAAC,IAAI,CACL,CAAC,CAAC,yBAAyB,EAAE,kCAAkC,CAAC,EAAE,EAAE;gBAClE,MAAM,2BAA2B,GAAG,sBAAsB,CAAC;oBACzD,gBAAgB,EAAE;wBAChB,GAAG,yBAAyB,CAAC,MAAM;wBACnC,GAAG,kCAAkC,CAAC,MAAM;qBAC7C;oBACD,kBAAkB,EAAE,mBAAmB;oBACvC,UAAU,EAAE,WAAW;oBACvB,WAAW;iBACZ,CAAC,CAAC;gBAEH,IAAI,CAAC,2BAA2B,EAAE,CAAC;oBACjC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;gBACrE,CAAC;gBAED,OAAO,2BAA2B,CAAC;YACrC,CAAC,CACF;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,YAAY,GAAG,kBAAkB,IAAI,wBAAwB,CAAC;QACpE,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QAED,yBAAyB;QACzB,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,EAAE,CAAC,CAAC;QACrD,MAAM,yBAAyB,GAAG,KAAK,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACxE,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,OAAO;aACtC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,yBAAyB,CAAC;aACtE,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACX,MAAM,IAAI,aAAa,CAAC;gBACtB,OAAO,EAAE,iCAAiC;gBAC1C,UAAU,EAAE,CAAC;aACd,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEL,MAAM,GAAG,GAAG,MAAM,IAAI;aACnB,GAAG,CAAC,aAAa,EAAE;YAClB,QAAQ,EAAE,QAAQ;YAClB,WAAW,EAAE,WAAW;SACzB,CAAC;aACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACX,MAAM,IAAI,aAAa,CAAC;gBACtB,OAAO,EAAE,0CAA0C;gBACnD,UAAU,EAAE,CAAC;aACd,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEL,MAAM,SAAS,GAAG,SAAS,GAAG,EAAE,CAAC;QAEjC,MAAM,KAAK,CAAC,OAAO,CAAC,mBAAmB,CACrC,iBAAiB,EACjB,IAAI,CAAC,SAAS,CAAC;YACb,YAAY,EAAE,aAAa;YAC3B,qBAAqB,EAAE,SAAS;YAChC,WAAW,EAAE,YAAY;YACzB,UAAU,EAAE,WAAW;YACvB,yBAAyB;YACzB,WAAW,EAAE,IAAI;SAClB,CAAC,CACH,CAAC;QAEF,MAAM,kBAAkB,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC;YAC9D,GAAG,EAAE,iBAAiB;YACtB,QAAQ,EAAE,eAAe,CAAC,QAAQ;YAClC,OAAO,EAAE,eAAe;YACxB,eAAe,EAAE,YAAY,CAAC,YAAY;YAC1C,WAAW,EAAE,QAAQ,CAAC,QAAQ;YAC9B,kBAAkB,EAAE,eAAe,CAAC,eAAe;YACnD,GAAG,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;YACrB,UAAU,EAAE,uBAAuB;YACnC,QAAQ,EAAE,iBAAiB;YAC3B,MAAM,EAAE;gBACN,aAAa,EAAE;oBACb,CAAC,EAAE,iBAAiB;iBACrB;gBACD,UAAU,EAAE,MAAM;aACnB;SACF,CAAC,CAAC;QAEH,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;QAE5E,mCAAmC;QACnC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,WAAW,CACtD;YACE,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,YAAY;YAC1B,eAAe,EAAE,eAAe;YAChC,YAAY,EAAE,YAAY;SAC3B,EACD,EAAE,UAAU,EAAE,WAAW,EAAE,CAC5B,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAEzD,OAAO;YACL,MAAM;YACN,MAAM;SACP,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAE7B,MAAM,IAAI,aAAa,CAAC;YACtB,OAAO,EAAE,qBAAqB;YAC9B,UAAU,EAAE,KAAK;SAClB,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC"}

package/dist/web3mail/sendEmailCampaign.d.ts

@@ -0,0 +1,4 @@
+import { SendEmailCampaignParams, SendEmailCampaignResponse } from './types.js';
+import { DataProtectorConsumer } from './internalTypes.js';
+export type SendEmailCampaign = typeof sendEmailCampaign;
+export declare const sendEmailCampaign: ({ dataProtector, workerpoolAddressOrEns, campaignRequest, }: DataProtectorConsumer & SendEmailCampaignParams) => Promise<SendEmailCampaignResponse>;

package/dist/web3mail/sendEmailCampaign.js

@@ -0,0 +1,43 @@
+import { NULL_ADDRESS } from 'iexec/utils';
+import { ValidationError } from 'yup';
+import { handleIfProtocolError, WorkflowError } from '../utils/errors.js';
+import { addressOrEnsSchema, campaignRequestSchema, throwIfMissing, } from '../utils/validators.js';
+export const sendEmailCampaign = async ({ dataProtector = throwIfMissing(), workerpoolAddressOrEns = throwIfMissing(), campaignRequest, }) => {
+    const vCampaignRequest = campaignRequestSchema()
+        .required()
+        .label('campaignRequest')
+        .validateSync(campaignRequest);
+    const vWorkerpoolAddressOrEns = addressOrEnsSchema()
+        .required()
+        .label('workerpoolAddressOrEns')
+        .validateSync(workerpoolAddressOrEns);
+    if (vCampaignRequest.workerpool !== NULL_ADDRESS &&
+        vCampaignRequest.workerpool.toLowerCase() !==
+            vWorkerpoolAddressOrEns.toLowerCase()) {
+        throw new ValidationError("workerpoolAddressOrEns doesn't match campaignRequest workerpool");
+    }
+    try {
+        // Process the prepared bulk request
+        const processBulkRequestResponse = await dataProtector.processBulkRequest({
+            bulkRequest: vCampaignRequest,
+            workerpool: vWorkerpoolAddressOrEns,
+            waitForResult: false,
+        });
+        return processBulkRequestResponse;
+    }
+    catch (error) {
+        // Protocol error detected, re-throwing as-is
+        if (error?.isProtocolError === true) {
+            throw error;
+        }
+        // Handle protocol errors - this will throw if it's an ApiCallError
+        // handleIfProtocolError transforms ApiCallError into a WorkflowError with isProtocolError=true
+        handleIfProtocolError(error);
+        // For all other errors
+        throw new WorkflowError({
+            message: 'Failed to sendEmailCampaign',
+            errorCause: error,
+        });
+    }
+};
+//# sourceMappingURL=sendEmailCampaign.js.map

package/dist/web3mail/sendEmailCampaign.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendEmailCampaign.js","sourceRoot":"","sources":["../../src/web3mail/sendEmailCampaign.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,KAAK,CAAC;AACtC,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,cAAc,GACf,MAAM,wBAAwB,CAAC;AAUhC,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EAAE,EACtC,aAAa,GAAG,cAAc,EAAE,EAChC,sBAAsB,GAAG,cAAc,EAAE,EACzC,eAAe,GAEQ,EAAsC,EAAE;IAC/D,MAAM,gBAAgB,GAAG,qBAAqB,EAAE;SAC7C,QAAQ,EAAE;SACV,KAAK,CAAC,iBAAiB,CAAC;SACxB,YAAY,CAAC,eAAe,CAAoB,CAAC;IAEpD,MAAM,uBAAuB,GAAG,kBAAkB,EAAE;SACjD,QAAQ,EAAE;SACV,KAAK,CAAC,wBAAwB,CAAC;SAC/B,YAAY,CAAC,sBAAsB,CAAC,CAAC;IAExC,IACE,gBAAgB,CAAC,UAAU,KAAK,YAAY;QAC5C,gBAAgB,CAAC,UAAU,CAAC,WAAW,EAAE;YACvC,uBAAuB,CAAC,WAAW,EAAE,EACvC,CAAC;QACD,MAAM,IAAI,eAAe,CACvB,iEAAiE,CAClE,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,oCAAoC;QACpC,MAAM,0BAA0B,GAAG,MAAM,aAAa,CAAC,kBAAkB,CAAC;YACxE,WAAW,EAAE,gBAAgB;YAC7B,UAAU,EAAE,uBAAuB;YACnC,aAAa,EAAE,KAAK;SACrB,CAAC,CAAC;QAEH,OAAO,0BAA0B,CAAC;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,6CAA6C;QAC7C,IAAK,KAAa,EAAE,eAAe,KAAK,IAAI,EAAE,CAAC;YAC7C,MAAM,KAAK,CAAC;QACd,CAAC;QAED,mEAAmE;QACnE,+FAA+F;QAC/F,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAE7B,uBAAuB;QACvB,MAAM,IAAI,aAAa,CAAC;YACtB,OAAO,EAAE,6BAA6B;YACtC,UAAU,EAAE,KAAK;SAClB,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC"}

package/dist/web3mail/types.d.ts

@@ -1,10 +1,26 @@
 import { EnhancedWallet } from 'iexec';
 import { IExecConfigOptions } from 'iexec/IExecConfig';
+import type { BulkRequest } from '@iexec/dataprotector';
 export type Web3SignerProvider = EnhancedWallet;
 export type ENS = string;
 export type AddressOrENS = Address | ENS;
 export type Address = string;
 export type TimeStamp = string;
+/**
+ * request to send email in bulk
+ *
+ * use `prepareEmailCampaign()` to create a `CampaignRequest`
+ *
+ * then use `sendEmailCampaign()` to send the campaign
+ */
+export type CampaignRequest = BulkRequest;
+/**
+ * authorization signed by the data owner granting access to this contact
+ *
+ * `GrantedAccess` are obtained by fetching contacts (e.g. `fetchMyContacts()` or `fetchUserContacts()`)
+ *
+ * `GrantedAccess` can be consumed for email campaigns (e.g. `prepareEmailCampaign()` then `sendEmailCampaign()`)
+ */
 export type GrantedAccess = {
     dataset: string;
     datasetprice: string;
@@ -30,14 +46,7 @@ export type Contact = {
 export type SendEmailParams = {
     emailSubject: string;
     emailContent: string;
-    protectedData?: Address;
-    /**
-     * Granted access to process.
-     * use prepareBulkRequest of dataprotector to create a bulk request.
-     * if not provided, the single message will be processed.
-     */
-    grantedAccess?: GrantedAccess[];
-    maxProtectedDataPerTask?: number;
+    protectedData: Address;
     contentType?: string;
     senderName?: string;
     label?: string;
@@ -52,6 +61,9 @@ export type FetchMyContactsParams = {
      * Get contacts for this specific user only
      */
     isUserStrict?: boolean;
+    /**
+     * If true, returns only contacts with bulk processing access grants
+     */
     bulkOnly?: boolean;
 };
 export type FetchUserContactsParams = {
@@ -60,23 +72,16 @@ export type FetchUserContactsParams = {
      */
     userAddress: Address;
 } & FetchMyContactsParams;
-type SendEmailSingleResponse = {
+export type SendEmailResponse = {
+    /**
+     * ID of the task
+     */
     taskId: string;
+    /**
+     * ID of the deal containing the task
+     */
+    dealId: string;
 };
-type SendEmailBulkResponse = {
-    tasks: {
-        bulkIndex: number;
-        taskId: string;
-        dealId: string;
-    }[];
-};
-export type SendEmailResponse<Params = {
-    protectedData: Address;
-}> = Params extends {
-    grantedAccess: GrantedAccess[];
-} ? SendEmailBulkResponse : never & Params extends {
-    protectedData: Address;
-} ? SendEmailSingleResponse : never;
 /**
  * Configuration options for Web3Mail.
  */
@@ -118,4 +123,58 @@ export type Web3MailConfigOptions = {
      */
     allowExperimentalNetworks?: boolean;
 };
-export {};
+export type PrepareEmailCampaignParams = {
+    /**
+     * List of `GrantedAccess` to contacts to send emails to in bulk.
+     *
+     * use `fetchMyContacts({ bulkOnly: true })` to get granted accesses.
+     */
+    grantedAccesses: GrantedAccess[];
+    maxProtectedDataPerTask?: number;
+    senderName?: string;
+    emailSubject: string;
+    emailContent: string;
+    contentType?: string;
+    label?: string;
+    workerpoolAddressOrEns?: AddressOrENS;
+    dataMaxPrice?: number;
+    appMaxPrice?: number;
+    workerpoolMaxPrice?: number;
+};
+export type PrepareEmailCampaignResponse = {
+    /**
+     * The prepared campaign request
+     *
+     * Use this in `sendEmailCampaign()` to start or continue sending the campaign
+     */
+    campaignRequest: CampaignRequest;
+};
+export type SendEmailCampaignParams = {
+    /**
+     * The prepared campaign request from `prepareEmailCampaign()`
+     */
+    campaignRequest: CampaignRequest;
+    /**
+     * Workerpool address or ENS to use for processing
+     */
+    workerpoolAddressOrEns?: AddressOrENS;
+};
+export type SendEmailCampaignResponse = {
+    /**
+     * List of tasks created for the campaign
+     */
+    tasks: Array<{
+        /**
+         * ID of the task
+         */
+        taskId: string;
+        /**
+         * ID of the deal containing the task
+         */
+        dealId: string;
+        /**
+         * Index of the task in the bulk request
+         */
+        bulkIndex: number;
+    }>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iexec/web3mail",
-  "version": "1.6.0-nightly-b2a0e93",
+  "version": "1.7.0",
   "description": "This product enables users to confidentially store data–such as mail address, documents, personal information ...",
   "main": "./dist/index.js",
   "type": "module",
@@ -20,8 +20,7 @@
   "scripts": {
     "build": "rm -rf dist && tsc --project tsconfig.build.json",
     "check-types": "tsc --noEmit",
-    "test:prepare": "node tests/scripts/prepare-bellecour-fork-for-tests.js",
-    "test": "NODE_OPTIONS=--experimental-vm-modules jest --testMatch \"**/tests/**/*.test.ts\" --forceExit -b",
+    "test:prepare": "node tests/scripts/prepare-bellecour-fork-for-tests.js && node tests/scripts/prepare-iexec.js",
     "test:coverage": "NODE_OPTIONS=--experimental-vm-modules jest --testMatch \"**/tests/**/*.test.ts\" --forceExit --coverage",
     "test:unit": "NODE_OPTIONS=--experimental-vm-modules jest --testMatch \"**/tests/unit/**/*.test.ts\" -b",
     "test:unit:coverage": "NODE_OPTIONS=--experimental-vm-modules jest --testMatch \"**/tests/unit/**/*.unit.ts\" --coverage",
@@ -31,7 +30,7 @@
     "format": "prettier --write \"(src|tests)/**/*.ts\"",
     "check-format": "prettier --check \"(src|tests)/**/*.ts\"",
     "stop-test-stack": "cd tests && docker compose down --volumes --remove-orphans",
-    "start-test-stack": "cd tests && npm run stop-test-stack && node scripts/prepare-test-env.js && docker compose build  &&  docker compose up -d && node scripts/prepare-bellecour-fork-for-tests.js"
+    "start-test-stack": "cd tests && npm run stop-test-stack && node scripts/prepare-test-env.js && docker compose build  &&  docker compose up -d && npm run test:prepare"
   },
   "repository": {
     "type": "git",

package/src/utils/subgraphQuery.ts

@@ -86,9 +86,8 @@ export const getValidContact = async (
             grantedAccess: contact.grantedAccess,
           };
         }
-        return null;
       })
-      .filter((contact) => contact !== null && contact !== undefined);
+      .filter((contact) => !!contact);
   } catch (error) {
     throw new WorkflowError({
       message: 'Failed to fetch subgraph',