viem 0.0.1-alpha.24 → 0.0.1-alpha.25

package/src/index.ts

@@ -1,172 +1,3 @@
-export type {
-  CallArgs,
-  CallResponse,
-  CreateBlockFilterResponse,
-  CreateContractEventFilterArgs,
-  CreateContractEventFilterResponse,
-  CreateEventFilterArgs,
-  CreateEventFilterResponse,
-  CreatePendingTransactionFilterResponse,
-  EstimateGasArgs,
-  EstimateGasResponse,
-  DeployContractArgs,
-  DeployContractResponse,
-  DropTransactionArgs,
-  GetBalanceArgs,
-  GetBalanceResponse,
-  GetBlockArgs,
-  GetBlockNumberArgs,
-  GetBlockNumberResponse,
-  GetBlockResponse,
-  GetBlockTransactionCountArgs,
-  GetBlockTransactionCountResponse,
-  GetBytecodeArgs,
-  GetBytecodeResponse,
-  GetFeeHistoryArgs,
-  GetFeeHistoryResponse,
-  GetFilterChangesArgs,
-  GetFilterChangesResponse,
-  GetFilterLogsArgs,
-  GetFilterLogsResponse,
-  GetGasPriceResponse,
-  GetLogsArgs,
-  GetLogsResponse,
-  GetPermissionsResponse,
-  GetStorageAtArgs,
-  GetStorageAtResponse,
-  GetTransactionArgs,
-  GetTransactionConfirmationsArgs,
-  GetTransactionConfirmationsResponse,
-  GetTransactionCountArgs,
-  GetTransactionCountResponse,
-  GetTransactionResponse,
-  GetTransactionReceiptArgs,
-  GetTransactionReceiptResponse,
-  ImpersonateAccountArgs,
-  IncreaseTimeArgs,
-  MineArgs,
-  MulticallArgs,
-  OnBlock,
-  OnBlockNumber,
-  OnBlockNumberResponse,
-  OnBlockResponse,
-  OnLogs,
-  OnLogsResponse,
-  OnTransactions,
-  OnTransactionsResponse,
-  ReadContractArgs,
-  ReadContractResponse,
-  ResetArgs,
-  RequestPermissionsResponse,
-  RevertArgs,
-  SendTransactionArgs,
-  SendTransactionResponse,
-  SendUnsignedTransactionArgs,
-  SendUnsignedTransactionResponse,
-  SetBalanceArgs,
-  SetBlockGasLimitArgs,
-  SetCodeArgs,
-  SetCoinbaseArgs,
-  SetIntervalMiningArgs,
-  SetMinGasPriceArgs,
-  SetBlockTimestampIntervalArgs,
-  SetNextBlockTimestampArgs,
-  SetNextBlockBaseFeePerGasArgs,
-  SetNonceArgs,
-  SetStorageAtArgs,
-  SignMessageArgs,
-  SignMessageResponse,
-  SimulateContractArgs,
-  SimulateContractResponse,
-  StopImpersonatingAccountArgs,
-  SwitchChainArgs,
-  UninstallFilterArgs,
-  UninstallFilterResponse,
-  WaitForTransactionReceiptArgs,
-  WaitForTransactionReceiptResponse,
-  WatchAssetArgs,
-  WatchAssetResponse,
-  WatchBlockNumberArgs,
-  WatchBlocksArgs,
-  WatchPendingTransactionsArgs,
-  WatchContractEventArgs,
-  WatchEventArgs,
-  WriteContractArgs,
-  WriteContractResponse,
-} from './actions'
-export {
-  addChain,
-  call,
-  createBlockFilter,
-  createContractEventFilter,
-  createEventFilter,
-  createPendingTransactionFilter,
-  deployContract,
-  dropTransaction,
-  estimateGas,
-  getAccounts,
-  getAutomine,
-  getBalance,
-  getBlock,
-  getBlockNumber,
-  getBlockTransactionCount,
-  getBytecode,
-  getChainId,
-  getFeeHistory,
-  getFilterChanges,
-  getFilterLogs,
-  getGasPrice,
-  getLogs,
-  getPermissions,
-  getStorageAt,
-  getTransaction,
-  getTransactionConfirmations,
-  getTransactionCount,
-  getTransactionReceipt,
-  getTxpoolContent,
-  getTxpoolStatus,
-  impersonateAccount,
-  increaseTime,
-  inspectTxpool,
-  mine,
-  multicall,
-  readContract,
-  removeBlockTimestampInterval,
-  reset,
-  requestAccounts,
-  requestPermissions,
-  revert,
-  sendTransaction,
-  sendUnsignedTransaction,
-  setAutomine,
-  setBalance,
-  setBlockGasLimit,
-  setBlockTimestampInterval,
-  setCode,
-  setCoinbase,
-  setIntervalMining,
-  setLoggingEnabled,
-  setMinGasPrice,
-  setNextBlockBaseFeePerGas,
-  setNextBlockTimestamp,
-  setNonce,
-  setStorageAt,
-  signMessage,
-  simulateContract,
-  snapshot,
-  stopImpersonatingAccount,
-  switchChain,
-  uninstallFilter,
-  waitForTransactionReceipt,
-  watchAsset,
-  watchBlockNumber,
-  watchBlocks,
-  watchPendingTransactions,
-  watchContractEvent,
-  watchEvent,
-  writeContract,
-} from './actions'
-
 export type {
   Client,
   ClientConfig,
@@ -299,91 +130,3 @@ export type {
   TransactionLegacy,
   Uncle,
 } from './types'
-
-export type {
-  DecodeAbiArgs,
-  DecodeErrorResultArgs,
-  DecodeFunctionDataArgs,
-  DecodeFunctionResultArgs,
-  DecodeFunctionResultResponse,
-  EncodeAbiArgs,
-  EncodeDeployDataArgs,
-  EncodeErrorResultArgs,
-  EncodeEventTopicsArgs,
-  EncodeFunctionDataArgs,
-  EncodeFunctionResultArgs,
-  GetContractAddressOptions,
-  GetCreateAddressOptions,
-  GetCreate2AddressOptions,
-  GetAbiItemArgs,
-  EncodeRlpResponse,
-  FormattedBlock,
-  FormattedTransaction,
-  FormattedTransactionRequest,
-} from './utils'
-export {
-  bytesToHex,
-  bytesToString,
-  boolToBytes,
-  boolToHex,
-  bytesToBigint,
-  bytesToBool,
-  bytesToNumber,
-  decodeAbi,
-  decodeBytes,
-  decodeErrorResult,
-  decodeFunctionData,
-  decodeFunctionResult,
-  decodeHex,
-  decodeRlp,
-  encodeAbi,
-  encodeBytes,
-  encodeDeployData,
-  encodeErrorResult,
-  encodeEventTopics,
-  encodeFunctionData,
-  encodeFunctionResult,
-  encodeHex,
-  encodeRlp,
-  etherUnits,
-  getAddress,
-  getContractAddress,
-  getCreateAddress,
-  getCreate2Address,
-  getEventSignature,
-  getFunctionSignature,
-  gweiUnits,
-  formatEther,
-  isAddress,
-  isAddressEqual,
-  isBytes,
-  isHex,
-  hexToBigInt,
-  hexToBool,
-  hexToBytes,
-  hexToString,
-  keccak256,
-  numberToBytes,
-  pad,
-  padBytes,
-  padHex,
-  parseEther,
-  parseGwei,
-  parseUnit,
-  formatBlock,
-  formatGwei,
-  formatTransaction,
-  formatTransactionRequest,
-  formatUnit,
-  hexToNumber,
-  numberToHex,
-  size,
-  slice,
-  sliceBytes,
-  sliceHex,
-  stringToBytes,
-  stringToHex,
-  transactionType,
-  trim,
-  weiUnits,
-} from './utils'

package/src/public.test.ts

@@ -0,0 +1,36 @@
+import { expect, test } from 'vitest'
+
+import * as public_ from './public'
+
+test('exports public actions', () => {
+  expect(Object.keys(public_)).toMatchInlineSnapshot(`
+    [
+      "call",
+      "createBlockFilter",
+      "createPendingTransactionFilter",
+      "estimateGas",
+      "getBalance",
+      "getBlock",
+      "getBlockNumber",
+      "getBlockNumberCache",
+      "getBlockTransactionCount",
+      "getBytecode",
+      "getChainId",
+      "getFeeHistory",
+      "getFilterChanges",
+      "getFilterLogs",
+      "getLogs",
+      "getGasPrice",
+      "getTransaction",
+      "getTransactionConfirmations",
+      "getTransactionCount",
+      "getTransactionReceipt",
+      "uninstallFilter",
+      "waitForTransactionReceipt",
+      "watchBlockNumber",
+      "watchBlocks",
+      "watchEvent",
+      "watchPendingTransactions",
+    ]
+  `)
+})

package/src/public.ts

@@ -2,7 +2,6 @@ export {
   call,
   createBlockFilter,
   createPendingTransactionFilter,
-  deployContract,
   estimateGas,
   getBalance,
   getBlock,
@@ -14,16 +13,17 @@ export {
   getFeeHistory,
   getFilterChanges,
   getFilterLogs,
+  getLogs,
   getGasPrice,
   getTransaction,
   getTransactionConfirmations,
   getTransactionCount,
   getTransactionReceipt,
-  simulateContract,
   uninstallFilter,
   waitForTransactionReceipt,
   watchBlockNumber,
   watchBlocks,
+  watchEvent,
   watchPendingTransactions,
 } from './actions/public'
 export type {
@@ -31,8 +31,6 @@ export type {
   CallResponse,
   CreateBlockFilterResponse,
   CreatePendingTransactionFilterResponse,
-  DeployContractArgs,
-  DeployContractResponse,
   EstimateGasArgs,
   EstimateGasResponse,
   GetBalanceArgs,
@@ -68,8 +66,6 @@ export type {
   OnTransactionsResponse,
   ReplacementReason,
   ReplacementResponse,
-  SimulateContractArgs,
-  SimulateContractResponse,
   UninstallFilterArgs,
   UninstallFilterResponse,
   WaitForTransactionReceiptArgs,

package/src/test.test.ts

@@ -0,0 +1,38 @@
+import { expect, test } from 'vitest'
+
+import * as test_ from './test'
+
+test('exports test actions', () => {
+  expect(Object.keys(test_)).toMatchInlineSnapshot(`
+    [
+      "dropTransaction",
+      "getAutomine",
+      "getTxpoolContent",
+      "getTxpoolStatus",
+      "impersonateAccount",
+      "increaseTime",
+      "inspectTxpool",
+      "mine",
+      "removeBlockTimestampInterval",
+      "reset",
+      "revert",
+      "sendUnsignedTransaction",
+      "setAutomine",
+      "setBalance",
+      "setBlockGasLimit",
+      "setBlockTimestampInterval",
+      "setCode",
+      "setCoinbase",
+      "setIntervalMining",
+      "setLoggingEnabled",
+      "setMinGasPrice",
+      "setNextBlockBaseFeePerGas",
+      "setNextBlockTimestamp",
+      "setNonce",
+      "setStorageAt",
+      "snapshot",
+      "setRpcUrl",
+      "stopImpersonatingAccount",
+    ]
+  `)
+})

package/src/test.ts

@@ -25,6 +25,7 @@ export {
   setNonce,
   setStorageAt,
   snapshot,
+  setRpcUrl,
   stopImpersonatingAccount,
 } from './actions/test'
 export type {

package/src/types/contract.ts

@@ -17,49 +17,135 @@ import type {
   ExtractAbiFunctionNames,
   Narrow,
 } from 'abitype'
-import type { Address } from './misc'
+import type { Address, Hex, LogTopic } from './misc'
 import type { TransactionRequest } from './transaction'
-import type { Trim } from './utils'
+import type { NoUndefined, Prettify, Trim } from './utils'
 
 //////////////////////////////////////////////////////////////////////
 // ABIs
 
 export type AbiItem = Abi[number]
 
+type HashedEventTypes = 'string' | 'bytes' | 'tuple' | `${string}[${string}]`
+
+type EventTopicParam<
+  TPrimitiveType = Hex,
+  TTopic extends LogTopic = LogTopic,
+> = NoUndefined<
+  | (TTopic extends Hex ? TPrimitiveType : undefined)
+  | (TTopic extends Hex[] ? TPrimitiveType[] : undefined)
+  | (TTopic extends null ? null : undefined)
+>
+
+export type AbiEventParameterToPrimitiveType<TParam extends AbiParameter> =
+  EventTopicParam<AbiParameterToPrimitiveType<TParam>>
+
 export type AbiEventParametersToPrimitiveTypes<
   TAbiParameters extends readonly AbiParameter[],
   TBase = TAbiParameters[0] extends { name: string } ? {} : [],
-> = TAbiParameters extends readonly [infer Head, ...infer Tail]
-  ? Head extends { indexed: true }
-    ? Head extends AbiParameter
-      ? Head extends { name: infer Name }
-        ? Name extends string
-          ? {
-              [name in Name]?:
-                | AbiParameterToPrimitiveType<Head>
-                | AbiParameterToPrimitiveType<Head>[]
-                | null
-            } & (Tail extends readonly []
-              ? {}
-              : Tail extends readonly AbiParameter[]
-              ? AbiEventParametersToPrimitiveTypes<Tail>
-              : {})
-          : never
-        : [
-            (
-              | AbiParameterToPrimitiveType<Head>
-              | AbiParameterToPrimitiveType<Head>[]
-              | null
-            ),
-            ...(Tail extends readonly []
-              ? []
-              : Tail extends readonly AbiParameter[]
-              ? AbiEventParametersToPrimitiveTypes<Tail>
-              : []),
-          ]
+> = Prettify<
+  TAbiParameters extends readonly [infer Head, ...infer Tail]
+    ? Head extends { indexed: true }
+      ? Head extends AbiParameter
+        ? Head extends { name: infer Name }
+          ? Name extends string
+            ? {
+                [name in Name]?: AbiEventParameterToPrimitiveType<Head>
+              } & (Tail extends readonly []
+                ? {}
+                : Tail extends readonly AbiParameter[]
+                ? AbiEventParametersToPrimitiveTypes<Tail>
+                : {})
+            : never
+          : [
+              AbiEventParameterToPrimitiveType<Head>,
+              ...(Tail extends readonly []
+                ? []
+                : Tail extends readonly AbiParameter[]
+                ? AbiEventParametersToPrimitiveTypes<Tail>
+                : []),
+            ]
+        : TBase
       : TBase
     : TBase
-  : TBase
+>
+
+export type AbiEventTopicToPrimitiveType<
+  TParam extends AbiParameter,
+  TTopic extends LogTopic,
+  TPrimitiveType = TParam['type'] extends HashedEventTypes
+    ? TTopic
+    : AbiParameterToPrimitiveType<TParam>,
+> = EventTopicParam<TPrimitiveType, TTopic>
+
+export type AbiEventTopicsToPrimitiveTypes<
+  TAbiParameters extends readonly AbiParameter[],
+  TTopics extends LogTopic[] | undefined = undefined,
+  TData extends Hex | undefined = undefined,
+  TBase = TAbiParameters[0] extends { name: string } ? {} : [],
+> = Prettify<
+  TAbiParameters extends readonly [infer Head, ...infer Tail]
+    ? TTopics extends readonly [infer TopicHead, ...infer TopicTail]
+      ? Head extends { indexed: true }
+        ? Head extends AbiParameter
+          ? Head extends { name: infer Name }
+            ? Name extends string
+              ? {
+                  [name in Name]: TopicHead extends LogTopic
+                    ? AbiEventTopicToPrimitiveType<Head, TopicHead>
+                    : never
+                } & (Tail extends readonly []
+                  ? {}
+                  : Tail extends readonly AbiParameter[]
+                  ? TopicTail extends LogTopic[]
+                    ? AbiEventTopicsToPrimitiveTypes<Tail, TopicTail, TData>
+                    : {}
+                  : {})
+              : never
+            : [
+                TopicHead extends LogTopic
+                  ? AbiEventTopicToPrimitiveType<Head, TopicHead>
+                  : never,
+                ...(Tail extends readonly []
+                  ? []
+                  : Tail extends readonly AbiParameter[]
+                  ? TopicTail extends LogTopic[]
+                    ? AbiEventTopicsToPrimitiveTypes<Tail, TopicTail, TData>
+                    : []
+                  : []),
+              ]
+          : TBase
+        : TBase
+      : TTopics extends readonly []
+      ? TData extends Hex
+        ? Head extends AbiParameter
+          ? Head extends { indexed: true }
+            ? Tail extends readonly AbiParameter[]
+              ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
+              : TBase
+            : Head extends { name: infer Name }
+            ? Name extends string
+              ? {
+                  [name in Name]: AbiParameterToPrimitiveType<Head>
+                } & (Tail extends readonly []
+                  ? {}
+                  : Tail extends readonly AbiParameter[]
+                  ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
+                  : {})
+              : never
+            : [
+                AbiParameterToPrimitiveType<Head>,
+                ...(Tail extends readonly []
+                  ? []
+                  : Tail extends readonly AbiParameter[]
+                  ? AbiEventTopicsToPrimitiveTypes<Tail, [], TData>
+                  : []),
+              ]
+          : TBase
+        : TBase
+      : TBase
+    : undefined
+>
 
 export type ExtractArgsFromAbi<
   TAbi extends Abi | readonly unknown[],
@@ -165,6 +251,23 @@ export type ExtractEventArgsFromAbi<
       args?: TArgs
     }
 
+export type ExtractEventArgsFromTopics<
+  TAbi extends Abi | readonly unknown[],
+  TEventName extends string,
+  TTopics extends LogTopic[],
+  TData extends Hex | undefined,
+  TAbiEvent extends AbiEvent & { type: 'event' } = TAbi extends Abi
+    ? ExtractAbiEvent<TAbi, TEventName>
+    : AbiEvent & { type: 'event' },
+  TArgs = AbiEventTopicsToPrimitiveTypes<TAbiEvent['inputs'], TTopics, TData>,
+> = TTopics extends readonly []
+  ? TData extends undefined
+    ? { args?: never }
+    : { args?: TArgs }
+  : {
+      args?: TArgs
+    }
+
 export type ExtractErrorNameFromAbi<
   TAbi extends Abi | readonly unknown[] = Abi,
   TErrorName extends string = string,
@@ -348,15 +451,16 @@ type ExtractArgsFromDefinition<
   : 'Error: Invalid definition was provided.'
 
 export type ExtractArgsFromEventDefinition<
-  TDef,
-  TConfig extends ExtractArgsFromDefinitionConfig = { indexedOnly: true },
-> = ExtractArgsFromDefinition<TDef, TConfig> extends [...args: any]
-  ? ExtractArgsFromDefinition<TDef, TConfig> | []
-  : ExtractArgsFromDefinition<TDef, TConfig>
-
-export type ExtractArgsFromFunctionDefinition<TDef> = ExtractArgsFromDefinition<
-  TDef,
-  { indexedOnly: false }
+  TDef extends EventDefinition | undefined,
+  TConfig extends ExtractArgsFromDefinitionConfig = {
+    indexedOnly: true
+  },
+> = Prettify<
+  TDef extends EventDefinition
+    ? ExtractArgsFromDefinition<TDef, TConfig> extends [...args: any]
+      ? ExtractArgsFromDefinition<TDef, TConfig> | []
+      : ExtractArgsFromDefinition<TDef, TConfig>
+    : undefined
 >
 
 //////////////////////////////////////////////////////////////////////

package/src/types/index.ts

@@ -15,11 +15,11 @@ export type {
   EventDefinition,
   ExtractArgsFromAbi,
   ExtractArgsFromEventDefinition,
-  ExtractArgsFromFunctionDefinition,
   ExtractConstructorArgsFromAbi,
   ExtractErrorArgsFromAbi,
   ExtractErrorNameFromAbi,
   ExtractEventArgsFromAbi,
+  ExtractEventArgsFromTopics,
   ExtractEventNameFromAbi,
   ExtractFunctionNameFromAbi,
   ExtractNameFromAbi,
@@ -78,6 +78,7 @@ export type {
 
 export type {
   PartialBy,
+  Prettify,
   MergeIntersectionProperties,
   OptionalNullable,
 } from './utils'

package/src/types/utils.ts

@@ -29,6 +29,15 @@ export type OptionalNullable<T> = {
   [K in keyof T as T[K] extends NonNullable<unknown> ? never : K]?: T[K]
 }
 
+/**
+ * @description Constructs a type by excluding `undefined` from `T`.
+ *
+ * @example
+ * NoUndefined<string | undefined>
+ * => string
+ */
+export type NoUndefined<T> = T extends undefined ? never : T
+
 /**
  * @description Creates a type that is a partial of T, but with the required keys K.
  *
@@ -38,6 +47,18 @@ export type OptionalNullable<T> = {
  */
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
 
+/**
+ * @description Combines members of an intersection into a readable type.
+ *
+ * @link https://twitter.com/mattpocockuk/status/1622730173446557697?s=20&t=NdpAcmEFXY01xkqU3KO0Mg
+ * @example
+ * Prettify<{ a: string } | { b: string } | { c: number, d: bigint }>
+ * => { a: string, b: string, c: number, d: bigint }
+ */
+export type Prettify<T> = {
+  [K in keyof T]: T[K]
+} & {}
+
 type TrimLeft<T, Chars extends string = ' '> = T extends `${Chars}${infer R}`
   ? TrimLeft<R>
   : T

package/src/utils/abi/decodeErrorResult.test.ts

@@ -222,7 +222,7 @@ test("errors: error doesn't exist", () => {
   ).toThrowErrorMatchingInlineSnapshot(`
     "Encoded error signature \\"0xa3741467\\" not found on ABI.
     Make sure you are using the correct ABI and that the error exists on it.
-    You can look up the signature \\"0xa3741467\\" here: https://sig.eth.samczsun.com/.
+    You can look up the signature here: https://openchain.xyz/signatures?query=0xa3741467.
 
     Docs: https://viem.sh/docs/contract/decodeErrorResult
     Version: viem@1.0.2"