feat: add bulk_cid in requestorder

Author: PierreJeanjacquot

CLI.md

@@ -1067,6 +1067,7 @@ Options:
 | --dataset \<address\|"deployed"\> | dataset address, use "deployed" to use last deployed from "deployed.json" |
 | --workerpool \<address\|"deployed"\> | workerpool address, use "deployed" to use last deployed from "deployed.json" |
 | --args \<string\> | specify the arguments to pass to the app |
+| --bulk-cid \<CID\> | specify the bulk CID to use for the request |
 | --input-files \<fileUrl\> | specify the URL of input files to be used by the app<br/>\* usage: --input-files https://example.com/foo.txt,https://example.com/bar.zip |
 | --secret \<secretMapping...\> | specify the requester secrets mappings (\<appSecretKey\>=\<requesterSecretName\>) to use in the app (only available for TEE tasks, use with --tag tee)<br/>\* usage: <br/>  \* \[command\] \[args\] --secret 1=login 2=password<br/>  \* \[command\] \[args\] --secret 1=login --secret 2=password<br/>  \* \[command\] --secret 1=login --secret 2=password -- \[args\]<br/>\* please note that this option is variadic, any number of mappings can be passed, use `--` to stop the list<br/> |
 | --category \<id\> | id of the task category |
@@ -1109,6 +1110,7 @@ Options:
 | --dataset-price \<amount unit...\> | dataset price per task (default unit nRLC) |
 | --workerpool-price \<amount unit...\> | workerpool price per task (default unit nRLC) |
 | --args \<string\> | specify the arguments to pass to the app |
+| --bulk-cid \<CID\> | specify the bulk CID to use for the request |
 | --input-files \<fileUrl\> | specify the URL of input files to be used by the app<br/>\* usage: --input-files https://example.com/foo.txt,https://example.com/bar.zip |
 | --secret \<secretMapping...\> | specify the requester secrets mappings (\<appSecretKey\>=\<requesterSecretName\>) to use in the app (only available for TEE tasks, use with --tag tee)<br/>\* usage: <br/>  \* \[command\] \[args\] --secret 1=login 2=password<br/>  \* \[command\] \[args\] --secret 1=login --secret 2=password<br/>  \* \[command\] --secret 1=login --secret 2=password -- \[args\]<br/>\* please note that this option is variadic, any number of mappings can be passed, use `--` to stop the list<br/> |
 | --category \<id\> | id of the task category |

docs/interfaces/internal_.RequestorderParams.md

@@ -8,6 +8,7 @@
 
 ### Properties
 
