Class: IExecOrderModule

April 29, 2026 · View on GitHub

iexec

iexec / IExecOrderModule

Class: IExecOrderModule

module exposing order methods

Constructors

Constructor

new IExecOrderModule(configOrArgs, options?): IExecOrderModule

Create an IExecModule instance

Parameters

Properties

config

config: IExecConfig

current IExecConfig

Methods

cancelApporder()

cancelApporder(apporder): Promise<{ order: SignedApporder; txHash: string; }>

SIGNER REQUIRED, ONLY APP OWNER

cancel an apporder on the blockchain making it invalid

example:

const { txHash } = await cancelApporder(apporder);
console.log('cancel tx:', txHash);

Returns

Promise<{ order: SignedApporder; txHash: string; }>

cancelDatasetorder()

cancelDatasetorder(datasetorder): Promise<{ order: SignedDatasetorder; txHash: string; }>

SIGNER REQUIRED, ONLY DATASET OWNER

cancel a datasetorder on the blockchain making it invalid

example:

const { txHash } = await cancelDatasetorder(datasetorder);
console.log('cancel tx:', txHash);

Returns

Promise<{ order: SignedDatasetorder; txHash: string; }>

cancelRequestorder()

cancelRequestorder(requestorder): Promise<{ order: SignedRequestorder; txHash: string; }>

SIGNER REQUIRED, ONLY REQUESTER

cancel a requestorder on the blockchain making it invalid

example:

const { txHash } = await cancelRequestorder(requestorder);
console.log('cancel tx:', txHash);

Returns

Promise<{ order: SignedRequestorder; txHash: string; }>

cancelWorkerpoolorder()

cancelWorkerpoolorder(workerpoolorder): Promise<{ order: SignedWorkerpoolorder; txHash: string; }>

SIGNER REQUIRED, ONLY WORKERPOOL OWNER

cancel a workerpoolorder on the blockchain making it invalid

example:

const { txHash } = await cancelWorkerpoolorder(workerpoolorder);
console.log('cancel tx:', txHash);

Returns

Promise<{ order: SignedWorkerpoolorder; txHash: string; }>

createApporder()

createApporder(overrides): Promise<ApporderTemplate>

create an apporder template with specified parameters

example:

const apporderTemplate = await createApporder({app: appAddress});

Parameters

overrides

datasetrestrict?

string

restrict usage to a specific dataset

default no restrict

requesterrestrict?

string

restrict usage to a specific requester

default no restrict

tag?

Tag | string[]

restrict usage to runtime with specified tags

default []

volume?

BNish

volume of tasks executable with the order

default 1

workerpoolrestrict?

string

restrict usage to a specific workerpool

default no restrict

createDatasetorder()

createDatasetorder(overrides): Promise<DatasetorderTemplate>

create a datasetorder template with specified parameters

example:

const datasetorderTemplate = await createDatasetorder({dataset: datasetAddress});

Parameters

overrides

apprestrict?

string

restrict usage to a specific app

default no restrict

requesterrestrict?

string

restrict usage to a specific requester

default no restrict

tag?

Tag | string[]

restrict usage to runtime with specified tags

default []

volume?

BNish

volume of tasks executable with the order

default 1

workerpoolrestrict?

string

restrict usage to a specific workerpool

default no restrict

createRequestorder()

createRequestorder(overrides): Promise<RequestorderTemplate>

create a requestorder template with specified parameters

example:

const requestorderTemplate = await createRequestorder({
  app: appAddress,
  category: 0,
  params: { iexec_args: 'hello world'}
 });

Parameters

overrides

appmaxprice?

NRLCAmount

app max price per task

default 0

beneficiary?

string

beneficiary

default connected wallet address

callback?

string

address of the smart contract for on-chain callback with the execution result

datasetmaxprice?

NRLCAmount

dataset max price per task

default 0

params?

string | RequestorderParams

execution parameters

requester?

string

requester

default connected wallet address

tag?

Tag | string[]

restrict usage to runtime with specified tags

default []

volume?

BNish

volume of tasks executable with the order

default 1

workerpool?

string

run one specified workerpool

