viem 0.0.0-main.20230727T170020 → 0.0.0-main.20230730T155828

package/src/actions/public/getLogs.ts

@@ -1,4 +1,4 @@
-import type { AbiEvent, Address, Narrow } from 'abitype'
+import type { Abi, AbiEvent, Address, Narrow } from 'abitype'
 
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
@@ -25,7 +25,13 @@ import { formatLog } from '../../utils/formatters/log.js'
 
 export type GetLogsParameters<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbiEvents extends
+    | readonly AbiEvent[]
+    | readonly unknown[]
+    | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
   TStrict extends boolean | undefined = undefined,
+  TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  TToBlock extends BlockNumber | BlockTag | undefined = undefined,
   _EventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
 > = {
   /** Address or list of addresses from which logs originated */
@@ -33,7 +39,8 @@ export type GetLogsParameters<
 } & (
   | {
       event: Narrow<TAbiEvent>
-      args?: MaybeExtractEventArgsFromAbi<[TAbiEvent], _EventName>
+      events?: never
+      args?: MaybeExtractEventArgsFromAbi<TAbiEvents, _EventName>
       /**
        * Whether or not the logs must match the indexed/non-indexed arguments on `event`.
        * @default false
@@ -42,6 +49,17 @@ export type GetLogsParameters<
     }
   | {
       event?: never
+      events: Narrow<TAbiEvents>
+      args?: never
+      /**
+       * Whether or not the logs must match the indexed/non-indexed arguments on `event`.
+       * @default false
+       */
+      strict?: TStrict
+    }
+  | {
+      event?: never
+      events?: never
       args?: never
       strict?: never
     }
@@ -49,9 +67,9 @@ export type GetLogsParameters<
   (
     | {
         /** Block number or tag after which to include logs */
-        fromBlock?: BlockNumber<bigint> | BlockTag
+        fromBlock?: TFromBlock | BlockNumber | BlockTag
         /** Block number or tag before which to include logs */
-        toBlock?: BlockNumber<bigint> | BlockTag
+        toBlock?: TToBlock | BlockNumber | BlockTag
         blockHash?: never
       }
     | {
@@ -64,9 +82,18 @@ export type GetLogsParameters<
 
 export type GetLogsReturnType<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbiEvents extends
+    | readonly AbiEvent[]
+    | readonly unknown[]
+    | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
   TStrict extends boolean | undefined = undefined,
+  TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  TToBlock extends BlockNumber | BlockTag | undefined = undefined,
   _EventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
-> = Log<bigint, number, TAbiEvent, TStrict, [TAbiEvent], _EventName>[]
+  _Pending extends boolean =
+    | (TFromBlock extends 'pending' ? true : false)
+    | (TToBlock extends 'pending' ? true : false),
+> = Log<bigint, number, _Pending, TAbiEvent, TStrict, TAbiEvents, _EventName>[]
 
 /**
  * Returns a list of event logs matching the provided parameters.
@@ -92,8 +119,14 @@ export type GetLogsReturnType<
  */
 export async function getLogs<
   TChain extends Chain | undefined,
-  TAbiEvent extends AbiEvent | undefined,
+  TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbiEvents extends
+    | readonly AbiEvent[]
+    | readonly unknown[]
+    | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
   TStrict extends boolean | undefined = undefined,
+  TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  TToBlock extends BlockNumber | BlockTag | undefined = undefined,
 >(
   client: Client<Transport, TChain>,
   {
@@ -102,19 +135,35 @@ export async function getLogs<
     fromBlock,
     toBlock,
     event,
+    events: events_,
     args,
     strict: strict_,
-  }: GetLogsParameters<TAbiEvent, TStrict> = {},
-): Promise<GetLogsReturnType<TAbiEvent, TStrict>> {
+  }: GetLogsParameters<
+    TAbiEvent,
+    TAbiEvents,
+    TStrict,
+    TFromBlock,
+    TToBlock
+  > = {},
+): Promise<
+  GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>
+> {
   const strict = strict_ ?? false
+  const events = events_ ?? (event ? [event] : undefined)
 
   let topics: LogTopic[] = []
-  if (event)
-    topics = encodeEventTopics({
-      abi: [event],
-      eventName: (event as AbiEvent).name,
-      args,
-    } as EncodeEventTopicsParameters)
+  if (events) {
+    topics = [
+      (events as AbiEvent[]).flatMap((event) =>
+        encodeEventTopics({
+          abi: [event],
+          eventName: (event as AbiEvent).name,
+          args,
+        } as EncodeEventTopicsParameters),
+      ),
+    ]
+    if (event) topics = topics[0] as LogTopic[]
+  }
 
   let logs: RpcLog[]
   if (blockHash) {
@@ -140,15 +189,15 @@ export async function getLogs<
   return logs
     .map((log) => {
       try {
-        const { eventName, args } = event
+        const { eventName, args } = events
           ? decodeEventLog({
-              abi: [event] as [AbiEvent],
+              abi: events as Abi,
               data: log.data,
               topics: log.topics as any,
               strict,
             })
           : { eventName: undefined, args: undefined }
-        return formatLog(log, { args, eventName })
+        return formatLog(log, { args, eventName: eventName as string })
       } catch (err) {
         let eventName
         let isUnnamed
@@ -166,5 +215,11 @@ export async function getLogs<
         return formatLog(log, { args: isUnnamed ? [] : {}, eventName })
       }
     })
-    .filter(Boolean) as unknown as GetLogsReturnType<TAbiEvent, TStrict>
+    .filter(Boolean) as unknown as GetLogsReturnType<
+    TAbiEvent,
+    TAbiEvents,
+    TStrict,
+    TFromBlock,
+    TToBlock
+  >
 }

package/src/actions/public/getTransaction.ts

@@ -11,7 +11,7 @@ import {
   formatTransaction,
 } from '../../utils/formatters/transaction.js'
 
-export type GetTransactionParameters =
+export type GetTransactionParameters<TBlockTag extends BlockTag = 'latest'> =
   | {
       /** The block hash */
       blockHash: Hash
@@ -34,7 +34,7 @@ export type GetTransactionParameters =
       blockHash?: never
       blockNumber?: never
       /** The block tag. */
-      blockTag: BlockTag
+      blockTag: TBlockTag | BlockTag
       hash?: never
       /** The index of the transaction on the block. */
       index: number
@@ -48,8 +48,10 @@ export type GetTransactionParameters =
       index?: number
     }
 
-export type GetTransactionReturnType<TChain extends Chain | undefined = Chain> =
-  FormattedTransaction<TChain>
+export type GetTransactionReturnType<
+  TChain extends Chain | undefined = Chain,
+  TBlockTag extends BlockTag = 'latest',
+> = FormattedTransaction<TChain, TBlockTag>
 
 /**
  * Returns information about a [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) given a hash or block identifier.
@@ -75,16 +77,21 @@ export type GetTransactionReturnType<TChain extends Chain | undefined = Chain> =
  *   hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  * })
  */
-export async function getTransaction<TChain extends Chain | undefined>(
+export async function getTransaction<
+  TChain extends Chain | undefined,
+  TBlockTag extends BlockTag = 'latest',
+>(
   client: Client<Transport, TChain>,
   {
     blockHash,
     blockNumber,
-    blockTag = 'latest',
+    blockTag: blockTag_,
     hash,
     index,
-  }: GetTransactionParameters,
-): Promise<GetTransactionReturnType<TChain>> {
+  }: GetTransactionParameters<TBlockTag>,
+): Promise<GetTransactionReturnType<TChain, TBlockTag>> {
+  const blockTag = blockTag_ || 'latest'
+
   const blockNumberHex =
     blockNumber !== undefined ? numberToHex(blockNumber) : undefined
 

package/src/actions/public/watchBlocks.ts

@@ -10,23 +10,35 @@ import { stringify } from '../../utils/stringify.js'
 
 import { type GetBlockReturnType, getBlock } from './getBlock.js'
 
-export type OnBlockParameter<TChain extends Chain | undefined = Chain> =
-  GetBlockReturnType<TChain>
+export type OnBlockParameter<
+  TChain extends Chain | undefined = Chain,
+  TIncludeTransactions extends boolean = false,
+  TBlockTag extends BlockTag = 'latest',
+> = GetBlockReturnType<TChain, TIncludeTransactions, TBlockTag>
 
-export type OnBlock<TChain extends Chain | undefined = Chain> = (
-  block: OnBlockParameter<TChain>,
-  prevBlock: OnBlockParameter<TChain> | undefined,
+export type OnBlock<
+  TChain extends Chain | undefined = Chain,
+  TIncludeTransactions extends boolean = false,
+  TBlockTag extends BlockTag = 'latest',
+> = (
+  block: OnBlockParameter<TChain, TIncludeTransactions, TBlockTag>,
+  prevBlock:
+    | OnBlockParameter<TChain, TIncludeTransactions, TBlockTag>
+    | undefined,
 ) => void
 
-type PollOptions = {
+type PollOptions<
+  TIncludeTransactions extends boolean = false,
+  TBlockTag extends BlockTag = 'latest',
+> = {
   /** The block tag. Defaults to "latest". */
-  blockTag?: BlockTag
+  blockTag?: TBlockTag | BlockTag
   /** Whether or not to emit the missed blocks to the callback. */
   emitMissed?: boolean
   /** Whether or not to emit the block to the callback when the subscription opens. */
   emitOnBegin?: boolean
   /** Whether or not to include transaction data in the response. */
-  includeTransactions?: boolean
+  includeTransactions?: TIncludeTransactions
   /** Polling frequency (in ms). Defaults to the client's pollingInterval config. */
   pollingInterval?: number
 }
@@ -34,9 +46,11 @@ type PollOptions = {
 export type WatchBlocksParameters<
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain,
+  TIncludeTransactions extends boolean = false,
+  TBlockTag extends BlockTag = 'latest',
 > = {
   /** The callback to call when a new block is received. */
-  onBlock: OnBlock<TChain>
+  onBlock: OnBlock<TChain, TIncludeTransactions, TBlockTag>
   /** The callback to call when an error occurred when trying to get for a new block. */
   onError?: (error: Error) => void
 } & (GetTransportConfig<TTransport>['type'] extends 'webSocket'
@@ -50,8 +64,8 @@ export type WatchBlocksParameters<
           poll?: false
           pollingInterval?: never
         }
-      | (PollOptions & { poll?: true })
-  : PollOptions & { poll?: true })
+      | (PollOptions<TIncludeTransactions, TBlockTag> & { poll?: true })
+  : PollOptions<TIncludeTransactions, TBlockTag> & { poll?: true })
 
 export type WatchBlocksReturnType = () => void
 
@@ -83,6 +97,8 @@ export type WatchBlocksReturnType = () => void
 export function watchBlocks<
   TTransport extends Transport,
   TChain extends Chain | undefined,
+  TIncludeTransactions extends boolean = false,
+  TBlockTag extends BlockTag = 'latest',
 >(
   client: Client<TTransport, TChain>,
   {
@@ -91,15 +107,18 @@ export function watchBlocks<
     emitOnBegin = false,
     onBlock,
     onError,
-    includeTransactions = false,
+    includeTransactions: includeTransactions_,
     poll: poll_,
     pollingInterval = client.pollingInterval,
-  }: WatchBlocksParameters<TTransport, TChain>,
+  }: WatchBlocksParameters<TTransport, TChain, TIncludeTransactions, TBlockTag>,
 ): WatchBlocksReturnType {
   const enablePolling =
     typeof poll_ !== 'undefined' ? poll_ : client.transport.type !== 'webSocket'
+  const includeTransactions = includeTransactions_ ?? false
 
-  let prevBlock: GetBlockReturnType<TChain> | undefined
+  let prevBlock:
+    | GetBlockReturnType<TChain, false | TIncludeTransactions, 'latest'>
+    | undefined
 
   const pollBlocks = () => {
     const observerId = stringify([
@@ -132,7 +151,7 @@ export function watchBlocks<
                     blockNumber: i,
                     includeTransactions,
                   })
-                  emit.onBlock(block, prevBlock)
+                  emit.onBlock(block as any, prevBlock as any)
                   prevBlock = block
                 }
               }
@@ -147,8 +166,8 @@ export function watchBlocks<
               // We don't want to emit blocks in the past.
               (block.number && block.number > prevBlock.number)
             ) {
-              emit.onBlock(block, prevBlock)
-              prevBlock = block
+              emit.onBlock(block as any, prevBlock as any)
+              prevBlock = block as any
             }
           } catch (err) {
             emit.onError?.(err as Error)
@@ -174,7 +193,7 @@ export function watchBlocks<
             const format =
               client.chain?.formatters?.block?.format || formatBlock
             const block = format(data.result)
-            onBlock(block, prevBlock)
+            onBlock(block, prevBlock as any)
             prevBlock = block
           },
           onError(error: Error) {

package/src/actions/public/watchContractEvent.ts

@@ -1,4 +1,4 @@
-import type { Abi, Address, ExtractAbiEvent, Narrow } from 'abitype'
+import type { Abi, AbiEvent, Address, ExtractAbiEvent, Narrow } from 'abitype'
 
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
@@ -20,7 +20,7 @@ import {
 } from './createContractEventFilter.js'
 import { getBlockNumber } from './getBlockNumber.js'
 import { getFilterChanges } from './getFilterChanges.js'
-import { type GetLogsParameters, getLogs } from './getLogs.js'
+import { getLogs } from './getLogs.js'
 import { uninstallFilter } from './uninstallFilter.js'
 
 export type WatchContractEventOnLogsParameter<
@@ -28,7 +28,7 @@ export type WatchContractEventOnLogsParameter<
   TEventName extends string = string,
   TStrict extends boolean | undefined = undefined,
 > = TAbi extends Abi
-  ? Log<bigint, number, ExtractAbiEvent<TAbi, TEventName>, TStrict>[]
+  ? Log<bigint, number, false, ExtractAbiEvent<TAbi, TEventName>, TStrict>[]
   : Log[]
 export type WatchContractEventOnLogsFn<
   TAbi extends Abi | readonly unknown[] = readonly unknown[],
@@ -173,8 +173,8 @@ export function watchContractEvent<
                 event: getAbiItem({
                   abi,
                   name: eventName,
-                } as unknown as GetAbiItemParameters),
-              } as unknown as GetLogsParameters)
+                } as unknown as GetAbiItemParameters) as AbiEvent,
+              })
             } else {
               logs = []
             }

