viem 0.0.0-main.20240103T193024 → 0.0.0-main.20240103T195854

package/actions/index.ts

@@ -1,3 +1,8 @@
+export {
+  type AddChainErrorType,
+  type AddChainParameters,
+  addChain,
+} from './wallet/addChain.js'
 export {
   type GetEnsAddressErrorType,
   type GetEnsAddressParameters,
@@ -56,6 +61,11 @@ export {
   type CreatePendingTransactionFilterReturnType,
   createPendingTransactionFilter,
 } from './public/createPendingTransactionFilter.js'
+export {
+  type DumpStateErrorType,
+  type DumpStateReturnType,
+  dumpState,
+} from './test/dumpState.js'
 export {
   type EstimateContractGasErrorType,
   type EstimateContractGasParameters,
@@ -184,6 +194,12 @@ export {
   type IncreaseTimeParameters,
   increaseTime,
 } from './test/increaseTime.js'
+export {
+  type LoadStateErrorType,
+  type LoadStateParameters,
+  type LoadStateReturnType,
+  loadState,
+} from './test/loadState.js'
 export {
   type MineErrorType,
   type MineParameters,
@@ -213,11 +229,7 @@ export {
 } from './public/watchBlockNumber.js'
 export {
   type WatchEventOnLogsFn,
-  /** @deprecated - use `WatchEventOnLogsFn` instead. */
-  type WatchEventOnLogsFn as OnLogsFn,
   type WatchEventOnLogsParameter,
-  /** @deprecated - use `WatchEventOnLogsParameter` instead. */
-  type WatchEventOnLogsParameter as OnLogsParameter,
   type WatchEventParameters,
   type WatchEventReturnType,
   watchEvent,
@@ -236,11 +248,22 @@ export {
   type ReadContractReturnType,
   readContract,
 } from './public/readContract.js'
+export {
+  type GetAddressesErrorType,
+  type GetAddressesReturnType,
+  getAddresses,
+} from './wallet/getAddresses.js'
 export {
   type GetPermissionsErrorType,
   type GetPermissionsReturnType,
   getPermissions,
 } from './wallet/getPermissions.js'
+export {
+  type GetProofErrorType,
+  type GetProofParameters,
+  type GetProofReturnType,
+  getProof,
+} from './public/getProof.js'
 export {
   type ReplacementReason,
   type ReplacementReturnType,
@@ -249,11 +272,6 @@ export {
   type WaitForTransactionReceiptReturnType,
   waitForTransactionReceipt,
 } from './public/waitForTransactionReceipt.js'
-export {
-  type GetAddressesErrorType,
-  type GetAddressesReturnType,
-  getAddresses,
-} from './wallet/getAddresses.js'
 export {
   type RequestAddressesErrorType,
   type RequestAddressesReturnType,
@@ -289,6 +307,10 @@ export {
   type InspectTxpoolReturnType,
   inspectTxpool,
 } from './test/inspectTxpool.js'
+export {
+  type RemoveBlockTimestampIntervalErrorType,
+  removeBlockTimestampInterval,
+} from './test/removeBlockTimestampInterval.js'
 export {
   type ResetErrorType,
   type ResetParameters,
@@ -360,6 +382,10 @@ export {
   type SetIntervalMiningParameters,
   setIntervalMining,
 } from './test/setIntervalMining.js'
+export {
+  type SetLoggingEnabledErrorType,
+  setLoggingEnabled,
+} from './test/setLoggingEnabled.js'
 export {
   type SetMinGasPriceErrorType,
   type SetMinGasPriceParameters,
@@ -380,6 +406,7 @@ export {
   type SetNonceParameters,
   setNonce,
 } from './test/setNonce.js'
+export { type SetRpcUrlErrorType, setRpcUrl } from './test/setRpcUrl.js'
 export {
   type SetStorageAtErrorType,
   type SetStorageAtParameters,

package/actions/public/createContractEventFilter.ts

@@ -6,7 +6,7 @@ import type { ErrorType } from '../../errors/utils.js'
 import type { BlockNumber, BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
 import type {
-  InferEventName,
+  ContractEventName,
   MaybeExtractEventArgsFromAbi,
 } from '../../types/contract.js'
 import type { Filter } from '../../types/filter.js'
@@ -24,52 +24,47 @@ import {
 import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js'
 
 export type CreateContractEventFilterParameters<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TEventName extends string | undefined = undefined,
-  TArgs extends
-    | MaybeExtractEventArgsFromAbi<TAbi, TEventName>
+  abi extends Abi | readonly unknown[] = Abi,
+  eventName extends ContractEventName<abi> | undefined = undefined,
+  args extends
+    | MaybeExtractEventArgsFromAbi<abi, eventName>
     | undefined = undefined,
-  TStrict extends boolean | undefined = undefined,
-  TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
-  TToBlock extends BlockNumber | BlockTag | undefined = undefined,
+  strict extends boolean | undefined = undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  toBlock extends BlockNumber | BlockTag | undefined = undefined,
 > = {
   address?: Address | Address[]
-  abi: TAbi
-  eventName?: InferEventName<TAbi, TEventName>
-  fromBlock?: TFromBlock | BlockNumber | BlockTag
+  abi: abi
+  eventName?: eventName | ContractEventName<abi> | undefined
+  fromBlock?: fromBlock | BlockNumber | BlockTag
   /**
    * Whether or not the logs must match the indexed/non-indexed arguments in the event ABI item.
    * @default false
    */
-  strict?: TStrict
-  toBlock?: TToBlock | BlockNumber | BlockTag
-} & (undefined extends TEventName
+  strict?: strict | boolean | undefined
+  toBlock?: toBlock | BlockNumber | BlockTag
+} & (undefined extends eventName
   ? {
       args?: never
     }
-  : MaybeExtractEventArgsFromAbi<
-        TAbi,
-        TEventName
-      > extends infer TEventFilterArgs
+  : MaybeExtractEventArgsFromAbi<abi, eventName> extends infer TEventFilterArgs
     ? {
-        args?:
-          | TEventFilterArgs
-          | (TArgs extends TEventFilterArgs ? TArgs : never)
+        args?: TEventFilterArgs | (args extends TEventFilterArgs ? args : never)
       }
     : {
         args?: never
       })
 
 export type CreateContractEventFilterReturnType<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TEventName extends string | undefined = undefined,
-  TArgs extends
-    | MaybeExtractEventArgsFromAbi<TAbi, TEventName>
+  abi extends Abi | readonly unknown[] = Abi,
+  eventName extends ContractEventName<abi> | undefined = undefined,
+  args extends
+    | MaybeExtractEventArgsFromAbi<abi, eventName>
     | undefined = undefined,
-  TStrict extends boolean | undefined = undefined,
-  TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
-  TToBlock extends BlockNumber | BlockTag | undefined = undefined,
-> = Filter<'event', TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>
+  strict extends boolean | undefined = undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  toBlock extends BlockNumber | BlockTag | undefined = undefined,
+> = Filter<'event', abi, eventName, args, strict, fromBlock, toBlock>
 
 export type CreateContractEventFilterErrorType =
   | EncodeEventTopicsErrorType
@@ -100,41 +95,36 @@ export type CreateContractEventFilterErrorType =
  * })
  */
 export async function createContractEventFilter<
-  TChain extends Chain | undefined,
-  const TAbi extends Abi | readonly unknown[],
-  TEventName extends string | undefined,
-  TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName> | undefined,
-  TStrict extends boolean | undefined = undefined,
-  TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
-  TToBlock extends BlockNumber | BlockTag | undefined = undefined,
+  chain extends Chain | undefined,
+  const abi extends Abi | readonly unknown[],
+  eventName extends ContractEventName<abi> | undefined,
+  args extends MaybeExtractEventArgsFromAbi<abi, eventName> | undefined,
+  strict extends boolean | undefined = undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  toBlock extends BlockNumber | BlockTag | undefined = undefined,
 >(
-  client: Client<Transport, TChain>,
-  {
-    address,
+  client: Client<Transport, chain>,
+  parameters: CreateContractEventFilterParameters<
     abi,
-    args,
     eventName,
-    fromBlock,
+    args,
     strict,
-    toBlock,
-  }: CreateContractEventFilterParameters<
-    TAbi,
-    TEventName,
-    TArgs,
-    TStrict,
-    TFromBlock,
-    TToBlock
+    fromBlock,
+    toBlock
   >,
 ): Promise<
   CreateContractEventFilterReturnType<
-    TAbi,
-    TEventName,
-    TArgs,
-    TStrict,
-    TFromBlock,
-    TToBlock
+    abi,
+    eventName,
+    args,
+    strict,
+    fromBlock,
+    toBlock
   >
 > {
+  const { address, abi, args, eventName, fromBlock, strict, toBlock } =
+    parameters as CreateContractEventFilterParameters
+
   const getRequest = createFilterRequestScope(client, {
     method: 'eth_newFilter',
   })
@@ -165,14 +155,14 @@ export async function createContractEventFilter<
     eventName,
     id,
     request: getRequest(id),
-    strict,
+    strict: Boolean(strict),
     type: 'event',
   } as unknown as CreateContractEventFilterReturnType<
-    TAbi,
-    TEventName,
-    TArgs,
-    TStrict,
-    TFromBlock,
-    TToBlock
+    abi,
+    eventName,
+    args,
+    strict,
+    fromBlock,
+    toBlock
   >
 }

package/actions/public/createEventFilter.ts

@@ -221,7 +221,7 @@ export async function createEventFilter<
     fromBlock,
     id,
     request: getRequest(id),
-    strict,
+    strict: Boolean(strict),
     toBlock,
     type: 'event',
   } as unknown as CreateEventFilterReturnType<

package/actions/public/estimateContractGas.ts

@@ -9,7 +9,12 @@ 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 EncodeFunctionDataErrorType,
@@ -28,17 +33,29 @@ import {
 } 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,
+> = ContractFunctionParameters<
+  abi,
+  'nonpayable' | 'payable',
+  functionName,
+  args
+> &
+  UnionOmit<EstimateGasParameters<chain>, 'data' | 'to' | 'value'> &
   GetValue<
-    TAbi,
-    TFunctionName,
-    EstimateGasParameters<TChain> extends EstimateGasParameters
-      ? EstimateGasParameters<TChain>['value']
+    abi,
+    functionName,
+    EstimateGasParameters<chain> extends EstimateGasParameters
+      ? EstimateGasParameters<chain>['value']
       : EstimateGasParameters['value']
   >
 
@@ -76,25 +93,22 @@ export type EstimateContractGasErrorType = GetContractErrorReturnType<
  * })
  */
 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>,
-  {
-    abi,
-    address,
-    args,
-    functionName,
-    ...request
-  }: EstimateContractGasParameters<TAbi, TFunctionName, TChain, TAccount>,
+  client: Client<Transport, chain, account>,
+  parameters: EstimateContractGasParameters<abi, functionName, args, chain>,
 ): Promise<EstimateContractGasReturnType> {
+  const { abi, address, args, functionName, ...request } =
+    parameters as EstimateContractGasParameters
   const data = encodeFunctionData({
     abi,
     args,
     functionName,
-  } as unknown as EncodeFunctionDataParameters<TAbi, TFunctionName>)
+  } as EncodeFunctionDataParameters)
   try {
     const gas = await getAction(
       client,
@@ -104,12 +118,12 @@ export async function estimateContractGas<
       data,
       to: address,
       ...request,
-    } as unknown as EstimateGasParameters<TChain>)
+    } as unknown as EstimateGasParameters)
     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/actions/public/estimateFeesPerGas.ts

@@ -13,7 +13,7 @@ import type {
   ChainEstimateFeesPerGasFnParameters,
   ChainFeesFnParameters,
 } from '../../types/chain.js'
-import type { GetChain } from '../../types/chain.js'
+import type { GetChainParameter } from '../../types/chain.js'
 import type {
   FeeValuesEIP1559,
   FeeValuesLegacy,
@@ -42,7 +42,7 @@ export type EstimateFeesPerGasParameters<
    * @default 'eip1559'
    */
   type?: type | FeeValuesType
-} & GetChain<chain, chainOverride>
+} & GetChainParameter<chain, chainOverride>
 
 export type EstimateFeesPerGasReturnType<
   type extends FeeValuesType = FeeValuesType,
