viem 0.0.1-alpha.2 → 0.0.1-alpha.20

package/src/actions/public/getTransactionReceipt.test.ts

@@ -0,0 +1,179 @@
+import { assertType, describe, expect, it, test } from 'vitest'
+
+import { accounts, publicClient, testClient, walletClient } from '../../_test'
+import { celo } from '../../chains'
+import { createPublicClient, http } from '../../clients'
+import type { Address, TransactionReceipt } from '../../types'
+import { parseEther, parseGwei } from '../../utils'
+import { wait } from '../../utils/wait'
+import { mine } from '../test'
+import { getBlock, sendTransaction } from '..'
+
+import { getTransaction } from './getTransaction'
+import { getTransactionReceipt } from './getTransactionReceipt'
+
+test('gets transaction receipt', async () => {
+  const receipt = await getTransactionReceipt(publicClient, {
+    hash: '0xa4b1f606b66105fa45cb5db23d2f6597075701e7f0e2367f4e6a39d17a8cf98b',
+  })
+  assertType<TransactionReceipt>(receipt)
+  expect(receipt).toMatchInlineSnapshot(`
+    {
+      "blockHash": "0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d",
+      "blockNumber": 15131999n,
+      "contractAddress": null,
+      "cumulativeGasUsed": 5814407n,
+      "effectiveGasPrice": 11789405161n,
+      "from": "0xa152f8bb749c55e9943a3a0a3111d18ee2b3f94e",
+      "gasUsed": 37976n,
+      "logs": [
+        {
+          "address": "0x15d4c048f83bd7e37d49ea4c83a07267ec4203da",
+          "blockHash": "0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d",
+          "blockNumber": 15131999n,
+          "data": "0x0000000000000000000000000000000000000000000000000000002b3b6fb3d0",
+          "logIndex": 108n,
+          "removed": false,
+          "topics": [
+            "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
+            "0x000000000000000000000000a00f99bc38b1ecda1fd70eaa1cd31d576a9f46b0",
+            "0x000000000000000000000000f16e9b0d03470827a95cdfd0cb8a8a3b46969b91",
+          ],
+          "transactionHash": "0xa4b1f606b66105fa45cb5db23d2f6597075701e7f0e2367f4e6a39d17a8cf98b",
+          "transactionIndex": 69n,
+        },
+        {
+          "address": "0x15d4c048f83bd7e37d49ea4c83a07267ec4203da",
+          "blockHash": "0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d",
+          "blockNumber": 15131999n,
+          "data": "0xffffffffffffffffffffffffffffffffffffffffffffffffffffffd4c4904c2f",
+          "logIndex": 109n,
+          "removed": false,
+          "topics": [
+            "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
+            "0x000000000000000000000000a00f99bc38b1ecda1fd70eaa1cd31d576a9f46b0",
+            "0x000000000000000000000000a152f8bb749c55e9943a3a0a3111d18ee2b3f94e",
+          ],
+          "transactionHash": "0xa4b1f606b66105fa45cb5db23d2f6597075701e7f0e2367f4e6a39d17a8cf98b",
+          "transactionIndex": 69n,
+        },
+      ],
+      "logsBloom": "0x08000000000000000000000000000000000000000000000000001000002000000000000000000000000000000000000000000000080000000000000000200000000000000000000000000008400000000000000000000000000000000000100000000000000000000040000008000000000004000000000000000010000000000000000000000000000000000000000000000000000000000000000000000004020000000000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000002090000000000000000000000000000000000000000000000000000000000000",
+      "status": "success",
+      "to": "0x15d4c048f83bd7e37d49ea4c83a07267ec4203da",
+      "transactionHash": "0xa4b1f606b66105fa45cb5db23d2f6597075701e7f0e2367f4e6a39d17a8cf98b",
+      "transactionIndex": 69,
+      "type": "eip1559",
+    }
+  `)
+})
+
+test('chain w/ custom block type', async () => {
+  const client = createPublicClient({
+    chain: celo,
+    transport: http(),
+  })
+  const receipt = await getTransactionReceipt(client, {
+    hash: '0xe47fce1dffbe8e94e8f7c23b0af18160fbc19a1e80e9cb107cafe0856dd4a3f7',
+  })
+
+  assertType<
+    TransactionReceipt & {
+      feeCurrency: Address | null
+      gatewayFee: bigint | null
+      gatewayFeeRecipient: Address | null
+    }
+  >(receipt)
+  expect(receipt).toMatchInlineSnapshot(`
+    {
+      "blockHash": "0xfc279eb47ec9edbd7cb5c6affa4b3367daff930085d532d3cc4a1e004da46bd9",
+      "blockNumber": 17582734n,
+      "contractAddress": null,
+      "cumulativeGasUsed": 1765686n,
+      "effectiveGasPrice": 5000000001n,
+      "feeCurrency": undefined,
+      "from": "0x0372cffb61f23703efae601b1962efee825204bc",
+      "gasUsed": 245109n,
+      "gatewayFee": null,
+      "gatewayFeeRecipient": undefined,
+      "logs": [],
+      "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
+      "status": "reverted",
+      "to": "0x865340af8e50eaf0acec9ebc789b2b425c7e0193",
+      "transactionHash": "0xe47fce1dffbe8e94e8f7c23b0af18160fbc19a1e80e9cb107cafe0856dd4a3f7",
+      "transactionIndex": 4,
+      "type": "legacy",
+    }
+  `)
+})
+
+describe('e2e', () => {
+  const sourceAccount = accounts[0]
+  const targetAccount = accounts[1]
+
+  it('gets transaction receipt', async () => {
+    const block = await getBlock(publicClient)
+
+    const maxFeePerGas = block.baseFeePerGas! + parseGwei('10')
+    const maxPriorityFeePerGas = parseGwei('10')
+
+    const hash = await sendTransaction(walletClient, {
+      from: sourceAccount.address,
+      to: targetAccount.address,
+      value: parseEther('1'),
+      maxFeePerGas,
+      maxPriorityFeePerGas,
+    })
+
+    expect(await getTransaction(publicClient, { hash })).toBeDefined()
+    await expect(() =>
+      getTransactionReceipt(publicClient, {
+        hash,
+      }),
+    ).rejects.toThrowError('Transaction receipt with hash')
+
+    mine(testClient, { blocks: 1 })
+    await wait(0)
+
+    const {
+      blockHash,
+      blockNumber,
+      effectiveGasPrice,
+      transactionHash,
+      ...receipt
+    } = await getTransactionReceipt(publicClient, {
+      hash,
+    })
+
+    expect(blockHash).toBeDefined()
+    expect(blockNumber).toBeDefined()
+    expect(effectiveGasPrice).toBeDefined()
+    expect(transactionHash).toBeDefined()
+    expect(receipt).toMatchInlineSnapshot(`
+      {
+        "contractAddress": null,
+        "cumulativeGasUsed": 21000n,
+        "from": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
+        "gasUsed": 21000n,
+        "logs": [],
+        "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
+        "status": "success",
+        "to": "0x70997970c51812dc3a010c7d01b50e0d17dc79c8",
+        "transactionIndex": 0,
+        "type": null,
+      }
+    `)
+  })
+})
+
+test('throws if transaction not found', async () => {
+  await expect(
+    getTransactionReceipt(publicClient, {
+      hash: '0xa4b1f606b66105fa45cb5db23d2f6597075701e7f0e2367f4e6a39d17a8cf98a',
+    }),
+  ).rejects.toThrowErrorMatchingInlineSnapshot(`
+    "Transaction receipt with hash \\"0xa4b1f606b66105fa45cb5db23d2f6597075701e7f0e2367f4e6a39d17a8cf98a\\" could not be found. The Transaction may not be processed on a block yet.
+
+    Version: viem@1.0.2"
+  `)
+})

