viem 1.10.8 → 2.0.0-alpha.0

package/actions/index.ts

@@ -0,0 +1,357 @@
+export {
+  type GetEnsAddressParameters,
+  type GetEnsAddressReturnType,
+  getEnsAddress,
+} from './ens/getEnsAddress.js'
+export {
+  type GetEnsAvatarParameters,
+  type GetEnsAvatarReturnType,
+  getEnsAvatar,
+} from './ens/getEnsAvatar.js'
+export {
+  type GetEnsNameParameters,
+  type GetEnsNameReturnType,
+  getEnsName,
+} from './ens/getEnsName.js'
+export {
+  type GetEnsResolverParameters,
+  type GetEnsResolverReturnType,
+  getEnsResolver,
+} from './ens/getEnsResolver.js'
+export {
+  type GetEnsTextParameters,
+  type GetEnsTextReturnType,
+  getEnsText,
+} from './ens/getEnsText.js'
+export {
+  type CallParameters,
+  type CallReturnType,
+  call,
+} from './public/call.js'
+export {
+  type CreateBlockFilterReturnType,
+  createBlockFilter,
+} from './public/createBlockFilter.js'
+export {
+  type CreateContractEventFilterParameters,
+  type CreateContractEventFilterReturnType,
+  createContractEventFilter,
+} from './public/createContractEventFilter.js'
+export {
+  type CreateEventFilterParameters,
+  type CreateEventFilterReturnType,
+  createEventFilter,
+} from './public/createEventFilter.js'
+export {
+  type CreatePendingTransactionFilterReturnType,
+  createPendingTransactionFilter,
+} from './public/createPendingTransactionFilter.js'
+export {
+  type EstimateContractGasParameters,
+  type EstimateContractGasReturnType,
+  estimateContractGas,
+} from './public/estimateContractGas.js'
+export {
+  type EstimateFeesPerGasParameters,
+  type EstimateFeesPerGasReturnType,
+  estimateFeesPerGas,
+} from './public/estimateFeesPerGas.js'
+export {
+  type EstimateMaxPriorityFeePerGasParameters,
+  type EstimateMaxPriorityFeePerGasReturnType,
+  estimateMaxPriorityFeePerGas,
+} from './public/estimateMaxPriorityFeePerGas.js'
+export {
+  type EstimateGasParameters,
+  type EstimateGasReturnType,
+  estimateGas,
+} from './public/estimateGas.js'
+export {
+  type GetBalanceParameters,
+  type GetBalanceReturnType,
+  getBalance,
+} from './public/getBalance.js'
+export {
+  type GetBlockParameters,
+  type GetBlockReturnType,
+  getBlock,
+} from './public/getBlock.js'
+export {
+  type GetBlockNumberParameters,
+  type GetBlockNumberReturnType,
+  getBlockNumber,
+} from './public/getBlockNumber.js'
+export {
+  type GetBlockTransactionCountParameters,
+  type GetBlockTransactionCountReturnType,
+  getBlockTransactionCount,
+} from './public/getBlockTransactionCount.js'
+export {
+  type GetBytecodeParameters,
+  type GetBytecodeReturnType,
+  getBytecode,
+} from './public/getBytecode.js'
+export { type GetChainIdReturnType, getChainId } from './public/getChainId.js'
+export {
+  type GetFeeHistoryParameters,
+  type GetFeeHistoryReturnType,
+  getFeeHistory,
+} from './public/getFeeHistory.js'
+export {
+  type GetFilterChangesParameters,
+  type GetFilterChangesReturnType,
+  getFilterChanges,
+} from './public/getFilterChanges.js'
+export {
+  type GetFilterLogsParameters,
+  type GetFilterLogsReturnType,
+  getFilterLogs,
+} from './public/getFilterLogs.js'
+export {
+  type GetGasPriceReturnType,
+  getGasPrice,
+} from './public/getGasPrice.js'
+export {
+  type GetLogsParameters,
+  type GetLogsReturnType,
+  getLogs,
+} from './public/getLogs.js'
+export {
+  type GetStorageAtParameters,
+  type GetStorageAtReturnType,
+  getStorageAt,
+} from './public/getStorageAt.js'
+export {
+  type GetTransactionConfirmationsParameters,
+  type GetTransactionConfirmationsReturnType,
+  getTransactionConfirmations,
+} from './public/getTransactionConfirmations.js'
+export {
+  type GetTransactionCountParameters,
+  type GetTransactionCountReturnType,
+  getTransactionCount,
+} from './public/getTransactionCount.js'
+export {
+  type GetTransactionParameters,
+  type GetTransactionReturnType,
+  getTransaction,
+} from './public/getTransaction.js'
+export {
+  type GetTransactionReceiptParameters,
+  type GetTransactionReceiptReturnType,
+  getTransactionReceipt,
+} from './public/getTransactionReceipt.js'
+export {
+  type ImpersonateAccountParameters,
+  impersonateAccount,
+} from './test/impersonateAccount.js'
+export {
+  type IncreaseTimeParameters,
+  increaseTime,
+} from './test/increaseTime.js'
+export { type MineParameters, mine } from './test/mine.js'
+export {
+  type MulticallParameters,
+  type MulticallReturnType,
+  multicall,
+} from './public/multicall.js'
+export {
+  type OnBlock,
+  type OnBlockParameter,
+  type WatchBlocksParameters,
+  type WatchBlocksReturnType,
+  watchBlocks,
+} from './public/watchBlocks.js'
+export {
+  type OnBlockNumberFn,
+  type OnBlockNumberParameter,
+  type WatchBlockNumberParameters,
+  type WatchBlockNumberReturnType,
+  watchBlockNumber,
+} 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,
+} from './public/watchEvent.js'
+export {
+  type OnTransactionsFn,
+  type OnTransactionsParameter,
+  type WatchPendingTransactionsParameters,
+  type WatchPendingTransactionsReturnType,
+  watchPendingTransactions,
+} from './public/watchPendingTransactions.js'
+export {
+  type ReadContractParameters,
+  type ReadContractReturnType,
+  readContract,
+} from './public/readContract.js'
+export {
+  type GetAddressesReturnType,
+  getAddresses,
+} from './wallet/getAddresses.js'
+export {
+  type GetPermissionsReturnType,
+  getPermissions,
+} from './wallet/getPermissions.js'
+export {
+  type ReplacementReason,
+  type ReplacementReturnType,
+  type WaitForTransactionReceiptParameters,
+  type WaitForTransactionReceiptReturnType,
+  waitForTransactionReceipt,
+} from './public/waitForTransactionReceipt.js'
+export {
+  type RequestAddressesReturnType,
+  requestAddresses,
+} from './wallet/requestAddresses.js'
+export {
+  type RequestPermissionsReturnType,
+  type RequestPermissionsParameters,
+  requestPermissions,
+} from './wallet/requestPermissions.js'
+export {
+  type DropTransactionParameters,
+  dropTransaction,
+} from './test/dropTransaction.js'
+export {
+  type GetAutomineReturnType,
+  getAutomine,
+} from './test/getAutomine.js'
+export {
+  type GetTxpoolContentReturnType,
+  getTxpoolContent,
+} from './test/getTxpoolContent.js'
+export {
+  type GetTxpoolStatusReturnType,
+  getTxpoolStatus,
+} from './test/getTxpoolStatus.js'
+export {
+  type InspectTxpoolReturnType,
+  inspectTxpool,
+} from './test/inspectTxpool.js'
+export { type ResetParameters, reset } from './test/reset.js'
+export { type RevertParameters, revert } from './test/revert.js'
+export {
+  type PrepareTransactionRequestParameters,
+  type PrepareTransactionRequestReturnType,
+  prepareTransactionRequest,
+} from './wallet/prepareTransactionRequest.js'
+export {
+  type SendTransactionParameters,
+  type SendTransactionReturnType,
+  sendTransaction,
+} from './wallet/sendTransaction.js'
+export {
+  type SignTransactionParameters,
+  type SignTransactionReturnType,
+  signTransaction,
+} from './wallet/signTransaction.js'
+export {
+  type SendRawTransactionParameters,
+  type SendRawTransactionReturnType,
+  sendRawTransaction,
+} from './wallet/sendRawTransaction.js'
+export {
+  type SendUnsignedTransactionParameters,
+  type SendUnsignedTransactionReturnType,
+  sendUnsignedTransaction,
+} from './test/sendUnsignedTransaction.js'
+export { type SetBalanceParameters, setBalance } from './test/setBalance.js'
+export { setAutomine } from './test/setAutomine.js'
+export {
+  type SetBlockGasLimitParameters,
+  setBlockGasLimit,
+} from './test/setBlockGasLimit.js'
+export {
+  type SetBlockTimestampIntervalParameters,
+  setBlockTimestampInterval,
+} from './test/setBlockTimestampInterval.js'
+export { type SetCodeParameters, setCode } from './test/setCode.js'
+export { type SetCoinbaseParameters, setCoinbase } from './test/setCoinbase.js'
+export {
+  type SetIntervalMiningParameters,
+  setIntervalMining,
+} from './test/setIntervalMining.js'
+export {
+  type SetMinGasPriceParameters,
+  setMinGasPrice,
+} from './test/setMinGasPrice.js'
+export {
+  type SetNextBlockBaseFeePerGasParameters,
+  setNextBlockBaseFeePerGas,
+} from './test/setNextBlockBaseFeePerGas.js'
+export {
+  type SetNextBlockTimestampParameters,
+  setNextBlockTimestamp,
+} from './test/setNextBlockTimestamp.js'
+export { type SetNonceParameters, setNonce } from './test/setNonce.js'
+export {
+  type SetStorageAtParameters,
+  setStorageAt,
+} from './test/setStorageAt.js'
+export { snapshot } from './test/snapshot.js'
+export {
+  type SignMessageParameters,
+  type SignMessageReturnType,
+  signMessage,
+} from './wallet/signMessage.js'
+export {
+  type SignTypedDataParameters,
+  type SignTypedDataReturnType,
+  signTypedData,
+} from './wallet/signTypedData.js'
+export {
+  type SimulateContractParameters,
+  type SimulateContractReturnType,
+  simulateContract,
+} from './public/simulateContract.js'
+export {
+  type StopImpersonatingAccountParameters,
+  stopImpersonatingAccount,
+} from './test/stopImpersonatingAccount.js'
+export {
+  type SwitchChainParameters,
+  switchChain,
+} from './wallet/switchChain.js'
+export {
+  type UninstallFilterParameters,
+  type UninstallFilterReturnType,
+  uninstallFilter,
+} from './public/uninstallFilter.js'
+export {
+  type VerifyHashParameters,
+  type VerifyHashReturnType,
+  verifyHash,
+} from './public/verifyHash.js'
+export {
+  type VerifyMessageParameters,
+  type VerifyMessageReturnType,
+  verifyMessage,
+} from './public/verifyMessage.js'
+export {
+  type VerifyTypedDataParameters,
+  type VerifyTypedDataReturnType,
+  verifyTypedData,
+} from './public/verifyTypedData.js'
+export {
+  type WatchAssetParameters,
+  type WatchAssetReturnType,
+  watchAsset,
+} from './wallet/watchAsset.js'
+export {
+  type WatchContractEventParameters,
+  type WatchContractEventReturnType,
+  watchContractEvent,
+} from './public/watchContractEvent.js'
+export {
+  type WriteContractParameters,
+  type WriteContractReturnType,
+  writeContract,
+} from './wallet/writeContract.js'