package/src/actions/public/watchEvent.ts

@@ -1,4 +1,4 @@
-import type { AbiEvent, Address } from 'abitype'
+import type { AbiEvent, Address, Narrow } from 'abitype'
 
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
@@ -19,24 +19,38 @@ import {
 } from './createEventFilter.js'
 import { getBlockNumber } from './getBlockNumber.js'
 import { getFilterChanges } from './getFilterChanges.js'
-import { getLogs } from './getLogs.js'
+import { type GetLogsParameters, getLogs } from './getLogs.js'
 import { uninstallFilter } from './uninstallFilter.js'
 
 export type WatchEventOnLogsParameter<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbiEvents extends
+    | readonly AbiEvent[]
+    | readonly unknown[]
+    | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
   TStrict extends boolean | undefined = undefined,
   TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
-> = Log<bigint, number, TAbiEvent, TStrict, [TAbiEvent], TEventName>[]
+> = Log<bigint, number, false, TAbiEvent, TStrict, TAbiEvents, TEventName>[]
 export type WatchEventOnLogsFn<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbiEvents extends
+    | readonly AbiEvent[]
+    | readonly unknown[]
+    | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
   TStrict extends boolean | undefined = undefined,
-  TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
-> = (logs: WatchEventOnLogsParameter<TAbiEvent, TStrict, TEventName>) => void
+  _EventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
+> = (
+  logs: WatchEventOnLogsParameter<TAbiEvent, TAbiEvents, TStrict, _EventName>,
+) => void
 
 export type WatchEventParameters<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbiEvents extends
