viem 0.3.16 → 0.3.18

package/src/public.ts

@@ -1,81 +1,125 @@
 export {
   call,
+  type CallParameters,
+  type CallReturnType,
+} from './actions/public/call.js'
+export {
   createBlockFilter,
+  type CreateBlockFilterReturnType,
+} from './actions/public/createBlockFilter.js'
+export {
   createEventFilter,
+  type CreateEventFilterParameters,
+  type CreateEventFilterReturnType,
+} from './actions/public/createEventFilter.js'
+export {
   createPendingTransactionFilter,
+  type CreatePendingTransactionFilterReturnType,
+} from './actions/public/createPendingTransactionFilter.js'
+export {
   estimateGas,
+  type EstimateGasParameters,
+  type EstimateGasReturnType,
+} from './actions/public/estimateGas.js'
+export {
   getBalance,
+  type GetBalanceParameters,
+  type GetBalanceReturnType,
+} from './actions/public/getBalance.js'
+export {
   getBlock,
+  type GetBlockParameters,
+  type GetBlockReturnType,
+} from './actions/public/getBlock.js'
+export {
   getBlockNumber,
   getBlockNumberCache,
+  type GetBlockNumberParameters,
+  type GetBlockNumberReturnType,
+} from './actions/public/getBlockNumber.js'
+export {
   getBlockTransactionCount,
+  type GetBlockTransactionCountParameters,
+  type GetBlockTransactionCountReturnType,
+} from './actions/public/getBlockTransactionCount.js'
+export {
   getBytecode,
-  getChainId,
+  type GetBytecodeParameters,
+  type GetBytecodeReturnType,
+} from './actions/public/getBytecode.js'
+export { getChainId } from './actions/public/getChainId.js'
+export {
   getFeeHistory,
+  type GetFeeHistoryParameters,
+  type GetFeeHistoryReturnType,
+} from './actions/public/getFeeHistory.js'
+export {
   getFilterChanges,
+  type GetFilterChangesParameters,
+  type GetFilterChangesReturnType,
+} from './actions/public/getFilterChanges.js'
+export {
   getFilterLogs,
-  getLogs,
+  type GetFilterLogsParameters,
+  type GetFilterLogsReturnType,
+} from './actions/public/getFilterLogs.js'
+export { getLogs } from './actions/public/getLogs.js'
+export {
   getGasPrice,
+  type GetGasPriceReturnType,
+} from './actions/public/getGasPrice.js'
+export {
   getTransaction,
+  type GetTransactionParameters,
+  type GetTransactionReturnType,
+} from './actions/public/getTransaction.js'
+export {
   getTransactionConfirmations,
+  type GetTransactionConfirmationsParameters,
+  type GetTransactionConfirmationsReturnType,
+} from './actions/public/getTransactionConfirmations.js'
+export {
   getTransactionCount,
+  type GetTransactionCountParameters,
+  type GetTransactionCountReturnType,
+} from './actions/public/getTransactionCount.js'
+export {
   getTransactionReceipt,
+  type GetTransactionReceiptParameters,
+  type GetTransactionReceiptReturnType,
+} from './actions/public/getTransactionReceipt.js'
+export {
   uninstallFilter,
+  type UninstallFilterParameters,
+  type UninstallFilterReturnType,
+} from './actions/public/uninstallFilter.js'
+export {
   waitForTransactionReceipt,
+  type ReplacementReason,
+  type ReplacementReturnType,
+  type WaitForTransactionReceiptParameters,
+  type WaitForTransactionReceiptReturnType,
+} from './actions/public/waitForTransactionReceipt.js'
+export {
   watchBlockNumber,
+  type OnBlockNumberFn,
+  type OnBlockNumberParameter,
+  type WatchBlockNumberParameters,
+} from './actions/public/watchBlockNumber.js'
+export {
   watchBlocks,
+  type OnBlock,
+  type OnBlockParameter,
+  type WatchBlocksParameters,
+} from './actions/public/watchBlocks.js'
+export {
   watchEvent,
+  type OnLogsFn,
+  type OnLogsParameter,
+} from './actions/public/watchEvent.js'
+export {
   watchPendingTransactions,
-} from './actions/public/index.js'
-export type {
-  CallParameters,
-  CallReturnType,
-  CreateBlockFilterReturnType,
-  CreateEventFilterParameters,
-  CreateEventFilterReturnType,
-  CreatePendingTransactionFilterReturnType,
-  EstimateGasParameters,
-  EstimateGasReturnType,
-  GetBalanceParameters,
-  GetBalanceReturnType,
-  GetBlockParameters,
-  GetBlockNumberParameters,
-  GetBlockNumberReturnType,
-  GetBlockReturnType,
-  GetBlockTransactionCountParameters,
-  GetBlockTransactionCountReturnType,
-  GetBytecodeParameters,
-  GetBytecodeReturnType,
-  GetFeeHistoryParameters,
-  GetFeeHistoryReturnType,
-  GetFilterChangesParameters,
-  GetFilterChangesReturnType,
-  GetFilterLogsParameters,
-  GetFilterLogsReturnType,
-  GetGasPriceReturnType,
-  GetTransactionParameters,
-  GetTransactionConfirmationsParameters,
-  GetTransactionConfirmationsReturnType,
-  GetTransactionCountParameters,
-  GetTransactionCountReturnType,
-  GetTransactionReceiptParameters,
-  GetTransactionReceiptReturnType,
-  GetTransactionReturnType,
-  OnBlock,
-  OnBlockNumberFn,
-  OnBlockNumberParameter,
-  OnBlockParameter,
-  OnLogsFn,
-  OnLogsParameter,
-  OnTransactionsFn,
-  OnTransactionsParameter,
-  ReplacementReason,
-  ReplacementReturnType,
-  UninstallFilterParameters,
-  UninstallFilterReturnType,
-  WaitForTransactionReceiptParameters,
-  WaitForTransactionReceiptReturnType,
-  WatchBlockNumberParameters,
-  WatchBlocksParameters,
-  WatchPendingTransactionsParameters,
-} from './actions/public/index.js'
+  type OnTransactionsFn,
+  type OnTransactionsParameter,
+  type WatchPendingTransactionsParameters,
+} from './actions/public/watchPendingTransactions.js'

