viem 2.0.0-alpha.10 → 2.0.0-alpha.11

package/actions/public/watchContractEvent.ts

@@ -1,4 +1,4 @@
-import type { Abi, AbiEvent, Address, ExtractAbiEvent } from 'abitype'
+import type { Abi, Address, ExtractAbiEvent } from 'abitype'
 
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
@@ -21,18 +21,17 @@ import {
   type EncodeEventTopicsParameters,
   encodeEventTopics,
 } from '../../utils/abi/encodeEventTopics.js'
-import {
-  type GetAbiItemParameters,
-  getAbiItem,
-} from '../../utils/abi/getAbiItem.js'
 import { formatLog } from '../../utils/formatters/log.js'
 import { observe } from '../../utils/observe.js'
 import { poll } from '../../utils/poll.js'
 import { stringify } from '../../utils/stringify.js'
 import { createContractEventFilter } from './createContractEventFilter.js'
 import { getBlockNumber } from './getBlockNumber.js'
+import {
+  type GetContractEventsParameters,
+  getContractEvents,
+} from './getContractEvents.js'
 import { getFilterChanges } from './getFilterChanges.js'
-import { getLogs } from './getLogs.js'
 import { uninstallFilter } from './uninstallFilter.js'
 
 export type WatchContractEventOnLogsParameter<
@@ -85,7 +84,7 @@ export type WatchContractEventParameters<
    * Whether or not the logs must match the indexed/non-indexed arguments on `event`.
    * @default false
    */
-  strict?: strict | undefined
+  strict?: strict | boolean | undefined
 } & GetPollOptions<transport>
 
 export type WatchContractEventReturnType = () => void
@@ -194,16 +193,14 @@ export function watchContractEvent<
               // If the block number doesn't exist, we are yet to reach the first poll interval,
               // so do not emit any logs.
               if (previousBlockNumber && previousBlockNumber !== blockNumber) {
-                logs = await getLogs(client, {
+                logs = await getContractEvents(client, {
+                  abi,
                   address,
                   args: args as any,
                   fromBlock: previousBlockNumber + 1n,
                   toBlock: blockNumber,
-                  event: getAbiItem({
-                    abi,
-                    name: eventName,
-                  } as unknown as GetAbiItemParameters) as AbiEvent,
-                })
+                  strict,
+                } as {} as GetContractEventsParameters)
               } else {
                 logs = []
               }

package/chains/definitions/moonbeamDev.ts

@@ -0,0 +1,22 @@
+import { defineChain } from '../../utils/chain.js'
+
+export const moonbeamDev = /*#__PURE__*/ defineChain({
+  id: 1281,
+  name: 'Moonbeam Development Node',
+  network: 'development',
+  nativeCurrency: {
+    decimals: 18,
+    name: 'DEV',
+    symbol: 'DEV',
+  },
+  rpcUrls: {
+    default: {
+      http: ['http://127.0.0.1:9944'],
+      webSocket: ['wss://127.0.0.1:9944'],
+    },
+    public: {
+      http: ['http://127.0.0.1:9944'],
+      webSocket: ['wss://127.0.0.1:9944'],
+    },
+  },
+})

package/chains/definitions/optimismSepolia.ts

@@ -0,0 +1,39 @@
+import { defineChain } from '../../utils/chain.js'
+import { formattersOptimism } from '../optimism/formatters.js'
+
+export const optimismSepolia = /*#__PURE__*/ defineChain(
+  {
+    id: 11155420,
+    name: 'Optimism Sepolia',
+    network: 'optimism-sepolia',
+    nativeCurrency: { name: 'Sepolia Ether', symbol: 'ETH', decimals: 18 },
+    rpcUrls: {
+      default: {
+        http: ['https://sepolia.optimism.io'],
+      },
+      public: {
+        http: ['https://sepolia.optimism.io'],
+      },
+    },
+    blockExplorers: {
+      blockscout: {
+        name: 'Blockscout',
+        url: 'https://optimism-sepolia.blockscout.com',
+      },
+      default: {
+        name: 'Blockscout',
+        url: 'https://optimism-sepolia.blockscout.com',
+      },
+    },
+    contracts: {
+      multicall3: {
+        address: '0xca11bde05977b3631167028862be2a173976ca11',
+        blockCreated: 1620204,
+      },
+    },
+    testnet: true,
+  },
+  {
+    formatters: formattersOptimism,
+  },
+)

