Feat: Switch to pnpm and implement gas optimizations (#14)

* switch to pnpm and audited gas optimizations

* removing extension

* add linting mechanics

* Use audits in Readme.md

.eslintrc.js

@@ -1,14 +1,16 @@
 module.exports = {
+  root: true,
   env: {
-    browser: false,
-    es2021: true,
-    mocha: true,
     node: true,
+    browser: false,
+    es2022: true,
   },
-  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  ignorePatterns: ["dist", "coverage"],
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
   parser: "@typescript-eslint/parser",
   plugins: ["@typescript-eslint", "prettier"],
   parserOptions: {
     ecmaVersion: 12,
+    sourceType: "module",
   },
 };

.gitignore

@@ -7,4 +7,4 @@ typechain-types
 cache
 build
 .openzeppelin
-.DS_Store
+

.prettierrc.js

@@ -0,0 +1,23 @@
+/** @type {import("prettier").Config} */
+module.exports = {
+  trailingComma: "all",
+  tabWidth: 2,
+  semi: true,
+  singleQuote: false,
+  printWidth: 120,
+  bracketSpacing: true,
+  plugins: ["prettier-plugin-solidity"],
+  overrides: [
+    {
+      files: "*.sol",
+      options: {
+        parser: "solidity-parse",
+        bracketSpacing: true,
+        printWidth: 120,
+        singleQuote: false,
+        tabWidth: 2,
+        useTabs: false,
+      },
+    },
+  ],
+};

.solhint.json

@@ -7,12 +7,12 @@
     "var-name-mixedcase": "off",
     "const-name-snakecase": "off",
     "func-name-mixedcase": "off",
-    "custom-errors": "off",
     "state-visibility": "off",
     "no-empty-blocks": "off",
     "avoid-low-level-calls": "off",
     "reason-string": "off",
     "check-send-result": "off",
-    "no-unused-import": ["error"]
+    "no-unused-import": ["error"],
+    "gas-custom-errors": "off"
   }
 }

README.md

@@ -1 +1,54 @@
-# linea-contracts
+# linea-contracts
+
+## Audits
+### Fourth Audit Round (Latest)
+
+**Open Zeppelin**
+- Gas optimization audit: https://blog.openzeppelin.com/linea-gas-optimizations-audit
+
+
+### Third Audit Round
+**Open Zeppelin**
+
+- Blob submission audit: https://blog.openzeppelin.com/linea-blob-submission-audit
+
+### Second Audit Round
+
+**Diligence**
+- Proof aggregation, data compression and message service updates Audit: https://consensys.io/diligence/audits/2024/01/linea-contracts-update/
+
+**Open Zeppelin**
+
+- Proof aggregation, data compression and message service updates Audit: https://blog.openzeppelin.com/linea-v2-audit
+
+### First Audit Round
+
+**Diligence**
+
+- Plonk Verifier: https://consensys.io/diligence/audits/2023/06/linea-plonk-verifier/
+- Message Service & Rollup: https://consensys.io/diligence/audits/2023/06/linea-message-service/
+- Canonical Token Bridge: https://consensys.io/diligence/audits/2023/06/linea-canonical-token-bridge/
+
+**Open Zeppelin**
+
+- Linea Bridge Audit: https://blog.openzeppelin.com/linea-bridge-audit-1
+- Linea Verifier Audit: https://blog.openzeppelin.com/linea-verifier-audit-1
+
+
+
+---
+
+## Installation and testing
+
+To run the solution's tests, coverage and gas reporting, be sure to install pnpm and then
+```
+# Install all the dependencies
+
+pnpm install
+
+pnpm run test
+
+pnpm run test:reportgas
+
+pnpm run coverage
+```