viem 0.0.1-alpha.24 → 0.0.1-alpha.26

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

@@ -1,311 +0,0 @@
-import { assertType, describe, expect, test } from 'vitest'
-
-import {
-  accounts,
-  initialBlockNumber,
-  publicClient,
-  testClient,
-  walletClient,
-} from '../../_test'
-import { parseEther } from '../../utils'
-import type { Address, Transaction } from '../../types'
-import { createPublicClient, http } from '../../clients'
-import { celo } from '../../chains'
-import { getBlock, sendTransaction } from '..'
-import { getTransaction } from './getTransaction'
-import { mine, setBalance } from '../test'
-
-const sourceAccount = accounts[0]
-const targetAccount = accounts[1]
-
-test('gets transaction', async () => {
-  const transaction = await getTransaction(publicClient, {
-    blockNumber: 15131999n,
-    index: 69,
-  })
-  assertType<Transaction>(transaction)
-  expect(transaction).toMatchInlineSnapshot(`
-    {
-      "accessList": [],
-      "blockHash": "0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d",
-      "blockNumber": 15131999n,
-      "chainId": "0x1",
-      "from": "0xa152f8bb749c55e9943a3a0a3111d18ee2b3f94e",
-      "gas": 100000n,
-      "gasPrice": 11789405161n,
-      "hash": "0xa4b1f606b66105fa45cb5db23d2f6597075701e7f0e2367f4e6a39d17a8cf98b",
-      "input": "0x23b872dd000000000000000000000000a00f99bc38b1ecda1fd70eaa1cd31d576a9f46b0000000000000000000000000f16e9b0d03470827a95cdfd0cb8a8a3b46969b910000000000000000000000000000000000000000000000000000002b3b6fb3d0",
-      "maxFeePerGas": 30309666435n,
-      "maxPriorityFeePerGas": 1000000000n,
-      "nonce": 513116,
-      "r": "0x5e49a7bd0534c6b6d3bbe581659424d3747f920d40ce56e48d26e5d94aac32ca",
-      "s": "0x1746abe27b7c4f00bda1ec714ac1f7083e9025b6ca3b2248e439a173e4ab55e0",
-      "to": "0x15d4c048f83bd7e37d49ea4c83a07267ec4203da",
-      "transactionIndex": 69,
-      "type": "eip1559",
-      "v": 1n,
-      "value": 0n,
-    }
-  `)
-})
-
-test('gets transaction (legacy)', async () => {
-  const transaction = await getTransaction(publicClient, {
-    blockNumber: 15131999n,
-    index: 0,
-  })
-  expect(transaction).toMatchInlineSnapshot(`
-    {
-      "blockHash": "0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d",
-      "blockNumber": 15131999n,
-      "from": "0x47a6b2f389cf4bb6e4b69411c87ae82371daf87e",
-      "gas": 200000n,
-      "gasPrice": 57000000000n,
-      "hash": "0x31a326e4190db96a0c12ef2f2aee6d4566635deb78a3c3497af208b8b7039f22",
-      "input": "0xa9059cbb00000000000000000000000001cc0c6c6c57707f89ab0c9a0c22139c501ffba50000000000000000000000000000000000000000000000064cf7d4e7b36a8000",
-      "nonce": 3,
-      "r": "0x36b5c1f8f70e845a35784b4e18807af88c36fd4958bc71e7dab3b99293531f73",
-      "s": "0x5e1a25ed16877580921003749f54d0a14981cd989c293c202a382f43d87b2c47",
-      "to": "0x3d382228c54736d831fac2748f4734d9177c7332",
-      "transactionIndex": 0,
-      "type": "legacy",
-      "v": 37n,
-      "value": 0n,
-    }
-  `)
-})
-
-test('gets transaction (eip2930)', async () => {
-  const block = await getBlock(publicClient)
-
-  await setBalance(testClient, {
-    address: targetAccount.address,
-    value: targetAccount.balance,
-  })
-
-  const hash = await sendTransaction(walletClient, {
-    accessList: [{ address: targetAccount.address, storageKeys: [] }],
-    from: sourceAccount.address,
-    to: targetAccount.address,
-    value: parseEther('1'),
-    gasPrice: BigInt(block.baseFeePerGas ?? 0),
-  })
-
-  const transaction = await getTransaction(publicClient, {
-    hash,
-  })
-  expect(Object.keys(transaction)).toMatchInlineSnapshot(`
-    [
-      "hash",
-      "nonce",
-      "blockHash",
-      "blockNumber",
-      "transactionIndex",
-      "from",
-      "to",
-      "value",
-      "gasPrice",
-      "gas",
-      "input",
-      "v",
-      "r",
-      "s",
-      "type",
-      "accessList",
-      "chainId",
-    ]
-  `)
-  expect(transaction.type).toMatchInlineSnapshot('"eip2930"')
-  expect(transaction.from).toMatchInlineSnapshot(
-    '"0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266"',
-  )
-  expect(transaction.gas).toBeDefined()
-  expect(transaction.to).toMatchInlineSnapshot(
-    '"0x70997970c51812dc3a010c7d01b50e0d17dc79c8"',
-  )
-  expect(transaction.value).toMatchInlineSnapshot('1000000000000000000n')
-})
-
-test('chain w/ custom block type', async () => {
-  const client = createPublicClient({
-    chain: celo,
-    transport: http(),
-  })
-
-  const transaction = await getTransaction(client, {
-    blockNumber: 16628100n,
-    index: 0,
-  })
-
-  assertType<
-    Transaction & {
-      feeCurrency: Address | null
-      gatewayFee: bigint | null
-      gatewayFeeRecipient: Address | null
-    }
-  >(transaction)
-  expect(transaction).toMatchInlineSnapshot(`
-    {
-      "blockHash": "0x740371d30b3cee9d687f72e3409ba6447eceda7de86bc38b0fa84493114b510b",
-      "blockNumber": 16628100n,
-      "ethCompatible": false,
-      "feeCurrency": null,
-      "from": "0x045d685d23e8aa34dc408a66fb408f20dc84d785",
-      "gas": 1527520n,
-      "gasPrice": 2999683966n,
-      "gatewayFee": 0n,
-      "gatewayFeeRecipient": null,
-      "hash": "0x55678b68cc086d5b9739bb28748b492db030d001d9eb59001cc2d1f7a3305d17",
-      "input": "0x389ec778",
-      "nonce": 697201,
-      "r": "0xf507fb8fa33ffd05a7f26c980bbb8271aa113affc8f192feba87abe26549bda1",
-      "s": "0x7971c7b15ab4475ce6256da0bdf62ca1d1e491be8a03fe7637289f98c166f521",
-      "to": "0xb86d682b1b6bf20d8d54f55c48f848b9487dec37",
-      "transactionIndex": 0,
-      "type": "legacy",
-      "v": 84475n,
-      "value": 0n,
-    }
-  `)
-})
-
-describe('args: hash', () => {
-  test('gets transaction by hash', async () => {
-    const transaction = await getTransaction(publicClient, {
-      hash: '0x886df53066105ebe390f3efcb4a523d7178597da84dfaa1bbc524e2b20b5650c',
-    })
-    expect(transaction).toMatchInlineSnapshot(`
-      {
-        "accessList": [],
-        "blockHash": "0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d",
-        "blockNumber": 15131999n,
-        "chainId": "0x1",
-        "from": "0x0926218bdafe613a4152628d14a762b6718741b9",
-        "gas": 70000n,
-        "gasPrice": 10939430701n,
-        "hash": "0x886df53066105ebe390f3efcb4a523d7178597da84dfaa1bbc524e2b20b5650c",
-        "input": "0x23b872dd0000000000000000000000000e7aeefe352dc961aaeeb32eb97fecd8a3f014f80000000000000000000000000926218bdafe613a4152628d14a762b6718741b9000000000000000000000000000000000000000000000000000000003fc6e780",
-        "maxFeePerGas": 10939430701n,
-        "maxPriorityFeePerGas": 10939430701n,
-        "nonce": 4,
-        "r": "0xe7dc7a0b7db15dba318fea7ad3dcbbc2170e5d52566c2e2785f7740f3ac1529d",
-        "s": "0x1b2687608968ecb67230bbf7944199560fa2b3cffe9cc2b1c024e1c8f86a9e08",
-        "to": "0xdac17f958d2ee523a2206206994597c13d831ec7",
-        "transactionIndex": 98,
-        "type": "eip1559",
-        "v": 1n,
-        "value": 0n,
-      }
-    `)
-  })
-
-  test('throws if transaction not found', async () => {
-    await expect(
-      getTransaction(publicClient, {
-        hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
-      }),
-    ).rejects.toThrowError(
-      'Transaction with hash "0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d" could not be found.',
-    )
-  })
-})
-
-describe('args: blockHash', () => {
-  test('blockHash: gets transaction by block hash & index', async () => {
-    const transaction = await getTransaction(publicClient, {
-      blockHash:
-        '0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d',
-      index: 5,
-    })
-    expect(transaction).toMatchInlineSnapshot(`
-      {
-        "blockHash": "0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d",
-        "blockNumber": 15131999n,
-        "from": "0xb14f54018284f5964097506219e2fd4c1783ca55",
-        "gas": 35859n,
-        "gasPrice": 21000000000n,
-        "hash": "0x082395f55b04a9ee09fc341ed0c10f0289786057fbb7153584cad85b6abf7737",
-        "input": "0xa9059cbb000000000000000000000000a471cffe40390a01e82245db590aff6233cc3f060000000000000000000000000000000000000000000004e8de652b3188049000",
-        "nonce": 0,
-        "r": "0xb5793da381688e5e52e519044a0faead359109f47493e90a5424d2f7cfc8c448",
-        "s": "0x56a18fe5d653f59838ffd9659da41c8f87826a2c26429165adb2284f50a4d5d8",
-        "to": "0x554ffc77f4251a9fb3c0e3590a6a205f8d4e067d",
-        "transactionIndex": 5,
-        "type": "legacy",
-        "v": 28n,
-        "value": 0n,
-      }
-    `)
-  }, 10000)
-
-  test('blockHash: throws if transaction not found', async () => {
-    const { hash: blockHash } = await getBlock(publicClient, {
-      blockNumber: initialBlockNumber - 69n,
-    })
-    if (!blockHash) throw new Error('no block hash found')
-
-    await expect(
-      getTransaction(publicClient, {
-        blockHash,
-        index: 420,
-      }),
-    ).rejects.toThrowError('Transaction at block hash')
-  })
-})
-
-describe('args: blockNumber', () => {
-  test('gets transaction by block number & index', async () => {
-    const transaction = await getTransaction(publicClient, {
-      blockNumber: 15131999n,
-      index: 5,
-    })
-    expect(transaction).toMatchInlineSnapshot(`
-      {
-        "blockHash": "0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d",
-        "blockNumber": 15131999n,
-        "from": "0xb14f54018284f5964097506219e2fd4c1783ca55",
-        "gas": 35859n,
-        "gasPrice": 21000000000n,
-        "hash": "0x082395f55b04a9ee09fc341ed0c10f0289786057fbb7153584cad85b6abf7737",
-        "input": "0xa9059cbb000000000000000000000000a471cffe40390a01e82245db590aff6233cc3f060000000000000000000000000000000000000000000004e8de652b3188049000",
-        "nonce": 0,
-        "r": "0xb5793da381688e5e52e519044a0faead359109f47493e90a5424d2f7cfc8c448",
-        "s": "0x56a18fe5d653f59838ffd9659da41c8f87826a2c26429165adb2284f50a4d5d8",
-        "to": "0x554ffc77f4251a9fb3c0e3590a6a205f8d4e067d",
-        "transactionIndex": 5,
-        "type": "legacy",
-        "v": 28n,
-        "value": 0n,
-      }
-    `)
-  }, 10000)
-
-  test('throws if transaction not found', async () => {
-    await expect(
-      getTransaction(publicClient, {
-        blockNumber: 15131999n,
-        index: 420,
-      }),
-    ).rejects.toThrowError(
-      'Transaction at block number "15131999" at index "420" could not be found.',
-    )
-  })
-})
-
-describe('args: blockTag', () => {
-  test('gets transaction by block tag & index', async () => {
-    await sendTransaction(walletClient, {
-      from: sourceAccount.address,
-      to: targetAccount.address,
-      value: parseEther('1'),
-    })
-
-    await mine(testClient, { blocks: 1 })
-
-    const transaction = await getTransaction(publicClient, {
-      blockTag: 'latest',
-      index: 0,
-    })
-    expect(transaction).toBeDefined()
-  }, 10000)
-})

