Upgrade to Hardhat 3 and Enhanced Development Tooling

.github/workflows/ci.yml

@@ -10,18 +10,19 @@ jobs:
 
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
-      - name: Use Node.js 20.x
+      - name: Use Node.js 24.x
         uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 #v4.4.0
         with:
-          node-version: 20
+          node-version: 24
 
       - name: Install dependencies
-        run: yarn
+        run: npm install
 
       - name: Compile contracts
-        run: yarn compile
+        run: npm run compile
 
-      - name: Test and Lint
+      - name: Test, Lint and Type Check
         run: |
-          yarn test
-          yarn lint
+          npm run test
+          npm run lint
+          npm run type-check

.github/workflows/dependency_review.yml

@@ -18,4 +18,6 @@ jobs:
         uses: actions/dependency-review-action@ce3cf9537a52e8119d91fd484ab5b8a807627bf8 # v4.6.0
         with:
           fail-on-severity: high
-          comment-summary-in-pr: true
+          comment-summary-in-pr: true
+          # Ignore rif-token-contracts package vulnerabilities (known false positive)
+          allow-ghsas: 'GHSA-j7xp-w6x3-3q9v'

.github/workflows/slither.yml

@@ -9,11 +9,20 @@ jobs:
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
 
-      - name: Run Slither
-        uses: crytic/slither-action@4fd765aeef19915d04ddf0be90c2930036a774d8 #v0.4.1
-        id: slither
-        with:
-          node-version: 20
-          fail-on: none
-          slither-args: --filter-paths "openzeppelin,RIF,util,exploit" --checklist --markdown-root ${{ github.server_url }}/${{ github.repository }}/blob/${{ github.sha }}/
-          target: .
+      # TODO: Re-enable Slither when Hardhat 3 compatibility is fixed
+      # Current issue: Slither v0.4.1 is not compatible with Hardhat 3.x
+      # See: https://github.com/crytic/slither/issues/860
+      # Alternative: Solhint analysis is now running in solidity-lint.yml workflow
+      - name: Run Slither (Temporarily Disabled)
+        run: |
+          echo "Slither analysis temporarily disabled due to Hardhat 3 incompatibility"
+          echo "Alternative Solidity analysis is provided by Solhint in solidity-lint.yml workflow"
+          echo "Will be re-enabled when crytic/slither-action supports Hardhat 3.x"
+      # - name: Run Slither
+      #   uses: crytic/slither-action@4fd765aeef19915d04ddf0be90c2930036a774d8 #v0.4.1
+      #   id: slither
+      #   with:
+      #     node-version: 24
+      #     fail-on: none
+      #     slither-args: --filter-paths "openzeppelin,RIF,util,exploit" --checklist --markdown-root ${{ github.server_url }}/${{ github.repository }}/blob/${{ github.sha }}/
+      #     target: .

.github/workflows/solidity-lint.yml

@@ -0,0 +1,22 @@
+name: Solidity Lint Analysis
+on: [push, pull_request]
+permissions: {}
+
+jobs:
+  solidity-lint:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
+
+      - name: Use Node.js 24.x
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 #v4.4.0
+        with:
+          node-version: 24
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run Solhint Analysis
+        run: npm run lint:sol

.gitignore

@@ -1,6 +1,13 @@
-node_modules
+# Node modules
+/node_modules
+
+# Compilation output
+/dist
+
+# Misc
 .env
 .DS_Store
+/nft
 
 # Hardhat files
 /cache
@@ -9,8 +16,9 @@ node_modules
 # TypeChain files
 /typechain
 /typechain-types
+/types/ethers-contracts
 
-# solidity-coverage files
+# Hardhat coverage reports
 /coverage
 /coverage.json
 

.husky/pre-commit

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+npx lint-staged

.prettierrc.json

@@ -7,12 +7,12 @@
   "useTabs": false,
   "tabWidth": 2,
   "bracketSpacing": true,
