viem 0.0.0-w-20230818230619 → 0.0.0-w-20230821160922

package/src/actions/public/estimateContractGas.ts

@@ -6,27 +6,42 @@ import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { BaseError } from '../../errors/base.js'
 import type { Chain } from '../../types/chain.js'
-import type { ContractFunctionConfig, GetValue } from '../../types/contract.js'
+import type {
+  ContractFunctionArgs,
+  ContractFunctionName,
+  ContractFunctionParameters,
+  GetValue,
+} from '../../types/contract.js'
 import type { UnionOmit } from '../../types/utils.js'
-import {
-  type EncodeFunctionDataParameters,
-  encodeFunctionData,
-} from '../../utils/abi/encodeFunctionData.js'
+import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js'
 import { getContractError } from '../../utils/errors/getContractError.js'
 import { type EstimateGasParameters, estimateGas } from './estimateGas.js'
 
 export type EstimateContractGasParameters<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TFunctionName extends string = string,
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccount extends Account | undefined = undefined,
-> = ContractFunctionConfig<TAbi, TFunctionName, 'payable' | 'nonpayable'> &
-  UnionOmit<EstimateGasParameters<TChain, TAccount>, 'data' | 'to' | 'value'> &
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ContractFunctionName<
+    abi,
+    'nonpayable' | 'payable'
+  > = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'nonpayable' | 'payable',
+    functionName
+  > = ContractFunctionArgs<abi, 'nonpayable' | 'payable', functionName>,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = undefined,
+> = ContractFunctionParameters<
+  abi,
+  'nonpayable' | 'payable',
+  functionName,
+  args
+> &
+  UnionOmit<EstimateGasParameters<chain, account>, 'data' | 'to' | 'value'> &
   GetValue<
-    TAbi,
-    TFunctionName,
-    EstimateGasParameters<TChain> extends EstimateGasParameters
-      ? EstimateGasParameters<TChain>['value']
+    abi,
+    functionName,
+    EstimateGasParameters<chain> extends EstimateGasParameters
+      ? EstimateGasParameters<chain>['value']
       : EstimateGasParameters['value']
   >
 
@@ -60,36 +75,31 @@ export type EstimateContractGasReturnType = bigint
  * })
  */
 export async function estimateContractGas<
