fix: Fix build with new storage layout (#237)

zguesmi · web-flow · commit efa1d228657b · 2025-07-28T11:53:20.000+02:00
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,10 @@
+
+artifacts/
+audit/
+build/
+cache/
+coverage/
+coverage.json
+deployments/
+node_modules/
+typechain/
diff --git a/contracts/modules/facets/IexecAccessorsABILegacyFacet.sol b/contracts/modules/facets/IexecAccessorsABILegacyFacet.sol
@@ -82,8 +82,8 @@ contract IexecAccessorsABILegacyFacet is IexecAccessorsABILegacy, FacetBase {
             bytes memory
         )
     {
-        PocoStorage storage $ = getPocoStorage();
-        IexecLibCore_v5.Task memory task = $.m_tasks[_taskid];
+        /// @dev Using $.m_tasks causes "Stack too deep" error.
+        IexecLibCore_v5.Task memory task = getPocoStorage().m_tasks[_taskid];
         return (
             task.status,
             task.dealid,
@@ -110,9 +110,7 @@ contract IexecAccessorsABILegacyFacet is IexecAccessorsABILegacy, FacetBase {
         returns (IexecLibCore_v5.ContributionStatusEnum, bytes32, bytes32, address)
     {
         PocoStorage storage $ = getPocoStorage();
-        IexecLibCore_v5.Contribution memory contribution = $.m_contributions[
-            _taskid
-        ][_worker];
+        IexecLibCore_v5.Contribution memory contribution = $.m_contributions[_taskid][_worker];
         return (
             contribution.status,
             contribution.resultHash,
diff --git a/contracts/modules/facets/IexecPocoBoostFacet.sol b/contracts/modules/facets/IexecPocoBoostFacet.sol
@@ -406,13 +406,18 @@ contract IexecPocoBoostFacet is
             "PocoBoost: Invalid contribution authorization signature"
         );
         address target = deal.callback;
-        bytes32 resultDigest = keccak256(target == address(0) ? results : resultsCallback);
         // Check enclave signature
         require(
             enclaveChallenge == address(0) ||
                 _verifySignatureOfEthSignedMessage(
                     enclaveChallenge,
-                    abi.encodePacked(msg.sender, taskId, resultDigest),
+                    abi.encodePacked(
+                        msg.sender,
+                        taskId,
+                        // Result digest
+                        /// @dev extracting it in a variable causes "Stack too deep" error.
+                        keccak256(target == address(0) ? results : resultsCallback)
+                    ),
                     enclaveSign
                 ),
             "PocoBoost: Invalid enclave signature"
@@ -469,10 +474,10 @@ contract IexecPocoBoostFacet is
         if (target != address(0)) {
             require(resultsCallback.length > 0, "PocoBoost: Callback requires data");
             /*
-             * The caller must be able to complete the task even if the external
-             * call reverts.
+             * The caller (worker) must be able to complete the task even if the external
+             * call reverts, hence we don't check the success of the call.
+             * See Halborn audit report for details.
              */
-            // See Halborn audit report for details
             //slither-disable-next-line low-level-calls
             (bool success, ) = target.call{gas: $.m_callbackgas}(
                 abi.encodeCall(IOracleConsumer.receiveResult, (taskId, resultsCallback))
diff --git a/deploy/0_deploy.ts b/deploy/0_deploy.ts
@@ -181,7 +181,7 @@ export default async function deploy() {
                 rlcInstanceAddress,
                 'Staked RLC',
                 'SRLC',
-                9, // TODO: generic ?
+                9,
                 appRegistryAddress,
                 datasetRegistryAddress,
                 workerpoolRegistryAddress,
diff --git a/package.json b/package.json
@@ -19,7 +19,7 @@
     "test:native": "npm run clean && TEST__IS_NATIVE_CHAIN=true npx hardhat test test/byContract/IexecEscrow/IexecEscrowNative.test.ts",
     "coverage": "npx hardhat coverage",
     "verify": "npx hardhat verify",
-    "format": "npx prettier --write ./contracts/**/*.sol",
+    "format": "npx prettier --write '**/*.{js,ts,sol,json,yml}'",
     "uml": "npm run sol-to-uml && npm run puml-to-links && npm run storage-to-diagrams",
     "sol-to-uml": "npx zx scripts/tools/sol-to-uml.mjs",
     "puml-to-links": "npx zx scripts/tools/puml-to-links.mjs",
@@ -86,4 +86,4 @@
     "sol2uml": "After 2.5.19, see https://github.com/naddison36/sol2uml/issues/183",
     "solidity-coverage": "Fixing Hardhat's solidity-coverage: TypeError: provider.send is not a function"
   }
-}
+}
diff --git a/test/byContract/IexecAccessors/IexecAccessors.test.ts b/test/byContract/IexecAccessors/IexecAccessors.test.ts
@@ -209,8 +209,7 @@ describe('IexecAccessors', async () => {
         expect(contribution.weight).to.equal(1);
     });
 
-    it('viewScore', async function () {
-        // TODO
+    it.skip('[TODO] viewScore', async function () {
         expect(await iexecPoco.viewScore(worker1.address)).to.equal(0);
     });
 
diff --git a/test/byContract/IexecConfiguration/IexecConfiguration.test.ts b/test/byContract/IexecConfiguration/IexecConfiguration.test.ts
@@ -13,6 +13,7 @@ import {
     IexecInterfaceNative__factory,
 } from '../../../typechain';
 import { getIexecAccounts } from '../../../utils/poco-tools';
+import { getPocoStorageSlotLocation } from '../../../utils/proxy-tools';
 import { loadHardhatFixtureDeployment } from '../../utils/hardhat-fixture-deployer';
 import { hashDomain } from '../../utils/utils';
 
@@ -113,20 +114,21 @@ describe('IexecConfiguration', async () => {
     });
 
     describe('Import score', () => {
-        it('[TODO] Should import score', async () => {
-            // Not tested
-        });
+        it.skip('[TODO] Should import score', async () => {});
+
         it('Should not import score when no v3_iexecHub configured', async () => {
             await expect(iexecPoco.importScore(worker.address)).to.be.revertedWithoutReason();
         });
+
         it('Should not import score when already imported', async () => {
             const workerScoreImportedSlot = ethers.stripZerosLeft(
                 ethers.keccak256(
                     ethers.AbiCoder.defaultAbiCoder().encode(
                         ['address', 'uint256'],
                         [
                             worker.address,
-                            23, // Slot index of m_v3_scoreImported in Store
+                            // 23 is the slot index of m_v3_scoreImported in Store
+                            getPocoStorageSlotLocation(23n),
                         ],
                     ),
                 ),
@@ -203,7 +205,7 @@ describe('IexecConfiguration', async () => {
     async function setDomainSeparatorInStorage(domainSeparator: string) {
         await setStorageAt(
             proxyAddress,
-            '0x0b', // Slot index of EIP712DOMAIN_SEPARATOR in Store
+            getPocoStorageSlotLocation(11n), // 11 is the slot index of EIP712DOMAIN_SEPARATOR in Store
             domainSeparator,
         );
         // Double check the update of the domain separator happened
diff --git a/test/byContract/IexecEscrow/IexecEscrowNative.test.ts b/test/byContract/IexecEscrow/IexecEscrowNative.test.ts
@@ -10,6 +10,7 @@ import { ethers } from 'hardhat';
 import { IexecInterfaceNative, IexecInterfaceNative__factory } from '../../../typechain';
 import config from '../../../utils/config';
 import { getIexecAccounts } from '../../../utils/poco-tools';
+import { getPocoStorageSlotLocation } from '../../../utils/proxy-tools';
 import { loadHardhatFixtureDeployment } from '../../utils/hardhat-fixture-deployer';
 import { setZeroAddressBalance } from '../../utils/utils';
 
@@ -75,7 +76,6 @@ if (config.isNativeChain()) {
             });
         });
 
-        // TODO 'Should deposit with zero value'
         describe('Deposit', () => {
             it('Should deposit native tokens', async () => {
                 expect(await iexecPocoAsAccountA.deposit.staticCall(...depositArgs)).to.be.true;
@@ -105,6 +105,16 @@ if (config.isNativeChain()) {
                     .withArgs(AddressZero, accountA.address, depositAmount);
             });
 
+            it('Should deposit amount zero', async () => {
+                expect(await iexecPocoAsAccountA.deposit.staticCall({ value: 0 })).to.be.true;
+                const tx = iexecPocoAsAccountA.deposit({ value: 0 });
+                await expect(tx).to.changeEtherBalances([accountA, iexecPoco], [0, 0]);
+                await expect(tx).to.changeTokenBalances(iexecPoco, [accountA], [0]);
+                await expect(tx)
+                    .to.emit(iexecPoco, 'Transfer')
+                    .withArgs(AddressZero, accountA.address, 0);
+            });
+
             it('Should not deposit native tokens when caller is address 0', async () => {
                 const zeroAddressSigner = await ethers.getImpersonatedSigner(ZeroAddress);
                 const iexecPocoAsAddress0 = iexecPoco.connect(zeroAddressSigner);
@@ -214,7 +224,6 @@ if (config.isNativeChain()) {
             });
         });
 
-        // TODO 'Should withdraw with zero value'
         describe('Withdraw', () => {
             it('Should withdraw native tokens', async () => {
                 await iexecPocoAsAccountA.deposit(...depositArgs);
@@ -231,6 +240,19 @@ if (config.isNativeChain()) {
                     .withArgs(accountA.address, AddressZero, withdrawAmount);
             });
 
+            it('Should withdraw amount zero', async () => {
+                await iexecPocoAsAccountA.deposit(...depositArgs);
+                expect(await iexecPocoAsAccountA.withdraw.staticCall(0)).to.be.true;
+                const tx = iexecPocoAsAccountA.withdraw(0);
+                await expect(tx).to.changeEtherBalances([accountA, iexecPoco], [0, 0]);
+                await expect(tx).to.changeTokenBalances(iexecPoco, [accountA], [0]);
+                await expect(tx)
+                    .to.emit(iexecPoco, 'Transfer')
+                    .withArgs(accountA.address, AddressZero, 0);
+                // User balance haven't changed.
+                expect(await iexecPoco.balanceOf(accountA.address)).to.equal(depositAmount);
+            });
+
             it('Should not withdraw native tokens with empty balance', async () => {
                 await expect(
                     iexecPocoAsAccountA.withdraw(...withdrawArg),
@@ -291,7 +313,7 @@ if (config.isNativeChain()) {
                 const expectedDelta = 5n;
                 await setStorageAt(
                     proxyAddress,
-                    '0x07', // Slot index of `m_totalSupply` in Store
+                    getPocoStorageSlotLocation(7n), // 7 is the slot index of `m_totalSupply` in Store
                     ethers.toBeHex(initTotalSupply - expectedDelta),
                 );
                 expect(await iexecPoco.totalSupply()).to.equal(
diff --git a/test/byContract/IexecPoco/IexecPoco1.test.ts b/test/byContract/IexecPoco/IexecPoco1.test.ts
@@ -942,7 +942,7 @@ describe('IexecPoco1', () => {
             // const appOrderConsumedSlotIndex = ethers.keccak256(
             //     ethers.concat([
             //         appOrderHash, // key in the mapping.
-            //         '0x12', // m_consumed mapping index.
+            //         getPocoStorageSlotLocation(12n), // 12 is the slot index of `m_consumed` in Store.
             //     ])
             // );
             // // Set order as fully consumed.
diff --git a/test/byContract/IexecPoco/IexecPoco2-contribute-and-finalize.test.ts b/test/byContract/IexecPoco/IexecPoco2-contribute-and-finalize.test.ts
@@ -350,7 +350,7 @@ describe('IexecPoco2#contributeAndFinalize', () => {
         ).to.be.revertedWithoutReason(); // require#2
     });
 
-    it('Should not contributeAndFinalize when someone else has already contributed', async () => {
+    it.skip('[TODO] Should not contributeAndFinalize when someone else has already contributed', async () => {
         // TODO require#3
     });
 
diff --git a/test/byContract/IexecPoco/IexecPoco2-finalize.test.ts b/test/byContract/IexecPoco/IexecPoco2-finalize.test.ts
@@ -21,6 +21,7 @@ import {
     buildUtf8ResultAndDigest,
     getIexecAccounts,
 } from '../../../utils/poco-tools';
+import { getPocoStorageSlotLocation } from '../../../utils/proxy-tools';
 import { IexecWrapper } from '../../utils/IexecWrapper';
 import { loadHardhatFixtureDeployment } from '../../utils/hardhat-fixture-deployer';
 
@@ -879,7 +880,7 @@ describe('IexecPoco2#finalize', async () => {
                     ['address', 'uint256'],
                     [
                         worker,
-                        18, // Slot index of m_workerScores in Store
+                        getPocoStorageSlotLocation(18n), // 18 is the slot index of m_workerScores in Store
                     ],
                 ),
             ),
diff --git a/utils/proxy-tools.ts b/utils/proxy-tools.ts
@@ -7,9 +7,15 @@ import { FacetCut, FacetCutAction } from 'hardhat-deploy/dist/types';
 import { DiamondCutFacet, DiamondLoupeFacet__factory } from '../typechain';
 import { getBaseNameFromContractFactory } from '../utils/deploy-tools';
 
-interface AbiParameter {
-    type: string;
-    components?: AbiParameter[];
+const POCO_STORAGE_LOCATION = '0x5862653c6982c162832160cf30593645e8487b257e44d77cdd6b51eee2651b00';
+
+/**
+ * Get the slot location of a storage variable in the `PocoStorage` struct.
+ * @param offset The offset to add to the base location.
+ * @returns The storage slot location as a hexadecimal string.
+ */
+export function getPocoStorageSlotLocation(offset: bigint): string {
+    return ethers.toBeHex(BigInt(POCO_STORAGE_LOCATION) + offset);
 }
 
 /**