package/actions/public/createContractEventFilter.ts

@@ -0,0 +1,156 @@
+import type { Abi, Address } from 'abitype'
+
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { BlockNumber, BlockTag } from '../../types/block.js'
+import type { Chain } from '../../types/chain.js'
+import type {
+  ContractEventName,
+  MaybeExtractEventArgsFromAbi,
+} from '../../types/contract.js'
+import type { Filter } from '../../types/filter.js'
+import type { Hex } from '../../types/misc.js'
+import {
+  type EncodeEventTopicsParameters,
+  encodeEventTopics,
+} from '../../utils/abi/encodeEventTopics.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
+import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js'
+
+export type CreateContractEventFilterParameters<
+  abi extends Abi | readonly unknown[] = Abi,
+  eventName extends ContractEventName<abi> | undefined = undefined,
+  args extends
+    | MaybeExtractEventArgsFromAbi<abi, eventName>
+    | undefined = undefined,
+  strict extends boolean | undefined = undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  toBlock extends BlockNumber | BlockTag | undefined = undefined,
+> = {
+  address?: Address | Address[]
+  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?: strict
+  toBlock?: toBlock | BlockNumber | BlockTag
+} & (undefined extends eventName
+  ? {
+      args?: never
+    }
+  : MaybeExtractEventArgsFromAbi<abi, eventName> extends infer TEventFilterArgs
+  ? {
+      args?: TEventFilterArgs | (args extends TEventFilterArgs ? args : never)
+    }
+  : {
+      args?: never
+    })
+
+export type CreateContractEventFilterReturnType<
+  abi extends Abi | readonly unknown[] = Abi,
+  eventName extends ContractEventName<abi> | undefined = undefined,
+  args extends
+    | MaybeExtractEventArgsFromAbi<abi, eventName>
+    | undefined = undefined,
+  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>
+
+/**
+ * Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs.html).
+ *
+ * - Docs: https://viem.sh/docs/contract/createContractEventFilter.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link CreateContractEventFilterParameters}
+ * @returns [`Filter`](https://viem.sh/docs/glossary/types.html#filter). {@link CreateContractEventFilterReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbi } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createContractEventFilter } from 'viem/contract'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const filter = await createContractEventFilter(client, {
+ *   abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
+ * })
+ */
+export async function createContractEventFilter<
+  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, chain>,
+  parameters: CreateContractEventFilterParameters<
+    abi,
+    eventName,
+    args,
+    strict,
+    fromBlock,
+    toBlock
+  >,
+): Promise<
+  CreateContractEventFilterReturnType<
+    abi,
+    eventName,
+    args,
+    strict,
+    fromBlock,
+    toBlock
+  >
+> {
+  const { address, abi, args, eventName, fromBlock, strict, toBlock } =
+    parameters as CreateContractEventFilterParameters
+
+  const getRequest = createFilterRequestScope(client, {
+    method: 'eth_newFilter',
+  })
+
+  const topics = eventName
+    ? encodeEventTopics({
+        abi,
+        args,
+        eventName,
+      } as unknown as EncodeEventTopicsParameters)
+    : undefined
+  const id: Hex = await client.request({
+    method: 'eth_newFilter',
+    params: [
+      {
+        address,
+        fromBlock:
+          typeof fromBlock === 'bigint' ? numberToHex(fromBlock) : fromBlock,
+        toBlock: typeof toBlock === 'bigint' ? numberToHex(toBlock) : toBlock,
+        topics,
+      },
+    ],
+  })
+
+  return {
+    abi,
+    args,
+    eventName,
+    id,
+    request: getRequest(id),
+    strict,
+    type: 'event',
+  } as unknown as CreateContractEventFilterReturnType<
+    abi,
+    eventName,
+    args,
+    strict,
+    fromBlock,
+    toBlock
+  >
+}

