Migrate EVM typegen to new codec (#261)

subsquid · May 3, 2024 · b7fa5d8 · b7fa5d8
1 parent 1a6d5da
commit b7fa5d8
Show file tree

Hide file tree

Showing 18 changed files with 627 additions and 882 deletions.
diff --git a/common/changes/@subsquid/evm-abi/new-evm-typegen_2024-05-03-08-59.json b/common/changes/@subsquid/evm-abi/new-evm-typegen_2024-05-03-08-59.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@subsquid/evm-abi",
+      "comment": "Added types for event arguments, function parameters and return values",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@subsquid/evm-abi"
+}
diff --git a/common/changes/@subsquid/evm-typegen/new-evm-typegen_2024-05-03-08-59.json b/common/changes/@subsquid/evm-typegen/new-evm-typegen_2024-05-03-08-59.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@subsquid/evm-typegen",
+      "comment": "Migrate typegen to new codec; Drop dependency to ethers.js",
+      "type": "major"
+    }
+  ],
+  "packageName": "@subsquid/evm-typegen"
+}
diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/evm/evm-abi/package.json b/evm/evm-abi/package.json
@@ -16,7 +16,8 @@
     "build": "rm -rf lib && tsc -p tsconfig.build.json"
   },
   "dependencies": {
-    "@subsquid/evm-codec": "^0.0.0"
+    "@subsquid/evm-codec": "^0.0.0",
+    "keccak256": "^1.0.6"
   },
   "devDependencies": {
     "@types/node": "^18.18.14",

diff --git a/evm/evm-abi/src/abi-components/event.ts b/evm/evm-abi/src/abi-components/event.ts
@@ -14,6 +14,8 @@ export type IndexedCodecs<T extends EventArgs> = Pretty<{
   [K in keyof T]: T[K] extends { indexed: true; isDynamic: true } ? typeof bytes32 & { indexed: true } : T[K]
 }>
 
+export type EventParams<T extends AbiEvent<any>> = T extends AbiEvent<infer U> ? StructTypes<U> : never
+
 export class AbiEvent<const T extends EventArgs> {
   public readonly params: any
   constructor(public readonly topic: string, args: T) {

diff --git a/evm/evm-abi/src/abi-components/function.ts b/evm/evm-abi/src/abi-components/function.ts
@@ -9,7 +9,9 @@ function slotsCount(codecs: readonly Codec<any>[]) {
   return count
 }
 
-type FunctionReturn<T> = T extends Codec<infer U> ? U : T extends Struct ? StructTypes<T> : undefined
+export type FunctionReturn<T> = T extends Codec<infer U> ? U : T extends Struct ? StructTypes<T> : void
+
+export type FunctionArguments<T extends AbiFunction<any, any>> = T extends AbiFunction<infer U, any> ? StructTypes<U> : never
 
 export class AbiFunction<const T extends Struct, const R extends Codec<any> | Struct | undefined> {
   readonly #selector: Buffer

diff --git a/evm/evm-abi/src/index.ts b/evm/evm-abi/src/index.ts
@@ -1,5 +1,7 @@
 export { ContractBase } from './contract-base'
 
 export { indexed } from './indexed'
-export { fun, AbiFunction } from './abi-components/function'
-export { event, AbiEvent, type EventRecord } from './abi-components/event'
+export { fun, AbiFunction, type FunctionReturn, type FunctionArguments } from './abi-components/function'
+export { event, AbiEvent, type EventRecord, type EventParams } from './abi-components/event'
+import keccak256 from 'keccak256'
+export { keccak256 }
diff --git a/evm/evm-typegen/package.json b/evm/evm-typegen/package.json
@@ -24,12 +24,12 @@
     "@subsquid/util-internal": "^3.2.0",
     "@subsquid/util-internal-code-printer": "^1.2.2",
     "@subsquid/util-internal-commander": "^1.4.0",
+    "@subsquid/evm-codec": "0.0.0",
+    "@subsquid/evm-abi": "0.0.0",
     "commander": "^11.1.0"
   },
-  "peerDependencies": {
-    "ethers": "^6.9.0"
-  },
   "devDependencies": {
+    "abitype": "^1.0.0",
     "@types/node": "^18.18.14",
     "typescript": "~5.3.2"
   }

diff --git a/evm/evm-typegen/src/abi.support.ts b/evm/evm-typegen/src/abi.support.ts