+  "plugins": ["prettier-plugin-solidity"],
   "overrides": [
     {
       "files": "*.sol",
       "options": {
         "singleQuote": false,
-        "explicitTypes": "always",
         "bracketSpacing": false
       }
     }

.solhint.json

@@ -2,6 +2,7 @@
   "extends": "solhint:recommended",
   "rules": {
     "func-visibility": ["warn", { "ignoreConstructors": true }],
-    "compiler-version": ["error", ">=0.8.20 <0.9.0 || 0.4.24"]
+    "compiler-version": ["error", ">=0.8.20 <0.9.0 || 0.4.24"],
+    "use-natspec": "off"
   }
 }

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "dbaeumer.vscode-eslint",
+    "NomicFoundation.hardhat-solidity",
+    "ms-vscode.vscode-typescript-next"
+  ]
+}

.vscode/settings.json

@@ -1,27 +1,26 @@
 {
-  "solidity.compileUsingRemoteVersion": "v0.8.24+commit.e11b9ed9",
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit"
   },
-  "[typescript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.formatOnSave": true,
-    "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": "explicit"
-    }
-  },
-  "[javascript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.formatOnSave": true,
-    "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": "explicit"
-    }
+  "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact"],
+  "eslint.workingDirectories": ["."],
+  "prettier.configPath": "./.prettierrc.json",
+  "typescript.preferences.importModuleSpecifier": "relative",
+  "files.associations": {
+    "*.sol": "solidity"
   },
   "[solidity]": {
     "editor.defaultFormatter": "NomicFoundation.hardhat-solidity"
   },
-  "eslint.validate": ["javascript", "typescript"],
-  "eslint.workingDirectories": ["."]
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
 }

contracts/ERC1967Proxy.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.20;
+
+import {ERC1967Proxy as OZProxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
+
+/**
+ * @dev Simple wrapper around OpenZeppelin's ERC1967Proxy for Hardhat artifacts
+ */
+contract ERC1967Proxy is OZProxy {
+  constructor(address _logic, bytes memory _data) OZProxy(_logic, _data) {}
+}

contracts/RIFToken.sol

@@ -1,7 +1,12 @@
-// SPDX-License-Identifier: UNLICENSED
+// SPDX-License-Identifier: MIT
+
 pragma solidity ^0.4.24;
 
+import {RIFToken as RIF} from "rif-token-contracts/contracts/RIF/RIFToken.sol";
+
 /**
  * @dev RIF token original implementation for testing its wrapping with StRIF
  */
-import "rif-token-contracts/contracts/RIF/RIFToken.sol";
+contract RIFToken is RIF {
+  constructor() public RIF() {}
+}

eslint.config.mjs

@@ -1,11 +1,16 @@
+import { defineConfig } from 'eslint/config'
 import globals from 'globals'
 import pluginJs from '@eslint/js'
+import { includeIgnoreFile } from '@eslint/compat'
 import tseslint from 'typescript-eslint'
 import eslintPluginPrettier from 'eslint-plugin-prettier/recommended'
 import json from '@eslint/json'
 import markdown from '@eslint/markdown'
+import { fileURLToPath } from 'node:url'
 
-export default [
+const gitignorePath = fileURLToPath(new URL('.gitignore', import.meta.url))
+
+export default defineConfig([
   // 1) Base config for JS & TS
   {
     files: ['**/*.{js,mjs,cjs,ts}'],
@@ -36,12 +41,15 @@ export default [
     },
   },
 
-  // 5) **Override just for test files**
+  // 5) Ignore gitignore files and folders
+  includeIgnoreFile(gitignorePath, 'Imported .gitignore patterns'),
+
+  // 6) **Override just for test files**
   {
     files: ['test/**/*.ts', 'test/**/*.js'],
     rules: {
       // Turn off the rule that flags Chai property-based assertions
       '@typescript-eslint/no-unused-expressions': 'off',
     },
   },
-]
+])