edit github actions

Author: ShivaanshK

.github/workflows/test.yml

@@ -14,29 +14,34 @@ env:
   POLYGON_RPC_URL: 'https://polygon.gateway.tenderly.co'
 
 jobs:
-  check:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+
     strategy:
-      fail-fast: true
+      matrix:
+        node-version: [20.x]
 
-    name: Foundry project
-    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
         with:
           submodules: recursive
 
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install yarn and dependencies
+        run: npm install -g yarn && yarn
+
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
           version: nightly
 
-      - name: Run Forge build
-        run: |
-          forge --version
-          forge build --sizes
-        id: build
+      - name: Run Solhint linter
+        run: npx solhint "src/*.sol"
 
-      - name: Run Forge tests
-        run: |
-          forge test -vvv
-        id: test
+      - name: Test
+        run: yarn test

.solhint.json

@@ -0,0 +1,27 @@
+{
+    "extends": "solhint:recommended",
+    "rules": {
+      "max-line-length": "off",
+      "no-inline-assembly": "off",
+      "reason-string": ["warn", { "maxLength": 160 }],
+      "func-visibility": ["warn", { "ignoreConstructors": true }],
+      "explicit-types": ["warn", "explicit"],
+      "quotes": ["warn", "double"],
+      "const-name-snakecase": "warn",
+      "not-rely-on-time": "off",
+      "avoid-low-level-calls": "off",
+      "contract-name-camelcase": "off",
+      "func-name-mixedcase": "off",
+      "var-name-mixedcase": "off",
+      "compiler-version": "off",
+      "custom-errors": "warn",
+      "no-global-import": "off",
+      "immutable-vars-naming": "off",
+      "no-console": "warn",
+      "named-parameters-mapping": "off",
+      "use-forbidden-name": "warn",
+      "imports-on-top": "warn",
+      "ordering": "off",
+      "comprehensive-interface": "off"
+    }
+  }

package.json

@@ -0,0 +1,15 @@
+{
+    "name": "cross-chain-deposit-module",
+    "version": "1.0.0",
+    "description": "A system for facilitating cross-chain deposit campaigns through Royco",
+      "scripts": {
+        "build": "forge build",
+        "test": "forge test -vvv",
+        "coverage": "forge coverage",
+        "hint": "solhint 'src/*.sol'",
+        "sizes": "forge --version && forge build --sizes --optimize --optimizer-runs 200 --skip test --force"
+    },
+    "devDependencies": {
+      "solhint": "^5.0.3"
+    }
+  }

src/PredepositExecutor.sol

@@ -198,29 +198,29 @@ contract PredepositExecutor is ILayerZeroComposer, Ownable2Step, ReentrancyGuard
     }
 
     /// @notice Sets a new owner for the specified campaign.
-    /// @param _sourceMarketHash The unique identifier for the campaign.
+    /// @param _sourceMarketHash The market hash on the source chain used to identify the corresponding campaign on the destination.
     /// @param _newOwner The address of the new campaign owner.
     function setPredepositCampaignOwner(bytes32 _sourceMarketHash, address _newOwner) external onlyOwnerOfPredepositCampaign(_sourceMarketHash) {
         sourceMarketHashToOwner[_sourceMarketHash] = _newOwner;
     }
 
     /// @notice Sets a new owner for the specified campaign.
-    /// @param _sourceMarketHash The unique identifier for the campaign.
-    /// @param _unlockTimestamp The ABSOLUTE timestamp until deposits will be locked for this campaign.
+    /// @param _sourceMarketHash The market hash on the source chain used to identify the corresponding campaign on the destination.
+    /// @param _unlockTimestamp The ABSOLUTE timestamp until deposits will be locked for this campaign on destination.
     function setPredepositCampaignLocktime(bytes32 _sourceMarketHash, uint256 _unlockTimestamp) external onlyOwnerOfPredepositCampaign(_sourceMarketHash) {
         sourceMarketHashToPredepositCampaign[_sourceMarketHash].unlockTimestamp = _unlockTimestamp;
     }
 
     /// @notice Sets the deposit recipe for a campaign.
-    /// @param _sourceMarketHash The unique identifier for the campaign.
-    /// @param _depositRecipe The deposit recipe for the source market on the destination chain
+    /// @param _sourceMarketHash The market hash on the source chain used to identify the corresponding campaign on the destination.
+    /// @param _depositRecipe The deposit recipe for the campaign on the destination chain
     function setDepositRecipe(bytes32 _sourceMarketHash, Recipe calldata _depositRecipe) external onlyOwnerOfPredepositCampaign(_sourceMarketHash) {
         sourceMarketHashToPredepositCampaign[_sourceMarketHash].depositRecipe = _depositRecipe;
     }
 
     /// @notice Sets the withdrawal recipe for a campaign.
-    /// @param _sourceMarketHash The unique identifier for the campaign.
-    /// @param _withdrawalRecipe The withdrawal recipe for the source market on the destination chain
+    /// @param _sourceMarketHash The market hash on the source chain used to identify the corresponding campaign on the destination.
+    /// @param _withdrawalRecipe The withdrawal recipe for the campaign on the destination chain
     function setWithdrawalRecipe(bytes32 _sourceMarketHash, Recipe calldata _withdrawalRecipe) external onlyOwnerOfPredepositCampaign(_sourceMarketHash) {
         sourceMarketHashToPredepositCampaign[_sourceMarketHash].withdrawalRecipe = _withdrawalRecipe;
     }