viem 0.3.0 → 0.3.2

package/src/actions/ens/getEnsAvatar.ts

@@ -19,7 +19,6 @@ export type GetEnsAvatarReturnType = string | null
  * - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar.html
  * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
  *
- * @remarks
  * Calls [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText.html) with `key` set to `'avatar'`.
  *
  * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.

package/src/actions/ens/getEnsName.ts

@@ -25,7 +25,6 @@ export type GetEnsNameReturnType = string | null
  * - Docs: https://viem.sh/docs/ens/actions/getEnsName.html
  * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
  *
- * @remarks
  * Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.
  *
  * @param client - Client to use

package/src/actions/ens/getEnsResolver.ts

@@ -22,7 +22,6 @@ export type GetEnsResolverReturnType = Address
  * - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
  * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
  *
- * @remarks
  * Calls `findResolver(bytes)` on ENS Universal Resolver Contract to retrieve the resolver of an ENS name.
  *
  * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.

package/src/actions/ens/getEnsText.ts

@@ -30,7 +30,6 @@ export type GetEnsTextReturnType = string | null
  * - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
  * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
  *
- * @remarks
  * Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
  *
  * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.

package/src/actions/getContract.ts

@@ -114,6 +114,24 @@ export type GetContractReturnType<
              * A "read-only" function (constant function) on a Solidity contract is denoted by a `view` or `pure` keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.
              *
              * Internally, `read` uses a [Public Client](https://viem.sh/docs/clients/public.html) to call the [`call` action](https://viem.sh/docs/actions/public/call.html) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData.html).
+             *
+             * @example
+             * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+             * import { mainnet } from 'viem/chains'
+             *
+             * const publicClient = createPublicClient({
+             *   chain: mainnet,
+             *   transport: http(),
+             * })
+             * const contract = getContract({
+             *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+             *   abi: parseAbi([
+             *     'function balanceOf(address owner) view returns (uint256)',
+             *   ]),
+             *   publicClient,
+             * })
+             * const result = await contract.read.balanceOf(['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'])
+             * // 424122n
              */
             read: {
               [FunctionName in _ReadFunctionNames]: GetReadFunction<
@@ -128,6 +146,23 @@ export type GetContractReturnType<
           : {
               /**
                * Estimates the gas necessary to complete a transaction without submitting it to the network.
+               *
+               * @example
+               * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+               * import { mainnet } from 'viem/chains'
+               *
+               * const client = createPublicClient({
+               *   chain: mainnet,
+               *   transport: http(),
+               * })
+               * const contract = getContract({
+               *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+               *   abi: parseAbi(['function mint() public']),
+               *   publicClient,
+               * })
+               * const gas = await contract.estimateGas.mint({
+               *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+               * })
                */
               estimateGas: {
                 [FunctionName in _WriteFunctionNames]: GetEstimateFunction<
@@ -145,6 +180,23 @@ export type GetContractReturnType<
                * This function does not require gas to execute and does not change the state of the blockchain. It is almost identical to [`readContract`](https://viem.sh/docs/contract/readContract.html), but also supports contract write functions.
                *
                * Internally, `simulate` uses a [Public Client](https://viem.sh/docs/clients/public.html) to call the [`call` action](https://viem.sh/docs/actions/public/call.html) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData.html).
+               *
+               * @example
+               * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+               * import { mainnet } from 'viem/chains'
+               *
+               * const client = createPublicClient({
+               *   chain: mainnet,
+               *   transport: http(),
+               * })
+               * const contract = getContract({
+               *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+               *   abi: parseAbi(['function mint() public']),
+               *   publicClient,
+               * })
+               * const result = await contract.simulate.mint({
+               *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+               * })
                */
               simulate: {
                 [FunctionName in _WriteFunctionNames]: GetSimulateFunction<
@@ -162,6 +214,21 @@ export type GetContractReturnType<
           : {
               /**
                * 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).
+               *
+               * @example
+               * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+               * import { mainnet } from 'viem/chains'
+               *
+               * const client = createPublicClient({
+               *   chain: mainnet,
+               *   transport: http(),
+               * })
+               * const contract = getContract({
+               *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+               *   abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
+               *   publicClient,
+               * })
+               * const filter = await contract.createEventFilter.Transfer()
                */
               createEventFilter: {
                 [EventName in _EventNames]: GetEventFilter<
@@ -176,6 +243,25 @@ export type GetContractReturnType<
                * This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent.html#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/contract/watchContractEvent.html#onLogs).
                *
                * `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter.html) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs.html) instead.
+               *
+               * @example
+               * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+               * import { mainnet } from 'viem/chains'
+               *
+               * const client = createPublicClient({
+               *   chain: mainnet,
+               *   transport: http(),
+               * })
+               * const contract = getContract({
+               *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+               *   abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
+               *   publicClient,
+               * })
+               * const filter = await contract.createEventFilter.Transfer()
+               * const unwatch = contract.watchEvent.Transfer(
+               *   { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' },
+               *   { onLogs: (logs) => console.log(logs) },
+               * )
                */
               watchEvent: {
                 [EventName in _EventNames]: GetWatchEvent<
@@ -197,7 +283,24 @@ export type GetContractReturnType<
              *
              * Internally, `write` uses a [Wallet Client](https://viem.sh/docs/clients/wallet.html) to call the [`sendTransaction` action](https://viem.sh/docs/actions/wallet/sendTransaction.html) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData.html).
              *
-             * Warning: The `write` internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to [simulate the contract write with `contract.simulate`](https://viem.sh/docs/contract/writeContract.html#usage) before you execute it.
+             * __Warning: The `write` internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to [simulate the contract write with `contract.simulate`](https://viem.sh/docs/contract/writeContract.html#usage) before you execute it.__
+             *
+             * @example
+             * import { createWalletClient, getContract, http, parseAbi } from 'viem'
+             * import { mainnet } from 'viem/chains'
+             *
+             * const client = createWalletClient({
+             *   chain: mainnet,
+             *   transport: http(),
+             * })
+             * const contract = getContract({
+             *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+             *   abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
+             *   publicClient,
+             * })
+             * const hash = await contract.write.min([69420], {
+             *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+             * })
              */
             write: {
               [FunctionName in _WriteFunctionNames]: GetWriteFunction<
@@ -221,7 +324,6 @@ export type GetContractReturnType<
  *
  * - Docs https://viem.sh/docs/contract/getContract.html
  *
- * @remarks
  * Using Contract Instances can make it easier to work with contracts if you don't want to pass the `abi` and `address` properites every time you perform contract actions, e.g. [`readContract`](https://viem.sh/docs/contract/readContract.html), [`writeContract`](https://viem.sh/docs/contract/writeContract.html), [`estimateContractGas`](https://viem.sh/docs/contract/estimateContractGas.html), etc.
  *
  * @example

package/src/actions/public/estimateContractGas.ts

@@ -31,7 +31,6 @@ export type EstimateContractGasReturnType = bigint
  *
  * - Docs: https://viem.sh/docs/contract/estimateContractGas.html
  *
- * @remarks
  * Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`estimateGas` action](https://viem.sh/docs/actions/public/estimateGas) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData).
  *
  * @param client - Client to use

package/src/actions/public/getBalance.ts

@@ -26,7 +26,6 @@ export type GetBalanceReturnType = bigint
  * - Docs: https://viem.sh/docs/actions/public/getBalance.html
  * - JSON-RPC Methods: [`eth_getBalance`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getbalance)
  *
- * @remarks
  * You can convert the balance to ether units with [`formatEther`](https://viem.sh/docs/utilities/formatEther.html).
  *
  * ```ts

package/src/actions/public/getFilterChanges.ts

@@ -36,7 +36,6 @@ export type GetFilterChangesReturnType<
  * - Docs: https://viem.sh/docs/actions/public/getFilterChanges.html
  * - JSON-RPC Methods: [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges)
  *
- * @remarks
  * A Filter can be created from the following actions:
  *
  * - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter)

package/src/actions/public/getFilterLogs.ts

@@ -29,7 +29,6 @@ export type GetFilterLogsReturnType<
  * - Docs: https://viem.sh/docs/actions/public/getFilterLogs.html
  * - JSON-RPC Methods: [`eth_getFilterLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterlogs)
  *
- * @remarks
  * `getFilterLogs` is only compatible with **event filters**.
  *
  * @param client - Client to use

package/src/actions/public/getLogs.ts

@@ -1,4 +1,4 @@
-import type { AbiEvent } from 'abitype'
+import type { AbiEvent, Narrow } from 'abitype'
 import type { PublicClient, Transport } from '../../clients/index.js'
 import type {
   Address,
@@ -28,7 +28,7 @@ export type GetLogsParameters<
   address?: Address | Address[]
 } & (
   | {
-      event: TAbiEvent
+      event: Narrow<TAbiEvent>
       args?: MaybeExtractEventArgsFromAbi<[TAbiEvent], TEventName>
     }
   | {
@@ -97,7 +97,7 @@ export async function getLogs<
   if (event)
     topics = encodeEventTopics({
       abi: [event],
-      eventName: event.name,
+      eventName: (event as AbiEvent).name,
       args,
     } as EncodeEventTopicsParameters)
 

package/src/actions/public/readContract.ts

@@ -36,7 +36,6 @@ export type ReadContractReturnType<
  * - Docs: https://viem.sh/docs/contract/readContract.html
  * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/reading-contracts
  *
- * @remarks
  * A "read-only" function (constant function) on a Solidity contract is denoted by a `view` or `pure` keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.
  *
  * Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData).
@@ -46,7 +45,7 @@ export type ReadContractReturnType<
  * @returns The response from the contract. Type is inferred. {@link ReadContractReturnType}
  *
  * @example
- * import { createPublicClient, http } from 'viem'
+ * import { createPublicClient, http, parseAbi } from 'viem'
  * import { mainnet } from 'viem/chains'
  * import { readContract } from 'viem/contract'
  *
@@ -54,7 +53,7 @@ export type ReadContractReturnType<
  *   chain: mainnet,
  *   transport: http(),
  * })
- * const results = await readContract(client, {
+ * const result = await readContract(client, {
  *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  *   abi: parseAbi(['function balanceOf(address) view returns (uint256)']),
  *   functionName: 'balanceOf',

package/src/actions/public/simulateContract.ts

@@ -63,7 +63,6 @@ export type SimulateContractReturnType<
  * - Docs: https://viem.sh/docs/contract/simulateContract.html
  * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/writing-to-contracts
  *
- * @remarks
  * This function does not require gas to execute and _**does not**_ change the state of the blockchain. It is almost identical to [`readContract`](https://viem.sh/docs/contract/readContract), but also supports contract write functions.
  *
  * Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData).
@@ -81,7 +80,7 @@ export type SimulateContractReturnType<
  *   chain: mainnet,
  *   transport: http(),
  * })
- * const results = await simulateContract(client, {
+ * const result = await simulateContract(client, {
  *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  *   abi: parseAbi(['function mint(uint32) view returns (uint32)']),
  *   functionName: 'mint',

package/src/actions/public/uninstallFilter.ts

@@ -12,7 +12,6 @@ export type UninstallFilterReturnType = boolean
  * - Docs: https://viem.sh/docs/actions/public/uninstallFilter.html
  * - JSON-RPC Methods: [`eth_uninstallFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_uninstallFilter)
  *
- * @remarks
  * Destroys a Filter that was created from one of the following Actions:
  * - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter)
  * - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter)

package/src/actions/public/waitForTransactionReceipt.ts

@@ -60,7 +60,6 @@ export type WaitForTransactionReceiptParameters<
  *     - Checks if one of the Transactions is a replacement
  *     - If so, calls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt).
  *
- * @remarks
  * The `waitForTransactionReceipt` action additionally supports Replacement detection (e.g. sped up Transactions).
  *
  * Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel). Transactions are replaced when they are sent from the same nonce.

package/src/actions/public/watchContractEvent.ts

@@ -59,7 +59,6 @@ export type WatchContractEventReturnType = () => void
  *
  * - Docs: https://viem.sh/docs/contract/watchContractEvent.html
  *
- * @remarks
  * This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent.html#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/contract/watchContractEvent.html#onLogs).
  *
  * `watchContractEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchContractEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead.

package/src/actions/public/watchEvent.ts

@@ -67,7 +67,6 @@ export type WatchEventReturnType = () => void
  *   - **RPC Provider does not support `eth_newFilter`:**
  *     - Calls [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) for each block between the polling interval.
  *
- * @remarks
  * This Action will batch up all the Event Logs found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchEvent.html#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/actions/public/watchEvent.html#onLogs).
  *
  * `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/actions/public/createEventFilter.html) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead.

package/src/actions/public/watchPendingTransactions.ts

@@ -68,7 +68,6 @@ export type WatchPendingTransactionsReturnType = () => void
  *     - Calls [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getFilterChanges) on a polling interval.
  *   - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newPendingTransactions"` event.
  *
- * @remarks
  * This Action will batch up all the pending transactions found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchPendingTransactions.html#pollinginterval-optional), and invoke them via [`onTransactions`](https://viem.sh/docs/actions/public/watchPendingTransactions.html#ontransactions).
  *
  * @param client - Client to use

package/src/actions/test/dropTransaction.ts

@@ -10,6 +10,28 @@ export type DropTransactionParameters = {
   hash: Hash
 }
 
+/**
+ * Removes a transaction from the mempool.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/dropTransaction.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link DropTransactionParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { dropTransaction } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await dropTransaction(client, {
+ *   hash: '0xe58dceb6b20b03965bb678e27d141e151d7d4efc2334c2d6a49b9fac523f7364'
+ * })
+ */
 export async function dropTransaction<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
   { hash }: DropTransactionParameters,

package/src/actions/test/getAutomine.ts

@@ -7,6 +7,26 @@ import type { Chain } from '../../types/index.js'
 
 export type GetAutomineReturnType = boolean
 
+/**
+ * Returns the automatic mining status of the node.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/getAutomine.html
+ *
+ * @param client - Client to use
+ * @returns Whether or not the node is auto mining. {@link GetAutomineReturnType}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { getAutomine } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * const isAutomining = await getAutomine(client)
+ */
 export async function getAutomine<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
 ): Promise<GetAutomineReturnType> {

package/src/actions/test/getTxpoolContent.ts

@@ -7,10 +7,32 @@ import type {
 import type { Chain, RpcTransaction } from '../../types/index.js'
 
 export type GetTxpoolContentReturnType = {
+  /** Pending transactions in the pool */
   pending: Record<Address, Record<string, RpcTransaction>>
+  /** Queued transactions in the pool */
   queued: Record<Address, Record<string, RpcTransaction>>
 }
 
+/**
+ * Returns the details of all transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/getTxpoolContent.html
+ *
+ * @param client - Client to use
+ * @returns Transaction pool content. {@link GetTxpoolContentReturnType}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { getTxpoolContent } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * const content = await getTxpoolContent(client)
+ */
 export async function getTxpoolContent<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
 ): Promise<GetTxpoolContentReturnType> {

package/src/actions/test/getTxpoolStatus.ts

@@ -11,6 +11,26 @@ export type GetTxpoolStatusReturnType = {
   queued: number
 }
 
+/**
+ * Returns a summary of all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/getTxpoolStatus.html
+ *
+ * @param client - Client to use
+ * @returns Transaction pool status. {@link GetTxpoolStatusReturnType}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { getTxpoolStatus } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * const status = await getTxpoolStatus(client)
+ */
 export async function getTxpoolStatus<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
 ): Promise<GetTxpoolStatusReturnType> {

package/src/actions/test/impersonateAccount.ts

@@ -10,6 +10,28 @@ export type ImpersonateAccountParameters = {
   address: Address
 }
 
+/**
+ * Impersonate an account or contract address. This lets you send transactions from that account even if you don't have access to its private key.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/impersonateAccount.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link ImpersonateAccountParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { impersonateAccount } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * const content = await impersonateAccount(client, {
+ *   address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ * })
+ */
 export async function impersonateAccount<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
   { address }: ImpersonateAccountParameters,

package/src/actions/test/increaseTime.ts

@@ -11,6 +11,28 @@ export type IncreaseTimeParameters = {
   seconds: number
 }
 
+/**
+ * Jump forward in time by the given amount of time, in seconds.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/increaseTime.html
+ *
+ * @param client - Client to use
+ * @param parameters – {@link IncreaseTimeParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { increaseTime } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await increaseTime(client, {
+ *   seconds: 420,
+ * })
+ */
 export async function increaseTime<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
   { seconds }: IncreaseTimeParameters,

package/src/actions/test/inspectTxpool.ts

@@ -10,6 +10,26 @@ export type InspectTxpoolReturnType = {
   queued: Record<Address, Record<string, string>>
 }
 
+/**
+ * Returns a summary of all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/inspectTxpool.html
+ *
+ * @param client - Client to use
+ * @returns Transaction pool inspection data. {@link InspectTxpoolReturnType}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { inspectTxpool } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * const data = await inspectTxpool(client)
+ */
 export async function inspectTxpool<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
 ): Promise<InspectTxpoolReturnType> {

package/src/actions/test/mine.ts

@@ -13,6 +13,26 @@ export type MineParameters = {
   interval?: number
 }
 
+/**
+ * Mine a specified number of blocks.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/mine.html
+ *
+ * @param client - Client to use
+ * @param parameters – {@link MineParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { mine } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await mine(client, { blocks: 1 })
+ */
 export async function mine<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
   { blocks, interval }: MineParameters,

package/src/actions/test/removeBlockTimestampInterval.ts

@@ -5,6 +5,25 @@ import type {
   Transport,
 } from '../../clients/index.js'
 
+/**
+ * Removes [`setBlockTimestampInterval`](https://viem.sh/docs/actions/test/setBlockTimestampInterval.html) if it exists.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/removeBlockTimestampInterval.html
+ *
+ * @param client - Client to use
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { removeBlockTimestampInterval } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await removeBlockTimestampInterval(client)
+ */
 export async function removeBlockTimestampInterval<
   TChain extends Chain | undefined,
 >(client: TestClient<TestClientMode, Transport, TChain>) {

package/src/actions/test/reset.ts

@@ -12,6 +12,26 @@ export type ResetParameters = {
   jsonRpcUrl?: string
 }
 
+/**
+ * Resets fork back to its original state.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/reset.html
+ *
+ * @param client - Client to use
+ * @param parameters – {@link ResetParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { reset } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await reset(client, { blockNumber: 69420n })
+ */
 export async function reset<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
   { blockNumber, jsonRpcUrl }: ResetParameters = {},