feat: add waitForResult option to processProtectedData

Author: PierreJeanjacquot

packages/sdk/src/lib/dataProtectorCore/IExecDataProtectorCore.ts

@@ -68,9 +68,9 @@ class IExecDataProtectorCore extends IExecDataProtectorModule {
     return transferOwnership({ ...args, iexec: this.iexec });
   }
 
-  async processProtectedData(
-    args: ProcessProtectedDataParams
-  ): Promise<ProcessProtectedDataResponse> {
+  async processProtectedData<Params extends ProcessProtectedDataParams>(
+    args: Params
+  ): Promise<ProcessProtectedDataResponse<Params>> {
     await this.init();
     await isValidProvider(this.iexec);
     return processProtectedData({

packages/sdk/src/lib/dataProtectorCore/processProtectedData.ts

@@ -43,7 +43,9 @@ import { isAddressInWhitelist } from './smartContract/whitelistContract.read.js'
 
 export type ProcessProtectedData = typeof processProtectedData;
 
-export const processProtectedData = async ({
+export const processProtectedData = async <
+  Params extends ProcessProtectedDataParams
+>({
   iexec = throwIfMissing(),
   defaultWorkerpool,
   protectedData,
@@ -61,10 +63,11 @@ export const processProtectedData = async ({
   voucherOwner,
   encryptResult = false,
   pemPrivateKey,
+  waitForResult = true,
   onStatusUpdate = () => {},
-}: IExecConsumer &
-  DefaultWorkerpoolConsumer &
-  ProcessProtectedDataParams): Promise<ProcessProtectedDataResponse> => {
+}: IExecConsumer & DefaultWorkerpoolConsumer & Params): Promise<
+  ProcessProtectedDataResponse<Params>
+> => {
   const vProtectedData = addressOrEnsSchema()
     .required()
     .label('protectedData')
@@ -107,6 +110,9 @@ export const processProtectedData = async ({
   const vPemPrivateKey = stringSchema()
     .label('pemPrivateKey')
     .validateSync(pemPrivateKey);
+  const vWaitForResult = booleanSchema()
+    .label('waitForResult')
+    .validateSync(waitForResult);
 
   // Validate that if pemPrivateKey is provided, encryptResult must be true
   if (vPemPrivateKey && !vEncryptResult) {
@@ -282,37 +288,39 @@ export const processProtectedData = async ({
       isDone: true,
     });
 
-    vOnStatusUpdate({
-      title: 'GENERATE_ENCRYPTION_KEY',
-      isDone: false,
-    });
-
     // Handle result encryption
     let privateKey: string | undefined;
     if (vEncryptResult) {
+      if (!vPemPrivateKey) {
+        vOnStatusUpdate({
+          title: 'GENERATE_ENCRYPTION_KEY',
+          isDone: false,
+        });
+      }
       const { publicKey, privateKey: generatedPrivateKey } =
         await getFormattedKeyPair({
           pemPrivateKey: vPemPrivateKey,
         });
       privateKey = generatedPrivateKey;
-
       // Notify user if a new key was generated
       if (!vPemPrivateKey) {
         vOnStatusUpdate({
           title: 'GENERATE_ENCRYPTION_KEY',
           isDone: true,
           payload: {
-            message: 'New encryption key pair generated',
             pemPrivateKey: generatedPrivateKey,
           },
         });
-      } else {
-        vOnStatusUpdate({
-          title: 'PUSH_ENCRYPTION_KEY',
-          isDone: false,
-        });
       }
 
+      vOnStatusUpdate({
+        title: 'PUSH_ENCRYPTION_KEY',
+        isDone: false,
+        payload: {
+          publicKey,
+        },
+      });
+
       await iexec.result.pushResultEncryptionKey(publicKey, {
         forceUpdate: true,
       });
@@ -375,6 +383,15 @@ export const processProtectedData = async ({
       },
     });
 
+    if (vWaitForResult === false) {
+      return {
+        txHash: txHash,
+        dealId: dealid,
+        taskId,
+        ...(privateKey ? { pemPrivateKey: privateKey } : {}),
+      } as ProcessProtectedDataResponse<Params>;
+    }
+
     vOnStatusUpdate({
       title: 'CONSUME_TASK',
       isDone: false,
@@ -415,7 +432,7 @@ export const processProtectedData = async ({
       taskId,
       result,
       ...(privateKey ? { pemPrivateKey: privateKey } : {}),
-    };
+    } as ProcessProtectedDataResponse<Params>;
   } catch (error) {
     console.error('[processProtectedData] ERROR', error);
     handleIfProtocolError(error);

packages/sdk/src/lib/types/coreTypes.ts

@@ -369,16 +369,31 @@ export type ProcessProtectedDataParams = {
    * If not provided and encryptResult is true, a new key pair will be generated.
    */
   pemPrivateKey?: string;
+
+  /**
+   * Whether to wait for the result of the processing or not.
+   * @default = true
+   */
+  waitForResult?: boolean;
+
   /**
    * Callback function that will get called at each step of the process
    */
   onStatusUpdate?: OnStatusUpdateFn<ProcessProtectedDataStatuses>;
 };
 
-export type ProcessProtectedDataResponse = {
+export type ProcessProtectedDataResponseBase = {
   txHash: string;
   dealId: string;
   taskId: string;
-  result: ArrayBuffer;
   pemPrivateKey?: string;
 };
+
+export type ProcessProtectedDataResponseWithResult =
+  ProcessProtectedDataResponseBase & {
+    result: ArrayBuffer;
+  };
+
+export type ProcessProtectedDataResponse<T> = T extends { waitForResult: false }
+  ? ProcessProtectedDataResponseBase
+  : ProcessProtectedDataResponseWithResult;