feat(examples): overloads (#149)

* wip: overloads * feat: overloads * feat: support optional properties * refactor: remove barrel files * chore: changeset Co-authored-by: 0xRaiden <[email protected]> * chore: cleanup * test(examples): update --------- Co-authored-by: 0xRaiden <[email protected]>
wevm · Jun 9, 2023 · ba21aae · ba21aae · vercel · Jun 9, 2023
1 parent 43d3a9d
commit ba21aae
Show file tree

Hide file tree

Showing 56 changed files with 1,501 additions and 1,453 deletions.
diff --git a/.changeset/dry-shrimps-enjoy.md b/.changeset/dry-shrimps-enjoy.md
@@ -0,0 +1,5 @@
+---
+"abitype": patch
+---
+
+Removed internal barrel exports.
diff --git a/examples/readContract.test-d.ts → examples/read.test-d.ts b/examples/readContract.test-d.ts → examples/read.test-d.ts
@@ -4,26 +4,23 @@ import {
   wagmiMintExampleAbi,
   wagmiMintExampleHumanReadableAbi,
   writingEditionsFactoryAbi,
-  zeroAddress,
 } from 'abitype/test'
-import { assertType, test } from 'vitest'
+import { assertType, expectTypeOf, test } from 'vitest'
 
-import { readContract, readWagmiMintExample } from './readContract.js'
+import { read, readWagmiMintExample, useRead } from './read.js'
 
-test('readContract', () => {
+test('read', () => {
   test('args', () => {
     test('zero', () => {
-      const result = readContract({
-        address: zeroAddress,
+      const result = read({
         abi: wagmiMintExampleAbi,
         functionName: 'name',
       })
       assertType<string>(result)
     })
 
     test('one', () => {
-      const result = readContract({
-        address: zeroAddress,
+      const result = read({
         abi: wagmiMintExampleAbi,
         functionName: 'tokenURI',
         args: [123n],
@@ -32,29 +29,26 @@ test('readContract', () => {
     })
 
     test('two or more', () => {
-      const result = readContract({
-        address: zeroAddress,
+      const result = read({
         abi: writingEditionsFactoryAbi,
         functionName: 'predictDeterministicAddress',
-        args: [zeroAddress, '0xfoo'],
+        args: ['0x', '0xfoo'],
       })
       assertType<Address>(result)
     })
   })
 
   test('return types', () => {
     test('string', () => {
-      const result = readContract({
-        address: zeroAddress,
+      const result = read({
         abi: wagmiMintExampleAbi,
         functionName: 'name',
       })
       assertType<string>(result)
     })
 
     test('Address', () => {
-      const result = readContract({
-        address: zeroAddress,
+      const result = read({
         abi: wagmiMintExampleAbi,
         functionName: 'ownerOf',
         args: [123n],
@@ -63,20 +57,18 @@ test('readContract', () => {
     })
 
     test('number', () => {
-      const result = readContract({
-        address: zeroAddress,
+      const result = read({
         abi: wagmiMintExampleAbi,
         functionName: 'balanceOf',
-        args: [zeroAddress],
+        args: ['0x'],
       })
       assertType<ResolvedConfig['BigIntType']>(result)
     })
   })
 
   test('behavior', () => {
     test('write function not allowed', () => {
-      const result = readContract({
-        address: zeroAddress,
+      const result = read({
         abi: wagmiMintExampleAbi,
         // @ts-expect-error Trying to use non-read function
         functionName: 'approve',
@@ -101,16 +93,14 @@ test('readContract', () => {
           outputs: [{ type: 'address', name: '' }],
         },
       ]
-      const result1 = readContract({
-        address: zeroAddress,
+      const result1 = read({
         abi: abi,
         functionName: 'foo',
       })
-      const result2 = readContract({
-        address: zeroAddress,
+      const result2 = read({
         abi: abi,
         functionName: 'bar',
-        args: [zeroAddress],
+        args: ['0x'],
       })
       type Result1 = typeof result1
       type Result2 = typeof result2
@@ -135,16 +125,14 @@ test('readContract', () => {
           outputs: [{ type: 'address', name: '' }],
         },
       ]
-      const result1 = readContract({
-        address: zeroAddress,
+      const result1 = read({
         abi: abi,
         functionName: 'foo',
       })
-      const result2 = readContract({
-        address: zeroAddress,
+      const result2 = read({
         abi: abi,
         functionName: 'bar',
-        args: [zeroAddress],
+        args: ['0x'],
       })
       type Result1 = typeof result1
       type Result2 = typeof result2
@@ -153,8 +141,7 @@ test('readContract', () => {
     })
 
     test('defined inline', () => {
-      const result1 = readContract({
-        address: zeroAddress,
+      const result1 = read({
         abi: [
           {
             name: 'foo',
@@ -173,8 +160,7 @@ test('readContract', () => {
         ],
         functionName: 'foo',
       })
-      const result2 = readContract({
-        address: zeroAddress,
+      const result2 = read({
         abi: [
           {
             name: 'foo',
@@ -192,7 +178,7 @@ test('readContract', () => {
           },
         ],
         functionName: 'bar',
-        args: [zeroAddress],
+        args: ['0x'],
       })
       type Result1 = typeof result1
       type Result2 = typeof result2
@@ -201,11 +187,10 @@ test('readContract', () => {
     })
 
     test('human readable', () => {
-      const result = readContract({
-        address: zeroAddress,
+      const result = read({
         abi: parseAbi(wagmiMintExampleHumanReadableAbi),
         functionName: 'balanceOf',
-        args: [zeroAddress],
+        args: ['0x'],
       })
       assertType<bigint>(result)
     })
@@ -216,19 +201,60 @@ test('readWagmiMintExample', () => {
   test('args', () => {
     test('zero', () => {
       const result = readWagmiMintExample({
-        address: '0x…',
         functionName: 'name',
       })
       assertType<string>(result)
     })
 
     test('one', () => {
       const result = readWagmiMintExample({
-        address: '0x…',
         functionName: 'balanceOf',
-        args: ['0x…'],
+        args: ['0x'],
       })
       assertType<bigint>(result)
     })
   })
 })
+
+const abi = parseAbi([
+  'function foo() returns (bool)',
+  'function foo() returns (uint8)',
+  'function foo(uint) view returns (address)',
+  'function foo(address) view returns (uint)',
+  'function foo(uint256, address) view returns (address, uint8)',
+  'function bar() pure returns (address)',
+  'function baz(uint) pure returns (string)',
+  'function boo(bytes32) pure returns (bytes32)',
+])
+expectTypeOf(
+  read({
+    abi,
+    functionName: 'foo',
+    args: [123n, '0x'],
+  }),
+).toEqualTypeOf<readonly [Address, number]>()
+expectTypeOf(
+  read({
+    abi,
+    functionName: 'foo',
+  }),
+).toEqualTypeOf<boolean | number>()
+expectTypeOf(
+  useRead({
+    abi,
+    functionName: 'foo',
+    args: [123n, '0x'],
+  }),
+).toEqualTypeOf<readonly [Address, number]>()
+
+const abi2 = parseAbi([
+  'function foo(address) view returns (uint)',
+  // 'function foo(address) view returns (string)',
+])
+const res = read({
+  abi: abi2,
+  functionName: 'foo',
+  args: ['0x'],
+})
+res
+// ^?
diff --git a/examples/read.ts b/examples/read.ts
@@ -0,0 +1,48 @@
+import { type Abi } from 'abitype'
+import type { wagmiMintExampleAbi } from 'abitype/test'
+
+import type {
+  ContractParameters,
+  ContractReturnType,
+  DeepPartial,
+} from './types.js'
+
+export declare function read<
+  const abi extends Abi | readonly unknown[], // `readonly unknown[]` allows for non-const asserted types
+  functionName extends string,
+  const args extends readonly unknown[] | undefined,
+>(
+  parameters: ReadParameters<abi, functionName, args>,
+): ReadReturnType<abi, functionName, args>
+
+export declare function readWagmiMintExample<
+  functionName extends string,
+  const args extends readonly unknown[] | undefined,
+>(
+  parameters: Omit<
+    ReadParameters<typeof wagmiMintExampleAbi, functionName, args>,
+    'abi'
+  >,
+): ReadReturnType<typeof wagmiMintExampleAbi, functionName, args>
+
+export declare function useRead<
+  const abi extends Abi | readonly unknown[], // `readonly unknown[]` allows for non-const asserted types
+  const functionName extends string,
+  const args extends readonly unknown[] | undefined,
+>(
+  parameters: DeepPartial<ReadParameters<abi, functionName, args>, 1>,
+): ReadReturnType<abi, functionName, args>
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export type ReadParameters<
+  abi extends Abi | readonly unknown[],
+  functionName extends string,
+  args extends readonly unknown[] | undefined = readonly unknown[] | undefined,
+> = { abi: abi } & ContractParameters<abi, functionName, 'pure' | 'view', args>
+
+export type ReadReturnType<
+  abi extends Abi | readonly unknown[],
+  functionName extends string,
+  args extends readonly unknown[] | undefined,
+> = ContractReturnType<abi, functionName, args>
diff --git a/examples/readContract.ts b/examples/readContract.ts