viem 1.1.0 → 1.1.1

package/src/errors/version.ts

@@ -1 +1 @@
-export const version = '1.1.0'
+export const version = '1.1.1'

package/src/index.ts

@@ -512,6 +512,7 @@ export {
   defineBlock,
   formatBlock,
 } from './utils/formatters/block.js'
+export { formatLog } from './utils/formatters/log.js'
 export {
   type DecodeAbiParametersReturnType,
   decodeAbiParameters,

package/src/types/formatter.ts

@@ -1,14 +1,15 @@
 import type { Chain } from './chain.js'
 
-export type Formatter<TSource = any, TTarget = any> = (
-  value: TSource,
-) => TTarget
+export type Formatter<TType extends string = string> = {
+  format: (args: any) => any
+  type: TType
+}
 
 export type Formatters = {
-  block?: Formatter
-  transaction?: Formatter
-  transactionReceipt?: Formatter
-  transactionRequest?: Formatter
+  block?: Formatter<'block'>
+  transaction?: Formatter<'transaction'>
+  transactionReceipt?: Formatter<'transactionReceipt'>
+  transactionRequest?: Formatter<'transactionRequest'>
 }
 
 export type ExtractFormatterParameters<
@@ -17,7 +18,7 @@ export type ExtractFormatterParameters<
   TFallback,
 > = TChain extends Chain<infer _Formatters extends Formatters>
   ? _Formatters[TType] extends Formatter
-    ? Parameters<_Formatters[TType]>[0]
+    ? Parameters<_Formatters[TType]['format']>[0]
     : TFallback
   : TFallback
 
@@ -27,6 +28,6 @@ export type ExtractFormatterReturnType<
   TFallback,
 > = TChain extends Chain<infer _Formatters extends Formatters>
   ? _Formatters[TType] extends Formatter
-    ? ReturnType<_Formatters[TType]>
+    ? ReturnType<_Formatters[TType]['format']>
     : TFallback
   : TFallback

package/src/types/serializer.ts

@@ -12,7 +12,7 @@ export type Serializers<
     TFormatters extends Formatters
       ? TFormatters['transactionRequest'] extends Formatter
         ? TransactionSerializableGeneric &
-            Parameters<TFormatters['transactionRequest']>[0]
+            Parameters<TFormatters['transactionRequest']['format']>[0]
         : TransactionSerializable
       : TransactionSerializable
   >

package/src/utils/formatters/block.ts

@@ -34,4 +34,4 @@ export function formatBlock(block: Partial<RpcBlock>) {
   } as Block
 }
 
-export const defineBlock = /*#__PURE__*/ defineFormatter(formatBlock)
+export const defineBlock = /*#__PURE__*/ defineFormatter('block', formatBlock)

package/src/utils/formatters/extract.ts

@@ -5,10 +5,10 @@ import type { Formatter } from '../../types/formatter.js'
  */
 export function extract(
   value: Record<string, unknown>,
-  { formatter }: { formatter?: Formatter },
+  { format }: { format?: Formatter['format'] },
 ) {
-  if (!formatter) return {}
-  const keys = Object.keys(formatter({}))
+  if (!format) return {}
+  const keys = Object.keys(format({}))
   return keys.reduce((data, key) => {
     if (value?.hasOwnProperty(key)) {
       ;(data as any)[key] = value[key]

package/src/utils/formatters/formatter.ts

@@ -1,6 +1,7 @@
 import type { Assign, Prettify } from '../../types/utils.js'
 
-export function defineFormatter<TParameters, TReturnType>(
+export function defineFormatter<TType extends string, TParameters, TReturnType>(
+  type: TType,
   format: (_: TParameters) => TReturnType,
 ) {
   return <
@@ -14,19 +15,22 @@ export function defineFormatter<TParameters, TReturnType>(
     exclude?: TExclude
     format: (_: TOverrideParameters) => TOverrideReturnType
   }) => {
-    return (args: TParameters & TOverrideParameters) => {
-      const formatted = format(args)
-      if (exclude) {
-        for (const key of exclude) {
-          delete (formatted as any)[key]
+    return {
+      format: (args: TParameters & TOverrideParameters) => {
+        const formatted = format(args)
+        if (exclude) {
+          for (const key of exclude) {
+            delete (formatted as any)[key]
+          }
         }
-      }
-      return {
-        ...formatted,
-        ...overrides(args),
-      } as Prettify<Assign<TReturnType, TOverrideReturnType>> & {
-        [K in TExclude[number]]: never
-      }
+        return {
+          ...formatted,
+          ...overrides(args),
+        } as Prettify<Assign<TReturnType, TOverrideReturnType>> & {
+          [K in TExclude[number]]: never
+        }
+      },
+      type,
     }
   }
 }

package/src/utils/formatters/transaction.ts

@@ -54,5 +54,7 @@ export function formatTransaction(transaction: Partial<RpcTransaction>) {
   return transaction_ as Transaction
 }
 
-export const defineTransaction =
-  /*#__PURE__*/ defineFormatter(formatTransaction)
+export const defineTransaction = /*#__PURE__*/ defineFormatter(
+  'transaction',
+  formatTransaction,
+)

package/src/utils/formatters/transactionReceipt.ts

@@ -56,5 +56,6 @@ export function formatTransactionReceipt(
 }
 
 export const defineTransactionReceipt = /*#__PURE__*/ defineFormatter(
+  'transactionReceipt',
   formatTransactionReceipt,
 )

package/src/utils/formatters/transactionRequest.ts

@@ -42,5 +42,6 @@ export function formatTransactionRequest(
 }
 
 export const defineTransactionRequest = /*#__PURE__*/ defineFormatter(
+  'transactionRequest',
   formatTransactionRequest,
 )

package/src/utils/index.ts

@@ -128,6 +128,7 @@ export {
   formatTransaction,
   transactionType,
 } from './formatters/transaction.js'
+export { formatLog } from './formatters/log.js'
 export {
   type FormattedTransactionReceipt,
   defineTransactionReceipt,