package/src/test.ts

@@ -1,52 +1,71 @@
 export {
   dropTransaction,
-  getAutomine,
-  getTxpoolContent,
-  getTxpoolStatus,
+  type DropTransactionParameters,
+} from './actions/test/dropTransaction.js'
+export { getAutomine } from './actions/test/getAutomine.js'
+export { getTxpoolContent } from './actions/test/getTxpoolContent.js'
+export { getTxpoolStatus } from './actions/test/getTxpoolStatus.js'
+export {
   impersonateAccount,
+  type ImpersonateAccountParameters,
+} from './actions/test/impersonateAccount.js'
+export {
   increaseTime,
-  inspectTxpool,
-  mine,
-  removeBlockTimestampInterval,
-  reset,
-  revert,
+  type IncreaseTimeParameters,
+} from './actions/test/increaseTime.js'
+export { inspectTxpool } from './actions/test/inspectTxpool.js'
+export { mine, type MineParameters } from './actions/test/mine.js'
+export { removeBlockTimestampInterval } from './actions/test/removeBlockTimestampInterval.js'
+export { reset, type ResetParameters } from './actions/test/reset.js'
+export { revert, type RevertParameters } from './actions/test/revert.js'
+export {
   sendUnsignedTransaction,
-  setAutomine,
+  type SendUnsignedTransactionParameters,
+  type SendUnsignedTransactionReturnType,
+} from './actions/test/sendUnsignedTransaction.js'
+export { setAutomine } from './actions/test/setAutomine.js'
+export {
   setBalance,
+  type SetBalanceParameters,
+} from './actions/test/setBalance.js'
+export {
   setBlockGasLimit,
+  type SetBlockGasLimitParameters,
+} from './actions/test/setBlockGasLimit.js'
+export {
   setBlockTimestampInterval,
-  setCode,
+  type SetBlockTimestampIntervalParameters,
+} from './actions/test/setBlockTimestampInterval.js'
+export { setCode, type SetCodeParameters } from './actions/test/setCode.js'
+export {
   setCoinbase,
+  type SetCoinbaseParameters,
+} from './actions/test/setCoinbase.js'
+export {
   setIntervalMining,
-  setLoggingEnabled,
+  type SetIntervalMiningParameters,
+} from './actions/test/setIntervalMining.js'
+export { setLoggingEnabled } from './actions/test/setLoggingEnabled.js'
+export {
   setMinGasPrice,
+  type SetMinGasPriceParameters,
+} from './actions/test/setMinGasPrice.js'
+export {
   setNextBlockBaseFeePerGas,
+  type SetNextBlockBaseFeePerGasParameters,
+} from './actions/test/setNextBlockBaseFeePerGas.js'
+export {
   setNextBlockTimestamp,
-  setNonce,
+  type SetNextBlockTimestampParameters,
+} from './actions/test/setNextBlockTimestamp.js'
+export { setNonce, type SetNonceParameters } from './actions/test/setNonce.js'
+export {
   setStorageAt,
-  snapshot,
-  setRpcUrl,
+  type SetStorageAtParameters,
+} from './actions/test/setStorageAt.js'
+export { snapshot } from './actions/test/snapshot.js'
+export { setRpcUrl } from './actions/test/setRpcUrl.js'
+export {
   stopImpersonatingAccount,
-} from './actions/test/index.js'
-export type {
-  DropTransactionParameters,
-  ImpersonateAccountParameters,
-  IncreaseTimeParameters,
-  MineParameters,
-  ResetParameters,
-  RevertParameters,
-  SendUnsignedTransactionParameters,
-  SendUnsignedTransactionReturnType,
-  SetBalanceParameters,
-  SetBlockGasLimitParameters,
-  SetBlockTimestampIntervalParameters,
-  SetCodeParameters,
-  SetCoinbaseParameters,
-  SetIntervalMiningParameters,
-  SetMinGasPriceParameters,
-  SetNextBlockBaseFeePerGasParameters,
-  SetNextBlockTimestampParameters,
-  SetNonceParameters,
-  SetStorageAtParameters,
-  StopImpersonatingAccountParameters,
-} from './actions/test/index.js'
+  type StopImpersonatingAccountParameters,
+} from './actions/test/stopImpersonatingAccount.js'