package/src/actions/public/getTransaction.ts

@@ -1,95 +0,0 @@
-import type { PublicClient } from '../../clients'
-import { TransactionNotFoundError } from '../../errors'
-import type { BlockTag, Chain, Hash, RpcTransaction } from '../../types'
-import { format, numberToHex } from '../../utils'
-import type {
-  FormattedTransaction,
-  TransactionFormatter,
-} from '../../utils/formatters/transaction'
-import { formatTransaction } from '../../utils/formatters/transaction'
-
-export type GetTransactionArgs =
-  | {
-      /** The block hash */
-      blockHash: Hash
-      blockNumber?: never
-      blockTag?: never
-      hash?: never
-      /** The index of the transaction on the block. */
-      index: number
-    }
-  | {
-      blockHash?: never
-      /** The block number */
-      blockNumber: bigint
-      blockTag?: never
-      hash?: never
-      /** The index of the transaction on the block. */
-      index: number
-    }
-  | {
-      blockHash?: never
-      blockNumber?: never
-      /** The block tag. */
-      blockTag: BlockTag
-      hash?: never
-      /** The index of the transaction on the block. */
-      index: number
-    }
-  | {
-      blockHash?: never
-      blockNumber?: never
-      blockTag?: never
-      /** The hash of the transaction. */
-      hash: Hash
-      index?: number
-    }
-
-export type GetTransactionResponse<TChain extends Chain = Chain> =
-  FormattedTransaction<TransactionFormatter<TChain>>
-
-/** @description Returns information about a transaction given a hash or block identifier. */
-export async function getTransaction<TChain extends Chain>(
-  client: PublicClient<any, TChain>,
-  {
-    blockHash,
-    blockNumber,
-    blockTag = 'latest',
-    hash,
-    index,
-  }: GetTransactionArgs,
-): Promise<GetTransactionResponse<TChain>> {
-  const blockNumberHex =
-    blockNumber !== undefined ? numberToHex(blockNumber) : undefined
-
-  let transaction: RpcTransaction | null = null
-  if (hash) {
-    transaction = await client.request({
-      method: 'eth_getTransactionByHash',
-      params: [hash],
-    })
-  } else if (blockHash) {
-    transaction = await client.request({
-      method: 'eth_getTransactionByBlockHashAndIndex',
-      params: [blockHash, numberToHex(index)],
-    })
-  } else if (blockNumberHex || blockTag) {
-    transaction = await client.request({
-      method: 'eth_getTransactionByBlockNumberAndIndex',
-      params: [blockNumberHex || blockTag, numberToHex(index)],
-    })
-  }
-
-  if (!transaction)
-    throw new TransactionNotFoundError({
-      blockHash,
-      blockNumber,
-      blockTag,
-      hash,
-      index,
-    })
-
-  return format(transaction, {
-    formatter: client.chain?.formatters?.transaction || formatTransaction,
-  })
-}

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

