Merge pull request #25 from hokunet/jd/ci-update

feat: add extra CI checks

Author: JulissaDantes

.github/workflows/coverage-check.yaml

@@ -0,0 +1,56 @@
+name: Solidity Lint, and Coverage
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+
+      - name: Install Dependencies
+        run: pnpm install
+
+      - name: Run Solidity Linter
+        run: pnpm exec solhint 'src/**/*.sol'
+
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Install forge-coverage
+        run: forge install
+
+      - name: Run Coverage
+        run: forge coverage --report lcov
+    # Check fails if coverage percentage falls under 80%
+      - name: Check Coverage Threshold
+        run: |
+          COVERAGE=$(forge coverage --report summary | grep 'Total coverage:' | awk '{print $3}' | cut -d'%' -f1)
+          echo "Coverage is $COVERAGE%"
+          if [ "$COVERAGE" -lt 80 ]; then
+            echo "Code coverage ($COVERAGE%) is below the threshold (80%)"
+            exit 1
+          fi

.github/workflows/lint-pr.yaml

@@ -0,0 +1,33 @@
+name: "Lint PR title and commits"
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - reopened
+
+permissions:
+  pull-requests: read
+
+jobs:
+  main:
+    name: Validate PR follows Conventional Commits
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          ## A non-comprehensive list of scopes. Scope is not required, but strongly encouraged, as it brings
+          ## structure to changelogs.
+          scopes: |
+            contracts 
+            test
+          requireScope: false
+          subjectPattern: ^(?![A-Z]).+$
+          subjectPatternError: |
+            The subject "{subject}" found in the pull request title "{title}"
+            didn't match the configured pattern. Please ensure that the subject
+            doesn't start with an uppercase character.

.github/workflows/upgrade-safe.yaml

@@ -0,0 +1,46 @@
+name: 'Contracts: Storage check'
+
+on:
+    push:
+    pull_request:
+    workflow_dispatch:
+
+env:
+  RPC_URL: https://filecoin-calibration.chainup.net/rpc/v1
+  PRIVATE_KEY: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
+
+jobs:
+  storage:
+    name: Storage layout check
+    runs-on: ubuntu-latest
+    if: ${{ !github.event.pull_request.draft }}
+    steps:
+      - uses: webfactory/[email protected]
+        with:
+          ssh-private-key: |
+            ${{ secrets.BUILTIN_ACTORS_DEPLOY_KEY }}
+            ${{ secrets.CONTRACTS_DEPLOY_KEY }}
+
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18.x'
+          cache: 'pnpm'
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          cache: false
+
+      - name: Install Node dependencies
+        run: pnpm install
+
+      - name: Storage check
+        run: pnpm exec hardhat storage-layout --check

.gitignore

@@ -1,6 +1,8 @@
 # Compiler files
 cache/
 out/
+cache_hardhat/
+artifacts/
 
 # Ignores development broadcast logs
 !/broadcast
@@ -16,4 +18,5 @@ docs/
 
 settings.json
 
-.DS_Store
+.DS_Store
+node_modules/

.solhint.json

@@ -0,0 +1,32 @@
+{
+    "extends": "solhint:recommended",
+    "rules": {
+        "compiler-version": ["error", "^0.8.0"],
+        "func-visibility": [
+            "warn",
+            {
+                "ignoreConstructors": true
+            }
+        ],
+        "no-inline-assembly": ["off"],
+        "no-global-import": "error",
+        "no-unused-import": "off",
+        "no-unused-vars": "error",
+        "const-name-snakecase": "error",
+        "contract-name-camelcase": "error",
+        "event-name-camelcase": "error",
+        "func-name-mixedcase": "error",
+        "func-param-name-mixedcase": "error",
+        "modifier-name-mixedcase": "error",
+        "private-vars-leading-underscore": "off",
+        "var-name-mixedcase": "error",
+        "imports-on-top": "error",
+        "no-empty-blocks": "error",
+        "quotes": "error",
+        "use-forbidden-name": "error",
+        "visibility-modifier-order": "error",
+        "avoid-tx-origin": "error",
+        "reentrancy": "error",
+        "explicit-types": ["error", "explicit"]
+    }
+}

hardhat.config.js

@@ -0,0 +1,31 @@
+/** @type import('hardhat/config').HardhatUserConfig */
+require("hardhat-storage-layout-changes");
+require("@nomicfoundation/hardhat-foundry");
+
+const path = require("path");
+
+module.exports = {
+  solidity: {
+    compilers: [
+      {
+        version: "0.8.23",  
+      },
+      {
+        version: "0.8.26",  
+      }
+    ],
+  },
+  paths: {
+    sources: "./src", 
+    storageLayouts: ".storage-layouts",
+  },
+  storageLayoutConfig: {
+    contracts: ['src/Hoku.sol:Hoku'],
+    fullPath: true
+  },
+  resolve: {
+    alias: {
+      "@openzeppelin/contracts": path.resolve(__dirname, "lib/openzeppelin-contracts/contracts"), 
+    },
+  },
+};

package.json

@@ -0,0 +1,20 @@
+{
+  "name": "contracts",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "forge test"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@nomicfoundation/hardhat-foundry": "^1.1.2",
+    "hardhat": "^2.22.13",
+    "solhint": "^5.0.3"
+  },
+  "dependencies": {
+    "hardhat-storage-layout-changes": "^0.1.2"
+  }
+}