Refactor test utilities and handlers for improved readability and consistency

- Updated formatting in loadFixture.test.js for better code structure and readability.
- Enhanced getEventFromLogs function in utils.js for clarity.
- Reformatted Invariant.t.sol to improve code legibility.
- Refactored HandlerCollection.sol to enhance readability and maintainability.
- Improved HandlerGlobal.sol by restructuring constant declarations for clarity.
- Refined HandlerRenting.sol to enhance code readability.
- Enhanced HandlerSale.sol for better code structure.
- Improved HandlerSubscription.sol for clarity and consistency.
- Updated storage-to-diagrams.js to include eslint-disable comment for unused vars.
- Removed .eslintignore file and integrated ignore patterns into eslint.config.mjs for better configuration management.

Author: Le-Caignec

packages/sharing-smart-contract/.env.template

@@ -2,7 +2,7 @@
 WALLET_PRIVATE_KEY=...
 
 # environment to use for configuration (prod/staging)
-ENV=prod
+ENV=...
 
 # IExec PoCo contract address override (deploy script only)
 POCO_ADDRESS=...

packages/sharing-smart-contract/.eslintignore

@@ -195,7 +195,7 @@
   },
   {
     "inputs": [],
-    "name": "FailedInnerCall",
+    "name": "FailedCall",
     "type": "error"
   },
   {

packages/sharing-smart-contract/.eslintrc.json

@@ -4,11 +4,6 @@
     "stateMutability": "nonpayable",
     "type": "constructor"
   },
-  {
-    "inputs": [],
-    "name": "ERC1167FailedCreateClone",
-    "type": "error"
-  },
   {
     "inputs": [
       {
@@ -112,6 +107,27 @@
     "name": "ERC721NonexistentToken",
     "type": "error"
   },
+  {
+    "inputs": [],
+    "name": "FailedDeployment",
+    "type": "error"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "uint256",
+        "name": "balance",
+        "type": "uint256"
+      },
+      {
+        "internalType": "uint256",
+        "name": "needed",
+        "type": "uint256"
+      }
+    ],
+    "name": "InsufficientBalance",
+    "type": "error"
+  },
   {
     "inputs": [],
     "name": "InvalidInitialization",

packages/sharing-smart-contract/abis/DataProtectorSharing.sol/DataProtectorSharing.json

@@ -166,7 +166,12 @@ contract DataProtectorSharing is
             _workerpoolOrder.category
         );
 
-        dealid = POCO_DELEGATE.matchOrders(_appOrder, _datasetOrder, _workerpoolOrder, requestOrder);
+        dealid = POCO_DELEGATE.matchOrders(
+            _appOrder,
+            _datasetOrder,
+            _workerpoolOrder,
+            requestOrder
+        );
         emit ProtectedDataConsumed(dealid, _protectedData, _mode);
     }
 
@@ -178,7 +183,11 @@ contract DataProtectorSharing is
 
     // Overide burn function from ERC721BurnableUpgradeable.
     // Enable to burn a collectionTokenID.
