Merge pull request #1 from pnetwork-association/chore/test-contracts

Add tests contracts + event attestator simulator

.github/workflows/ci.yml

@@ -1,29 +1,42 @@
-name: CI
+name: test
 on:
   push:
-    branches:
-      - master
+    branches: [master]
   pull_request:
 
 env:
   FOUNDRY_PROFILE: ci
 
 jobs:
-  run-ci:
+  yarn-ci:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: 'Enable corepack'
+        run: corepack enable
 
-      - name: Install Foundry
+      - name: 'Install Foundry'
         uses: foundry-rs/foundry-toolchain@v1
         with:
           version: nightly
 
-      - name: Install deps
-        run: forge install
+      - name: 'Setup Node.js'
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: 'yarn'
+
+      - name: 'Install'
+        run: yarn install
+
+      - name: 'Build'
+        run: yarn build
 
-      - name: Check gas snapshots
-        run: forge snapshot --check
+      - name: 'Lint'
+        run: yarn lint
 
-      - name: Run tests
-        run: forge test
+      - name: 'Test'
+        run: yarn test

.gitignore

@@ -1 +1,5 @@
+.yarn
+
+dist
+coverage
 node_modules

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "solidity/lib/Solidity-RLP"]
 	path = solidity/lib/Solidity-RLP
 	url = https://github.com/hamdiallam/Solidity-RLP
+[submodule "solidity/lib/openzeppelin-contracts-upgradeable"]
+	path = solidity/lib/openzeppelin-contracts-upgradeable
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable

.prettierrc

@@ -1,5 +1,7 @@
 {
+  "semi": false,
   "tabWidth": 2,
+  "arrowParens": "avoid",
   "singleQuote": true,
   "trailingComma": "all",
   "overrides": [
@@ -14,9 +16,12 @@
       }
     }
   ],
-  "importOrder": ["^@hyperlane-xyz/(.*)$", "^../(.*)$", "^./(.*)$"],
+  "importOrder": ["<THIRD_PARTY_MODULES>", "^[./]"],
   "importOrderSeparation": true,
   "importOrderSortSpecifiers": true,
   "importOrderParserPlugins": ["importAssertions", "typescript", "jsx"],
-  "plugins": ["prettier-plugin-solidity", "@trivago/prettier-plugin-sort-imports"]
+  "plugins": [
+    "prettier-plugin-solidity",
+    "@trivago/prettier-plugin-sort-imports"
+  ]
 }

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "bierner.github-markdown-preview",
+    "nomicfoundation.hardhat-solidity"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,41 @@
+{
+    "npm.packageManager": "yarn",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": true,
+        "source.organizeImports": "explicit"
+    },
+    "[json]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[markdown]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[solidity]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[typescript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[javascript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "files.watcherExclude": {
+        "**/.git/**": true,
+        "./solidity/lib": true,
+        "**/node_modules/*/**": true
+    },
+    "files.exclude": {
+        "**/node_modules": true,
+        "**/*.js": {
+            "when": "$(basename).ts"
+        },
+        "**/*.map": {
+            "when": "$(basename).map"
+        },
+        "**/artifacts": true,
+        "**/cache": true,
+        "**/dist": true,
+        "**/types": true
+    }
+}

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: "node-modules"

eslint.config.js

@@ -0,0 +1,24 @@
+// @ts-check
+import eslint from '@eslint/js'
+import prettierConfig from 'eslint-config-prettier'
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  prettierConfig,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+    },
+    rules: {
+      'no-console': 'error',
+    },
+  },
+  {
+    ignores: ['**/lib'],
+  },
+)

package.json

@@ -3,21 +3,30 @@
   "version": "0.0.0",
   "private": true,
   "description": "pNetwork v4 monorepo",
-  "main": " ",
+  "type": "module",
   "author": "pNetwork Devs",
   "license": "MIT",
   "workspaces": [
-    "solidity"
+    "solidity",
+    "typescript/*"
   ],
   "scripts": {
-    "test": "yarn workspaces run test",
-    "prettier": "yarn workspaces run prettier"
+    "test": "yarn workspaces foreach --all --parallel --no-private run test",
+    "lint": "yarn workspaces foreach --all --parallel --no-private run lint",
+    "build": "yarn workspaces foreach --all --parallel --no-private run build",
+    "prettier": "yarn workspaces foreach --all --parallel --no-private run prettier"
   },
   "devDependencies": {
+    "@eslint/js": "^9.5.0",
     "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@types/eslint__js": "^8.42.3",
     "eslint": "8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "prettier": "3.3.2",
-    "prettier-plugin-solidity": "^1.3.1"
-  }
+    "prettier-plugin-solidity": "^1.3.1",
+    "solhint": "^5.0.1",
+    "typescript": "4.7.4",
+    "typescript-eslint": "^7.13.1"
+  },
+  "packageManager": "[email protected]"
 }

pnetwork-v4.code-workspace

@@ -0,0 +1,14 @@
+{
+    "folders": [
+        {
+            "name": "root",
+            "path": "./",
+        },
+        {
+            "path": "typescript",
+        },
+        {
+            "path": "solidity",
+        },
+    ]
+}

solidity/.gitignore

@@ -12,3 +12,7 @@ docs/
 
 # Dotenv file
 .env
+
+# Private keys
+*.key
+*.keys

solidity/.solhint.json

@@ -1,3 +1,7 @@
 {
-  "extends": "solhint:default"
+  "extends": "solhint:default",
+  "rules": {
+    "ordering": "warn",
+    "private-vars-leading-underscore": ["warn", { "strict": false }]
+  }
 }

solidity/eslint.config.js

@@ -0,0 +1,3 @@
+import config from '../eslint.config.js'
+
+export default [...config, { rules: { 'no-console': 'off' } }]

solidity/forge-dependencies.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+ls lib/ | \
+xargs -I % bash -c \
+'cat ./lib/%/package.json | jq -r "@text \"\(.name)@\(.version)\""'

solidity/forge-dependencies.txt

@@ -0,0 +1,4 @@
+[email protected]
+[email protected]
+[email protected]
+[email protected]

solidity/foundry.toml

@@ -2,5 +2,12 @@
 src = "src"
 out = "out"
 libs = ["lib"]
+evm_version="cancun"
+
+gas_reports = ["Adapter"]
+remappings = [
+  "forge-std/=lib/forge-std/src/",
+  "solidity-rlp/=lib/Solidity-RLP/",
+]
 
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

solidity/package.json

@@ -1,16 +1,23 @@
 {
   "name": "@pnetwork/contracts",
   "version": "1.0.0",
+  "type": "module",
   "description": "pNetwork v4 contracts",
   "directories": {
     "lib": "lib",
     "test": "test"
   },
   "scripts": {
-    "test": "yarn test:forge",
-    "test:forge": "forge test",
-    "lint": "solhint contracts/**/*.sol",
-    "prettier": "prettier --write ./src ./test"
+    "build": "forge build",
+    "test": "forge test",
+    "lint": "npx solhint src/**/*.sol",
+    "prettier": "prettier --write ./src ./test",
+    "coverage": "forge coverage --report summary"
+  },
+  "devDependencies": {
+    "@pnetwork/event-attestator": "*",
+    "commander": "^12.1.0",
+    "ramda": "^0.30.1"
   },
   "author": "gitmp01",
   "license": "MIT"