default run on any workerpool

workerpoolmaxprice?

NRLCAmount

workerpool max price per task

default 0

createWorkerpoolorder()

createWorkerpoolorder(overrides): Promise<WorkerpoolorderTemplate>

create a workerpoolorder template with specified parameters

example:

const workerpoolorderTemplate = await createWorkerpoolorder({workerpool: workerpoolAddress, category: 0});

Parameters

overrides

apprestrict?

string

restrict usage to a specific app

default no restrict

datasetrestrict?

string

restrict usage to a specific dataset

default no restrict

requesterrestrict?

string

restrict usage to a specific requester

default no restrict

tag?

Tag | string[]

proposed tags

default []

volume?

BNish

volume of tasks executable with the order

default 1

estimateMatchOrders()

estimateMatchOrders(orders): Promise<{ sponsored: BN; total: BN; volume: BN; }>

estimates the cost of matching the provided orders

example:

const orders = {
  apporder,
  datasetorder
  workerpoolorder,
  requestorder,
};
const result = await estimateMatchOrders(orders);
console.log(`executable volume: ${result.volume} tasks`);
console.log(`total cost for matching orders: ${result.total} nRLC`);

Parameters

orders

Returns

Promise<{ sponsored: BN; total: BN; volume: BN; }>

hashDatasetorder()

hashDatasetorder(datasetorder): Promise<string>

compute the hash of a datasetorder

example:

const orderHash = await hashDatasetorder(datasetorder);
console.log('order hash:', orderHash);

hashRequestorder()

hashRequestorder(requestorder): Promise<string>

compute the hash of a requestorder

example:

const orderHash = await hashRequestorder(requestorder);
console.log('order hash:', orderHash);

hashWorkerpoolorder()

hashWorkerpoolorder(workerpoolorder): Promise<string>

compute the hash of a workerpoolorder

example:

const orderHash = await hashWorkerpoolorder(workerpoolorder);
console.log('order hash:', orderHash);

matchOrders()

matchOrders(orders, options?): Promise<{ dealid: string; txHash: string; volume: BN; }>

SIGNER REQUIRED

make a deal on-chain with compatible orders to trigger the off-chain computation.

NB: preflight checks are performed on the orders before signing (this helps detecting inconsistencies and prevent creating always failing tasks). these checks can be disabled by passing the option preflightCheck: false

const { dealid, txHash } = await matchOrders({
  apporder,
  workerpoolorder,
  requestorder,
});
console.log(`created deal ${dealid} in tx ${txHash}`);

Parameters

orders

options?

preflightCheck?

boolean

Returns

Promise<{ dealid: string; txHash: string; volume: BN; }>

prepareDatasetBulk()

prepareDatasetBulk(datasetorders, options?): Promise<{ cid: string; volume: number; }>

Prepare a bulk from datasetorders to process multiple datasets with a single requestorder

NB:

datasetorders used must authorize the requester to use the dataset in for free with an infinite volume (utils.DATASET_INFINITE_VOLUME)
depending on the number of datasetorders provided and the maxDatasetPerTask option, the bulk might require be splitted into multiple tasks to respect the max dataset per task limit, the returned volume is the number of tasks required to process the bulk

example:

const { bulkCid, volume } = await prepareDatasetBulk(datasetorders, { maxDatasetPerTask: 5 });
console.log(`bulk_cid: ${bulkCid}, volume: ${volume}`);

const requestorderTemplate = await createRequestorder({
  app: appAddress,
  category: 0,
  volume: volume, // set the volume
  params: { bulk_cid: bulkCid } // set the bulk cid in the requestorder params
});

Parameters

datasetorders

ConsumableDatasetorder[]

options?

maxDatasetPerTask?

number

Maximum number of datasets to include in a single task

Default

Returns

Promise<{ cid: string; volume: number; }>

publishApporder()

publishApporder(apporder, options?): Promise<string>

SIGNER REQUIRED, ONLY APP OWNER

publish an apporder on the off-chain marketplace making it available for other users

NB: preflight checks are performed on the order before signing (this helps detecting inconsistencies and prevent creating always failing tasks). these checks can be disabled by passing the option preflightCheck: false