@@ -148,7 +148,7 @@ export async function internal_estimateFeesPerGas<
       : await internal_estimateMaxPriorityFeePerGas(
           client as Client<Transport, Chain>,
           {
-            block,
+            block: block as Block,
             chain,
             request,
           },

package/actions/public/estimateGas.ts

@@ -1,3 +1,4 @@
+import type { Address } from 'abitype'
 import type { Account } from '../../accounts/types.js'
 import {
   type ParseAccountErrorType,
@@ -5,9 +6,7 @@ import {
 } from '../../accounts/utils/parseAccount.js'
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
-import { AccountNotFoundError } from '../../errors/account.js'
 import type { BaseError } from '../../errors/base.js'
-import type { GetAccountParameter } from '../../types/account.js'
 import type { BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
 import type { TransactionRequest } from '../../types/transaction.js'
@@ -42,10 +41,9 @@ export type FormattedEstimateGas<
 
 export type EstimateGasParameters<
   TChain extends Chain | undefined = Chain | undefined,
-  TAccount extends Account | undefined = undefined,
-> = UnionOmit<FormattedEstimateGas<TChain>, 'from'> &
-  GetAccountParameter<TAccount> &
-  (
+> = UnionOmit<FormattedEstimateGas<TChain>, 'from'> & {
+  account?: Account | Address
+} & (
     | {
         /** The balance of the account at a block number. */
         blockNumber?: bigint
@@ -100,14 +98,10 @@ export async function estimateGas<
   TAccount extends Account | undefined = undefined,
 >(
   client: Client<Transport, TChain, TAccount>,
-  args: EstimateGasParameters<TChain, TAccount>,
+  args: EstimateGasParameters<TChain>,
 ): Promise<EstimateGasReturnType> {
   const account_ = args.account ?? client.account
-  if (!account_)
-    throw new AccountNotFoundError({
-      docsPath: '/docs/actions/public/estimateGas',
-    })
-  const account = parseAccount(account_)
+  const account = account_ ? parseAccount(account_) : undefined
 
   try {
     const {
@@ -124,7 +118,7 @@ export async function estimateGas<
       value,
       ...rest
     } =
-      account.type === 'local'
+      account?.type === 'local'
         ? ((await prepareTransactionRequest(
             client,
             args as PrepareTransactionRequestParameters,
@@ -142,7 +136,7 @@ export async function estimateGas<
     const request = format({
       // Pick out extra data that might exist on the chain's transaction request type.
       ...extract(rest, { format: chainFormat }),
-      from: account.address,
+      from: account?.address,
       accessList,
       data,
       gas,

package/actions/public/estimateMaxPriorityFeePerGas.ts

@@ -8,7 +8,7 @@ import type { ErrorType } from '../../errors/utils.js'
 import type { Account } from '../../types/account.js'
 import type { Block } from '../../types/block.js'
 import type { Chain, ChainFeesFnParameters } from '../../types/chain.js'
-import type { GetChain } from '../../types/chain.js'
+import type { GetChainParameter } from '../../types/chain.js'
 import type { RequestErrorType } from '../../utils/buildRequest.js'
 import {
   type HexToBigIntErrorType,
@@ -22,7 +22,7 @@ import { type GetGasPriceErrorType, getGasPrice } from './getGasPrice.js'
 export type EstimateMaxPriorityFeePerGasParameters<
   chain extends Chain | undefined = Chain | undefined,
   chainOverride extends Chain | undefined = Chain | undefined,
-> = GetChain<chain, chainOverride>
+> = GetChainParameter<chain, chainOverride>
 
 export type EstimateMaxPriorityFeePerGasReturnType = bigint
 

package/actions/public/getBlock.ts

@@ -51,7 +51,7 @@ export type GetBlockParameters<
 )
 
 export type GetBlockReturnType<
-  TChain extends Chain | undefined = Chain | undefined,
+  TChain extends Chain | undefined = undefined,
   TIncludeTransactions extends boolean = false,
   TBlockTag extends BlockTag = 'latest',
 > = FormattedBlock<TChain, TIncludeTransactions, TBlockTag>

package/actions/public/getBlockNumber.ts

@@ -8,8 +8,6 @@ import { getCache, withCache } from '../../utils/promise/withCache.js'
 export type GetBlockNumberParameters = {
   /** Time (in ms) that cached block number will remain in memory. */
   cacheTime?: number
-  /** @deprecated use `cacheTime` instead. */
-  maxAge?: number
 }
 
 export type GetBlockNumberReturnType = bigint
@@ -47,14 +45,14 @@ export function getBlockNumberCache(id: string) {
  */
 export async function getBlockNumber<TChain extends Chain | undefined>(
   client: Client<Transport, TChain>,
-  { cacheTime = client.cacheTime, maxAge }: GetBlockNumberParameters = {},
+  { cacheTime = client.cacheTime }: GetBlockNumberParameters = {},
 ): Promise<GetBlockNumberReturnType> {
   const blockNumberHex = await withCache(
     () =>
       client.request({
         method: 'eth_blockNumber',
       }),
-    { cacheKey: cacheKey(client.uid), cacheTime: maxAge ?? cacheTime },
+    { cacheKey: cacheKey(client.uid), cacheTime },
   )
   return BigInt(blockNumberHex)
 }