chore: support ethersv5 types for interfaces

Signed-off-by: Tomás Migone <[email protected]>

Author: tmigone

.gitignore

@@ -32,6 +32,8 @@ build/
 typechain/
 typechain-types/
 types/
+types-v5/
+wagmi/
 deployments/hardhat/
 
 # TypeScript incremental compilation cache
@@ -81,6 +83,3 @@ tx-builder-*.json
 **/ignition/deployments/*-hardhat/
 **/ignition/deployments/*-31337/
 **/ignition/deployments/*-1337/
-
-# wagmi generated types
-wagmi/

packages/interfaces/package.json

@@ -15,25 +15,32 @@
     "./wagmi": {
       "default": "./dist/wagmi/generated.js",
       "types": "./dist/wagmi/generated.d.ts"
+    },
+    "./types-v5": {
+      "default": "./dist/types-v5/index.js",
+      "types": "./dist/types-v5/index.d.ts"
     }
   },
   "files": [
     "artifacts/**/*",
     "dist/**/*",
     "contracts/**/*",
     "types/**/*",
+    "types-v5/**/*",
+    "wagmi/**/*",
     "README.md"
   ],
   "author": "The Graph Team",
   "license": "GPL-2.0-or-later",
   "scripts": {
-    "clean": "rm -rf dist cache artifacts types",
+    "clean": "rm -rf dist cache artifacts types wagmi",
     "lint": "pnpm lint:ts; pnpm lint:sol; pnpm lint:json",
     "lint:ts": "eslint --fix --cache '**/*.{js,ts,cjs,mjs,jsx,tsx}'; prettier -w --cache --log-level warn '**/*.{js,ts,cjs,mjs,jsx,tsx}'",
     "lint:sol": "solhint --fix --noPrompt --noPoster 'contracts/**/*.sol'; prettier -w --cache --log-level warn 'contracts/**/*.sol'",
     "lint:json": "prettier -w --cache --log-level warn '**/*.json'",
     "format": "prettier -w --cache --log-level warn '**/*.{js,ts,cjs,mjs,jsx,tsx,json,md,yaml,yml}'",
-    "build": "hardhat compile && wagmi generate && tsc",
+    "build": "hardhat compile && pnpm build:types && tsc",
+    "build:types": "scripts/build-types.sh",
     "build:clean": "pnpm clean && pnpm build",
     "watch": "tsc --watch",
     "prepublishOnly": "pnpm run build"
@@ -43,13 +50,15 @@
     "@nomicfoundation/hardhat-toolbox": "^4.0.0",
     "@openzeppelin/contracts": "3.4.1",
     "@openzeppelin/contracts-upgradeable": "3.4.2",
+    "@typechain/ethers-v5": "^10.2.1",
     "@wagmi/cli": "^2.3.1",
     "ethers": "6.13.7",
     "hardhat": "^2.24.0",
     "markdownlint-cli": "^0.45.0",
     "prettier": "^3.5.3",
     "prettier-plugin-solidity": "^2.0.0",
     "solhint": "5.1.0",
+    "typechain": "^8.3.2",
     "viem": "^2.31.7"
   }
 }

packages/interfaces/scripts/build-types.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# This script builds WAGMI and ethers-v5 types for interacting with the contracts
+# Note that ethers-v6 types are automatically generated by hardhat compilation step
+# - wagmi: wagmi/
+# - ethers-v5: types-v5/
+# - ethers-v6: types/
+
+# Build wagmi types
+pnpm wagmi generate
+
+# Build ethers-v5 types
+pnpm typechain \
+  --target ethers-v5 \
+  --out-dir types-v5 \
+  'artifacts/contracts/**/!(*.dbg).json' \
+  'artifacts/@openzeppelin/**/!(*.dbg).json'