+- [bulk\_cid](internal_.RequestorderParams.md#bulk_cid)
 - [iexec\_args](internal_.RequestorderParams.md#iexec_args)
 - [iexec\_input\_files](internal_.RequestorderParams.md#iexec_input_files)
 - [iexec\_result\_encryption](internal_.RequestorderParams.md#iexec_result_encryption)
@@ -17,6 +18,16 @@
 
 ## Properties
 
+### bulk\_cid
+
+• `Optional` **bulk\_cid**: `string`
+
+bulk CID for the request
+
+default none
+
+___
+
 ### iexec\_args
 
 • `Optional` **iexec\_args**: `string`

src/cli/cmd/iexec-app.js

@@ -19,6 +19,7 @@ import {
   datasetorderSchema,
   apporderSchema,
   requestorderSchema,
+  stringSchema,
 } from '../../common/utils/validator.js';
 import { sconeTeeApp, gramineTeeApp } from '../utils/templates.js';
 import {
@@ -574,6 +575,7 @@ run
   .option(...orderOption.dataset())
   .option(...orderOption.workerpool())
   .option(...orderOption.requestArgs())
+  .option(...orderOption.requestBulkCid())
   .option(...orderOption.requestInputFiles())
   .option(...orderOption.requestSecrets())
   .option(...orderOption.category())
@@ -674,6 +676,8 @@ run
 
       const inputParams = await paramsSchema().validate(opts.params);
       const inputParamsArgs = await paramsArgsSchema().validate(opts.args);
+      // TODO bulkCid validation
+      const inputParamsBulkCid = await stringSchema().validate(opts.bulkCid);
       const inputParamsInputFiles =
         await paramsInputFilesArraySchema().validate(opts.inputFiles);
 
@@ -708,6 +712,9 @@ run
         ...(inputParamsArgs !== undefined && {
           [IEXEC_REQUEST_PARAMS.IEXEC_ARGS]: inputParamsArgs,
         }),
+        ...(inputParamsBulkCid !== undefined && {
+          [IEXEC_REQUEST_PARAMS.IEXEC_BULK_CID]: inputParamsBulkCid,
+        }),
         ...(inputParamsInputFiles !== undefined && {
           [IEXEC_REQUEST_PARAMS.IEXEC_INPUT_FILES]: inputParamsInputFiles,
         }),
@@ -1169,6 +1176,7 @@ requestRun
   .option(...orderOption.datasetprice())
   .option(...orderOption.workerpoolprice())
   .option(...orderOption.requestArgs())
+  .option(...orderOption.requestBulkCid())
   .option(...orderOption.requestInputFiles())
   .option(...orderOption.requestSecrets())
   .option(...orderOption.category())
@@ -1228,6 +1236,8 @@ requestRun
 
       const inputParams = await paramsSchema().validate(opts.params);
       const inputParamsArgs = await paramsArgsSchema().validate(opts.args);
+      // TODO bulkCid validation
+      const inputParamsBulkCid = await stringSchema().validate(opts.bulkCid);
       const inputParamsInputFiles =
         await paramsInputFilesArraySchema().validate(opts.inputFiles);
       const inputParamsSecrets =
@@ -1261,6 +1271,9 @@ requestRun
         ...(inputParamsArgs !== undefined && {
           [IEXEC_REQUEST_PARAMS.IEXEC_ARGS]: inputParamsArgs,
         }),
+        ...(inputParamsBulkCid !== undefined && {
+          [IEXEC_REQUEST_PARAMS.IEXEC_BULK_CID]: inputParamsBulkCid,
+        }),
         ...(inputParamsInputFiles !== undefined && {
           [IEXEC_REQUEST_PARAMS.IEXEC_INPUT_FILES]: inputParamsInputFiles,
         }),

src/cli/utils/cli-helper.js

@@ -498,6 +498,10 @@ export const orderOption = {
     '--args <string>',
     'specify the arguments to pass to the app',
   ],
+  requestBulkCid: () => [
+    '--bulk-cid <CID>',
+    'specify the bulk CID to use for the request',
+  ],
   requestSecrets: () => [
     '--secret <secretMapping...>',
     'specify the requester secrets mappings (<appSecretKey>=<requesterSecretName>) to use in the app (only available for TEE tasks, use with --tag tee)\n* usage: \n  * [command] [args] --secret 1=login 2=password\n  * [command] [args] --secret 1=login --secret 2=password\n  * [command] --secret 1=login --secret 2=password -- [args]\n* please note that this option is variadic, any number of mappings can be passed, use `--` to stop the list\n',

src/common/utils/constant.js

@@ -43,6 +43,7 @@ export const IEXEC_REQUEST_PARAMS = {
   IEXEC_RESULT_ENCRYPTION: 'iexec_result_encryption',
   IEXEC_RESULT_STORAGE_PROVIDER: 'iexec_result_storage_provider',
   IEXEC_RESULT_STORAGE_PROXY: 'iexec_result_storage_proxy',
+  IEXEC_BULK_CID: 'bulk_cid',
 };
 
 export const ANY = 'any';

src/common/utils/validator.js

@@ -312,6 +312,7 @@ export const objParamsSchema = () =>
   object({
     [IEXEC_REQUEST_PARAMS.IEXEC_ARGS]: paramsArgsSchema(),
     [IEXEC_REQUEST_PARAMS.IEXEC_INPUT_FILES]: paramsInputFilesArraySchema(),
+    [IEXEC_REQUEST_PARAMS.IEXEC_BULK_CID]: string().notRequired(), // TODO add CID validation
     [IEXEC_REQUEST_PARAMS.IEXEC_RESULT_ENCRYPTION]: paramsEncryptResultSchema(),
     [IEXEC_REQUEST_PARAMS.IEXEC_RESULT_STORAGE_PROVIDER]: string().when(
       '$isCallback',

src/lib/IExecOrderModule.d.ts

@@ -257,6 +257,12 @@ export interface RequestorderParams {
    * result proxy url
    */
   iexec_result_storage_proxy?: string;
+  /**
+   * bulk CID for the request
+   *
+   * default none
+   */
+  bulk_cid?: string;
 }
 
 /**