Merge pull request #502 from maticnetwork/stage

POL updates, migration to Foundry/Hardhat

.env.example

@@ -0,0 +1,4 @@
+INFURA_TOKEN="909b972ab2ff3afb8b0f8f6a9667test"
+BOR_CHAIN_URL="http://localhost:9545"
+ENV="local"
+MNEMONIC_DEV="poly radar mass judge dismiss just intact mind resemble fringe diary casino"

.github/workflows/ci.yml

@@ -2,30 +2,51 @@ name: CI
 
 on:
   push:
-    branches: 
+    branches:
       - main
   pull_request:
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Setup Node.js environment
-      uses: actions/setup-node@v2-beta
-      with:
-        node-version: '10.x'
-        registry-url: 'https://registry.npmjs.org'
-    - name: Cache npm dependencies
-      uses: actions/cache@v1
-      with:
-        path: ~/.npm
-        key: ${{ runner.OS }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.OS }}-npm-cache-
-    - name: Install npm dependencies
-      run: npm install
-    - name: Process templates
-      run: npm run template:process
-    - name: Run tests
-      run: npm run test:ci
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Cache npm dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.OS }}-npm-cache-${{ hashFiles('./package-lock.json') }}
+          restore-keys: |
+            ${{ runner.OS }}-npm-cache-
+
+      - name: Install npm dependencies
+        run: npm install
+
+      - name: Process templates
+        run: npm run template:process
+
+      - name: Run Coverage and Hardhat tests
+        run: npm run test:ci
+
+      - 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 Forge tests
+        run: |
+          forge test -vvv
+        id: test

.gitignore

@@ -1,22 +1,26 @@
 node_modules
-build
+artifacts
+out
 contractAddresses.json
+.vscode
+
 
 # ignore generated files
 contracts/root/predicates/TransferWithSigUtils.sol
 contracts/common/mixin/ChainIdMixin.sol
-test-blockchain/genesis.json
-test-blockchain/start.sh
 test/helpers/marketplaceUtils.js
+cache_hardhat
+forge-cache
+
 
-test-blockchain/geth
-test-blockchain/history
-test-blockchain/data
+test-bor-docker/history
+test-bor-docker/data
 
 *.pid
 *.log
 
 .DS_Store
+.vscode
 *.env
 
 coverage/

.gitmodules

@@ -0,0 +1,12 @@
+[submodule "lib/solady"]
+	path = lib/solady
+	url = https://github.com/vectorized/solady
+[submodule "lib/deployment-log-generator"]
+	path = lib/deployment-log-generator
+	url = https://github.com/0xPolygon/deployment-log-generator
+[submodule "lib/contract-deployer-template"]
+	path = lib/contract-deployer-template
+	url = https://github.com/0xPolygon/contract-deployer-template
+[submodule "lib/storage-layout-checker"]
+	path = lib/storage-layout-checker
+	url = https://github.com/0xPolygon/storage-layout-checker

.nvmrc

@@ -1 +1 @@
-11.1.0
+20.6.0

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+        description: Forces to replace line ending by the UNIX 'lf' character.
+        exclude: "^docs/autogen"
+  - repo: local
+    hooks:
+      - id: format
+        name: Format solidity code
+        description: Format solidity code with `forge fmt`
+        language: system
+        entry: forge fmt
+        exclude: "^lib/"
+        pass_filenames: true
+      - id: doc
+        name: Generate documentation
+        description: Generate docs with `forge doc`
+        language: system
+        # generates docs and unstages files if only the commit hash changed within the file, this way only when the documentation is updated, the documentation needs to be regenerated and only the changed files are pushed
+        entry: "scripts/util/doc_gen.sh"
+        pass_filenames: false
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.0.3"
+    hooks:
+      - id: prettier
+        name: Format non solidity files with prettier
+        exclude: "^docs/autogen"

.prettierrc

@@ -10,6 +10,16 @@
         "bracketSpacing": false,
         "explicitTypes": "always"
       }
+    },
+    {
+      "files": "*.js",
+      "options": {
+        "semi": false,
+        "singleQuote": true,
+        "tabWidth": 2,
+        "printWidth": 120,
+        "trailingComma": "none"
+      }
     }
   ]
 }

.solcover.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+  mocha: {
+    grep: "@skip-on-coverage", // Find everything with this tag
+    invert: true, // Run the grep's inverse set.
+  },
+  compileCommand: "npx hardhat compile",
+};

.soliumrc.json

@@ -14,7 +14,7 @@
     "no-unused-vars": 1,
     "quotes": 1,
     "error-reason": 0,
-    "indentation": ["error", 2],
+    "indentation": ["error", 4],
     "arg-overflow": ["error", 8],
     "whitespace": 1,
     "deprecated-suicide": 1,