viem 2.0.6 → 2.1.0

package/utils/cursor.ts

@@ -1,6 +1,7 @@
 import {
   NegativeOffsetError,
   PositionOutOfBoundsError,
+  RecursiveReadLimitExceededError,
 } from '../errors/cursor.js'
 import type { ErrorType } from '../errors/utils.js'
 import type { ByteArray } from '../types/misc.js'
@@ -9,8 +10,13 @@ export type Cursor = {
   bytes: ByteArray
   dataView: DataView
   position: number
+  positionReadCount: Map<number, number>
+  recursiveReadCount: number
+  recursiveReadLimit: number
+  assertReadLimit(position?: number): void
   assertPosition(position: number): void
   decrementPosition(offset: number): void
+  getReadCount(position?: number): number
   incrementPosition(offset: number): void
   inspectByte(position?: number): ByteArray[number]
   inspectBytes(length: number, position?: number): ByteArray
@@ -25,12 +31,13 @@ export type Cursor = {
   pushUint24(value: number): void
   pushUint32(value: number): void
   readByte(): ByteArray[number]
-  readBytes(length: number): ByteArray
+  readBytes(length: number, size?: number): ByteArray
   readUint8(): number
   readUint16(): number
   readUint24(): number
   readUint32(): number
-  setPosition(position: number): void
+  setPosition(position: number): () => void
+  _touch(): void
 }
 
 export type CreateCursorErrorType = ErrorType
@@ -51,6 +58,16 @@ const staticCursor: Cursor = {
   bytes: new Uint8Array(),
   dataView: new DataView(new ArrayBuffer(0)),
   position: 0,
+  positionReadCount: new Map(),
+  recursiveReadCount: 0,
+  recursiveReadLimit: Infinity,
+  assertReadLimit() {
+    if (this.recursiveReadCount >= this.recursiveReadLimit)
+      throw new RecursiveReadLimitExceededError({
+        count: this.recursiveReadCount + 1,
+        limit: this.recursiveReadLimit,
+      })
+  },
   assertPosition(position) {
     if (position < 0 || position > this.bytes.length - 1)
       throw new PositionOutOfBoundsError({
@@ -64,6 +81,9 @@ const staticCursor: Cursor = {
     this.assertPosition(position)
     this.position = position
   },
+  getReadCount(position) {
+    return this.positionReadCount.get(position || this.position) || 0
+  },
   incrementPosition(offset) {
     if (offset < 0) throw new NegativeOffsetError({ offset })
     const position = this.position + offset
@@ -135,48 +155,75 @@ const staticCursor: Cursor = {
     this.position += 4
   },
   readByte() {
+    this.assertReadLimit()
+    this._touch()
     const value = this.inspectByte()
     this.position++
     return value
   },
-  readBytes(length) {
+  readBytes(length, size) {
+    this.assertReadLimit()
+    this._touch()
     const value = this.inspectBytes(length)
-    this.position += length
+    this.position += size ?? length
     return value
   },
   readUint8() {
+    this.assertReadLimit()
+    this._touch()
     const value = this.inspectUint8()
     this.position += 1
     return value
   },
   readUint16() {
+    this.assertReadLimit()
+    this._touch()
     const value = this.inspectUint16()
     this.position += 2
     return value
   },
   readUint24() {
+    this.assertReadLimit()
+    this._touch()
     const value = this.inspectUint24()
     this.position += 3
     return value
   },
   readUint32() {
+    this.assertReadLimit()
+    this._touch()
     const value = this.inspectUint32()
     this.position += 4
     return value
   },
   setPosition(position) {
+    const oldPosition = this.position
     this.assertPosition(position)
     this.position = position
+    return () => (this.position = oldPosition)
+  },
+  _touch() {
+    if (this.recursiveReadLimit === Infinity) return
+    const count = this.getReadCount()
+    this.positionReadCount.set(this.position, count + 1)
+    if (count > 0) this.recursiveReadCount++
   },
 }
 
-export function createCursor(bytes: ByteArray): Cursor {
-  const cursor = Object.create(staticCursor)
+type CursorConfig = { recursiveReadLimit?: number }
+
+export function createCursor(
+  bytes: ByteArray,
+  { recursiveReadLimit = 8_192 }: CursorConfig = {},
+): Cursor {
+  const cursor: Cursor = Object.create(staticCursor)
   cursor.bytes = bytes
   cursor.dataView = new DataView(
     bytes.buffer,
     bytes.byteOffset,
     bytes.byteLength,
   )
+  cursor.positionReadCount = new Map()
+  cursor.recursiveReadLimit = recursiveReadLimit
   return cursor
 }

package/utils/encoding/fromBytes.ts

@@ -47,8 +47,8 @@ export type FromBytesErrorType =
 /**
  * Decodes a byte array into a UTF-8 string, hex value, number, bigint or boolean.
  *
- * - Docs: https://viem.sh/docs/utilities/fromBytes.html
- * - Example: https://viem.sh/docs/utilities/fromBytes.html#usage
+ * - Docs: https://viem.sh/docs/utilities/fromBytes
+ * - Example: https://viem.sh/docs/utilities/fromBytes#usage
  *
  * @param bytes Byte array to decode.
  * @param toOrOpts Type to convert to or options.
@@ -102,7 +102,7 @@ export type BytesToBigIntErrorType =
 /**
  * Decodes a byte array into a bigint.
  *
- * - Docs: https://viem.sh/docs/utilities/fromBytes.html#bytestobigint
+ * - Docs: https://viem.sh/docs/utilities/fromBytes#bytestobigint
  *
  * @param bytes Byte array to decode.
  * @param opts Options.
@@ -119,7 +119,7 @@ export function bytesToBigInt(
 ): bigint {
   if (typeof opts.size !== 'undefined') assertSize(bytes, { size: opts.size })
   const hex = bytesToHex(bytes, opts)
-  return hexToBigInt(hex)
+  return hexToBigInt(hex, opts)
 }
 
 export type BytesToBoolOpts = {
@@ -135,7 +135,7 @@ export type BytesToBoolErrorType =
 /**
  * Decodes a byte array into a boolean.
  *
- * - Docs: https://viem.sh/docs/utilities/fromBytes.html#bytestobool
+ * - Docs: https://viem.sh/docs/utilities/fromBytes#bytestobool
  *
  * @param bytes Byte array to decode.
  * @param opts Options.
@@ -170,7 +170,7 @@ export type BytesToNumberErrorType =
 /**
  * Decodes a byte array into a number.
  *
- * - Docs: https://viem.sh/docs/utilities/fromBytes.html#bytestonumber
+ * - Docs: https://viem.sh/docs/utilities/fromBytes#bytestonumber
  *
  * @param bytes Byte array to decode.
  * @param opts Options.
@@ -187,7 +187,7 @@ export function bytesToNumber(
 ): number {
   if (typeof opts.size !== 'undefined') assertSize(bytes, { size: opts.size })
   const hex = bytesToHex(bytes, opts)
-  return hexToNumber(hex)
+  return hexToNumber(hex, opts)
 }
 
 export type BytesToStringOpts = {
@@ -203,7 +203,7 @@ export type BytesToStringErrorType =
 /**
  * Decodes a byte array into a UTF-8 string.
  *
- * - Docs: https://viem.sh/docs/utilities/fromBytes.html#bytestostring
+ * - Docs: https://viem.sh/docs/utilities/fromBytes#bytestostring
  *
  * @param bytes Byte array to decode.
  * @param opts Options.

package/utils/encoding/fromHex.ts

@@ -61,8 +61,8 @@ export type FromHexErrorType =
 /**
  * Decodes a hex string into a string, number, bigint, boolean, or byte array.
  *
- * - Docs: https://viem.sh/docs/utilities/fromHex.html
- * - Example: https://viem.sh/docs/utilities/fromHex.html#usage
+ * - Docs: https://viem.sh/docs/utilities/fromHex
+ * - Example: https://viem.sh/docs/utilities/fromHex#usage
  *
  * @param hex Hex string to decode.
  * @param toOrOpts Type to convert to or options.
@@ -111,7 +111,7 @@ export type HexToBigIntErrorType = AssertSizeErrorType | ErrorType
 /**
  * Decodes a hex value into a bigint.
  *
- * - Docs: https://viem.sh/docs/utilities/fromHex.html#hextobigint
+ * - Docs: https://viem.sh/docs/utilities/fromHex#hextobigint
  *
  * @param hex Hex value to decode.
  * @param opts Options.
@@ -156,7 +156,7 @@ export type HexToBoolErrorType =
 /**
  * Decodes a hex value into a boolean.
  *
- * - Docs: https://viem.sh/docs/utilities/fromHex.html#hextobool
+ * - Docs: https://viem.sh/docs/utilities/fromHex#hextobool
  *
  * @param hex Hex value to decode.
  * @param opts Options.
@@ -190,7 +190,7 @@ export type HexToNumberErrorType = HexToBigIntErrorType | ErrorType
 /**
  * Decodes a hex string into a number.
  *
- * - Docs: https://viem.sh/docs/utilities/fromHex.html#hextonumber
+ * - Docs: https://viem.sh/docs/utilities/fromHex#hextonumber
  *
  * @param hex Hex value to decode.
  * @param opts Options.
@@ -224,7 +224,7 @@ export type HexToStringErrorType =
 /**
  * Decodes a hex value into a UTF-8 string.
  *
- * - Docs: https://viem.sh/docs/utilities/fromHex.html#hextostring
+ * - Docs: https://viem.sh/docs/utilities/fromHex#hextostring
  *
  * @param hex Hex value to decode.
  * @param opts Options.

package/utils/encoding/fromRlp.ts

@@ -41,7 +41,7 @@ export function fromRlp<to extends To = 'hex'>(
     return value
   })()
 
-  const cursor = createCursor(bytes)
+  const cursor = createCursor(bytes, { recursiveReadLimit: Infinity })
   const result = fromRlpCursor(cursor, to)
 
   return result as FromRlpReturnType<to>

package/utils/encoding/toBytes.ts

@@ -29,8 +29,8 @@ export type ToBytesErrorType =
 /**
  * Encodes a UTF-8 string, hex value, bigint, number or boolean to a byte array.
  *
- * - Docs: https://viem.sh/docs/utilities/toBytes.html
- * - Example: https://viem.sh/docs/utilities/toBytes.html#usage
+ * - Docs: https://viem.sh/docs/utilities/toBytes
+ * - Example: https://viem.sh/docs/utilities/toBytes#usage
  *
  * @param value Value to encode.
  * @param opts Options.
@@ -75,7 +75,7 @@ export type BoolToBytesErrorType =
 /**
  * Encodes a boolean into a byte array.
  *
- * - Docs: https://viem.sh/docs/utilities/toBytes.html#booltobytes
+ * - Docs: https://viem.sh/docs/utilities/toBytes#booltobytes
  *
  * @param value Boolean value to encode.
  * @param opts Options.
@@ -131,7 +131,7 @@ export type HexToBytesErrorType = AssertSizeErrorType | PadErrorType | ErrorType
 /**
  * Encodes a hex string into a byte array.
  *
- * - Docs: https://viem.sh/docs/utilities/toBytes.html#hextobytes
+ * - Docs: https://viem.sh/docs/utilities/toBytes#hextobytes
  *
  * @param hex Hex string to encode.
  * @param opts Options.
@@ -182,7 +182,7 @@ export type NumberToBytesErrorType =
 /**
  * Encodes a number into a byte array.
  *
- * - Docs: https://viem.sh/docs/utilities/toBytes.html#numbertobytes
+ * - Docs: https://viem.sh/docs/utilities/toBytes#numbertobytes
  *
  * @param value Number to encode.
  * @param opts Options.
@@ -216,7 +216,7 @@ export type StringToBytesErrorType =
 /**
  * Encodes a UTF-8 string into a byte array.
  *
- * - Docs: https://viem.sh/docs/utilities/toBytes.html#stringtobytes
+ * - Docs: https://viem.sh/docs/utilities/toBytes#stringtobytes
  *
  * @param value String to encode.
  * @param opts Options.

package/utils/encoding/toHex.ts

@@ -27,8 +27,8 @@ export type ToHexErrorType =
 /**
  * Encodes a string, number, bigint, or ByteArray into a hex string
  *
- * - Docs: https://viem.sh/docs/utilities/toHex.html
- * - Example: https://viem.sh/docs/utilities/toHex.html#usage
+ * - Docs: https://viem.sh/docs/utilities/toHex
+ * - Example: https://viem.sh/docs/utilities/toHex#usage
  *
  * @param value Value to encode.
  * @param opts Options.
@@ -72,7 +72,7 @@ export type BoolToHexErrorType = AssertSizeErrorType | PadErrorType | ErrorType
 /**
  * Encodes a boolean into a hex string
  *
- * - Docs: https://viem.sh/docs/utilities/toHex.html#booltohex
+ * - Docs: https://viem.sh/docs/utilities/toHex#booltohex
  *
  * @param value Value to encode.
  * @param opts Options.
@@ -112,7 +112,7 @@ export type BytesToHexErrorType = AssertSizeErrorType | PadErrorType | ErrorType
 /**
  * Encodes a bytes array into a hex string
  *
- * - Docs: https://viem.sh/docs/utilities/toHex.html#bytestohex
+ * - Docs: https://viem.sh/docs/utilities/toHex#bytestohex
  *
  * @param value Value to encode.
  * @param opts Options.
@@ -163,7 +163,7 @@ export type NumberToHexErrorType =
 /**
  * Encodes a number or bigint into a hex string
  *
- * - Docs: https://viem.sh/docs/utilities/toHex.html#numbertohex
+ * - Docs: https://viem.sh/docs/utilities/toHex#numbertohex
  *
  * @param value Value to encode.
  * @param opts Options.
@@ -228,7 +228,7 @@ const encoder = /*#__PURE__*/ new TextEncoder()
 /**
  * Encodes a UTF-8 string into a hex string
  *
- * - Docs: https://viem.sh/docs/utilities/toHex.html#stringtohex
+ * - Docs: https://viem.sh/docs/utilities/toHex#stringtohex
  *
  * @param value Value to encode.
  * @param opts Options.

package/utils/ens/labelhash.ts

@@ -20,7 +20,7 @@ export type LabelhashErrorType =
 /**
  * @description Hashes ENS label
  *
- * - Since ENS labels prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS labels](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `labelhash`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ * - Since ENS labels prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS labels](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `labelhash`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
  *
  * @example
  * labelhash('eth')

package/utils/ens/namehash.ts

@@ -25,7 +25,7 @@ export type NamehashErrorType =
 /**
  * @description Hashes ENS name
  *
- * - Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `namehash`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ * - Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `namehash`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
  *
  * @example
  * namehash('wevm.eth')

package/utils/signature/verifyMessage.ts

@@ -37,7 +37,7 @@ export type VerifyMessageErrorType =
  *        It is highly recommended to use `publicClient.verifyMessage` instead to ensure
  *        wallet interoperability.
  *
- * - Docs {@link https://viem.sh/docs/utilities/verifyMessage.html}
+ * - Docs {@link https://viem.sh/docs/utilities/verifyMessage}
  *
  * @param parameters - {@link VerifyMessageParameters}
  * @returns Whether or not the signature is valid. {@link VerifyMessageReturnType}

package/utils/signature/verifyTypedData.ts

@@ -39,7 +39,7 @@ export type VerifyTypedDataErrorType =
  *        It is highly recommended to use `publicClient.verifyTypedData` instead to ensure
  *        wallet interoperability.
  *
- * - Docs {@link https://viem.sh/docs/utilities/verifyTypedData.html}
+ * - Docs {@link https://viem.sh/docs/utilities/verifyTypedData}
  *
  * @param parameters - {@link VerifyTypedDataParameters}
  * @returns Whether or not the signature is valid. {@link VerifyTypedDataReturnType}

package/utils/unit/formatEther.ts

@@ -7,7 +7,7 @@ export type FormatEtherErrorType = FormatUnitsErrorType
 /**
  * Converts numerical wei to a string representation of ether.
  *
- * - Docs: https://viem.sh/docs/utilities/formatEther.html
+ * - Docs: https://viem.sh/docs/utilities/formatEther
  *
  * @example
  * import { formatEther } from 'viem'

package/utils/unit/formatGwei.ts

@@ -7,7 +7,7 @@ export type FormatGweiErrorType = FormatUnitsErrorType
 /**
  * Converts numerical wei to a string representation of gwei.
  *
- * - Docs: https://viem.sh/docs/utilities/formatGwei.html
+ * - Docs: https://viem.sh/docs/utilities/formatGwei
  *
  * @example
  * import { formatGwei } from 'viem'

package/utils/unit/formatUnits.ts

@@ -5,7 +5,7 @@ export type FormatUnitsErrorType = ErrorType
 /**
  *  Divides a number by a given exponent of base 10 (10exponent), and formats it into a string representation of the number..
  *
- * - Docs: https://viem.sh/docs/utilities/formatUnits.html
+ * - Docs: https://viem.sh/docs/utilities/formatUnits
  *
  * @example
  * import { formatUnits } from 'viem'

package/utils/unit/parseEther.ts

@@ -8,7 +8,7 @@ export type ParseEtherErrorType = ParseUnitsErrorType | ErrorType
 /**
  * Converts a string representation of ether to numerical wei.
  *
- * - Docs: https://viem.sh/docs/utilities/parseEther.html
+ * - Docs: https://viem.sh/docs/utilities/parseEther
  *
  * @example
  * import { parseEther } from 'viem'

package/utils/unit/parseGwei.ts

@@ -8,7 +8,7 @@ export type ParseGweiErrorType = ParseUnitsErrorType | ErrorType
 /**
  * Converts a string representation of gwei to numerical wei.
  *
- * - Docs: https://viem.sh/docs/utilities/parseGwei.html
+ * - Docs: https://viem.sh/docs/utilities/parseGwei
  *
  * @example
  * import { parseGwei } from 'viem'

package/utils/unit/parseUnits.ts

@@ -5,7 +5,7 @@ export type ParseUnitsErrorType = ErrorType
 /**
  * Multiplies a string representation of a number by a given exponent of base 10 (10exponent).
  *
- * - Docs: https://viem.sh/docs/utilities/parseUnits.html
+ * - Docs: https://viem.sh/docs/utilities/parseUnits
  *
  * @example
  * import { parseUnits } from 'viem'