viem 0.0.0-main.20230606T175443 → 0.0.0-main.20230606T201917

package/src/actions/public/watchEvent.ts

@@ -24,15 +24,18 @@ import { uninstallFilter } from './uninstallFilter.js'
 
 export type OnLogsParameter<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TStrict extends boolean | undefined = undefined,
   TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
-> = Log<bigint, number, TAbiEvent, [TAbiEvent], TEventName>[]
+> = Log<bigint, number, TAbiEvent, TStrict, [TAbiEvent], TEventName>[]
 export type OnLogsFn<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TStrict extends boolean | undefined = undefined,
   TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
-> = (logs: OnLogsParameter<TAbiEvent, TEventName>) => void
+> = (logs: OnLogsParameter<TAbiEvent, TStrict, TEventName>) => void
 
 export type WatchEventParameters<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TStrict extends boolean | undefined = undefined,
   TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
 > = {
   /** The address of the contract. */
@@ -45,17 +48,23 @@ 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: OnLogsFn<TAbiEvent, TEventName>
+  onLogs: OnLogsFn<TAbiEvent, TStrict, TEventName>
   /** Polling frequency (in ms). Defaults to Client's pollingInterval config. */
   pollingInterval?: number
 } & (
   | {
       event: TAbiEvent
       args?: MaybeExtractEventArgsFromAbi<[TAbiEvent], TEventName>
+      /**
+       * Whether or not the logs must match the indexed/non-indexed arguments on `event`.
+       * @default false
+       */
+      strict?: TStrict
     }
   | {
       event?: never
       args?: never
+      strict?: never
     }
 )
 
@@ -97,6 +106,7 @@ export function watchEvent<
   TChain extends Chain | undefined,
   TAbiEvent extends AbiEvent | undefined,
   TEventName extends string | undefined,
+  TStrict extends boolean | undefined = undefined,
 >(
   client: PublicClient<Transport, TChain>,
   {
@@ -107,7 +117,8 @@ export function watchEvent<
     onError,
     onLogs,
     pollingInterval = client.pollingInterval,
-  }: WatchEventParameters<TAbiEvent>,
+    strict: strict_,
+  }: WatchEventParameters<TAbiEvent, TStrict>,
 ): WatchEventReturnType {
   const observerId = stringify([
     'watchEvent',
@@ -118,6 +129,7 @@ export function watchEvent<
     event,
     pollingInterval,
   ])
+  const strict = strict_ ?? false
 
   return observe(observerId, { onLogs, onError }, (emit) => {
     let previousBlockNumber: bigint
@@ -132,6 +144,7 @@ export function watchEvent<
               address,
               args,
               event: event!,
+              strict,
             } as unknown as CreateEventFilterParameters)) as unknown as Filter<
               'event',
               [TAbiEvent],

package/src/clients/decorators/public.ts

