Migrate IexecOrderManagement unit tests (#101)

Author: james-toussaint

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## vNEXT
 - Migrate unit test files to Typescript & Hardhat:
+    - IexecOrderManagement (#101)
     - IexecMaintenance (#100)
     - IexecEscrowNative (#99)
     - IexecERC20 (#98)

test/byContract/IexecOrderManagement/IexecOrderManagement.ts

@@ -1,6 +1,8 @@
 // SPDX-FileCopyrightText: 2020-2024 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
 // SPDX-License-Identifier: Apache-2.0
 
+// TODO: Remove this file replaced by IexecOrderManagement.ts
+
 const loadTruffleFixtureDeployment = require('../../../scripts/truffle-fixture-deployer');
 // Config
 var DEPLOYMENT = require('../../../config/config.json').chains.default;

test/byContract/IexecOrderManagement/close.js renamed to test/byContract/IexecOrderManagement/close.js.skip

@@ -1,6 +1,8 @@
 // SPDX-FileCopyrightText: 2020-2024 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
 // SPDX-License-Identifier: Apache-2.0
 
+// TODO: Remove this file replaced by IexecOrderManagement.ts
+
 const loadTruffleFixtureDeployment = require('../../../scripts/truffle-fixture-deployer');
 // Config
 var DEPLOYMENT = require('../../../config/config.json').chains.default;

test/byContract/IexecOrderManagement/invalid.js renamed to test/byContract/IexecOrderManagement/invalid.js.skip

@@ -1,6 +1,8 @@
 // SPDX-FileCopyrightText: 2020-2024 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
 // SPDX-License-Identifier: Apache-2.0
 
+// TODO: Remove this file replaced by IexecOrderManagement.ts
+
 const loadTruffleFixtureDeployment = require('../../../scripts/truffle-fixture-deployer');
 // Config
 var DEPLOYMENT = require('../../../config/config.json').chains.default;

test/byContract/IexecOrderManagement/sign.js renamed to test/byContract/IexecOrderManagement/sign.js.skip

@@ -1,6 +1,7 @@
 // SPDX-FileCopyrightText: 2024 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
 // SPDX-License-Identifier: Apache-2.0
 
+import { TypedDataDomain } from '@ethersproject/abstract-signer';
 import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers';
 import { BigNumber, ContractReceipt } from 'ethers';
 import hre, { ethers } from 'hardhat';
@@ -18,18 +19,32 @@ import {
     WorkerpoolRegistry__factory,
 } from '../../typechain';
 import { IexecPoco1__factory } from '../../typechain/factories/contracts/modules/interfaces/IexecPoco1.v8.sol';
-import { IexecOrders, Orders, hashOrder, signOrders } from '../../utils/createOrders';
+import {
+    IexecOrders,
+    OrderOperation,
+    Orders,
+    hashOrder,
+    signOrderOperation,
+    signOrders,
+} from '../../utils/createOrders';
 import { IexecAccounts, getDealId, getTaskId, setNextBlockTimestamp } from '../../utils/poco-tools';
 import { extractEventsFromReceipt } from '../../utils/tools';
 const DEPLOYMENT_CONFIG = config.chains.default;
 
 export class IexecWrapper {
     proxyAddress: string;
     accounts: IexecAccounts;
+    domain: TypedDataDomain;
 
     constructor(proxyAddress: string, accounts: IexecAccounts) {
         this.proxyAddress = proxyAddress;
         this.accounts = accounts;
+        this.domain = {
+            name: 'iExecODB',
+            version: '5.0.0',
+            chainId: hre.network.config.chainId,
+            verifyingContract: this.proxyAddress,
+        };
     }
 
     /**
@@ -89,6 +104,23 @@ export class IexecWrapper {
             .then((tx) => tx.wait());
     }
 
+    /**
+     * Hash an order using current domain.
+     */
+    hashOrder(order: Record<string, any>) {
+        return hashOrder(this.domain, order);
+    }
+
+    /**
+     * Sign an order operation using current domain.
+     */
+    async signOrderOperation(
+        orderOperation: OrderOperation,
+        signer: SignerWithAddress,
+    ): Promise<void> {
+        return signOrderOperation(this.domain, orderOperation, signer);
+    }
+
     async signAndSponsorMatchOrders(orders: IexecOrders) {
         return this._signAndMatchOrders(orders, true);
     }
@@ -104,13 +136,7 @@ export class IexecWrapper {
      * Otherwise the requester will be in charge of paying for the deal.
      */
     private async _signAndMatchOrders(orders: IexecOrders, withSponsor: boolean) {
-        const domain = {
-            name: 'iExecODB',
-            version: '5.0.0',
-            chainId: hre.network.config.chainId,
-            verifyingContract: this.proxyAddress,
-        };
-        await signOrders(domain, orders, {
+        await signOrders(this.domain, orders, {
             appOwner: this.accounts.appProvider,
             datasetOwner: this.accounts.datasetProvider,
             workerpoolOwner: this.accounts.scheduler,
@@ -124,9 +150,9 @@ export class IexecWrapper {
             await IexecAccessors__factory.connect(
                 this.proxyAddress,
                 this.accounts.anyone,
-            ).viewConsumed(hashOrder(domain, requestOrder))
+            ).viewConsumed(this.hashOrder(requestOrder))
         ).toNumber();
-        const dealId = getDealId(domain, requestOrder, taskIndex);
+        const dealId = getDealId(this.domain, requestOrder, taskIndex);
         const taskId = getTaskId(dealId, taskIndex);
         const volume = Number(requestOrder.volume);
         const taskPrice =

test/utils/IexecWrapper.ts

@@ -1,12 +1,14 @@
-// SPDX-FileCopyrightText: 2023 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
+// SPDX-FileCopyrightText: 2023-2024 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
 // SPDX-License-Identifier: Apache-2.0
 
 import { TypedDataDomain } from '@ethersproject/abstract-signer';
+import { BigNumber } from '@ethersproject/bignumber';
 import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers';
 import { ethers } from 'hardhat';
 import { IexecLibOrders_v5 } from '../typechain';
-import constants from './constants';
+import constants, { NULL } from './constants';
 import { utils } from './odb-tools';
+import { OrderOperationEnum } from './poco-tools';
 
 export type Orders = [
     IexecLibOrders_v5.AppOrderStruct,
@@ -52,6 +54,12 @@ export interface IexecOrders {
     requester: IexecLibOrders_v5.RequestOrderStruct;
 }
 
+export interface OrderOperation {
+    order: Record<string, any>;
+    operation: BigNumber;
+    sign: string;
+}
+
 export function createEmptyAppOrder(): IexecLibOrders_v5.AppOrderStruct {
     return {
         app: constants.NULL.ADDRESS,
@@ -117,6 +125,13 @@ export function createEmptyDatasetOrder(): IexecLibOrders_v5.DatasetOrderStruct
     };
 }
 
+/**
+ * Create an order operation from an existing order.
+ */
+export function createOrderOperation<OrderType>(order: OrderType, operation: OrderOperationEnum) {
+    return { order, operation: BigNumber.from(operation), sign: NULL.SIGNATURE };
+}
+
 export function buildOrders(matchOrdersArgs: MatchOrdersArgs) {
     let requestOrder = createEmptyRequestOrder();
     let appOrder = createEmptyAppOrder();
@@ -240,6 +255,23 @@ export async function signOrder(
     return utils.signStruct(getTypeOf(order), order, domain, signer);
 }
 
+/**
+ * Sign an iExec EIP712 order operation for app, dataset, workerpool or request
+ * order operations.
+ */
+export async function signOrderOperation(
+    domain: TypedDataDomain,
+    orderOperation: OrderOperation,
+    signer: SignerWithAddress,
+): Promise<void> {
+    return utils.signStruct(
+        getTypeOf(orderOperation.order) + 'Operation',
+        orderOperation,
+        domain,
+        signer,
+    );
+}
+
 /**
  * Get typed data hash of order: app, dataset, workerpool or request
  * @returns order hash

utils/createOrders.ts

@@ -22,6 +22,11 @@ export enum TaskStatusEnum {
     FAILED,
 }
 
+export enum OrderOperationEnum {
+    SIGN,
+    CLOSE,
+}
+
 export interface IexecAccounts {
     iexecAdmin: SignerWithAddress;
     requester: SignerWithAddress;