@iexec/web3mail 1.8.0 → 2.0.0

package/src/web3mail/sendEmailCampaign.ts

@@ -2,7 +2,7 @@ import { NULL_ADDRESS } from 'iexec/utils';
 import { ValidationError } from 'yup';
 import { handleIfProtocolError, WorkflowError } from '../utils/errors.js';
 import {
-  addressOrEnsSchema,
+  addressSchema,
   campaignRequestSchema,
   throwIfMissing,
 } from '../utils/validators.js';
@@ -17,7 +17,7 @@ export type SendEmailCampaign = typeof sendEmailCampaign;
 
 export const sendEmailCampaign = async ({
   dataProtector = throwIfMissing(),
-  workerpoolAddressOrEns = throwIfMissing(),
+  workerpoolAddress = throwIfMissing(),
   campaignRequest,
 }: DataProtectorConsumer &
   SendEmailCampaignParams): Promise<SendEmailCampaignResponse> => {
@@ -26,18 +26,18 @@ export const sendEmailCampaign = async ({
     .label('campaignRequest')
     .validateSync(campaignRequest) as CampaignRequest;
 
-  const vWorkerpoolAddressOrEns = addressOrEnsSchema()
+  const vWorkerpoolAddress = addressSchema()
     .required()
-    .label('workerpoolAddressOrEns')
-    .validateSync(workerpoolAddressOrEns);
+    .label('workerpoolAddress')
+    .validateSync(workerpoolAddress);
 
   if (
     vCampaignRequest.workerpool !== NULL_ADDRESS &&
     vCampaignRequest.workerpool.toLowerCase() !==
-      vWorkerpoolAddressOrEns.toLowerCase()
+      vWorkerpoolAddress.toLowerCase()
   ) {
     throw new ValidationError(
-      "workerpoolAddressOrEns doesn't match campaignRequest workerpool"
+      "workerpoolAddress doesn't match campaignRequest workerpool"
     );
   }
 
@@ -45,7 +45,7 @@ export const sendEmailCampaign = async ({
     // Process the prepared bulk request
     const processBulkRequestResponse = await dataProtector.processBulkRequest({
       bulkRequest: vCampaignRequest,
-      workerpool: vWorkerpoolAddressOrEns,
+      workerpool: vWorkerpoolAddress,
       waitForResult: false,
     });
 
@@ -57,13 +57,12 @@ export const sendEmailCampaign = async ({
     }
 
     // Handle protocol errors - this will throw if it's an ApiCallError
-    // handleIfProtocolError transforms ApiCallError into a WorkflowError with isProtocolError=true
-    handleIfProtocolError(error);
+    handleIfProtocolError(error as Error);
 
     // For all other errors
     throw new WorkflowError({
       message: 'Failed to sendEmailCampaign',
-      errorCause: error,
+      errorCause: error as Error,
     });
   }
 };

package/src/web3mail/types.ts

@@ -1,12 +1,8 @@
-import { EnhancedWallet } from 'iexec';
+import type { AbstractSigner } from 'ethers';
 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 Web3SignerProvider = AbstractSigner;
 
 export type Address = string;
 
@@ -59,11 +55,10 @@ export type SendEmailParams = {
   contentType?: string;
   senderName?: string;
   label?: string;
-  workerpoolAddressOrEns?: AddressOrENS;
+  workerpoolAddress?: Address;
   dataMaxPrice?: number;
   appMaxPrice?: number;
   workerpoolMaxPrice?: number;
-  useVoucher?: boolean;
 };
 
 export type FetchMyContactsParams = {
@@ -100,10 +95,10 @@ export type SendEmailResponse = {
  */
 export type Web3MailConfigOptions = {
   /**
-   * The Ethereum contract address or ENS (Ethereum Name Service) for the email sender dapp.
+   * Ethereum contract address for the email sender dapp.
    * If not provided, the default web3mail address will be used.
    */
-  dappAddressOrENS?: AddressOrENS;
+  dappAddress?: Address;
 
   /**
    * The Ethereum contract address for the whitelist.
@@ -156,7 +151,7 @@ export type PrepareEmailCampaignParams = {
   emailContent: string;
   contentType?: string;
   label?: string;
-  workerpoolAddressOrEns?: AddressOrENS;
+  workerpoolAddress?: Address;
   dataMaxPrice?: number;
   appMaxPrice?: number;
   workerpoolMaxPrice?: number;
@@ -177,9 +172,9 @@ export type SendEmailCampaignParams = {
    */
   campaignRequest: CampaignRequest;
   /**
-   * Workerpool address or ENS to use for processing
+   * Workerpool contract address used for processing
    */
-  workerpoolAddressOrEns?: AddressOrENS;
+  workerpoolAddress?: string;
 };
 
 export type SendEmailCampaignResponse = {