@@ -1,69 +0,0 @@
-import { expect, test } from 'vitest'
-
-import { accounts, publicClient, testClient, walletClient } from '../../_test'
-import { parseEther } from '../../utils'
-import { mine } from '../test'
-import { getTransactionConfirmations } from './getTransactionConfirmations'
-import { getTransactionReceipt } from './getTransactionReceipt'
-import { sendTransaction } from '..'
-
-test('default', async () => {
-  const hash = await sendTransaction(walletClient, {
-    from: accounts[0].address,
-    to: accounts[1].address,
-    value: parseEther('1'),
-  })
-  await mine(testClient, { blocks: 1 })
-  const transactionReceipt = await getTransactionReceipt(publicClient, {
-    hash,
-  })
-  expect(
-    await getTransactionConfirmations(publicClient, {
-      transactionReceipt,
-    }),
-  ).toBe(1n)
-})
-
-test('multiple confirmations', async () => {
-  const hash = await sendTransaction(walletClient, {
-    from: accounts[0].address,
-    to: accounts[1].address,
-    value: parseEther('1'),
-  })
-  await mine(testClient, { blocks: 10 })
-  const transactionReceipt = await getTransactionReceipt(publicClient, {
-    hash,
-  })
-  expect(
-    await getTransactionConfirmations(publicClient, {
-      transactionReceipt,
-    }),
-  ).toBe(10n)
-})
-
-test('args: hash', async () => {
-  const hash = await sendTransaction(walletClient, {
-    from: accounts[0].address,
-    to: accounts[1].address,
-    value: parseEther('1'),
-  })
-  await mine(testClient, { blocks: 10 })
-  expect(
-    await getTransactionConfirmations(publicClient, {
-      hash,
-    }),
-  ).toBe(10n)
-})
-
-test('no confirmations', async () => {
-  const hash = await sendTransaction(walletClient, {
-    from: accounts[0].address,
-    to: accounts[1].address,
-    value: parseEther('1'),
-  })
-  expect(
-    await getTransactionConfirmations(publicClient, {
-      hash,
-    }),
-  ).toBe(0n)
-})