package/src/types/account.ts

@@ -1,18 +1,8 @@
 import type { Address } from 'abitype'
-import type { Account, JsonRpcAccount } from '../accounts/index.js'
-import type { IsUndefined } from './utils.js'
 
-export type {
-  Account,
-  AccountSource,
-  CustomSource,
-  HDAccount,
-  HDKey,
-  HDOptions,
-  JsonRpcAccount,
-  LocalAccount,
-  PrivateKeyAccount,
-} from '../accounts/index.js'
+import type { Account, JsonRpcAccount } from '../accounts/types.js'
+
+import type { IsUndefined } from './utils.js'
 
 export type GetAccountParameter<
   TAccount extends Account | undefined = Account | undefined,
@@ -24,3 +14,15 @@ export type ParseAccount<TAccount extends Account | Address | undefined> =
   | (TAccount extends Account ? TAccount : never)
   | (TAccount extends Address ? JsonRpcAccount : never)
   | (TAccount extends undefined ? undefined : never)
+
+export {
+  type Account,
+  type AccountSource,
+  type CustomSource,
+  type HDAccount,
+  type HDOptions,
+  type JsonRpcAccount,
+  type LocalAccount,
+  type PrivateKeyAccount,
+} from '../accounts/types.js'
+export type { HDKey } from '@scure/bip32'

package/src/types/block.ts

@@ -1,4 +1,5 @@
 import type { Address } from 'abitype'
+
 import type { Hash, Hex } from './misc.js'
 import type { Transaction } from './transaction.js'
 

package/src/types/chain.ts

@@ -1,5 +1,6 @@
 import type { Chain as Chain_ } from '@wagmi/chains'
 import type { Address } from 'abitype'
+
 import type { Formatters } from './formatter.js'
 import type { IsUndefined } from './utils.js'
 

package/src/types/contract.ts

