Test: Initial Strategy & Service

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/test.yml

@@ -43,3 +43,15 @@ jobs:
         run: |
           forge test -vvv
         id: test
+
+      - name: Run Slither
+        uses: crytic/slither-action@v0.4.0
+        id: slither
+        with:
+          sarif: results.sarif
+          fail-on: none
+
+      # - name: Upload SARIF file
+      #   uses: github/codeql-action/upload-sarif@v3
+      #   with:
+      #     sarif_file: ${{ steps.slither.outputs.sarif }}

.gitignore

@@ -15,4 +15,9 @@ docs/
 .env
 
 node_modules/
-package-lock.json
+package-lock.json
+
+# Coverage
+coverage/
+report/
+lcov.info

.husky/pre-commit

@@ -1,5 +1,5 @@
 npm run format
 
-solhint 'src/**/*.sol'
+npm run lint:solhint
 
 npm run test-coverage

.solhint.json

@@ -1,3 +1,15 @@
 {
-  "extends": "solhint:default"
-}
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", "0.8.28"],
+    "no-inline-assembly": "off",
+    "no-unused-import": "error",
+    "func-named-parameters": "off",
+    "func-visibility": ["error", { "ignoreConstructors": true }],
+    "reason-string": ["warn", { "maxLength": 64 }],
+    "immutable-vars-naming": ["error", { "immutablesAsConstants": true }],
+    "var-name-mixedcase": "error",
+    "custom-errors": "error",
+    "func-name-mixedcase": "error"
+  }
+}

package.json

@@ -1,18 +1,13 @@
 {
   "name": "based-applications",
   "version": "0.0.0",
-  "description": "Based Applications Contracts SSV",
-  "scripts": {
-    "build": "forge fmt && forge build",
-    "deploy": "forge script script/DeployProxy.s.sol --rpc-url $HOLESKY_RPC_URL --private-key $PRIVATE_KEY --broadcast",
-    "format": "forge fmt",
-    "gas-report": "forge test -vvvv --gas-report",
-    "generate-docs": "solc --include-path node_modules --base-path . --combined-json userdoc,devdoc src/BasedAppManager.sol --output-dir ./docs --overwrite",
-    "prepare": "husky",
-    "test": "forge test -vvvv",
-    "test-coverage": "forge coverage",
-    "verify-implementation": "forge verify-contract --chain holesky $IMPLEMENTATION_ADDRESS src/BasedAppManager.sol:BasedAppManager --etherscan-api-key $ETHERSCAN_API_KEY"
+  "description": "SSV Based Applications",
+  "author": "SSV.Network",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ssvlabs/based-applications.git"
   },
+  "license": "UNLICENSED",
   "keywords": [
     "Based",
     "BApps",
@@ -22,8 +17,21 @@
     "Marco Tabasco <marco@ssvlabs.io>",
     "Riccardo Persiani <r.persiani92@gmail.com>"
   ],
-  "license": "UNLICENSED",
+  "scripts": {
+    "build": "forge fmt && forge build",
+    "deploy": "forge script script/DeployProxy.s.sol --rpc-url $HOLESKY_RPC_URL --private-key $PRIVATE_KEY --broadcast",
+    "format": "forge fmt",
+    "gas-report": "forge test -vvvv --gas-report",
+    "generate-docs": "solc --include-path node_modules --base-path . --combined-json userdoc,devdoc src/BasedAppManager.sol --output-dir ./docs --overwrite",
+    "prepare": "husky",
+    "lint:solhint": "solhint './src/**/*.sol'",
+    "test": "forge test -vvvv",
+    "test-coverage": "forge coverage --no-match-coverage \"(script|test)\"",
+    "test-coverage-report": "forge coverage --no-match-coverage \"(script|test)\" --report lcov && genhtml lcov.info -o report --branch-coverage",
+    "verify-implementation": "forge verify-contract --chain holesky $IMPLEMENTATION_ADDRESS src/BasedAppManager.sol:BasedAppManager --etherscan-api-key $ETHERSCAN_API_KEY"
+  },
   "devDependencies": {
+    "@openzeppelin/contracts-upgradeable": "^5.1.0",
     "husky": "^9.1.7"
   }
 }