package/src/actions/public/getTransactionConfirmations.ts

@@ -1,38 +0,0 @@
-import type { PublicClient } from '../../clients'
-import type { Chain, Hash } from '../../types'
-import type {
-  FormattedTransactionReceipt,
-  TransactionReceiptFormatter,
-} from '../../utils'
-import { getBlockNumber } from './getBlockNumber'
-import { getTransaction } from './getTransaction'
-
-export type GetTransactionConfirmationsArgs<TChain extends Chain> =
-  | {
-      /** The transaction hash. */
-      hash: Hash
-      transactionReceipt?: never
-    }
-  | {
-      hash?: never
-      /** The transaction receipt. */
-      transactionReceipt: FormattedTransactionReceipt<
-        TransactionReceiptFormatter<TChain>
-      >
-    }
-
-export type GetTransactionConfirmationsResponse = bigint
-
-export async function getTransactionConfirmations<TChain extends Chain>(
-  client: PublicClient<any, TChain>,
-  { hash, transactionReceipt }: GetTransactionConfirmationsArgs<TChain>,
-): Promise<GetTransactionConfirmationsResponse> {
-  const [blockNumber, transaction] = await Promise.all([
-    getBlockNumber(client),
-    hash ? getTransaction(client, { hash }) : undefined,
-  ])
-  const transactionBlockNumber =
-    transactionReceipt?.blockNumber || transaction?.blockNumber
-  if (!transactionBlockNumber) return 0n
-  return blockNumber - transactionBlockNumber! + 1n
-}

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

