viem 2.55.13 → 2.55.16

package/actions/public/watchBlockHeaders.ts

@@ -0,0 +1,131 @@
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { Chain } from '../../types/chain.js'
+import type { HasTransportType } from '../../types/transport.js'
+import { formatBlock } from '../../utils/formatters/block.js'
+import { observe } from '../../utils/observe.js'
+import { type StringifyErrorType, stringify } from '../../utils/stringify.js'
+
+import type { GetBlockReturnType } from './getBlock.js'
+
+const blockFields = [
+  'size',
+  'totalDifficulty',
+  'transactions',
+  'uncles',
+  'withdrawals',
+] as const
+
+export type BlockHeader<chain extends Chain | undefined = Chain> = Omit<
+  GetBlockReturnType<chain, false, 'latest'>,
+  (typeof blockFields)[number]
+>
+
+export type OnBlockHeaderParameter<chain extends Chain | undefined = Chain> =
+  BlockHeader<chain>
+
+export type OnBlockHeader<chain extends Chain | undefined = Chain> = (
+  blockHeader: OnBlockHeaderParameter<chain>,
+  prevBlockHeader: OnBlockHeaderParameter<chain> | undefined,
+) => void
+
+export type WatchBlockHeadersParameters<
+  chain extends Chain | undefined = Chain,
+> = {
+  /** The callback to call when a new block header is received. */
+  onBlockHeader: OnBlockHeader<chain>
+  /** The callback to call when an error occurs while watching block headers. */
+  onError?: ((error: Error) => void) | undefined
+}
+
+export type WatchBlockHeadersReturnType = () => void
+
+export type WatchBlockHeadersErrorType = StringifyErrorType | ErrorType
+
+/**
+ * Watches and returns incoming block headers.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/watchBlockHeaders
+ * - JSON-RPC Methods: Uses a WebSocket or IPC subscription via [`eth_subscribe`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_subscribe) and the `"newHeads"` event.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link WatchBlockHeadersParameters}
+ * @returns A function that can be invoked to stop watching for new block headers. {@link WatchBlockHeadersReturnType}
+ *
+ * @example
+ * import { createPublicClient, webSocket } from 'viem'
+ * import { watchBlockHeaders } from 'viem/actions'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: webSocket(),
+ * })
+ * const unwatch = watchBlockHeaders(client, {
+ *   onBlockHeader: (blockHeader) => console.log(blockHeader),
+ * })
+ */
+export function watchBlockHeaders<
+  transport extends Transport,
+  chain extends Chain | undefined,
+>(
+  client: Client<transport, chain>,
+  {
+    onBlockHeader,
+    onError,
+  }: HasTransportType<transport, 'webSocket' | 'ipc'> extends true
+    ? WatchBlockHeadersParameters<chain>
+    : never,
+): WatchBlockHeadersReturnType {
+  let prevBlockHeader: OnBlockHeaderParameter<chain> | undefined
+
+  const observerId = stringify(['watchBlockHeaders', client.uid])
+
+  return observe(observerId, { onBlockHeader, onError }, (emit) => {
+    let active = true
+    let subscribed = false
+    let unsubscribe = () => (active = false)
+    ;(async () => {
+      try {
+        const transport = (() => {
+          if (client.transport.type === 'fallback') {
+            const transport = client.transport.transports.find(
+              (transport: ReturnType<Transport>) =>
+                transport.config.type === 'webSocket' ||
+                transport.config.type === 'ipc',
+            )
+            if (!transport) return client.transport
+            return transport.value
+          }
+          return client.transport
+        })()
+
+        const { unsubscribe: unsubscribe_ } = await transport.subscribe({
+          params: ['newHeads'],
+          onData(data: any) {
+            if (!active) return
+            const blockHeader = (
+              client.chain?.formatters?.block?.format || formatBlock
+            )(data.result, 'watchBlockHeaders')
+            for (const field of blockFields) delete blockHeader[field]
+            emit.onBlockHeader(
+              blockHeader as OnBlockHeaderParameter<chain>,
+              prevBlockHeader,
+            )
+            prevBlockHeader = blockHeader as OnBlockHeaderParameter<chain>
+          },
+          onError(error: Error) {
+            if (subscribed) emit.onError?.(error)
+          },
+        })
+        subscribed = true
+        unsubscribe = unsubscribe_
+        if (!active) unsubscribe()
+      } catch (err) {
+        emit.onError?.(err as Error)
+      }
+    })()
+    return () => unsubscribe()
+  })
+}

package/clients/decorators/public.ts

@@ -240,6 +240,11 @@ import {
   type WaitForTransactionReceiptReturnType,
   waitForTransactionReceipt,
 } from '../../actions/public/waitForTransactionReceipt.js'
