Merge branch 'develop' into feature/upgrade-workflow

Author: james-toussaint

.github/workflows/main.yml

@@ -29,6 +29,8 @@ jobs:
         run: npm ci
       - name: Check Format
         run: npm run check-format
+      - name: Check Lint
+        run: npm run check-lint
       - name: Build
         run: npm run build
       - name: Check Types

.prettierrc

@@ -8,16 +8,12 @@
         "prettier-plugin-organize-imports",
         "prettier-plugin-solidity"
     ],
-    "pluginsComments": {
-        "prettier-plugin-organize-import": "Supports .ts files (not .sol)",
-        "prettier-plugin-solidity": "Does not support imports sorting yet. See prettier-solidity/prettier-plugin-solidity#918"
-    },
     "overrides": [
         {
-          "files": "*.sol",
-          "options": {
-                "singleQuote": false 
-            }    
+            "files": "*.sol",
+            "options": {
+                "singleQuote": false
+            }
         }
-      ]
+    ]
 }

.solhint.json

@@ -0,0 +1,22 @@
+{
+  "extends": [
+    "solhint:recommended"
+  ],
+  "plugins": [],
+  "rules": {
+    "compiler-version": [
+      "error",
+      "^0.8.20"
+    ],
+    "func-visibility": [
+      "warn",
+      {
+        "ignoreConstructors": true
+      }
+    ],
+    "quotes": [
+      "error",
+      "double"
+    ]
+  }
+}

.solhintignore

@@ -0,0 +1 @@
+hardhat-dependency-compiler

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## vNEXT
 - Add upgrade workflow. (#64)
+- Add Halborn "Poco v5.5 & Voucher v1.0" audit report ( #70)
 - Add `dealId` to `TaskClaimedWithVoucher` event. (#61)
 - Add type-checking script (#53)
 - Run partial upgrade tests on fork.

README.md

@@ -67,3 +67,7 @@ npx hardhat verify <voucherProxyAddress> --network bellecour <beaconAddress>
 
 Note: no need to verify all VoucherProxy contracts because Blockscout automatically
 matches all similar contracts with the submitted source code.
+
+## Audits
+
+All contract audit files can be found in [audit/](./audit/) folder.

audit/v1.0/Audit_Poco_and_Voucher_Contracts_2025-01.pdf

@@ -0,0 +1,22 @@
+import eslint from '@eslint/js';
+import tsEslint from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import importPlugin from 'eslint-plugin-import';
+
+export default [
+    {
+        ...eslint.configs.recommended,
+        ignores: ['.solcover.js'],
+        languageOptions: {
+            parser: tsParser,
+            parserOptions: {
+                ecmaVersion: 'latest',
+                sourceType: 'module',
+            },
+        },
+        plugins: {
+            '@typescript-eslint': tsEslint,
+            import: importPlugin,
+        },
+    },
+];