-  const TAbi extends Abi | readonly unknown[],
-  TFunctionName extends string,
-  TChain extends Chain | undefined,
-  TAccount extends Account | undefined = undefined,
+  const abi extends Abi | readonly unknown[],
+  functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
+  chain extends Chain | undefined,
+  account extends Account | undefined = undefined,
 >(
-  client: Client<Transport, TChain, TAccount>,
-  {
+  client: Client<Transport, chain, account>,
+  parameters: EstimateContractGasParameters<
     abi,
-    address,
-    args,
     functionName,
-    ...request
-  }: EstimateContractGasParameters<TAbi, TFunctionName, TChain, TAccount>,
-): Promise<EstimateContractGasReturnType> {
-  const data = encodeFunctionData({
-    abi,
     args,
-    functionName,
-  } as unknown as EncodeFunctionDataParameters<TAbi, TFunctionName>)
+    chain,
+    account
+  >,
+): Promise<EstimateContractGasReturnType> {
+  const { abi, address, args, functionName, ...request } =
+    parameters as EstimateContractGasParameters
+  const data = encodeFunctionData({ abi, args, functionName })
   try {
-    const gas = await estimateGas(client, {
-      data,
-      to: address,
-      ...request,
-    } as unknown as EstimateGasParameters<TChain>)
+    const gas = await estimateGas(client, { data, to: address, ...request })
     return gas
-  } catch (err) {
+  } catch (error) {
     const account = request.account ? parseAccount(request.account) : undefined
-    throw getContractError(err as BaseError, {
-      abi: abi as Abi,
+    throw getContractError(error as BaseError, {
+      abi,
       address,
       args,
       docsPath: '/docs/contract/estimateContractGas',

package/src/actions/public/multicall.ts

@@ -7,9 +7,9 @@ import { AbiDecodingZeroDataError } from '../../errors/abi.js'
 import type { BaseError } from '../../errors/base.js'
 import { RawContractError } from '../../errors/contract.js'
 import type { Chain } from '../../types/chain.js'
+import type { ContractFunctionParameters } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
 import type {
-  MulticallContract,
   MulticallContracts,
   MulticallResults,
 } from '../../types/multicall.js'
@@ -17,12 +17,11 @@ import { decodeFunctionResult } from '../../utils/abi/decodeFunctionResult.js'
 import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js'
 import { getChainContractAddress } from '../../utils/chain.js'
 import { getContractError } from '../../utils/errors/getContractError.js'
-
 import type { CallParameters } from './call.js'
 import { readContract } from './readContract.js'
 
 export type MulticallParameters<
-  contracts extends readonly unknown[] = readonly MulticallContract[],
+  contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
   allowFailure extends boolean = true,
   options extends {
     optional?: boolean
@@ -39,7 +38,7 @@ export type MulticallParameters<
 }
 
 export type MulticallReturnType<
-  contracts extends readonly unknown[] = readonly MulticallContract[],
+  contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
   allowFailure extends boolean = true,
   options extends {
     error?: Error
@@ -104,7 +103,7 @@ export async function multicall<
     blockTag,
     multicallAddress: multicallAddress_,
   } = parameters
-  const contracts = parameters.contracts as MulticallContract[]
+  const contracts = parameters.contracts as ContractFunctionParameters[]
 
   const batchSize =
     batchSize_ ??

package/src/actions/public/readContract.ts

@@ -5,31 +5,42 @@ import type { Transport } from '../../clients/transports/createTransport.js'
 import type { BaseError } from '../../errors/base.js'
 import type { Chain } from '../../types/chain.js'
 import type {
-  ContractFunctionConfig,
-  ContractFunctionResult,
+  ContractFunctionArgs,
+  ContractFunctionName,
+  ContractFunctionParameters,
+  ContractFunctionReturnType,
 } from '../../types/contract.js'
-import {
-  type DecodeFunctionResultParameters,
-  decodeFunctionResult,
-} from '../../utils/abi/decodeFunctionResult.js'
-import {
-  type EncodeFunctionDataParameters,
-  encodeFunctionData,
-} from '../../utils/abi/encodeFunctionData.js'
+import { decodeFunctionResult } from '../../utils/abi/decodeFunctionResult.js'
+import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js'
 import { getContractError } from '../../utils/errors/getContractError.js'
-
 import { type CallParameters, call } from './call.js'
 
 export type ReadContractParameters<
   abi extends Abi | readonly unknown[] = Abi,
-  functionName extends string = string,
+  functionName extends ContractFunctionName<
+    abi,
+    'pure' | 'view'
+  > = ContractFunctionName<abi, 'pure' | 'view'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'pure' | 'view',
+    functionName
+  > = ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
 > = Pick<CallParameters, 'account' | 'blockNumber' | 'blockTag'> &
-  ContractFunctionConfig<abi, functionName, 'view' | 'pure'>
+  ContractFunctionParameters<abi, 'pure' | 'view', functionName, args>
 
 export type ReadContractReturnType<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TFunctionName extends string = string,
-> = ContractFunctionResult<TAbi, TFunctionName>
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ContractFunctionName<
+    abi,
+    'pure' | 'view'
+  > = ContractFunctionName<abi, 'pure' | 'view'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'pure' | 'view',
+    functionName
+  > = ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
+> = ContractFunctionReturnType<abi, 'pure' | 'view', functionName, args>
 
 /**
  * Calls a read-only function on a contract, and returns the response.
@@ -65,35 +76,30 @@ export type ReadContractReturnType<
 export async function readContract<
   chain extends Chain | undefined,
   const abi extends Abi | readonly unknown[],
-  functionName extends string,
+  functionName extends ContractFunctionName<abi, 'pure' | 'view'>,
+  args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
 >(
   client: Client<Transport, chain>,
-  parameters: ReadContractParameters<abi, functionName>,
-): Promise<ReadContractReturnType<abi, functionName>> {
-  const { abi, address, args, functionName, ...callRequest } = parameters
-  const calldata = encodeFunctionData({
-    abi,
-    args,
-    functionName,
-  } as unknown as EncodeFunctionDataParameters<abi, functionName>)
+  parameters: ReadContractParameters<abi, functionName, args>,
+): Promise<ReadContractReturnType<abi, functionName, args>> {
+  const { abi, address, args, functionName, ...rest } =
+    parameters as ReadContractParameters
+  const calldata = encodeFunctionData({ abi, args, functionName })
   try {
     const { data } = await call(client, {
+      ...(rest as CallParameters),
       data: calldata,
       to: address,
-      ...callRequest,
-    } as unknown as CallParameters)
+    })
     return decodeFunctionResult({
       abi,
       args,
       functionName,
       data: data || '0x',
-    } as DecodeFunctionResultParameters<
+    }) as ReadContractReturnType<abi, functionName>
+  } catch (error) {
+    throw getContractError(error as BaseError, {
       abi,
-      functionName
-    >) as ReadContractReturnType<abi, functionName>
-  } catch (err) {
-    throw getContractError(err as BaseError, {
-      abi: abi as Abi,
       address,
       args,
       docsPath: '/docs/contract/readContract',

package/src/actions/public/simulateContract.ts

@@ -6,67 +6,95 @@ import type { Transport } from '../../clients/transports/createTransport.js'
 import type { BaseError } from '../../errors/base.js'
 import type { Chain } from '../../types/chain.js'
 import type {
-  ContractFunctionConfig,
-  ContractFunctionResult,
+  ContractFunctionArgs,
+  ContractFunctionName,
+  ContractFunctionParameters,
+  ContractFunctionReturnType,
   GetValue,
 } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
 import type { UnionOmit } from '../../types/utils.js'
-import {
-  type DecodeFunctionResultParameters,
-  decodeFunctionResult,
-} from '../../utils/abi/decodeFunctionResult.js'
-import {
-  type EncodeFunctionDataParameters,
-  encodeFunctionData,
-} from '../../utils/abi/encodeFunctionData.js'
+import { decodeFunctionResult } from '../../utils/abi/decodeFunctionResult.js'
+import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js'
 import { getContractError } from '../../utils/errors/getContractError.js'
 import type { WriteContractParameters } from '../wallet/writeContract.js'
 
 import { type CallParameters, call } from './call.js'
 
 export type SimulateContractParameters<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TFunctionName extends string = any,
-  TChain extends Chain | undefined = Chain | undefined,
-  TChainOverride extends Chain | undefined = Chain | undefined,
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ContractFunctionName<
+    abi,
+    'nonpayable' | 'payable'
+  > = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'nonpayable' | 'payable',
+    functionName
+  > = ContractFunctionArgs<abi, 'nonpayable' | 'payable', functionName>,
+  chain extends Chain | undefined = Chain | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
 > = {
-  chain?: TChainOverride
+  chain?: chainOverride
   /** Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f). */
   dataSuffix?: Hex
-} & ContractFunctionConfig<TAbi, TFunctionName, 'payable' | 'nonpayable'> &
+} & ContractFunctionParameters<
+  abi,
+  'nonpayable' | 'payable',
+  functionName,
+  args
+> &
   UnionOmit<
-    CallParameters<TChainOverride extends Chain ? TChainOverride : TChain>,
+    CallParameters<chainOverride extends Chain ? chainOverride : chain>,
     'batch' | 'to' | 'data' | 'value'
   > &
   GetValue<
-    TAbi,
-    TFunctionName,
-    CallParameters<TChain> extends CallParameters
-      ? CallParameters<TChain>['value']
+    abi,
+    functionName,
+    CallParameters<chain> extends CallParameters
+      ? CallParameters<chain>['value']
       : CallParameters['value']
   >
 
 export type SimulateContractReturnType<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TFunctionName extends string = string,
-  TChain extends Chain | undefined = Chain | undefined,
-  TChainOverride extends Chain | undefined = Chain | undefined,
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ContractFunctionName<
+    abi,
+    'nonpayable' | 'payable'
+  > = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'nonpayable' | 'payable',
+    functionName
+  > = ContractFunctionArgs<abi, 'nonpayable' | 'payable', functionName>,
+  chain extends Chain | undefined = Chain | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
 > = {
-  result: ContractFunctionResult<TAbi, TFunctionName>
+  result: ContractFunctionReturnType<
+    abi,
+    'nonpayable' | 'payable',
+    functionName,
+    args
+  >
   request: UnionOmit<
     WriteContractParameters<
-      TAbi,
-      TFunctionName,
-      TChain,
+      abi,
+      functionName,
+      args,
+      chain,
       undefined,
-      TChainOverride
+      chainOverride
     >,
     'chain' | 'functionName'
   > & {
-    chain: TChainOverride
-    functionName: TFunctionName
-  } & ContractFunctionConfig<TAbi, TFunctionName, 'payable' | 'nonpayable'>
+    chain: chainOverride
+    functionName: functionName
+  } & ContractFunctionParameters<
+      abi,
+      'nonpayable' | 'payable',
+      functionName,
+      args
+    >
 }
 
 /**
@@ -101,44 +129,47 @@ export type SimulateContractReturnType<
  * })
  */
 export async function simulateContract<
-  TChain extends Chain | undefined,
-  const TAbi extends Abi | readonly unknown[],
-  TFunctionName extends string,
-  TChainOverride extends Chain | undefined,
+  chain extends Chain | undefined,
+  const abi extends Abi | readonly unknown[],
+  functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'nonpayable' | 'payable',
+    functionName
+  >,
+  chainOverride extends Chain | undefined,
 >(
-  client: Client<Transport, TChain>,
-  {
+  client: Client<Transport, chain>,
+  parameters: SimulateContractParameters<
     abi,
-    address,
-    args,
-    dataSuffix,
     functionName,
-    ...callRequest
-  }: SimulateContractParameters<TAbi, TFunctionName, TChain, TChainOverride>,
+    args,
+    chain,
+    chainOverride
+  >,
 ): Promise<
-  SimulateContractReturnType<TAbi, TFunctionName, TChain, TChainOverride>
+  SimulateContractReturnType<abi, functionName, args, chain, chainOverride>
 > {
+  const { abi, address, args, dataSuffix, functionName, ...callRequest } =
+    parameters as SimulateContractParameters
+
   const account = callRequest.account
     ? parseAccount(callRequest.account)
     : undefined
-  const calldata = encodeFunctionData({
-    abi,
-    args,
-    functionName,
-  } as unknown as EncodeFunctionDataParameters<TAbi, TFunctionName>)
+  const calldata = encodeFunctionData({ abi, args, functionName })
   try {
     const { data } = await call(client, {
       batch: false,
       data: `${calldata}${dataSuffix ? dataSuffix.replace('0x', '') : ''}`,
       to: address,
       ...callRequest,
-    } as unknown as CallParameters<TChain>)
+    })
     const result = decodeFunctionResult({
       abi,
       args,
       functionName,
       data: data || '0x',
-    } as DecodeFunctionResultParameters)
+    })
     return {
       result,
       request: {
@@ -150,14 +181,15 @@ export async function simulateContract<
         ...callRequest,
       },
     } as unknown as SimulateContractReturnType<
-      TAbi,
-      TFunctionName,
-      TChain,
-      TChainOverride
+      abi,
+      functionName,
+      args,
+      chain,
+      chainOverride
     >
-  } catch (err) {
-    throw getContractError(err as BaseError, {
-      abi: abi as Abi,
+  } catch (error) {
+    throw getContractError(error as BaseError, {
+      abi,
       address,
       args,
       docsPath: '/docs/contract/simulateContract',

package/src/actions/wallet/writeContract.ts

@@ -5,13 +5,15 @@ import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { GetAccountParameter } from '../../types/account.js'
 import type { Chain, GetChain } from '../../types/chain.js'
-import type { ContractFunctionConfig, GetValue } from '../../types/contract.js'
+import type {
+  ContractFunctionArgs,
+  ContractFunctionName,
+  ContractFunctionParameters,
+  GetValue,
+} from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
 import type { UnionOmit } from '../../types/utils.js'
-import {
-  type EncodeFunctionDataParameters,
-  encodeFunctionData,
-} from '../../utils/abi/encodeFunctionData.js'
+import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js'
 import type { FormattedTransactionRequest } from '../../utils/formatters/transactionRequest.js'
 import {
   type SendTransactionParameters,
@@ -21,11 +23,24 @@ import {
 
 export type WriteContractParameters<
   abi extends Abi | readonly unknown[] = Abi,
-  functionName extends string = string,
+  functionName extends ContractFunctionName<
+    abi,
+    'nonpayable' | 'payable'
+  > = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'nonpayable' | 'payable',
+    functionName
+  > = ContractFunctionArgs<abi, 'nonpayable' | 'payable', functionName>,
   chain extends Chain | undefined = Chain,
   account extends Account | undefined = Account | undefined,
   chainOverride extends Chain | undefined = Chain | undefined,
-> = ContractFunctionConfig<abi, functionName, 'payable' | 'nonpayable'> &
+> = ContractFunctionParameters<
+  abi,
+  'nonpayable' | 'payable',
+  functionName,
+  args
+> &
   UnionOmit<
     FormattedTransactionRequest<
       chainOverride extends Chain ? chainOverride : chain
@@ -105,29 +120,27 @@ export async function writeContract<
   chain extends Chain | undefined,
   account extends Account | undefined,
   const abi extends Abi | readonly unknown[],
-  functionName extends string,
+  functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
   chainOverride extends Chain | undefined,
 >(
   client: Client<Transport, chain, account>,
   parameters: WriteContractParameters<
     abi,
     functionName,
+    args,
     chain,
     account,
     chainOverride
   >,
 ): Promise<WriteContractReturnType> {
   const { abi, address, args, dataSuffix, functionName, ...request } =
-    parameters
-  const data = encodeFunctionData({
-    abi,
-    args,
-    functionName,
-  } as unknown as EncodeFunctionDataParameters<abi, functionName>)
+    parameters as WriteContractParameters
+  const data = encodeFunctionData({ abi, args, functionName })
   const hash = await sendTransaction(client, {
     data: `${data}${dataSuffix ? dataSuffix.replace('0x', '') : ''}`,
     to: address,
     ...request,
-  } as unknown as SendTransactionParameters<chain, account, chainOverride>)
+  })
   return hash
 }

package/src/clients/decorators/public.ts

@@ -200,6 +200,8 @@ import type { Account } from '../../types/account.js'
 import type { BlockNumber, BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
 import type {
+  ContractFunctionArgs,
+  ContractFunctionName,
   MaybeAbiEventName,
   MaybeExtractEventArgsFromAbi,
 } from '../../types/contract.js'
@@ -405,10 +407,21 @@ export type PublicActions<
    */
   estimateContractGas: <
     TChain extends Chain | undefined,
-    const TAbi extends Abi | readonly unknown[],
-    TFunctionName extends string,
+    const abi extends Abi | readonly unknown[],
+    functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+    args extends ContractFunctionArgs<
+      abi,
+      'nonpayable' | 'payable',
+      functionName
+    >,
   >(
-    args: EstimateContractGasParameters<TAbi, TFunctionName, TChain, TAccount>,
+    args: EstimateContractGasParameters<
+      abi,
+      functionName,
+      args,
+      TChain,
+      TAccount
+    >,
   ) => Promise<EstimateContractGasReturnType>
   /**
    * Estimates the gas necessary to complete a transaction without submitting it to the network.
@@ -1169,11 +1182,12 @@ export type PublicActions<
    * // 424122n
    */
   readContract: <
-    const TAbi extends Abi | readonly unknown[],
-    TFunctionName extends string,
+    const abi extends Abi | readonly unknown[],
+    functionName extends ContractFunctionName<abi, 'pure' | 'view'>,
+    args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
   >(
-    args: ReadContractParameters<TAbi, TFunctionName>,
-  ) => Promise<ReadContractReturnType<TAbi, TFunctionName>>
+    args: ReadContractParameters<abi, functionName, args>,
+  ) => Promise<ReadContractReturnType<abi, functionName, args>>
   /**
    * Simulates/validates a contract interaction. This is useful for retrieving **return data** and **revert reasons** of contract write functions.
    *
@@ -1205,18 +1219,24 @@ export type PublicActions<
    * })
    */
   simulateContract: <
-    const TAbi extends Abi | readonly unknown[],
-    TFunctionName extends string,
+    const abi extends Abi | readonly unknown[],
+    functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+    args extends ContractFunctionArgs<
+      abi,
+      'nonpayable' | 'payable',
+      functionName
+    >,
     TChainOverride extends Chain | undefined,
   >(
     args: SimulateContractParameters<
-      TAbi,
-      TFunctionName,
+      abi,
+      functionName,
+      args,
       TChain,
       TChainOverride
     >,
   ) => Promise<
-    SimulateContractReturnType<TAbi, TFunctionName, TChain, TChainOverride>
+    SimulateContractReturnType<abi, functionName, args, TChain, TChainOverride>
   >
   verifyMessage: (
     args: VerifyMessageParameters,