+import {
+  type WatchBlockHeadersParameters,
+  type WatchBlockHeadersReturnType,
+  watchBlockHeaders,
+} from '../../actions/public/watchBlockHeaders.js'
 import {
   type WatchBlockNumberParameters,
   type WatchBlockNumberReturnType,
@@ -305,6 +310,7 @@ import type {
 } from '../../types/contract.js'
 import type { FeeValuesType } from '../../types/fee.js'
 import type { FilterType } from '../../types/filter.js'
+import type { HasTransportType } from '../../types/transport.js'
 import { bindActionDecorators, type Client } from '../createClient.js'
 import type { Transport } from '../transports/createTransport.js'
 
@@ -1988,6 +1994,32 @@ export type PublicActions<
   watchBlockNumber: (
     args: WatchBlockNumberParameters,
   ) => WatchBlockNumberReturnType
+  /**
+   * Watches and returns incoming block headers without fetching full blocks.
+   *
+   * - Docs: https://viem.sh/docs/actions/public/watchBlockHeaders
+   * - JSON-RPC Methods: Uses a WebSocket or IPC subscription via [`eth_subscribe`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_subscribe) and the `"newHeads"` event.
+   *
+   * @param args - {@link WatchBlockHeadersParameters}
+   * @returns A function that can be invoked to stop watching for new block headers. {@link WatchBlockHeadersReturnType}
+   *
+   * @example
+   * import { createPublicClient, webSocket } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: webSocket(),
+   * })
+   * const unwatch = client.watchBlockHeaders({
+   *   onBlockHeader: (blockHeader) => console.log(blockHeader),
+   * })
+   */
+  watchBlockHeaders: (
+    args: HasTransportType<transport, 'webSocket' | 'ipc'> extends true
+      ? WatchBlockHeadersParameters<chain>
+      : never,
+  ) => WatchBlockHeadersReturnType
   /**
    * Watches and returns information for incoming blocks.
    *
@@ -2337,6 +2369,7 @@ export function publicActions<
     uninstallFilter: (args) => uninstallFilter(client, args),
     waitForTransactionReceipt: (args) =>
       waitForTransactionReceipt(client, args),
+    watchBlockHeaders: (args) => watchBlockHeaders(client, args),
     watchBlocks: (args) => watchBlocks(client, args),
     watchBlockNumber: (args) => watchBlockNumber(client, args),
     watchContractEvent: (args) => watchContractEvent(client, args),

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.55.13'
+export const version = '2.55.16'

package/index.ts

@@ -320,6 +320,14 @@ export type {
   WaitForTransactionReceiptParameters,
   WaitForTransactionReceiptReturnType,
 } from './actions/public/waitForTransactionReceipt.js'
+export type {
+  BlockHeader,
+  OnBlockHeader,
+  OnBlockHeaderParameter,
+  WatchBlockHeadersErrorType,
+  WatchBlockHeadersParameters,
+  WatchBlockHeadersReturnType,
+} from './actions/public/watchBlockHeaders.js'
 export type {
   OnBlockNumberFn,
   OnBlockNumberParameter,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.55.13",
+  "version": "2.55.16",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",

package/tempo/actions/earn.ts

@@ -1051,6 +1051,7 @@ export namespace privateDeposit {
         memo: returnMemo,
         portalAddress: config.zonePortal,
         recipient,
+        sender: gateway,
         zoneId: config.zoneId,
       })
     const shareAmountMin = resolveMinimumShareAmount(parameters)
@@ -2429,6 +2430,7 @@ export namespace privateRedeem {
         memo: returnMemo,
         portalAddress: config.zonePortal,
         recipient,
+        sender: gateway,
         zoneId: config.zoneId,
       }),
       (async () => {

package/tempo/actions/zone.ts

@@ -28,7 +28,12 @@ import type { Transport } from '../../clients/transports/createTransport.js'
 import { zeroHash } from '../../constants/bytes.js'
 import type { BaseErrorType } from '../../errors/base.js'
 import type { Chain, GetChainParameter } from '../../types/chain.js'
-import type { Compute, UnionOmit } from '../../types/utils.js'
+import type {
+  Compute,
+  IsUndefined,
+  MaybeRequired,
+  UnionOmit,
+} from '../../types/utils.js'
 import { parseEventLogs } from '../../utils/abi/parseEventLogs.js'
 import type { RequestErrorType } from '../../utils/buildRequest.js'
 import { type ObserveErrorType, observe } from '../../utils/observe.js'
@@ -81,6 +86,8 @@ export type PreparedEncryptedDeposit = {
   keyIndex: bigint
   /** Zone portal address on the parent chain. */
   portalAddress: Address
+  /** Address that will call the Zone portal. */
+  sender: Address
   /** Token address or ID to deposit. */
   token: TokenId.TokenIdOrAddress
   /** Zone ID (e.g. `7`). */
@@ -96,6 +103,8 @@ export type PreparedEncryptedDepositRecipient = {
   keyIndex: bigint
   /** Zone portal address on the parent chain. */
   portalAddress: Address
+  /** Address that will call the Zone portal. */
+  sender: Address
   /** Zone ID (e.g. `7`). */
   zoneId: number
 }
@@ -494,6 +503,7 @@ export async function encryptedDeposit<
     memo: parameters.memo,
     portalAddress: parameters.portalAddress,
     recipient,
+    sender: account_.address,
     token: parameters.token,
     zoneId: parameters.zoneId,
   })
