feat: abi parameter named tuples

.changeset/angry-squids-rescue.md

@@ -0,0 +1,5 @@
+---
+"viem": minor
+---
+
+Added experimental named tuple support for contract-related actions and utilities.

.github/actions/setup-wagmi/action.yml

@@ -33,11 +33,6 @@ runs:
       run: pnpm install --no-frozen-lockfile
       working-directory: ./wagmi
 
-    - name: Build packages
-      shell: bash
-      run: pnpm build
-      working-directory: ./wagmi
-
     - name: Link packages
       shell: bash
       run: pnpm preconstruct

.github/workflows/verify.yml

@@ -227,7 +227,7 @@ jobs:
     timeout-minutes: 10
     strategy:
       matrix:
-        typescript-version: ['5.7.2', '5.8.2', '5.9.2', 'latest']
+        typescript-version: ['5.7.2', '5.8.3', '5.9.2', 'latest']
 
     steps:
       - name: Clone repository

pnpm-workspace.yaml

@@ -11,6 +11,7 @@ catalog:
 minimumReleaseAge: 1440
 minimumReleaseAgeExclude:
   - '@vitest/*'
+  - abitype
   - glob  
   - hono
   - vitest

src/actions/getContract.ts

@@ -825,7 +825,7 @@ type GetReadFunction<
     ? ExtractAbiFunction<abi, functionName>
     : AbiFunction,
   //
-  _args = AbiParametersToPrimitiveTypes<abiFunction['inputs']>,
+  _args = AbiParametersToPrimitiveTypes<abiFunction['inputs'], 'inputs', true>,
   _options = Prettify<
     UnionOmit<
       ReadContractParameters<abi, functionName, args>,
@@ -859,7 +859,7 @@ type GetEstimateFunction<
     ? ExtractAbiFunction<abi, functionName>
     : AbiFunction,
   //
-  _args = AbiParametersToPrimitiveTypes<abiFunction['inputs']>,
+  _args = AbiParametersToPrimitiveTypes<abiFunction['inputs'], 'inputs', true>,
   _options = Prettify<
     UnionOmit<
       EstimateContractGasParameters<abi, functionName, args, chain>,
@@ -909,7 +909,7 @@ type GetSimulateFunction<
     ? ExtractAbiFunction<abi, functionName>
     : AbiFunction,
   //
-  _args = AbiParametersToPrimitiveTypes<abiFunction['inputs']>,
+  _args = AbiParametersToPrimitiveTypes<abiFunction['inputs'], 'inputs', true>,
 > = narrowable extends true
   ? <
       chainOverride extends Chain | undefined = undefined,
@@ -1003,7 +1003,7 @@ type GetWriteFunction<
     ? ExtractAbiFunction<abi, functionName>
     : AbiFunction,
   //
-  _args = AbiParametersToPrimitiveTypes<abiFunction['inputs']>,
+  _args = AbiParametersToPrimitiveTypes<abiFunction['inputs'], 'inputs', true>,
   // For making `options` parameter required if `account` or `chain` is undefined
   _isOptionsRequired = Or<[IsUndefined<account>, IsUndefined<chain>]>,
 > = narrowable extends true

src/actions/public/multicall.test-d.ts