+    | readonly AbiEvent[]
+    | readonly unknown[]
+    | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
   TStrict extends boolean | undefined = undefined,
-  TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
+  _EventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
 > = {
   /** The address of the contract. */
   address?: Address | Address[]
@@ -48,13 +62,24 @@ export type WatchEventParameters<
   /** The callback to call when an error occurred when trying to get for a new block. */
   onError?: (error: Error) => void
   /** The callback to call when new event logs are received. */
-  onLogs: WatchEventOnLogsFn<TAbiEvent, TStrict, TEventName>
+  onLogs: WatchEventOnLogsFn<TAbiEvent, TAbiEvents, TStrict, _EventName>
   /** Polling frequency (in ms). Defaults to Client's pollingInterval config. */
   pollingInterval?: number
 } & (
   | {
-      event: TAbiEvent
-      args?: MaybeExtractEventArgsFromAbi<[TAbiEvent], TEventName>
+      event: Narrow<TAbiEvent>
+      events?: never
+      args?: MaybeExtractEventArgsFromAbi<TAbiEvents, _EventName>
+      /**
+       * Whether or not the logs must match the indexed/non-indexed arguments on `event`.
+       * @default false
+       */
+      strict?: TStrict
+    }
+  | {
+      event?: never
+      events?: Narrow<TAbiEvents>
+      args?: never
       /**
        * Whether or not the logs must match the indexed/non-indexed arguments on `event`.
        * @default false
@@ -63,6 +88,7 @@ export type WatchEventParameters<
     }
   | {
       event?: never
+      events?: never
       args?: never
       strict?: never
     }
@@ -104,9 +130,13 @@ export type WatchEventReturnType = () => void
  */
 export function watchEvent<
   TChain extends Chain | undefined,
-  TAbiEvent extends AbiEvent | undefined,
-  TEventName extends string | undefined,
+  TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbiEvents extends
+    | readonly AbiEvent[]
+    | readonly unknown[]
+    | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
   TStrict extends boolean | undefined = undefined,
+  _EventName extends string | undefined = undefined,
 >(
   client: Client<Transport, TChain>,
   {
@@ -114,11 +144,12 @@ export function watchEvent<
     args,
     batch = true,
     event,
+    events,
     onError,
     onLogs,
     pollingInterval = client.pollingInterval,
     strict: strict_,
-  }: WatchEventParameters<TAbiEvent, TStrict>,
+  }: WatchEventParameters<TAbiEvent, TAbiEvents, TStrict>,
 ): WatchEventReturnType {
   const observerId = stringify([
     'watchEvent',
@@ -133,7 +164,7 @@ export function watchEvent<
 
   return observe(observerId, { onLogs, onError }, (emit) => {
     let previousBlockNumber: bigint
-    let filter: Filter<'event', [TAbiEvent], TEventName, any>
+    let filter: Filter<'event', TAbiEvents, _EventName, any>
     let initialized = false
 
     const unwatch = poll(
@@ -144,11 +175,12 @@ export function watchEvent<
               address,
               args,
               event: event!,
+              events,
               strict,
             } as unknown as CreateEventFilterParameters)) as unknown as Filter<
               'event',
-              [TAbiEvent],
-              TEventName
+              TAbiEvents,
+              _EventName
             >
           } catch {}
           initialized = true
@@ -173,10 +205,11 @@ export function watchEvent<
               logs = await getLogs(client, {
                 address,
                 args,
+                event: event!,
+                events,
                 fromBlock: previousBlockNumber + 1n,
                 toBlock: blockNumber,
-                event: event!,
-              })
+              } as unknown as GetLogsParameters)
             } else {
               logs = []
             }