package/src/actions/public/getTransactionReceipt.ts

@@ -0,0 +1,34 @@
+import type { PublicClient } from '../../clients'
+import { TransactionReceiptNotFoundError } from '../../errors'
+import type { Chain, Hash } from '../../types'
+import { format } from '../../utils'
+import type {
+  FormattedTransactionReceipt,
+  TransactionReceiptFormatter,
+} from '../../utils/formatters/transactionReceipt'
+import { formatTransactionReceipt } from '../../utils/formatters/transactionReceipt'
+
+export type GetTransactionReceiptArgs = {
+  /** The hash of the transaction. */
+  hash: Hash
+}
+
+export type GetTransactionReceiptResponse<TChain extends Chain = Chain> =
+  FormattedTransactionReceipt<TransactionReceiptFormatter<TChain>>
+
+export async function getTransactionReceipt<TChain extends Chain>(
+  client: PublicClient<any, TChain>,
+  { hash }: GetTransactionReceiptArgs,
+) {
+  const receipt = await client.request({
+    method: 'eth_getTransactionReceipt',
+    params: [hash],
+  })
+
+  if (!receipt) throw new TransactionReceiptNotFoundError({ hash })
+
+  return format(receipt, {
+    formatter:
+      client.chain?.formatters?.transactionReceipt || formatTransactionReceipt,
+  }) as GetTransactionReceiptResponse<TChain>
+}

