viem 0.4.0-main.20230430T213120 → 1.0.0

package/src/actions/getContract.ts

@@ -10,42 +10,54 @@ import type {
   ExtractAbiFunctionNames,
   Narrow,
 } from 'abitype'
-import type { PublicClient, Transport, WalletClient } from '../clients/index.js'
+
+import type { Account } from '../accounts/types.js'
+import type { PublicClient } from '../clients/createPublicClient.js'
+import type { WalletClient } from '../clients/createWalletClient.js'
+import type { Transport } from '../clients/transports/createTransport.js'
+import type { Chain } from '../types/chain.js'
 import type {
   AbiEventParametersToPrimitiveTypes,
-  Account,
-  Chain,
+  MaybeExtractEventArgsFromAbi,
+} from '../types/contract.js'
+import type {
   IsNarrowable,
   IsNever,
   IsUndefined,
-  MaybeExtractEventArgsFromAbi,
   Or,
   Prettify,
-} from '../types/index.js'
+} from '../types/utils.js'
+
 import {
+  type CreateContractEventFilterParameters,
+  type CreateContractEventFilterReturnType,
   createContractEventFilter,
+} from './public/createContractEventFilter.js'
+import {
+  type EstimateContractGasParameters,
+  type EstimateContractGasReturnType,
+  estimateContractGas,
+} from './public/estimateContractGas.js'
+import {
+  type ReadContractParameters,
+  type ReadContractReturnType,
   readContract,
+} from './public/readContract.js'
+import {
+  type SimulateContractParameters,
+  type SimulateContractReturnType,
   simulateContract,
-  estimateContractGas,
+} from './public/simulateContract.js'
+import {
+  type WatchContractEventParameters,
+  type WatchContractEventReturnType,
   watchContractEvent,
-} from './public/index.js'
-import type {
-  WatchContractEventParameters,
-  WatchContractEventReturnType,
-  ReadContractParameters,
-  ReadContractReturnType,
-  SimulateContractParameters,
-  EstimateContractGasParameters,
-  CreateContractEventFilterParameters,
-  CreateContractEventFilterReturnType,
-  EstimateContractGasReturnType,
-  SimulateContractReturnType,
-} from './public/index.js'
-import { writeContract } from './wallet/index.js'
-import type {
-  WriteContractParameters,
-  WriteContractReturnType,
-} from './wallet/index.js'
+} from './public/watchContractEvent.js'
+import {
+  type WriteContractParameters,
+  type WriteContractReturnType,
+  writeContract,
+} from './wallet/writeContract.js'
 
 export type GetContractParameters<
   TTransport extends Transport = Transport,
@@ -56,11 +68,12 @@ export type GetContractParameters<
   TWalletClient extends
     | WalletClient<TTransport, TChain, TAccount>
     | unknown = unknown,
+  TAddress extends Address = Address,
 > = {
   /** Contract ABI */
   abi: Narrow<TAbi>
   /** Contract address */
-  address: Address
+  address: TAddress
   /**
    * Public client
    *
@@ -78,6 +91,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
@@ -87,6 +101,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
@@ -151,7 +166,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(),
                * })
@@ -167,9 +182,8 @@ export type GetContractReturnType<
               estimateGas: {
                 [FunctionName in _WriteFunctionNames]: GetEstimateFunction<
                   _Narrowable,
-                  TPublicClient extends PublicClient
-                    ? TPublicClient['chain']
-                    : undefined,
+                  TPublicClient['chain'],
+                  undefined,
                   TAbi,
                   FunctionName
                 >
@@ -185,7 +199,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(),
                * })
@@ -201,9 +215,7 @@ export type GetContractReturnType<
               simulate: {
                 [FunctionName in _WriteFunctionNames]: GetSimulateFunction<
                   _Narrowable,
-                  TPublicClient extends PublicClient
-                    ? TPublicClient['chain']
-                    : undefined,
+                  TPublicClient['chain'],
                   TAbi,
                   FunctionName
                 >
@@ -219,7 +231,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(),
                * })
@@ -248,7 +260,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(),
                * })
@@ -276,6 +288,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.
              *
@@ -289,14 +330,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',
@@ -305,19 +346,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`.
@@ -346,6 +383,7 @@ export type GetContractReturnType<
  */
 export function getContract<
   TTransport extends Transport,
+  TAddress extends Address,
   TAbi extends Abi | readonly unknown[],
   TChain extends Chain | undefined = Chain | undefined,
   TAccount extends Account | undefined = Account | undefined,
@@ -366,13 +404,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'
@@ -422,32 +463,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(
         {},
         {
@@ -473,7 +489,6 @@ export function getContract<
           },
         },
       )
-    }
 
     if (hasEvent) {
       contract.createEventFilter = new Proxy(
@@ -533,7 +548,7 @@ export function getContract<
                 eventName,
                 args,
                 ...options,
-              } as WatchContractEventParameters)
+              } as unknown as WatchContractEventParameters)
             }
           },
         },
@@ -575,10 +590,45 @@ export function getContract<
       )
   }
 
+  if (hasPublicClient || hasWalletClient)
+    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)
+              const client = (publicClient ?? walletClient)!
+              return estimateContractGas(client, {
+                abi,
+                address,
+                functionName,
+                args,
+                ...options,
+                account:
+                  (options as EstimateContractGasParameters).account ??
+                  (walletClient as WalletClient).account,
+              } as EstimateContractGasParameters)
+            }
+          },
+        },
+      )
+  contract.address = address
+  contract.abi = abi
+
   return contract as unknown as GetContractReturnType<
     TAbi,
     TPublicClient,