@@ -573,6 +583,7 @@ export namespace encryptedDeposit {
    *   amount: 1_000_000n,
    *   bouncebackRecipient: '0x...',
    *   recipient: '0x...',
+   *   sender: '0x...',
    *   zoneId: 7,
    * })
    * ```
@@ -586,7 +597,7 @@ export namespace encryptedDeposit {
     account extends Account | undefined,
   >(
     client: Client<Transport, chain, account>,
-    parameters: prepare.Parameters,
+    parameters: prepare.Parameters<account>,
   ): Promise<prepare.ReturnValue> {
     const chainId = client.chain?.id
     if (!chainId) throw new Error('`chain` is required.')
@@ -597,10 +608,13 @@ export namespace encryptedDeposit {
       memo,
       portalAddress: portalAddress_,
       recipient,
+      sender: sender_ = client.account?.address,
       token,
       zoneId,
       ...rest
     } = parameters
+    if (!sender_) throw new Error('`sender` is required.')
+    const sender = sender_
     const portalAddress = portalAddress_ ?? getPortalAddress(chainId, zoneId)
 
     const { keyIndex, publicKey } = await getEncryptionKey(client, {
@@ -612,6 +626,7 @@ export namespace encryptedDeposit {
     const encrypted = await encryptDepositPayload(
       publicKey,
       recipient,
+      sender,
       portalAddress,
       keyIndex,
       memo,
@@ -624,13 +639,24 @@ export namespace encryptedDeposit {
       encrypted,
       keyIndex,
       portalAddress,
+      sender,
       token,
       zoneId,
     }
   }
 
   export namespace prepare {
-    export type Parameters = ReadParameters & Args
+    export type Parameters<
+      account extends Account | undefined = Account | undefined,
+    > = ReadParameters &
+      Omit<Args, 'sender'> &
+      MaybeRequired<
+        {
+          /** Address that will call the Zone portal. @default `client.account.address` */
+          sender?: Address | undefined
+        },
+        IsUndefined<account>
+      >
 
     export type Args = {
       /** Amount of tokens to deposit. */
@@ -643,6 +669,8 @@ export namespace encryptedDeposit {
       portalAddress?: Address | undefined
       /** Recipient address in the zone. */
       recipient: Address
+      /** Address that will call the Zone portal. */
+      sender: Address
       /** Token address or ID to deposit. */
       token: TokenId.TokenIdOrAddress
       /** Zone ID (e.g. `7`). */
@@ -674,6 +702,7 @@ export namespace encryptedDeposit {
    *
    * const recipient = await Actions.zone.encryptedDeposit.prepareRecipient(client, {
    *   recipient: '0x...',
+   *   sender: '0x...',
    *   zoneId: 7,
    * })
    * ```
@@ -687,7 +716,7 @@ export namespace encryptedDeposit {
     account extends Account | undefined,
   >(
     client: Client<Transport, chain, account>,
-    parameters: prepareRecipient.Parameters,
+    parameters: prepareRecipient.Parameters<account>,
   ): Promise<prepareRecipient.ReturnValue> {
     const chainId = client.chain?.id
     if (!chainId) throw new Error('`chain` is required.')
@@ -696,9 +725,12 @@ export namespace encryptedDeposit {
       memo,
       portalAddress: portalAddress_,
       recipient,
+      sender: sender_ = client.account?.address,
       zoneId,
       ...rest
     } = parameters
+    if (!sender_) throw new Error('`sender` is required.')
+    const sender = sender_
     const portalAddress = portalAddress_ ?? getPortalAddress(chainId, zoneId)
     const { keyIndex, publicKey } = await getEncryptionKey(client, {
       ...rest,
@@ -708,6 +740,7 @@ export namespace encryptedDeposit {
     const encrypted = await encryptDepositPayload(
       publicKey,
       recipient,
+      sender,
       portalAddress,
       keyIndex,
       memo,
@@ -718,12 +751,23 @@ export namespace encryptedDeposit {
       encrypted,
       keyIndex,
       portalAddress,
+      sender,
       zoneId,
     }
   }
 
   export namespace prepareRecipient {
-    export type Parameters = ReadParameters & Args
+    export type Parameters<
+      account extends Account | undefined = Account | undefined,
+    > = ReadParameters &
+      Omit<Args, 'sender'> &
+      MaybeRequired<
+        {
+          /** Address that will call the Zone portal. @default `client.account.address` */
+          sender?: Address | undefined
+        },
+        IsUndefined<account>
+      >
 
     export type Args = {
       /** Optional deposit memo. @default `0x00...00` */
@@ -732,6 +776,8 @@ export namespace encryptedDeposit {
       portalAddress?: Address | undefined
       /** Recipient address in the zone. */
       recipient: Address
+      /** Address that will call the Zone portal. */
+      sender: Address
       /** Zone ID (e.g. `7`). */
       zoneId: number
     }
@@ -864,6 +910,7 @@ export async function encryptedDepositSync<
     memo: parameters.memo,
     portalAddress: parameters.portalAddress,
     recipient,
+    sender: account_.address,
     token: parameters.token,
     zoneId: parameters.zoneId,
   })
@@ -1883,6 +1930,7 @@ export namespace signAuthorizationToken {
 async function encryptDepositPayload(
   publicKey: { prefix: 2 | 3; x: Hex.Hex },
   recipient: Address,
+  sender: Address,
   portalAddress: Address,
   keyIndex: bigint,
   memo: Hex.Hex = zeroHash,
@@ -1918,6 +1966,7 @@ async function encryptDepositPayload(
         portalAddress,
         keyIndex,
         Hex.fromNumber(compressedEphemeral.x, { size: 32 }),
+        sender,
       ) as BufferSource,
     },
     hkdfKey,
@@ -1961,11 +2010,13 @@ function buildDepositHkdfInfo(
   portalAddress: Address,
   keyIndex: bigint,
   ephemeralPubkeyX: Hex.Hex,
+  sender: Address,
 ): Bytes.Bytes {
   return Bytes.concat(
     Bytes.from(portalAddress),
     Bytes.fromNumber(keyIndex, { size: 32 }),
     Bytes.from(ephemeralPubkeyX),
+    Bytes.from(sender),
   )
 }
 

package/utils/siwe/parseSiweMessage.ts

@@ -3,6 +3,21 @@ import type { Address } from 'abitype'
 import type { ExactPartial, Prettify } from '../../types/utils.js'
 import type { SiweMessage } from './types.js'
 
+const siweDateTimeRegex =
+  /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$/
+
+function isValidSiweDateTime(value: string): boolean {
+  if (!siweDateTimeRegex.test(value)) return false
+  return !Number.isNaN(new Date(value).getTime())
+}
+
+function parseSiweDateTime(value: string): Date {
+  // Reject non-RFC-3339 / non-EIP-4361 date-time strings before Date coercion
+  // (JS Date accepts many non-SIWE forms that would otherwise look "valid").
+  if (!isValidSiweDateTime(value)) return new Date(Number.NaN)
+  return new Date(value)
+}
+
 /**
  * @description Parses EIP-4361 formatted message into message fields object.
  *
@@ -36,9 +51,11 @@ export function parseSiweMessage(
     ...prefix,
     ...suffix,
     ...(chainId ? { chainId: Number(chainId) } : {}),
-    ...(expirationTime ? { expirationTime: new Date(expirationTime) } : {}),
-    ...(issuedAt ? { issuedAt: new Date(issuedAt) } : {}),
-    ...(notBefore ? { notBefore: new Date(notBefore) } : {}),
+    ...(expirationTime
+      ? { expirationTime: parseSiweDateTime(expirationTime) }
+      : {}),
+    ...(issuedAt ? { issuedAt: parseSiweDateTime(issuedAt) } : {}),
+    ...(notBefore ? { notBefore: parseSiweDateTime(notBefore) } : {}),
     ...(requestId ? { requestId } : {}),
     ...(resources ? { resources } : {}),
     ...(scheme ? { scheme } : {}),

package/utils/siwe/validateSiweMessage.ts

@@ -57,8 +57,19 @@ export function validateSiweMessage(
   if (nonce && message.nonce !== nonce) return false
   if (scheme && message.scheme !== scheme) return false
 
-  if (message.expirationTime && time >= message.expirationTime) return false
-  if (message.notBefore && time < message.notBefore) return false
+  // Invalid `time` makes both lifetime comparisons false in JS; reject first.
+  if (Number.isNaN(time.getTime())) return false
+
+  // Invalid Date (e.g. non-RFC-3339 SIWE timestamp coerced at parse) is truthy;
+  // comparisons against it are always false and previously skipped checks.
+  if (message.expirationTime) {
+    if (Number.isNaN(message.expirationTime.getTime())) return false
+    if (time >= message.expirationTime) return false
+  }
+  if (message.notBefore) {
+    if (Number.isNaN(message.notBefore.getTime())) return false
+    if (time < message.notBefore) return false
+  }
 
   try {
     if (!message.address) return false