|
| 1 | +// SPDX-FileCopyrightText: 2024 IEXEC BLOCKCHAIN TECH <[email protected]> |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +import { loadFixture } from '@nomicfoundation/hardhat-network-helpers'; |
| 5 | +import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers'; |
| 6 | +import { ethers, expect } from 'hardhat'; |
| 7 | +import { loadHardhatFixtureDeployment } from '../scripts/hardhat-fixture-deployer'; |
| 8 | +import { |
| 9 | + IexecInterfaceNative, |
| 10 | + IexecInterfaceNative__factory, |
| 11 | + IexecPocoAccessors, |
| 12 | + IexecPocoAccessors__factory, |
| 13 | +} from '../typechain'; |
| 14 | +import { |
| 15 | + IexecOrders, |
| 16 | + OrdersActors, |
| 17 | + OrdersAssets, |
| 18 | + OrdersPrices, |
| 19 | + buildOrders, |
| 20 | +} from '../utils/createOrders'; |
| 21 | +import { |
| 22 | + PocoMode, |
| 23 | + TaskStatusEnum, |
| 24 | + buildUtf8ResultAndDigest, |
| 25 | + getIexecAccounts, |
| 26 | +} from '../utils/poco-tools'; |
| 27 | +import { IexecWrapper } from './utils/IexecWrapper'; |
| 28 | + |
| 29 | +const standardDealTag = '0x0000000000000000000000000000000000000000000000000000000000000000'; |
| 30 | +const appPrice = 1000; |
| 31 | +const datasetPrice = 1_000_000; |
| 32 | +const workerpoolPrice1 = 1_000_000_015; |
| 33 | +const workerpoolPrice2 = 1_000_000_025; |
| 34 | +const { results, resultDigest } = buildUtf8ResultAndDigest('result'); |
| 35 | + |
| 36 | +let proxyAddress: string; |
| 37 | +let iexecPoco: IexecInterfaceNative; |
| 38 | +let iexecPocoAccessors: IexecPocoAccessors; // To use `computeDealVolume()` |
| 39 | +let iexecWrapper: IexecWrapper; |
| 40 | +let [appAddress, workerpoolAddress, datasetAddress]: string[] = []; |
| 41 | +let [requester, appProvider, datasetProvider, scheduler, anyone, worker1]: SignerWithAddress[] = []; |
| 42 | +let ordersActors: OrdersActors; |
| 43 | +let ordersAssets: OrdersAssets; |
| 44 | +let ordersPrices: OrdersPrices; |
| 45 | + |
| 46 | +describe('Integration tests', function () { |
| 47 | + beforeEach('Deploy', async () => { |
| 48 | + // Deploy all contracts |
| 49 | + proxyAddress = await loadHardhatFixtureDeployment(); |
| 50 | + // Initialize test environment |
| 51 | + await loadFixture(initFixture); |
| 52 | + }); |
| 53 | + |
| 54 | + async function initFixture() { |
| 55 | + const accounts = await getIexecAccounts(); |
| 56 | + ({ requester, appProvider, datasetProvider, scheduler, anyone, worker1 } = accounts); |
| 57 | + iexecWrapper = new IexecWrapper(proxyAddress, accounts); |
| 58 | + ({ appAddress, datasetAddress, workerpoolAddress } = await iexecWrapper.createAssets()); |
| 59 | + iexecPoco = IexecInterfaceNative__factory.connect(proxyAddress, anyone); |
| 60 | + iexecPocoAccessors = IexecPocoAccessors__factory.connect(proxyAddress, ethers.provider); |
| 61 | + ordersActors = { |
| 62 | + appOwner: appProvider, |
| 63 | + datasetOwner: datasetProvider, |
| 64 | + workerpoolOwner: scheduler, |
| 65 | + requester: requester, |
| 66 | + }; |
| 67 | + ordersAssets = { |
| 68 | + app: appAddress, |
| 69 | + dataset: datasetAddress, |
| 70 | + workerpool: workerpoolAddress, |
| 71 | + }; |
| 72 | + ordersPrices = { |
| 73 | + app: appPrice, |
| 74 | + dataset: datasetPrice, |
| 75 | + workerpool: 0, // Overridden below. |
| 76 | + }; |
| 77 | + } |
| 78 | + |
| 79 | + /** |
| 80 | + * A test to run full workflow (matchOrders..finalize) with 2 orders having 2 different volumes |
| 81 | + * for the same workerpool and only 1 request order. |
| 82 | + */ |
| 83 | + it('[1] No sponsorship, no beneficiary, no callback, BoT, no replication, 2 workerpool orders', async function () { |
| 84 | + const volume = 3; |
| 85 | + const workerpoolOrderVolume1 = 2; |
| 86 | + const workerpoolOrderVolume2 = 10; |
| 87 | + const dealVolume1 = Math.min(workerpoolOrderVolume1, volume); // min(2, 3); |
| 88 | + const dealVolume2 = Math.min(workerpoolOrderVolume2, volume - dealVolume1); // min(10, 1) |
| 89 | + const taskPrice1 = appPrice + datasetPrice + workerpoolPrice1; |
| 90 | + const taskPrice2 = appPrice + datasetPrice + workerpoolPrice2; |
| 91 | + // Create default orders. |
| 92 | + const { |
| 93 | + appOrder, |
| 94 | + datasetOrder, |
| 95 | + workerpoolOrder, |
| 96 | + requesterOrder: requestOrder, |
| 97 | + } = buildOrders({ |
| 98 | + assets: ordersAssets, |
| 99 | + prices: ordersPrices, |
| 100 | + requester: requester.address, |
| 101 | + tag: standardDealTag, |
| 102 | + volume, |
| 103 | + }).toObject(); |
| 104 | + // Create 2 different orders for the same workerpool. |
| 105 | + const workerpoolOrder1 = { ...workerpoolOrder }; // Shallow cloning is fine here. |
| 106 | + const workerpoolOrder2 = { ...workerpoolOrder }; |
| 107 | + workerpoolOrder1.volume = workerpoolOrderVolume1; |
| 108 | + workerpoolOrder1.workerpoolprice = workerpoolPrice1; |
| 109 | + workerpoolOrder2.volume = workerpoolOrderVolume2; |
| 110 | + workerpoolOrder2.workerpoolprice = workerpoolPrice2; |
| 111 | + requestOrder.workerpoolmaxprice = Math.max(workerpoolPrice1, workerpoolPrice2); |
| 112 | + // Match both workerpool orders with the same request order. |
| 113 | + const dealOrders1 = new IexecOrders( |
| 114 | + appOrder, |
| 115 | + datasetOrder, |
| 116 | + workerpoolOrder1, |
| 117 | + requestOrder, |
| 118 | + ).toArray(); |
| 119 | + const dealOrders2 = new IexecOrders( |
| 120 | + appOrder, |
| 121 | + datasetOrder, |
| 122 | + workerpoolOrder2, |
| 123 | + requestOrder, |
| 124 | + ).toArray(); |
| 125 | + expect(await iexecPocoAccessors.computeDealVolume(...dealOrders1)).to.equal(dealVolume1); |
| 126 | + const { |
| 127 | + dealId: dealId1, |
| 128 | + taskIndex: taskIndex1, |
| 129 | + schedulerStakePerDeal: schedulerStakeForDeal1, |
| 130 | + } = await iexecWrapper.signAndMatchOrders( |
| 131 | + appOrder, |
| 132 | + datasetOrder, |
| 133 | + workerpoolOrder1, |
| 134 | + requestOrder, |
| 135 | + ); // First task index is 0. |
| 136 | + expect(await iexecPocoAccessors.computeDealVolume(...dealOrders2)).to.equal(dealVolume2); |
| 137 | + const { |
| 138 | + dealId: dealId2, |
| 139 | + taskIndex: taskIndex2, |
| 140 | + schedulerStakePerDeal: schedulerStakeForDeal2, |
| 141 | + } = await iexecWrapper.signAndMatchOrders( |
| 142 | + appOrder, |
| 143 | + datasetOrder, |
| 144 | + workerpoolOrder2, |
| 145 | + requestOrder, |
| 146 | + ); // First task index is 2. |
| 147 | + const deal1 = await iexecPoco.viewDeal(dealId1); |
| 148 | + expect(deal1.botFirst).to.equal(0); |
| 149 | + expect(deal1.botSize).to.equal(dealVolume1); |
| 150 | + const deal2 = await iexecPoco.viewDeal(dealId2); |
| 151 | + expect(deal2.botFirst).to.equal(dealVolume1); |
| 152 | + expect(deal2.botSize).to.equal(dealVolume2); |
| 153 | + // Compute stakes and rewards for each deal. |
| 154 | + const schedulerStakePerTaskOfDeal1 = schedulerStakeForDeal1 / dealVolume1; |
| 155 | + const schedulerStakePerTaskOfDeal2 = schedulerStakeForDeal2 / dealVolume2; |
| 156 | + const workersRewardPerTaskOfDeal1 = await iexecWrapper.computeWorkersRewardPerTask( |
| 157 | + dealId1, |
| 158 | + PocoMode.CLASSIC, |
| 159 | + ); |
| 160 | + const workersRewardPerTaskOfDeal2 = await iexecWrapper.computeWorkersRewardPerTask( |
| 161 | + dealId2, |
| 162 | + PocoMode.CLASSIC, |
| 163 | + ); |
| 164 | + const schedulerRewardPerTaskOfDeal1 = workerpoolPrice1 - workersRewardPerTaskOfDeal1; |
| 165 | + const schedulerRewardPerTaskOfDeal2 = workerpoolPrice2 - workersRewardPerTaskOfDeal2; |
| 166 | + // Finalize each task and run checks. |
| 167 | + await runTaskThenCheckBalancesAndVolumes( |
| 168 | + dealId1, |
| 169 | + taskIndex1, |
| 170 | + taskPrice1, |
| 171 | + schedulerStakePerTaskOfDeal1, |
| 172 | + schedulerRewardPerTaskOfDeal1, |
| 173 | + workersRewardPerTaskOfDeal1, |
| 174 | + ); |
| 175 | + await runTaskThenCheckBalancesAndVolumes( |
| 176 | + dealId1, |
| 177 | + taskIndex1 + 1, |
| 178 | + taskPrice1, |
| 179 | + schedulerStakePerTaskOfDeal1, |
| 180 | + schedulerRewardPerTaskOfDeal1, |
| 181 | + workersRewardPerTaskOfDeal1, |
| 182 | + ); |
| 183 | + await runTaskThenCheckBalancesAndVolumes( |
| 184 | + dealId2, |
| 185 | + taskIndex2, |
| 186 | + taskPrice2, |
| 187 | + schedulerStakePerTaskOfDeal2, |
| 188 | + schedulerRewardPerTaskOfDeal2, |
| 189 | + workersRewardPerTaskOfDeal2, |
| 190 | + ); |
| 191 | + // Check remaining volumes. |
| 192 | + expect(await iexecPoco.viewConsumed(iexecWrapper.hashOrder(requestOrder))).to.equal(volume); |
| 193 | + expect(await iexecPoco.viewConsumed(iexecWrapper.hashOrder(workerpoolOrder1))).to.equal( |
| 194 | + dealVolume1, |
| 195 | + ); |
| 196 | + expect(await iexecPoco.viewConsumed(iexecWrapper.hashOrder(workerpoolOrder2))).to.equal( |
| 197 | + dealVolume2, |
| 198 | + ); |
| 199 | + }); |
| 200 | + |
| 201 | + async function runTaskThenCheckBalancesAndVolumes( |
| 202 | + dealId: string, |
| 203 | + taskIndex: number, |
| 204 | + taskPrice: number, |
| 205 | + schedulerStake: number, |
| 206 | + schedulerReward: number, |
| 207 | + workerReward: number, |
| 208 | + ) { |
| 209 | + // Save frozens before task execution. |
| 210 | + const accounts = [requester, scheduler, appProvider, datasetProvider, worker1]; |
| 211 | + const accountsInitialFrozens = await iexecWrapper.getInitialFrozens(accounts); |
| 212 | + // Run task. |
| 213 | + const taskId = await iexecWrapper.initializeTask(dealId, taskIndex); |
| 214 | + const { workerStakePerTask: workerStake } = await iexecWrapper.contributeToTask( |
| 215 | + dealId, |
| 216 | + taskIndex, |
| 217 | + resultDigest, |
| 218 | + worker1, |
| 219 | + ); |
| 220 | + await iexecPoco |
| 221 | + .connect(worker1) |
| 222 | + .reveal(taskId, resultDigest) |
| 223 | + .then((tx) => tx.wait()); |
| 224 | + const finalizeTx = await iexecPoco.connect(scheduler).finalize(taskId, results, '0x'); |
| 225 | + await finalizeTx.wait(); |
| 226 | + // Check task. |
| 227 | + const task = await iexecPoco.viewTask(taskId); |
| 228 | + expect(task.status).to.equal(TaskStatusEnum.COMPLETED); |
| 229 | + expect(task.idx).to.equal(taskIndex); |
| 230 | + // Verify token balance changes. |
| 231 | + const expectedProxyBalanceChange = -(taskPrice + schedulerStake + workerStake); |
| 232 | + await expect(finalizeTx).to.changeTokenBalances( |
| 233 | + iexecPoco, |
| 234 | + [proxyAddress, requester, scheduler, appProvider, datasetProvider, worker1], |
| 235 | + [ |
| 236 | + expectedProxyBalanceChange, // Proxy |
| 237 | + 0, // Requester |
| 238 | + schedulerStake + schedulerReward, // Scheduler |
| 239 | + appPrice, // AppProvider |
| 240 | + datasetPrice, // DatasetProvider |
| 241 | + workerStake + workerReward, // Worker |
| 242 | + ], |
| 243 | + ); |
| 244 | + // Calculate expected frozen changes |
| 245 | + const expectedFrozenChanges = [ |
| 246 | + 0, // Proxy |
| 247 | + -taskPrice, // Requester |
| 248 | + -schedulerStake, // Scheduler |
| 249 | + 0, // AppProvider |
| 250 | + 0, // DatasetProvider |
| 251 | + 0, // Worker |
| 252 | + ]; |
| 253 | + await iexecWrapper.checkFrozenChanges(accountsInitialFrozens, expectedFrozenChanges); |
| 254 | + } |
| 255 | +}); |
0 commit comments