@@ -250,7 +250,7 @@ test('many contracts of differing types', async () => {
         address: '0x',
         abi: parseAbi([
           'function foo() view returns (int8)',
-          'function foo(address) view returns (string)',
+          'function foo(address account) view returns (string)',
           'function foo(address, address) view returns ((address foo, address bar))',
           'function bar() view returns (int8)',
         ]),

src/actions/public/readContract.bench-d.ts

@@ -1,20 +1,43 @@
 import { attest } from '@ark/attest'
+import { parseAbi } from 'abitype'
+import { erc20Abi } from 'abitype/abis'
 import { test } from 'vitest'
-
-import { usdcContractConfig } from '~test/abis.js'
 import { mainnet } from '../../chains/index.js'
 import { createClient } from '../../clients/createClient.js'
 import { http } from '../../clients/transports/http.js'
-import { readContract } from './readContract.js'
+import { type ReadContractParameters, readContract } from './readContract.js'
 
 const client = createClient({ chain: mainnet, transport: http() })
 
 test('return type', () => {
   const res = readContract(client, {
-    ...usdcContractConfig,
+    address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+    abi: erc20Abi,
     functionName: 'balanceOf',
     args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
   })
-  attest.instantiations([53192, 'instantiations'])
+  attest.instantiations([63834, 'instantiations'])
   attest<Promise<bigint>>(res)
 })
+
+const abi = parseAbi([
+  'function foo() view returns (int8)',
+  'function foo(address account) view returns (string)',
+  'function foo(address sender, address account) view returns ((address foo, address bar))',
+  'function bar() view returns (int8)',
+])
+test('overloads', () => {
+  type Result = ReadContractParameters<typeof abi, 'foo'>
+  const res = {} as Result
+  attest.instantiations([14699, 'instantiations'])
+  attest<
+    | readonly []
+    | readonly [account: `0x${string}`]
+    | readonly [sender: `0x${string}`, account: `0x${string}`]
+    | undefined
+  >(res.args)
+  attest(res.args).type.toString.snap(`  | readonly []
+  | readonly [account: \`0x\${string}\`]
+  | readonly [sender: \`0x\${string}\`, account: \`0x\${string}\`]
+  | undefined`)
+})

src/actions/public/readContract.test-d.ts

@@ -207,7 +207,7 @@ test('behavior', () => {
           name: 'bar',
           type: 'function',
           stateMutability: 'view',
-          inputs: [{ type: 'address', name: '' }],
+          inputs: [{ type: 'address', name: 'account' }],
           outputs: [{ type: 'address', name: '' }],
         },
       ],
@@ -231,8 +231,8 @@ test('behavior', () => {
   test('overloads', async () => {
     const abi = parseAbi([
       'function foo() view returns (int8)',
-      'function foo(address) view returns (string)',
-      'function foo(address, address) view returns ((address foo, address bar))',
+      'function foo(address tokenId) view returns (string)',
+      'function foo(address spender, address account) view returns ((address foo, address bar))',
       'function bar() view returns (int8)',
     ])
 

src/actions/public/simulateContract.ts

@@ -83,6 +83,8 @@ export type SimulateContractParameters<
   accountOverride extends Account | Address | null | undefined = undefined,
   ///
   derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+  callParameters extends
+    CallParameters<derivedChain> = CallParameters<derivedChain>,
 > = {
   account?: accountOverride | null | undefined
   chain?: chainOverride | undefined
@@ -95,7 +97,7 @@ export type SimulateContractParameters<
   args
 > &
   UnionOmit<
-    CallParameters<derivedChain>,
+    callParameters,
     | 'account'
     | 'batch'
     | 'code'
@@ -109,9 +111,7 @@ export type SimulateContractParameters<
     abi,
     'nonpayable' | 'payable',
     functionName,
-    CallParameters<derivedChain> extends CallParameters
-      ? CallParameters<derivedChain>['value']
-      : CallParameters['value'],
+    callParameters['value'],
     args
   >
 

src/actions/public/verifyHash.ts

@@ -223,13 +223,13 @@ export async function verifyErc8010(
     args: [
       [
         ...(initData
-          ? [
+          ? ([
               {
                 allowFailure: true,
                 target: to ?? address,
                 callData: initData,
               },
-            ]
+            ] as const)
           : []),
         {
           allowFailure: true,

src/actions/wallet/writeContract.bench-d.ts

@@ -0,0 +1,37 @@
+import { attest } from '@ark/attest'
+import { parseAbi } from 'abitype'
+import type { erc20Abi } from 'abitype/abis'
+import { test } from 'vitest'
+import type { WriteContractParameters } from './writeContract.js'
+
+test('default', () => {
+  type Result = WriteContractParameters<typeof erc20Abi, 'approve'>
+  const res = {} as Result
+  attest.instantiations([9217, 'instantiations'])
+  attest<readonly [spender: `0x${string}`, amount: bigint]>(res.args)
+  attest(res.args).type.toString.snap(
+    `readonly [spender: \`0x\${string}\`, amount: bigint]`,
+  )
+})
+
+const abi = parseAbi([
+  'function foo() returns (int8)',
+  'function foo(address account) returns (string)',
+  'function foo(address sender, address account) returns ((address foo, address bar))',
+  'function bar() returns (int8)',
+])
+test('overloads', () => {
+  type Result = WriteContractParameters<typeof abi, 'foo'>
+  const res = {} as Result
+  attest.instantiations([14699, 'instantiations'])
+  attest<
+    | readonly []
+    | readonly [account: `0x${string}`]
+    | readonly [sender: `0x${string}`, account: `0x${string}`]
+    | undefined
+  >(res.args)
+  attest(res.args).type.toString.snap(`  | readonly []
+  | readonly [account: \`0x\${string}\`]
+  | readonly [sender: \`0x\${string}\`, account: \`0x\${string}\`]
+  | undefined`)
+})