@@ -1,56 +0,0 @@
-import { expect, test } from 'vitest'
-
-import { parseEther } from '../../utils'
-import { accounts, publicClient, testClient, walletClient } from '../../_test'
-import { sendTransaction } from '..'
-import { mine, setNonce } from '../test'
-import { getTransactionCount } from './getTransactionCount'
-
-test('gets transaction count', async () => {
-  await setNonce(testClient, { address: accounts[0].address, nonce: 0 })
-
-  expect(
-    await getTransactionCount(publicClient, {
-      address: accounts[0].address,
-    }),
-  ).toBe(0)
-
-  await sendTransaction(walletClient, {
-    from: accounts[0].address,
-    to: accounts[0].address,
-    value: parseEther('1'),
-  })
-  await mine(testClient, { blocks: 1 })
-
-  expect(
-    await getTransactionCount(publicClient, {
-      address: accounts[0].address,
-    }),
-  ).toBe(1)
-})
-
-test('args: blockNumber', async () => {
-  expect(
-    await getTransactionCount(publicClient, {
-      address: '0xa5cc3c03994db5b0d9a5eedd10cabab0813678ac',
-      blockNumber: 14932234n,
-    }),
-  ).toBe(368)
-})
-
-test('args: blockTag', async () => {
-  expect(
-    await getTransactionCount(publicClient, {
-      address: '0xa5cc3c03994db5b0d9a5eedd10cabab0813678ac',
-      blockTag: 'latest',
-    }),
-  ).toBe(579)
-})
-
-test('no count', async () => {
-  expect(
-    await getTransactionCount(publicClient, {
-      address: '0xa5cc3c03994db5b0d9a5eedd10cabab0813678ad',
-    }),
-  ).toBe(0)
-})