package/chains/definitions/sepolia.ts

@@ -34,7 +34,7 @@ export const sepolia = /*#__PURE__*/ defineChain({
   contracts: {
     multicall3: {
       address: '0xca11bde05977b3631167028862be2a173976ca11',
-      blockCreated: 6507670,
+      blockCreated: 751532,
     },
     ensRegistry: { address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e' },
     ensUniversalResolver: {

package/chains/index.ts

@@ -80,6 +80,7 @@ export { mevTestnet } from './definitions/mevTestnet.js'
 export { modeTestnet } from './definitions/modeTestnet.js'
 export { moonbaseAlpha } from './definitions/moonbaseAlpha.js'
 export { moonbeam } from './definitions/moonbeam.js'
+export { moonbeamDev } from './definitions/moonbeamDev.js'
 export { moonriver } from './definitions/moonriver.js'
 export { neonDevnet } from './definitions/neonDevnet.js'
 export { nexi } from './definitions/nexi.js'
@@ -88,6 +89,7 @@ export { oasys } from './definitions/oasys.js'
 export { okc } from './definitions/okc.js'
 export { optimism } from './definitions/optimism.js'
 export { optimismGoerli } from './definitions/optimismGoerli.js'
+export { optimismSepolia } from './definitions/optimismSepolia.js'
 export { opBNB } from './definitions/opBNB.js'
 export { opBNBTestnet } from './definitions/opBNBTestnet.js'
 export { plinga } from './definitions/plinga.js'

package/clients/decorators/public.ts

@@ -97,6 +97,11 @@ import {
   type GetChainIdReturnType,
   getChainId,
 } from '../../actions/public/getChainId.js'
+import {
+  type GetContractEventsParameters,
+  type GetContractEventsReturnType,
+  getContractEvents,
+} from '../../actions/public/getContractEvents.js'
 import {
   type GetFeeHistoryParameters,
   type GetFeeHistoryReturnType,
@@ -624,6 +629,48 @@ export type PublicActions<
    * // 1
    */
   getChainId: () => Promise<GetChainIdReturnType>
+  /**
+   * Returns a list of event logs emitted by a contract.
+   *
+   * - Docs: https://viem.sh/docs/actions/public/getContractEvents.html
+   * - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs)
+   *
+   * @param client - Client to use
+   * @param parameters - {@link GetContractEventsParameters}
+   * @returns A list of event logs. {@link GetContractEventsReturnType}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   * import { wagmiAbi } from './abi'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: http(),
+   * })
+   * const logs = await client.getContractEvents(client, {
+   *  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+   *  abi: wagmiAbi,
+   *  eventName: 'Transfer'
+   * })
+   */
+  getContractEvents: <
+    const abi extends Abi | readonly unknown[],
+    eventName extends ContractEventName<abi> | undefined = undefined,
+    strict extends boolean | undefined = undefined,
+    fromBlock extends BlockNumber | BlockTag | undefined = undefined,
+    toBlock extends BlockNumber | BlockTag | undefined = undefined,
+  >(
+    args: GetContractEventsParameters<
+      abi,
+      eventName,
+      strict,
+      fromBlock,
+      toBlock
+    >,
+  ) => Promise<
+    GetContractEventsReturnType<abi, eventName, strict, fromBlock, toBlock>
+  >
   /**
    * Gets address for ENS name.
    *
@@ -1645,6 +1692,7 @@ export function publicActions<
     getBlockTransactionCount: (args) => getBlockTransactionCount(client, args),
     getBytecode: (args) => getBytecode(client, args),
     getChainId: () => getChainId(client),
+    getContractEvents: (args) => getContractEvents(client, args),
     getEnsAddress: (args) => getEnsAddress(client, args),
     getEnsAvatar: (args) => getEnsAvatar(client, args),
     getEnsName: (args) => getEnsName(client, args),

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.0.0-alpha.10'
+export const version = '2.0.0-alpha.11'

package/index.ts

@@ -868,7 +868,9 @@ export { fromRlp } from './utils/encoding/fromRlp.js'
 export { getAddress } from './utils/address/getAddress.js'
 export { getContractError } from './utils/errors/getContractError.js'
 export { getEventSelector } from './utils/hash/getEventSelector.js'
+export { getEventSignature } from './utils/hash/getEventSignature.js'
 export { getFunctionSelector } from './utils/hash/getFunctionSelector.js'
+export { getFunctionSignature } from './utils/hash/getFunctionSignature.js'
 export { hashMessage } from './utils/signature/hashMessage.js'
 export { isAddress } from './utils/address/isAddress.js'
 export { isAddressEqual } from './utils/address/isAddressEqual.js'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.0.0-alpha.10",
+  "version": "2.0.0-alpha.11",
   "type": "module",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",

package/utils/abi/decodeEventLog.ts

@@ -31,9 +31,9 @@ export type DecodeEventLogParameters<
   strict extends boolean = true,
 > = {
   abi: abi
-  data?: data
+  data?: data | undefined
   eventName?: eventName | ContractEventName<abi>
-  strict?: strict
+  strict?: strict | boolean | undefined
   topics: [signature: Hex, ...args: topics] | []
 }
 

package/utils/hash/getEventSelector.ts

@@ -1,9 +1,10 @@
 import type { AbiEvent } from 'abitype'
-import type { EventDefinition } from '../../types/contract.js'
 
-import { hashAbiItem, hashFunction } from './hashFunction.js'
+import { toBytes } from '../encoding/toBytes.js'
+import { getEventSignature } from './getEventSignature.js'
+import { keccak256 } from './keccak256.js'
 
-export const getEventSelector = (event: EventDefinition | AbiEvent) => {
-  if (typeof event === 'string') return hashFunction(event)
-  return hashAbiItem(event)
-}
+const hash = (value: string) => keccak256(toBytes(value))
+
+export const getEventSelector = (fn: string | AbiEvent) =>
+  hash(getEventSignature(fn))

package/utils/hash/getEventSignature.ts

@@ -0,0 +1,7 @@
+import type { AbiEvent, AbiFunction } from 'abitype'
+
+import { getFunctionSignature } from './getFunctionSignature.js'
+
+export const getEventSignature = (fn: string | AbiEvent) => {
+  return getFunctionSignature(fn as {} as AbiFunction)
+}

package/utils/hash/getFunctionSelector.ts

@@ -1,9 +1,11 @@
 import type { AbiFunction } from 'abitype'
 import { slice } from '../data/slice.js'
 
-import { hashAbiItem, hashFunction } from './hashFunction.js'
+import { toBytes } from '../encoding/toBytes.js'
+import { getFunctionSignature } from './getFunctionSignature.js'
+import { keccak256 } from './keccak256.js'
 
-export const getFunctionSelector = (fn: string | AbiFunction) => {
-  if (typeof fn === 'string') return slice(hashFunction(fn), 0, 4)
-  return slice(hashAbiItem(fn), 0, 4)
-}
+const hash = (value: string) => keccak256(toBytes(value))
+
+export const getFunctionSelector = (fn: string | AbiFunction) =>
+  slice(hash(getFunctionSignature(fn)), 0, 4)

package/utils/hash/getFunctionSignature.ts

@@ -0,0 +1,17 @@
+import type { AbiFunction } from 'abitype'
+
+import { formatAbiItem } from '../abi/formatAbiItem.js'
+import {
+  extractFunctionName,
+  extractFunctionParams,
+} from '../contract/extractFunctionParts.js'
+
+export const getFunctionSignature = (fn: string | AbiFunction) => {
+  if (typeof fn === 'string') {
+    const name = extractFunctionName(fn)
+    const params = extractFunctionParams(fn) || []
+    return `${name}(${params.map(({ type }) => type).join(',')})`
+  }
+
+  return formatAbiItem(fn)
+}

package/utils/hash/hashFunction.ts

@@ -1,19 +1,14 @@
 import type { AbiEvent, AbiFunction } from 'abitype'
 import { formatAbiItem } from '../abi/formatAbiItem.js'
-import {
-  extractFunctionName,
-  extractFunctionParams,
-} from '../contract/extractFunctionParts.js'
 import { toBytes } from '../encoding/toBytes.js'
 
+import { getFunctionSignature } from './getFunctionSignature.js'
 import { keccak256 } from './keccak256.js'
 
 const hash = (value: string) => keccak256(toBytes(value))
 
 export function hashFunction(def: string) {
-  const name = extractFunctionName(def)
-  const params = extractFunctionParams(def) || []
-  return hash(`${name}(${params.map(({ type }) => type).join(',')})`)
+  return hash(getFunctionSignature(def))
 }
 
 export function hashAbiItem(abiItem: AbiFunction | AbiEvent) {