-    TWalletClient
+    TWalletClient,
+    TAddress
   >
 }
 
@@ -647,6 +697,7 @@ type GetReadFunction<
 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
@@ -655,20 +706,36 @@ type GetEstimateFunction<
   Args = AbiParametersToPrimitiveTypes<TAbiFunction['inputs']>,
   Options = Prettify<
     Omit<
-      EstimateContractGasParameters<TAbi, TFunctionName, TChain>,
+      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<
@@ -747,13 +814,17 @@ 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,
@@ -787,25 +858,30 @@ 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>(
+  ? <
+      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,
+            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>
 

package/src/actions/public/call.ts

@@ -1,38 +1,37 @@
-import type { PublicClient, Transport } from '../../clients/index.js'
-import { aggregate3Signature, multicall3Abi } from '../../constants/index.js'
+import type { Address } from 'abitype'
+
+import type { Account } from '../../accounts/types.js'
+import { parseAccount } from '../../accounts/utils/parseAccount.js'
+import type { PublicClient } from '../../clients/createPublicClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import { multicall3Abi } from '../../constants/abis.js'
+import { aggregate3Signature } from '../../constants/contract.js'
+import { BaseError } from '../../errors/base.js'
 import {
-  BaseError,
   ChainDoesNotSupportContract,
   ClientChainNotConfiguredError,
-  RawContractError,
-} from '../../errors/index.js'
-import type {
-  Account,
-  Address,
-  BlockTag,
-  Chain,
-  Formatter,
-  Hex,
-  MergeIntersectionProperties,
-  TransactionRequest,
-} from '../../types/index.js'
-import type {
-  Formatted,
-  TransactionRequestFormatter,
-} from '../../utils/index.js'
+} from '../../errors/chain.js'
+import { RawContractError } from '../../errors/contract.js'
+import type { BlockTag } from '../../types/block.js'
+import type { Chain } from '../../types/chain.js'
+import type { Formatter } from '../../types/formatter.js'
+import type { Hex } from '../../types/misc.js'
+import type { RpcTransactionRequest } from '../../types/rpc.js'
+import type { TransactionRequest } from '../../types/transaction.js'
+import type { MergeIntersectionProperties } from '../../types/utils.js'
+import { decodeFunctionResult } from '../../utils/abi/decodeFunctionResult.js'
+import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js'
+import { getChainContractAddress } from '../../utils/chain.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
+import { getCallError } from '../../utils/errors/getCallError.js'
+import { extract } from '../../utils/formatters/extract.js'
+import { type Formatted, format } from '../../utils/formatters/format.js'
 import {
-  assertRequest,
-  decodeFunctionResult,
-  encodeFunctionData,
-  extract,
-  format,
+  type TransactionRequestFormatter,
   formatTransactionRequest,
-  getCallError,
-  getChainContractAddress,
-  numberToHex,
-  parseAccount,
-} from '../../utils/index.js'
+} from '../../utils/formatters/transactionRequest.js'
 import { createBatchScheduler } from '../../utils/promise/createBatchScheduler.js'
+import { assertRequest } from '../../utils/transaction/assertRequest.js'
 
 export type FormattedCall<
   TFormatter extends Formatter | undefined = Formatter,
@@ -115,6 +114,8 @@ export async function call<TChain extends Chain | undefined>(
     assertRequest(args)
 
     const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined
+    const block = blockNumberHex || blockTag
+
     const formatter = client.chain?.formatters?.transactionRequest
     const request = format(
       {
@@ -154,7 +155,9 @@ export async function call<TChain extends Chain | undefined>(
 
     const response = await client.request({
       method: 'eth_call',
-      params: [request as any, blockNumberHex || blockTag],
+      params: block
+        ? [request as Partial<RpcTransactionRequest>, block]
+        : [request as Partial<RpcTransactionRequest>],
     })
     if (response === '0x') return { data: undefined }
     return { data: response }
@@ -205,7 +208,7 @@ async function scheduleMulticall<TChain extends Chain | undefined>(
   args: ScheduleMulticallParameters<TChain>,
 ) {
   const { batchSize = 1024, wait = 0 } =
-    typeof client.batch?.multicall === 'object' ? client.batch?.multicall : {}
+    typeof client.batch?.multicall === 'object' ? client.batch.multicall : {}
   const {
     blockNumber,
     blockTag = 'latest',
@@ -282,5 +285,6 @@ async function scheduleMulticall<TChain extends Chain | undefined>(
 
 export function getRevertErrorData(err: unknown) {
   if (!(err instanceof BaseError)) return undefined
-  return (err.walk() as { data?: Hex })?.data
+  const error = err.walk() as RawContractError
+  return typeof error.data === 'object' ? error.data.data : error.data
 }

package/src/actions/public/createBlockFilter.ts

@@ -1,11 +1,13 @@
-import type { PublicClient, Transport } from '../../clients/index.js'
-import type { Chain, Filter } from '../../types/index.js'
+import type { PublicClient } from '../../clients/createPublicClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import type { Filter } from '../../types/filter.js'
 import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js'
 
 export type CreateBlockFilterReturnType = Filter<'block'>
 
 /**
- * Creates a [`Filter`](https://viem.sh/docs/glossary/types.html#filter) to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges).
+ * Creates a [`Filter`](https://viem.sh/docs/glossary/types.html#filter) to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html).
  *
  * - Docs: https://viem.sh/docs/actions/public/createBlockFilter.html
  * - JSON-RPC Methods: [`eth_newBlockFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newBlockFilter)