viem 0.0.0-portable-types-20230522163654 → 0.0.0-refactor-generics-20230831161903

package/src/actions/getContract.ts

@@ -8,7 +8,6 @@ import type {
   ExtractAbiEventNames,
   ExtractAbiFunction,
   ExtractAbiFunctionNames,
-  Narrow,
 } from 'abitype'
 
 import type { Account } from '../accounts/types.js'
@@ -18,6 +17,8 @@ import type { Transport } from '../clients/transports/createTransport.js'
 import type { Chain } from '../types/chain.js'
 import type {
   AbiEventParametersToPrimitiveTypes,
+  ContractFunctionArgs,
+  ContractFunctionName,
   MaybeExtractEventArgsFromAbi,
 } from '../types/contract.js'
 import type {
@@ -26,6 +27,7 @@ import type {
   IsUndefined,
   Or,
   Prettify,
+  UnionOmit,
 } from '../types/utils.js'
 
 import {
@@ -68,11 +70,12 @@ export type GetContractParameters<
   TWalletClient extends
     | WalletClient<TTransport, TChain, TAccount>
     | unknown = unknown,
+  TAddress extends Address = Address,
 > = {
   /** Contract ABI */
-  abi: Narrow<TAbi>
+  abi: TAbi
   /** Contract address */
-  address: Address
+  address: TAddress
   /**
    * Public client
    *
@@ -90,6 +93,7 @@ export type GetContractParameters<
    *
    * If you pass in a [`walletClient`](https://viem.sh/docs/clients/wallet.html), the following methods are available:
    *
+   * - [`estimateGas`](https://viem.sh/docs/contract/estimateContractGas.html)
    * - [`write`](https://viem.sh/docs/contract/writeContract.html)
    */
   walletClient?: TWalletClient
@@ -99,6 +103,7 @@ export type GetContractReturnType<
   TAbi extends Abi | readonly unknown[] = Abi,
   TPublicClient extends PublicClient | unknown = unknown,
   TWalletClient extends WalletClient | unknown = unknown,
+  TAddress extends Address = Address,
   _EventNames extends string = TAbi extends Abi
     ? Abi extends TAbi
       ? string
@@ -149,7 +154,9 @@ export type GetContractReturnType<
               [FunctionName in _ReadFunctionNames]: GetReadFunction<
                 _Narrowable,
                 TAbi,
-                FunctionName
+                FunctionName extends ContractFunctionName<TAbi, 'pure' | 'view'>
+                  ? FunctionName
+                  : never
               >
             }
           }) &
@@ -163,7 +170,7 @@ export type GetContractReturnType<
                * import { createPublicClient, getContract, http, parseAbi } from 'viem'
                * import { mainnet } from 'viem/chains'
                *
