viem 0.0.1-alpha.19 → 0.0.1-alpha.20

package/src/_test/abis.ts

@@ -1223,3 +1223,191 @@ export const wagmiContractConfig = {
     },
   ],
 } as const
+
+export const usdcContractConfig = {
+  address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+  abi: [
+    {
+      type: 'event',
+      name: 'Approval',
+      inputs: [
+        {
+          indexed: true,
+          name: 'owner',
+          type: 'address',
+        },
+        {
+          indexed: true,
+          name: 'spender',
+          type: 'address',
+        },
+        {
+          indexed: false,
+          name: 'value',
+          type: 'uint256',
+        },
+      ],
+    },
+    {
+      type: 'event',
+      name: 'Transfer',
+      inputs: [
+        {
+          indexed: true,
+          name: 'from',
+          type: 'address',
+        },
+        {
+          indexed: true,
+          name: 'to',
+          type: 'address',
+        },
+        {
+          indexed: false,
+          name: 'value',
+          type: 'uint256',
+        },
+      ],
+    },
+    {
+      type: 'function',
+      name: 'allowance',
+      stateMutability: 'view',
+      inputs: [
+        {
+          name: 'owner',
+          type: 'address',
+        },
+        {
+          name: 'spender',
+          type: 'address',
+        },
+      ],
+      outputs: [{ type: 'uint256' }],
+    },
+    {
+      type: 'function',
+      name: 'approve',
+      stateMutability: 'nonpayable',
+      inputs: [
+        {
+          name: 'spender',
+          type: 'address',
+        },
+        {
+          name: 'amount',
+          type: 'uint256',
+        },
+      ],
+      outputs: [{ type: 'bool' }],
+    },
+    {
+      type: 'function',
+      name: 'balanceOf',
+      stateMutability: 'view',
+      inputs: [
+        {
+          name: 'account',
+          type: 'address',
+        },
+      ],
+      outputs: [{ type: 'uint256' }],
+    },
+    {
+      type: 'function',
+      name: 'decimals',
+      stateMutability: 'view',
+      inputs: [],
+      outputs: [{ type: 'uint8' }],
+    },
+    {
+      type: 'function',
+      name: 'name',
+      stateMutability: 'view',
+      inputs: [],
+      outputs: [{ type: 'string' }],
+    },
+    {
+      type: 'function',
+      name: 'symbol',
+      stateMutability: 'view',
+      inputs: [],
+      outputs: [{ type: 'string' }],
+    },
+    {
+      type: 'function',
+      name: 'totalSupply',
+      stateMutability: 'view',
+      inputs: [],
+      outputs: [{ type: 'uint256' }],
+    },
+    {
+      type: 'function',
+      name: 'transfer',
+      stateMutability: 'nonpayable',
+      inputs: [
+        {
+          name: 'recipient',
+          type: 'address',
+        },
+        {
+          name: 'amount',
+          type: 'uint256',
+        },
+      ],
+      outputs: [{ type: 'bool' }],
+    },
+    {
+      type: 'function',
+      name: 'transferFrom',
+      stateMutability: 'nonpayable',
+      inputs: [
+        {
+          name: 'sender',
+          type: 'address',
+        },
+        {
+          name: 'recipient',
+          type: 'address',
+        },
+        {
+          name: 'amount',
+          type: 'uint256',
+        },
+      ],
+      outputs: [{ type: 'bool' }],
+    },
+    {
+      type: 'function',
+      name: 'increaseAllowance',
+      stateMutability: 'nonpayable',
+      inputs: [
+        {
+          name: 'spender',
+          type: 'address',
+        },
+        {
+          name: 'addedValue',
+          type: 'uint256',
+        },
+      ],
+      outputs: [{ type: 'bool' }],
+    },
+    {
+      type: 'function',
+      name: 'decreaseAllowance',
+      stateMutability: 'nonpayable',
+      inputs: [
+        {
+          name: 'spender',
+          type: 'address',
+        },
+        {
+          name: 'subtractedValue',
+          type: 'uint256',
+        },
+      ],
+      outputs: [{ type: 'bool' }],
+    },
+  ],
+} as const

package/src/_test/constants.ts

@@ -58,6 +58,3 @@ export const transfer1Data = (address: string): Hex =>
 
 // vitalik.eth
 export const vitalikAddress = '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
-
-// USDC ERC20 contract
-export const usdcAddress = '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'

package/src/_test/index.ts

@@ -1,4 +1,8 @@
-export { wagmiContractConfig } from './abis'
+export {
+  wagmiContractConfig,
+  uniswapV3PositionsContractConfig,
+  usdcContractConfig,
+} from './abis'
 
 export { essentialProvider, ethersProvider, web3Provider } from './bench'
 
