viem 0.0.1-alpha.14 → 0.0.1-alpha.16

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

@@ -0,0 +1,217 @@
+import { assertType, describe, expect, it, test } from 'vitest'
+
+import { accounts, publicClient, testClient, walletClient } from '../../_test'
+import { celo, defineTransactionReceipt, localhost } from '../../chains'
+import { createPublicClient, http } from '../../clients'
+import type { 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,
+      rpcUrls: localhost.rpcUrls,
+      formatters: {
+        transactionReceipt: defineTransactionReceipt({
+          exclude: ['effectiveGasPrice'],
+          format: () => ({
+            foo: 'bar' as const,
+          }),
+        }),
+      },
+    },
+    transport: http(),
+  })
+  const receipt = await getTransactionReceipt(client, {
+    hash: '0xa4b1f606b66105fa45cb5db23d2f6597075701e7f0e2367f4e6a39d17a8cf98b',
+  })
+
+  assertType<
+    Omit<TransactionReceipt, 'effectiveGasPrice'> & {
+      foo: 'bar'
+    }
+  >(receipt)
+
+  expect(receipt).toMatchInlineSnapshot(`
+    {
+      "blockHash": "0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d",
+      "blockNumber": 15131999n,
+      "contractAddress": null,
+      "cumulativeGasUsed": 5814407n,
+      "foo": "bar",
+      "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",
+    }
+  `)
+})
+
+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,35 @@
+import type { Chain } from '../../chains'
+import type { PublicClient } from '../../clients'
+import { TransactionReceiptNotFoundError } from '../../errors'
+import type { 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,36 @@
+import { expect, test } from 'vitest'
+
+import * as actions from './index'
+
+test('exports actions', () => {
+  expect(actions).toMatchInlineSnapshot(`
+    {
+      "call": [Function],
+      "callContract": [Function],
+      "createBlockFilter": [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],
+      "getTransaction": [Function],
+      "getTransactionConfirmations": [Function],
+      "getTransactionCount": [Function],
+      "getTransactionReceipt": [Function],
+      "uninstallFilter": [Function],
+      "waitForTransactionReceipt": [Function],
+      "watchBlockNumber": [Function],
+      "watchBlocks": [Function],
+      "watchPendingTransactions": [Function],
+    }
+  `)
+})

package/src/actions/public/index.ts

@@ -0,0 +1,120 @@
+export { call } from './call'
+export type { CallArgs, CallResponse, FormattedCall } from './call'
+
+export { callContract } from './callContract'
+export type {
+  CallContractArgs,
+  CallContractResponse,
+  FormattedCallContract,
+} from './callContract'
+
+export { createPendingTransactionFilter } from './createPendingTransactionFilter'
+export type { CreatePendingTransactionFilterResponse } from './createPendingTransactionFilter'
+
+export { createBlockFilter } from './createBlockFilter'
+export type { CreateBlockFilterResponse } from './createBlockFilter'
+
+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 { 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 { 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 { watchPendingTransactions } from './watchPendingTransactions'
+export type {
+  OnTransactions,
+  OnTransactionsResponse,
+  WatchPendingTransactionsArgs,
+} from './watchPendingTransactions'

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

@@ -0,0 +1,13 @@
+import { bench, describe } from 'vitest'
+
+import { publicClient } from '../../_test'
+import { createPendingTransactionFilter } from './createPendingTransactionFilter'
+import { uninstallFilter } from './uninstallFilter'
+
+const filter = await createPendingTransactionFilter(publicClient)
+
+describe('Get Filter Changes', () => {
+  bench('viem: `uninstallFilter`', async () => {
+    await uninstallFilter(publicClient, { filter })
+  })
+})

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

@@ -0,0 +1,65 @@
+import { assertType, expect, test } from 'vitest'
+
+import { accounts, publicClient, testClient, walletClient } from '../../_test'
+
+import { createPendingTransactionFilter } from './createPendingTransactionFilter'
+import { getFilterChanges } from './getFilterChanges'
+import { uninstallFilter } from './uninstallFilter'
+import { mine } from '../test'
+import { sendTransaction } from '../wallet'
+import { parseEther } from '../../utils'
+import type { Hash } from '../../types'
+
+test('default', async () => {
+  const filter = await createPendingTransactionFilter(publicClient)
+  expect(await uninstallFilter(publicClient, { filter })).toBeTruthy()
+})
+
+test('pending txns', async () => {
+  const filter = await createPendingTransactionFilter(publicClient)
+
+  await sendTransaction(walletClient, {
+    from: accounts[0].address,
+    to: accounts[1].address,
+    value: parseEther('1'),
+  })
+  await sendTransaction(walletClient, {
+    from: accounts[0].address,
+    to: accounts[1].address,
+    value: parseEther('1'),
+  })
+
+  let hashes = await getFilterChanges(publicClient, { filter })
+  assertType<Hash[]>(hashes)
+  expect(hashes.length).toBe(2)
+
+  mine(testClient, { blocks: 1 })
+
+  hashes = await getFilterChanges(publicClient, { filter })
+  expect(hashes.length).toBe(0)
+
+  expect(await uninstallFilter(publicClient, { filter })).toBeTruthy()
+
+  await sendTransaction(walletClient, {
+    from: accounts[0].address,
+    to: accounts[1].address,
+    value: parseEther('1'),
+  })
+
+  hashes = await getFilterChanges(publicClient, { filter })
+  expect(hashes.length).toBe(0)
+})
+
+test('filter does not exist', async () => {
+  expect(
+    await uninstallFilter(publicClient, {
+      filter: { id: '0x1', type: 'default' },
+    }),
+  ).toBeFalsy()
+})
+
+test('filter already uninstalled', async () => {
+  const filter = await createPendingTransactionFilter(publicClient)
+  expect(await uninstallFilter(publicClient, { filter })).toBeTruthy()
+  expect(await uninstallFilter(publicClient, { filter })).toBeFalsy()
+})

package/src/actions/public/uninstallFilter.ts

@@ -0,0 +1,17 @@
+import type { PublicClient } from '../../clients'
+import type { Filter } from '../../types'
+
+export type UninstallFilterArgs = {
+  filter: Filter<any>
+}
+export type UninstallFilterResponse = boolean
+
+export async function uninstallFilter(
+  client: PublicClient,
+  { filter }: UninstallFilterArgs,
+): Promise<UninstallFilterResponse> {
+  return client.request({
+    method: 'eth_uninstallFilter',
+    params: [filter.id],
+  })
+}