fix: change zod schemas inputs/outputs to readonly to match abitype

.changeset/seven-planes-deliver.md

@@ -0,0 +1,10 @@
+---
+"abitype": patch
+---
+
+Changed the following types to readonly in zod package:
+
+- `AbiContructor.inputs`
+- `AbiError.inputs`
+- `AbiEvent.inputs`
+- `AbiFunction.inputs` / `AbiFunction.outputs`

.github/CONTRIBUTING.md

@@ -82,6 +82,8 @@ pnpm install
 
 After the install completes, pnpm links packages across the project for development and [git hooks](https://github.com/toplenboren/simple-git-hooks) are set up.
 
+> **Note:** In case you have to install new packages or upgrade packages make sure to use **pnpm@8.3.1** and **typescript@5.0.4**
+
 <div align="right">
   <a href="#basic-guide">&uarr; back to top</a></b>
 </div>
@@ -95,6 +97,8 @@ pnpm test
 pnpm test:typecheck
 ```
 
+> **Note** Ensure to build the package (`pnpm build`) before running the `test:typecheck` suite.
+
 <div align="right">
   <a href="#basic-guide">&uarr; back to top</a></b>
 </div>

package.json

@@ -70,20 +70,14 @@
   },
   "typesVersions": {
     "*": {
-      "config": [
-        "./dist/types/config.d.ts"
-      ],
-      "test": [
-        "./dist/types/test.d.ts"
-      ],
-      "zod": [
-        "./dist/types/zod.d.ts"
-      ]
+      "config": ["./dist/types/config.d.ts"],
+      "test": ["./dist/types/test.d.ts"],
+      "zod": ["./dist/types/zod.d.ts"]
     }
   },
   "peerDependencies": {
     "typescript": ">=5.0.4",
-    "zod": "^3 >=3.19.1"
+    "zod": "^3 >=3.22.0"
   },
   "peerDependenciesMeta": {
     "typescript": {
@@ -109,25 +103,16 @@
     "typescript": "5.0.4",
     "typescript@5.1.3": "npm:typescript@5.1.3",
     "vitest": "^0.30.1",
-    "zod": "^3.20.6"
+    "zod": "^3.22.4"
   },
-  "contributors": [
-    "jxom.eth <j@wagmi.sh>",
-    "awkweb.eth <t@wagmi.sh>"
-  ],
+  "contributors": ["jxom.eth <j@wagmi.sh>", "awkweb.eth <t@wagmi.sh>"],
   "funding": [
     {
       "type": "github",
       "url": "https://github.com/sponsors/wagmi-dev"
     }
   ],
-  "keywords": [
-    "abi",
-    "eth",
-    "ethereum",
-    "typescript",
-    "web3"
-  ],
+  "keywords": ["abi", "eth", "ethereum", "typescript", "web3"],
   "simple-git-hooks": {
     "pre-commit": "pnpm format && pnpm lint:fix"
   },
@@ -138,9 +123,7 @@
       "shiki-twoslash>shiki": "^0.14.1"
     },
     "peerDependencyRules": {
-      "ignoreMissing": [
-        "@algolia/client-search"
-      ]
+      "ignoreMissing": ["@algolia/client-search"]
     }
   }
 }

src/zod.test-d.ts

@@ -1,17 +1,106 @@
-import type { Abi } from './abi.js'
-import { Abi as AbiSchema } from './zod.js'
+import type {
+  Abi,
+  AbiConstructor,
+  AbiError,
+  AbiEvent,
+  AbiParameter,
+} from './abi.js'
+import {
+  customSolidityErrorsAbi,
+  ensRegistryWithFallbackAbi,
+  erc20Abi,
+} from './test/abis.js'
+import {
+  Abi as AbiSchema,
+  AbiConstructor as AbiConstructorSchema,
+  AbiError as AbiErrorSchema,
+  AbiEvent as AbiEventSchema,
+  AbiParameter as AbiParameterSchema,
+} from './zod.js'
 import { describe, expectTypeOf, test } from 'vitest'
 
 describe('Zod Types', () => {
-  test('assignable to Abi', () => {
-    const parsed: Abi = AbiSchema.parse([])
-    type Result = typeof parsed extends Abi ? true : false
-    expectTypeOf<Result>().toEqualTypeOf<true>()
+  describe('Abi', () => {
+    test('assignable to Abi', () => {
+      const parsed: Abi = AbiSchema.parse(erc20Abi)
+      type Result = typeof parsed extends Abi ? true : false
+      expectTypeOf<Result>().toEqualTypeOf<true>()
+    })
+
+    test('extends Abi', () => {
+      const parsed = AbiSchema.parse(erc20Abi)
+      type Result = typeof parsed extends Abi ? true : false
+      expectTypeOf<Result>().toEqualTypeOf<true>()
+    })
+  })
+
+  describe('AbiConstructor', () => {
+    const ensRegistryConstructor = ensRegistryWithFallbackAbi[0]
+
+    test('assignable to AbiConstructor', () => {
+      const parsed: AbiConstructor = AbiConstructorSchema.parse(
+        ensRegistryConstructor,
+      )
+      type Result = typeof parsed extends AbiConstructor ? true : false
+      expectTypeOf<Result>().toEqualTypeOf<true>()
+    })
+
+    test('extends AbiConstructor', () => {
+      const parsed = AbiConstructorSchema.parse(ensRegistryConstructor)
+      type Result = typeof parsed extends AbiConstructor ? true : false
+      expectTypeOf<Result>().toEqualTypeOf<true>()
+    })
   })
 
-  test('extends Abi', () => {
-    const parsed = AbiSchema.parse([])
-    type Result = typeof parsed extends Abi ? true : false
-    expectTypeOf<Result>().toEqualTypeOf<true>()
+  describe('AbiError', () => {
+    const approvalCallerNotOwnerNorApproved = customSolidityErrorsAbi[1]
+
+    test('assignable to AbiError', () => {
+      const parsed: AbiError = AbiErrorSchema.parse(
+        approvalCallerNotOwnerNorApproved,
+      )
+      type Result = typeof parsed extends AbiError ? true : false
+      expectTypeOf<Result>().toEqualTypeOf<true>()
+    })
+
+    test('extends AbiError', () => {
+      const parsed = AbiErrorSchema.parse(approvalCallerNotOwnerNorApproved)
+      type Result = typeof parsed extends AbiError ? true : false
+      expectTypeOf<Result>().toEqualTypeOf<true>()
+    })
+  })
+
+  describe('AbiEvent', () => {
+    const approvalEvent = erc20Abi[0]
+
+    test('assignable to AbiEvent', () => {
+      const parsed: AbiEvent = AbiEventSchema.parse(approvalEvent)
+      type Result = typeof parsed extends AbiEvent ? true : false
+      expectTypeOf<Result>().toEqualTypeOf<true>()
+    })
+
+    test('extends AbiEvent', () => {
+      const parsed = AbiEventSchema.parse(approvalEvent)
+      type Result = typeof parsed extends AbiEvent ? true : false
+      expectTypeOf<Result>().toEqualTypeOf<true>()
+    })
+  })
+
+  describe('AbiParameter', () => {
+    const approvalOwnerParameter = erc20Abi[0].inputs[0]
+
+    test('assignable to AbiParameter', () => {
+      const parsed: AbiParameter = AbiParameterSchema.parse(
+        approvalOwnerParameter,
+      )
+      type Result = typeof parsed extends AbiParameter ? true : false
+      expectTypeOf<Result>().toEqualTypeOf<true>()
+    })
+
+    test('extends AbiParameter', () => {
+      const parsed = AbiParameterSchema.parse(approvalOwnerParameter)
+      type Result = typeof parsed extends AbiParameter ? true : false
+      expectTypeOf<Result>().toEqualTypeOf<true>()
+    })
   })
 })

src/zod.ts

@@ -71,7 +71,7 @@ export const AbiParameter: z.ZodType<AbiParameterType> = z.lazy(() =>
       }),
       z.object({
         type: z.union([SolidityTuple, SolidityArrayWithTuple]),
-        components: z.array(AbiParameter),
+        components: z.array(AbiParameter).readonly(),
       }),
     ]),
   ),
@@ -110,9 +110,9 @@ export const AbiFunction = z.preprocess(
      * https://github.com/vyperlang/vyper/issues/2151
      */
     gas: z.number().optional(),
-    inputs: z.array(AbiParameter),
+    inputs: z.array(AbiParameter).readonly(),
     name: Identifier,
-    outputs: z.array(AbiParameter),
+    outputs: z.array(AbiParameter).readonly(),
     /**
      * @deprecated use `payable` or `nonpayable` from {@link AbiStateMutability} instead
      * https://github.com/ethereum/solidity/issues/992
@@ -138,7 +138,7 @@ export const AbiConstructor = z.preprocess(
      * @deprecated use `pure` or `view` from {@link AbiStateMutability} instead
      * https://github.com/ethereum/solidity/issues/992
      */
-    inputs: z.array(AbiParameter),
+    inputs: z.array(AbiParameter).readonly(),
     /**
      * @deprecated use `payable` or `nonpayable` from {@link AbiStateMutability} instead
      * https://github.com/ethereum/solidity/issues/992
@@ -182,13 +182,13 @@ export const AbiReceive = z.object({
 export const AbiEvent = z.object({
   type: z.literal('event'),
   anonymous: z.boolean().optional(),
-  inputs: z.array(AbiEventParameter),
+  inputs: z.array(AbiEventParameter).readonly(),
   name: Identifier,
 })
 
 export const AbiError = z.object({
   type: z.literal('error'),
-  inputs: z.array(AbiParameter),
+  inputs: z.array(AbiParameter).readonly(),
   name: z.string(),
 })
 
@@ -263,14 +263,14 @@ export const Abi = z.array(
         z.discriminatedUnion('type', [
           z.object({
             type: z.literal('function'),
-            inputs: z.array(AbiParameter),
+            inputs: z.array(AbiParameter).readonly(),
             name: z.string().regex(/[a-zA-Z$_][a-zA-Z0-9$_]*/),
-            outputs: z.array(AbiParameter),
+            outputs: z.array(AbiParameter).readonly(),
             stateMutability: AbiStateMutability,
           }),
           z.object({
             type: z.literal('constructor'),
-            inputs: z.array(AbiParameter),
+            inputs: z.array(AbiParameter).readonly(),
             stateMutability: z.union([
               z.literal('payable'),
               z.literal('nonpayable'),