Release/5.5.1 (#220)

Author: Le-Caignec

.github/workflows/main.yml

@@ -10,31 +10,50 @@ on:
       - v5
 
 jobs:
+  # Note: changing the name of the job disables Slither checks with the error:
+  # Warning: Code scanning cannot determine the alerts introduced by this pull
+  # request, because 1 configuration present on refs/heads/develop was not found:
+  #
+  # Actions workflow (main.yml)
+  # ❓ .github/workflows/main.yml:coverage
   coverage:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Init
+      - name: Set up Nodejs
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm' # Cache dependencies
+      - name: Install dependencies
         run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Check storage layout
+        run: npm run check-storage-layout
+      - name: Test deployment
+        run: npm run deploy
+      - name: Test Timelock deployment
+        run: npm run deploy:timelock
       - name: Run coverage
         run: npm run coverage
+      - name: Run partial native tests
+        run: npm run test:native
       - name: Upload coverage reports to Codecov
         uses: codecov/[email protected]
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           slug: iExecBlockchainComputing/PoCo
-      - name: Run static analysis with slither
+      - name: Run static analysis with Slither
         uses: crytic/[email protected]
-        id: slither
         with:
           target: "contracts/tools/testing/slither/"
           solc-version: '0.8.21'
           slither-args: --checklist --markdown-root ${{ github.server_url }}/${{ github.repository }}/blob/${{ github.sha }}/
-          node-version: "20"
           fail-on: none # TODO set this to high or other
           sarif: results.sarif
       - name: Upload SARIF file
         uses: github/codeql-action/upload-sarif@v3
         with:
-          sarif_file: ${{ steps.slither.outputs.sarif }}
+          sarif_file: results.sarif

.github/workflows/publish.yml

@@ -0,0 +1,11 @@
+name: Publish NPM Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/[email protected]
+    secrets:
+      npm-token: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,5 +1,6 @@
 **/__pycache__
 node_modules
+.DS_Store
 
 coverage
 coverage.json

.nvmrc

@@ -0,0 +1 @@
+20

.prettierrc

@@ -16,8 +16,14 @@
         {
           "files": "*.sol",
           "options": {
-                "singleQuote": false 
-            }    
+                "singleQuote": false
+            }
+        },
+        {
+          "files": ["**/*.json", "**/*.yml"],
+          "options": {
+                "tabWidth": 2
+            }
         }
       ]
 }

.solcover.js

