feat(sendEmailCampaign): add allowDeposit parameter to enable automatic deposit

Author: abbesBenayache

src/web3mail/sendEmail.ts

@@ -331,6 +331,9 @@ export const sendEmail = async ({
         workerpoolorder: workerpoolorder,
         requestorder: requestorder,
       },
+      // TODO: Remove @ts-ignore once iexec SDK is updated to a version that includes allowDeposit in matchOrders types
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore - allowDeposit is supported at runtime but not yet in TypeScript types
       { useVoucher: vUseVoucher, allowDeposit: vAllowDeposit }
     );
 

src/web3mail/sendEmailCampaign.ts

@@ -5,6 +5,7 @@ import {
   addressOrEnsSchema,
   campaignRequestSchema,
   throwIfMissing,
+  booleanSchema,
 } from '../utils/validators.js';
 import {
   CampaignRequest,
@@ -19,6 +20,7 @@ export const sendEmailCampaign = async ({
   dataProtector = throwIfMissing(),
   workerpoolAddressOrEns = throwIfMissing(),
   campaignRequest,
+  allowDeposit = false,
 }: DataProtectorConsumer &
   SendEmailCampaignParams): Promise<SendEmailCampaignResponse> => {
   const vCampaignRequest = campaignRequestSchema()
@@ -31,6 +33,10 @@ export const sendEmailCampaign = async ({
     .label('workerpoolAddressOrEns')
     .validateSync(workerpoolAddressOrEns);
 
+  const vAllowDeposit = booleanSchema()
+    .label('allowDeposit')
+    .validateSync(allowDeposit);
+
   if (
     vCampaignRequest.workerpool !== NULL_ADDRESS &&
     vCampaignRequest.workerpool.toLowerCase() !==
@@ -43,10 +49,14 @@ export const sendEmailCampaign = async ({
 
   try {
     // Process the prepared bulk request
+    // TODO: Remove @ts-ignore once @iexec/dataprotector is updated to a version that includes allowDeposit in ProcessBulkRequestParams types
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - allowDeposit is supported at runtime but not yet in TypeScript types
     const processBulkRequestResponse = await dataProtector.processBulkRequest({
       bulkRequest: vCampaignRequest,
       workerpool: vWorkerpoolAddressOrEns,
       waitForResult: false,
+      allowDeposit: vAllowDeposit,
     });
 
     return processBulkRequestResponse;

src/web3mail/types.ts

@@ -181,6 +181,11 @@ export type SendEmailCampaignParams = {
    * Workerpool address or ENS to use for processing
    */
   workerpoolAddressOrEns?: AddressOrENS;
+  /**
+   * If true, allows automatic deposit of funds when balance is insufficient
+   * @default false
+   */
+  allowDeposit?: boolean;
 };
 
 export type SendEmailCampaignResponse = {