example:

const orderHash = await publishApporder(apporder);
console.log('published order hash:', orderHash);

Parameters

apporder

ConsumableApporder

options?

preflightCheck?

boolean

Returns

Promise<string>

publishDatasetorder()

publishDatasetorder(datasetorder, options?): Promise<string>

SIGNER REQUIRED, ONLY DATASET OWNER

publish a datasetorder on the off-chain marketplace making it available for other users

example:

const orderHash = await publishDatasetorder(datasetorder);
console.log('published order hash:', orderHash);

Parameters

datasetorder

ConsumableDatasetorder

options?

preflightCheck?

boolean

Returns

Promise<string>

publishRequestorder()

publishRequestorder(requestorder, options?): Promise<string>

SIGNER REQUIRED, ONLY REQUESTER

publish a requestorder on the off-chain marketplace making it available for other users

example:

const orderHash = await publishRequestorder(requestorder);
console.log('published order hash:', orderHash);

Parameters

requestorder

ConsumableRequestorder

options?

preflightCheck?

boolean

Returns

Promise<string>

publishWorkerpoolorder()

publishWorkerpoolorder(workerpoolorder): Promise<string>

SIGNER REQUIRED, ONLY WORKERPOOL OWNER

publish a workerpoolorder on the off-chain marketplace making it available for other users

example:

const orderHash = await publishWorkerpoolorder(workerpoolorder);
console.log('published order hash:', orderHash);

Parameters

workerpoolorder

ConsumableWorkerpoolorder

Returns

Promise<string>

signApporder()

signApporder(apporder, options?): Promise<SignedApporder>

ONLY APP OWNER

sign an apporder template to create a valid order

example:

const apporderTemplate = await createApporder({app: appAddress});
const apporder = await signApporder(apporderTemplate);

Parameters

apporder

SignableApporder

options?

preflightCheck?

boolean

Returns

Promise<SignedApporder>

signDatasetorder()

signDatasetorder(datasetorder, options?): Promise<SignedDatasetorder>

SIGNER REQUIRED, ONLY DATASET OWNER

sign a datasetorder template to create a valid order

example:

const datasetorderTemplate = await createDatasetorder({dataset: datasetAddress});
const datasetorder = await signDatasetorder(datasetorderTemplate);

Parameters

datasetorder

SignableDatasetorder

options?

preflightCheck?

boolean

Returns

Promise<SignedDatasetorder>

signRequestorder()

signRequestorder(requestorder, options?): Promise<SignedRequestorder>

SIGNER REQUIRED, ONLY REQUESTER

sign a requestorder template to create a valid order

example:

const requestorderTemplate = await createRequestorder({
  app: appAddress,
  category: 0,
  params: { iexec_args: 'hello world'}
 });
const requestorder = await signRequestorder(requestorderTemplate);

Parameters

requestorder

SignableRequestorder

options?

preflightCheck?

boolean

Returns

Promise<SignedRequestorder>

signWorkerpoolorder()

signWorkerpoolorder(workerpoolorder): Promise<SignedWorkerpoolorder>

SIGNER REQUIRED, ONLY WORKERPOOL OWNER

sign a workerpoolorder template to create a valid order

const workerpoolorderTemplate = await createWorkerpoolorder({workerpool: workerpoolAddress, category: 0});
const workerpoolorder = await signWorkerpoolorder(workerpoolorderTemplate);

Parameters

workerpoolorder

SignableWorkerpoolorder

Returns

Promise<SignedWorkerpoolorder>

unpublishAllApporders()

unpublishAllApporders(appAddress): Promise<string[]>

SIGNER REQUIRED, ONLY APPORDER SIGNER

unpublish all the published app's apporders from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHashes = await unpublishAllApporders(appAddress);
console.log('published orders count:', orderHashes.length);

Parameters

appAddress

string

Returns

Promise<string[]>

unpublishAllDatasetorders()

unpublishAllDatasetorders(datasetAddress): Promise<string[]>

SIGNER REQUIRED, ONLY DATASETORDER SIGNER