@@ -17,6 +17,7 @@ module.exports = {
     },
     skipFiles: [
         'tools/Migrations.sol',
+        'tools/testing/ERC734Mock.sol',
         'tools/testing/ERC1271Mock.sol',
         'tools/testing/TestClient.sol',
         'tools/testing/TestReceiver.sol',

CHANGELOG.md

@@ -1,44 +1,106 @@
 # Changelog
 
+## v5.5.1
+
+- Add Github Action CI in order to publish NPM package
+
+### Updated contracts
+
+- [x] `IexecPoco2Delegate.sol`
+
+### Features
+
+- Housekeeping (#207)
+- Add Halborn "Poco v5.5 & Voucher v1.0" audit report (#205)
+- Refactor Factory deployer (#206)
+- Enable native tests on CI (#204)
+- Migrate to Ethers v6:
+  - Deployment scripts (#187, #203)
+  - Tests
+    - IexecEscrow (#199)
+    - ENSIntegration, IexecOrderManagement, IexecRelay (#195, #199)
+    - IexecCategoryManager, IexecERC20 (#192, #199, #202)
+    - test/*fullchain* (#190, #196)
+    - IexecAccessors, IexecMaintenance (#189, #191, #199)
+    - IexecPoco (#196)
+    - `trust` specific field (#201)
+    - IexecPocoBoost (#198)
+    - fixed a minor issue in BigInt for IexecWrapper (#202).
+- Migrate scripts to TypeScript: (#184)
+  - `getFunctionSignatures.js`, `common-test-snapshot.js`, `test-storage.js`, `timelock.js`
+- Migrated utility files to TypeScript : (#183)
+  - `FactoryDeployer.js`, `constants.js`, `odb-tools.js`
+  - Removed deprecated `scripts/ens/sidechain.js`
+- Purge Truffle leftovers (#180, #181, #182, #185, #186)
+- Sunset Jenkins pipeline (#178)
+- Re-use variable in `IexecPoco2Delegate` in `contribute(...)` function. (#168)
+- Remove unnecessary back and forth transfers in `IexecPoco2Delegate` happening during `claim(..)`. (#167)
+- Remove references to blockscout v5. (#161)
+- Migrate integration test files to Typescript & Hardhat:
+  - 000_fullchain.js (#156, #157)
+  - 00X_fullchain-Xworkers.js (#158, #159)
+  - 000_fullchain-5workers-1error.js (#160, #162)
+  - Clean ToDo (#163)
+  - 200_fullchain-bot.js (#164, #166)
+  - 201_fullchain-bot-dualPool.js (#171, #172)
+  - Fix balance checks in integration tests (#165)
+  - 300_fullchain-reopen.js (#170, #173)
+  - 000_fullchain-ABILegacy.js (#174, #175)
+  - 400_contributeAndCallback.js (#176, #177)
+- Remove `smock` from unit tests:
+  - IexecEscrow.v8 (#154, #155)
+  - IexecPocoDelegate (#149, #151)
+  - IexecPocoBoost (#148, #150, #153)
+- Migrate unit test files to Typescript & Hardhat:
+  - ERC1154 (#145, #146, #147, #152)
+  - IexecEscrowToken (#141, #143)
+  - IexecRelay (#140)
+  - IexecPoco1 (#136, #137)
+  - IexecPoco2
+    - kitty (#142, #144)
+    - reopen (#135)
+
 ## v5.5.0
 
 ### What's new?
+
 - Added the ability to sponsor a deal for a requester via the new `sponsorMatchOrders(..)` function.
-    - contracts implementation ✍️
-    - deployment on iExec Bellecour network 🚀
+  - contracts implementation ✍️
+  - deployment on iExec Bellecour network 🚀
 - Initialized « boost » mode to improve deal throughput
-    - contracts implementation ✍️
+  - contracts implementation ✍️
 
 ### More details
+
 - Include `IexecOrderManagement` module in Poco sponsoring upgrade. (#132)
 - Update function visibilities to `external` in `IexecPoco` and `IexecOrderManagement` modules. (#131)
 - Fix configs native and token. (#129)
 - Bump dependencies: (#127)
-    - `@openzeppelin/hardhat-upgrades`, `hardhat-dependency-compiler`, `web3`,
+  - `@openzeppelin/hardhat-upgrades`, `hardhat-dependency-compiler`, `web3`,
         `prettier`, `zx`, and others [minor/patch version bump]
-    - `prettier-plugin-organize-imports@4`
+  - `prettier-plugin-organize-imports@4`
 - Clean some TODOs and harmonize unit tests. (#123)
 - Add `set-callback-gas.ts` script. (#121)
 - Accept any signature format in `SignatureVerifier.v8` when the account is a smart contract. (#120)
 - Update UML class diagrams. (#112)
 - Generate Solidity documentation. (#111)
 - Migrate unit test files to Typescript & Hardhat:
-    - Resources (#125, #126)
-    - Registries (#122, #124)
-    - IexecPoco2
-        - reopen (#133)
-        - finalize (#79, #117, #119)
-        - reveal (#114, #118)
-        - contribute (#108, #109, #110)
-    - IexecPoco1 (#107, #113, #115, #116)
-    - Add `.test` suffix to unit test files (#106)
-    - ENSIntegration (#105)
-    - IexecOrderManagement (#101, #102, #103, #104)
-    - IexecMaintenance (#100)
-    - IexecEscrowNative (#99)
-    - IexecERC20 (#98)
-    - IexecCategoryManager (#97)
-    - IexecAccessors (#96)
+  - Resources (#125, #126)
+  - Registries (#122, #124)
+  - IexecPoco2
+    - reopen (#133)
+    - finalize (#79, #117, #119)
+    - reveal (#114, #118)
+    - contribute (#108, #109, #110)
+  - IexecPoco1 (#107, #113, #115, #116)
+  - Add `.test` suffix to unit test files (#106)
+  - ENSIntegration (#105)
+  - IexecOrderManagement (#101, #102, #103, #104)
+  - IexecMaintenance (#100)
+  - IexecEscrowNative (#99)
+  - IexecERC20 (#98)
+  - IexecCategoryManager (#97)
+  - IexecAccessors (#96)
 - Wait for transactions occurring during deployment. (#95)
 - Deploy and configure ENS with hardhat. (#93)
 - Fix contribute & finalize with callbacks. (#92)
@@ -54,23 +116,23 @@
 - Refund sponsor on `claim`. (#77)
 - Sponsor match orders boost. (#67, #78)
 - Migrate to hardhat tests related to:
-    - `initialize` (#74, #75)
-    - `claim` (#65, #66, #72, #76)
+  - `initialize` (#74, #75)
+  - `claim` (#65, #66, #72, #76)
 - Upgrade Poco2 to solidity v0.8 . (#63)
 - Use common helpers in Poco Boost integration tests. (#62)
 - Upload coverage reports to Codecov. (#61)
 - Deploy contracts in tests explicitly with hardhat or truffle fixture. (#59)
 - Add the ability to deploy without truffle fixture. (#58)
 - Sponsor match orders. (#57, #60)
 - Upgrade Poco1 to solidity `^0.8.0` (#55):
-    - Migrate to `openzeppelin@v5`
-    - Migrate to `SignatureVerifier.v8`
+  - Migrate to `openzeppelin@v5`
+  - Migrate to `SignatureVerifier.v8`
 - Change MNEMONIC var name for production & clean Hardhat file. (#53)
 - Format files & update copyright notices:
-    - DelegateBase, IexecERC20Core (#64)
-    - PoCo2 contracts (#54)
-    - PoCo1 contracts (#52)
-    - Order Management contract (#83)
+  - DelegateBase, IexecERC20Core (#64)
+  - PoCo2 contracts (#54)
+  - PoCo1 contracts (#52)
+  - Order Management contract (#83)
 - Remove enterprise mode. (#51, #56)
 - Add PoCo Boost modules to a timelock controlled proxy.
 - Add IexecEscrow.v8 tests and developer notices.
@@ -97,50 +159,50 @@
 - Refactor tests.
 - Add dedicated Poco Boost accessors.
 - Implement `claimBoost`:
-    - Refund requester.
-    - Seize workerpool and reward kitty.
+  - Refund requester.
+  - Seize workerpool and reward kitty.
 - Implement `pushResultBoost`:
-    - Verify task exists.
-    - Push result before deadline.
-    - Require enclave challenge when TEE bit of tag set.
-    - Verify signatures
-        - scheduler
-        - enclave
-        - tee broker
-    - Reward worker.
-    - Reward app provider.
-    - Reward dataset provider.
-    - Unlock scheduler stake.
-    - Reward scheduler.
-    - Handle callback.
+  - Verify task exists.
+  - Push result before deadline.
+  - Require enclave challenge when TEE bit of tag set.
+  - Verify signatures
+    - scheduler
+    - enclave
+    - tee broker
+  - Reward worker.
+  - Reward app provider.
+  - Reward dataset provider.
+  - Unlock scheduler stake.
+  - Reward scheduler.
+  - Handle callback.
 - Implement `matchOrdersBoost`:
-    - Verify compatibility of orders
-        - trust
-        - category
-        - price
-        - tag
-        - restrictions
-            - Assets or requester belong to groups in ERC734 identity contract.
-    - Verify entries are registered & category exists.
-    - Verify signatures or presignatures of orders.
+  - Verify compatibility of orders
+    - trust
+    - category
+    - price
+    - tag
+    - restrictions
+      - Assets or requester belong to groups in ERC734 identity contract.
+  - Verify entries are registered & category exists.
+  - Verify signatures or presignatures of orders.
             - ERC1271 contracts can be signers of orders.
-    - Compute volume & consume orders.
-    - Lock requester deal value.
-    - Store deal.
-    - Emit events.
-    - Lock scheduler stake.
-    - Return `dealId`.
-    - Reduce gas footprint:
-        - Remove beneficiary from deal storage.
-        - Reduce Boost deal storage from 6 to 5 slots.
-        - Reduce gas consumption on `lock()` calls.
-        - Cache addresses of assets and requester from arguments.
-        - Init local vars and cache order category.
-        - Optimize deal storing by slot.
-        - Change local structure for local variables.
-        - Store in variable if read multiple times.
-        - Group `hasDataset` block.
-    - Remove useless variable.
+  - Compute volume & consume orders.
+  - Lock requester deal value.
+  - Store deal.
+  - Emit events.
+  - Lock scheduler stake.
+  - Return `dealId`.
+  - Reduce gas footprint:
+    - Remove beneficiary from deal storage.
+    - Reduce Boost deal storage from 6 to 5 slots.
+    - Reduce gas consumption on `lock()` calls.
+    - Cache addresses of assets and requester from arguments.
+    - Init local vars and cache order category.
+    - Optimize deal storing by slot.
+    - Change local structure for local variables.
+    - Store in variable if read multiple times.
+    - Group `hasDataset` block.
+  - Remove useless variable.
 - Update prettier rules and reformat.
 - Migrate `IexecPocoBoost` linking to hardhat deploy script.
 - Clean files related to docker build of a test blockchain.
@@ -151,25 +213,26 @@
 - Deploy Nominal and Boost modules with Hardhat.
 - Upgrade `hashStruct` function to use `ethers`.
 - Add Boost module.
-    - Add interfaces.
+  - Add interfaces.
 - Add `Store` contract compatible with solidity `^0.8.0`.
 - Update documentation:
-    - Generate class diagrams from solidity contracts.
-    - Add task and contribution state diagrams.
-    - Add boost workflow sequence diagram. Update nominal workflow sequence diagram.
-    - Update TEE workflow sequence diagram.
-    - Update actors diagram.
-    - Rename UMLs.md file to standard README.md.
-    - Add inline solidity documentation.
-    - Update class diagrams.
-    - Create folder docs that contains all documentation material.
+  - Generate class diagrams from solidity contracts.
+  - Add task and contribution state diagrams.
+  - Add boost workflow sequence diagram. Update nominal workflow sequence diagram.
+  - Update TEE workflow sequence diagram.
+  - Update actors diagram.
+  - Rename UMLs.md file to standard README.md.
+  - Add inline solidity documentation.
+  - Update class diagrams.
+  - Create folder docs that contains all documentation material.
 - Migrate to Hardhat:
-    - Init Hardhat project.
-    - Migrate unit tests with `@nomiclabs/hardhat-truffle5`.
-    - Fetch `@iexec/[email protected]` from default public registry.
-    - Migrate tests coverage with [solidity-coverage](https://github.com/sc-forks/solidity-coverage) of `@nomicfoundation/hardhat-toolbox`.
+  - Init Hardhat project.
+  - Migrate unit tests with `@nomiclabs/hardhat-truffle5`.
+  - Fetch `@iexec/[email protected]` from default public registry.
+  - Migrate tests coverage with [solidity-coverage](https://github.com/sc-forks/solidity-coverage) of `@nomicfoundation/hardhat-toolbox`.
 
 ## v5.4.2
+
 - Use latest Nethermind base image `nethermindeth/nethermind:iexec`
 (saved internally at `nexus.intra.iex.ec/nethermind:1.18.x-0`)
 containing a fix for [#5506](https://github.com/NethermindEth/nethermind/issues/5506).