-    function _update(address to, uint256 _collectionTokenId, address auth) internal virtual override returns (address) {
+    function _update(
+        address to,
+        uint256 _collectionTokenId,
+        address auth
+    ) internal virtual override returns (address) {
         CollectionDetails storage _collectionDetails = collectionDetails[_collectionTokenId];
         if (to == address(0)) {
             if (_collectionDetails.size > 0) {
@@ -192,7 +201,10 @@ contract DataProtectorSharing is
     }
 
     /// @inheritdoc IDataProtectorSharing
-    function getProtectedDataRenter(address _protectedData, address _renterAddress) public view returns (uint48) {
+    function getProtectedDataRenter(
+        address _protectedData,
+        address _renterAddress
+    ) public view returns (uint48) {
         return protectedDataDetails[_protectedData].renters[_renterAddress];
     }
 
@@ -205,7 +217,12 @@ contract DataProtectorSharing is
     }
 
     /// @inheritdoc IDataProtectorSharing
-    function receiveApproval(address _sender, uint256, address, bytes calldata _extraData) public returns (bool) {
+    function receiveApproval(
+        address _sender,
+        uint256,
+        address,
+        bytes calldata _extraData
+    ) public returns (bool) {
         if (msg.sender != address(POCO_DELEGATE)) {
             revert OnlyPocoCallerAuthorized(msg.sender);
         }
@@ -229,7 +246,10 @@ contract DataProtectorSharing is
             _rentProtectedData(protectedData, _sender, rentingParams);
             return true;
         } else if (selector == this.buyProtectedData.selector) {
-            (address protectedData, address to, uint72 price) = abi.decode(_extraData[4:], (address, address, uint72));
+            (address protectedData, address to, uint72 price) = abi.decode(
+                _extraData[4:],
+                (address, address, uint72)
+            );
             _buyProtectedData(protectedData, _sender, to, price);
             return true;
         }
@@ -291,7 +311,11 @@ contract DataProtectorSharing is
 
         delete protectedDataDetails[_protectedData];
         collectionDetails[_collectionTokenId].size -= 1;
-        PROTECTED_DATA_REGISTRY.safeTransferFrom(address(this), msg.sender, uint256(uint160(_protectedData)));
+        PROTECTED_DATA_REGISTRY.safeTransferFrom(
+            address(this),
+            msg.sender,
+            uint256(uint160(_protectedData))
+        );
         emit ProtectedDataTransfer(_protectedData, 0, _collectionTokenId, address(0));
     }
 
@@ -327,7 +351,11 @@ contract DataProtectorSharing is
         _collectionDetails.lastSubscriptionExpiration = uint48(
             Math.max(endDate, _collectionDetails.lastSubscriptionExpiration)
         );
-        POCO_DELEGATE.transferFrom(spender, ownerOf(_collectionTokenId), _collectionDetails.subscriptionParams.price);
+        POCO_DELEGATE.transferFrom(
+            spender,
+            ownerOf(_collectionTokenId),
+            _collectionDetails.subscriptionParams.price
+        );
         emit NewSubscription(_collectionTokenId, spender, endDate);
     }
 
@@ -354,7 +382,10 @@ contract DataProtectorSharing is
     }
 
     /// @inheritdoc ISubscription
-    function setSubscriptionParams(uint256 _collectionTokenId, SubscriptionParams calldata _subscriptionParams) public {
+    function setSubscriptionParams(
+        uint256 _collectionTokenId,
+        SubscriptionParams calldata _subscriptionParams
+    ) public {
         _checkCollectionOperator(_collectionTokenId);
 
         collectionDetails[_collectionTokenId].subscriptionParams = _subscriptionParams;
@@ -405,7 +436,10 @@ contract DataProtectorSharing is
     }
 
     /// @inheritdoc IRental
-    function setProtectedDataToRenting(address _protectedData, RentingParams calldata _rentingParams) public {
+    function setProtectedDataToRenting(
+        address _protectedData,
+        RentingParams calldata _rentingParams
+    ) public {
         ProtectedDataDetails storage _protectedDataDetails = protectedDataDetails[_protectedData];
         uint256 _collectionTokenId = _protectedDataDetails.collection;
         _checkCollectionOperator(_collectionTokenId);
@@ -436,14 +470,23 @@ contract DataProtectorSharing is
         return _buyProtectedData(_protectedData, msg.sender, _to, _price);
     }
 
-    function _buyProtectedData(address _protectedData, address spender, address _to, uint72 _price) private {
+    function _buyProtectedData(
+        address _protectedData,
+        address spender,
+        address _to,
+        uint72 _price
+    ) private {
         ProtectedDataDetails storage _protectedDataDetails = protectedDataDetails[_protectedData];
         _checkProtectedDataForSale(_protectedData);
         if (_protectedDataDetails.sellingParams.price != _price) {
             revert InvalidPriceForPurchase(_protectedData, _price);
         }
 
-        PROTECTED_DATA_REGISTRY.safeTransferFrom(address(this), _to, uint256(uint160(_protectedData)));
+        PROTECTED_DATA_REGISTRY.safeTransferFrom(
+            address(this),
+            _to,
+            uint256(uint160(_protectedData))
+        );
         POCO_DELEGATE.transferFrom(
             spender,
             ownerOf(_protectedDataDetails.collection),

packages/sharing-smart-contract/abis/registry/AddOnlyAppWhitelistRegistry.sol/AddOnlyAppWhitelistRegistry.json

@@ -20,6 +20,7 @@ pragma solidity ^0.8.24;
 import {IExecPocoDelegate, IexecLibOrders_v5} from "./interfaces/IExecPocoDelegate.sol";
 
 /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
+// eslint-disable-next-line quotes
 abstract contract ManageOrders {
     using IexecLibOrders_v5 for IexecLibOrders_v5.OrderOperationEnum;
     using IexecLibOrders_v5 for IexecLibOrders_v5.AppOrder;
@@ -32,7 +33,8 @@ abstract contract ManageOrders {
 
     // ---------------------ManageOrders state----------------------------------
     IExecPocoDelegate internal immutable POCO_DELEGATE;
-    bytes32 internal constant TAG = 0x0000000000000000000000000000000000000000000000000000000000000003; // [tee,scone]
+    bytes32 internal constant TAG =
+        0x0000000000000000000000000000000000000000000000000000000000000003; // [tee,scone]
     uint256 internal constant TRUST = 0; // No replication
     string internal _iexecResultStorageProvider;
     string internal _iexecResultStorageProxy;
@@ -49,7 +51,9 @@ abstract contract ManageOrders {
     /***************************************************************************
      *                        Functions                                        *
      **************************************************************************/
-    function _createAppOrder(address _appAddress) internal view returns (IexecLibOrders_v5.AppOrder memory) {
+    function _createAppOrder(
+        address _appAddress
+    ) internal view returns (IexecLibOrders_v5.AppOrder memory) {
         //create AppOrderOperation
         return
             IexecLibOrders_v5.AppOrder({
@@ -120,28 +124,29 @@ abstract contract ManageOrders {
         uint256 _category
     ) internal returns (IexecLibOrders_v5.RequestOrder memory) {
         //create RequestOrderOperation
-        IexecLibOrders_v5.RequestOrderOperation memory requestOrderOperation = IexecLibOrders_v5.RequestOrderOperation({
-            order: IexecLibOrders_v5.RequestOrder({
-                app: _appAddress, //address
-                appmaxprice: 0, //uint256
-                dataset: _protectedData, //address
-                datasetmaxprice: 0, //uint256
-                workerpool: _workerpoolAddress, //address
-                workerpoolmaxprice: 0, //uint256
-                requester: address(this), //address
-                volume: 1, //uint256
-                tag: TAG, //bytes32
-                category: _category, //uint256
-                trust: TRUST, //uint256
-                beneficiary: msg.sender, //address
-                callback: address(0), //address
-                params: generateParams(), //string
-                salt: getSalt(), //bytes32
+        IexecLibOrders_v5.RequestOrderOperation memory requestOrderOperation = IexecLibOrders_v5
+            .RequestOrderOperation({
+                order: IexecLibOrders_v5.RequestOrder({
+                    app: _appAddress, //address
+                    appmaxprice: 0, //uint256
+                    dataset: _protectedData, //address
+                    datasetmaxprice: 0, //uint256
+                    workerpool: _workerpoolAddress, //address
+                    workerpoolmaxprice: 0, //uint256
+                    requester: address(this), //address
+                    volume: 1, //uint256
+                    tag: TAG, //bytes32
+                    category: _category, //uint256
+                    trust: TRUST, //uint256
+                    beneficiary: msg.sender, //address
+                    callback: address(0), //address
+                    params: generateParams(), //string
+                    salt: getSalt(), //bytes32
+                    sign: new bytes(0)
+                }),
+                operation: IexecLibOrders_v5.OrderOperationEnum.SIGN, //OrderOperationEnum
                 sign: new bytes(0)
-            }),
-            operation: IexecLibOrders_v5.OrderOperationEnum.SIGN, //OrderOperationEnum
-            sign: new bytes(0)
-        });
+            });
 
         // presign
         POCO_DELEGATE.manageRequestOrder(requestOrderOperation);
@@ -156,12 +161,13 @@ abstract contract ManageOrders {
     function generateParams() private view returns (string memory) {
         return
             string.concat(
-                '{"iexec_result_encryption":true',
-                ',"iexec_result_storage_provider":"',
+                // eslint-disable-next-line quotes
+                '{"iexec_result_encryption":true', // solhint-disable-line quotes
+                ',"iexec_result_storage_provider":"', // solhint-disable-line quotes
                 _iexecResultStorageProvider,
-                '","iexec_result_storage_proxy":"',
+                '","iexec_result_storage_proxy":"', // solhint-disable-line quotes
                 _iexecResultStorageProxy,
-                '"}'
+                '"}' // solhint-disable-line quotes
             );
     }
 }

packages/sharing-smart-contract/contracts/DataProtectorSharing.sol

@@ -138,7 +138,10 @@ interface IDataProtectorSharing is ICollection, ISubscription, IRental, ISale {
      * @param _renterAddress The address of the renter.
      * @return The rental expiration timestamp as a uint48.
      */
-    function getProtectedDataRenter(address _protectedData, address _renterAddress) external view returns (uint48);
+    function getProtectedDataRenter(
+        address _protectedData,
+        address _renterAddress
+    ) external view returns (uint48);
 
     /**
      * Retrieves the subscription expiration timestamp for a specific collection and subscriber.