@xylabs/hex 5.0.83 → 5.0.86

package/README.md

@@ -15,6 +15,8 @@
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+
+
 ## Reference
 
 **@xylabs/hex**
@@ -23,77 +25,85 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Interfaces
 
-- [HexConfig](#interfaces/HexConfig)
+| Interface | Description |
+| ------ | ------ |
+| [HexConfig](#interfaces/HexConfig) | Configuration of validation and output format |
 
 ## Type Aliases
 
-- [AddressTransformZodType](#type-aliases/AddressTransformZodType)
-- [AddressValidationZodType](#type-aliases/AddressValidationZodType)
-- [Address](#type-aliases/Address)
-- [EthAddress](#type-aliases/EthAddress)
-- [HashBitLength](#type-aliases/HashBitLength)
-- [BrandedHash](#type-aliases/BrandedHash)
-- [Hash](#type-aliases/Hash)
-- [BrandedHex](#type-aliases/BrandedHex)
-- [Hex](#type-aliases/Hex)
+| Type Alias | Description |
+| ------ | ------ |
+| [AddressTransformZodType](#type-aliases/AddressTransformZodType) | The output type of AddressTransformZod after parsing and transformation. |
+| [AddressValidationZodType](#type-aliases/AddressValidationZodType) | The output type of AddressValidationZod after parsing. |
+| [Address](#type-aliases/Address) | A validated 20-byte address string type, inferred from the AddressZod schema. |
+| [EthAddress](#type-aliases/EthAddress) | Branded type representing a validated Ethereum address with 0x prefix. |
+| [HashBitLength](#type-aliases/HashBitLength) | Valid bit lengths for hash values. |
+| [BrandedHash](#type-aliases/BrandedHash) | Branded type representing a validated hash hex string. |
+| [Hash](#type-aliases/Hash) | A validated hash string type, inferred from the HashZod schema. |
+| [BrandedHex](#type-aliases/BrandedHex) | Branded type representing a validated lowercase hex string. |
+| [Hex](#type-aliases/Hex) | A validated hex string type, inferred from the HexZod schema. |
 
 ## Variables
 
-- [HexRegEx](#variables/HexRegEx)
-- [HexRegExWithPrefix](#variables/HexRegExWithPrefix)
-- [AddressTransformZod](#variables/AddressTransformZod)
-- [AddressValidationZod](#variables/AddressValidationZod)
-- [ZERO\_ADDRESS](#variables/ZERO_ADDRESS)
-- [ADDRESS\_LENGTH](#variables/ADDRESS_LENGTH)
-- [AddressRegEx](#variables/AddressRegEx)
-- [AddressZod](#variables/AddressZod)
-- [EthAddressRegEx](#variables/EthAddressRegEx)
-- [EthAddressToStringZod](#variables/EthAddressToStringZod)
-- [~~EthAddressToStringSchema~~](#variables/EthAddressToStringSchema)
-- [EthAddressFromStringZod](#variables/EthAddressFromStringZod)
-- [~~EthAddressFromStringSchema~~](#variables/EthAddressFromStringSchema)
-- [ETH\_ZERO\_ADDRESS](#variables/ETH_ZERO_ADDRESS)
-- [EthAddressZod](#variables/EthAddressZod)
-- [HASH\_LENGTH](#variables/HASH_LENGTH)
-- [HashRegEx](#variables/HashRegEx)
-- [ZERO\_HASH](#variables/ZERO_HASH)
-- [HashBitLength](#variables/HashBitLength)
-- [HashZod](#variables/HashZod)
-- [HashToJsonZod](#variables/HashToJsonZod)
-- [JsonToHashZod](#variables/JsonToHashZod)
-- [HexZod](#variables/HexZod)
-- [BigIntToJsonZod](#variables/BigIntToJsonZod)
-- [JsonToBigIntZod](#variables/JsonToBigIntZod)
+| Variable | Description |
+| ------ | ------ |
+| [HexRegEx](#variables/HexRegEx) | Regular expression matching a lowercase hex string without prefix. |
+| [HexRegExWithPrefix](#variables/HexRegExWithPrefix) | Regular expression matching a lowercase hex string with a 0x prefix. |
+| [AddressTransformZod](#variables/AddressTransformZod) | Zod schema that accepts a string, bigint, or number and transforms it into a validated Address. |
+| [AddressValidationZod](#variables/AddressValidationZod) | Zod schema that validates a string is a properly formatted 40-character hex address. |
+| [ZERO\_ADDRESS](#variables/ZERO_ADDRESS) | A 160-bit zero address constant. |
+| [ADDRESS\_LENGTH](#variables/ADDRESS_LENGTH) | The character length of an address hex string (40 hex characters / 20 bytes). |
+| [AddressRegEx](#variables/AddressRegEx) | Regular expression matching a 20-byte (40 hex character) address string. |
+| [AddressZod](#variables/AddressZod) | Zod schema that validates and transforms a string into a branded Address type. |
+| [EthAddressRegEx](#variables/EthAddressRegEx) | Regular expression matching a 20-byte Ethereum address with 0x prefix (mixed case). |
+| [EthAddressToStringZod](#variables/EthAddressToStringZod) | Zod schema that validates a string is a properly formatted Ethereum address. |
+| [~~EthAddressToStringSchema~~](#variables/EthAddressToStringSchema) | - |
+| [EthAddressFromStringZod](#variables/EthAddressFromStringZod) | Zod schema that validates and transforms a string into an EthAddress type. |
+| [~~EthAddressFromStringSchema~~](#variables/EthAddressFromStringSchema) | - |
+| [ETH\_ZERO\_ADDRESS](#variables/ETH_ZERO_ADDRESS) | The zero Ethereum address constant (0x followed by 40 zero characters). |
+| [EthAddressZod](#variables/EthAddressZod) | Zod schema that validates a string as a properly formatted Ethereum address using regex and type guard. |
+| [HASH\_LENGTH](#variables/HASH_LENGTH) | The byte length of a standard hash (32 bytes / 256 bits). |
+| [HashRegEx](#variables/HashRegEx) | Regular expression matching a 32-byte (64 hex character) hash string. |
+| [ZERO\_HASH](#variables/ZERO_HASH) | A 256-bit zero hash constant. |
+| [HashBitLength](#variables/HashBitLength) | Array of all valid hash bit lengths for runtime validation. |
+| [HashZod](#variables/HashZod) | Zod schema that validates and transforms a string into a branded Hash type. |
+| [HashToJsonZod](#variables/HashToJsonZod) | Zod schema that transforms a Hash to a plain string for JSON serialization. |
+| [JsonToHashZod](#variables/JsonToHashZod) | Zod schema that parses a JSON string into a validated Hash, throwing on invalid input. |
+| [HexZod](#variables/HexZod) | Zod schema that validates and transforms a string into a branded Hex type. |
+| [BigIntToJsonZod](#variables/BigIntToJsonZod) | Zod schema that transforms a non-negative BigInt into a hex string for JSON serialization. |
+| [JsonToBigIntZod](#variables/JsonToBigIntZod) | Zod schema that parses a JSON hex string into a BigInt. |
 
 ## Functions
 
-- [HexRegExMinMax](#functions/HexRegExMinMax)
-- [HexRegExMinMaxMixedCaseWithPrefix](#functions/HexRegExMinMaxMixedCaseWithPrefix)
-- [asAddress](#functions/asAddress)
-- [asAddressV2](#functions/asAddressV2)
-- [isAddress](#functions/isAddress)
-- [isAddressV2](#functions/isAddressV2)
-- [toAddress](#functions/toAddress)
-- [toAddressV2](#functions/toAddressV2)
-- [toEthAddress](#functions/toEthAddress)
-- [isEthAddress](#functions/isEthAddress)
-- [asEthAddress](#functions/asEthAddress)
-- [asHash](#functions/asHash)
-- [isHashBitLength](#functions/isHashBitLength)
-- [isHash](#functions/isHash)
-- [asHex](#functions/asHex)
-- [hexFrom](#functions/hexFrom)
-- [hexFromArrayBuffer](#functions/hexFromArrayBuffer)
-- [hexFromBigInt](#functions/hexFromBigInt)
-- [hexFromHexString](#functions/hexFromHexString)
-- [hexFromNumber](#functions/hexFromNumber)
-- [isHex](#functions/isHex)
-- [isHexZero](#functions/isHexZero)
-- [toHexLegacy](#functions/toHexLegacy)
-- [bitsToNibbles](#functions/bitsToNibbles)
-- [nibblesToBits](#functions/nibblesToBits)
-- [toHex](#functions/toHex)
-- [hexToBigInt](#functions/hexToBigInt)
+| Function | Description |
+| ------ | ------ |
+| [HexRegExMinMax](#functions/HexRegExMinMax) | Creates a RegExp matching lowercase hex strings with a byte length in the given range. |
+| [HexRegExMinMaxMixedCaseWithPrefix](#functions/HexRegExMinMaxMixedCaseWithPrefix) | Creates a RegExp matching mixed-case hex strings with a 0x prefix and a byte length in the given range. |
+| [asAddress](#functions/asAddress) | Attempts to coerce a value into an Address type, returning undefined or throwing based on the assert config. |
+| [asAddressV2](#functions/asAddressV2) | - |
+| [isAddress](#functions/isAddress) | Type guard that checks whether a value is a valid 160-bit address. |
+| [isAddressV2](#functions/isAddressV2) | - |
+| [toAddress](#functions/toAddress) | Converts a value to a 160-bit Address hex string. |
+| [toAddressV2](#functions/toAddressV2) | - |
+| [toEthAddress](#functions/toEthAddress) | Converts a value to a 0x-prefixed Ethereum address string. |
+| [isEthAddress](#functions/isEthAddress) | Type guard that checks whether a value is a valid 0x-prefixed Ethereum address. |
+| [asEthAddress](#functions/asEthAddress) | Attempts to coerce a value into an EthAddress, returning undefined or throwing based on the assert config. |
+| [asHash](#functions/asHash) | Attempts to coerce a value into a Hash type, returning undefined or throwing based on the assert config. |
+| [isHashBitLength](#functions/isHashBitLength) | Type guard that checks whether a value is a valid hash bit length. |
+| [isHash](#functions/isHash) | Type guard that checks whether a value is a valid hash of the specified bit length. |
+| [asHex](#functions/asHex) | Attempts to coerce a value into a Hex type, returning undefined or throwing based on the assert config. |
+| [hexFrom](#functions/hexFrom) | Takes unknown value and tries our best to convert it to a hex string |
+| [hexFromArrayBuffer](#functions/hexFromArrayBuffer) | Convert an ArrayBuffer to a hex string |
+| [hexFromBigInt](#functions/hexFromBigInt) | Convert a bigint to a hex string |
+| [hexFromHexString](#functions/hexFromHexString) | Normalizes a hex string by stripping an optional 0x prefix, lowercasing, and padding to byte/bit boundaries. |
+| [hexFromNumber](#functions/hexFromNumber) | Converts a number to a hex string by converting to BigInt first. |
+| [isHex](#functions/isHex) | Type guard that checks whether a value is a valid hex string. |
+| [isHexZero](#functions/isHexZero) | Checks whether a hex string represents a zero value. |
+| [toHexLegacy](#functions/toHexLegacy) | Converts an ArrayBuffer to a hex string without padding or normalization. |
+| [bitsToNibbles](#functions/bitsToNibbles) | Converts a bit count to the equivalent number of hex nibbles (4 bits each). |
+| [nibblesToBits](#functions/nibblesToBits) | Converts a nibble count to the equivalent number of bits. |
+| [toHex](#functions/toHex) | takes any value and tries our best to convert it to a hex string |
+| [hexToBigInt](#functions/hexToBigInt) | Converts a Hex string to a BigInt. |
 
 ### functions
 
@@ -104,23 +114,24 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 ***
 
 ```ts
-function HexRegExMinMax(minBytes?, maxBytes?): RegExp;
+function HexRegExMinMax(minBytes?: number, maxBytes?: number): RegExp;
 ```
 
-## Parameters
-
-### minBytes?
-
-`number` = `0`
+Creates a RegExp matching lowercase hex strings with a byte length in the given range.
 
-### maxBytes?
+## Parameters
 
-`number` = `...`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `minBytes` | `number` | `0` | Minimum number of bytes (default 0) |
+| `maxBytes` | `number` | `...` | Maximum number of bytes |
 
 ## Returns
 
 `RegExp`
 
+A RegExp for validating hex strings within the byte range
+
   ### <a id="HexRegExMinMaxMixedCaseWithPrefix"></a>HexRegExMinMaxMixedCaseWithPrefix
 
 [**@xylabs/hex**](#../README)
@@ -128,23 +139,24 @@ function HexRegExMinMax(minBytes?, maxBytes?): RegExp;
 ***
 
 ```ts
-function HexRegExMinMaxMixedCaseWithPrefix(minBytes?, maxBytes?): RegExp;
+function HexRegExMinMaxMixedCaseWithPrefix(minBytes?: number, maxBytes?: number): RegExp;
 ```
 
-## Parameters
-
-### minBytes?
+Creates a RegExp matching mixed-case hex strings with a 0x prefix and a byte length in the given range.
 
-`number` = `0`
-
-### maxBytes?
+## Parameters
 
-`number` = `...`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `minBytes` | `number` | `0` | Minimum number of bytes (default 0) |
+| `maxBytes` | `number` | `...` | Maximum number of bytes |
 
 ## Returns
 
 `RegExp`
 
+A RegExp for validating prefixed hex strings within the byte range
+
   ### <a id="asAddress"></a>asAddress
 
 [**@xylabs/hex**](#../README)
@@ -154,39 +166,44 @@ function HexRegExMinMaxMixedCaseWithPrefix(minBytes?, maxBytes?): RegExp;
 ## Call Signature
 
 ```ts
-function asAddress(value): BrandedAddress | undefined;
+function asAddress(value: unknown): BrandedAddress | undefined;
 ```
 
-### Parameters
+Attempts to coerce a value into an Address type, returning undefined or throwing based on the assert config.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
 
 ### Returns
 
 `BrandedAddress` \| `undefined`
 
+The value as Address, or undefined if coercion fails and assert is not set
+
 ## Call Signature
 
 ```ts
-function asAddress(value, assert): BrandedAddress;
+function asAddress(value: unknown, assert: AssertConfig): BrandedAddress;
 ```
 
-### Parameters
-
-### value
-
-`unknown`
+Attempts to coerce a value into an Address type, returning undefined or throwing based on the assert config.
 
-### assert
+### Parameters
 
-`AssertConfig`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
+| `assert` | `AssertConfig` | If provided, throws on failure instead of returning undefined |
 
 ### Returns
 
 `BrandedAddress`
 
+The value as Address, or undefined if coercion fails and assert is not set
+
   ### <a id="asAddressV2"></a>asAddressV2
 
 [**@xylabs/hex**](#../README)
@@ -194,20 +211,17 @@ function asAddress(value, assert): BrandedAddress;
 ***
 
 ```ts
-function asAddressV2(value, assert?): BrandedAddress | undefined;
+function asAddressV2(value: unknown, assert?: boolean): BrandedAddress | undefined;
 ```
 
 **`Alpha`**
 
 ## Parameters
 
-### value
-
-`unknown`
-
-### assert?
-
-`boolean` = `false`
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `value` | `unknown` | `undefined` |
+| `assert` | `boolean` | `false` |
 
 ## Returns
 
@@ -222,39 +236,44 @@ function asAddressV2(value, assert?): BrandedAddress | undefined;
 ## Call Signature
 
 ```ts
-function asEthAddress(value): EthAddress | undefined;
+function asEthAddress(value: unknown): EthAddress | undefined;
 ```
 
-### Parameters
+Attempts to coerce a value into an EthAddress, returning undefined or throwing based on the assert config.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
 
 ### Returns
 
 [`EthAddress`](#../type-aliases/EthAddress) \| `undefined`
 
+The value as EthAddress, or undefined if coercion fails and assert is not set
+
 ## Call Signature
 
 ```ts
-function asEthAddress(value, assert): EthAddress;
+function asEthAddress(value: unknown, assert: AssertConfig): EthAddress;
 ```
 
-### Parameters
-
-### value
-
-`unknown`
+Attempts to coerce a value into an EthAddress, returning undefined or throwing based on the assert config.
 
-### assert
+### Parameters
 
-`AssertConfig`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
+| `assert` | `AssertConfig` | If provided, throws on failure instead of returning undefined |
 
 ### Returns
 
 [`EthAddress`](#../type-aliases/EthAddress)
 
+The value as EthAddress, or undefined if coercion fails and assert is not set
+
   ### <a id="asHash"></a>asHash
 
 [**@xylabs/hex**](#../README)
@@ -264,39 +283,44 @@ function asEthAddress(value, assert): EthAddress;
 ## Call Signature
 
 ```ts
-function asHash(value): BrandedHash | undefined;
+function asHash(value: unknown): BrandedHash | undefined;
 ```
 
-### Parameters
+Attempts to coerce a value into a Hash type, returning undefined or throwing based on the assert config.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
 
 ### Returns
 
 [`BrandedHash`](#../type-aliases/BrandedHash) \| `undefined`
 
+The value as Hash, or undefined if coercion fails and assert is not set
+
 ## Call Signature
 
 ```ts
-function asHash(value, assert): BrandedHash;
+function asHash(value: unknown, assert: AssertConfig): BrandedHash;
 ```
 
-### Parameters
+Attempts to coerce a value into a Hash type, returning undefined or throwing based on the assert config.
 
-### value
-
-`unknown`
-
-### assert
+### Parameters
 
-`AssertConfig`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
+| `assert` | `AssertConfig` | If provided, throws on failure instead of returning undefined |
 
 ### Returns
 
 [`BrandedHash`](#../type-aliases/BrandedHash)
 
+The value as Hash, or undefined if coercion fails and assert is not set
+
   ### <a id="asHex"></a>asHex
 
 [**@xylabs/hex**](#../README)
@@ -306,39 +330,44 @@ function asHash(value, assert): BrandedHash;
 ## Call Signature
 
 ```ts
-function asHex(value): BrandedHex | undefined;
+function asHex(value: unknown): BrandedHex | undefined;
 ```
 
-### Parameters
+Attempts to coerce a value into a Hex type, returning undefined or throwing based on the assert config.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
 
 ### Returns
 
 [`BrandedHex`](#../type-aliases/BrandedHex) \| `undefined`
 
+The value as Hex, or undefined if coercion fails and assert is not set
+
 ## Call Signature
 
 ```ts
-function asHex(value, assert): BrandedHex;
+function asHex(value: unknown, assert: AssertConfig): BrandedHex;
 ```
 
-### Parameters
-
-### value
+Attempts to coerce a value into a Hex type, returning undefined or throwing based on the assert config.
 
-`unknown`
-
-### assert
+### Parameters
 
-`AssertConfig`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
+| `assert` | `AssertConfig` | If provided, throws on failure instead of returning undefined |
 
 ### Returns
 
 [`BrandedHex`](#../type-aliases/BrandedHex)
 
+The value as Hex, or undefined if coercion fails and assert is not set
+
   ### <a id="bitsToNibbles"></a>bitsToNibbles
 
 [**@xylabs/hex**](#../README)
@@ -346,19 +375,23 @@ function asHex(value, assert): BrandedHex;
 ***
 
 ```ts
-function bitsToNibbles(value): number;
+function bitsToNibbles(value: number): number;
 ```
 
-## Parameters
+Converts a bit count to the equivalent number of hex nibbles (4 bits each).
 
-### value
+## Parameters
 
-`number`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `number` | The number of bits (must be a multiple of 4) |
 
 ## Returns
 
 `number`
 
+The number of nibbles
+
   ### <a id="hexFrom"></a>hexFrom
 
 [**@xylabs/hex**](#../README)
@@ -366,24 +399,17 @@ function bitsToNibbles(value): number;
 ***
 
 ```ts
-function hexFrom(value, config?): BrandedHex;
+function hexFrom(value: string | number | bigint | ArrayBufferLike, config?: HexConfig): BrandedHex;
 ```
 
 Takes unknown value and tries our best to convert it to a hex string
 
 ## Parameters
 
-### value
-
-Supported types are string, number, bigint, and ArrayBuffer
-
-`string` | `number` | `bigint` | `ArrayBufferLike`
-
-### config?
-
-[`HexConfig`](#../interfaces/HexConfig)
-
-Configuration of output format and validation
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `string` \| `number` \| `bigint` \| `ArrayBufferLike` | Supported types are string, number, bigint, and ArrayBuffer |
+| `config?` | [`HexConfig`](#../interfaces/HexConfig) | Configuration of output format and validation |
 
 ## Returns
 
@@ -396,24 +422,17 @@ Configuration of output format and validation
 ***
 
 ```ts
-function hexFromArrayBuffer(buffer, config?): BrandedHex;
+function hexFromArrayBuffer(buffer: ArrayBufferLike, config?: HexConfig): BrandedHex;
 ```
 
 Convert an ArrayBuffer to a hex string
 
 ## Parameters
 
-### buffer
-
-`ArrayBufferLike`
-
-The buffer to be converted
-
-### config?
-
-[`HexConfig`](#../interfaces/HexConfig)
-
-Configuration of output format and validation
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `buffer` | `ArrayBufferLike` | The buffer to be converted |
+| `config?` | [`HexConfig`](#../interfaces/HexConfig) | Configuration of output format and validation |
 
 ## Returns
 
@@ -426,24 +445,17 @@ Configuration of output format and validation
 ***
 
 ```ts
-function hexFromBigInt(value, config?): BrandedHex;
+function hexFromBigInt(value: bigint, config?: HexConfig): BrandedHex;
 ```
 
 Convert a bigint to a hex string
 
 ## Parameters
 
-### value
-
-`bigint`
-
-The bigint to be converted
-
-### config?
-
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
-
-Configuration of output format and validation
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `bigint` | The bigint to be converted |
+| `config` | [`HexConfig`](#../interfaces/HexConfig) | Configuration of output format and validation |
 
 ## Returns
 
@@ -456,23 +468,24 @@ Configuration of output format and validation
 ***
 
 ```ts
-function hexFromHexString(value, config?): BrandedHex;
+function hexFromHexString(value: string, config?: HexConfig): BrandedHex;
 ```
 
-## Parameters
-
-### value
+Normalizes a hex string by stripping an optional 0x prefix, lowercasing, and padding to byte/bit boundaries.
 
-`string`
-
-### config?
+## Parameters
 
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `string` | The hex string to normalize (with or without 0x prefix) |
+| `config` | [`HexConfig`](#../interfaces/HexConfig) | Configuration for prefix, byteSize, and bitLength padding |
 
 ## Returns
 
 [`BrandedHex`](#../type-aliases/BrandedHex)
 
+The normalized Hex string
+
   ### <a id="hexFromNumber"></a>hexFromNumber
 
 [**@xylabs/hex**](#../README)
@@ -480,23 +493,24 @@ function hexFromHexString(value, config?): BrandedHex;
 ***
 
 ```ts
-function hexFromNumber(value, config?): BrandedHex;
+function hexFromNumber(value: number, config?: HexConfig): BrandedHex;
 ```
 
-## Parameters
-
-### value
+Converts a number to a hex string by converting to BigInt first.
 
-`number`
-
-### config?
+## Parameters
 
-[`HexConfig`](#../interfaces/HexConfig)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `number` | The number to convert |
+| `config?` | [`HexConfig`](#../interfaces/HexConfig) | Optional hex output configuration |
 
 ## Returns
 
 [`BrandedHex`](#../type-aliases/BrandedHex)
 
+The hex string representation
+
   ### <a id="hexToBigInt"></a>hexToBigInt
 
 [**@xylabs/hex**](#../README)
@@ -504,19 +518,23 @@ function hexFromNumber(value, config?): BrandedHex;
 ***
 
 ```ts
-function hexToBigInt(hex): bigint;
+function hexToBigInt(hex: BrandedHex): bigint;
 ```
 
+Converts a Hex string to a BigInt.
+
 ## Parameters
 
-### hex
-
-[`BrandedHex`](#../type-aliases/BrandedHex)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `hex` | [`BrandedHex`](#../type-aliases/BrandedHex) | The hex string to convert |
 
 ## Returns
 
 `bigint`
 
+The BigInt representation of the hex value
+
   ### <a id="isAddress"></a>isAddress
 
 [**@xylabs/hex**](#../README)
@@ -524,23 +542,24 @@ function hexToBigInt(hex): bigint;
 ***
 
 ```ts
-function isAddress(value, config?): value is BrandedAddress;
+function isAddress(value: unknown, config?: HexConfig): value is BrandedAddress;
 ```
 
-## Parameters
-
-### value
-
-`unknown`
+Type guard that checks whether a value is a valid 160-bit address.
 
-### config?
+## Parameters
 
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check |
+| `config` | [`HexConfig`](#../interfaces/HexConfig) | Optional hex config (defaults to 160-bit, no prefix) |
 
 ## Returns
 
 `value is BrandedAddress`
 
+True if the value is a valid Address
+
   ### <a id="isAddressV2"></a>isAddressV2
 
 [**@xylabs/hex**](#../README)
@@ -548,16 +567,16 @@ function isAddress(value, config?): value is BrandedAddress;
 ***
 
 ```ts
-function isAddressV2(value): value is BrandedAddress;
+function isAddressV2(value: unknown): value is BrandedAddress;
 ```
 
 **`Alpha`**
 
 ## Parameters
 
-### value
-
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ## Returns
 
@@ -570,23 +589,24 @@ function isAddressV2(value): value is BrandedAddress;
 ***
 
 ```ts
-function isEthAddress(value, config?): value is EthAddress;
+function isEthAddress(value: unknown, config?: HexConfig): value is EthAddress;
 ```
 
-## Parameters
-
-### value
-
-`unknown`
+Type guard that checks whether a value is a valid 0x-prefixed Ethereum address.
 
-### config?
+## Parameters
 
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check |
+| `config` | [`HexConfig`](#../interfaces/HexConfig) | Optional hex config (defaults to 160-bit with prefix) |
 
 ## Returns
 
 `value is EthAddress`
 
+True if the value is a valid EthAddress
+
   ### <a id="isHash"></a>isHash
 
 [**@xylabs/hex**](#../README)
@@ -594,23 +614,24 @@ function isEthAddress(value, config?): value is EthAddress;
 ***
 
 ```ts
-function isHash(value, bitLength?): value is BrandedHash;
+function isHash(value: unknown, bitLength?: HashBitLength): value is BrandedHash;
 ```
 
-## Parameters
-
-### value
-
-`unknown`
+Type guard that checks whether a value is a valid hash of the specified bit length.
 
-### bitLength?
+## Parameters
 
-[`HashBitLength`](#../type-aliases/HashBitLength) = `256`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `value` | `unknown` | `undefined` | The value to check |
+| `bitLength` | [`HashBitLength`](#../type-aliases/HashBitLength) | `256` | The expected bit length of the hash (defaults to 256) |
 
 ## Returns
 
 `value is BrandedHash`
 
+True if the value is a valid Hash
+
   ### <a id="isHashBitLength"></a>isHashBitLength
 
 [**@xylabs/hex**](#../README)
@@ -618,19 +639,23 @@ function isHash(value, bitLength?): value is BrandedHash;
 ***
 
 ```ts
-function isHashBitLength(value): value is HashBitLength;
+function isHashBitLength(value: unknown): value is HashBitLength;
 ```
 
-## Parameters
+Type guard that checks whether a value is a valid hash bit length.
 
-### value
+## Parameters
 
-`unknown`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check |
 
 ## Returns
 
 `value is HashBitLength`
 
+True if the value is one of the supported HashBitLength values
+
   ### <a id="isHex"></a>isHex
 
 [**@xylabs/hex**](#../README)
@@ -638,23 +663,24 @@ function isHashBitLength(value): value is HashBitLength;
 ***
 
 ```ts
-function isHex(value, config?): value is BrandedHex;
+function isHex(value: unknown, config?: HexConfig): value is BrandedHex;
 ```
 
-## Parameters
-
-### value
+Type guard that checks whether a value is a valid hex string.
 
-`unknown`
-
-### config?
+## Parameters
 
-[`HexConfig`](#../interfaces/HexConfig)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check |
+| `config?` | [`HexConfig`](#../interfaces/HexConfig) | Optional configuration for prefix and bit length validation |
 
 ## Returns
 
 `value is BrandedHex`
 
+True if the value is a valid Hex string
+
   ### <a id="isHexZero"></a>isHexZero
 
 [**@xylabs/hex**](#../README)
@@ -662,19 +688,23 @@ function isHex(value, config?): value is BrandedHex;
 ***
 
 ```ts
-function isHexZero(value?): boolean | undefined;
+function isHexZero(value?: string): boolean | undefined;
 ```
 
-## Parameters
+Checks whether a hex string represents a zero value.
 
-### value?
+## Parameters
 
-`string`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value?` | `string` | The hex string to check |
 
 ## Returns
 
 `boolean` \| `undefined`
 
+True if zero, false if non-zero, or undefined if the input is not a string
+
   ### <a id="nibblesToBits"></a>nibblesToBits
 
 [**@xylabs/hex**](#../README)
@@ -682,19 +712,23 @@ function isHexZero(value?): boolean | undefined;
 ***
 
 ```ts
-function nibblesToBits(value): number;
+function nibblesToBits(value: number): number;
 ```
 
+Converts a nibble count to the equivalent number of bits.
+
 ## Parameters
 
-### value
-
-`number`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `number` | The number of nibbles |
 
 ## Returns
 
 `number`
 
+The number of bits
+
   ### <a id="toAddress"></a>toAddress
 
 [**@xylabs/hex**](#../README)
@@ -702,23 +736,24 @@ function nibblesToBits(value): number;
 ***
 
 ```ts
-function toAddress(value, config?): BrandedAddress;
+function toAddress(value: string | number | bigint | ArrayBufferLike, config?: HexConfig): BrandedAddress;
 ```
 
-## Parameters
-
-### value
-
-`string` | `number` | `bigint` | `ArrayBufferLike`
+Converts a value to a 160-bit Address hex string.
 
-### config?
+## Parameters
 
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `string` \| `number` \| `bigint` \| `ArrayBufferLike` | The value to convert (string, number, bigint, or ArrayBuffer) |
+| `config` | [`HexConfig`](#../interfaces/HexConfig) | Optional hex config (defaults to 160-bit, no prefix) |
 
 ## Returns
 
 `BrandedAddress`
 
+The value as an Address
+
   ### <a id="toAddressV2"></a>toAddressV2
 
 [**@xylabs/hex**](#../README)
@@ -726,20 +761,17 @@ function toAddress(value, config?): BrandedAddress;
 ***
 
 ```ts
-function toAddressV2(value, assert?): BrandedAddress | undefined;
+function toAddressV2(value: unknown, assert?: boolean): BrandedAddress | undefined;
 ```
 
 **`Alpha`**
 
 ## Parameters
 
-### value
-
-`unknown`
-
-### assert?
-
-`boolean` = `false`
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `value` | `unknown` | `undefined` |
+| `assert` | `boolean` | `false` |
 
 ## Returns
 
@@ -752,23 +784,24 @@ function toAddressV2(value, assert?): BrandedAddress | undefined;
 ***
 
 ```ts
-function toEthAddress(value, config?): EthAddress;
+function toEthAddress(value: string | number | bigint | ArrayBufferLike, config?: HexConfig): EthAddress;
 ```
 
-## Parameters
-
-### value
-
-`string` | `number` | `bigint` | `ArrayBufferLike`
+Converts a value to a 0x-prefixed Ethereum address string.
 
-### config?
+## Parameters
 
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `string` \| `number` \| `bigint` \| `ArrayBufferLike` | The value to convert (string, number, bigint, or ArrayBuffer) |
+| `config` | [`HexConfig`](#../interfaces/HexConfig) | Optional hex config (defaults to 160-bit, no inner prefix) |
 
 ## Returns
 
 [`EthAddress`](#../type-aliases/EthAddress)
 
+The value as an EthAddress
+
   ### <a id="toHex"></a>toHex
 
 [**@xylabs/hex**](#../README)
@@ -776,24 +809,17 @@ function toEthAddress(value, config?): EthAddress;
 ***
 
 ```ts
-function toHex(value, config?): BrandedHex;
+function toHex(value: string | number | bigint | ArrayBufferLike, config?: HexConfig): BrandedHex;
 ```
 
 takes any value and tries our best to convert it to a hex string
 
 ## Parameters
 
-### value
-
-Supported types are string, number, bigint, and ArrayBuffer
-
-`string` | `number` | `bigint` | `ArrayBufferLike`
-
-### config?
-
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
-
-Configuration of output format and validation
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `string` \| `number` \| `bigint` \| `ArrayBufferLike` | Supported types are string, number, bigint, and ArrayBuffer |
+| `config` | [`HexConfig`](#../interfaces/HexConfig) | Configuration of output format and validation |
 
 ## Returns
 
@@ -806,19 +832,23 @@ Configuration of output format and validation
 ***
 
 ```ts
-function toHexLegacy(buffer): string;
+function toHexLegacy(buffer: ArrayBuffer): string;
 ```
 
-## Parameters
+Converts an ArrayBuffer to a hex string without padding or normalization.
 
-### buffer
+## Parameters
 
-`ArrayBuffer`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `buffer` | `ArrayBuffer` | The ArrayBuffer to convert |
 
 ## Returns
 
 `string`
 
+A lowercase hex string representation of the buffer
+
 ### interfaces
 
   ### <a id="HexConfig"></a>HexConfig
@@ -831,27 +861,11 @@ Configuration of validation and output format
 
 ## Properties
 
-### bitLength?
-
-```ts
-optional bitLength: number;
-```
-
-***
-
-### byteSize?
-
-```ts
-optional byteSize: number;
-```
-
-***
-
-### prefix?
-
-```ts
-optional prefix: boolean;
-```
+| Property | Type |
+| ------ | ------ |
+| <a id="bitlength"></a> `bitLength?` | `number` |
+| <a id="bytesize"></a> `byteSize?` | `number` |
+| <a id="prefix"></a> `prefix?` | `boolean` |
 
 ### type-aliases
 
@@ -865,6 +879,8 @@ optional prefix: boolean;
 type Address = z.infer<typeof AddressZod>;
 ```
 
+A validated 20-byte address string type, inferred from the AddressZod schema.
+
   ### <a id="AddressTransformZodType"></a>AddressTransformZodType
 
 [**@xylabs/hex**](#../README)
@@ -875,6 +891,8 @@ type Address = z.infer<typeof AddressZod>;
 type AddressTransformZodType = z.infer<typeof AddressTransformZod>;
 ```
 
+The output type of AddressTransformZod after parsing and transformation.
+
   ### <a id="AddressValidationZodType"></a>AddressValidationZodType
 
 [**@xylabs/hex**](#../README)
@@ -885,6 +903,8 @@ type AddressTransformZodType = z.infer<typeof AddressTransformZod>;
 type AddressValidationZodType = z.infer<typeof AddressValidationZod>;
 ```
 
+The output type of AddressValidationZod after parsing.
+
   ### <a id="BrandedHash"></a>BrandedHash
 
 [**@xylabs/hex**](#../README)
@@ -897,6 +917,8 @@ type BrandedHash = Brand<Hex, {
 }>;
 ```
 
+Branded type representing a validated hash hex string.
+
   ### <a id="BrandedHex"></a>BrandedHex
 
 [**@xylabs/hex**](#../README)
@@ -909,6 +931,8 @@ type BrandedHex = Brand<Lowercase<string>, {
 }>;
 ```
 
+Branded type representing a validated lowercase hex string.
+
   ### <a id="EthAddress"></a>EthAddress
 
 [**@xylabs/hex**](#../README)
@@ -921,6 +945,8 @@ type EthAddress = Brand<string, {
 }>;
 ```
 
+Branded type representing a validated Ethereum address with 0x prefix.
+
   ### <a id="Hash"></a>Hash
 
 [**@xylabs/hex**](#../README)
@@ -931,6 +957,8 @@ type EthAddress = Brand<string, {
 type Hash = z.infer<typeof HashZod>;
 ```
 
+A validated hash string type, inferred from the HashZod schema.
+
   ### <a id="HashBitLength"></a>HashBitLength
 
 [**@xylabs/hex**](#../README)
@@ -941,6 +969,8 @@ type Hash = z.infer<typeof HashZod>;
 type HashBitLength = 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096;
 ```
 
+Valid bit lengths for hash values.
+
   ### <a id="Hex"></a>Hex
 
 [**@xylabs/hex**](#../README)
@@ -951,6 +981,8 @@ type HashBitLength = 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096;
 type Hex = z.infer<typeof HexZod>;
 ```
 
+A validated hex string type, inferred from the HexZod schema.
+
 ### variables
 
   ### <a id="ADDRESS_LENGTH"></a>ADDRESS_LENGTH
@@ -963,6 +995,8 @@ type Hex = z.infer<typeof HexZod>;
 const ADDRESS_LENGTH: 40;
 ```
 
+The character length of an address hex string (40 hex characters / 20 bytes).
+
   ### <a id="AddressRegEx"></a>AddressRegEx
 
 [**@xylabs/hex**](#../README)
@@ -973,6 +1007,8 @@ const ADDRESS_LENGTH: 40;
 const AddressRegEx: RegExp;
 ```
 
+Regular expression matching a 20-byte (40 hex character) address string.
+
   ### <a id="AddressTransformZod"></a>AddressTransformZod
 
 [**@xylabs/hex**](#../README)
@@ -983,6 +1019,8 @@ const AddressRegEx: RegExp;
 const AddressTransformZod: ZodPipe<ZodPipe<ZodUnion<readonly [ZodString, ZodBigInt, ZodNumber]>, ZodTransform<string, string | number | bigint>>, ZodTransform<BrandedAddress, string>>;
 ```
 
+Zod schema that accepts a string, bigint, or number and transforms it into a validated Address.
+
   ### <a id="AddressValidationZod"></a>AddressValidationZod
 
 [**@xylabs/hex**](#../README)
@@ -993,6 +1031,8 @@ const AddressTransformZod: ZodPipe<ZodPipe<ZodUnion<readonly [ZodString, ZodBigI
 const AddressValidationZod: ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>;
 ```
 
+Zod schema that validates a string is a properly formatted 40-character hex address.
+
   ### <a id="AddressZod"></a>AddressZod
 
 [**@xylabs/hex**](#../README)
@@ -1003,6 +1043,8 @@ const AddressValidationZod: ZodPipe<ZodString, ZodTransform<BrandedAddress, stri
 const AddressZod: ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>;
 ```
 
+Zod schema that validates and transforms a string into a branded Address type.
+
   ### <a id="BigIntToJsonZod"></a>BigIntToJsonZod
 
 [**@xylabs/hex**](#../README)
@@ -1013,6 +1055,8 @@ const AddressZod: ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>;
 const BigIntToJsonZod: ZodPipe<ZodBigInt, ZodTransform<BrandedHex, bigint>>;
 ```
 
+Zod schema that transforms a non-negative BigInt into a hex string for JSON serialization.
+
   ### <a id="ETH_ZERO_ADDRESS"></a>ETH_ZERO_ADDRESS
 
 [**@xylabs/hex**](#../README)
@@ -1023,6 +1067,8 @@ const BigIntToJsonZod: ZodPipe<ZodBigInt, ZodTransform<BrandedHex, bigint>>;
 const ETH_ZERO_ADDRESS: EthAddress;
 ```
 
+The zero Ethereum address constant (0x followed by 40 zero characters).
+
   ### <a id="EthAddressFromStringSchema"></a>EthAddressFromStringSchema
 
 [**@xylabs/hex**](#../README)
@@ -1047,6 +1093,8 @@ use EthAddressFromStringZod
 const EthAddressFromStringZod: ZodPipe<ZodString, ZodTransform<EthAddress, string>>;
 ```
 
+Zod schema that validates and transforms a string into an EthAddress type.
+
   ### <a id="EthAddressRegEx"></a>EthAddressRegEx
 
 [**@xylabs/hex**](#../README)
@@ -1057,6 +1105,8 @@ const EthAddressFromStringZod: ZodPipe<ZodString, ZodTransform<EthAddress, strin
 const EthAddressRegEx: RegExp;
 ```
 
+Regular expression matching a 20-byte Ethereum address with 0x prefix (mixed case).
+
   ### <a id="EthAddressToStringSchema"></a>EthAddressToStringSchema
 
 [**@xylabs/hex**](#../README)
@@ -1081,6 +1131,8 @@ use EthAddressToStringZod
 const EthAddressToStringZod: ZodString;
 ```
 
+Zod schema that validates a string is a properly formatted Ethereum address.
+
   ### <a id="EthAddressZod"></a>EthAddressZod
 
 [**@xylabs/hex**](#../README)
@@ -1091,6 +1143,8 @@ const EthAddressToStringZod: ZodString;
 const EthAddressZod: ZodString & ZodType<EthAddress, string, $ZodTypeInternals<EthAddress, string>>;
 ```
 
+Zod schema that validates a string as a properly formatted Ethereum address using regex and type guard.
+
   ### <a id="HASH_LENGTH"></a>HASH_LENGTH
 
 [**@xylabs/hex**](#../README)
@@ -1101,6 +1155,8 @@ const EthAddressZod: ZodString & ZodType<EthAddress, string, $ZodTypeInternals<E
 const HASH_LENGTH: 32;
 ```
 
+The byte length of a standard hash (32 bytes / 256 bits).
+
   ### <a id="HashBitLength"></a>HashBitLength
 
 [**@xylabs/hex**](#../README)
@@ -1111,6 +1167,8 @@ const HASH_LENGTH: 32;
 HashBitLength: HashBitLength[];
 ```
 
+Array of all valid hash bit lengths for runtime validation.
+
   ### <a id="HashRegEx"></a>HashRegEx
 
 [**@xylabs/hex**](#../README)
@@ -1121,6 +1179,8 @@ HashBitLength: HashBitLength[];
 const HashRegEx: RegExp;
 ```
 
+Regular expression matching a 32-byte (64 hex character) hash string.
+
   ### <a id="HashToJsonZod"></a>HashToJsonZod
 
 [**@xylabs/hex**](#../README)
@@ -1131,6 +1191,8 @@ const HashRegEx: RegExp;
 const HashToJsonZod: ZodPipe<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>, ZodTransform<string, BrandedHash>>;
 ```
 
+Zod schema that transforms a Hash to a plain string for JSON serialization.
+
   ### <a id="HashZod"></a>HashZod
 
 [**@xylabs/hex**](#../README)
@@ -1141,6 +1203,8 @@ const HashToJsonZod: ZodPipe<ZodPipe<ZodString, ZodTransform<BrandedHash, string
 const HashZod: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>;
 ```
 
+Zod schema that validates and transforms a string into a branded Hash type.
+
   ### <a id="HexRegEx"></a>HexRegEx
 
 [**@xylabs/hex**](#../README)
@@ -1151,6 +1215,8 @@ const HashZod: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>;
 const HexRegEx: RegExp;
 ```
 
+Regular expression matching a lowercase hex string without prefix.
+
   ### <a id="HexRegExWithPrefix"></a>HexRegExWithPrefix
 
 [**@xylabs/hex**](#../README)
@@ -1161,6 +1227,8 @@ const HexRegEx: RegExp;
 const HexRegExWithPrefix: RegExp;
 ```
 
+Regular expression matching a lowercase hex string with a 0x prefix.
+
   ### <a id="HexZod"></a>HexZod
 
 [**@xylabs/hex**](#../README)
@@ -1171,6 +1239,8 @@ const HexRegExWithPrefix: RegExp;
 const HexZod: ZodPipe<ZodString, ZodTransform<BrandedHex, string>>;
 ```
 
+Zod schema that validates and transforms a string into a branded Hex type.
+
   ### <a id="JsonToBigIntZod"></a>JsonToBigIntZod
 
 [**@xylabs/hex**](#../README)
@@ -1181,6 +1251,8 @@ const HexZod: ZodPipe<ZodString, ZodTransform<BrandedHex, string>>;
 const JsonToBigIntZod: ZodPipe<ZodPipe<ZodString, ZodTransform<BrandedHex, string>>, ZodTransform<bigint, BrandedHex>>;
 ```
 
+Zod schema that parses a JSON hex string into a BigInt.
+
   ### <a id="JsonToHashZod"></a>JsonToHashZod
 
 [**@xylabs/hex**](#../README)
@@ -1191,6 +1263,8 @@ const JsonToBigIntZod: ZodPipe<ZodPipe<ZodString, ZodTransform<BrandedHex, strin
 const JsonToHashZod: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>;
 ```
 
+Zod schema that parses a JSON string into a validated Hash, throwing on invalid input.
+
   ### <a id="ZERO_ADDRESS"></a>ZERO_ADDRESS
 
 [**@xylabs/hex**](#../README)
@@ -1201,6 +1275,8 @@ const JsonToHashZod: ZodPipe<ZodString, ZodTransform<BrandedHash, string>>;
 const ZERO_ADDRESS: BrandedAddress;
 ```
 
+A 160-bit zero address constant.
+
   ### <a id="ZERO_HASH"></a>ZERO_HASH
 
 [**@xylabs/hex**](#../README)
@@ -1211,6 +1287,8 @@ const ZERO_ADDRESS: BrandedAddress;
 const ZERO_HASH: BrandedHash;
 ```
 
+A 256-bit zero hash constant.
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)