@xylabs/hex 5.0.95 → 5.0.97

package/README.md

@@ -1,130 +1,76 @@
 # @xylabs/hex
 
-[![logo][]](https://xylabs.com)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![main-build][]][main-build-link]
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
-[![socket-badge][]][socket-link]
+> Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+## Install
 
-Base functionality used throughout XY Labs TypeScript/JavaScript libraries
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
+
+```sh
+yarn add {{name}}
+```
+
+Using pnpm:
+
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
 
+## License
+
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
 ## Reference
 
-**@xylabs/hex**
-
-***
-
-## Interfaces
-
-| Interface | Description |
-| ------ | ------ |
-| [HexConfig](#interfaces/HexConfig) | Configuration of validation and output format |
-
-## Type Aliases
-
-| 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
-
-| 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
-
-| 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
-
-  ### <a id="HexRegExMinMax"></a>HexRegExMinMax
+### packages
+
+  ### hex
+
+    ### .temp-typedoc
+
+      ### functions
+
+        ### <a id="HexRegExMinMax"></a>HexRegExMinMax
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function HexRegExMinMax(minBytes?: number, maxBytes?: number): RegExp;
+function HexRegExMinMax(minBytes?, maxBytes?): RegExp;
 ```
 
 Creates a RegExp matching lowercase hex strings with a byte length in the given range.
 
 ## Parameters
 
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `minBytes` | `number` | `0` | Minimum number of bytes (default 0) |
-| `maxBytes` | `number` | `...` | Maximum number of bytes |
+### minBytes?
+
+`number` = `0`
+
+Minimum number of bytes (default 0)
+
+### maxBytes?
+
+`number` = `...`
+
+Maximum number of bytes
 
 ## Returns
 
@@ -132,24 +78,31 @@ Creates a RegExp matching lowercase hex strings with a byte length in the given
 
 A RegExp for validating hex strings within the byte range
 
-  ### <a id="HexRegExMinMaxMixedCaseWithPrefix"></a>HexRegExMinMaxMixedCaseWithPrefix
+        ### <a id="HexRegExMinMaxMixedCaseWithPrefix"></a>HexRegExMinMaxMixedCaseWithPrefix
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function HexRegExMinMaxMixedCaseWithPrefix(minBytes?: number, maxBytes?: number): RegExp;
+function HexRegExMinMaxMixedCaseWithPrefix(minBytes?, maxBytes?): RegExp;
 ```
 
 Creates a RegExp matching mixed-case hex strings with a 0x prefix and a byte length in the given range.
 
 ## Parameters
 
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `minBytes` | `number` | `0` | Minimum number of bytes (default 0) |
-| `maxBytes` | `number` | `...` | Maximum number of bytes |
+### minBytes?
+
+`number` = `0`
+
+Minimum number of bytes (default 0)
+
+### maxBytes?
+
+`number` = `...`
+
+Maximum number of bytes
 
 ## Returns
 
@@ -157,7 +110,7 @@ Creates a RegExp matching mixed-case hex strings with a 0x prefix and a byte len
 
 A RegExp for validating prefixed hex strings within the byte range
 
-  ### <a id="asAddress"></a>asAddress
+        ### <a id="asAddress"></a>asAddress
 
 [**@xylabs/hex**](#../README)
 
@@ -166,16 +119,18 @@ A RegExp for validating prefixed hex strings within the byte range
 ## Call Signature
 
 ```ts
-function asAddress(value: unknown): BrandedAddress | undefined;
+function asAddress(value?): BrandedAddress | undefined;
 ```
 
 Attempts to coerce a value into an Address type, returning undefined or throwing based on the assert config.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to coerce (must be a string) |
+### value?
+
+`unknown`
+
+The value to coerce (must be a string)
 
 ### Returns
 
@@ -186,17 +141,24 @@ The value as Address, or undefined if coercion fails and assert is not set
 ## Call Signature
 
 ```ts
-function asAddress(value: unknown, assert: AssertConfig): BrandedAddress;
+function asAddress(value, assert): BrandedAddress;
 ```
 
 Attempts to coerce a value into an Address type, returning undefined or throwing based on the assert config.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to coerce (must be a string) |
-| `assert` | `AssertConfig` | If provided, throws on failure instead of returning undefined |
+### value
+
+`unknown`
+
+The value to coerce (must be a string)
+
+### assert
+
+`AssertConfig`
+
+If provided, throws on failure instead of returning undefined
 
 ### Returns
 
@@ -204,30 +166,33 @@ Attempts to coerce a value into an Address type, returning undefined or throwing
 
 The value as Address, or undefined if coercion fails and assert is not set
 
-  ### <a id="asAddressV2"></a>asAddressV2
+        ### <a id="asAddressV2"></a>asAddressV2
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function asAddressV2(value: unknown, assert?: boolean): BrandedAddress | undefined;
+function asAddressV2(value?, assert?): BrandedAddress | undefined;
 ```
 
 **`Alpha`**
 
 ## Parameters
 
-| Parameter | Type | Default value |
-| ------ | ------ | ------ |
-| `value` | `unknown` | `undefined` |
-| `assert` | `boolean` | `false` |
+### value?
+
+`unknown`
+
+### assert?
+
+`boolean` = `false`
 
 ## Returns
 
 `BrandedAddress` \| `undefined`
 
-  ### <a id="asEthAddress"></a>asEthAddress
+        ### <a id="asEthAddress"></a>asEthAddress
 
 [**@xylabs/hex**](#../README)
 
@@ -236,16 +201,18 @@ function asAddressV2(value: unknown, assert?: boolean): BrandedAddress | undefin
 ## Call Signature
 
 ```ts
-function asEthAddress(value: unknown): EthAddress | undefined;
+function asEthAddress(value): EthAddress | undefined;
 ```
 
 Attempts to coerce a value into an EthAddress, returning undefined or throwing based on the assert config.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to coerce (must be a string) |
+### value
+
+`unknown`
+
+The value to coerce (must be a string)
 
 ### Returns
 
@@ -256,17 +223,24 @@ The value as EthAddress, or undefined if coercion fails and assert is not set
 ## Call Signature
 
 ```ts
-function asEthAddress(value: unknown, assert: AssertConfig): EthAddress;
+function asEthAddress(value, assert): EthAddress;
 ```
 
 Attempts to coerce a value into an EthAddress, returning undefined or throwing based on the assert config.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to coerce (must be a string) |
-| `assert` | `AssertConfig` | If provided, throws on failure instead of returning undefined |
+### value
+
+`unknown`
+
+The value to coerce (must be a string)
+
+### assert
+
+`AssertConfig`
+
+If provided, throws on failure instead of returning undefined
 
 ### Returns
 
@@ -274,7 +248,7 @@ Attempts to coerce a value into an EthAddress, returning undefined or throwing b
 
 The value as EthAddress, or undefined if coercion fails and assert is not set
 
-  ### <a id="asHash"></a>asHash
+        ### <a id="asHash"></a>asHash
 
 [**@xylabs/hex**](#../README)
 
@@ -283,16 +257,18 @@ The value as EthAddress, or undefined if coercion fails and assert is not set
 ## Call Signature
 
 ```ts
-function asHash(value: unknown): BrandedHash | undefined;
+function asHash(value): BrandedHash | undefined;
 ```
 
 Attempts to coerce a value into a Hash type, returning undefined or throwing based on the assert config.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to coerce (must be a string) |
+### value
+
+`unknown`
+
+The value to coerce (must be a string)
 
 ### Returns
 
@@ -303,17 +279,24 @@ The value as Hash, or undefined if coercion fails and assert is not set
 ## Call Signature
 
 ```ts
-function asHash(value: unknown, assert: AssertConfig): BrandedHash;
+function asHash(value, assert): BrandedHash;
 ```
 
 Attempts to coerce a value into a Hash type, returning undefined or throwing based on the assert config.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to coerce (must be a string) |
-| `assert` | `AssertConfig` | If provided, throws on failure instead of returning undefined |
+### value
+
+`unknown`
+
+The value to coerce (must be a string)
+
+### assert
+
+`AssertConfig`
+
+If provided, throws on failure instead of returning undefined
 
 ### Returns
 
@@ -321,7 +304,7 @@ Attempts to coerce a value into a Hash type, returning undefined or throwing bas
 
 The value as Hash, or undefined if coercion fails and assert is not set
 
-  ### <a id="asHex"></a>asHex
+        ### <a id="asHex"></a>asHex
 
 [**@xylabs/hex**](#../README)
 
@@ -330,16 +313,18 @@ The value as Hash, or undefined if coercion fails and assert is not set
 ## Call Signature
 
 ```ts
-function asHex(value: unknown): BrandedHex | undefined;
+function asHex(value): BrandedHex | undefined;
 ```
 
 Attempts to coerce a value into a Hex type, returning undefined or throwing based on the assert config.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to coerce (must be a string) |
+### value
+
+`unknown`
+
+The value to coerce (must be a string)
 
 ### Returns
 
@@ -350,17 +335,24 @@ The value as Hex, or undefined if coercion fails and assert is not set
 ## Call Signature
 
 ```ts
-function asHex(value: unknown, assert: AssertConfig): BrandedHex;
+function asHex(value, assert): BrandedHex;
 ```
 
 Attempts to coerce a value into a Hex type, returning undefined or throwing based on the assert config.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to coerce (must be a string) |
-| `assert` | `AssertConfig` | If provided, throws on failure instead of returning undefined |
+### value
+
+`unknown`
+
+The value to coerce (must be a string)
+
+### assert
+
+`AssertConfig`
+
+If provided, throws on failure instead of returning undefined
 
 ### Returns
 
@@ -368,23 +360,25 @@ Attempts to coerce a value into a Hex type, returning undefined or throwing base
 
 The value as Hex, or undefined if coercion fails and assert is not set
 
-  ### <a id="bitsToNibbles"></a>bitsToNibbles
+        ### <a id="bitsToNibbles"></a>bitsToNibbles
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function bitsToNibbles(value: number): number;
+function bitsToNibbles(value): number;
 ```
 
 Converts a bit count to the equivalent number of hex nibbles (4 bits each).
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `number` | The number of bits (must be a multiple of 4) |
+### value
+
+`number`
+
+The number of bits (must be a multiple of 4)
 
 ## Returns
 
@@ -392,93 +386,121 @@ Converts a bit count to the equivalent number of hex nibbles (4 bits each).
 
 The number of nibbles
 
-  ### <a id="hexFrom"></a>hexFrom
+        ### <a id="hexFrom"></a>hexFrom
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function hexFrom(value: string | number | bigint | ArrayBufferLike, config?: HexConfig): BrandedHex;
+function hexFrom(value, config?): BrandedHex;
 ```
 
 Takes unknown value and tries our best to convert it to a hex string
 
 ## Parameters
 
-| 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 |
+### value
+
+`string` \| `number` \| `bigint` \| `ArrayBufferLike`
+
+Supported types are string, number, bigint, and ArrayBuffer
+
+### config?
+
+[`HexConfig`](#../interfaces/HexConfig)
+
+Configuration of output format and validation
 
 ## Returns
 
 [`BrandedHex`](#../type-aliases/BrandedHex)
 
-  ### <a id="hexFromArrayBuffer"></a>hexFromArrayBuffer
+        ### <a id="hexFromArrayBuffer"></a>hexFromArrayBuffer
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function hexFromArrayBuffer(buffer: ArrayBufferLike, config?: HexConfig): BrandedHex;
+function hexFromArrayBuffer(buffer, config?): BrandedHex;
 ```
 
 Convert an ArrayBuffer to a hex string
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `buffer` | `ArrayBufferLike` | The buffer to be converted |
-| `config?` | [`HexConfig`](#../interfaces/HexConfig) | Configuration of output format and validation |
+### buffer
+
+`ArrayBufferLike`
+
+The buffer to be converted
+
+### config?
+
+[`HexConfig`](#../interfaces/HexConfig)
+
+Configuration of output format and validation
 
 ## Returns
 
 [`BrandedHex`](#../type-aliases/BrandedHex)
 
-  ### <a id="hexFromBigInt"></a>hexFromBigInt
+        ### <a id="hexFromBigInt"></a>hexFromBigInt
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function hexFromBigInt(value: bigint, config?: HexConfig): BrandedHex;
+function hexFromBigInt(value, config?): BrandedHex;
 ```
 
 Convert a bigint to a hex string
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `bigint` | The bigint to be converted |
-| `config` | [`HexConfig`](#../interfaces/HexConfig) | Configuration of output format and validation |
+### value
+
+`bigint`
+
+The bigint to be converted
+
+### config?
+
+[`HexConfig`](#../interfaces/HexConfig) = `{}`
+
+Configuration of output format and validation
 
 ## Returns
 
 [`BrandedHex`](#../type-aliases/BrandedHex)
 
-  ### <a id="hexFromHexString"></a>hexFromHexString
+        ### <a id="hexFromHexString"></a>hexFromHexString
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function hexFromHexString(value: string, config?: HexConfig): BrandedHex;
+function hexFromHexString(value, config?): BrandedHex;
 ```
 
 Normalizes a hex string by stripping an optional 0x prefix, lowercasing, and padding to byte/bit boundaries.
 
 ## Parameters
 
-| 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 |
+### value
+
+`string`
+
+The hex string to normalize (with or without 0x prefix)
+
+### config?
+
+[`HexConfig`](#../interfaces/HexConfig) = `{}`
+
+Configuration for prefix, byteSize, and bitLength padding
 
 ## Returns
 
@@ -486,24 +508,31 @@ Normalizes a hex string by stripping an optional 0x prefix, lowercasing, and pad
 
 The normalized Hex string
 
-  ### <a id="hexFromNumber"></a>hexFromNumber
+        ### <a id="hexFromNumber"></a>hexFromNumber
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function hexFromNumber(value: number, config?: HexConfig): BrandedHex;
+function hexFromNumber(value, config?): BrandedHex;
 ```
 
 Converts a number to a hex string by converting to BigInt first.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `number` | The number to convert |
-| `config?` | [`HexConfig`](#../interfaces/HexConfig) | Optional hex output configuration |
+### value
+
+`number`
+
+The number to convert
+
+### config?
+
+[`HexConfig`](#../interfaces/HexConfig)
+
+Optional hex output configuration
 
 ## Returns
 
@@ -511,23 +540,25 @@ Converts a number to a hex string by converting to BigInt first.
 
 The hex string representation
 
-  ### <a id="hexToBigInt"></a>hexToBigInt
+        ### <a id="hexToBigInt"></a>hexToBigInt
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function hexToBigInt(hex: BrandedHex): bigint;
+function hexToBigInt(hex): bigint;
 ```
 
 Converts a Hex string to a BigInt.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `hex` | [`BrandedHex`](#../type-aliases/BrandedHex) | The hex string to convert |
+### hex
+
+[`BrandedHex`](#../type-aliases/BrandedHex)
+
+The hex string to convert
 
 ## Returns
 
@@ -535,24 +566,31 @@ Converts a Hex string to a BigInt.
 
 The BigInt representation of the hex value
 
-  ### <a id="isAddress"></a>isAddress
+        ### <a id="isAddress"></a>isAddress
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function isAddress(value: unknown, config?: HexConfig): value is BrandedAddress;
+function isAddress(value?, config?): value is BrandedAddress;
 ```
 
 Type guard that checks whether a value is a valid 160-bit address.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to check |
-| `config` | [`HexConfig`](#../interfaces/HexConfig) | Optional hex config (defaults to 160-bit, no prefix) |
+### value?
+
+`unknown`
+
+The value to check
+
+### config?
+
+[`HexConfig`](#../interfaces/HexConfig) = `{}`
+
+Optional hex config (defaults to 160-bit, no prefix)
 
 ## Returns
 
@@ -560,46 +598,53 @@ Type guard that checks whether a value is a valid 160-bit address.
 
 True if the value is a valid Address
 
-  ### <a id="isAddressV2"></a>isAddressV2
+        ### <a id="isAddressV2"></a>isAddressV2
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function isAddressV2(value: unknown): value is BrandedAddress;
+function isAddressV2(value?): value is BrandedAddress;
 ```
 
 **`Alpha`**
 
 ## Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `value` | `unknown` |
+### value?
+
+`unknown`
 
 ## Returns
 
 `value is BrandedAddress`
 
-  ### <a id="isEthAddress"></a>isEthAddress
+        ### <a id="isEthAddress"></a>isEthAddress
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function isEthAddress(value: unknown, config?: HexConfig): value is EthAddress;
+function isEthAddress(value?, config?): value is EthAddress;
 ```
 
 Type guard that checks whether a value is a valid 0x-prefixed Ethereum address.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to check |
-| `config` | [`HexConfig`](#../interfaces/HexConfig) | Optional hex config (defaults to 160-bit with prefix) |
+### value?
+
+`unknown`
+
+The value to check
+
+### config?
+
+[`HexConfig`](#../interfaces/HexConfig) = `{}`
+
+Optional hex config (defaults to 160-bit with prefix)
 
 ## Returns
 
@@ -607,24 +652,31 @@ Type guard that checks whether a value is a valid 0x-prefixed Ethereum address.
 
 True if the value is a valid EthAddress
 
-  ### <a id="isHash"></a>isHash
+        ### <a id="isHash"></a>isHash
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function isHash(value: unknown, bitLength?: HashBitLength): value is BrandedHash;
+function isHash(value, bitLength?): value is BrandedHash;
 ```
 
 Type guard that checks whether a value is a valid hash of the specified bit length.
 
 ## Parameters
 
-| 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) |
+### value
+
+`unknown`
+
+The value to check
+
+### bitLength?
+
+[`HashBitLength`](#../type-aliases/HashBitLength) = `256`
+
+The expected bit length of the hash (defaults to 256)
 
 ## Returns
 
@@ -632,23 +684,25 @@ Type guard that checks whether a value is a valid hash of the specified bit leng
 
 True if the value is a valid Hash
 
-  ### <a id="isHashBitLength"></a>isHashBitLength
+        ### <a id="isHashBitLength"></a>isHashBitLength
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function isHashBitLength(value: unknown): value is HashBitLength;
+function isHashBitLength(value): value is HashBitLength;
 ```
 
 Type guard that checks whether a value is a valid hash bit length.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to check |
+### value
+
+`unknown`
+
+The value to check
 
 ## Returns
 
@@ -656,24 +710,31 @@ Type guard that checks whether a value is a valid hash bit length.
 
 True if the value is one of the supported HashBitLength values
 
-  ### <a id="isHex"></a>isHex
+        ### <a id="isHex"></a>isHex
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function isHex(value: unknown, config?: HexConfig): value is BrandedHex;
+function isHex(value, config?): value is BrandedHex;
 ```
 
 Type guard that checks whether a value is a valid hex string.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `unknown` | The value to check |
-| `config?` | [`HexConfig`](#../interfaces/HexConfig) | Optional configuration for prefix and bit length validation |
+### value
+
+`unknown`
+
+The value to check
+
+### config?
+
+[`HexConfig`](#../interfaces/HexConfig)
+
+Optional configuration for prefix and bit length validation
 
 ## Returns
 
@@ -681,23 +742,25 @@ Type guard that checks whether a value is a valid hex string.
 
 True if the value is a valid Hex string
 
-  ### <a id="isHexZero"></a>isHexZero
+        ### <a id="isHexZero"></a>isHexZero
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function isHexZero(value?: string): boolean | undefined;
+function isHexZero(value?): boolean | undefined;
 ```
 
 Checks whether a hex string represents a zero value.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value?` | `string` | The hex string to check |
+### value?
+
+`string`
+
+The hex string to check
 
 ## Returns
 
@@ -705,23 +768,25 @@ Checks whether a hex string represents a zero value.
 
 True if zero, false if non-zero, or undefined if the input is not a string
 
-  ### <a id="nibblesToBits"></a>nibblesToBits
+        ### <a id="nibblesToBits"></a>nibblesToBits
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function nibblesToBits(value: number): number;
+function nibblesToBits(value): number;
 ```
 
 Converts a nibble count to the equivalent number of bits.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `number` | The number of nibbles |
+### value
+
+`number`
+
+The number of nibbles
 
 ## Returns
 
@@ -729,24 +794,31 @@ Converts a nibble count to the equivalent number of bits.
 
 The number of bits
 
-  ### <a id="toAddress"></a>toAddress
+        ### <a id="toAddress"></a>toAddress
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function toAddress(value: string | number | bigint | ArrayBufferLike, config?: HexConfig): BrandedAddress;
+function toAddress(value, config?): BrandedAddress;
 ```
 
 Converts a value to a 160-bit Address hex string.
 
 ## Parameters
 
-| 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) |
+### 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
 
@@ -754,47 +826,57 @@ Converts a value to a 160-bit Address hex string.
 
 The value as an Address
 
-  ### <a id="toAddressV2"></a>toAddressV2
+        ### <a id="toAddressV2"></a>toAddressV2
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function toAddressV2(value: unknown, assert?: boolean): BrandedAddress | undefined;
+function toAddressV2(value, assert?): BrandedAddress | undefined;
 ```
 
 **`Alpha`**
 
 ## Parameters
 
-| Parameter | Type | Default value |
-| ------ | ------ | ------ |
-| `value` | `unknown` | `undefined` |
-| `assert` | `boolean` | `false` |
+### value
+
+`unknown`
+
+### assert?
+
+`boolean` = `false`
 
 ## Returns
 
 `BrandedAddress` \| `undefined`
 
-  ### <a id="toEthAddress"></a>toEthAddress
+        ### <a id="toEthAddress"></a>toEthAddress
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function toEthAddress(value: string | number | bigint | ArrayBufferLike, config?: HexConfig): EthAddress;
+function toEthAddress(value, config?): EthAddress;
 ```
 
 Converts a value to a 0x-prefixed Ethereum address string.
 
 ## Parameters
 
-| 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) |
+### 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
 
@@ -802,46 +884,55 @@ Converts a value to a 0x-prefixed Ethereum address string.
 
 The value as an EthAddress
 
-  ### <a id="toHex"></a>toHex
+        ### <a id="toHex"></a>toHex
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function toHex(value: string | number | bigint | ArrayBufferLike, config?: HexConfig): BrandedHex;
+function toHex(value, config?): BrandedHex;
 ```
 
 takes any value and tries our best to convert it to a hex string
 
 ## Parameters
 
-| 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 |
+### value
+
+`string` \| `number` \| `bigint` \| `ArrayBufferLike`
+
+Supported types are string, number, bigint, and ArrayBuffer
+
+### config?
+
+[`HexConfig`](#../interfaces/HexConfig) = `{}`
+
+Configuration of output format and validation
 
 ## Returns
 
 [`BrandedHex`](#../type-aliases/BrandedHex)
 
-  ### <a id="toHexLegacy"></a>toHexLegacy
+        ### <a id="toHexLegacy"></a>toHexLegacy
 
 [**@xylabs/hex**](#../README)
 
 ***
 
 ```ts
-function toHexLegacy(buffer: ArrayBuffer): string;
+function toHexLegacy(buffer): string;
 ```
 
 Converts an ArrayBuffer to a hex string without padding or normalization.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `buffer` | `ArrayBuffer` | The ArrayBuffer to convert |
+### buffer
+
+`ArrayBuffer`
+
+The ArrayBuffer to convert
 
 ## Returns
 
@@ -849,9 +940,9 @@ Converts an ArrayBuffer to a hex string without padding or normalization.
 
 A lowercase hex string representation of the buffer
 
-### interfaces
+      ### interfaces
 
-  ### <a id="HexConfig"></a>HexConfig
+        ### <a id="HexConfig"></a>HexConfig
 
 [**@xylabs/hex**](#../README)
 
@@ -861,15 +952,31 @@ Configuration of validation and output format
 
 ## Properties
 
-| Property | Type |
-| ------ | ------ |
-| <a id="bitlength"></a> `bitLength?` | `number` |
-| <a id="bytesize"></a> `byteSize?` | `number` |
-| <a id="prefix"></a> `prefix?` | `boolean` |
+### bitLength?
+
+```ts
+optional bitLength?: number;
+```
+
+***
+
+### byteSize?
 
-### type-aliases
+```ts
+optional byteSize?: number;
+```
+
+***
 
-  ### <a id="Address"></a>Address
+### prefix?
+
+```ts
+optional prefix?: boolean;
+```
+
+      ### type-aliases
+
+        ### <a id="Address"></a>Address
 
 [**@xylabs/hex**](#../README)
 
@@ -881,7 +988,7 @@ type Address = z.infer<typeof AddressZod>;
 
 A validated 20-byte address string type, inferred from the AddressZod schema.
 
-  ### <a id="AddressTransformZodType"></a>AddressTransformZodType
+        ### <a id="AddressTransformZodType"></a>AddressTransformZodType
 
 [**@xylabs/hex**](#../README)
 
@@ -893,7 +1000,7 @@ type AddressTransformZodType = z.infer<typeof AddressTransformZod>;
 
 The output type of AddressTransformZod after parsing and transformation.
 
-  ### <a id="AddressValidationZodType"></a>AddressValidationZodType
+        ### <a id="AddressValidationZodType"></a>AddressValidationZodType
 
 [**@xylabs/hex**](#../README)
 
@@ -905,7 +1012,7 @@ type AddressValidationZodType = z.infer<typeof AddressValidationZod>;
 
 The output type of AddressValidationZod after parsing.
 
-  ### <a id="BrandedHash"></a>BrandedHash
+        ### <a id="BrandedHash"></a>BrandedHash
 
 [**@xylabs/hex**](#../README)
 
@@ -919,7 +1026,7 @@ type BrandedHash = Brand<Hex, {
 
 Branded type representing a validated hash hex string.
 
-  ### <a id="BrandedHex"></a>BrandedHex
+        ### <a id="BrandedHex"></a>BrandedHex
 
 [**@xylabs/hex**](#../README)
 
@@ -933,7 +1040,7 @@ type BrandedHex = Brand<Lowercase<string>, {
 
 Branded type representing a validated lowercase hex string.
 
-  ### <a id="EthAddress"></a>EthAddress
+        ### <a id="EthAddress"></a>EthAddress
 
 [**@xylabs/hex**](#../README)
 
@@ -947,7 +1054,7 @@ type EthAddress = Brand<string, {
 
 Branded type representing a validated Ethereum address with 0x prefix.
 
-  ### <a id="Hash"></a>Hash
+        ### <a id="Hash"></a>Hash
 
 [**@xylabs/hex**](#../README)
 
@@ -959,7 +1066,7 @@ type Hash = z.infer<typeof HashZod>;
 
 A validated hash string type, inferred from the HashZod schema.
 
-  ### <a id="HashBitLength"></a>HashBitLength
+        ### <a id="HashBitLength"></a>HashBitLength
 
 [**@xylabs/hex**](#../README)
 
@@ -971,7 +1078,7 @@ type HashBitLength = 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096;
 
 Valid bit lengths for hash values.
 
-  ### <a id="Hex"></a>Hex
+        ### <a id="Hex"></a>Hex
 
 [**@xylabs/hex**](#../README)
 
@@ -983,9 +1090,9 @@ type Hex = z.infer<typeof HexZod>;
 
 A validated hex string type, inferred from the HexZod schema.
 
-### variables
+      ### variables
 
-  ### <a id="ADDRESS_LENGTH"></a>ADDRESS_LENGTH
+        ### <a id="ADDRESS_LENGTH"></a>ADDRESS_LENGTH
 
 [**@xylabs/hex**](#../README)
 
@@ -997,7 +1104,7 @@ const ADDRESS_LENGTH: 40;
 
 The character length of an address hex string (40 hex characters / 20 bytes).
 
-  ### <a id="AddressRegEx"></a>AddressRegEx
+        ### <a id="AddressRegEx"></a>AddressRegEx
 
 [**@xylabs/hex**](#../README)
 
@@ -1009,7 +1116,7 @@ const AddressRegEx: RegExp;
 
 Regular expression matching a 20-byte (40 hex character) address string.
 
-  ### <a id="AddressTransformZod"></a>AddressTransformZod
+        ### <a id="AddressTransformZod"></a>AddressTransformZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1021,7 +1128,7 @@ const AddressTransformZod: ZodPipe<ZodPipe<ZodUnion<readonly [ZodString, ZodBigI
 
 Zod schema that accepts a string, bigint, or number and transforms it into a validated Address.
 
-  ### <a id="AddressValidationZod"></a>AddressValidationZod
+        ### <a id="AddressValidationZod"></a>AddressValidationZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1033,7 +1140,7 @@ const AddressValidationZod: ZodPipe<ZodString, ZodTransform<BrandedAddress, stri
 
 Zod schema that validates a string is a properly formatted 40-character hex address.
 
-  ### <a id="AddressZod"></a>AddressZod
+        ### <a id="AddressZod"></a>AddressZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1045,7 +1152,7 @@ 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
+        ### <a id="BigIntToJsonZod"></a>BigIntToJsonZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1057,7 +1164,7 @@ 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
+        ### <a id="ETH_ZERO_ADDRESS"></a>ETH_ZERO_ADDRESS
 
 [**@xylabs/hex**](#../README)
 
@@ -1069,7 +1176,7 @@ const ETH_ZERO_ADDRESS: EthAddress;
 
 The zero Ethereum address constant (0x followed by 40 zero characters).
 
-  ### <a id="EthAddressFromStringSchema"></a>EthAddressFromStringSchema
+        ### <a id="EthAddressFromStringSchema"></a>EthAddressFromStringSchema
 
 [**@xylabs/hex**](#../README)
 
@@ -1083,7 +1190,7 @@ const EthAddressFromStringSchema: ZodPipe<ZodString, ZodTransform<EthAddress, st
 
 use EthAddressFromStringZod
 
-  ### <a id="EthAddressFromStringZod"></a>EthAddressFromStringZod
+        ### <a id="EthAddressFromStringZod"></a>EthAddressFromStringZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1095,7 +1202,7 @@ const EthAddressFromStringZod: ZodPipe<ZodString, ZodTransform<EthAddress, strin
 
 Zod schema that validates and transforms a string into an EthAddress type.
 
-  ### <a id="EthAddressRegEx"></a>EthAddressRegEx
+        ### <a id="EthAddressRegEx"></a>EthAddressRegEx
 
 [**@xylabs/hex**](#../README)
 
@@ -1107,7 +1214,7 @@ const EthAddressRegEx: RegExp;
 
 Regular expression matching a 20-byte Ethereum address with 0x prefix (mixed case).
 
-  ### <a id="EthAddressToStringSchema"></a>EthAddressToStringSchema
+        ### <a id="EthAddressToStringSchema"></a>EthAddressToStringSchema
 
 [**@xylabs/hex**](#../README)
 
@@ -1121,7 +1228,7 @@ const EthAddressToStringSchema: ZodString = EthAddressToStringZod;
 
 use EthAddressToStringZod
 
-  ### <a id="EthAddressToStringZod"></a>EthAddressToStringZod
+        ### <a id="EthAddressToStringZod"></a>EthAddressToStringZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1133,7 +1240,7 @@ const EthAddressToStringZod: ZodString;
 
 Zod schema that validates a string is a properly formatted Ethereum address.
 
-  ### <a id="EthAddressZod"></a>EthAddressZod
+        ### <a id="EthAddressZod"></a>EthAddressZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1145,7 +1252,7 @@ const EthAddressZod: ZodString & ZodType<EthAddress, string, $ZodTypeInternals<E
 
 Zod schema that validates a string as a properly formatted Ethereum address using regex and type guard.
 
-  ### <a id="HASH_LENGTH"></a>HASH_LENGTH
+        ### <a id="HASH_LENGTH"></a>HASH_LENGTH
 
 [**@xylabs/hex**](#../README)
 
@@ -1157,7 +1264,7 @@ const HASH_LENGTH: 32;
 
 The byte length of a standard hash (32 bytes / 256 bits).
 
-  ### <a id="HashBitLength"></a>HashBitLength
+        ### <a id="HashBitLength"></a>HashBitLength
 
 [**@xylabs/hex**](#../README)
 
@@ -1169,7 +1276,7 @@ HashBitLength: HashBitLength[];
 
 Array of all valid hash bit lengths for runtime validation.
 
-  ### <a id="HashRegEx"></a>HashRegEx
+        ### <a id="HashRegEx"></a>HashRegEx
 
 [**@xylabs/hex**](#../README)
 
@@ -1181,7 +1288,7 @@ const HashRegEx: RegExp;
 
 Regular expression matching a 32-byte (64 hex character) hash string.
 
-  ### <a id="HashToJsonZod"></a>HashToJsonZod
+        ### <a id="HashToJsonZod"></a>HashToJsonZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1193,7 +1300,7 @@ const HashToJsonZod: ZodPipe<ZodPipe<ZodString, ZodTransform<BrandedHash, string
 
 Zod schema that transforms a Hash to a plain string for JSON serialization.
 
-  ### <a id="HashZod"></a>HashZod
+        ### <a id="HashZod"></a>HashZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1205,7 +1312,7 @@ 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
+        ### <a id="HexRegEx"></a>HexRegEx
 
 [**@xylabs/hex**](#../README)
 
@@ -1217,7 +1324,7 @@ const HexRegEx: RegExp;
 
 Regular expression matching a lowercase hex string without prefix.
 
-  ### <a id="HexRegExWithPrefix"></a>HexRegExWithPrefix
+        ### <a id="HexRegExWithPrefix"></a>HexRegExWithPrefix
 
 [**@xylabs/hex**](#../README)
 
@@ -1229,7 +1336,7 @@ const HexRegExWithPrefix: RegExp;
 
 Regular expression matching a lowercase hex string with a 0x prefix.
 
-  ### <a id="HexZod"></a>HexZod
+        ### <a id="HexZod"></a>HexZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1241,7 +1348,7 @@ 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
+        ### <a id="JsonToBigIntZod"></a>JsonToBigIntZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1253,7 +1360,7 @@ const JsonToBigIntZod: ZodPipe<ZodPipe<ZodString, ZodTransform<BrandedHex, strin
 
 Zod schema that parses a JSON hex string into a BigInt.
 
-  ### <a id="JsonToHashZod"></a>JsonToHashZod
+        ### <a id="JsonToHashZod"></a>JsonToHashZod
 
 [**@xylabs/hex**](#../README)
 
@@ -1265,7 +1372,7 @@ 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
+        ### <a id="ZERO_ADDRESS"></a>ZERO_ADDRESS
 
 [**@xylabs/hex**](#../README)
 
@@ -1277,7 +1384,7 @@ const ZERO_ADDRESS: BrandedAddress;
 
 A 160-bit zero address constant.
 
-  ### <a id="ZERO_HASH"></a>ZERO_HASH
+        ### <a id="ZERO_HASH"></a>ZERO_HASH
 
 [**@xylabs/hex**](#../README)
 
@@ -1290,41 +1397,7 @@ const ZERO_HASH: BrandedHash;
 A 256-bit zero hash constant.
 
 
-Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
-
-## Maintainers
-
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
-
-## License
-
-> See the [LICENSE](LICENSE) file for license details
-
-## Credits
-
-[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
-
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
-
-[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/hex.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/hex
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
-
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/hex
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/hex
-
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/hex/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/hex
-
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/hex
-[socket-link]: https://socket.dev/npm/package/@xylabs/hex
+[license-badge]: https://img.shields.io/npm/l/@xylabs/hex.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE