viem 1.4.2 → 1.5.0

package/src/actions/public/watchEvent.ts

@@ -1,4 +1,4 @@
-import type { AbiEvent, Address } from 'abitype'
+import type { AbiEvent, Address, Narrow } from 'abitype'
 
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
@@ -19,24 +19,38 @@ import {
 } from './createEventFilter.js'
 import { getBlockNumber } from './getBlockNumber.js'
 import { getFilterChanges } from './getFilterChanges.js'
-import { getLogs } from './getLogs.js'
+import { type GetLogsParameters, getLogs } from './getLogs.js'
 import { uninstallFilter } from './uninstallFilter.js'
 
 export type WatchEventOnLogsParameter<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbiEvents extends
+    | readonly AbiEvent[]
+    | readonly unknown[]
+    | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
   TStrict extends boolean | undefined = undefined,
   TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
-> = Log<bigint, number, TAbiEvent, TStrict, [TAbiEvent], TEventName>[]
+> = Log<bigint, number, false, TAbiEvent, TStrict, TAbiEvents, TEventName>[]
 export type WatchEventOnLogsFn<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbiEvents extends
+    | readonly AbiEvent[]
+    | readonly unknown[]
+    | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
   TStrict extends boolean | undefined = undefined,
-  TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
-> = (logs: WatchEventOnLogsParameter<TAbiEvent, TStrict, TEventName>) => void
+  _EventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
+> = (
+  logs: WatchEventOnLogsParameter<TAbiEvent, TAbiEvents, TStrict, _EventName>,
+) => void
 
 export type WatchEventParameters<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbiEvents extends
+    | readonly AbiEvent[]
+    | readonly unknown[]
+    | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
   TStrict extends boolean | undefined = undefined,
-  TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
+  _EventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
 > = {
   /** The address of the contract. */
   address?: Address | Address[]
@@ -48,13 +62,24 @@ 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: WatchEventOnLogsFn<TAbiEvent, TStrict, TEventName>
+  onLogs: WatchEventOnLogsFn<TAbiEvent, TAbiEvents, TStrict, _EventName>
   /** Polling frequency (in ms). Defaults to Client's pollingInterval config. */
   pollingInterval?: number
 } & (
   | {
-      event: TAbiEvent
-      args?: MaybeExtractEventArgsFromAbi<[TAbiEvent], TEventName>
+      event: Narrow<TAbiEvent>
+      events?: never
+      args?: MaybeExtractEventArgsFromAbi<TAbiEvents, _EventName>
+      /**
+       * Whether or not the logs must match the indexed/non-indexed arguments on `event`.
+       * @default false
+       */
+      strict?: TStrict
+    }
+  | {
+      event?: never
+      events?: Narrow<TAbiEvents>
+      args?: never
       /**
        * Whether or not the logs must match the indexed/non-indexed arguments on `event`.
        * @default false
@@ -63,6 +88,7 @@ export type WatchEventParameters<
     }
   | {
       event?: never
+      events?: never
       args?: never
       strict?: never
     }
@@ -104,9 +130,13 @@ export type WatchEventReturnType = () => void
  */
 export function watchEvent<
   TChain extends Chain | undefined,
-  TAbiEvent extends AbiEvent | undefined,
-  TEventName extends string | undefined,
+  TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbiEvents extends
+    | readonly AbiEvent[]
+    | readonly unknown[]
+    | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
   TStrict extends boolean | undefined = undefined,
+  _EventName extends string | undefined = undefined,
 >(
   client: Client<Transport, TChain>,
   {
@@ -114,11 +144,12 @@ export function watchEvent<
     args,
     batch = true,
     event,
+    events,
     onError,
     onLogs,
     pollingInterval = client.pollingInterval,
     strict: strict_,
-  }: WatchEventParameters<TAbiEvent, TStrict>,
+  }: WatchEventParameters<TAbiEvent, TAbiEvents, TStrict>,
 ): WatchEventReturnType {
   const observerId = stringify([
     'watchEvent',
@@ -133,7 +164,7 @@ export function watchEvent<
 
   return observe(observerId, { onLogs, onError }, (emit) => {
     let previousBlockNumber: bigint
-    let filter: Filter<'event', [TAbiEvent], TEventName, any>
+    let filter: Filter<'event', TAbiEvents, _EventName, any>
     let initialized = false
 
     const unwatch = poll(
@@ -144,11 +175,12 @@ export function watchEvent<
               address,
               args,
               event: event!,
+              events,
               strict,
             } as unknown as CreateEventFilterParameters)) as unknown as Filter<
               'event',
-              [TAbiEvent],
-              TEventName
+              TAbiEvents,
+              _EventName
             >
           } catch {}
           initialized = true
@@ -173,10 +205,11 @@ export function watchEvent<
               logs = await getLogs(client, {
                 address,
                 args,
+                event: event!,
+                events,
                 fromBlock: previousBlockNumber + 1n,
                 toBlock: blockNumber,
-                event: event!,
-              })
+              } as unknown as GetLogsParameters)
             } else {
               logs = []
             }

package/src/clients/createClient.ts

@@ -29,6 +29,11 @@ export type ClientConfig<
         multicall?: boolean | Prettify<MulticallBatchOptions> | undefined
       }
     | undefined
+  /**
+   * Time (in ms) that cached data will remain in memory.
+   * @default 4_000
+   */
+  cacheTime?: number | undefined
   /** Chain for the client. */
   chain?: Chain | undefined | chain
   /** A key for the client. */
@@ -79,6 +84,8 @@ type Client_Base<
   account: account
   /** Flags for batch settings. */
   batch?: ClientConfig['batch']
+  /** Time (in ms) that cached data will remain in memory. */
+  cacheTime: number
   /** Chain for the client. */
   chain: chain
   /** A key for the client. */
@@ -135,6 +142,7 @@ export function createClient<
 export function createClient(parameters: ClientConfig): Client {
   const {
     batch,
+    cacheTime = parameters.pollingInterval ?? 4_000,
     key = 'base',
     name = 'Base Client',
     pollingInterval = 4_000,
@@ -154,6 +162,7 @@ export function createClient(parameters: ClientConfig): Client {
   const client = {
     account,
     batch,
+    cacheTime,
     chain,
     key,
     name,

package/src/clients/createPublicClient.ts

@@ -11,7 +11,13 @@ export type PublicClientConfig<
 > = Prettify<
   Pick<
     ClientConfig<transport, chain>,
-    'batch' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+    | 'batch'
+    | 'cacheTime'
+    | 'chain'
+    | 'key'
+    | 'name'
+    | 'pollingInterval'
+    | 'transport'
   >
 >
 

package/src/clients/createTestClient.ts

@@ -21,7 +21,13 @@ export type TestClientConfig<
 > = Prettify<
   Pick<
     ClientConfig<transport, chain, accountOrAddress>,
-    'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+    | 'account'
+    | 'cacheTime'
+    | 'chain'
+    | 'key'
+    | 'name'
+    | 'pollingInterval'
+    | 'transport'
   > & {
     /** Mode of the test client. */
     mode: mode | ('anvil' | 'hardhat' | 'ganache') // TODO: Type utility that expands `TestClientMode`

package/src/clients/createWalletClient.ts

@@ -19,7 +19,13 @@ export type WalletClientConfig<
 > = Prettify<
   Pick<
     ClientConfig<transport, chain, accountOrAddress>,
-    'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+    | 'account'
+    | 'cacheTime'
+    | 'chain'
+    | 'key'
+    | 'name'
+    | 'pollingInterval'
+    | 'transport'
   >
 >
 

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.0'