package/src/actions/public/index.test.ts

@@ -0,0 +1,43 @@
+import { expect, test } from 'vitest'
+
+import * as actions from './index'
+
+test('exports actions', () => {
+  expect(actions).toMatchInlineSnapshot(`
+    {
+      "call": [Function],
+      "createBlockFilter": [Function],
+      "createContractEventFilter": [Function],
+      "createEventFilter": [Function],
+      "createPendingTransactionFilter": [Function],
+      "deployContract": [Function],
+      "estimateGas": [Function],
+      "getBalance": [Function],
+      "getBlock": [Function],
+      "getBlockNumber": [Function],
+      "getBlockNumberCache": [Function],
+      "getBlockTransactionCount": [Function],
+      "getBytecode": [Function],
+      "getChainId": [Function],
+      "getFeeHistory": [Function],
+      "getFilterChanges": [Function],
+      "getFilterLogs": [Function],
+      "getGasPrice": [Function],
+      "getLogs": [Function],
+      "getStorageAt": [Function],
+      "getTransaction": [Function],
+      "getTransactionConfirmations": [Function],
+      "getTransactionCount": [Function],
+      "getTransactionReceipt": [Function],
+      "readContract": [Function],
+      "simulateContract": [Function],
+      "uninstallFilter": [Function],
+      "waitForTransactionReceipt": [Function],
+      "watchBlockNumber": [Function],
+      "watchBlocks": [Function],
+      "watchContractEvent": [Function],
+      "watchEvent": [Function],
+      "watchPendingTransactions": [Function],
+    }
+  `)
+})

package/src/actions/public/index.ts

@@ -0,0 +1,149 @@
+export { call } from './call'
+export type { CallArgs, CallResponse, FormattedCall } from './call'
+
+export { simulateContract } from './simulateContract'
+export type {
+  SimulateContractArgs,
+  SimulateContractResponse,
+} from './simulateContract'
+
+export { createPendingTransactionFilter } from './createPendingTransactionFilter'
+export type { CreatePendingTransactionFilterResponse } from './createPendingTransactionFilter'
+
+export { createBlockFilter } from './createBlockFilter'
+export type { CreateBlockFilterResponse } from './createBlockFilter'
+
+export { createEventFilter } from './createEventFilter'
+export type {
+  CreateEventFilterArgs,
+  CreateEventFilterResponse,
+} from './createEventFilter'
+
+export { createContractEventFilter } from './createContractEventFilter'
+export type {
+  CreateContractEventFilterArgs,
+  CreateContractEventFilterResponse,
+} from './createContractEventFilter'
+
+export { deployContract } from './deployContract'
+export type {
+  DeployContractArgs,
+  DeployContractResponse,
+} from './deployContract'
+
+export { estimateGas } from './estimateGas'
+export type { EstimateGasArgs, EstimateGasResponse } from './estimateGas'
+
+export { getBalance } from './getBalance'
+export type { GetBalanceArgs, GetBalanceResponse } from './getBalance'
+
+export { getBlock } from './getBlock'
+export type { GetBlockArgs, GetBlockResponse } from './getBlock'
+
+export { getBlockNumber, getBlockNumberCache } from './getBlockNumber'
+export type {
+  GetBlockNumberArgs,
+  GetBlockNumberResponse,
+} from './getBlockNumber'
+
+export { getBlockTransactionCount } from './getBlockTransactionCount'
+export type {
+  GetBlockTransactionCountArgs,
+  GetBlockTransactionCountResponse,
+} from './getBlockTransactionCount'
+
+export { getBytecode } from './getBytecode'
+export type { GetBytecodeArgs, GetBytecodeResponse } from './getBytecode'
+
+export { getChainId } from './getChainId'
+
+export { getFeeHistory } from './getFeeHistory'
+export type { GetFeeHistoryArgs, GetFeeHistoryResponse } from './getFeeHistory'
+
+export { getFilterChanges } from './getFilterChanges'
+export type {
+  GetFilterChangesArgs,
+  GetFilterChangesResponse,
+} from './getFilterChanges'
+
+export { getFilterLogs } from './getFilterLogs'
+export type {
+  GetFilterLogsArgs,
+  GetFilterLogsResponse,
+} from './getFilterLogs'
+
+export { getGasPrice } from './getGasPrice'
+export type { GetGasPriceResponse } from './getGasPrice'
+
+export { getLogs } from './getLogs'
+export type { GetLogsArgs, GetLogsResponse } from './getLogs'
+
+export { getStorageAt } from './getStorageAt'
+export type { GetStorageAtArgs, GetStorageAtResponse } from './getStorageAt'
+
+export { getTransaction } from './getTransaction'
+export type {
+  GetTransactionArgs,
+  GetTransactionResponse,
+} from './getTransaction'
+
+export { getTransactionConfirmations } from './getTransactionConfirmations'
+export type {
+  GetTransactionConfirmationsArgs,
+  GetTransactionConfirmationsResponse,
+} from './getTransactionConfirmations'
+
+export { getTransactionCount } from './getTransactionCount'
+export type {
+  GetTransactionCountArgs,
+  GetTransactionCountResponse,
+} from './getTransactionCount'
+
+export { getTransactionReceipt } from './getTransactionReceipt'
+export type {
+  GetTransactionReceiptArgs,
+  GetTransactionReceiptResponse,
+} from './getTransactionReceipt'
+
+export { readContract } from './readContract'
+export type {
+  ReadContractArgs,
+  ReadContractResponse,
+} from './readContract'
+
+export { uninstallFilter } from './uninstallFilter'
+export type {
+  UninstallFilterArgs,
+  UninstallFilterResponse,
+} from './uninstallFilter'
+
+export { waitForTransactionReceipt } from './waitForTransactionReceipt'
+export type {
+  WaitForTransactionReceiptArgs,
+  WaitForTransactionReceiptResponse,
+  ReplacementReason,
+  ReplacementResponse,
+} from './waitForTransactionReceipt'
+
+export { watchBlockNumber } from './watchBlockNumber'
+export type {
+  WatchBlockNumberArgs,
+  OnBlockNumber,
+  OnBlockNumberResponse,
+} from './watchBlockNumber'
+
+export { watchBlocks } from './watchBlocks'
+export type { WatchBlocksArgs, OnBlock, OnBlockResponse } from './watchBlocks'
+
+export { watchContractEvent } from './watchContractEvent'
+export type { WatchContractEventArgs } from './watchContractEvent'
+
+export { watchEvent } from './watchEvent'
+export type { WatchEventArgs, OnLogs, OnLogsResponse } from './watchEvent'
+
+export { watchPendingTransactions } from './watchPendingTransactions'
+export type {
+  OnTransactions,
+  OnTransactionsResponse,
+  WatchPendingTransactionsArgs,
+} from './watchPendingTransactions'

package/src/actions/public/readContract.test.ts

