viem 2.13.1 → 2.13.3

package/experimental/eip5792/actions/writeContracts.ts

@@ -1,16 +1,23 @@
-import type { AbiStateMutability, Narrow } from 'abitype'
+import type { Abi, AbiStateMutability, Address, Narrow } from 'abitype'
 
 import type { Client } from '../../../clients/createClient.js'
 import type { Transport } from '../../../clients/transports/createTransport.js'
 import type { ErrorType } from '../../../errors/utils.js'
 import type { Account, GetAccountParameter } from '../../../types/account.js'
 import type { Chain, GetChainParameter } from '../../../types/chain.js'
-import type { ContractFunctionParameters } from '../../../types/contract.js'
+import type {
+  ContractFunctionArgs,
+  ContractFunctionName,
+  GetValue,
+  UnionWiden,
+  Widen,
+} from '../../../types/contract.js'
 import type { MulticallContracts } from '../../../types/multicall.js'
 import {
   type EncodeFunctionDataErrorType,
   encodeFunctionData,
 } from '../../../utils/abi/encodeFunctionData.js'
+import { getAction } from '../../../utils/getAction.js'
 import {
   type SendCallsErrorType,
   type SendCallsParameters,
@@ -19,7 +26,8 @@ import {
 } from './sendCalls.js'
 
 export type WriteContractsParameters<
-  contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
+  contracts extends
+    readonly unknown[] = readonly WriteContractFunctionParameters[],
   chain extends Chain | undefined = Chain | undefined,
   account extends Account | undefined = Account | undefined,
   chainOverride extends Chain | undefined = Chain | undefined,
@@ -98,7 +106,7 @@ export async function writeContracts<
     chainOverride
   >,
 ): Promise<WriteContractsReturnType> {
-  const contracts = parameters.contracts as ContractFunctionParameters[]
+  const contracts = parameters.contracts as WriteContractFunctionParameters[]
   const calls = contracts.map((contract) => {
     const { address, abi, functionName, args, value } = contract
     return {
@@ -111,5 +119,36 @@ export async function writeContracts<
       value,
     } satisfies SendCallsParameters['calls'][number]
   })
-  return sendCalls(client, { ...parameters, calls } as SendCallsParameters)
+  return getAction(
+    client,
+    sendCalls,
+    'sendCalls',
+  )({ ...parameters, calls } as SendCallsParameters)
 }
+
+export type WriteContractFunctionParameters<
+  abi extends Abi | readonly unknown[] = Abi,
+  mutability extends AbiStateMutability = AbiStateMutability,
+  functionName extends ContractFunctionName<
+    abi,
+    mutability
+  > = ContractFunctionName<abi, mutability>,
+  args extends ContractFunctionArgs<
+    abi,
+    mutability,
+    functionName
+  > = ContractFunctionArgs<abi, mutability, functionName>,
+  ///
+  allFunctionNames = ContractFunctionName<abi, mutability>,
+  allArgs = ContractFunctionArgs<abi, mutability, functionName>,
+  // when `args` is inferred to `readonly []` ("inputs": []) or `never` (`abi` declared as `Abi` or not inferrable), allow `args` to be optional.
+  // important that both branches return same structural type
+> = {
+  address: Address
+  abi: abi
+  functionName:
+    | allFunctionNames // show all options
+    | (functionName extends allFunctionNames ? functionName : never) // infer value
+  args?: (abi extends Abi ? UnionWiden<args> : never) | allArgs | undefined
+} & (readonly [] extends allArgs ? {} : { args: Widen<args> }) &
+  GetValue<abi, functionName>

package/experimental/index.ts

@@ -27,6 +27,7 @@ export {
   type WriteContractsErrorType,
   type WriteContractsParameters,
   type WriteContractsReturnType,
+  type WriteContractFunctionParameters,
   writeContracts,
 } from './eip5792/actions/writeContracts.js'
 export {

package/index.ts

@@ -1097,6 +1097,7 @@ export {
 export {
   type DecodeFunctionDataErrorType,
   type DecodeFunctionDataParameters,
+  type DecodeFunctionDataReturnType,
   decodeFunctionData,
 } from './utils/abi/decodeFunctionData.js'
 export {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.13.1",
+  "version": "2.13.3",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -9,11 +9,12 @@
   "sideEffects": false,
   "files": [
     "*",
-    "!**/*.tsbuildinfo",
+    "!**/*.bench.ts",
+    "!**/*.bench-d.ts",
     "!**/*.test.ts",
     "!**/*.test.ts.snap",
     "!**/*.test-d.ts",
-    "!**/*.bench.ts",
+    "!**/*.tsbuildinfo",
     "!tsconfig.build.json",
     "!jsr.json"
   ],

package/types/contract.ts

@@ -209,9 +209,7 @@ export type ContractFunctionParameters<
     | allFunctionNames // show all options
     | (functionName extends allFunctionNames ? functionName : never) // infer value
   args?: (abi extends Abi ? UnionWiden<args> : never) | allArgs | undefined
-} & (readonly [] extends allArgs ? {} : { args: Widen<args> }) &
-  // TODO: Remove `GetValue` from here (should be applied to top-level type as separate utility)
-  GetValue<abi, functionName>
+} & (readonly [] extends allArgs ? {} : { args: Widen<args> })
 
 export type ContractFunctionReturnType<
   abi extends Abi | readonly unknown[] = Abi,

package/utils/index.ts

@@ -86,6 +86,7 @@ export {
 export {
   type DecodeFunctionDataErrorType,
   type DecodeFunctionDataParameters,
+  type DecodeFunctionDataReturnType,
   decodeFunctionData,
 } from './abi/decodeFunctionData.js'
 export {