unpublish all the published dataset's datasetorders from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHashes = await unpublishAllDatasetorders(datasetAddress);
console.log('unpublished orders count:', orderHashes.length);

Parameters

datasetAddress

string

Returns

Promise<string[]>

unpublishAllRequestorders()

unpublishAllRequestorders(): Promise<string[]>

SIGNER REQUIRED, ONLY REQUESTER

unpublish all the published requester's requestorders from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHashes = await unpublishAllRequestorders();
console.log('unpublished orders count:', orderHashes.length);

Returns

Promise<string[]>

unpublishAllWorkerpoolorders()

unpublishAllWorkerpoolorders(workerpoolAddress): Promise<string[]>

SIGNER REQUIRED, ONLY WORKERPOOLORDER SIGNER

unpublish all the published workerpool's workerpoolorders from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHashes = await unpublishAllWorkerpoolorders(workerpoolAddress);
console.log('unpublished orders count:', orderHashes.length);

Parameters

workerpoolAddress

string

Returns

Promise<string[]>

unpublishApporder()

unpublishApporder(apporderHash): Promise<string>

SIGNER REQUIRED, ONLY APPORDER SIGNER

unpublish an apporder from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHash = await unpublishApporder(apporderHash);
console.log(unpublished order hash:', orderHash);

Parameters

apporderHash

string

Returns

Promise<string>

unpublishDatasetorder()

unpublishDatasetorder(datasetorderHash): Promise<string>

SIGNER REQUIRED, ONLY DATASETORDER SIGNER

unpublish a datasetorder from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHash = await unpublishDatasetorder(datasetorderHash);
console.log('unpublished order hash:', orderHash);

Parameters

datasetorderHash

string

Returns

Promise<string>

unpublishLastApporder()

unpublishLastApporder(appAddress): Promise<string>

SIGNER REQUIRED, ONLY APPORDER SIGNER

unpublish the last published app's apporder from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHash = await unpublishLastApporder(appAddress);
console.log('published order hash:', orderHash);

Parameters

appAddress

string

Returns

Promise<string>

unpublishLastDatasetorder()

unpublishLastDatasetorder(datasetAddress): Promise<string>

SIGNER REQUIRED, ONLY DATASETORDER SIGNER

unpublish the last published dataset's datasetorder from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHash = await unpublishLastDatasetorder(datasetAddress);
console.log('unpublished order hash:', orderHash);

Parameters

datasetAddress

string

Returns

Promise<string>

unpublishLastRequestorder()

unpublishLastRequestorder(): Promise<string>

SIGNER REQUIRED, ONLY REQUESTER

unpublish the last published requester's requestorder from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHash = await unpublishLastRequestorder();
console.log('unpublished order hash:', orderHash);

Returns

Promise<string>

unpublishLastWorkerpoolorder()

unpublishLastWorkerpoolorder(workerpoolAddress): Promise<string>

**SIGNER REQUIRED, ONLY WORKERPOOLORDER SIGNER

unpublish the last published workerpool's workerpoolorder from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHash = await unpublishLastWorkerpoolorder(workerpoolAddress);
console.log('unpublished order hash:', orderHash);

Parameters

workerpoolAddress

string

Returns

Promise<string>

unpublishRequestorder()

unpublishRequestorder(requestorderHash): Promise<string>

SIGNER REQUIRED, ONLY REQUESTER

unpublish a requestorder from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHash = await unpublishRequestorder(requestorderHash);
console.log('unpublished order hash:', orderHash);

unpublishWorkerpoolorder(workerpoolorderHash): Promise<string>

SIGNER REQUIRED, ONLY WORKERPOOLORDER SIGNER

unpublish a workerpoolorder from the off-chain marketplace

NB: this is a transaction free off-chain operation, unpublished orders are no longer exposed to other users but are still valid, use the cancel method if you want to invalidate them

example:

const orderHash = await unpublishWorkerpoolorder(workerpoolorderHash);
console.log('unpublished order hash:', orderHash);

static fromConfig(config): IExecOrderModule

Create an IExecOrderModule instance using an IExecConfig instance