@@ -0,0 +1,128 @@
+/**
+ * TODO:  Heaps more test cases :D
+ *        - Complex calldata types
+ *        - Complex return types (tuple/structs)
+ *        - Calls against blocks
+ */
+
+import { describe, expect, test } from 'vitest'
+import {
+  accounts,
+  publicClient,
+  testClient,
+  wagmiContractConfig,
+  walletClient,
+} from '../../_test'
+import { baycContractConfig } from '../../_test/abis'
+import { encodeFunctionData } from '../../utils'
+import { mine } from '../test'
+import { sendTransaction } from '../wallet'
+
+import { deployContract } from './deployContract'
+import { getTransactionReceipt } from './getTransactionReceipt'
+import { readContract } from './readContract'
+
+describe('wagmi', () => {
+  test('default', async () => {
+    expect(
+      await readContract(publicClient, {
+        ...wagmiContractConfig,
+        functionName: 'balanceOf',
+        args: ['0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC'],
+      }),
+    ).toEqual(3n)
+    expect(
+      await readContract(publicClient, {
+        ...wagmiContractConfig,
+        functionName: 'getApproved',
+        args: [420n],
+      }),
+    ).toEqual('0x0000000000000000000000000000000000000000')
+    expect(
+      await readContract(publicClient, {
+        ...wagmiContractConfig,
+        functionName: 'isApprovedForAll',
+        args: [
+          '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
+          '0x0000000000000000000000000000000000000000',
+        ],
+      }),
+    ).toEqual(false)
+    expect(
+      await readContract(publicClient, {
+        ...wagmiContractConfig,
+        functionName: 'name',
+      }),
+    ).toEqual('wagmi')
+    expect(
+      await readContract(publicClient, {
+        ...wagmiContractConfig,
+        functionName: 'ownerOf',
+        args: [420n],
+      }),
+    ).toEqual('0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC')
+    expect(
+      await readContract(publicClient, {
+        ...wagmiContractConfig,
+        functionName: 'supportsInterface',
+        args: ['0x1a452251'],
+      }),
+    ).toEqual(false)
+    expect(
+      await readContract(publicClient, {
+        ...wagmiContractConfig,
+        functionName: 'symbol',
+      }),
+    ).toEqual('WAGMI')
+    expect(
+      await readContract(publicClient, {
+        ...wagmiContractConfig,
+        functionName: 'tokenURI',
+        args: [420n],
+      }),
+    ).toMatchInlineSnapshot(
+      '"data:application/json;base64,eyJuYW1lIjogIndhZ21pICM0MjAiLCAiaW1hZ2UiOiAiZGF0YTppbWFnZS9zdmcreG1sO2Jhc2U2NCxQSE4yWnlCNGJXeHVjejBpYUhSMGNEb3ZMM2QzZHk1M015NXZjbWN2TWpBd01DOXpkbWNpSUhkcFpIUm9QU0l4TURJMElpQm9aV2xuYUhROUlqRXdNalFpSUdacGJHdzlJbTV2Ym1VaVBqeHdZWFJvSUdacGJHdzlJbWh6YkNneE1UY3NJREV3TUNVc0lERXdKU2tpSUdROUlrMHdJREJvTVRBeU5IWXhNREkwU0RCNklpQXZQanhuSUdacGJHdzlJbWh6YkNneU9EZ3NJREV3TUNVc0lEa3dKU2tpUGp4d1lYUm9JR1E5SWswNU1ETWdORE0zTGpWak1DQTVMakV4TXkwM0xqTTRPQ0F4Tmk0MUxURTJMalVnTVRZdU5YTXRNVFl1TlMwM0xqTTROeTB4Tmk0MUxURTJMalVnTnk0ek9EZ3RNVFl1TlNBeE5pNDFMVEUyTGpVZ01UWXVOU0EzTGpNNE55QXhOaTQxSURFMkxqVjZUVFk1T0M0MU1qa2dOVFkyWXpZdU9USXhJREFnTVRJdU5UTXROUzQxT1RZZ01USXVOVE10TVRJdU5YWXROVEJqTUMwMkxqa3dOQ0ExTGpZd09TMHhNaTQxSURFeUxqVXlPUzB4TWk0MWFESTFMakExT1dNMkxqa3lJREFnTVRJdU5USTVJRFV1TlRrMklERXlMalV5T1NBeE1pNDFkalV3WXpBZ05pNDVNRFFnTlM0Mk1Ea2dNVEl1TlNBeE1pNDFNeUF4TWk0MWN6RXlMalV5T1MwMUxqVTVOaUF4TWk0MU1qa3RNVEl1TlhZdE5UQmpNQzAyTGprd05DQTFMall3T1MweE1pNDFJREV5TGpVekxURXlMalZvTWpVdU1EVTVZell1T1RJZ01DQXhNaTQxTWprZ05TNDFPVFlnTVRJdU5USTVJREV5TGpWMk5UQmpNQ0EyTGprd05DQTFMall3T1NBeE1pNDFJREV5TGpVeU9TQXhNaTQxYURNM0xqVTRPV00yTGpreUlEQWdNVEl1TlRJNUxUVXVOVGsySURFeUxqVXlPUzB4TWk0MWRpMDNOV013TFRZdU9UQTBMVFV1TmpBNUxURXlMalV0TVRJdU5USTVMVEV5TGpWekxURXlMalV6SURVdU5UazJMVEV5TGpVeklERXlMalYyTlRZdU1qVmhOaTR5TmpRZ05pNHlOalFnTUNBeElERXRNVEl1TlRJNUlEQldORGM0TGpWak1DMDJMamt3TkMwMUxqWXdPUzB4TWk0MUxURXlMalV6TFRFeUxqVklOams0TGpVeU9XTXROaTQ1TWlBd0xURXlMalV5T1NBMUxqVTVOaTB4TWk0MU1qa2dNVEl1TlhZM05XTXdJRFl1T1RBMElEVXVOakE1SURFeUxqVWdNVEl1TlRJNUlERXlMalY2SWlBdlBqeHdZWFJvSUdROUlrMHhOVGN1TmpVMUlEVTBNV010Tmk0NU16SWdNQzB4TWk0MU5USXROUzQxT1RZdE1USXVOVFV5TFRFeUxqVjJMVFV3WXpBdE5pNDVNRFF0TlM0Mk1Ua3RNVEl1TlMweE1pNDFOVEV0TVRJdU5WTXhNakFnTkRjeExqVTVOaUF4TWpBZ05EYzRMalYyTnpWak1DQTJMamt3TkNBMUxqWXlJREV5TGpVZ01USXVOVFV5SURFeUxqVm9NVFV3TGpZeVl6WXVPVE16SURBZ01USXVOVFV5TFRVdU5UazJJREV5TGpVMU1pMHhNaTQxZGkwMU1HTXdMVFl1T1RBMElEVXVOakU1TFRFeUxqVWdNVEl1TlRVeUxURXlMalZvTVRRMExqTTBOV016TGpRMk5TQXdJRFl1TWpjMklESXVOems0SURZdU1qYzJJRFl1TWpWekxUSXVPREV4SURZdU1qVXROaTR5TnpZZ05pNHlOVWd6TWpBdU9ESTRZeTAyTGprek15QXdMVEV5TGpVMU1pQTFMalU1TmkweE1pNDFOVElnTVRJdU5YWXpOeTQxWXpBZ05pNDVNRFFnTlM0Mk1Ua2dNVEl1TlNBeE1pNDFOVElnTVRJdU5XZ3hOVEF1TmpKak5pNDVNek1nTUNBeE1pNDFOVEl0TlM0MU9UWWdNVEl1TlRVeUxURXlMalYyTFRjMVl6QXROaTQ1TURRdE5TNDJNVGt0TVRJdU5TMHhNaTQxTlRJdE1USXVOVWd5T0RNdU1UY3lZeTAyTGprek1pQXdMVEV5TGpVMU1TQTFMalU1TmkweE1pNDFOVEVnTVRJdU5YWTFNR013SURZdU9UQTBMVFV1TmpFNUlERXlMalV0TVRJdU5UVXlJREV5TGpWb0xUSTFMakV3TTJNdE5pNDVNek1nTUMweE1pNDFOVEl0TlM0MU9UWXRNVEl1TlRVeUxURXlMalYyTFRVd1l6QXROaTQ1TURRdE5TNDJNaTB4TWk0MUxURXlMalUxTWkweE1pNDFjeTB4TWk0MU5USWdOUzQxT1RZdE1USXVOVFV5SURFeUxqVjJOVEJqTUNBMkxqa3dOQzAxTGpZeE9TQXhNaTQxTFRFeUxqVTFNU0F4TWk0MWFDMHlOUzR4TURSNmJUTXdNUzR5TkRJdE5pNHlOV013SURNdU5EVXlMVEl1T0RFeElEWXVNalV0Tmk0eU56WWdOaTR5TlVnek16a3VOalUxWXkwekxqUTJOU0F3TFRZdU1qYzJMVEl1TnprNExUWXVNamMyTFRZdU1qVnpNaTQ0TVRFdE5pNHlOU0EyTGpJM05pMDJMakkxYURFeE1pNDVOalpqTXk0ME5qVWdNQ0EyTGpJM05pQXlMamM1T0NBMkxqSTNOaUEyTGpJMWVrMDBPVGNnTlRVekxqZ3hPR013SURZdU9USTVJRFV1TmpJNElERXlMalUwTmlBeE1pNDFOekVnTVRJdU5UUTJhREV6TW1FMkxqSTRJRFl1TWpnZ01DQXdJREVnTmk0eU9EWWdOaTR5TnpJZ05pNHlPQ0EyTGpJNElEQWdNQ0F4TFRZdU1qZzJJRFl1TWpjemFDMHhNekpqTFRZdU9UUXpJREF0TVRJdU5UY3hJRFV1TmpFMkxURXlMalUzTVNBeE1pNDFORFpCTVRJdU5UWWdNVEl1TlRZZ01DQXdJREFnTlRBNUxqVTNNU0EyTURSb01UVXdMamcxT0dNMkxqazBNeUF3SURFeUxqVTNNUzAxTGpZeE5pQXhNaTQxTnpFdE1USXVOVFExZGkweE1USXVPVEZqTUMwMkxqa3lPQzAxTGpZeU9DMHhNaTQxTkRVdE1USXVOVGN4TFRFeUxqVTBOVWcxTURrdU5UY3hZeTAyTGprME15QXdMVEV5TGpVM01TQTFMall4TnkweE1pNDFOekVnTVRJdU5UUTFkamMxTGpJM00zcHRNemN1TnpFMExUWXlMamN5TjJNdE5pNDVORE1nTUMweE1pNDFOekVnTlM0Mk1UY3RNVEl1TlRjeElERXlMalUwTlhZeU5TNHdPVEZqTUNBMkxqa3lPU0ExTGpZeU9DQXhNaTQxTkRZZ01USXVOVGN4SURFeUxqVTBObWd4TURBdU5UY3lZell1T1RReklEQWdNVEl1TlRjeExUVXVOakUzSURFeUxqVTNNUzB4TWk0MU5EWjJMVEkxTGpBNU1XTXdMVFl1T1RJNExUVXVOakk0TFRFeUxqVTBOUzB4TWk0MU56RXRNVEl1TlRRMVNEVXpOQzQzTVRSNklpQm1hV3hzTFhKMWJHVTlJbVYyWlc1dlpHUWlJQzgrUEM5blBqd3ZjM1puUGc9PSJ9"',
+    )
+    expect(
+      await readContract(publicClient, {
+        ...wagmiContractConfig,
+        functionName: 'totalSupply',
+      }),
+    ).toEqual(558n)
+  })
+})
+
+test('fake contract address', async () => {
+  await expect(() =>
+    readContract(publicClient, {
+      abi: wagmiContractConfig.abi,
+      address: '0x0000000000000000000000000000000000000069',
+      functionName: 'totalSupply',
+    }),
+  ).rejects.toThrowErrorMatchingInlineSnapshot(`
+    "The contract method \\"totalSupply\\" returned no data (\\"0x\\"). This could be due to any of the following:
+    - The contract does not have the function \\"totalSupply\\",
+    - The parameters passed to the contract function may be invalid, or
+    - The address is not a contract.
+     
+    Contract: 0x0000000000000000000000000000000000000000
+    Function: totalSupply()
+            > \\"0x\\"
+
+    Version: viem@1.0.2"
+  `)
+})
+
+// Deploy BAYC Contract
+async function deployBAYC() {
+  const hash = await deployContract(walletClient, {
+    ...baycContractConfig,
+    args: ['Bored Ape Wagmi Club', 'BAYC', 69420n, 0n],
+    from: accounts[0].address,
+  })
+  await mine(testClient, { blocks: 1 })
+  const { contractAddress } = await getTransactionReceipt(publicClient, {
+    hash,
+  })
+  return { contractAddress }
+}

