viem 0.0.0-w-20230820223631 → 0.0.0-w-20230821171049

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

@@ -407,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.
@@ -1208,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,

package/src/clients/decorators/wallet.ts

@@ -61,6 +61,10 @@ import {
   writeContract,
 } from '../../actions/wallet/writeContract.js'
 import type { Chain } from '../../types/chain.js'
+import {
+  type ContractFunctionArgs,
+  type ContractFunctionName,
+} from '../../types/contract.js'
 import type { Client } from '../createClient.js'
 import type { Transport } from '../transports/createTransport.js'
 
@@ -509,13 +513,15 @@ export type WalletActions<
    * const hash = await client.writeContract(request)
    */
   writeContract: <
-    const TAbi extends Abi | readonly unknown[],
-    TFunctionName extends string,
+    const abi extends Abi | readonly unknown[],
+    functionName extends ContractFunctionName<abi, 'payable' | 'nonpayable'>,
+    args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
     TChainOverride extends Chain | undefined,
   >(
     args: WriteContractParameters<
-      TAbi,
-      TFunctionName,
+      abi,
+      functionName,
+      args,
       TChain,
       TAccount,
       TChainOverride

package/src/index.ts

@@ -519,9 +519,6 @@ export type {
   ContractFunctionReturnType,
   ContractFunctionName,
   ContractFunctionArgs,
-  ContractParameters,
-  ContractReturnType,
-  ContractFunctionConfig,
   ContractFunctionResult,
   GetConstructorArgs,
   GetErrorArgs,

package/src/types/contract.ts

@@ -1,21 +1,21 @@
-import type {
-  Abi,
-  AbiConstructor,
-  AbiError,
-  AbiEvent,
-  AbiFunction,
-  AbiParameter,
-  AbiParameterToPrimitiveType,
-  AbiParametersToPrimitiveTypes,
-  AbiStateMutability,
-  Address,
-  ExtractAbiError,
-  ExtractAbiErrorNames,
-  ExtractAbiEvent,
-  ExtractAbiEventNames,
-  ExtractAbiFunction,
-  ExtractAbiFunctionNames,
-  ResolvedConfig,
+import {
+  type Abi,
+  type AbiConstructor,
+  type AbiError,
+  type AbiEvent,
+  type AbiFunction,
+  type AbiParameter,
+  type AbiParameterToPrimitiveType,
+  type AbiParametersToPrimitiveTypes,
+  type AbiStateMutability,
+  type Address,
+  type ExtractAbiError,
+  type ExtractAbiErrorNames,
+  type ExtractAbiEvent,
+  type ExtractAbiEventNames,
+  type ExtractAbiFunction,
+  type ExtractAbiFunctionNames,
+  type ResolvedConfig,
 } from 'abitype'
 
 import type { Hex, LogTopic } from './misc.js'
@@ -27,6 +27,7 @@ import type {
   MaybeRequired,
   NoUndefined,
   Prettify,
+  UnionEvaluate,
   UnionToTuple,
 } from './utils.js'
 
@@ -128,28 +129,30 @@ export type ContractFunctionParameters<
   allFunctionNames = ContractFunctionName<abi, mutability>,
   // 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
-> = readonly [] extends allArgs
-  ? {
-      address: Address
-      abi: abi
-      functionName:
-        | allFunctionNames // show all options
-        | (functionName extends allFunctionNames ? functionName : never) // infer value
-      args?:
-        | allArgs // show all options
-        | (args extends allArgs ? Widen<args> : never) // infer value, widen inferred value of `args` conditionally to match `allArgs`
-        | undefined
-    }
-  : {
-      address: Address
-      abi: abi
-      functionName:
-        | allFunctionNames // show all options
-        | (functionName extends allFunctionNames ? functionName : never) // infer value
-      args:
-        | allArgs // show all options
-        | Widen<args> // infer value, widen inferred value of `args` match `allArgs` (e.g. avoid union `args: readonly [123n] | readonly [bigint]`)
-    }
+> = {
+  address: Address
+  abi: abi
+  functionName:
+    | allFunctionNames // show all options
+    | (functionName extends allFunctionNames ? functionName : never) // infer value
+  args?:
+    | allArgs // show all options
+    | (args extends allArgs ? Widen<args> : never) // infer value, widen inferred value of `args` conditionally to match `allArgs`
+    | undefined
+} & UnionEvaluate<
+  readonly [] extends allArgs
+    ? {
+        args?:
+          | allArgs // show all options
+          | (args extends allArgs ? Widen<args> : never) // infer value, widen inferred value of `args` conditionally to match `allArgs`
+          | undefined
+      }
+    : {
+        args:
+          | allArgs // show all options
+          | (Widen<args> & (args extends allArgs ? unknown : never)) // infer value, widen inferred value of `args` match `allArgs` (e.g. avoid union `args: readonly [123n] | readonly [bigint]`)
+      }
+>
 
 export type ContractFunctionReturnType<
   abi extends Abi | readonly unknown[] = Abi,
@@ -186,78 +189,6 @@ export type AbiItem = Abi[number]
 
 export type EventDefinition = `${string}(${string})`
 
-export type ContractParameters<
-  abi extends Abi | readonly unknown[] = readonly unknown[],
-  stateMutability extends AbiStateMutability = AbiStateMutability,
-  functionName extends ExtractAbiFunctionNames<
-    abi extends Abi ? abi : Abi,
-    stateMutability
-  > = string,
-  ///
-  functionNames extends string = abi extends Abi
-    ? ExtractAbiFunctionNames<abi, stateMutability>
-    : string,
-  abiFunction extends AbiFunction = abi extends Abi
-    ? ExtractAbiFunction<
-        abi,
-        functionName extends functionNames ? functionName : functionNames, // fallback to all function names if `functionName` is invalid
-        stateMutability
-      >
-    : AbiFunction,
-  types = AbiParametersToPrimitiveTypes<abiFunction['inputs'], 'inputs'>,
-  args =
-    | types // show all values
-    | (Abi extends abi ? readonly unknown[] | undefined : never) // `abi` declared as `Abi`
-    | (readonly [] extends types ? undefined : never), // `abiFunction` has no inputs
-  isArgsOptional extends boolean = Abi extends abi
-    ? true
-    : readonly [] extends types
-    ? true
-    : false,
-> = {
-  abi: abi
-  address: Address
-  functionName:
-    | functionNames // show all values
-    | (functionName extends functionNames ? functionName : never) // validate `functionName`
-    | ([functionNames] extends [never] ? string : never) // `abi` declared as `Abi`
-} & (isArgsOptional extends true ? { args?: args | undefined } : { args: args })
-
-export type ContractReturnType<
-  abi extends Abi | readonly unknown[] = readonly unknown[],
-  stateMutability extends AbiStateMutability = AbiStateMutability,
-  functionName extends ExtractAbiFunctionNames<
-    abi extends Abi ? abi : Abi,
-    stateMutability
-  > = string,
-  ///
-  abiFunction extends AbiFunction = abi extends Abi
-    ? ExtractAbiFunction<abi, functionName, stateMutability>
-    : AbiFunction,
-  types = AbiParametersToPrimitiveTypes<abiFunction['outputs'], 'outputs'>,
-> = [abiFunction] extends [never]
-  ? unknown // `abiFunction` was not inferrable (e.g. `abi` declared as `Abi`)
-  : readonly unknown[] extends types
-  ? unknown // `abiFunction` was not inferrable (e.g. `abi` not const asserted)
-  : types extends readonly [] // unwrap `types`
-  ? void // no outputs
-  : types extends readonly [infer type]
-  ? type // single output
-  : types
-
-export type ContractFunctionConfig<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TFunctionName extends string = string,
-  TAbiStateMutability extends AbiStateMutability = AbiStateMutability,
-> = {
-  /** Contract ABI */
-  abi: TAbi
-  /** Contract address */
-  address: Address
-  /** Function to invoke on the contract */
-  functionName: InferFunctionName<TAbi, TFunctionName, TAbiStateMutability>
-} & GetFunctionArgs<TAbi, TFunctionName>
-
 export type ContractFunctionResult<
   TAbi extends Abi | readonly unknown[] = Abi,
   TFunctionName extends string = string,

package/src/types/utils.ts

@@ -147,6 +147,8 @@ export type Prettify<T> = {
   [K in keyof T]: T[K]
 } & {}
 
+export type UnionEvaluate<type> = type extends object ? Prettify<type> : type
+
 /**
  * @description Creates a type that extracts the values of T.
  *
@@ -188,3 +190,12 @@ export type MaybePartial<
 export type ExactPartial<type> = {
   [key in keyof type]?: type[key] | undefined
 }
+
+export type OneOf<
+  union extends object,
+  ///
+  keys extends KeyofUnion<union> = KeyofUnion<union>,
+> = union extends infer Item
+  ? Prettify<Item & { [K in Exclude<keys, keyof Item>]?: undefined }>
+  : never
+type KeyofUnion<type> = type extends type ? keyof type : never