viem 1.4.2 → 1.5.2

package/src/clients/decorators/public.ts

@@ -197,6 +197,7 @@ import {
   watchPendingTransactions,
 } from '../../actions/public/watchPendingTransactions.js'
 import type { Account } from '../../types/account.js'
+import type { BlockNumber, BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
 import type {
   ContractFunctionConfig,
@@ -281,10 +282,26 @@ export type PublicActions<
     TEventName extends string | undefined,
     TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName> | undefined,
     TStrict extends boolean | undefined = undefined,
+    TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+    TToBlock extends BlockNumber | BlockTag | undefined = undefined,
   >(
-    args: CreateContractEventFilterParameters<TAbi, TEventName, TArgs, TStrict>,
+    args: CreateContractEventFilterParameters<
+      TAbi,
+      TEventName,
+      TArgs,
+      TStrict,
+      TFromBlock,
+      TToBlock
+    >,
   ) => Promise<
-    CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict>
+    CreateContractEventFilterReturnType<
+      TAbi,
+      TEventName,
+      TArgs,
+      TStrict,
+      TFromBlock,
+      TToBlock
+    >
   >
   /**
    * Creates a [`Filter`](https://viem.sh/docs/glossary/types.html#filter) to listen for new events that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html).
@@ -308,23 +325,38 @@ export type PublicActions<
    * })
    */
   createEventFilter: <
-    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,
-    _Abi extends Abi | readonly unknown[] = [TAbiEvent],
+    TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+    TToBlock extends BlockNumber | BlockTag | undefined = undefined,
     _EventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
     _Args extends
-      | MaybeExtractEventArgsFromAbi<_Abi, _EventName>
+      | MaybeExtractEventArgsFromAbi<TAbiEvents, _EventName>
       | undefined = undefined,
   >(
     args?: CreateEventFilterParameters<
       TAbiEvent,
+      TAbiEvents,
       TStrict,
-      _Abi,
+      TFromBlock,
+      TToBlock,
       _EventName,
       _Args
     >,
   ) => Promise<
-    CreateEventFilterReturnType<TAbiEvent, TStrict, _Abi, _EventName, _Args>
+    CreateEventFilterReturnType<
+      TAbiEvent,
+      TAbiEvents,
+      TStrict,
+      TFromBlock,
+      TToBlock,
+      _EventName,
+      _Args
+    >
   >
   /**
    * Creates a Filter to listen for new pending transaction hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html).
@@ -462,7 +494,12 @@ export type PublicActions<
    * })
    * const block = await client.getBlock()
    */
-  getBlock: (args?: GetBlockParameters) => Promise<GetBlockReturnType<TChain>>
+  getBlock: <
+    TIncludeTransactions extends boolean = false,
+    TBlockTag extends BlockTag = 'latest',
+  >(
+    args?: GetBlockParameters<TIncludeTransactions, TBlockTag>,
+  ) => Promise<GetBlockReturnType<TChain, TIncludeTransactions, TBlockTag>>
   /**
    * Returns the number of the most recent block seen.
    *
@@ -807,13 +844,29 @@ export type PublicActions<
    */
   getFilterChanges: <
     TFilterType extends FilterType,
-    TAbi extends Abi | readonly unknown[],
+    TAbi extends Abi | readonly unknown[] | undefined,
     TEventName extends string | undefined,
     TStrict extends boolean | undefined = undefined,
+    TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+    TToBlock extends BlockNumber | BlockTag | undefined = undefined,
   >(
-    args: GetFilterChangesParameters<TFilterType, TAbi, TEventName, TStrict>,
+    args: GetFilterChangesParameters<
+      TFilterType,
+      TAbi,
+      TEventName,
+      TStrict,
+      TFromBlock,
+      TToBlock
+    >,
   ) => Promise<
-    GetFilterChangesReturnType<TFilterType, TAbi, TEventName, TStrict>
+    GetFilterChangesReturnType<
+      TFilterType,
+      TAbi,
+      TEventName,
+      TStrict,
+      TFromBlock,
+      TToBlock
+    >
   >
   /**
    * Returns a list of event logs since the filter was created.
@@ -842,12 +895,22 @@ export type PublicActions<
    * const logs = await client.getFilterLogs({ filter })
    */
   getFilterLogs: <
-    TAbi extends Abi | readonly unknown[],
+    TAbi extends Abi | readonly unknown[] | undefined,
     TEventName extends string | undefined,
     TStrict extends boolean | undefined = undefined,
+    TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+    TToBlock extends BlockNumber | BlockTag | undefined = undefined,
   >(
-    args: GetFilterLogsParameters<TAbi, TEventName, TStrict>,
-  ) => Promise<GetFilterLogsReturnType<TAbi, TEventName, TStrict>>
+    args: GetFilterLogsParameters<
+      TAbi,
+      TEventName,
+      TStrict,
+      TFromBlock,
+      TToBlock
+    >,
+  ) => Promise<
+    GetFilterLogsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>
+  >
   /**
    * Returns the current price of gas (in wei).
    *
@@ -888,11 +951,25 @@ export type PublicActions<
    * const logs = await client.getLogs()
    */
   getLogs: <
-    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,
   >(
-    args?: GetLogsParameters<TAbiEvent, TStrict>,
-  ) => Promise<GetLogsReturnType<TAbiEvent, TStrict>>
+    args?: GetLogsParameters<
+      TAbiEvent,
+      TAbiEvents,
+      TStrict,
+      TFromBlock,
+      TToBlock
+    >,
+  ) => Promise<
+    GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>
+  >
   /**
    * Returns the value from a storage slot at a given address.
    *
@@ -941,9 +1018,9 @@ export type PublicActions<
    *   hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
    * })
    */