package/src/actions/public/readContract.ts

@@ -0,0 +1,87 @@
+import { Abi } from 'abitype'
+
+import type { PublicClient } from '../../clients'
+import type {
+  Address,
+  ExtractArgsFromAbi,
+  ExtractResultFromAbi,
+  ExtractFunctionNameFromAbi,
+  Formatter,
+} from '../../types'
+import {
+  EncodeFunctionDataArgs,
+  decodeFunctionResult,
+  encodeFunctionData,
+  getContractError,
+} from '../../utils'
+import { call, CallArgs, FormattedCall } from './call'
+
+export type FormattedReadContract<
+  TFormatter extends Formatter | undefined = Formatter,
+> = FormattedCall<TFormatter>
+
+export type ReadContractArgs<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TFunctionName extends string = any,
+> = Omit<
+  CallArgs,
+  | 'accessList'
+  | 'chain'
+  | 'from'
+  | 'gas'
+  | 'gasPrice'
+  | 'maxFeePerGas'
+  | 'maxPriorityFeePerGas'
+  | 'nonce'
+  | 'to'
+  | 'data'
+  | 'value'
+> & {
+  address: Address
+  abi: TAbi
+  functionName: ExtractFunctionNameFromAbi<TAbi, TFunctionName, 'pure' | 'view'>
+} & ExtractArgsFromAbi<TAbi, TFunctionName>
+
+export type ReadContractResponse<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TFunctionName extends string = string,
+> = ExtractResultFromAbi<TAbi, TFunctionName>
+
+export async function readContract<
+  TAbi extends Abi = Abi,
+  TFunctionName extends string = any,
+>(
+  client: PublicClient,
+  {
+    abi,
+    address,
+    args,
+    functionName,
+    ...callRequest
+  }: ReadContractArgs<TAbi, TFunctionName>,
+): Promise<ReadContractResponse<TAbi, TFunctionName>> {
+  const calldata = encodeFunctionData({
+    abi,
+    args,
+    functionName,
+  } as unknown as EncodeFunctionDataArgs<TAbi, TFunctionName>)
+  try {
+    const { data } = await call(client, {
+      data: calldata,
+      to: address,
+      ...callRequest,
+    } as unknown as CallArgs)
+    return decodeFunctionResult({
+      abi,
+      functionName,
+      data: data || '0x',
+    })
+  } catch (err) {
+    throw getContractError(err, {
+      abi,
+      address,
+      args,
+      functionName,
+    })
+  }
+}

package/src/actions/public/simulateContract.bench.ts

@@ -0,0 +1,31 @@
+import { Contract } from 'ethers'
+import { bench, describe } from 'vitest'
+
+import {
+  accounts,
+  ethersProvider,
+  publicClient,
+  wagmiContractConfig,
+} from '../../_test'
+
+import { simulateContract } from './simulateContract'
+
+describe('Simulate Contract', () => {
+  bench('viem: `simulateContract`', async () => {
+    await simulateContract(publicClient, {
+      ...wagmiContractConfig,
+      functionName: 'mint',
+      args: [1n],
+      from: accounts[0].address,
+    })
+  })
+
+  bench('ethers: `callStatic`', async () => {
+    const wagmi = new Contract(
+      wagmiContractConfig.address,
+      wagmiContractConfig.abi,
+      ethersProvider,
+    )
+    await wagmi.callStatic.mint(1)
+  })
+})