feat: add bulkOnly filter on dataset orderbook

Author: PierreJeanjacquot

CLI.md

@@ -1978,6 +1978,7 @@ Options:
 | --app-strict | fetch orders created strictly for the specified app |
 | --requester-strict | fetch orders created strictly for the specified requester |
 | --workerpool-strict | fetch orders created strictly for the specified workerpool |
+| --bulk-only | only include bulk orders |
 
 #### iexec orderbook workerpool
 

docs/classes/IExecOrderbookModule.md

@@ -155,6 +155,7 @@ console.log('total orders:', count);
 | `datasetAddressOrOptions` | `string` \| { `app?`: `string` ; `dataset?`: `string` ; `datasetOwner?`: `string` ; `isAppStrict?`: `boolean` ; `isRequesterStrict?`: `boolean` ; `isWorkerpoolStrict?`: `boolean` ; `maxTag?`: [`Tag`](../modules.md#tag) \| `string`[] ; `minTag?`: [`Tag`](../modules.md#tag) \| `string`[] ; `minVolume?`: [`BNish`](../modules.md#bnish) ; `page?`: `number` ; `pageSize?`: `number` ; `requester?`: `string` ; `workerpool?`: `string`  } | - |
 | `options?` | `Object` | **`Deprecated`** use first parameter instead migration: replace `fetchDatasetOrderbook(datasetAddress, options)` by `fetchDatasetOrderbook({ dataset: datasetAddress, ...options })` |
 | `options.app?` | `string` | include orders restricted to specified app (use `'any'` to include any app) |
+| `options.bulkOnly?` | `boolean` | filters out orders that don't allow bulk processing (default: `false`) |
 | `options.isAppStrict?` | `boolean` | filters out orders allowing “any” app (default: `false`) |
 | `options.isRequesterStrict?` | `boolean` | filters out orders allowing “any” requester (default: `false`) |
 | `options.isWorkerpoolStrict?` | `boolean` | filters out orders allowing “any” workerpool (default: `false`) |

docs/interfaces/internal_.PublishedDatasetorder.md

@@ -10,6 +10,7 @@ published sell order for a dataset
 
 ### Properties
 
+- [bulk](internal_.PublishedDatasetorder.md#bulk)
 - [chainId](internal_.PublishedDatasetorder.md#chainid)
 - [order](internal_.PublishedDatasetorder.md#order)
 - [orderHash](internal_.PublishedDatasetorder.md#orderhash)
@@ -20,6 +21,14 @@ published sell order for a dataset
 
 ## Properties
 
+### bulk
+
+• `Optional` **bulk**: `boolean`
+
+true if the order allows bulk processing
+
+___
+
 ### chainId
 
 • **chainId**: `number`

src/cli/cmd/iexec-orderbook.js

@@ -155,6 +155,7 @@ orderbookDataset
   .option(...option.isAppStrict())
   .option(...option.isRequesterStrict())
   .option(...option.isWorkerpoolStrict())
+  .option(...option.bulkOnly())
   .description(desc.showObj('dataset orderbook', 'marketplace'))
   .action(async (dataset, opts) => {
     await checkUpdate(opts);
@@ -175,8 +176,8 @@ orderbookDataset
         isAppStrict,
         isRequesterStrict,
         isWorkerpoolStrict,
+        bulkOnly,
       } = opts;
-
       const request = fetchDatasetOrderbook(
         chain.contracts,
         getPropertyFormChain(chain, 'iexecGateway'),
@@ -191,6 +192,7 @@ orderbookDataset
           isAppStrict,
           isRequesterStrict,
           isWorkerpoolStrict,
+          bulkOnly,
         },
       );
       const fetchMessage = info.showing(objName);
@@ -205,6 +207,7 @@ orderbookDataset
               apprestrict: e.order.apprestrict,
               workerpoolrestrict: e.order.workerpoolrestrict,
               requesterrestrict: e.order.requesterrestrict,
+              bulk: e.bulk,
             }))
           : [];
       const createResultsMessage = (
@@ -219,6 +222,7 @@ orderbookDataset
             orderHash: e.orderHash,
             price: e.price,
             remaining: e.remaining,
+            ...(e.bulk && { bulk: e.bulk }),
             ...(e.tag !== NULL_BYTES32 && { tag: e.tag }),
             ...(e.apprestrict !== NULL_ADDRESS && {
               apprestrict: e.apprestrict,

src/cli/utils/cli-helper.js

@@ -312,6 +312,7 @@ export const option = {
   minVolume: () => ['--min-volume <integer>', 'specify minimum volume'],
   minTrust: () => ['--min-trust <integer>', 'specify minimum trust'],
   maxTrust: () => ['--max-trust <integer>', 'specify maximum trust'],
+  bulkOnly: () => ['--bulk-only', 'only include bulk orders'],
   password: () => [
     '--password <password>',
     'password used to encrypt the wallet (unsafe)',

src/common/market/orderbook.js

@@ -181,6 +181,7 @@ export const fetchDatasetOrderbook = async (
     let isAppStrict;
     let isWorkerpoolStrict;
     let isRequesterStrict;
+    let bulkOnly;
     if (typeof datasetOrOptions === 'object' && datasetOrOptions !== null) {
       ({
         dataset,
@@ -196,6 +197,7 @@ export const fetchDatasetOrderbook = async (
         isAppStrict = false,
         isWorkerpoolStrict = false,
         isRequesterStrict = false,
+        bulkOnly = false,
       } = datasetOrOptions);
     } else {
       // deprecated
@@ -216,6 +218,7 @@ export const fetchDatasetOrderbook = async (
         isAppStrict = false,
         isWorkerpoolStrict = false,
         isRequesterStrict = false,
+        bulkOnly = false,
       } = options || {});
     }
     if (!dataset && !datasetOwner) {
@@ -279,6 +282,7 @@ export const fetchDatasetOrderbook = async (
       ...(maxTag !== undefined && {
         maxTag: await tagSchema().label('maxTag').validate(maxTag),
       }),
+      bulkOnly: await booleanSchema().label('bulkOnly').validate(bulkOnly),
       ...(page !== undefined && {
         pageIndex: await positiveIntSchema().label('page').validate(page),
       }),

src/lib/IExecOrderbookModule.d.ts

@@ -47,6 +47,10 @@ export interface PublishedDatasetorder {
   status: string;
   signer: Address;
   publicationTimestamp: string;
+  /**
+   * true if the order allows bulk processing
+   */
+  bulk?: boolean;
   order: {
     dataset: Address;
     datasetprice: number;
@@ -379,6 +383,10 @@ export default class IExecOrderbookModule extends IExecModule {
        * filters out orders allowing “any” workerpool (default: `false`)
        */
       isWorkerpoolStrict?: boolean;
+      /**
+       * filters out orders that don't allow bulk processing (default: `false`)
+       */
+      bulkOnly?: boolean;
     },
   ): Promise<PaginableOrders<PublishedDatasetorder>>;
   /**

test/docker-compose.yml

@@ -244,7 +244,7 @@ services:
         condition: service_started
 
   market-api:
-    image: iexechub/iexec-market-api:7.0.0
+    image: iexechub/iexec-market-api:7.0.0-feat-bulk-order-filter-cae060a
     restart: unless-stopped
     ports:
       - 3000:3000

test/lib/e2e/IExecOrderbookModule.test.js

@@ -17,8 +17,9 @@ import {
   SERVICE_HTTP_500_URL,
   getRandomBytes32,
 } from '../../test-utils.js';
-import '../../jest-setup.js';
+import { DATASET_INFINITE_VOLUME } from '../../../src/common/utils/constant.js';
 import { errors } from '../../../src/lib/index.js';
+import '../../jest-setup.js';
 
 const { MarketCallError } = errors;
 
@@ -598,6 +599,7 @@ describe('orderbook', () => {
           );
         expect(res1.orders).toLooseEqual(res1deprecated.orders);
       });
+
       test('datasetOwner returns orders from dataset owner', async () => {
         const { iexec: iexecUser, wallet } = getTestConfig(iexecTestChain)();
         const { iexec: iexecOtherUser } = getTestConfig(iexecTestChain)();
@@ -815,6 +817,53 @@ describe('orderbook', () => {
         expect(strictAppOrders.count).toBe(0);
         expect(strictAppOrders.orders.length).toBe(0);
       });
+
+      test('bulkOnly option allow filtering only orders allowing dataset bulk processing', async () => {
+        const { iexec } = getTestConfig(iexecTestChain)();
+        const { iexec: iexecReadOnly } = getTestConfig(iexecTestChain)({
+          readOnly: true,
+        });
+        // 1 and 2: orders without any restrictions
+        const datasetOrderTemplate = await deployAndGetDatasetorder(iexec);
+        const datasetAddress = datasetOrderTemplate.dataset;
+
+        await iexec.order
+          .signDatasetorder(datasetOrderTemplate, { preflightCheck: false })
+          .then((o) =>
+            iexec.order.publishDatasetorder(o, { preflightCheck: false }),
+          );
+        await iexec.order
+          .signDatasetorder(
+            {
+              ...datasetOrderTemplate,
+              datasetprice: 0,
+              volume: DATASET_INFINITE_VOLUME,
+            },
+            { preflightCheck: false },
+          )
+          .then((o) =>
+            iexec.order.publishDatasetorder(o, { preflightCheck: false }),
+          );
+
+        const allOrders = await iexecReadOnly.orderbook.fetchDatasetOrderbook({
+          dataset: datasetAddress,
+        });
+        expect(allOrders.count).toBe(2);
+        expect(allOrders.orders.length).toBe(2);
+
+        const bulkOnlyOrders =
+          await iexecReadOnly.orderbook.fetchDatasetOrderbook({
+            dataset: datasetAddress,
+            bulkOnly: true,
+          });
+        expect(bulkOnlyOrders.count).toBe(1);
+        expect(bulkOnlyOrders.orders.length).toBe(1);
+        expect(bulkOnlyOrders.orders[0].order.datasetprice).toBe(0);
+        expect(bulkOnlyOrders.orders[0].order.volume).toBe(
+          DATASET_INFINITE_VOLUME,
+        );
+        expect(bulkOnlyOrders.orders[0].bulk).toBe(true);
+      });
     });
 
     describe('fetchWorkerpoolOrderbook()', () => {