package/actions/public/estimateContractGas.ts

@@ -0,0 +1,110 @@
+import type { Abi } from 'abitype'
+
+import type { Account } from '../../accounts/types.js'
+import { parseAccount } from '../../accounts/utils/parseAccount.js'
+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 {
+  ContractFunctionArgs,
+  ContractFunctionName,
+  ContractFunctionParameters,
+  GetValue,
+} from '../../types/contract.js'
+import type { UnionOmit } from '../../types/utils.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<
+  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<
+    abi,
+    functionName,
+    EstimateGasParameters<chain> extends EstimateGasParameters
+      ? EstimateGasParameters<chain>['value']
+      : EstimateGasParameters['value']
+  >
+
+export type EstimateContractGasReturnType = bigint
+
+/**
+ * Estimates the gas required to successfully execute a contract write function call.
+ *
+ * - Docs: https://viem.sh/docs/contract/estimateContractGas.html
+ *
+ * Internally, uses a [Public Client](https://viem.sh/docs/clients/public.html) to call the [`estimateGas` action](https://viem.sh/docs/actions/public/estimateGas.html) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData.html).
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateContractGasParameters}
+ * @returns The gas estimate (in wei). {@link EstimateContractGasReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbi } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { estimateContractGas } from 'viem/contract'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const gas = await estimateContractGas(client, {
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ *   abi: parseAbi(['function mint() public']),
+ *   functionName: 'mint',
+ *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+ * })
+ */
+export async function estimateContractGas<
+  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, chain, account>,
+  parameters: EstimateContractGasParameters<
+    abi,
+    functionName,
+    args,
+    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 })
+    return gas
+  } catch (error) {
+    const account = request.account ? parseAccount(request.account) : undefined
+    throw getContractError(error as BaseError, {
+      abi,
+      address,
+      args,
+      docsPath: '/docs/contract/estimateContractGas',
+      functionName,
+      sender: account?.address,
+    })
+  }
+}