feat(core): support allowDeposit option for protected and bulk data processing

Author: abbesBenayache

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

@@ -1,10 +1,10 @@
 import { sumTags } from 'iexec/utils';
 import { SCONE_TAG } from '../../config/config.js';
 import {
-  WorkflowError,
-  processProtectedDataErrorMessage,
   handleIfProtocolError,
+  processProtectedDataErrorMessage,
   ValidationError,
+  WorkflowError,
 } from '../../utils/errors.js';
 import {
   checkUserVoucher,
@@ -50,6 +50,7 @@ export const processBulkRequest = async <
   bulkRequest,
   workerpool,
   useVoucher = false,
+  allowDeposit = false,
   voucherOwner,
   path,
   pemPrivateKey,
@@ -66,6 +67,9 @@ export const processBulkRequest = async <
     .default(defaultWorkerpool) // Default workerpool if none is specified
     .label('workerpool')
     .validateSync(workerpool);
+  const vAllowDeposit = booleanSchema()
+    .label('allowDeposit')
+    .validateSync(allowDeposit);
   const vUseVoucher = booleanSchema()
     .label('useVoucher')
     .validateSync(useVoucher);
@@ -215,6 +219,7 @@ export const processBulkRequest = async <
       const matchOptions: MatchOptions = {
         useVoucher: vUseVoucher,
         ...(vVoucherOwner ? { voucherAddress: userVoucher?.address } : {}),
+        allowDeposit: vAllowDeposit,
       };
 
       const {

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

@@ -6,19 +6,19 @@ import {
   SCONE_TAG,
 } from '../../config/config.js';
 import {
-  WorkflowError,
-  processProtectedDataErrorMessage,
   handleIfProtocolError,
+  processProtectedDataErrorMessage,
   ValidationError,
+  WorkflowError,
 } from '../../utils/errors.js';
 import {
   checkUserVoucher,
   filterWorkerpoolOrders,
 } from '../../utils/processProtectedData.models.js';
 import { pushRequesterSecret } from '../../utils/pushRequesterSecret.js';
 import {
-  getPemFormattedKeyPair,
   formatPemPublicKeyForSMS,
+  getPemFormattedKeyPair,
 } from '../../utils/rsa.js';
 import {
   addressOrEnsSchema,
@@ -64,6 +64,7 @@ export const processProtectedData = async <
   inputFiles,
   secrets,
   workerpool,
+  allowDeposit = false,
   useVoucher = false,
   voucherOwner,
   encryptResult = false,
@@ -103,6 +104,9 @@ export const processProtectedData = async <
     .default(defaultWorkerpool) // Default workerpool if none is specified
     .label('workerpool')
     .validateSync(workerpool);
+  const vAllowDeposit = booleanSchema()
+    .label('allowDeposit')
+    .validateSync(allowDeposit);
   const vUseVoucher = booleanSchema()
     .label('useVoucher')
     .validateSync(useVoucher);
@@ -369,9 +373,9 @@ export const processProtectedData = async <
     };
     const matchOptions: MatchOptions = {
       useVoucher: vUseVoucher,
+      allowDeposit: vAllowDeposit,
       ...(vVoucherOwner ? { voucherAddress: userVoucher?.address } : {}),
     };
-
     const { dealid: dealId, txHash } = await iexec.order.matchOrders(
       orders,
       matchOptions

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

@@ -380,6 +380,12 @@ export type ProcessProtectedDataParams = {
    */
   workerpool?: AddressOrENS;
 
+  /**
+   * A boolean that indicates whether to allow automatic deposit from wallet when account balance is insufficient to cover the cost of the task.
+   * @default false
+   */
+  allowDeposit?: boolean;
+
   /**
    * A boolean that indicates whether to use a voucher or no.
    */
@@ -567,6 +573,12 @@ export type ProcessBulkRequestParams = {
    */
   useVoucher?: boolean;
 
+  /**
+   * A boolean that indicates whether to allow automatic deposit from wallet when account balance is insufficient to cover the cost of the bulk request.
+   * @default false
+   */
+  allowDeposit?: boolean;
+
   /**
    * Override the voucher contract to use, must be combined with useVoucher: true the user must be authorized by the voucher's owner to use it.
    */