@@ -8,7 +12,6 @@ export {
   localHttpUrl,
   localWsUrl,
   transfer1Data,
-  usdcAddress,
   vitalikAddress,
 } from './constants'
 

package/src/actions/index.test.ts

@@ -8,6 +8,8 @@ test('exports actions', () => {
       "addChain": [Function],
       "call": [Function],
       "createBlockFilter": [Function],
+      "createContractEventFilter": [Function],
+      "createEventFilter": [Function],
       "createPendingTransactionFilter": [Function],
       "deployContract": [Function],
       "dropTransaction": [Function],

package/src/actions/index.ts

@@ -1,6 +1,8 @@
 export {
   call,
   createBlockFilter,
+  createContractEventFilter,
+  createEventFilter,
   createPendingTransactionFilter,
   deployContract,
   estimateGas,
@@ -33,6 +35,10 @@ export type {
   CallArgs,
   CallResponse,
   CreateBlockFilterResponse,
+  CreateContractEventFilterArgs,
+  CreateContractEventFilterResponse,
+  CreateEventFilterArgs,
+  CreateEventFilterResponse,
   CreatePendingTransactionFilterResponse,
   DeployContractArgs,
   DeployContractResponse,

package/src/actions/public/call.ts

@@ -1,9 +1,10 @@
-import type { Chain, Formatter } from '../../chains'
 import type { PublicClient } from '../../clients'
 import { InvalidGasArgumentsError } from '../../errors'
 import type {
   Address,
   BlockTag,
+  Chain,
+  Formatter,
   Hex,
   MergeIntersectionProperties,
   TransactionRequest,

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

@@ -0,0 +1,119 @@
+import { expect, test } from 'vitest'
+
+import {
+  accounts,
+  initialBlockNumber,
+  publicClient,
+  usdcContractConfig,
+} from '../../_test'
+
+import { createContractEventFilter } from './createContractEventFilter'
+
+test('default', async () => {
+  expect(
+    (
+      await createContractEventFilter(publicClient, {
+        abi: usdcContractConfig.abi,
+        eventName: 'Transfer',
+      })
+    ).id,
+  ).toBeDefined()
+})
+
+test('args: address', async () => {
+  expect(
+    (
+      await createContractEventFilter(publicClient, {
+        address: usdcContractConfig.address,
+        abi: usdcContractConfig.abi,
+        eventName: 'Transfer',
+      })
+    ).id,
+  ).toBeDefined()
+})
+
+test('args: args', async () => {
+  expect(
+    (
+      await createContractEventFilter(publicClient, {
+        address: usdcContractConfig.address,
+        abi: usdcContractConfig.abi,
+        eventName: 'Transfer',
+        args: {
+          from: accounts[0].address,
+          to: accounts[0].address,
+        },
+      })
+    ).id,
+  ).toBeDefined()
+  expect(
+    (
+      await createContractEventFilter(publicClient, {
+        address: usdcContractConfig.address,
+        abi: usdcContractConfig.abi,
+        eventName: 'Transfer',
+        args: {
+          from: accounts[0].address,
+        },
+      })
+    ).id,
+  ).toBeDefined()
+  expect(
+    (
+      await createContractEventFilter(publicClient, {
+        address: usdcContractConfig.address,
+        abi: usdcContractConfig.abi,
+        eventName: 'Transfer',
+        args: {
+          to: [accounts[0].address, accounts[1].address],
+        },
+      })
+    ).id,
+  ).toBeDefined()
+})
+
+test('args: fromBlock', async () => {
+  expect(
+    (
+      await createContractEventFilter(publicClient, {
+        address: usdcContractConfig.address,
+        abi: usdcContractConfig.abi,
+        eventName: 'Transfer',
+        fromBlock: 'latest',
+      })
+    ).id,
+  ).toBeDefined()
+  expect(
+    (
+      await createContractEventFilter(publicClient, {
+        address: usdcContractConfig.address,
+        abi: usdcContractConfig.abi,
+        eventName: 'Transfer',
+        fromBlock: initialBlockNumber,
+      })
+    ).id,
+  ).toBeDefined()
+})
+
+test('args: toBlock', async () => {
+  expect(
+    (
+      await createContractEventFilter(publicClient, {
+        address: usdcContractConfig.address,
+        abi: usdcContractConfig.abi,
+        eventName: 'Transfer',
+        toBlock: 'latest',
+      })
+    ).id,
+  ).toBeDefined()
+  expect(
+    (
+      await createContractEventFilter(publicClient, {
+        address: usdcContractConfig.address,
+        abi: usdcContractConfig.abi,
+        eventName: 'Transfer',
+        toBlock: initialBlockNumber,
+      })
+    ).id,
+  ).toBeDefined()
+})

package/src/actions/public/createContractEventFilter.ts

@@ -0,0 +1,69 @@
+import { Abi } from 'abitype'
+import type { PublicClient } from '../../clients'
+
+import type {
+  Address,
+  BlockNumber,
+  BlockTag,
+  EventDefinition,
+  ExtractArgsFromEventDefinition,
+  ExtractEventArgsFromAbi,
+  ExtractEventNameFromAbi,
+  Filter,
+} from '../../types'
+import {
+  encodeEventTopics,
+  EncodeEventTopicsArgs,
+  numberToHex,
+} from '../../utils'
+
+export type EventFilterArgs<TEventDefinition extends EventDefinition> =
+  ExtractArgsFromEventDefinition<TEventDefinition>
+
+export type CreateContractEventFilterArgs<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TEventName extends string = any,
+> = {
+  address?: Address | Address[]
+  abi: TAbi
+  eventName: ExtractEventNameFromAbi<TAbi, TEventName>
+  fromBlock?: BlockNumber | BlockTag
+  toBlock?: BlockNumber | BlockTag
+} & ExtractEventArgsFromAbi<TAbi, TEventName>
+export type CreateContractEventFilterResponse = Filter<'event'>
+
+export async function createContractEventFilter<
+  TAbi extends Abi | readonly unknown[] = Abi,
+  TEventName extends string = any,
+>(
+  client: PublicClient,
+  {
+    address,
+    abi,
+    args,
+    eventName,
+    fromBlock,
+    toBlock,
+  }: CreateContractEventFilterArgs<TAbi, TEventName>,
+): Promise<CreateContractEventFilterResponse> {
+  const topics = eventName
+    ? encodeEventTopics({
+        abi,
+        args,
+        eventName,
+      } as unknown as EncodeEventTopicsArgs)
+    : undefined
+  const id = await client.request({
+    method: 'eth_newFilter',
+    params: [
+      {
+        address,
+        fromBlock:
+          typeof fromBlock === 'bigint' ? numberToHex(fromBlock) : fromBlock,
+        toBlock: typeof toBlock === 'bigint' ? numberToHex(toBlock) : toBlock,
+        topics,
+      },
+    ],
+  })
+  return { id, type: 'event' }
+}

package/src/actions/public/createEventFilter.ts

@@ -4,18 +4,17 @@ import type {
   Address,
   BlockNumber,
   BlockTag,
+  EventDefinition,
   ExtractArgsFromEventDefinition,
   Filter,
   LogTopic,
 } from '../../types'
 import { getEventSignature, numberToHex } from '../../utils'
 
-export type EventFilterArgs<TEventDefinition extends `${string}(${string})`> =
+export type EventFilterArgs<TEventDefinition extends EventDefinition> =
   ExtractArgsFromEventDefinition<TEventDefinition>
 
-export type CreateEventFilterArgs<
-  TEventDefinition extends `${string}(${string})`,
-> = {
+export type CreateEventFilterArgs<TEventDefinition extends EventDefinition> = {
   address?: Address | Address[]
   fromBlock?: BlockNumber | BlockTag
   toBlock?: BlockNumber | BlockTag
@@ -32,7 +31,7 @@ export type CreateEventFilterArgs<
 export type CreateEventFilterResponse = Filter<'event'>
 
 export async function createEventFilter<
-  TEventDefinition extends `${string}(${string})`,
+  TEventDefinition extends EventDefinition,
 >(
   client: PublicClient,
   {
@@ -62,9 +61,7 @@ export async function createEventFilter<
   return { id, type: 'event' }
 }
 
-export function buildFilterTopics<
-  TEventDefinition extends `${string}(${string})`,
->({
+export function buildFilterTopics<TEventDefinition extends EventDefinition,>({
   event,
   args: _args,
 }: {

package/src/actions/public/deployContract.ts

@@ -1,8 +1,7 @@
 import { Abi } from 'abitype'
-import { Chain } from '../../chains'
 import { WalletClient } from '../../clients'
 
-import { ExtractConstructorArgsFromAbi, Hex } from '../../types'
+import { Chain, ExtractConstructorArgsFromAbi, Hex } from '../../types'
 import { encodeDeployData } from '../../utils'
 import {
   sendTransaction,

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

@@ -52,11 +52,11 @@ test('chain w/ custom block type', async () => {
       randomness: { committed: Hex; revealed: Hex }
     }
   >(block)
-  expect(block).toMatchInlineSnapshot(`
+  const { extraData, ...rest } = block
+  expect(rest).toMatchInlineSnapshot(`
     {
-      "baseFeePerGas": 100000000n,
+      "baseFeePerGas": null,
       "epochSnarkData": null,
-      "extraData": "0xd983010700846765746889676f312e31372e3133856c696e7578000000000000f8ccc0c080b84169807e4d7934803decfde330167e444ec323431e1ff4cd70f40f2e79f24ce91f60340b99f97e3562ee57389e2c72343a74379e0b8b7ca5237ec141e84278bb3e00f8418e3e8af95497b7f6ffe7d3c4cbfbbdb06b26f6f3e913ca2cb7dff23532eaf3eb9f3b06ae75498c88353d279cf58fb0570736e2aa20cf53381722b6485f0f3c8180f8418e3fffffffffffffffffffffffffffb0005d23be939b9f8135e6b1ff283baff985c1b6ccacf2b6aa7fbd8939c4b6178b1d242b574a614b6347182a3b3195258080",
       "gasUsed": 5045322n,
       "hash": "0xac8c9bc3b84e103dc321bbe83b670e425ff68bfc9a333a4f1b1b204ad11c583d",
       "logsBloom": "0x02004000004200000000000000800020000000000000400002040000002020000000802000000000000180000001000020800000000000000000000000000000000000000022000260000008000800000000000000000000000000000000000000000008000410002100000140000800000044c00200000000400010000800008800000080000000000010000040000000000000000000000000000000800020028000000100000000000000000000002002881000000000000800020000040020900402020000180000000000000040000800000011020090002000400000200010002000001000000000000080000000000000000000000000000004000000",

package/src/actions/public/getBlock.ts

@@ -1,7 +1,6 @@
-import type { Chain } from '../../chains'
 import type { PublicClient } from '../../clients'
 import { BlockNotFoundError } from '../../errors'
-import type { BlockTag, Hash, RpcBlock } from '../../types'
+import type { BlockTag, Chain, Hash, RpcBlock } from '../../types'
 import type { BlockFormatter, FormattedBlock } from '../../utils'
 import { format, formatBlock, numberToHex } from '../../utils'
 

package/src/actions/public/getBlockTransactionCount.ts

@@ -1,6 +1,5 @@
-import type { Chain } from '../../chains'
 import type { PublicClient } from '../../clients'
-import type { BlockTag, Hash, Quantity } from '../../types'
+import type { BlockTag, Chain, Hash, Quantity } from '../../types'
 import { hexToNumber, numberToHex } from '../../utils'
 
 export type GetBlockTransactionCountArgs =

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

@@ -6,9 +6,9 @@ import {
   publicClient,
   testClient,
   transfer1Data,
-  usdcAddress,
   vitalikAddress,
   walletClient,
+  usdcContractConfig,
 } from '../../_test'
 
 import {
@@ -103,12 +103,12 @@ describe('events', () => {
 
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[0].address),
     })
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[1].address),
     })
 
@@ -123,7 +123,7 @@ describe('events', () => {
 
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[2].address),
     })
 
@@ -140,12 +140,12 @@ describe('events', () => {
 
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[0].address),
     })
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[1].address),
     })
 
@@ -160,7 +160,7 @@ describe('events', () => {
 
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[2].address),
     })
 
@@ -184,4 +184,6 @@ describe('events', () => {
     logs = await getFilterChanges(publicClient, { filter })
     expect(logs.length).toBe(0)
   })
+
+  test.todo('args: args')
 })

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

@@ -6,7 +6,7 @@ import {
   publicClient,
   testClient,
   transfer1Data,
-  usdcAddress,
+  usdcContractConfig,
   vitalikAddress,
   walletClient,
 } from '../../_test'
@@ -49,12 +49,12 @@ describe('events', () => {
 
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[0].address),
     })
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[1].address),
     })
 
@@ -72,12 +72,12 @@ describe('events', () => {
 
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[0].address),
     })
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[1].address),
     })
 
@@ -99,4 +99,6 @@ describe('events', () => {
     assertType<Log[]>(logs)
     expect(logs.length).toBe(1056)
   })
+
+  test.todo('args: args')
 })

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

@@ -6,8 +6,8 @@ import {
   publicClient,
   testClient,
   transfer1Data,
-  usdcAddress,
   vitalikAddress,
+  usdcContractConfig,
   walletClient,
 } from '../../_test'
 
@@ -45,12 +45,12 @@ describe('events', () => {
   test('no args', async () => {
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[0].address),
     })
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[1].address),
     })
     await mine(testClient, { blocks: 1 })
@@ -63,12 +63,12 @@ describe('events', () => {
   test('args: event', async () => {
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[0].address),
     })
     await sendTransaction(walletClient, {
       from: vitalikAddress,
-      to: usdcAddress,
+      to: usdcContractConfig.address,
       data: transfer1Data(accounts[1].address),
     })
 
@@ -102,4 +102,6 @@ describe('events', () => {
     assertType<Log[]>(logs)
     expect(logs.length).toBe(118)
   })
+
+  test.todo('args: args')
 })