-               * const client = createPublicClient({
+               * const publicClient = createPublicClient({
                *   chain: mainnet,
                *   transport: http(),
                * })
@@ -179,9 +186,8 @@ export type GetContractReturnType<
               estimateGas: {
                 [FunctionName in _WriteFunctionNames]: GetEstimateFunction<
                   _Narrowable,
-                  TPublicClient extends PublicClient
-                    ? TPublicClient['chain']
-                    : undefined,
+                  TPublicClient['chain'],
+                  undefined,
                   TAbi,
                   FunctionName
                 >
@@ -197,7 +203,7 @@ export type GetContractReturnType<
                * import { createPublicClient, getContract, http, parseAbi } from 'viem'
                * import { mainnet } from 'viem/chains'
                *
-               * const client = createPublicClient({
+               * const publicClient = createPublicClient({
                *   chain: mainnet,
                *   transport: http(),
                * })
@@ -213,9 +219,7 @@ export type GetContractReturnType<
               simulate: {
                 [FunctionName in _WriteFunctionNames]: GetSimulateFunction<
                   _Narrowable,
-                  TPublicClient extends PublicClient
-                    ? TPublicClient['chain']
-                    : undefined,
+                  TPublicClient['chain'],
                   TAbi,
                   FunctionName
                 >
@@ -231,7 +235,7 @@ export type GetContractReturnType<
                * import { createPublicClient, getContract, http, parseAbi } from 'viem'
                * import { mainnet } from 'viem/chains'
                *
-               * const client = createPublicClient({
+               * const publicClient = createPublicClient({
                *   chain: mainnet,
                *   transport: http(),
                * })
@@ -260,7 +264,7 @@ export type GetContractReturnType<
                * import { createPublicClient, getContract, http, parseAbi } from 'viem'
                * import { mainnet } from 'viem/chains'
                *
-               * const client = createPublicClient({
+               * const publicClient = createPublicClient({
                *   chain: mainnet,
                *   transport: http(),
                * })
@@ -288,6 +292,35 @@ export type GetContractReturnType<
       ? IsNever<_WriteFunctionNames> extends true
         ? unknown
         : {
+            /**
+             * Estimates the gas necessary to complete a transaction without submitting it to the network.
+             *
+             * @example
+             * import { createWalletClient, getContract, http, parseAbi } from 'viem'
+             * import { mainnet } from 'viem/chains'
+             *
+             * const walletClient = createWalletClient({
+             *   chain: mainnet,
+             *   transport: http(),
+             * })
+             * const contract = getContract({
+             *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+             *   abi: parseAbi(['function mint() public']),
+             *   walletClient,
+             * })
+             * const gas = await contract.estimateGas.mint({
+             *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+             * })
+             */
+            estimateGas: {
+              [FunctionName in _WriteFunctionNames]: GetEstimateFunction<
+                _Narrowable,
+                TWalletClient['chain'],
+                TWalletClient['account'],
+                TAbi,
+                FunctionName
+              >
+            }
             /**
              * Executes a write function on a contract.
              *
@@ -301,14 +334,14 @@ export type GetContractReturnType<
              * import { createWalletClient, getContract, http, parseAbi } from 'viem'
              * import { mainnet } from 'viem/chains'
              *
-             * const client = createWalletClient({
+             * const walletClient = createWalletClient({
              *   chain: mainnet,
              *   transport: http(),
              * })
              * const contract = getContract({
              *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
              *   abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
-             *   publicClient,
+             *   walletClient,
              * })
              * const hash = await contract.write.min([69420], {
              *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
@@ -317,19 +350,15 @@ export type GetContractReturnType<
             write: {
               [FunctionName in _WriteFunctionNames]: GetWriteFunction<
                 _Narrowable,
-                TWalletClient extends WalletClient
-                  ? TWalletClient['chain']
-                  : undefined,
-                TWalletClient extends WalletClient
-                  ? TWalletClient['account']
-                  : undefined,
+                TWalletClient['chain'],
+                TWalletClient['account'],
                 TAbi,
                 FunctionName
               >
             }
           }
       : unknown)
->
+> & { address: TAddress; abi: TAbi }
 
 /**
  * Gets type-safe interface for performing contract-related actions with a specific `abi` and `address`.
@@ -358,7 +387,8 @@ export type GetContractReturnType<
  */
 export function getContract<
   TTransport extends Transport,
-  TAbi extends Abi | readonly unknown[],
+  TAddress extends Address,
+  const TAbi extends Abi | readonly unknown[],
   TChain extends Chain | undefined = Chain | undefined,
   TAccount extends Account | undefined = Account | undefined,
   TPublicClient extends PublicClient<TTransport, TChain> | undefined =
@@ -378,13 +408,16 @@ export function getContract<
   TAccount,
   TAbi,
   TPublicClient,
-  TWalletClient
->): GetContractReturnType<TAbi, TPublicClient, TWalletClient> {
+  TWalletClient,
+  TAddress
+>): GetContractReturnType<TAbi, TPublicClient, TWalletClient, TAddress> {
   const hasPublicClient = publicClient !== undefined && publicClient !== null
   const hasWalletClient = walletClient !== undefined && walletClient !== null
 
   const contract: {
     [_ in
+      | 'abi'
+      | 'address'
       | 'createEventFilter'
       | 'estimateGas'
       | 'read'
@@ -415,7 +448,7 @@ export function getContract<
             return (
               ...parameters: [
                 args?: readonly unknown[],
-                options?: Omit<
+                options?: UnionOmit<
                   ReadContractParameters,
                   'abi' | 'address' | 'functionName' | 'args'
                 >,
@@ -434,32 +467,7 @@ export function getContract<
         },
       )
 
-    if (hasWriteFunction) {
-      contract.estimateGas = new Proxy(
-        {},
-        {
-          get(_, functionName: string) {
-            return (
-              ...parameters: [
-                args?: readonly unknown[],
-                options?: Omit<
-                  EstimateContractGasParameters,
-                  'abi' | 'address' | 'functionName' | 'args'
-                >,
-              ]
-            ) => {
-              const { args, options } = getFunctionParameters(parameters)
-              return estimateContractGas(publicClient, {
-                abi,
-                address,
-                functionName,
-                args,
-                ...options,
-              } as EstimateContractGasParameters)
-            }
-          },
-        },
-      )
+    if (hasWriteFunction)
       contract.simulate = new Proxy(
         {},
         {
@@ -467,7 +475,7 @@ export function getContract<
             return (
               ...parameters: [
                 args?: readonly unknown[],
-                options?: Omit<
+                options?: UnionOmit<
                   SimulateContractParameters,
                   'abi' | 'address' | 'functionName' | 'args'
                 >,
@@ -485,7 +493,6 @@ export function getContract<
           },
         },
       )
-    }
 
     if (hasEvent) {
       contract.createEventFilter = new Proxy(
@@ -545,7 +552,7 @@ export function getContract<
                 eventName,
                 args,
                 ...options,
-              } as WatchContractEventParameters)
+              } as unknown as WatchContractEventParameters)
             }
           },
         },
@@ -562,7 +569,7 @@ export function getContract<
             return (
               ...parameters: [
                 args?: readonly unknown[],
-                options?: Omit<
+                options?: UnionOmit<
                   WriteContractParameters,
                   'abi' | 'address' | 'functionName' | 'args'
                 >,
@@ -587,10 +594,45 @@ export function getContract<
       )
   }
 
+  if (hasPublicClient || hasWalletClient)
+    if (hasWriteFunction)
+      contract.estimateGas = new Proxy(
+        {},
+        {
+          get(_, functionName: string) {
+            return (
+              ...parameters: [
+                args?: readonly unknown[],
+                options?: UnionOmit<
+                  EstimateContractGasParameters,
+                  'abi' | 'address' | 'functionName' | 'args'
+                >,
+              ]
+            ) => {
+              const { args, options } = getFunctionParameters(parameters)
+              const client = (publicClient ?? walletClient)!
+              return estimateContractGas(client, {
+                abi,
+                address,
+                functionName,
+                args,
+                ...options,
+                account:
+                  (options as EstimateContractGasParameters).account ??
+                  (walletClient as unknown as WalletClient).account,
+              } as any)
+            }
+          },
+        },
+      )
+  contract.address = address
+  contract.abi = abi
+
   return contract as unknown as GetContractReturnType<
     TAbi,
     TPublicClient,
-    TWalletClient
+    TWalletClient,
+    TAddress
   >
 }
 
@@ -630,35 +672,52 @@ export function getEventParameters(
   return { args, options }
 }
 
+type OmittedReadProperties = 'abi' | 'address' | 'args' | 'functionName'
+
 type GetReadFunction<
   Narrowable extends boolean,
   TAbi extends Abi | readonly unknown[],
-  TFunctionName extends string,
-  TAbiFunction extends AbiFunction = TAbi extends Abi
-    ? ExtractAbiFunction<TAbi, TFunctionName>
-    : AbiFunction,
-  Args = AbiParametersToPrimitiveTypes<TAbiFunction['inputs']>,
-  Options = Prettify<
-    Omit<
-      ReadContractParameters<TAbi, TFunctionName>,
-      'abi' | 'address' | 'args' | 'functionName'
-    >
-  >,
+  TFunctionName extends ContractFunctionName<TAbi, 'pure' | 'view'>,
 > = Narrowable extends true
-  ? (
-      ...parameters: Args extends readonly []
-        ? [options?: Options]
-        : [args: Args, options?: Options]
-    ) => Promise<ReadContractReturnType<TAbi, TFunctionName>>
+  ? <TArgs extends ContractFunctionArgs<TAbi, 'pure' | 'view', TFunctionName>>(
+      ...parameters: TArgs extends readonly []
+        ? [
+            options?: Prettify<
+              UnionOmit<
+                ReadContractParameters<TAbi, TFunctionName, TArgs>,
+                OmittedReadProperties
+              >
+            >,
+          ]
+        : [
+            args: TArgs,
+            options?: Prettify<
+              UnionOmit<
+                ReadContractParameters<TAbi, TFunctionName, TArgs>,
+                OmittedReadProperties
+              >
+            >,
+          ]
+    ) => Promise<ReadContractReturnType<TAbi, TFunctionName, TArgs>>
   : (
       ...parameters:
-        | [options?: Options]
-        | [args: readonly unknown[], options?: Options]
+        | [
+            options?: Prettify<
+              UnionOmit<ReadContractParameters, OmittedReadProperties>
+            >,
+          ]
+        | [
+            args: readonly unknown[],
+            options?: Prettify<
+              UnionOmit<ReadContractParameters, OmittedReadProperties>
+            >,
+          ]
     ) => Promise<ReadContractReturnType>
 
 type GetEstimateFunction<
   Narrowable extends boolean,
   TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
   TAbi extends Abi | readonly unknown[],
   TFunctionName extends string,
   TAbiFunction extends AbiFunction = TAbi extends Abi
@@ -666,21 +725,37 @@ type GetEstimateFunction<
     : AbiFunction,
   Args = AbiParametersToPrimitiveTypes<TAbiFunction['inputs']>,
   Options = Prettify<
-    Omit<
-      EstimateContractGasParameters<TAbi, TFunctionName, TChain>,
+    UnionOmit<
+      EstimateContractGasParameters<TAbi, TFunctionName, TChain, TAccount>,
       'abi' | 'address' | 'args' | 'functionName'
     >
   >,
+  // For making `options` parameter required if `TAccount`
+  IsOptionsRequired = IsUndefined<TAccount>,
 > = Narrowable extends true
   ? (
       ...parameters: Args extends readonly []
-        ? [options?: Options]
-        : [args: Args, options?: Options]
+        ? IsOptionsRequired extends true
+          ? [options: Options]
+          : [options?: Options]
+        : [
+            args: Args,
+            ...parameters: IsOptionsRequired extends true
+              ? [options: Options]
+              : [options?: Options],
+          ]
     ) => Promise<EstimateContractGasReturnType>
   : (
       ...parameters:
-        | [options?: Options]
-        | [args: readonly unknown[], options?: Options]
+        | (IsOptionsRequired extends true
+            ? [options: Options]
+            : [options?: Options])
+        | [
+            args: readonly unknown[],
+            ...parameters: IsOptionsRequired extends true
+              ? [options: Options]
+              : [options?: Options],
+          ]
     ) => Promise<EstimateContractGasReturnType>
 
 type GetSimulateFunction<
@@ -696,7 +771,7 @@ type GetSimulateFunction<
   ? <
       TChainOverride extends Chain | undefined,
       Options extends Prettify<
-        Omit<
+        UnionOmit<
           SimulateContractParameters<
             TAbi,
             TFunctionName,
@@ -716,7 +791,7 @@ type GetSimulateFunction<
   : <
       TChainOverride extends Chain | undefined,
       Options extends Prettify<
-        Omit<
+        UnionOmit<
           SimulateContractParameters<
             TAbi,
             TFunctionName,
@@ -748,7 +823,7 @@ type GetWriteFunction<
   ? <
       TChainOverride extends Chain | undefined,
       Options extends Prettify<
-        Omit<
+        UnionOmit<
           WriteContractParameters<
             TAbi,
             TFunctionName,
@@ -759,18 +834,22 @@ type GetWriteFunction<
           'abi' | 'address' | 'args' | 'functionName'
         >
       >,
-      Rest extends IsOptionsRequired extends true
-        ? [options: Options]
-        : [options?: Options],
     >(
       ...parameters: Args extends readonly []
-        ? Rest
-        : [args: Args, ...parameters: Rest]
+        ? IsOptionsRequired extends true
+          ? [options: Options]
+          : [options?: Options]
+        : [
+            args: Args,
+            ...parameters: IsOptionsRequired extends true
+              ? [options: Options]
+              : [options?: Options],
+          ]
     ) => Promise<WriteContractReturnType>
   : <
       TChainOverride extends Chain | undefined,
       Options extends Prettify<
-        Omit<
+        UnionOmit<
           WriteContractParameters<
             TAbi,
             TFunctionName,
@@ -799,25 +878,32 @@ type GetEventFilter<
   Options = Prettify<
     Omit<
       CreateContractEventFilterParameters<TAbi, TEventName>,
-      'abi' | 'address' | 'args' | 'eventName'
+      'abi' | 'address' | 'args' | 'eventName' | 'strict'
     >
   >,
   IndexedInputs = Extract<TAbiEvent['inputs'][number], { indexed: true }>,
 > = Narrowable extends true
-  ? <TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName> | undefined>(
+  ? <
+      const TArgs extends
+        | MaybeExtractEventArgsFromAbi<TAbi, TEventName>
+        | undefined,
+      TStrict extends boolean | undefined = undefined,
+    >(
       ...parameters: IsNever<IndexedInputs> extends true
-        ? [options?: Options]
+        ? [options?: Options & { strict?: TStrict }]
         : [
-            args: Args | (Args extends Narrow<TArgs> ? Narrow<TArgs> : never),
-            options?: Options,
+            args: Args | (Args extends TArgs ? Readonly<TArgs> : never),
+            options?: Options & { strict?: TStrict },
           ]
-    ) => Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs>>
-  : (
+    ) => Promise<
+      CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict>
+    >
+  : <TStrict extends boolean | undefined = undefined>(
       ...parameters:
-        | [options?: Options]
+        | [options?: Options & { strict?: TStrict }]
         | [
             args: readonly unknown[] | CreateContractFilterOptions,
-            options?: Options,
+            options?: Options & { strict?: TStrict },
           ]
     ) => Promise<CreateContractEventFilterReturnType>