package/src/actions/public/getTransactionCount.ts

@@ -1,34 +0,0 @@
-import type { PublicClient } from '../../clients'
-import type { Address, BlockTag } from '../../types'
-import { hexToNumber, numberToHex } from '../../utils'
-
-export type GetTransactionCountArgs = {
-  /** The account address. */
-  address: Address
-} & (
-  | {
-      /** The block number. */
-      blockNumber?: bigint
-      blockTag?: never
-    }
-  | {
-      blockNumber?: never
-      /** The block tag. Defaults to 'latest'. */
-      blockTag?: BlockTag
-    }
-)
-export type GetTransactionCountResponse = number
-
-/**
- * @description Returns the number of transactions an account has broadcast / sent.
- */
-export async function getTransactionCount(
-  client: PublicClient,
-  { address, blockTag = 'latest', blockNumber }: GetTransactionCountArgs,
-): Promise<GetTransactionCountResponse> {
-  const count = await client.request({
-    method: 'eth_getTransactionCount',
-    params: [address, blockNumber ? numberToHex(blockNumber) : blockTag],
-  })
-  return hexToNumber(count)
-}

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

@@ -1,33 +0,0 @@
-import { bench, describe } from 'vitest'
-
-import {
-  ethersProvider,
-  ethersV6Provider,
-  publicClient,
-  web3Provider,
-} from '../../_test'
-
-import { getTransactionReceipt } from './getTransactionReceipt'
-
-const hash =
-  '0xa4b1f606b66105fa45cb5db23d2f6597075701e7f0e2367f4e6a39d17a8cf98b'
-
-describe('Get Transaction Receipt', () => {
-  bench('viem: `getTransactionReceipt`', async () => {
-    await getTransactionReceipt(publicClient, {
-      hash,
-    })
-  })
-
-  bench('ethers: `getTransactionReceipt`', async () => {
-    await ethersProvider.getTransactionReceipt(hash)
-  })
-
-  bench('ethers@6: `getTransactionReceipt`', async () => {
-    await ethersV6Provider.getTransactionReceipt(hash)
-  })
-
-  bench('web3.js: `getTransactionReceipt`', async () => {
-    await web3Provider.eth.getTransactionReceipt(hash)
-  })
-})