@@ -1,5 +1,6 @@
 import type {
   Abi,
+  AbiConstructor,
   AbiError,
   AbiEvent,
   AbiFunction,
@@ -8,18 +9,18 @@ import type {
   AbiParametersToPrimitiveTypes,
   AbiStateMutability,
   Address,
-  ExtractAbiFunction,
-  ExtractAbiEvent,
-  ExtractAbiEventNames,
   ExtractAbiError,
   ExtractAbiErrorNames,
+  ExtractAbiEvent,
+  ExtractAbiEventNames,
+  ExtractAbiFunction,
   ExtractAbiFunctionNames,
   Narrow,
-  AbiConstructor,
 } from 'abitype'
+
 import type { Hex, LogTopic } from './misc.js'
 import type { TransactionRequest } from './transaction.js'
-import type { Filter, MaybeRequired, NoUndefined } from './utils.js'
+import type { Filter, MaybeRequired, NoUndefined, Prettify } from './utils.js'
 
 export type AbiItem = Abi[number]
 
@@ -82,7 +83,7 @@ export type MaybeExtractEventArgsFromAbi<
 
 export type InferErrorName<
   TAbi extends Abi | readonly unknown[] = Abi,
-  TErrorName extends string = string,
+  TErrorName extends string | undefined = string,
 > = TAbi extends Abi
   ? ExtractAbiErrorNames<TAbi> extends infer AbiErrorNames
     ?
@@ -103,7 +104,7 @@ export type InferEventName<
 
 export type InferFunctionName<
   TAbi extends Abi | readonly unknown[] = Abi,
-  TFunctionName extends string = string,
+  TFunctionName extends string | undefined = string,
   TAbiStateMutability extends AbiStateMutability = AbiStateMutability,
 > = TAbi extends Abi
   ? ExtractAbiFunctionNames<
@@ -240,7 +241,7 @@ export type GetEventArgsFromTopics<
   ? TData extends undefined
     ? { args?: never }
     : { args?: TArgs }
-  : { args?: TArgs }
+  : { args: TArgs }
 
 //////////////////////////////////////////////////////////////////////
 // ABI event types
@@ -362,63 +363,65 @@ export type AbiEventTopicsToPrimitiveTypes<
   TTopics extends LogTopic[] | undefined = undefined,
   TData extends Hex | undefined = undefined,
   TBase = TAbiParameters[0] extends { name: string } ? {} : [],
-> = TAbiParameters extends readonly [
-  infer Head extends AbiParameter,
-  ...infer Tail,
-]
-  ? TTopics extends readonly [infer TopicHead, ...infer TopicTail]
-    ? Head extends { indexed: true }
-      ? Head extends { name: infer Name extends string }
-        ? {
-            [_ in Name]: TopicHead extends LogTopic
-              ? AbiEventTopicToPrimitiveType<Head, TopicHead>
-              : never
-          } & (Tail extends readonly []
-            ? {}
-            : Tail extends readonly AbiParameter[]
-            ? TopicTail extends LogTopic[]
-              ? AbiEventTopicsToPrimitiveTypes<Tail, TopicTail, TData>
-              : {}
-            : {})
-        : [
-            TopicHead extends LogTopic
-              ? AbiEventTopicToPrimitiveType<Head, TopicHead>
-              : never,
-            ...(Tail extends readonly []
-              ? []
-              : Tail extends readonly AbiParameter[]
-              ? TopicTail extends LogTopic[]
-                ? AbiEventTopicsToPrimitiveTypes<Tail, TopicTail, TData>
-                : []
-              : []),
-          ]
-      : TBase
-    : TTopics extends readonly []
-    ? TData extends '0x'
-      ? TBase
-      : TData extends Hex
-      ? Head extends AbiParameter
-        ? Head extends { indexed: true }
-          ? Tail extends readonly AbiParameter[]
-            ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
-            : TBase
-          : Head extends { name: infer Name extends string }
+> = Prettify<
+  TAbiParameters extends readonly [
+    infer Head extends AbiParameter,
+    ...infer Tail,
+  ]
+    ? TTopics extends readonly [infer TopicHead, ...infer TopicTail]
+      ? Head extends { indexed: true }
+        ? Head extends { name: infer Name extends string }
           ? {
-              [_ in Name]: AbiParameterToPrimitiveType<Head>
+              [_ in Name]: TopicHead extends LogTopic
+                ? AbiEventTopicToPrimitiveType<Head, TopicHead>
+                : never
             } & (Tail extends readonly []
               ? {}
               : Tail extends readonly AbiParameter[]
-              ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
+              ? TopicTail extends LogTopic[]
+                ? AbiEventTopicsToPrimitiveTypes<Tail, TopicTail, TData>
+                : {}
               : {})
           : [
-              AbiParameterToPrimitiveType<Head>,
+              TopicHead extends LogTopic
+                ? AbiEventTopicToPrimitiveType<Head, TopicHead>
+                : never,
               ...(Tail extends readonly []
                 ? []
                 : Tail extends readonly AbiParameter[]
-                ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
+                ? TopicTail extends LogTopic[]
+                  ? AbiEventTopicsToPrimitiveTypes<Tail, TopicTail, TData>
+                  : []
                 : []),
             ]
         : TBase
+      : TTopics extends readonly []
+      ? TData extends '0x'
+        ? TBase
+        : TData extends Hex
+        ? Head extends AbiParameter
+          ? Head extends { indexed: true }
+            ? Tail extends readonly AbiParameter[]
+              ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
+              : TBase
+            : Head extends { name: infer Name extends string }
+            ? {
+                [_ in Name]: AbiParameterToPrimitiveType<Head>
+              } & (Tail extends readonly []
+                ? {}
+                : Tail extends readonly AbiParameter[]
+                ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
+                : {})
+            : [
+                AbiParameterToPrimitiveType<Head>,
+                ...(Tail extends readonly []
+                  ? []
+                  : Tail extends readonly AbiParameter[]
+                  ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
+                  : []),
+              ]
+          : TBase
+        : TBase
       : TBase
-    : TBase
-  : undefined
+    : undefined
+>

package/src/types/eip1193.ts

@@ -1,13 +1,14 @@
 import type { Address } from 'abitype'
+
 import type { BlockTag } from './block.js'
 import type { Hash, Hex, LogTopic } from './misc.js'
 import type {
+  Quantity,
   RpcBlock as Block,
   RpcBlockIdentifier as BlockIdentifier,
   RpcBlockNumber as BlockNumber,
   RpcFeeHistory as FeeHistory,
   RpcLog as Log,
-  Quantity,
   RpcTransaction as Transaction,
   RpcTransactionReceipt as TransactionReceipt,
   RpcTransactionRequest as TransactionRequest,
@@ -208,7 +209,7 @@ export type PublicRequests = {
     method: 'eth_call'
     params: [
       request: Partial<TransactionRequest>,
-      block: BlockNumber | BlockTag | BlockIdentifier,
+      block?: BlockNumber | BlockTag | BlockIdentifier,
     ]
   }): Promise<Hex>
   request(args: {
@@ -234,7 +235,7 @@ export type PublicRequests = {
      * // => '0x5208'
      * */
     method: 'eth_estimateGas'
-    params: [parameters: TransactionRequest, block: BlockNumber | BlockTag]
+    params: [parameters: TransactionRequest, block?: BlockNumber | BlockTag]
   }): Promise<Quantity>
   request(args: {
     /**

package/src/types/filter.ts

@@ -1,7 +1,8 @@
 import type { Abi } from 'abitype'
+
 import type { MaybeExtractEventArgsFromAbi } from './contract.js'
-import type { Hex } from './misc.js'
 import type { Requests } from './eip1193.js'
+import type { Hex } from './misc.js'
 
 export type FilterType = 'transaction' | 'block' | 'event'
 

package/src/types/log.ts

@@ -1,34 +1,16 @@
-import type { Abi, AbiEvent, Address, ExtractAbiEventNames } from 'abitype'
-import type { GetEventArgs } from './contract.js'
-import type { Hash, Hex } from './misc.js'
+import type {
+  Abi,
+  AbiEvent,
+  Address,
+  ExtractAbiEvent,
+  ExtractAbiEventNames,
+} from 'abitype'
 
-type DecodedAbiEvent<
-  TAbiEvent extends AbiEvent | undefined = undefined,
-  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
-  TEventName extends string | undefined = TAbiEvent extends AbiEvent
-    ? TAbiEvent['name']
-    : undefined,
-> = TAbi extends Abi
-  ? TEventName extends string
-    ? {
-        args: GetEventArgs<
-          TAbi,
-          TEventName,
-          { EnableUnion: false; IndexedOnly: false; Required: true }
-        >
-        /** The event name decoded from `topics`. */
-        eventName: TEventName
-      }
-    : {
-        args: GetEventArgs<
-          TAbi,
-          string,
-          { EnableUnion: false; IndexedOnly: false; Required: true }
-        >
-        /** The event name decoded from `topics`. */
-        eventName: ExtractAbiEventNames<TAbi>
-      }
-  : {}
+import type {
+  AbiEventParametersToPrimitiveTypes,
+  GetEventArgs,
+} from './contract.js'
+import type { Hash, Hex } from './misc.js'
 
 export type Log<
   TQuantity = bigint,
@@ -53,8 +35,84 @@ export type Log<
   transactionHash: Hash | null
   /** Index of the transaction that created this log or `null` if pending */
   transactionIndex: TIndex | null
-  /** List of order-dependent topics */
-  topics: [Hex, ...Hex[]] | []
   /** `true` if this filter has been destroyed and is invalid */
   removed: boolean
-} & DecodedAbiEvent<TAbiEvent, TAbi, TEventName>
+} & GetInferredLogValues<TAbiEvent, TAbi, TEventName>
+
+type Topics<
+  THead extends AbiEvent['inputs'],
+  TBase = [Hex],
+> = THead extends readonly [
+  infer _Head,
+  ...infer Tail extends AbiEvent['inputs'],
+]
+  ? _Head extends { indexed: true }
+    ? [Hex, ...Topics<Tail>]
+    : Topics<Tail>
+  : TBase
+
+type GetTopics<
+  TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
+  TEventName extends string | undefined = TAbiEvent extends AbiEvent
+    ? TAbiEvent['name']
+    : undefined,
+  _AbiEvent extends AbiEvent | undefined = TAbi extends Abi
+    ? TEventName extends string
+      ? ExtractAbiEvent<TAbi, TEventName>
+      : undefined
+    : undefined,
+  _Args = _AbiEvent extends AbiEvent
+    ? AbiEventParametersToPrimitiveTypes<_AbiEvent['inputs']>
+    : never,
+  _FailedToParseArgs =
+    | ([_Args] extends [never] ? true : false)
+    | (readonly unknown[] extends _Args ? true : false),
+> = true extends _FailedToParseArgs
+  ? [Hex, ...Hex[]] | []
+  : TAbiEvent extends AbiEvent
+  ? Topics<TAbiEvent['inputs']>
+  : _AbiEvent extends AbiEvent
+  ? Topics<_AbiEvent['inputs']>
+  : [Hex, ...Hex[]] | []
+
+type GetInferredLogValues<
+  TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
+  TEventName extends string | undefined = TAbiEvent extends AbiEvent
+    ? TAbiEvent['name']
+    : undefined,
+  _EventNames extends string = TAbi extends Abi
+    ? Abi extends TAbi
+      ? string
+      : ExtractAbiEventNames<TAbi>
+    : string,
+> = TAbi extends Abi
+  ? TEventName extends string
+    ? {
+        args: GetEventArgs<
+          TAbi,
+          TEventName,
+          { EnableUnion: false; IndexedOnly: false; Required: true }
+        >
+        /** The event name decoded from `topics`. */
+        eventName: TEventName
+        /** List of order-dependent topics */
+        topics: GetTopics<TAbiEvent, TAbi, TEventName>
+      }
+    : {
+        [TName in _EventNames]: {
+          args: GetEventArgs<
+            TAbi,
+            string,
+            { EnableUnion: false; IndexedOnly: false; Required: true }
+          >
+          /** The event name decoded from `topics`. */
+          eventName: TName
+          /** List of order-dependent topics */
+          topics: GetTopics<TAbiEvent, TAbi, TName>
+        }
+      }[_EventNames]
+  : {
+      topics: [Hex, ...Hex[]] | []
+    }