-  getTransaction: (
-    args: GetTransactionParameters,
-  ) => Promise<GetTransactionReturnType<TChain>>
+  getTransaction: <TBlockTag extends BlockTag = 'latest'>(
+    args: GetTransactionParameters<TBlockTag>,
+  ) => Promise<GetTransactionReturnType<TChain, TBlockTag>>
   /**
    * Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
    *
@@ -1265,8 +1342,16 @@ export type PublicActions<
    *   onBlock: (block) => console.log(block),
    * })
    */
-  watchBlocks: (
-    args: WatchBlocksParameters<TTransport, TChain>,
+  watchBlocks: <
+    TIncludeTransactions extends boolean = false,
+    TBlockTag extends BlockTag = 'latest',
+  >(
+    args: WatchBlocksParameters<
+      TTransport,
+      TChain,
+      TIncludeTransactions,
+      TBlockTag
+    >,
   ) => WatchBlocksReturnType
   /**
    * Watches and returns emitted contract event logs.
@@ -1336,10 +1421,14 @@ export type PublicActions<
    * })
    */
   watchEvent: <
-    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,
   >(
-    args: WatchEventParameters<TAbiEvent, TStrict>,
+    args: WatchEventParameters<TAbiEvent, TAbiEvents, TStrict>,
   ) => WatchEventReturnType
   /**
    * Watches and returns pending transaction hashes.
@@ -1406,7 +1495,7 @@ export function publicActions<
     getFilterChanges: (args) => getFilterChanges(client, args),
     getFilterLogs: (args) => getFilterLogs(client, args),
     getGasPrice: () => getGasPrice(client),
-    getLogs: (args) => getLogs(client, args),
+    getLogs: (args) => getLogs(client, args as any),
     getStorageAt: (args) => getStorageAt(client, args),
     getTransaction: (args) => getTransaction(client, args),
     getTransactionConfirmations: (args) =>

package/src/constants/number.ts

@@ -0,0 +1,98 @@
+export const maxInt8 = 2n ** (8n - 1n)
+export const maxInt16 = 2n ** (16n - 1n)
+export const maxInt24 = 2n ** (24n - 1n)
+export const maxInt32 = 2n ** (32n - 1n)
+export const maxInt40 = 2n ** (40n - 1n)
+export const maxInt48 = 2n ** (48n - 1n)
+export const maxInt56 = 2n ** (56n - 1n)
+export const maxInt64 = 2n ** (64n - 1n)
+export const maxInt72 = 2n ** (72n - 1n)
+export const maxInt80 = 2n ** (80n - 1n)
+export const maxInt88 = 2n ** (88n - 1n)
+export const maxInt96 = 2n ** (96n - 1n)
+export const maxInt104 = 2n ** (104n - 1n)
+export const maxInt112 = 2n ** (112n - 1n)
+export const maxInt120 = 2n ** (120n - 1n)
+export const maxInt128 = 2n ** (128n - 1n)
+export const maxInt136 = 2n ** (136n - 1n)
+export const maxInt144 = 2n ** (144n - 1n)
+export const maxInt152 = 2n ** (152n - 1n)
+export const maxInt160 = 2n ** (160n - 1n)
+export const maxInt168 = 2n ** (168n - 1n)
+export const maxInt176 = 2n ** (176n - 1n)
+export const maxInt184 = 2n ** (184n - 1n)
+export const maxInt192 = 2n ** (192n - 1n)
+export const maxInt200 = 2n ** (200n - 1n)
+export const maxInt208 = 2n ** (208n - 1n)
+export const maxInt216 = 2n ** (216n - 1n)
+export const maxInt224 = 2n ** (224n - 1n)
+export const maxInt232 = 2n ** (232n - 1n)
+export const maxInt240 = 2n ** (240n - 1n)
+export const maxInt248 = 2n ** (248n - 1n)
+export const maxInt256 = 2n ** (256n - 1n)
+
+export const minInt8 = -(2n ** 8n)
+export const minInt16 = -(2n ** 16n)
+export const minInt24 = -(2n ** 24n)
+export const minInt32 = -(2n ** 32n)
+export const minInt40 = -(2n ** 40n)
+export const minInt48 = -(2n ** 48n)
+export const minInt56 = -(2n ** 56n)
+export const minInt64 = -(2n ** 64n)
+export const minInt72 = -(2n ** 72n)
+export const minInt80 = -(2n ** 80n)
+export const minInt88 = -(2n ** 88n)
+export const minInt96 = -(2n ** 96n)
+export const minInt104 = -(2n ** 104n)
+export const minInt112 = -(2n ** 112n)
+export const minInt120 = -(2n ** 120n)
+export const minInt128 = -(2n ** 128n)
+export const minInt136 = -(2n ** 136n)
+export const minInt144 = -(2n ** 144n)
+export const minInt152 = -(2n ** 152n)
+export const minInt160 = -(2n ** 160n)
+export const minInt168 = -(2n ** 168n)
+export const minInt176 = -(2n ** 176n)
+export const minInt184 = -(2n ** 184n)
+export const minInt192 = -(2n ** 192n)
+export const minInt200 = -(2n ** 200n)
+export const minInt208 = -(2n ** 208n)
+export const minInt216 = -(2n ** 216n)
+export const minInt224 = -(2n ** 224n)
+export const minInt232 = -(2n ** 232n)
+export const minInt240 = -(2n ** 240n)
+export const minInt248 = -(2n ** 248n)
+export const minInt256 = -(2n ** 256n)
+
+export const maxUint8 = 2n ** 8n
+export const maxUint16 = 2n ** 16n
+export const maxUint24 = 2n ** 24n
+export const maxUint32 = 2n ** 32n
+export const maxUint40 = 2n ** 40n
+export const maxUint48 = 2n ** 48n
+export const maxUint56 = 2n ** 56n
+export const maxUint64 = 2n ** 64n
+export const maxUint72 = 2n ** 72n
+export const maxUint80 = 2n ** 80n
+export const maxUint88 = 2n ** 88n
+export const maxUint96 = 2n ** 96n
+export const maxUint104 = 2n ** 104n
+export const maxUint112 = 2n ** 112n
+export const maxUint120 = 2n ** 120n
+export const maxUint128 = 2n ** 128n
+export const maxUint136 = 2n ** 136n
+export const maxUint144 = 2n ** 144n
+export const maxUint152 = 2n ** 152n
+export const maxUint160 = 2n ** 160n
+export const maxUint168 = 2n ** 168n
+export const maxUint176 = 2n ** 176n
+export const maxUint184 = 2n ** 184n
+export const maxUint192 = 2n ** 192n
+export const maxUint200 = 2n ** 200n
+export const maxUint208 = 2n ** 208n
+export const maxUint216 = 2n ** 216n
+export const maxUint224 = 2n ** 224n
+export const maxUint232 = 2n ** 232n
+export const maxUint240 = 2n ** 240n
+export const maxUint248 = 2n ** 248n
+export const maxUint256 = 2n ** 256n

package/src/errors/version.ts

@@ -1 +1 @@
-export const version = '1.4.2'
+export const version = '1.5.2'

package/src/index.ts

@@ -304,8 +304,106 @@ export {
   webSocket,
 } from './clients/transports/webSocket.js'
 export { multicall3Abi } from './constants/abis.js'
-export { etherUnits, gweiUnits, weiUnits } from './constants/unit.js'
 export { zeroAddress } from './constants/address.js'
+export { etherUnits, gweiUnits, weiUnits } from './constants/unit.js'
+export {
+  maxInt8,
+  maxInt16,
+  maxInt24,
+  maxInt32,
+  maxInt40,
+  maxInt48,
+  maxInt56,
+  maxInt64,
+  maxInt72,
+  maxInt80,
+  maxInt88,
+  maxInt96,
+  maxInt104,
+  maxInt112,
+  maxInt120,
+  maxInt128,
+  maxInt136,
+  maxInt144,
+  maxInt152,
+  maxInt160,
+  maxInt168,
+  maxInt176,
+  maxInt184,
+  maxInt192,
+  maxInt200,
+  maxInt208,
+  maxInt216,
+  maxInt224,
+  maxInt232,
+  maxInt240,
+  maxInt248,
+  maxInt256,
+  maxUint8,
+  maxUint16,
+  maxUint24,
+  maxUint32,
+  maxUint40,
+  maxUint48,
+  maxUint56,
+  maxUint64,
+  maxUint72,
+  maxUint80,
+  maxUint88,
+  maxUint96,
+  maxUint104,
+  maxUint112,
+  maxUint120,
+  maxUint128,
+  maxUint136,
+  maxUint144,
+  maxUint152,
+  maxUint160,
+  maxUint168,
+  maxUint176,
+  maxUint184,
+  maxUint192,
+  maxUint200,
+  maxUint208,
+  maxUint216,
+  maxUint224,
+  maxUint232,
+  maxUint240,
+  maxUint248,
+  maxUint256,
+  minInt8,
+  minInt16,
+  minInt24,
+  minInt32,
+  minInt40,
+  minInt48,
+  minInt56,
+  minInt64,
+  minInt72,
+  minInt80,
+  minInt88,
+  minInt96,
+  minInt104,
+  minInt112,
+  minInt120,
+  minInt128,
+  minInt136,
+  minInt144,
+  minInt152,
+  minInt160,
+  minInt168,
+  minInt176,
+  minInt184,
+  minInt192,
+  minInt200,
+  minInt208,
+  minInt216,
+  minInt224,
+  minInt232,
+  minInt240,
+  minInt248,
+  minInt256,
+} from './constants/number.js'
 export {
   AbiConstructorNotFoundError,
   AbiConstructorParamsNotFoundError,
@@ -636,6 +734,7 @@ export {
   type HashTypedDataReturnType,
   hashTypedData,
 } from './utils/signature/hashTypedData.js'
+export { hexToSignature } from './utils/signature/hexToSignature.js'
 export {
   type RecoverAddressParameters,
   type RecoverAddressReturnType,
@@ -656,6 +755,7 @@ export {
   type RecoverTypedDataAddressReturnType,
   recoverTypedDataAddress,
 } from './utils/signature/recoverTypedDataAddress.js'
+export { signatureToHex } from './utils/signature/signatureToHex.js'
 export { type ToRlpReturnType, toRlp } from './utils/encoding/toRlp.js'
 export {
   type VerifyMessageParameters,

package/src/types/block.ts

@@ -3,7 +3,16 @@ import type { Address } from 'abitype'
 import type { Hash, Hex } from './misc.js'
 import type { Transaction } from './transaction.js'
 
-export type Block<TQuantity = bigint, TTransaction = Transaction> = {
+export type Block<
+  TQuantity = bigint,
+  TIncludeTransactions extends boolean = boolean,
+  TBlockTag extends BlockTag = BlockTag,
+  TTransaction = Transaction<
+    bigint,
+    number,
+    TBlockTag extends 'pending' ? true : false
+  >,
+> = {
   /** Base fee per gas */
   baseFeePerGas: TQuantity | null
   /** Difficulty for this block */
@@ -15,17 +24,17 @@ export type Block<TQuantity = bigint, TTransaction = Transaction> = {
   /** Total used gas by all transactions in this block */
   gasUsed: TQuantity
   /** Block hash or `null` if pending */
-  hash: Hash | null
+  hash: TBlockTag extends 'pending' ? null : Hash
   /** Logs bloom filter or `null` if pending */
-  logsBloom: Hex | null
+  logsBloom: TBlockTag extends 'pending' ? null : Hex
   /** Address that received this block’s mining rewards */
   miner: Address
   /** Unique identifier for the block. */
   mixHash: Hash
   /** Proof-of-work hash or `null` if pending */
-  nonce: Hex | null
+  nonce: TBlockTag extends 'pending' ? null : Hex
   /** Block number or `null` if pending */
-  number: TQuantity | null
+  number: TBlockTag extends 'pending' ? null : TQuantity
   /** Parent block hash */
   parentHash: Hash
   /** Root of the this block’s receipts trie */
@@ -42,7 +51,7 @@ export type Block<TQuantity = bigint, TTransaction = Transaction> = {
   /** Total difficulty of the chain until this block */
   totalDifficulty: TQuantity | null
   /** List of transaction objects or hashes */
-  transactions: Hash[] | TTransaction[]
+  transactions: TIncludeTransactions extends true ? TTransaction[] : Hash[]
   /** Root of this block’s transaction trie */
   transactionsRoot: Hash
   /** List of uncle hashes */
@@ -67,7 +76,13 @@ export type BlockNumber<TQuantity = bigint> = TQuantity
 
 export type BlockTag = 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'
 
-export type Uncle<TQuantity = bigint, TTransaction = Transaction> = Block<
-  TQuantity,
-  TTransaction
->
+export type Uncle<
+  TQuantity = bigint,
+  TIncludeTransactions extends boolean = boolean,
+  TBlockTag extends BlockTag = BlockTag,
+  TTransaction = Transaction<
+    bigint,
+    number,
+    TBlockTag extends 'pending' ? true : false
+  >,
+> = Block<TQuantity, TIncludeTransactions, TBlockTag, TTransaction>

package/src/types/contract.ts

@@ -83,9 +83,13 @@ export type MaybeAbiEventName<TAbiEvent extends AbiEvent | undefined> =
   TAbiEvent extends AbiEvent ? TAbiEvent['name'] : undefined
 
 export type MaybeExtractEventArgsFromAbi<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TEventName extends string | undefined = undefined,
-> = TEventName extends string ? GetEventArgs<TAbi, TEventName> : undefined
+  TAbi extends Abi | readonly unknown[] | undefined,
+  TEventName extends string | undefined,
+> = TAbi extends Abi | readonly unknown[]
+  ? TEventName extends string
+    ? GetEventArgs<TAbi, TEventName>
+    : undefined
+  : undefined
 
 //////////////////////////////////////////////////////////////////////
 // ABI item name

package/src/types/filter.ts

@@ -1,5 +1,6 @@
 import type { Abi } from 'abitype'
 
+import type { BlockNumber, BlockTag } from './block.js'
 import type { MaybeExtractEventArgsFromAbi } from './contract.js'
 import type { EIP1193RequestFn, PublicRpcSchema } from './eip1193.js'
 import type { Hex } from './misc.js'
@@ -16,42 +17,47 @@ type FilterRpcSchema = Filter_<
 
 export type Filter<
   TFilterType extends FilterType = 'event',
-  TAbi extends Abi | readonly unknown[] = Abi,
+  TAbi extends Abi | readonly unknown[] | undefined = undefined,
   TEventName extends string | undefined = undefined,
   TArgs extends
     | MaybeExtractEventArgsFromAbi<TAbi, TEventName>
     | undefined = MaybeExtractEventArgsFromAbi<TAbi, TEventName>,
   TStrict extends boolean | undefined = undefined,
+  TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  TToBlock extends BlockNumber | BlockTag | undefined = undefined,
 > = {
   id: Hex
   request: EIP1193RequestFn<FilterRpcSchema>
   type: TFilterType
 } & (TFilterType extends 'event'
-  ? TAbi extends Abi
-    ? undefined extends TEventName
-      ? {
-          abi: TAbi
-          args?: never
-          eventName?: never
-          strict: TStrict
-        }
-      : TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName>
-      ? {
-          abi: TAbi
-          args: TArgs
-          eventName: TEventName
-          strict: TStrict
-        }
+  ? {
+      fromBlock?: TFromBlock
+      toBlock?: TToBlock
+    } & (TAbi extends Abi
+      ? undefined extends TEventName
+        ? {
+            abi: TAbi
+            args?: never
+            eventName?: never
+            strict: TStrict
+          }
+        : TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName>
+        ? {
+            abi: TAbi
+            args: TArgs
+            eventName: TEventName
+            strict: TStrict
+          }
+        : {
+            abi: TAbi
+            args?: never
+            eventName: TEventName
+            strict: TStrict
+          }
       : {
-          abi: TAbi
+          abi?: never
           args?: never
-          eventName: TEventName
-          strict: TStrict
-        }
-    : {
-        abi?: never
-        args?: never
-        eventName?: never
-        strict?: never
-      }
+          eventName?: never
+          strict?: never
+        })
   : {})

package/src/types/formatter.ts

@@ -12,6 +12,15 @@ export type Formatters = {
   transactionRequest?: Formatter<'transactionRequest'>
 }
 
+export type ExtractFormatterExclude<
+  TChain extends Chain | undefined,
+  TType extends keyof Formatters,
+> = TChain extends Chain<infer _Formatters extends Formatters>
+  ? _Formatters[TType] extends { exclude: infer Exclude }
+    ? Extract<Exclude, string[]>[number]
+    : ''
+  : ''
+
 export type ExtractFormatterParameters<
   TChain extends Chain | undefined,
   TType extends keyof Formatters,