@@ -199,6 +199,7 @@ import {
 import type { Chain } from '../../types/chain.js'
 import type {
   ContractFunctionConfig,
+  MaybeAbiEventName,
   MaybeExtractEventArgsFromAbi,
 } from '../../types/contract.js'
 import type { FilterType } from '../../types/filter.js'
@@ -277,7 +278,7 @@ export type PublicActions<
     TAbi extends Abi | readonly unknown[],
     TEventName extends string | undefined,
     TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName> | undefined,
-    TStrict extends boolean | undefined,
+    TStrict extends boolean | undefined = undefined,
   >(
     args: CreateContractEventFilterParameters<TAbi, TEventName, TArgs, TStrict>,
   ) => Promise<
@@ -306,10 +307,12 @@ export type PublicActions<
    */
   createEventFilter: <
     TAbiEvent extends AbiEvent | undefined,
-    TStrict extends boolean | undefined,
-    _Abi extends Abi | readonly unknown[],
-    _EventName extends string | undefined,
-    _Args extends MaybeExtractEventArgsFromAbi<_Abi, _EventName> | undefined,
+    TStrict extends boolean | undefined = undefined,
+    _Abi extends Abi | readonly unknown[] = [TAbiEvent],
+    _EventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
+    _Args extends
+      | MaybeExtractEventArgsFromAbi<_Abi, _EventName>
+      | undefined = undefined,
   >(
     args?: CreateEventFilterParameters<
       TAbiEvent,
@@ -804,7 +807,7 @@ export type PublicActions<
     TFilterType extends FilterType,
     TAbi extends Abi | readonly unknown[],
     TEventName extends string | undefined,
-    TStrict extends boolean | undefined,
+    TStrict extends boolean | undefined = undefined,
   >(
     args: GetFilterChangesParameters<TFilterType, TAbi, TEventName, TStrict>,
   ) => Promise<
@@ -839,7 +842,7 @@ export type PublicActions<
   getFilterLogs: <
     TAbi extends Abi | readonly unknown[],
     TEventName extends string | undefined,
-    TStrict extends boolean | undefined,
+    TStrict extends boolean | undefined = undefined,
   >(
     args: GetFilterLogsParameters<TAbi, TEventName, TStrict>,
   ) => Promise<GetFilterLogsReturnType<TAbi, TEventName, TStrict>>
@@ -884,7 +887,7 @@ export type PublicActions<
    */
   getLogs: <
     TAbiEvent extends AbiEvent | undefined,
-    TStrict extends boolean | undefined,
+    TStrict extends boolean | undefined = undefined,
   >(
     args?: GetLogsParameters<TAbiEvent, TStrict>,
   ) => Promise<GetLogsReturnType<TAbiEvent, TStrict>>
@@ -1295,8 +1298,9 @@ export type PublicActions<
   watchContractEvent: <
     TAbi extends Abi | readonly unknown[],
     TEventName extends string,
+    TStrict extends boolean | undefined = undefined,
   >(
-    args: WatchContractEventParameters<TAbi, TEventName>,
+    args: WatchContractEventParameters<TAbi, TEventName, TStrict>,
   ) => WatchContractEventReturnType
   /**
    * Watches and returns emitted [Event Logs](https://viem.sh/docs/glossary/terms.html#event-log).
@@ -1329,8 +1333,11 @@ export type PublicActions<
    *   onLogs: (logs) => console.log(logs),
    * })
    */
-  watchEvent: <TAbiEvent extends AbiEvent | undefined>(
-    args: WatchEventParameters<TAbiEvent>,
+  watchEvent: <
+    TAbiEvent extends AbiEvent | undefined,
+    TStrict extends boolean | undefined = undefined,
+  >(
+    args: WatchEventParameters<TAbiEvent, TStrict>,
   ) => WatchEventReturnType
   /**
    * Watches and returns pending transaction hashes.

package/src/errors/version.ts

@@ -1 +1 @@
-export const version = '0.0.0-main.20230606T175443'
+export const version = '0.0.0-main.20230606T201917'

package/src/types/contract.ts

@@ -223,9 +223,7 @@ export type GetEventArgs<
     | ([TArgs] extends [never] ? true : false)
     | (readonly unknown[] extends TArgs ? true : false),
 > = true extends FailedToParseArgs
-  ? readonly unknown[]
-  : TArgs extends readonly []
-  ? never
+  ? readonly unknown[] | Record<string, unknown>
   : TArgs
 
 export type GetEventArgsFromTopics<
@@ -233,12 +231,13 @@ export type GetEventArgsFromTopics<
   TEventName extends string,
   TTopics extends LogTopic[],
   TData extends Hex | undefined,
+  TStrict extends boolean = true,
   TAbiEvent extends AbiEvent & { type: 'event' } = TAbi extends Abi
     ? ExtractAbiEvent<TAbi, TEventName>
     : AbiEvent & { type: 'event' },
   TArgs = AbiEventParametersToPrimitiveTypes<
     TAbiEvent['inputs'],
-    { EnableUnion: false; IndexedOnly: false; Required: true }
+    { EnableUnion: false; IndexedOnly: false; Required: TStrict }
   >,
 > = TTopics extends readonly []
   ? TData extends undefined

package/src/types/filter.ts

@@ -33,20 +33,20 @@ export type Filter<
           abi: TAbi
           args?: never
           eventName?: never
-          strict?: TStrict
+          strict: TStrict
         }
       : TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName>
       ? {
           abi: TAbi
           args: TArgs
           eventName: TEventName
-          strict?: TStrict
+          strict: TStrict
         }
       : {
           abi: TAbi
           args?: never
           eventName: TEventName
-          strict?: TStrict
+          strict: TStrict
         }
     : {
         abi?: never

package/src/types/log.ts

@@ -11,17 +11,16 @@ import type {
   GetEventArgs,
 } from './contract.js'
 import type { Hash, Hex } from './misc.js'
-import type { MaybeUndefined } from './utils.js'
 
 export type Log<
   TQuantity = bigint,
   TIndex = number,
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TStrict extends boolean | undefined = undefined,
   TAbi extends Abi | readonly unknown[] = [TAbiEvent],
   TEventName extends string | undefined = TAbiEvent extends AbiEvent
     ? TAbiEvent['name']
     : undefined,
-  TStrict extends boolean | undefined = undefined,
 > = {
   /** The address from which this log originated */
   address: Address
@@ -93,13 +92,14 @@ type GetInferredLogValues<
 > = TAbi extends Abi
   ? TEventName extends string
     ? {
-        args: MaybeUndefined<
-          GetEventArgs<
-            TAbi,
-            TEventName,
-            { EnableUnion: false; IndexedOnly: false; Required: true }
-          >,
-          TStrict extends true ? false : true
+        args: GetEventArgs<
+          TAbi,
+          TEventName,
+          {
+            EnableUnion: false
+            IndexedOnly: false
+            Required: TStrict extends boolean ? TStrict : false
+          }
         >
         /** The event name decoded from `topics`. */
         eventName: TEventName
@@ -108,13 +108,14 @@ type GetInferredLogValues<
       }
     : {
         [TName in _EventNames]: {
-          args: MaybeUndefined<
-            GetEventArgs<
-              TAbi,
-              string,
-              { EnableUnion: false; IndexedOnly: false; Required: true }
-            >,
-            TStrict extends true ? false : true
+          args: GetEventArgs<
+            TAbi,
+            string,
+            {
+              EnableUnion: false
+              IndexedOnly: false
+              Required: TStrict extends boolean ? TStrict : false
+            }
           >
           /** The event name decoded from `topics`. */
           eventName: TName

package/src/utils/abi/decodeEventLog.ts

@@ -24,10 +24,12 @@ export type DecodeEventLogParameters<
   TEventName extends string | undefined = string,
   TTopics extends Hex[] = Hex[],
   TData extends Hex | undefined = undefined,
+  TStrict extends boolean = true,
 > = {
   abi: Narrow<TAbi>
   data?: TData
   eventName?: InferEventName<TAbi, TEventName>
+  strict?: TStrict
   topics: [signature: Hex, ...args: TTopics] | []
 }
 
@@ -36,6 +38,7 @@ export type DecodeEventLogReturnType<
   TEventName extends string | undefined = string,
   TTopics extends Hex[] = Hex[],
   TData extends Hex | undefined = undefined,
+  TStrict extends boolean = true,
   _EventNames extends string = TAbi extends Abi
     ? Abi extends TAbi
       ? string
@@ -45,13 +48,13 @@ export type DecodeEventLogReturnType<
   ? Prettify<
       {
         eventName: TEventName
-      } & GetEventArgsFromTopics<TAbi, TEventName, TTopics, TData>
+      } & GetEventArgsFromTopics<TAbi, TEventName, TTopics, TData, TStrict>
     >
   : {
       [TName in _EventNames]: Prettify<
         {
           eventName: TName
-        } & GetEventArgsFromTopics<TAbi, TName, TTopics, TData>
+        } & GetEventArgsFromTopics<TAbi, TName, TTopics, TData, TStrict>
       >
     }[_EventNames]
 
@@ -62,16 +65,20 @@ export function decodeEventLog<
   TEventName extends string | undefined = undefined,
   TTopics extends Hex[] = Hex[],
   TData extends Hex | undefined = undefined,
+  TStrict extends boolean = true,
 >({
   abi,
   data,
+  strict: strict_,
   topics,
 }: DecodeEventLogParameters<
   TAbi,
   TEventName,
   TTopics,
-  TData
->): DecodeEventLogReturnType<TAbi, TEventName, TTopics, TData> {
+  TData,
+  TStrict
+>): DecodeEventLogReturnType<TAbi, TEventName, TTopics, TData, TStrict> {
+  const strict = strict_ ?? true
   const [signature, ...argTopics] = topics
   if (!signature)
     throw new AbiEventSignatureEmptyTopicsError({
@@ -110,39 +117,49 @@ export function decodeEventLog<
   // Decode data (non-indexed args).
   const nonIndexedInputs = inputs.filter((x) => !('indexed' in x && x.indexed))
   if (nonIndexedInputs.length > 0) {
-    if (!data || data === '0x')
+    if (data && data !== '0x') {
+      try {
+        const decodedData = decodeAbiParameters(nonIndexedInputs, data)
+        if (decodedData) {
+          if (isUnnamed) args = [...args, ...decodedData]
+          else {
+            for (let i = 0; i < nonIndexedInputs.length; i++) {
+              args[nonIndexedInputs[i].name!] = decodedData[i]
+            }
+          }
+        }
+      } catch (err) {
+        if (strict) {
+          if (err instanceof AbiDecodingDataSizeTooSmallError)
+            throw new DecodeLogDataMismatch({
+              abiItem,
+              data: err.data,
+              params: err.params,
+              size: err.size,
+            })
+          throw err
+        }
+      }
+    } else if (strict) {
       throw new DecodeLogDataMismatch({
         abiItem,
         data: '0x',
         params: nonIndexedInputs,
         size: 0,
       })
-    try {
-      const decodedData = decodeAbiParameters(nonIndexedInputs, data)
-      if (decodedData) {
-        if (isUnnamed) args = [...args, ...decodedData]
-        else {
-          for (let i = 0; i < nonIndexedInputs.length; i++) {
-            args[nonIndexedInputs[i].name!] = decodedData[i]
-          }
-        }
-      }
-    } catch (err) {
-      if (err instanceof AbiDecodingDataSizeTooSmallError)
-        throw new DecodeLogDataMismatch({
-          abiItem,
-          data: err.data,
-          params: err.params,
-          size: err.size,
-        })
-      throw err
     }
   }
 
   return {
     eventName: name,
     args: Object.values(args).length > 0 ? args : undefined,
-  } as unknown as DecodeEventLogReturnType<TAbi, TEventName, TTopics, TData>
+  } as unknown as DecodeEventLogReturnType<
+    TAbi,
+    TEventName,
+    TTopics,
+    TData,
+    TStrict
+  >
 }
 
 function decodeTopic({ param, value }: { param: AbiParameter; value: Hex }) {

package/src/utils/abi/encodeEventTopics.ts

@@ -66,17 +66,22 @@ export function encodeEventTopics<
     )
     const args_ = Array.isArray(args)
       ? args
-      : indexedInputs?.map((x: any) => (args as any)[x.name]) ?? []
-    topics =
-      indexedInputs?.map((param, i) =>
-        Array.isArray(args_[i])
-          ? args_[i].map((_: any, j: number) =>
-              encodeArg({ param, value: args_[i][j] }),
-            )
-          : args_[i]
-          ? encodeArg({ param, value: args_[i] })
-          : null,
-      ) ?? []
+      : Object.values(args).length > 0
+      ? indexedInputs?.map((x: any) => (args as any)[x.name]) ?? []
+      : []
+
+    if (args_.length > 0) {
+      topics =
+        indexedInputs?.map((param, i) =>
+          Array.isArray(args_[i])
+            ? args_[i].map((_: any, j: number) =>
+                encodeArg({ param, value: args_[i][j] }),
+              )
+            : args_[i]
+            ? encodeArg({ param, value: args_[i] })
+            : null,
+        ) ?? []
+    }
   }
   return [signature, ...topics]
 }

package/src/utils/abi/getAbiItem.ts

@@ -45,6 +45,7 @@ export function getAbiItem<
     }
     if (!abiItem.inputs) continue
     if (abiItem.inputs.length === 0) continue
+    if (abiItem.inputs.length !== args.length) continue
     const matched = (args as readonly unknown[]).every((arg, index) => {
       const abiParameter = 'inputs' in abiItem && abiItem.inputs![index]
       if (!abiParameter) return false