feature/fix-processProtectedData-price-handling (#422)

Co-authored-by: Pierre Jeanjacquot <[email protected]>

Author: Le-Caignec

packages/sdk/package-lock.json

@@ -56,6 +56,7 @@
     "@ethersproject/random": "^5.7.0",
     "@multiformats/multiaddr": "^12.1.3",
     "@typechain/ethers-v6": "^0.5.1",
+    "@types/bn.js": "^5.1.6",
     "borsh": "^2.0.0",
     "debug": "^4.3.4",
     "ethers": "^6.13.2",
@@ -75,6 +76,7 @@
     "@types/jest": "^29.5.12",
     "@typescript-eslint/eslint-plugin": "^6.7.5",
     "@typescript-eslint/parser": "^6.7.5",
+    "bn.js": "^5.2.1",
     "eslint": "^8.51.0",
     "eslint-config-airbnb-typescript": "^17.1.0",
     "eslint-config-prettier": "^9.0.0",

packages/sdk/package.json

@@ -9,7 +9,10 @@ import {
   processProtectedDataErrorMessage,
   handleIfProtocolError,
 } from '../../utils/errors.js';
-import { fetchOrdersUnderMaxPrice } from '../../utils/fetchOrdersUnderMaxPrice.js';
+import {
+  checkUserVoucher,
+  findWorkerpoolOrders,
+} from '../../utils/processProtectedData.models.js';
 import { pushRequesterSecret } from '../../utils/pushRequesterSecret.js';
 import {
   addressOrEnsSchema,
@@ -23,7 +26,6 @@ import {
   validateOnStatusUpdateCallback,
 } from '../../utils/validators.js';
 import { isERC734 } from '../../utils/whitelist.js';
-import { getResultFromCompletedTask } from './getResultFromCompletedTask.js';
 import {
   MatchOptions,
   OnStatusUpdateFn,
@@ -32,12 +34,9 @@ import {
   ProcessProtectedDataStatuses,
 } from '../types/index.js';
 import { IExecConsumer } from '../types/internalTypes.js';
+import { getResultFromCompletedTask } from './getResultFromCompletedTask.js';
 import { getWhitelistContract } from './smartContract/getWhitelistContract.js';
 import { isAddressInWhitelist } from './smartContract/whitelistContract.read.js';
-import {
-  checkUserVoucher,
-  filterWorkerpoolOrders,
-} from '../../utils/processProtectedData.models.js';
 
 export type ProcessProtectedData = typeof processProtectedData;
 
@@ -146,6 +145,10 @@ export const processProtectedData = async ({
         requester,
       }
     );
+    const datasetorder = datasetOrderbook.orders[0]?.order; //The first order is the cheapest one
+    if (!datasetorder) {
+      throw new Error(`No dataset orders found`);
+    }
     vOnStatusUpdate({
       title: 'FETCH_PROTECTED_DATA_ORDERBOOK',
       isDone: true,
@@ -162,6 +165,10 @@ export const processProtectedData = async ({
       maxTag: SCONE_TAG,
       workerpool: vWorkerpool,
     });
+    const apporder = appOrderbook.orders[0]?.order; //The first order is the cheapest one
+    if (!apporder) {
+      throw new Error(`No app orders found`);
+    }
     vOnStatusUpdate({
       title: 'FETCH_APP_ORDERBOOK',
       isDone: true,
@@ -181,24 +188,18 @@ export const processProtectedData = async ({
       maxTag: SCONE_TAG,
       category: 0,
     });
-    vOnStatusUpdate({
-      title: 'FETCH_WORKERPOOL_ORDERBOOK',
-      isDone: true,
-    });
-    const desiredPriceWorkerpoolOrder = filterWorkerpoolOrders({
+    const workerpoolOrder = findWorkerpoolOrders({
       workerpoolOrders: [...workerpoolOrderbook.orders],
       useVoucher: vUseVoucher,
       userVoucher,
     });
-    if (!desiredPriceWorkerpoolOrder) {
+    if (!workerpoolOrder) {
       throw new Error('No Workerpool order found.');
     }
-
-    const underMaxPriceOrders = fetchOrdersUnderMaxPrice(
-      datasetOrderbook,
-      appOrderbook,
-      vMaxPrice
-    );
+    vOnStatusUpdate({
+      title: 'FETCH_WORKERPOOL_ORDERBOOK',
+      isDone: true,
+    });
 
     vOnStatusUpdate({
       title: 'PUSH_REQUESTER_SECRET',
@@ -216,30 +217,48 @@ export const processProtectedData = async ({
     });
     const requestorderToSign = await iexec.order.createRequestorder({
       app: vApp,
-      category: desiredPriceWorkerpoolOrder.category,
+      category: workerpoolOrder.category,
       dataset: vProtectedData,
-      appmaxprice: underMaxPriceOrders.apporder.appprice,
-      datasetmaxprice: underMaxPriceOrders.datasetorder.datasetprice,
-      workerpoolmaxprice: desiredPriceWorkerpoolOrder.workerpoolprice,
+      appmaxprice: apporder.appprice,
+      datasetmaxprice: datasetorder.datasetprice,
+      workerpoolmaxprice: workerpoolOrder.workerpoolprice,
       tag: SCONE_TAG,
-      workerpool: desiredPriceWorkerpoolOrder.workerpool,
+      workerpool: workerpoolOrder.workerpool,
       params: {
         iexec_input_files: vInputFiles,
         iexec_secrets: secretsId,
         iexec_args: vArgs,
       },
     });
     const requestorder = await iexec.order.signRequestorder(requestorderToSign);
+
+    const orders = {
+      requestorder,
+      workerpoolorder: workerpoolOrder,
+      apporder: apporder,
+      datasetorder: datasetorder,
+    };
     const matchOptions: MatchOptions = {
       useVoucher: vUseVoucher,
       ...(vVoucherAddress ? { voucherAddress: vVoucherAddress } : {}),
     };
+
+    const estimatedMatchOrderPrice = await iexec.order.estimateMatchOrders(
+      orders,
+      matchOptions
+    );
+    if (
+      estimatedMatchOrderPrice.total
+        .sub(estimatedMatchOrderPrice.sponsored)
+        .ltn(vMaxPrice)
+    ) {
+      throw new Error(
+        `No orders found within the specified price limit ${vMaxPrice} nRLC.`
+      );
+    }
+
     const { dealid, txHash } = await iexec.order.matchOrders(
-      {
-        requestorder,
-        workerpoolorder: desiredPriceWorkerpoolOrder,
-        ...underMaxPriceOrders,
-      },
+      orders,
       matchOptions
     );
     const taskId = await iexec.deal.computeTaskId(dealid, 0);

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

@@ -36,7 +36,7 @@ export function checkUserVoucher({
   }
 }
 
-export function filterWorkerpoolOrders({
+export function findWorkerpoolOrders({
   workerpoolOrders,
   useVoucher,
   userVoucher,
@@ -49,9 +49,7 @@ export function filterWorkerpoolOrders({
     return null;
   }
 
-  let eligibleWorkerpoolOrders = [...workerpoolOrders];
-  let maxVoucherSponsoredAmount = 0; // may be safer to use bigint
-
+  let eligibleWorkerpoolOrders = workerpoolOrders;
   if (useVoucher) {
     if (!userVoucher) {
       throw new Error(
@@ -67,19 +65,11 @@ export function filterWorkerpoolOrders({
         'Found some workerpool orders but none can be sponsored by your voucher.'
       );
     }
-    maxVoucherSponsoredAmount = bnToNumber(userVoucher.balance);
   }
 
   const [cheapestOrder] = eligibleWorkerpoolOrders.sort(
     (order1, order2) =>
       order1.order.workerpoolprice - order2.order.workerpoolprice
   );
-
-  if (
-    !cheapestOrder ||
-    cheapestOrder.order.workerpoolprice > maxVoucherSponsoredAmount
-  ) {
-    return null;
-  }
   return cheapestOrder.order;
 }

packages/sdk/src/utils/fetchOrdersUnderMaxPrice.ts

@@ -40,7 +40,7 @@ jest.unstable_mockModule(
 jest.unstable_mockModule(
   '../../../../src/utils/processProtectedData.models.js',
   () => ({
-    filterWorkerpoolOrders: jest.fn(
+    findWorkerpoolOrders: jest.fn(
       () => mockWorkerpoolOrderbook.orders[0].order
     ),
     checkUserVoucher: jest.fn(),
@@ -524,11 +524,11 @@ describe('processProtectedData', () => {
 
   describe('When there is NO workerpool orders', () => {
     it('should throw a WorkflowError with the correct message', async () => {
-      const { filterWorkerpoolOrders } = await import(
+      const { findWorkerpoolOrders } = await import(
         '../../../../src/utils/processProtectedData.models.js'
       );
 
-      (filterWorkerpoolOrders as jest.Mock).mockReturnValue(null);
+      (findWorkerpoolOrders as jest.Mock).mockReturnValue(null);
       // --- GIVEN
       const iexec = {
         wallet: {