npm - @xylabs/hex - Versions diffs - 5.0.84 → 5.0.86 - Mend

@xylabs/hex 5.0.84 → 5.0.86

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md +221 -379
package/dist/neutral/address/is.d.ts +2 -2
package/dist/neutral/address/is.d.ts.map +1 -1
package/dist/neutral/index.mjs +2 -2
package/dist/neutral/index.mjs.map +1 -1
package/package.json +6 -6

package/README.md CHANGED Viewed

@@ -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,24 +114,17 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 ***
 ```ts
-function HexRegExMinMax(minBytes?, maxBytes?): RegExp;
+function HexRegExMinMax(minBytes?: number, maxBytes?: number): RegExp;
 ```
 Creates a RegExp matching lowercase hex strings with a byte length in the given range.
 ## Parameters
-### minBytes?
-`number` = `0`
-Minimum number of bytes (default 0)
-### maxBytes?
-`number` = `...`
-Maximum number of bytes
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `minBytes` | `number` | `0` | Minimum number of bytes (default 0) |
+| `maxBytes` | `number` | `...` | Maximum number of bytes |
 ## Returns
@@ -136,24 +139,17 @@ A RegExp for validating hex strings within the byte range
 ***
 ```ts
-function HexRegExMinMaxMixedCaseWithPrefix(minBytes?, maxBytes?): RegExp;
+function HexRegExMinMaxMixedCaseWithPrefix(minBytes?: number, maxBytes?: number): RegExp;
 ```
 Creates a RegExp matching mixed-case hex strings with a 0x prefix and a byte length in the given range.
 ## Parameters
-### minBytes?
-`number` = `0`
-Minimum number of bytes (default 0)
-### maxBytes?
-`number` = `...`
-Maximum number of bytes
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `minBytes` | `number` | `0` | Minimum number of bytes (default 0) |
+| `maxBytes` | `number` | `...` | Maximum number of bytes |
 ## Returns
@@ -170,18 +166,16 @@ A RegExp for validating prefixed hex strings within the byte range
 ## Call Signature
 ```ts
-function asAddress(value): BrandedAddress | undefined;
+function asAddress(value: unknown): BrandedAddress | undefined;
 ```
 Attempts to coerce a value into an Address type, returning undefined or throwing based on the assert config.
 ### Parameters
-### value
-`unknown`
-The value to coerce (must be a string)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
 ### Returns
@@ -192,24 +186,17 @@ 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;
 ```
 Attempts to coerce a value into an Address type, returning undefined or throwing based on the assert config.
 ### Parameters
-### value
-`unknown`
-The value to coerce (must be a string)
-### assert
-`AssertConfig`
-If provided, throws on failure instead of returning undefined
+| 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
@@ -224,20 +211,17 @@ The value as Address, or undefined if coercion fails and assert is not set
 ***
 ```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
@@ -252,18 +236,16 @@ function asAddressV2(value, assert?): BrandedAddress | undefined;
 ## Call Signature
 ```ts
-function asEthAddress(value): EthAddress | undefined;
+function asEthAddress(value: unknown): EthAddress | undefined;
 ```
 Attempts to coerce a value into an EthAddress, returning undefined or throwing based on the assert config.
 ### Parameters
-### value
-`unknown`
-The value to coerce (must be a string)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
 ### Returns
@@ -274,24 +256,17 @@ 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;
 ```
 Attempts to coerce a value into an EthAddress, returning undefined or throwing based on the assert config.
 ### Parameters
-### value
-`unknown`
-The value to coerce (must be a string)
-### assert
-`AssertConfig`
-If provided, throws on failure instead of returning undefined
+| 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
@@ -308,18 +283,16 @@ The value as EthAddress, or undefined if coercion fails and assert is not set
 ## Call Signature
 ```ts
-function asHash(value): BrandedHash | undefined;
+function asHash(value: unknown): BrandedHash | undefined;
 ```
 Attempts to coerce a value into a Hash type, returning undefined or throwing based on the assert config.
 ### Parameters
-### value
-`unknown`
-The value to coerce (must be a string)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
 ### Returns
@@ -330,24 +303,17 @@ 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;
 ```
 Attempts to coerce a value into a Hash type, returning undefined or throwing based on the assert config.
 ### Parameters
-### value
-`unknown`
-The value to coerce (must be a string)
-### assert
-`AssertConfig`
-If provided, throws on failure instead of returning undefined
+| 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
@@ -364,18 +330,16 @@ The value as Hash, or undefined if coercion fails and assert is not set
 ## Call Signature
 ```ts
-function asHex(value): BrandedHex | undefined;
+function asHex(value: unknown): BrandedHex | undefined;
 ```
 Attempts to coerce a value into a Hex type, returning undefined or throwing based on the assert config.
 ### Parameters
-### value
-`unknown`
-The value to coerce (must be a string)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to coerce (must be a string) |
 ### Returns
@@ -386,24 +350,17 @@ 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;
 ```
 Attempts to coerce a value into a Hex type, returning undefined or throwing based on the assert config.
 ### Parameters
-### value
-`unknown`
-The value to coerce (must be a string)
-### assert
-`AssertConfig`
-If provided, throws on failure instead of returning undefined
+| 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
@@ -418,18 +375,16 @@ The value as Hex, or undefined if coercion fails and assert is not set
 ***
 ```ts
-function bitsToNibbles(value): number;
+function bitsToNibbles(value: number): number;
 ```
 Converts a bit count to the equivalent number of hex nibbles (4 bits each).
 ## Parameters
-### value
-`number`
-The number of bits (must be a multiple of 4)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `number` | The number of bits (must be a multiple of 4) |
 ## Returns
@@ -444,24 +399,17 @@ The number of nibbles
 ***
 ```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
@@ -474,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
@@ -504,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
@@ -534,24 +468,17 @@ Configuration of output format and validation
 ***
 ```ts
-function hexFromHexString(value, config?): BrandedHex;
+function hexFromHexString(value: string, config?: HexConfig): BrandedHex;
 ```
 Normalizes a hex string by stripping an optional 0x prefix, lowercasing, and padding to byte/bit boundaries.
 ## Parameters
-### value
-`string`
-The hex string to normalize (with or without 0x prefix)
-### config?
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
-Configuration for prefix, byteSize, and bitLength padding
+| 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
@@ -566,24 +493,17 @@ The normalized Hex string
 ***
 ```ts
-function hexFromNumber(value, config?): BrandedHex;
+function hexFromNumber(value: number, config?: HexConfig): BrandedHex;
 ```
 Converts a number to a hex string by converting to BigInt first.
 ## Parameters
-### value
-`number`
-The number to convert
-### config?
-[`HexConfig`](#../interfaces/HexConfig)
-Optional hex output configuration
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `number` | The number to convert |
+| `config?` | [`HexConfig`](#../interfaces/HexConfig) | Optional hex output configuration |
 ## Returns
@@ -598,18 +518,16 @@ The hex string representation
 ***
 ```ts
-function hexToBigInt(hex): bigint;
+function hexToBigInt(hex: BrandedHex): bigint;
 ```
 Converts a Hex string to a BigInt.
 ## Parameters
-### hex
-[`BrandedHex`](#../type-aliases/BrandedHex)
-The hex string to convert
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `hex` | [`BrandedHex`](#../type-aliases/BrandedHex) | The hex string to convert |
 ## Returns
@@ -624,24 +542,17 @@ The BigInt representation of the hex value
 ***
 ```ts
-function isAddress(value, config?): value is BrandedAddress;
+function isAddress(value: unknown, config?: HexConfig): value is BrandedAddress;
 ```
 Type guard that checks whether a value is a valid 160-bit address.
 ## Parameters
-### value
-`unknown`
-The value to check
-### config?
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
-Optional hex config (defaults to 160-bit, no prefix)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check |
+| `config` | [`HexConfig`](#../interfaces/HexConfig) | Optional hex config (defaults to 160-bit, no prefix) |
 ## Returns
@@ -656,16 +567,16 @@ True if the value is a valid Address
 ***
 ```ts
-function isAddressV2(value): value is BrandedAddress;
+function isAddressV2(value: unknown): value is BrandedAddress;
 ```
 **`Alpha`**
 ## Parameters
-### value
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 ## Returns
@@ -678,24 +589,17 @@ function isAddressV2(value): value is BrandedAddress;
 ***
 ```ts
-function isEthAddress(value, config?): value is EthAddress;
+function isEthAddress(value: unknown, config?: HexConfig): value is EthAddress;
 ```
 Type guard that checks whether a value is a valid 0x-prefixed Ethereum address.
 ## Parameters
-### value
-`unknown`
-The value to check
-### config?
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
-Optional hex config (defaults to 160-bit with prefix)
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check |
+| `config` | [`HexConfig`](#../interfaces/HexConfig) | Optional hex config (defaults to 160-bit with prefix) |
 ## Returns
@@ -710,24 +614,17 @@ True if the value is a valid EthAddress
 ***
 ```ts
-function isHash(value, bitLength?): value is BrandedHash;
+function isHash(value: unknown, bitLength?: HashBitLength): value is BrandedHash;
 ```
 Type guard that checks whether a value is a valid hash of the specified bit length.
 ## Parameters
-### value
-`unknown`
-The value to check
-### bitLength?
-[`HashBitLength`](#../type-aliases/HashBitLength) = `256`
-The expected bit length of the hash (defaults to 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
@@ -742,18 +639,16 @@ True if the value is a valid Hash
 ***
 ```ts
-function isHashBitLength(value): value is HashBitLength;
+function isHashBitLength(value: unknown): value is HashBitLength;
 ```
 Type guard that checks whether a value is a valid hash bit length.
 ## Parameters
-### value
-`unknown`
-The value to check
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check |
 ## Returns
@@ -768,24 +663,17 @@ True if the value is one of the supported HashBitLength values
 ***
 ```ts
-function isHex(value, config?): value is BrandedHex;
+function isHex(value: unknown, config?: HexConfig): value is BrandedHex;
 ```
 Type guard that checks whether a value is a valid hex string.
 ## Parameters
-### value
-`unknown`
-The value to check
-### config?
-[`HexConfig`](#../interfaces/HexConfig)
-Optional configuration for prefix and bit length validation
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value to check |
+| `config?` | [`HexConfig`](#../interfaces/HexConfig) | Optional configuration for prefix and bit length validation |
 ## Returns
@@ -800,18 +688,16 @@ True if the value is a valid Hex string
 ***
 ```ts
-function isHexZero(value?): boolean | undefined;
+function isHexZero(value?: string): boolean | undefined;
 ```
 Checks whether a hex string represents a zero value.
 ## Parameters
-### value?
-`string`
-The hex string to check
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value?` | `string` | The hex string to check |
 ## Returns
@@ -826,18 +712,16 @@ True if zero, false if non-zero, or undefined if the input is not a string
 ***
 ```ts
-function nibblesToBits(value): number;
+function nibblesToBits(value: number): number;
 ```
 Converts a nibble count to the equivalent number of bits.
 ## Parameters
-### value
-`number`
-The number of nibbles
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `number` | The number of nibbles |
 ## Returns
@@ -852,24 +736,17 @@ The number of bits
 ***
 ```ts
-function toAddress(value, config?): BrandedAddress;
+function toAddress(value: string | number | bigint | ArrayBufferLike, config?: HexConfig): BrandedAddress;
 ```
 Converts a value to a 160-bit Address hex string.
 ## Parameters
-### value
-The value to convert (string, number, bigint, or ArrayBuffer)
-`string` | `number` | `bigint` | `ArrayBufferLike`
-### config?
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
-Optional hex config (defaults to 160-bit, no prefix)
+| 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
@@ -884,20 +761,17 @@ The value as an Address
 ***
 ```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
@@ -910,24 +784,17 @@ function toAddressV2(value, assert?): BrandedAddress | undefined;
 ***
 ```ts
-function toEthAddress(value, config?): EthAddress;
+function toEthAddress(value: string | number | bigint | ArrayBufferLike, config?: HexConfig): EthAddress;
 ```
 Converts a value to a 0x-prefixed Ethereum address string.
 ## Parameters
-### value
-The value to convert (string, number, bigint, or ArrayBuffer)
-`string` | `number` | `bigint` | `ArrayBufferLike`
-### config?
-[`HexConfig`](#../interfaces/HexConfig) = `{}`
-Optional hex config (defaults to 160-bit, no inner prefix)
+| 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
@@ -942,24 +809,17 @@ The value as an 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
@@ -972,18 +832,16 @@ Configuration of output format and validation
 ***
 ```ts
-function toHexLegacy(buffer): string;
+function toHexLegacy(buffer: ArrayBuffer): string;
 ```
 Converts an ArrayBuffer to a hex string without padding or normalization.
 ## Parameters
-### buffer
-`ArrayBuffer`
-The ArrayBuffer to convert
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `buffer` | `ArrayBuffer` | The ArrayBuffer to convert |
 ## Returns
@@ -1003,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

package/dist/neutral/address/is.d.ts CHANGED Viewed

@@ -6,7 +6,7 @@ import type { Address } from './address.ts';
  * @param config - Optional hex config (defaults to 160-bit, no prefix)
  * @returns True if the value is a valid Address
  */
-export declare const isAddress: (value: unknown, config?: HexConfig) => value is Address;
+export declare const isAddress: (value?: unknown, config?: HexConfig) => value is Address;
 /** @alpha */
-export declare function isAddressV2(value: unknown): value is Address;
+export declare function isAddressV2(value?: unknown): value is Address;
 //# sourceMappingURL=is.d.ts.map

package/dist/neutral/address/is.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"is.d.ts","sourceRoot":"","sources":["../../../src/address/is.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAEhD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAG3C;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,~~OAAO~~,OAAO,EAAE,SAAQ,SAAc,KAAG,KAAK,IAAI,~~OAG3E~~,CAAA;AAED,aAAa;AACb,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,~~CAE5D~~"}
1	+ {"version":3,"file":"is.d.ts","sourceRoot":"","sources":["../../../src/address/is.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAEhD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAG3C;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,EAAE,SAAQ,SAAc,KAAG,KAAK,IAAI,OAG5E,CAAA;AAED,aAAa;AACb,wBAAgB,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAE7D"}

package/dist/neutral/index.mjs CHANGED Viewed

@@ -140,7 +140,7 @@ var toHex = (value, config = {}) => {
 };
 // src/address/AddressValidationZod.ts
-var AddressValidationZod = z3.string().refine((x) => HexZod.safeParse(x)).refine((x) => x.length === ADDRESS_LENGTH, { error: (e) => new Error(`Address must have 40 characters [${e.input}]`) }).transform((v) => v);
+var AddressValidationZod = z3.string().refine((x) => HexZod.safeParse(x).success).refine((x) => x.length === ADDRESS_LENGTH, { error: (e) => new Error(`Address must have 40 characters [${e.input}]`) }).transform((v) => v);
 // src/address/AddressTransformZod.ts
 var AddressTransformZod = z4.union([z4.string(), z4.bigint(), z4.number()]).transform((value) => {
@@ -179,7 +179,7 @@ function asAddress(value, assert) {
     let stringValue = void 0;
     switch (typeof value) {
       case "string": {
-        stringValue = hexFromHexString(value, { prefix: false });
+        stringValue = hexFromHexString(value, { prefix: false, byteSize: 4 });
         break;
       }
       default: {

package/dist/neutral/index.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../../src/address/address.ts","../../src/HexRegEx.ts","../../src/address/AddressTransformZod.ts","../../src/address/AddressValidationZod.ts","../../src/hex/as.ts","../../src/hex/from/fromHexString.ts","../../src/hex/nibble.ts","../../src/hex/is.ts","../../src/hex/from/fromArrayBuffer.ts","../../src/hex/from/fromBigInt.ts","../../src/hex/from/fromNumber.ts","../../src/hex/from/from.ts","../../src/hex/hex.ts","../../src/hex/isHexZero.ts","../../src/hex/legacy.ts","../../src/hex/to.ts","../../src/address/as.ts","../../src/address/is.ts","../../src/address/to.ts","../../src/ethAddress.ts","../../src/hash/as.ts","../../src/hash/is.ts","../../src/hash/hash.ts","../../src/hash/zod.ts","../../src/hexToBigInt.ts","../../src/zod.ts"],"sourcesContent":["import type { Brand } from '@xylabs/typeof'\nimport * as z from 'zod'\n\nimport { type Hex } from '../hex/index.ts'\nimport { HexRegExMinMax } from '../HexRegEx.ts'\n\n/** A 160-bit zero address constant. /\nexport const ZERO_ADDRESS = '0000000000000000000000000000000000000000' as Address\n/* The character length of an address hex string (40 hex characters / 20 bytes). /\nexport const ADDRESS_LENGTH = 40 as const\n\n/* Regular expression matching a 20-byte (40 hex character) address string. /\nexport const AddressRegEx = HexRegExMinMax(ADDRESS_LENGTH / 2, ADDRESS_LENGTH / 2)\n\ntype BrandedAddress = Brand<Hex, { readonly __address: true }>\n\n/* Zod schema that validates and transforms a string into a branded Address type. /\nexport const AddressZod = z.string().regex(AddressRegEx).transform<BrandedAddress>(v => v as BrandedAddress)\n\n/* A validated 20-byte address string type, inferred from the AddressZod schema. /\nexport type Address = z.infer<typeof AddressZod>\n","/\n Creates a RegExp matching lowercase hex strings with a byte length in the given range.\n * @param minBytes - Minimum number of bytes (default 0)\n * @param maxBytes - Maximum number of bytes\n * @returns A RegExp for validating hex strings within the byte range\n /\nexport const HexRegExMinMax = (minBytes = 0, maxBytes: number = (Number.MAX_SAFE_INTEGER / 2)) => {\n return new RegExp(`^[a-f0-9]{${minBytes 2},${maxBytes * 2}}$`)\n}\n\n/*\n Creates a RegExp matching mixed-case hex strings with a 0x prefix and a byte length in the given range.\n * @param minBytes - Minimum number of bytes (default 0)\n * @param maxBytes - Maximum number of bytes\n * @returns A RegExp for validating prefixed hex strings within the byte range\n /\nexport const HexRegExMinMaxMixedCaseWithPrefix = (minBytes = 0, maxBytes: number = (Number.MAX_SAFE_INTEGER / 2)) => {\n return new RegExp(`^0x[a-fA-F0-9]{${minBytes 2},${maxBytes * 2}}$`)\n}\n\n/** Regular expression matching a lowercase hex string without prefix. /\nexport const HexRegEx = /^[0-9a-f]+$/\n/* Regular expression matching a lowercase hex string with a 0x prefix. /\nexport const HexRegExWithPrefix = /^0x[0-9a-f]+$/\n","import as z from 'zod'\n\nimport { type Address, ADDRESS_LENGTH } from './address.ts'\nimport { AddressValidationZod } from './AddressValidationZod.ts'\n\n/** Zod schema that accepts a string, bigint, or number and transforms it into a validated Address. /\nexport const AddressTransformZod = z.union([z.string(), z.bigint(), z.number()])\n .transform((value) => {\n switch (typeof value) {\n case 'bigint': {\n return value.toString(16).padStart(ADDRESS_LENGTH, '0')\n }\n case 'string': {\n if (value.startsWith('0x')) {\n return value.slice(2)\n }\n return value\n }\n case 'number': {\n return BigInt(value).toString(16).padStart(ADDRESS_LENGTH, '0')\n }\n }\n })\n .refine(x => AddressValidationZod.safeParse(x).data)\n .transform(x => x as Address)\n\n/* The output type of AddressTransformZod after parsing and transformation. /\nexport type AddressTransformZodType = z.infer<typeof AddressTransformZod>\n","import as z from 'zod'\n\nimport { HexZod } from '../hex/index.ts'\nimport type { Address } from './address.ts'\nimport { ADDRESS_LENGTH } from './address.ts'\n\n/** Zod schema that validates a string is a properly formatted 40-character hex address. /\nexport const AddressValidationZod = z.string()\n .refine(x => HexZod.safeParse(x))\n .refine(x => x.length === ADDRESS_LENGTH, { error: e => new Error(`Address must have 40 characters [${e.input}]`) })\n .transform(v => v as Address)\n\n/* The output type of AddressValidationZod after parsing. /\nexport type AddressValidationZodType = z.infer<typeof AddressValidationZod>\n","import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\n\nimport { hexFromHexString } from './from/index.ts'\nimport type { Hex } from './hex.ts'\nimport { isHex } from './is.ts'\n\n/\n Attempts to coerce a value into a Hex type, returning undefined or throwing based on the assert config.\n * @param value - The value to coerce (must be a string)\n * @param assert - If provided, throws on failure instead of returning undefined\n * @returns The value as Hex, or undefined if coercion fails and assert is not set\n /\nexport function asHex(value: unknown): Hex \| undefined\nexport function asHex(value: unknown, assert: AssertConfig): Hex\nexport function asHex(value: unknown, assert?: AssertConfig): Hex \| undefined {\n let stringValue: string \| undefined = undefined\n\n switch (typeof value) {\n case 'string': {\n stringValue = hexFromHexString(value)\n break\n }\n default: {\n return assertError(value, assert, `Unsupported type [${typeof value}]`)\n }\n }\n\n return isHex(stringValue) ? stringValue : assertError(value, assert, `Value is not Hex [${value}]`)\n}\n","import { isNumber } from '@xylabs/typeof'\n\nimport type { Hex, HexConfig } from '../hex.ts'\nimport { isHex } from '../is.ts'\nimport { bitsToNibbles } from '../nibble.ts'\n\n/\n Normalizes a hex string by stripping an optional 0x prefix, lowercasing, and padding to byte/bit boundaries.\n * @param value - The hex string to normalize (with or without 0x prefix)\n * @param config - Configuration for prefix, byteSize, and bitLength padding\n * @returns The normalized Hex string\n /\nexport const hexFromHexString = (value: string, config: HexConfig = {}): Hex => {\n const {\n prefix = false, byteSize = 8, bitLength,\n } = config\n const nibbleBoundary = bitsToNibbles(byteSize)\n const unEvened = (value.startsWith('0x') ? value.slice(2) : value).toLowerCase()\n if (isHex(unEvened)) {\n const evenCharacters = unEvened.padStart(Math.ceil(unEvened.length / nibbleBoundary) nibbleBoundary, '0')\n const padded = isNumber(bitLength) ? evenCharacters.padStart(bitLength / 4, '0') : evenCharacters\n return (prefix ? `0x${padded}` : padded).toLowerCase() as Hex\n } else {\n throw new Error('Received string is not a value hex')\n }\n}\n","/*\n Converts a bit count to the equivalent number of hex nibbles (4 bits each).\n * @param value - The number of bits (must be a multiple of 4)\n * @returns The number of nibbles\n /\nexport const bitsToNibbles = (value: number): number => {\n const nibbles = value >> 2\n if (value !== nibbles << 2) throw new Error('Bits for nibbles must multiple of 4')\n return nibbles\n}\n\n/\n Converts a nibble count to the equivalent number of bits.\n * @param value - The number of nibbles\n * @returns The number of bits\n /\nexport const nibblesToBits = (value: number): number => {\n return value << 2\n}\n","import { HexRegEx, HexRegExWithPrefix } from '../HexRegEx.ts'\nimport type { Hex, HexConfig } from './hex.ts'\nimport { bitsToNibbles } from './nibble.ts'\n\n/\n Type guard that checks whether a value is a valid hex string.\n * @param value - The value to check\n * @param config - Optional configuration for prefix and bit length validation\n * @returns True if the value is a valid Hex string\n /\nexport const isHex = (value: unknown, config?: HexConfig): value is Hex => {\n // Is it a string?\n if (typeof value !== 'string') return false\n\n const valueCharLength = config?.prefix ? value.length - 2 : value.length\n\n // If a bitLength specified, does it conform?\n if (config?.bitLength !== undefined && valueCharLength !== bitsToNibbles(config?.bitLength)) return false\n\n // Does it only has hex values?\n return config?.prefix ? HexRegExWithPrefix.test(value) : HexRegEx.test(value)\n}\n","import type { Hex, HexConfig } from '../hex.ts'\nimport { hexFromHexString } from './fromHexString.ts'\n\n/* Convert an ArrayBuffer to a hex string /\nexport const hexFromArrayBuffer = (\n /* The buffer to be converted /\n buffer: ArrayBufferLike,\n /* Configuration of output format and validation /\n config?: HexConfig,\n): Hex => {\n const unPadded = [...new Uint8Array(buffer)].map(x => x.toString(16).padStart(2, '0')).join('')\n return hexFromHexString(unPadded, config)\n}\n","import type { Hex, HexConfig } from '../hex.ts'\nimport { hexFromHexString } from './fromHexString.ts'\n\n/* Convert a bigint to a hex string /\nexport const hexFromBigInt = (\n /* The bigint to be converted /\n value: bigint,\n /* Configuration of output format and validation /\n config: HexConfig = {},\n): Hex => {\n const unPadded = value.toString(16)\n return hexFromHexString(unPadded, config)\n}\n","import type { Hex, HexConfig } from '../hex.ts'\nimport { hexFromBigInt } from './fromBigInt.ts'\n\n/\n Converts a number to a hex string by converting to BigInt first.\n * @param value - The number to convert\n * @param config - Optional hex output configuration\n * @returns The hex string representation\n /\nexport const hexFromNumber = (value: number, config?: HexConfig): Hex => {\n return hexFromBigInt(BigInt(value), config)\n}\n","import type { Hex, HexConfig } from '../hex.ts'\nimport { hexFromArrayBuffer } from './fromArrayBuffer.ts'\nimport { hexFromBigInt } from './fromBigInt.ts'\nimport { hexFromHexString } from './fromHexString.ts'\nimport { hexFromNumber } from './fromNumber.ts'\n\n/* Takes unknown value and tries our best to convert it to a hex string /\nexport const hexFrom = (\n /* Supported types are string, number, bigint, and ArrayBuffer /\n value: string \| number \| bigint \| ArrayBufferLike,\n /* Configuration of output format and validation /\n config?: HexConfig,\n): Hex => {\n switch (typeof value) {\n case 'string': {\n return hexFromHexString(value, config)\n }\n case 'bigint': {\n return hexFromBigInt(value, config)\n }\n case 'number': {\n return hexFromNumber(value, config)\n }\n case 'object': {\n return hexFromArrayBuffer(value, config)\n }\n default: {\n throw new Error(`Invalid type: ${typeof value}`)\n }\n }\n}\n","import type { Brand } from '@xylabs/typeof'\nimport as z from 'zod'\n\nimport { HexRegEx } from '../HexRegEx.ts'\n\n/** Branded type representing a validated lowercase hex string. /\nexport type BrandedHex = Brand<Lowercase<string>, { readonly __hex: true }>\n\n/* Zod schema that validates and transforms a string into a branded Hex type. /\nexport const HexZod = z.string().regex(HexRegEx, { message: 'Invalid hex format' }).transform(val => val as BrandedHex)\n\n/* Configuration of validation and output format /\nexport interface HexConfig {\n bitLength?: number\n byteSize?: number\n prefix?: boolean\n}\n\n/* A validated hex string type, inferred from the HexZod schema. /\nexport type Hex = z.infer<typeof HexZod>\n","import { isString } from '@xylabs/typeof'\n\nimport { hexFromHexString } from './from/index.ts'\n\n/\n Checks whether a hex string represents a zero value.\n * @param value - The hex string to check\n * @returns True if zero, false if non-zero, or undefined if the input is not a string\n /\nexport const isHexZero = (value?: string) => {\n return isString(value) ? BigInt(hexFromHexString(value, { prefix: true })) === 0n : undefined\n}\n","/\n Converts an ArrayBuffer to a hex string without padding or normalization.\n * @param buffer - The ArrayBuffer to convert\n * @returns A lowercase hex string representation of the buffer\n /\nexport const toHexLegacy = (buffer: ArrayBuffer) => {\n return [...new Uint8Array(buffer)].map(x => x.toString(16).padStart(2, '0')).join('')\n}\n","import { hexFrom } from './from/index.ts'\nimport type { HexConfig } from './hex.ts'\n\n/* takes any value and tries our best to convert it to a hex string /\nexport const toHex = (\n /* Supported types are string, number, bigint, and ArrayBuffer /\n value: string \| number \| bigint \| ArrayBufferLike,\n /* Configuration of output format and validation /\n config: HexConfig = {},\n) => {\n const { prefix = false } = config\n return hexFrom(value, { prefix, ...config })\n}\n","import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\nimport { isObject } from '@xylabs/typeof'\n\nimport { hexFromHexString } from '../hex/index.ts'\nimport type { Address } from './address.ts'\nimport { AddressValidationZod } from './AddressValidationZod.ts'\nimport { isAddress } from './is.ts'\n\n/\n Attempts to coerce a value into an Address type, returning undefined or throwing based on the assert config.\n * @param value - The value to coerce (must be a string)\n * @param assert - If provided, throws on failure instead of returning undefined\n * @returns The value as Address, or undefined if coercion fails and assert is not set\n /\nexport function asAddress(value: unknown): Address \| undefined\nexport function asAddress(value: unknown, assert: AssertConfig): Address\nexport function asAddress(value: unknown, assert?: AssertConfig): Address \| undefined {\n try {\n let stringValue: string \| undefined = undefined\n\n switch (typeof value) {\n case 'string': {\n stringValue = hexFromHexString(value, { prefix: false })\n break\n }\n default: {\n return isObject(assert) ? assertError(value, assert, `Unsupported type [${typeof value}]`) : undefined\n }\n }\n return isAddress(stringValue) ? stringValue : assertError(value, assert, `Value is not an Address [${value}]`)\n } catch (ex) {\n const error = ex as Error\n return assertError(undefined, assert, error.message)\n }\n}\n\n/* @alpha /\nexport function asAddressV2(value: unknown, assert: boolean = false): Address \| undefined {\n return assert\n ? AddressValidationZod.parse(value)\n : AddressValidationZod.safeParse(value).data\n}\n","import type { HexConfig } from '../hex/index.ts'\nimport { isHex } from '../hex/index.ts'\nimport type { Address } from './address.ts'\nimport { AddressValidationZod } from './AddressValidationZod.ts'\n\n/\n Type guard that checks whether a value is a valid 160-bit address.\n * @param value - The value to check\n * @param config - Optional hex config (defaults to 160-bit, no prefix)\n * @returns True if the value is a valid Address\n /\nexport const isAddress = (value: unknown, config: HexConfig = {}): value is Address => {\n const { bitLength = 160, prefix = false } = config\n return isHex(value, { bitLength, prefix })\n}\n\n/* @alpha /\nexport function isAddressV2(value: unknown): value is Address {\n return AddressValidationZod.safeParse(value).success\n}\n","import type { HexConfig } from '../hex/index.ts'\nimport { hexFrom } from '../hex/index.ts'\nimport type { Address } from './address.ts'\nimport { AddressTransformZod } from './AddressTransformZod.ts'\n\n/\n Converts a value to a 160-bit Address hex string.\n * @param value - The value to convert (string, number, bigint, or ArrayBuffer)\n * @param config - Optional hex config (defaults to 160-bit, no prefix)\n * @returns The value as an Address\n /\nexport const toAddress = (value: string \| number \| bigint \| ArrayBufferLike, config: HexConfig = {}): Address => {\n const { bitLength = 160, prefix = false } = config\n return hexFrom(value, {\n bitLength, prefix, ...config,\n }) as unknown as Address\n}\n\n/* @alpha /\nexport function toAddressV2(value: unknown, assert: boolean = false): Address \| undefined {\n return assert\n ? AddressTransformZod.parse(value)\n : AddressTransformZod.safeParse(value).data\n}\n","import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\nimport type { Brand } from '@xylabs/typeof'\nimport as z from 'zod'\n\nimport type { HexConfig } from './hex/index.ts'\nimport {\n hexFrom, hexFromHexString, isHex,\n} from './hex/index.ts'\nimport { HexRegExMinMaxMixedCaseWithPrefix } from './HexRegEx.ts'\n\n/** Regular expression matching a 20-byte Ethereum address with 0x prefix (mixed case). /\nexport const EthAddressRegEx = HexRegExMinMaxMixedCaseWithPrefix(20, 20)\n\n/* Zod schema that validates a string is a properly formatted Ethereum address. /\nexport const EthAddressToStringZod = z.string().regex(EthAddressRegEx)\n\n/* @deprecated use EthAddressToStringZod /\nexport const EthAddressToStringSchema = EthAddressToStringZod\n\n/* Zod schema that validates and transforms a string into an EthAddress type. /\nexport const EthAddressFromStringZod = z.string().regex(EthAddressRegEx).transform(v => toEthAddress(v))\n\n/* @deprecated use EthAddressFromStringZod /\nexport const EthAddressFromStringSchema = EthAddressFromStringZod\n\n/* Branded type representing a validated Ethereum address with 0x prefix. /\n// using true instead of unique symbol to avoid conflicts with other versions of library\nexport type EthAddress = Brand<string, { readonly __eth_address: true }>\n\n/* The zero Ethereum address constant (0x followed by 40 zero characters). /\nexport const ETH_ZERO_ADDRESS = '0x0000000000000000000000000000000000000000' as EthAddress\n\n/\n Converts a value to a 0x-prefixed Ethereum address string.\n * @param value - The value to convert (string, number, bigint, or ArrayBuffer)\n * @param config - Optional hex config (defaults to 160-bit, no inner prefix)\n * @returns The value as an EthAddress\n /\nexport const toEthAddress = (value: string \| number \| bigint \| ArrayBufferLike, config: HexConfig = {}): EthAddress => {\n const { bitLength = 160, prefix = false } = config\n return `0x${hexFrom(value, {\n bitLength, prefix, ...config,\n })}` as EthAddress\n}\n\n/\n Type guard that checks whether a value is a valid 0x-prefixed Ethereum address.\n * @param value - The value to check\n * @param config - Optional hex config (defaults to 160-bit with prefix)\n * @returns True if the value is a valid EthAddress\n /\nexport const isEthAddress = (value: unknown, config: HexConfig = {}): value is EthAddress => {\n const { bitLength = 160, prefix = true } = config\n const loweredValue = typeof value === 'string' ? value.toLowerCase() : value\n return isHex(loweredValue, { bitLength, prefix })\n}\n\n/* Zod schema that validates a string as a properly formatted Ethereum address using regex and type guard. /\nexport const EthAddressZod = z.string()\n .regex(EthAddressRegEx, { message: 'Invalid address format' })\n .refine(\n isEthAddress,\n )\n\n/\n Attempts to coerce a value into an EthAddress, returning undefined or throwing based on the assert config.\n * @param value - The value to coerce (must be a string)\n * @param assert - If provided, throws on failure instead of returning undefined\n * @returns The value as EthAddress, or undefined if coercion fails and assert is not set\n /\nexport function asEthAddress(value: unknown): EthAddress \| undefined\nexport function asEthAddress(value: unknown, assert: AssertConfig): EthAddress\nexport function asEthAddress(value: unknown, assert?: AssertConfig): EthAddress \| undefined {\n try {\n let stringValue: string \| undefined = undefined\n\n switch (typeof value) {\n case 'string': {\n stringValue = hexFromHexString(value, { prefix: true, byteSize: 4 })\n break\n }\n default: {\n if (value !== undefined) {\n return assertError(value, assert, `Unsupported type [${typeof value}]`)\n }\n }\n }\n return isEthAddress(stringValue) ? stringValue : assertError(value, assert, `Value is not an EthAddress [${value}]`)\n } catch (ex) {\n const error = ex as Error\n return assertError(undefined, assert, error.message)\n }\n}\n","import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\nimport { isUndefined } from '@xylabs/typeof'\n\nimport { hexFromHexString } from '../hex/index.ts'\nimport { type Hash } from './hash.ts'\nimport { isHash } from './is.ts'\n\n/\n Attempts to coerce a value into a Hash type, returning undefined or throwing based on the assert config.\n * @param value - The value to coerce (must be a string)\n * @param assert - If provided, throws on failure instead of returning undefined\n * @returns The value as Hash, or undefined if coercion fails and assert is not set\n /\nexport function asHash(value: unknown): Hash \| undefined\nexport function asHash(value: unknown, assert: AssertConfig): Hash\nexport function asHash(value: unknown, assert?: AssertConfig): Hash \| undefined {\n let stringValue: string \| undefined = undefined\n\n switch (typeof value) {\n case 'string': {\n stringValue = hexFromHexString(value)\n break\n }\n default: {\n return isUndefined(assert) ? undefined : assertError(value, assert, `Unsupported type [${typeof value}]`)\n }\n }\n return isHash(stringValue) ? stringValue : assertError(value, assert, `Value is not a Hash [${value}]`)\n}\n","import { isHex } from '../hex/index.ts'\nimport type { Hash, HashBitLength } from './hash.ts'\n\n/\n Type guard that checks whether a value is a valid hash of the specified bit length.\n * @param value - The value to check\n * @param bitLength - The expected bit length of the hash (defaults to 256)\n * @returns True if the value is a valid Hash\n /\nexport const isHash = (value: unknown, bitLength: HashBitLength = 256): value is Hash => {\n return isHex(value, { bitLength })\n}\n","import type { Brand } from '@xylabs/typeof'\nimport as z from 'zod'\n\nimport type { Hex } from '../hex/index.ts'\nimport { HexRegExMinMax } from '../HexRegEx.ts'\n\n/** The byte length of a standard hash (32 bytes / 256 bits). /\nexport const HASH_LENGTH = 32 as const\n\n/* Regular expression matching a 32-byte (64 hex character) hash string. /\nexport const HashRegEx = HexRegExMinMax(HASH_LENGTH, HASH_LENGTH)\n\n/* A 256-bit zero hash constant. /\nexport const ZERO_HASH = '0000000000000000000000000000000000000000000000000000000000000000' as Hash\n\n/* Valid bit lengths for hash values. /\nexport type HashBitLength = 32 \| 64 \| 128 \| 256 \| 512 \| 1024 \| 2048 \| 4096\n/* Array of all valid hash bit lengths for runtime validation. /\nexport const HashBitLength: HashBitLength[] = [32, 64, 128, 256, 512, 1024, 2048, 4096]\n\n/\n Type guard that checks whether a value is a valid hash bit length.\n * @param value - The value to check\n * @returns True if the value is one of the supported HashBitLength values\n /\nexport const isHashBitLength = (value: unknown): value is HashBitLength => {\n return typeof value === 'number' && HashBitLength.includes(value as HashBitLength)\n}\n\n/* Branded type representing a validated hash hex string. /\nexport type BrandedHash = Brand<Hex, { readonly __hash: true }>\n\n/* Zod schema that validates and transforms a string into a branded Hash type. /\nexport const HashZod = z.string()\n .regex(HashRegEx, { message: 'Invalid hex format' }).transform(val => val as BrandedHash)\n\n/* A validated hash string type, inferred from the HashZod schema. /\nexport type Hash = z.infer<typeof HashZod>\n","import as z from 'zod'\n\nimport { asHash } from './as.ts'\nimport type { Hash } from './hash.ts'\nimport { HashZod } from './hash.ts'\n\n/** Zod schema that transforms a Hash to a plain string for JSON serialization. /\nexport const HashToJsonZod = HashZod.transform<string>(v => v)\n/* Zod schema that parses a JSON string into a validated Hash, throwing on invalid input. /\nexport const JsonToHashZod = z.string().transform<Hash>(v => asHash(v, true))\n","import { type Hex, hexFromHexString } from './hex/index.ts'\n\n/\n Converts a Hex string to a BigInt.\n * @param hex - The hex string to convert\n * @returns The BigInt representation of the hex value\n /\nexport function hexToBigInt(hex: Hex): bigint {\n return BigInt(hexFromHexString(hex, { prefix: true }))\n}\n","import as z from 'zod'\n\nimport { toHex } from './hex/index.ts'\nimport { hexToBigInt } from './hexToBigInt.ts'\n\n/** Zod schema that transforms a non-negative BigInt into a hex string for JSON serialization. /\nexport const BigIntToJsonZod = z.bigint().nonnegative().transform(x => toHex(x))\n/* Zod schema that parses a JSON hex string into a BigInt. */\nexport const JsonToBigIntZod = z.string().transform(x => toHex(x)).transform(x => hexToBigInt(x))\n"],"mappings":";AACA,YAAY,OAAO;;;ACKZ,IAAM,iBAAiB,CAAC,WAAW,GAAG,WAAoB,OAAO,mBAAmB,MAAO;AAChG,SAAO,IAAI,OAAO,aAAa,WAAW,CAAC,IAAI,WAAW,CAAC,IAAI;AACjE;AAQO,IAAM,oCAAoC,CAAC,WAAW,GAAG,WAAoB,OAAO,mBAAmB,MAAO;AACnH,SAAO,IAAI,OAAO,kBAAkB,WAAW,CAAC,IAAI,WAAW,CAAC,IAAI;AACtE;AAGO,IAAM,WAAW;AAEjB,IAAM,qBAAqB;;;ADhB3B,IAAM,eAAe;AAErB,IAAM,iBAAiB;AAGvB,IAAM,eAAe,eAAe,iBAAiB,GAAG,iBAAiB,CAAC;AAK1E,IAAM,aAAe,SAAO,EAAE,MAAM,YAAY,EAAE,UAA0B,OAAK,CAAmB;;;AEjB3G,YAAYA,QAAO;;;ACAnB,YAAYC,QAAO;;;ACCnB,SAAS,mBAAmB;;;ACD5B,SAAS,gBAAgB;;;ACKlB,IAAM,gBAAgB,CAAC,UAA0B;AACtD,QAAM,UAAU,SAAS;AACzB,MAAI,UAAU,WAAW,EAAG,OAAM,IAAI,MAAM,qCAAqC;AACjF,SAAO;AACT;AAOO,IAAM,gBAAgB,CAAC,UAA0B;AACtD,SAAO,SAAS;AAClB;;;ACRO,IAAM,QAAQ,CAAC,OAAgB,WAAqC;AAEzE,MAAI,OAAO,UAAU,SAAU,QAAO;AAEtC,QAAM,kBAAkB,QAAQ,SAAS,MAAM,SAAS,IAAI,MAAM;AAGlE,MAAI,QAAQ,cAAc,UAAa,oBAAoB,cAAc,QAAQ,SAAS,EAAG,QAAO;AAGpG,SAAO,QAAQ,SAAS,mBAAmB,KAAK,KAAK,IAAI,SAAS,KAAK,KAAK;AAC9E;;;AFTO,IAAM,mBAAmB,CAAC,OAAe,SAAoB,CAAC,MAAW;AAC9E,QAAM;AAAA,IACJ,SAAS;AAAA,IAAO,WAAW;AAAA,IAAG;AAAA,EAChC,IAAI;AACJ,QAAM,iBAAiB,cAAc,QAAQ;AAC7C,QAAM,YAAY,MAAM,WAAW,IAAI,IAAI,MAAM,MAAM,CAAC,IAAI,OAAO,YAAY;AAC/E,MAAI,MAAM,QAAQ,GAAG;AACnB,UAAM,iBAAiB,SAAS,SAAS,KAAK,KAAK,SAAS,SAAS,cAAc,IAAI,gBAAgB,GAAG;AAC1G,UAAM,SAAS,SAAS,SAAS,IAAI,eAAe,SAAS,YAAY,GAAG,GAAG,IAAI;AACnF,YAAQ,SAAS,KAAK,MAAM,KAAK,QAAQ,YAAY;AAAA,EACvD,OAAO;AACL,UAAM,IAAI,MAAM,oCAAoC;AAAA,EACtD;AACF;;;AGrBO,IAAM,qBAAqB,CAEhC,QAEA,WACQ;AACR,QAAM,WAAW,CAAC,GAAG,IAAI,WAAW,MAAM,CAAC,EAAE,IAAI,OAAK,EAAE,SAAS,EAAE,EAAE,SAAS,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE;AAC9F,SAAO,iBAAiB,UAAU,MAAM;AAC1C;;;ACRO,IAAM,gBAAgB,CAE3B,OAEA,SAAoB,CAAC,MACb;AACR,QAAM,WAAW,MAAM,SAAS,EAAE;AAClC,SAAO,iBAAiB,UAAU,MAAM;AAC1C;;;ACHO,IAAM,gBAAgB,CAAC,OAAe,WAA4B;AACvE,SAAO,cAAc,OAAO,KAAK,GAAG,MAAM;AAC5C;;;ACJO,IAAM,UAAU,CAErB,OAEA,WACQ;AACR,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK,UAAU;AACb,aAAO,iBAAiB,OAAO,MAAM;AAAA,IACvC;AAAA,IACA,KAAK,UAAU;AACb,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAAA,IACA,KAAK,UAAU;AACb,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAAA,IACA,KAAK,UAAU;AACb,aAAO,mBAAmB,OAAO,MAAM;AAAA,IACzC;AAAA,IACA,SAAS;AACP,YAAM,IAAI,MAAM,iBAAiB,OAAO,KAAK,EAAE;AAAA,IACjD;AAAA,EACF;AACF;;;APfO,SAAS,MAAM,OAAgB,QAAwC;AAC5E,MAAI,cAAkC;AAEtC,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK,UAAU;AACb,oBAAc,iBAAiB,KAAK;AACpC;AAAA,IACF;AAAA,IACA,SAAS;AACP,aAAO,YAAY,OAAO,QAAQ,qBAAqB,OAAO,KAAK,GAAG;AAAA,IACxE;AAAA,EACF;AAEA,SAAO,MAAM,WAAW,IAAI,cAAc,YAAY,OAAO,QAAQ,qBAAqB,KAAK,GAAG;AACpG;;;AQ5BA,YAAYC,QAAO;AAQZ,IAAM,SAAW,UAAO,EAAE,MAAM,UAAU,EAAE,SAAS,qBAAqB,CAAC,EAAE,UAAU,SAAO,GAAiB;;;ACTtH,SAAS,gBAAgB;AASlB,IAAM,YAAY,CAAC,UAAmB;AAC3C,SAAO,SAAS,KAAK,IAAI,OAAO,iBAAiB,OAAO,EAAE,QAAQ,KAAK,CAAC,CAAC,MAAM,KAAK;AACtF;;;ACNO,IAAM,cAAc,CAAC,WAAwB;AAClD,SAAO,CAAC,GAAG,IAAI,WAAW,MAAM,CAAC,EAAE,IAAI,OAAK,EAAE,SAAS,EAAE,EAAE,SAAS,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE;AACtF;;;ACHO,IAAM,QAAQ,CAEnB,OAEA,SAAoB,CAAC,MAClB;AACH,QAAM,EAAE,SAAS,MAAM,IAAI;AAC3B,SAAO,QAAQ,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC;AAC7C;;;AZLO,IAAM,uBAAyB,UAAO,EAC1C,OAAO,OAAK,OAAO,UAAU,CAAC,CAAC,EAC/B,OAAO,OAAK,EAAE,WAAW,gBAAgB,EAAE,OAAO,OAAK,IAAI,MAAM,oCAAoC,EAAE,KAAK,GAAG,EAAE,CAAC,EAClH,UAAU,OAAK,CAAY;;;ADJvB,IAAM,sBAAwB,SAAM,CAAG,UAAO,GAAK,UAAO,GAAK,UAAO,CAAC,CAAC,EAC5E,UAAU,CAAC,UAAU;AACpB,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK,UAAU;AACb,aAAO,MAAM,SAAS,EAAE,EAAE,SAAS,gBAAgB,GAAG;AAAA,IACxD;AAAA,IACA,KAAK,UAAU;AACb,UAAI,MAAM,WAAW,IAAI,GAAG;AAC1B,eAAO,MAAM,MAAM,CAAC;AAAA,MACtB;AACA,aAAO;AAAA,IACT;AAAA,IACA,KAAK,UAAU;AACb,aAAO,OAAO,KAAK,EAAE,SAAS,EAAE,EAAE,SAAS,gBAAgB,GAAG;AAAA,IAChE;AAAA,EACF;AACF,CAAC,EACA,OAAO,OAAK,qBAAqB,UAAU,CAAC,EAAE,IAAI,EAClD,UAAU,OAAK,CAAY;;;AcvB9B,SAAS,eAAAC,oBAAmB;AAC5B,SAAS,gBAAgB;;;ACSlB,IAAM,YAAY,CAAC,OAAgB,SAAoB,CAAC,MAAwB;AACrF,QAAM,EAAE,YAAY,KAAK,SAAS,MAAM,IAAI;AAC5C,SAAO,MAAM,OAAO,EAAE,WAAW,OAAO,CAAC;AAC3C;AAGO,SAAS,YAAY,OAAkC;AAC5D,SAAO,qBAAqB,UAAU,KAAK,EAAE;AAC/C;;;ADFO,SAAS,UAAU,OAAgB,QAA4C;AACpF,MAAI;AACF,QAAI,cAAkC;AAEtC,YAAQ,OAAO,OAAO;AAAA,MACpB,KAAK,UAAU;AACb,sBAAc,iBAAiB,OAAO,EAAE,QAAQ,MAAM,CAAC;AACvD;AAAA,MACF;AAAA,MACA,SAAS;AACP,eAAO,SAAS,MAAM,IAAIC,aAAY,OAAO,QAAQ,qBAAqB,OAAO,KAAK,GAAG,IAAI;AAAA,MAC/F;AAAA,IACF;AACA,WAAO,UAAU,WAAW,IAAI,cAAcA,aAAY,OAAO,QAAQ,4BAA4B,KAAK,GAAG;AAAA,EAC/G,SAAS,IAAI;AACX,UAAM,QAAQ;AACd,WAAOA,aAAY,QAAW,QAAQ,MAAM,OAAO;AAAA,EACrD;AACF;AAGO,SAAS,YAAY,OAAgB,SAAkB,OAA4B;AACxF,SAAO,SACH,qBAAqB,MAAM,KAAK,IAChC,qBAAqB,UAAU,KAAK,EAAE;AAC5C;;;AE/BO,IAAM,YAAY,CAAC,OAAmD,SAAoB,CAAC,MAAe;AAC/G,QAAM,EAAE,YAAY,KAAK,SAAS,MAAM,IAAI;AAC5C,SAAO,QAAQ,OAAO;AAAA,IACpB;AAAA,IAAW;AAAA,IAAQ,GAAG;AAAA,EACxB,CAAC;AACH;AAGO,SAAS,YAAY,OAAgB,SAAkB,OAA4B;AACxF,SAAO,SACH,oBAAoB,MAAM,KAAK,IAC/B,oBAAoB,UAAU,KAAK,EAAE;AAC3C;;;ACtBA,SAAS,eAAAC,oBAAmB;AAE5B,YAAYC,QAAO;AASZ,IAAM,kBAAkB,kCAAkC,IAAI,EAAE;AAGhE,IAAM,wBAA0B,UAAO,EAAE,MAAM,eAAe;AAG9D,IAAM,2BAA2B;AAGjC,IAAM,0BAA4B,UAAO,EAAE,MAAM,eAAe,EAAE,UAAU,OAAK,aAAa,CAAC,CAAC;AAGhG,IAAM,6BAA6B;AAOnC,IAAM,mBAAmB;AAQzB,IAAM,eAAe,CAAC,OAAmD,SAAoB,CAAC,MAAkB;AACrH,QAAM,EAAE,YAAY,KAAK,SAAS,MAAM,IAAI;AAC5C,SAAO,KAAK,QAAQ,OAAO;AAAA,IACzB;AAAA,IAAW;AAAA,IAAQ,GAAG;AAAA,EACxB,CAAC,CAAC;AACJ;AAQO,IAAM,eAAe,CAAC,OAAgB,SAAoB,CAAC,MAA2B;AAC3F,QAAM,EAAE,YAAY,KAAK,SAAS,KAAK,IAAI;AAC3C,QAAM,eAAe,OAAO,UAAU,WAAW,MAAM,YAAY,IAAI;AACvE,SAAO,MAAM,cAAc,EAAE,WAAW,OAAO,CAAC;AAClD;AAGO,IAAM,gBAAkB,UAAO,EACnC,MAAM,iBAAiB,EAAE,SAAS,yBAAyB,CAAC,EAC5D;AAAA,EACC;AACF;AAUK,SAAS,aAAa,OAAgB,QAA+C;AAC1F,MAAI;AACF,QAAI,cAAkC;AAEtC,YAAQ,OAAO,OAAO;AAAA,MACpB,KAAK,UAAU;AACb,sBAAc,iBAAiB,OAAO,EAAE,QAAQ,MAAM,UAAU,EAAE,CAAC;AACnE;AAAA,MACF;AAAA,MACA,SAAS;AACP,YAAI,UAAU,QAAW;AACvB,iBAAOC,aAAY,OAAO,QAAQ,qBAAqB,OAAO,KAAK,GAAG;AAAA,QACxE;AAAA,MACF;AAAA,IACF;AACA,WAAO,aAAa,WAAW,IAAI,cAAcA,aAAY,OAAO,QAAQ,+BAA+B,KAAK,GAAG;AAAA,EACrH,SAAS,IAAI;AACX,UAAM,QAAQ;AACd,WAAOA,aAAY,QAAW,QAAQ,MAAM,OAAO;AAAA,EACrD;AACF;;;AC5FA,SAAS,eAAAC,oBAAmB;AAC5B,SAAS,mBAAmB;;;ACOrB,IAAM,SAAS,CAAC,OAAgB,YAA2B,QAAuB;AACvF,SAAO,MAAM,OAAO,EAAE,UAAU,CAAC;AACnC;;;ADKO,SAAS,OAAO,OAAgB,QAAyC;AAC9E,MAAI,cAAkC;AAEtC,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK,UAAU;AACb,oBAAc,iBAAiB,KAAK;AACpC;AAAA,IACF;AAAA,IACA,SAAS;AACP,aAAO,YAAY,MAAM,IAAI,SAAYC,aAAY,OAAO,QAAQ,qBAAqB,OAAO,KAAK,GAAG;AAAA,IAC1G;AAAA,EACF;AACA,SAAO,OAAO,WAAW,IAAI,cAAcA,aAAY,OAAO,QAAQ,wBAAwB,KAAK,GAAG;AACxG;;;AE5BA,YAAYC,QAAO;AAMZ,IAAM,cAAc;AAGpB,IAAM,YAAY,eAAe,aAAa,WAAW;AAGzD,IAAM,YAAY;AAKlB,IAAM,gBAAiC,CAAC,IAAI,IAAI,KAAK,KAAK,KAAK,MAAM,MAAM,IAAI;AAO/E,IAAM,kBAAkB,CAAC,UAA2C;AACzE,SAAO,OAAO,UAAU,YAAY,cAAc,SAAS,KAAsB;AACnF;AAMO,IAAM,UAAY,UAAO,EAC7B,MAAM,WAAW,EAAE,SAAS,qBAAqB,CAAC,EAAE,UAAU,SAAO,GAAkB;;;AClC1F,YAAYC,QAAO;AAOZ,IAAM,gBAAgB,QAAQ,UAAkB,OAAK,CAAC;AAEtD,IAAM,gBAAkB,UAAO,EAAE,UAAgB,OAAK,OAAO,GAAG,IAAI,CAAC;;;ACFrE,SAAS,YAAY,KAAkB;AAC5C,SAAO,OAAO,iBAAiB,KAAK,EAAE,QAAQ,KAAK,CAAC,CAAC;AACvD;;;ACTA,YAAYC,QAAO;AAMZ,IAAM,kBAAoB,UAAO,EAAE,YAAY,EAAE,UAAU,OAAK,MAAM,CAAC,CAAC;AAExE,IAAM,kBAAoB,UAAO,EAAE,UAAU,OAAK,MAAM,CAAC,CAAC,EAAE,UAAU,OAAK,YAAY,CAAC,CAAC;","names":["z","z","z","assertError","assertError","assertError","z","assertError","assertError","assertError","z","z","z"]}
1	+ {"version":3,"sources":["../../src/address/address.ts","../../src/HexRegEx.ts","../../src/address/AddressTransformZod.ts","../../src/address/AddressValidationZod.ts","../../src/hex/as.ts","../../src/hex/from/fromHexString.ts","../../src/hex/nibble.ts","../../src/hex/is.ts","../../src/hex/from/fromArrayBuffer.ts","../../src/hex/from/fromBigInt.ts","../../src/hex/from/fromNumber.ts","../../src/hex/from/from.ts","../../src/hex/hex.ts","../../src/hex/isHexZero.ts","../../src/hex/legacy.ts","../../src/hex/to.ts","../../src/address/as.ts","../../src/address/is.ts","../../src/address/to.ts","../../src/ethAddress.ts","../../src/hash/as.ts","../../src/hash/is.ts","../../src/hash/hash.ts","../../src/hash/zod.ts","../../src/hexToBigInt.ts","../../src/zod.ts"],"sourcesContent":["import type { Brand } from '@xylabs/typeof'\nimport * as z from 'zod'\n\nimport { type Hex } from '../hex/index.ts'\nimport { HexRegExMinMax } from '../HexRegEx.ts'\n\n/** A 160-bit zero address constant. /\nexport const ZERO_ADDRESS = '0000000000000000000000000000000000000000' as Address\n/* The character length of an address hex string (40 hex characters / 20 bytes). /\nexport const ADDRESS_LENGTH = 40 as const\n\n/* Regular expression matching a 20-byte (40 hex character) address string. /\nexport const AddressRegEx = HexRegExMinMax(ADDRESS_LENGTH / 2, ADDRESS_LENGTH / 2)\n\ntype BrandedAddress = Brand<Hex, { readonly __address: true }>\n\n/* Zod schema that validates and transforms a string into a branded Address type. /\nexport const AddressZod = z.string().regex(AddressRegEx).transform<BrandedAddress>(v => v as BrandedAddress)\n\n/* A validated 20-byte address string type, inferred from the AddressZod schema. /\nexport type Address = z.infer<typeof AddressZod>\n","/\n Creates a RegExp matching lowercase hex strings with a byte length in the given range.\n * @param minBytes - Minimum number of bytes (default 0)\n * @param maxBytes - Maximum number of bytes\n * @returns A RegExp for validating hex strings within the byte range\n /\nexport const HexRegExMinMax = (minBytes = 0, maxBytes: number = (Number.MAX_SAFE_INTEGER / 2)) => {\n return new RegExp(`^[a-f0-9]{${minBytes 2},${maxBytes * 2}}$`)\n}\n\n/*\n Creates a RegExp matching mixed-case hex strings with a 0x prefix and a byte length in the given range.\n * @param minBytes - Minimum number of bytes (default 0)\n * @param maxBytes - Maximum number of bytes\n * @returns A RegExp for validating prefixed hex strings within the byte range\n /\nexport const HexRegExMinMaxMixedCaseWithPrefix = (minBytes = 0, maxBytes: number = (Number.MAX_SAFE_INTEGER / 2)) => {\n return new RegExp(`^0x[a-fA-F0-9]{${minBytes 2},${maxBytes * 2}}$`)\n}\n\n/** Regular expression matching a lowercase hex string without prefix. /\nexport const HexRegEx = /^[0-9a-f]+$/\n/* Regular expression matching a lowercase hex string with a 0x prefix. /\nexport const HexRegExWithPrefix = /^0x[0-9a-f]+$/\n","import as z from 'zod'\n\nimport { type Address, ADDRESS_LENGTH } from './address.ts'\nimport { AddressValidationZod } from './AddressValidationZod.ts'\n\n/** Zod schema that accepts a string, bigint, or number and transforms it into a validated Address. /\nexport const AddressTransformZod = z.union([z.string(), z.bigint(), z.number()])\n .transform((value) => {\n switch (typeof value) {\n case 'bigint': {\n return value.toString(16).padStart(ADDRESS_LENGTH, '0')\n }\n case 'string': {\n if (value.startsWith('0x')) {\n return value.slice(2)\n }\n return value\n }\n case 'number': {\n return BigInt(value).toString(16).padStart(ADDRESS_LENGTH, '0')\n }\n }\n })\n .refine(x => AddressValidationZod.safeParse(x).data)\n .transform(x => x as Address)\n\n/* The output type of AddressTransformZod after parsing and transformation. /\nexport type AddressTransformZodType = z.infer<typeof AddressTransformZod>\n","import as z from 'zod'\n\nimport { HexZod } from '../hex/index.ts'\nimport type { Address } from './address.ts'\nimport { ADDRESS_LENGTH } from './address.ts'\n\n/** Zod schema that validates a string is a properly formatted 40-character hex address. /\nexport const AddressValidationZod = z.string()\n .refine(x => HexZod.safeParse(x).success)\n .refine(x => x.length === ADDRESS_LENGTH, { error: e => new Error(`Address must have 40 characters [${e.input}]`) })\n .transform(v => v as Address)\n\n/* The output type of AddressValidationZod after parsing. /\nexport type AddressValidationZodType = z.infer<typeof AddressValidationZod>\n","import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\n\nimport { hexFromHexString } from './from/index.ts'\nimport type { Hex } from './hex.ts'\nimport { isHex } from './is.ts'\n\n/\n Attempts to coerce a value into a Hex type, returning undefined or throwing based on the assert config.\n * @param value - The value to coerce (must be a string)\n * @param assert - If provided, throws on failure instead of returning undefined\n * @returns The value as Hex, or undefined if coercion fails and assert is not set\n /\nexport function asHex(value: unknown): Hex \| undefined\nexport function asHex(value: unknown, assert: AssertConfig): Hex\nexport function asHex(value: unknown, assert?: AssertConfig): Hex \| undefined {\n let stringValue: string \| undefined = undefined\n\n switch (typeof value) {\n case 'string': {\n stringValue = hexFromHexString(value)\n break\n }\n default: {\n return assertError(value, assert, `Unsupported type [${typeof value}]`)\n }\n }\n\n return isHex(stringValue) ? stringValue : assertError(value, assert, `Value is not Hex [${value}]`)\n}\n","import { isNumber } from '@xylabs/typeof'\n\nimport type { Hex, HexConfig } from '../hex.ts'\nimport { isHex } from '../is.ts'\nimport { bitsToNibbles } from '../nibble.ts'\n\n/\n Normalizes a hex string by stripping an optional 0x prefix, lowercasing, and padding to byte/bit boundaries.\n * @param value - The hex string to normalize (with or without 0x prefix)\n * @param config - Configuration for prefix, byteSize, and bitLength padding\n * @returns The normalized Hex string\n /\nexport const hexFromHexString = (value: string, config: HexConfig = {}): Hex => {\n const {\n prefix = false, byteSize = 8, bitLength,\n } = config\n const nibbleBoundary = bitsToNibbles(byteSize)\n const unEvened = (value.startsWith('0x') ? value.slice(2) : value).toLowerCase()\n if (isHex(unEvened)) {\n const evenCharacters = unEvened.padStart(Math.ceil(unEvened.length / nibbleBoundary) nibbleBoundary, '0')\n const padded = isNumber(bitLength) ? evenCharacters.padStart(bitLength / 4, '0') : evenCharacters\n return (prefix ? `0x${padded}` : padded).toLowerCase() as Hex\n } else {\n throw new Error('Received string is not a value hex')\n }\n}\n","/*\n Converts a bit count to the equivalent number of hex nibbles (4 bits each).\n * @param value - The number of bits (must be a multiple of 4)\n * @returns The number of nibbles\n /\nexport const bitsToNibbles = (value: number): number => {\n const nibbles = value >> 2\n if (value !== nibbles << 2) throw new Error('Bits for nibbles must multiple of 4')\n return nibbles\n}\n\n/\n Converts a nibble count to the equivalent number of bits.\n * @param value - The number of nibbles\n * @returns The number of bits\n /\nexport const nibblesToBits = (value: number): number => {\n return value << 2\n}\n","import { HexRegEx, HexRegExWithPrefix } from '../HexRegEx.ts'\nimport type { Hex, HexConfig } from './hex.ts'\nimport { bitsToNibbles } from './nibble.ts'\n\n/\n Type guard that checks whether a value is a valid hex string.\n * @param value - The value to check\n * @param config - Optional configuration for prefix and bit length validation\n * @returns True if the value is a valid Hex string\n /\nexport const isHex = (value: unknown, config?: HexConfig): value is Hex => {\n // Is it a string?\n if (typeof value !== 'string') return false\n\n const valueCharLength = config?.prefix ? value.length - 2 : value.length\n\n // If a bitLength specified, does it conform?\n if (config?.bitLength !== undefined && valueCharLength !== bitsToNibbles(config?.bitLength)) return false\n\n // Does it only has hex values?\n return config?.prefix ? HexRegExWithPrefix.test(value) : HexRegEx.test(value)\n}\n","import type { Hex, HexConfig } from '../hex.ts'\nimport { hexFromHexString } from './fromHexString.ts'\n\n/* Convert an ArrayBuffer to a hex string /\nexport const hexFromArrayBuffer = (\n /* The buffer to be converted /\n buffer: ArrayBufferLike,\n /* Configuration of output format and validation /\n config?: HexConfig,\n): Hex => {\n const unPadded = [...new Uint8Array(buffer)].map(x => x.toString(16).padStart(2, '0')).join('')\n return hexFromHexString(unPadded, config)\n}\n","import type { Hex, HexConfig } from '../hex.ts'\nimport { hexFromHexString } from './fromHexString.ts'\n\n/* Convert a bigint to a hex string /\nexport const hexFromBigInt = (\n /* The bigint to be converted /\n value: bigint,\n /* Configuration of output format and validation /\n config: HexConfig = {},\n): Hex => {\n const unPadded = value.toString(16)\n return hexFromHexString(unPadded, config)\n}\n","import type { Hex, HexConfig } from '../hex.ts'\nimport { hexFromBigInt } from './fromBigInt.ts'\n\n/\n Converts a number to a hex string by converting to BigInt first.\n * @param value - The number to convert\n * @param config - Optional hex output configuration\n * @returns The hex string representation\n /\nexport const hexFromNumber = (value: number, config?: HexConfig): Hex => {\n return hexFromBigInt(BigInt(value), config)\n}\n","import type { Hex, HexConfig } from '../hex.ts'\nimport { hexFromArrayBuffer } from './fromArrayBuffer.ts'\nimport { hexFromBigInt } from './fromBigInt.ts'\nimport { hexFromHexString } from './fromHexString.ts'\nimport { hexFromNumber } from './fromNumber.ts'\n\n/* Takes unknown value and tries our best to convert it to a hex string /\nexport const hexFrom = (\n /* Supported types are string, number, bigint, and ArrayBuffer /\n value: string \| number \| bigint \| ArrayBufferLike,\n /* Configuration of output format and validation /\n config?: HexConfig,\n): Hex => {\n switch (typeof value) {\n case 'string': {\n return hexFromHexString(value, config)\n }\n case 'bigint': {\n return hexFromBigInt(value, config)\n }\n case 'number': {\n return hexFromNumber(value, config)\n }\n case 'object': {\n return hexFromArrayBuffer(value, config)\n }\n default: {\n throw new Error(`Invalid type: ${typeof value}`)\n }\n }\n}\n","import type { Brand } from '@xylabs/typeof'\nimport as z from 'zod'\n\nimport { HexRegEx } from '../HexRegEx.ts'\n\n/** Branded type representing a validated lowercase hex string. /\nexport type BrandedHex = Brand<Lowercase<string>, { readonly __hex: true }>\n\n/* Zod schema that validates and transforms a string into a branded Hex type. /\nexport const HexZod = z.string().regex(HexRegEx, { message: 'Invalid hex format' }).transform(val => val as BrandedHex)\n\n/* Configuration of validation and output format /\nexport interface HexConfig {\n bitLength?: number\n byteSize?: number\n prefix?: boolean\n}\n\n/* A validated hex string type, inferred from the HexZod schema. /\nexport type Hex = z.infer<typeof HexZod>\n","import { isString } from '@xylabs/typeof'\n\nimport { hexFromHexString } from './from/index.ts'\n\n/\n Checks whether a hex string represents a zero value.\n * @param value - The hex string to check\n * @returns True if zero, false if non-zero, or undefined if the input is not a string\n /\nexport const isHexZero = (value?: string) => {\n return isString(value) ? BigInt(hexFromHexString(value, { prefix: true })) === 0n : undefined\n}\n","/\n Converts an ArrayBuffer to a hex string without padding or normalization.\n * @param buffer - The ArrayBuffer to convert\n * @returns A lowercase hex string representation of the buffer\n /\nexport const toHexLegacy = (buffer: ArrayBuffer) => {\n return [...new Uint8Array(buffer)].map(x => x.toString(16).padStart(2, '0')).join('')\n}\n","import { hexFrom } from './from/index.ts'\nimport type { HexConfig } from './hex.ts'\n\n/* takes any value and tries our best to convert it to a hex string /\nexport const toHex = (\n /* Supported types are string, number, bigint, and ArrayBuffer /\n value: string \| number \| bigint \| ArrayBufferLike,\n /* Configuration of output format and validation /\n config: HexConfig = {},\n) => {\n const { prefix = false } = config\n return hexFrom(value, { prefix, ...config })\n}\n","import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\nimport { isObject } from '@xylabs/typeof'\n\nimport { hexFromHexString } from '../hex/index.ts'\nimport type { Address } from './address.ts'\nimport { AddressValidationZod } from './AddressValidationZod.ts'\nimport { isAddress } from './is.ts'\n\n/\n Attempts to coerce a value into an Address type, returning undefined or throwing based on the assert config.\n * @param value - The value to coerce (must be a string)\n * @param assert - If provided, throws on failure instead of returning undefined\n * @returns The value as Address, or undefined if coercion fails and assert is not set\n /\nexport function asAddress(value: unknown): Address \| undefined\nexport function asAddress(value: unknown, assert: AssertConfig): Address\nexport function asAddress(value: unknown, assert?: AssertConfig): Address \| undefined {\n try {\n let stringValue: string \| undefined = undefined\n\n switch (typeof value) {\n case 'string': {\n stringValue = hexFromHexString(value, { prefix: false, byteSize: 4 })\n break\n }\n default: {\n return isObject(assert) ? assertError(value, assert, `Unsupported type [${typeof value}]`) : undefined\n }\n }\n return isAddress(stringValue) ? stringValue : assertError(value, assert, `Value is not an Address [${value}]`)\n } catch (ex) {\n const error = ex as Error\n return assertError(undefined, assert, error.message)\n }\n}\n\n/* @alpha /\nexport function asAddressV2(value: unknown, assert: boolean = false): Address \| undefined {\n return assert\n ? AddressValidationZod.parse(value)\n : AddressValidationZod.safeParse(value).data\n}\n","import type { HexConfig } from '../hex/index.ts'\nimport { isHex } from '../hex/index.ts'\nimport type { Address } from './address.ts'\nimport { AddressValidationZod } from './AddressValidationZod.ts'\n\n/\n Type guard that checks whether a value is a valid 160-bit address.\n * @param value - The value to check\n * @param config - Optional hex config (defaults to 160-bit, no prefix)\n * @returns True if the value is a valid Address\n /\nexport const isAddress = (value?: unknown, config: HexConfig = {}): value is Address => {\n const { bitLength = 160, prefix = false } = config\n return isHex(value, { bitLength, prefix })\n}\n\n/* @alpha /\nexport function isAddressV2(value?: unknown): value is Address {\n return AddressValidationZod.safeParse(value).success\n}\n","import type { HexConfig } from '../hex/index.ts'\nimport { hexFrom } from '../hex/index.ts'\nimport type { Address } from './address.ts'\nimport { AddressTransformZod } from './AddressTransformZod.ts'\n\n/\n Converts a value to a 160-bit Address hex string.\n * @param value - The value to convert (string, number, bigint, or ArrayBuffer)\n * @param config - Optional hex config (defaults to 160-bit, no prefix)\n * @returns The value as an Address\n /\nexport const toAddress = (value: string \| number \| bigint \| ArrayBufferLike, config: HexConfig = {}): Address => {\n const { bitLength = 160, prefix = false } = config\n return hexFrom(value, {\n bitLength, prefix, ...config,\n }) as unknown as Address\n}\n\n/* @alpha /\nexport function toAddressV2(value: unknown, assert: boolean = false): Address \| undefined {\n return assert\n ? AddressTransformZod.parse(value)\n : AddressTransformZod.safeParse(value).data\n}\n","import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\nimport type { Brand } from '@xylabs/typeof'\nimport as z from 'zod'\n\nimport type { HexConfig } from './hex/index.ts'\nimport {\n hexFrom, hexFromHexString, isHex,\n} from './hex/index.ts'\nimport { HexRegExMinMaxMixedCaseWithPrefix } from './HexRegEx.ts'\n\n/** Regular expression matching a 20-byte Ethereum address with 0x prefix (mixed case). /\nexport const EthAddressRegEx = HexRegExMinMaxMixedCaseWithPrefix(20, 20)\n\n/* Zod schema that validates a string is a properly formatted Ethereum address. /\nexport const EthAddressToStringZod = z.string().regex(EthAddressRegEx)\n\n/* @deprecated use EthAddressToStringZod /\nexport const EthAddressToStringSchema = EthAddressToStringZod\n\n/* Zod schema that validates and transforms a string into an EthAddress type. /\nexport const EthAddressFromStringZod = z.string().regex(EthAddressRegEx).transform(v => toEthAddress(v))\n\n/* @deprecated use EthAddressFromStringZod /\nexport const EthAddressFromStringSchema = EthAddressFromStringZod\n\n/* Branded type representing a validated Ethereum address with 0x prefix. /\n// using true instead of unique symbol to avoid conflicts with other versions of library\nexport type EthAddress = Brand<string, { readonly __eth_address: true }>\n\n/* The zero Ethereum address constant (0x followed by 40 zero characters). /\nexport const ETH_ZERO_ADDRESS = '0x0000000000000000000000000000000000000000' as EthAddress\n\n/\n Converts a value to a 0x-prefixed Ethereum address string.\n * @param value - The value to convert (string, number, bigint, or ArrayBuffer)\n * @param config - Optional hex config (defaults to 160-bit, no inner prefix)\n * @returns The value as an EthAddress\n /\nexport const toEthAddress = (value: string \| number \| bigint \| ArrayBufferLike, config: HexConfig = {}): EthAddress => {\n const { bitLength = 160, prefix = false } = config\n return `0x${hexFrom(value, {\n bitLength, prefix, ...config,\n })}` as EthAddress\n}\n\n/\n Type guard that checks whether a value is a valid 0x-prefixed Ethereum address.\n * @param value - The value to check\n * @param config - Optional hex config (defaults to 160-bit with prefix)\n * @returns True if the value is a valid EthAddress\n /\nexport const isEthAddress = (value: unknown, config: HexConfig = {}): value is EthAddress => {\n const { bitLength = 160, prefix = true } = config\n const loweredValue = typeof value === 'string' ? value.toLowerCase() : value\n return isHex(loweredValue, { bitLength, prefix })\n}\n\n/* Zod schema that validates a string as a properly formatted Ethereum address using regex and type guard. /\nexport const EthAddressZod = z.string()\n .regex(EthAddressRegEx, { message: 'Invalid address format' })\n .refine(\n isEthAddress,\n )\n\n/\n Attempts to coerce a value into an EthAddress, returning undefined or throwing based on the assert config.\n * @param value - The value to coerce (must be a string)\n * @param assert - If provided, throws on failure instead of returning undefined\n * @returns The value as EthAddress, or undefined if coercion fails and assert is not set\n /\nexport function asEthAddress(value: unknown): EthAddress \| undefined\nexport function asEthAddress(value: unknown, assert: AssertConfig): EthAddress\nexport function asEthAddress(value: unknown, assert?: AssertConfig): EthAddress \| undefined {\n try {\n let stringValue: string \| undefined = undefined\n\n switch (typeof value) {\n case 'string': {\n stringValue = hexFromHexString(value, { prefix: true, byteSize: 4 })\n break\n }\n default: {\n if (value !== undefined) {\n return assertError(value, assert, `Unsupported type [${typeof value}]`)\n }\n }\n }\n return isEthAddress(stringValue) ? stringValue : assertError(value, assert, `Value is not an EthAddress [${value}]`)\n } catch (ex) {\n const error = ex as Error\n return assertError(undefined, assert, error.message)\n }\n}\n","import type { AssertConfig } from '@xylabs/error'\nimport { assertError } from '@xylabs/error'\nimport { isUndefined } from '@xylabs/typeof'\n\nimport { hexFromHexString } from '../hex/index.ts'\nimport { type Hash } from './hash.ts'\nimport { isHash } from './is.ts'\n\n/\n Attempts to coerce a value into a Hash type, returning undefined or throwing based on the assert config.\n * @param value - The value to coerce (must be a string)\n * @param assert - If provided, throws on failure instead of returning undefined\n * @returns The value as Hash, or undefined if coercion fails and assert is not set\n /\nexport function asHash(value: unknown): Hash \| undefined\nexport function asHash(value: unknown, assert: AssertConfig): Hash\nexport function asHash(value: unknown, assert?: AssertConfig): Hash \| undefined {\n let stringValue: string \| undefined = undefined\n\n switch (typeof value) {\n case 'string': {\n stringValue = hexFromHexString(value)\n break\n }\n default: {\n return isUndefined(assert) ? undefined : assertError(value, assert, `Unsupported type [${typeof value}]`)\n }\n }\n return isHash(stringValue) ? stringValue : assertError(value, assert, `Value is not a Hash [${value}]`)\n}\n","import { isHex } from '../hex/index.ts'\nimport type { Hash, HashBitLength } from './hash.ts'\n\n/\n Type guard that checks whether a value is a valid hash of the specified bit length.\n * @param value - The value to check\n * @param bitLength - The expected bit length of the hash (defaults to 256)\n * @returns True if the value is a valid Hash\n /\nexport const isHash = (value: unknown, bitLength: HashBitLength = 256): value is Hash => {\n return isHex(value, { bitLength })\n}\n","import type { Brand } from '@xylabs/typeof'\nimport as z from 'zod'\n\nimport type { Hex } from '../hex/index.ts'\nimport { HexRegExMinMax } from '../HexRegEx.ts'\n\n/** The byte length of a standard hash (32 bytes / 256 bits). /\nexport const HASH_LENGTH = 32 as const\n\n/* Regular expression matching a 32-byte (64 hex character) hash string. /\nexport const HashRegEx = HexRegExMinMax(HASH_LENGTH, HASH_LENGTH)\n\n/* A 256-bit zero hash constant. /\nexport const ZERO_HASH = '0000000000000000000000000000000000000000000000000000000000000000' as Hash\n\n/* Valid bit lengths for hash values. /\nexport type HashBitLength = 32 \| 64 \| 128 \| 256 \| 512 \| 1024 \| 2048 \| 4096\n/* Array of all valid hash bit lengths for runtime validation. /\nexport const HashBitLength: HashBitLength[] = [32, 64, 128, 256, 512, 1024, 2048, 4096]\n\n/\n Type guard that checks whether a value is a valid hash bit length.\n * @param value - The value to check\n * @returns True if the value is one of the supported HashBitLength values\n /\nexport const isHashBitLength = (value: unknown): value is HashBitLength => {\n return typeof value === 'number' && HashBitLength.includes(value as HashBitLength)\n}\n\n/* Branded type representing a validated hash hex string. /\nexport type BrandedHash = Brand<Hex, { readonly __hash: true }>\n\n/* Zod schema that validates and transforms a string into a branded Hash type. /\nexport const HashZod = z.string()\n .regex(HashRegEx, { message: 'Invalid hex format' }).transform(val => val as BrandedHash)\n\n/* A validated hash string type, inferred from the HashZod schema. /\nexport type Hash = z.infer<typeof HashZod>\n","import as z from 'zod'\n\nimport { asHash } from './as.ts'\nimport type { Hash } from './hash.ts'\nimport { HashZod } from './hash.ts'\n\n/** Zod schema that transforms a Hash to a plain string for JSON serialization. /\nexport const HashToJsonZod = HashZod.transform<string>(v => v)\n/* Zod schema that parses a JSON string into a validated Hash, throwing on invalid input. /\nexport const JsonToHashZod = z.string().transform<Hash>(v => asHash(v, true))\n","import { type Hex, hexFromHexString } from './hex/index.ts'\n\n/\n Converts a Hex string to a BigInt.\n * @param hex - The hex string to convert\n * @returns The BigInt representation of the hex value\n /\nexport function hexToBigInt(hex: Hex): bigint {\n return BigInt(hexFromHexString(hex, { prefix: true }))\n}\n","import as z from 'zod'\n\nimport { toHex } from './hex/index.ts'\nimport { hexToBigInt } from './hexToBigInt.ts'\n\n/** Zod schema that transforms a non-negative BigInt into a hex string for JSON serialization. /\nexport const BigIntToJsonZod = z.bigint().nonnegative().transform(x => toHex(x))\n/* Zod schema that parses a JSON hex string into a BigInt. */\nexport const JsonToBigIntZod = z.string().transform(x => toHex(x)).transform(x => hexToBigInt(x))\n"],"mappings":";AACA,YAAY,OAAO;;;ACKZ,IAAM,iBAAiB,CAAC,WAAW,GAAG,WAAoB,OAAO,mBAAmB,MAAO;AAChG,SAAO,IAAI,OAAO,aAAa,WAAW,CAAC,IAAI,WAAW,CAAC,IAAI;AACjE;AAQO,IAAM,oCAAoC,CAAC,WAAW,GAAG,WAAoB,OAAO,mBAAmB,MAAO;AACnH,SAAO,IAAI,OAAO,kBAAkB,WAAW,CAAC,IAAI,WAAW,CAAC,IAAI;AACtE;AAGO,IAAM,WAAW;AAEjB,IAAM,qBAAqB;;;ADhB3B,IAAM,eAAe;AAErB,IAAM,iBAAiB;AAGvB,IAAM,eAAe,eAAe,iBAAiB,GAAG,iBAAiB,CAAC;AAK1E,IAAM,aAAe,SAAO,EAAE,MAAM,YAAY,EAAE,UAA0B,OAAK,CAAmB;;;AEjB3G,YAAYA,QAAO;;;ACAnB,YAAYC,QAAO;;;ACCnB,SAAS,mBAAmB;;;ACD5B,SAAS,gBAAgB;;;ACKlB,IAAM,gBAAgB,CAAC,UAA0B;AACtD,QAAM,UAAU,SAAS;AACzB,MAAI,UAAU,WAAW,EAAG,OAAM,IAAI,MAAM,qCAAqC;AACjF,SAAO;AACT;AAOO,IAAM,gBAAgB,CAAC,UAA0B;AACtD,SAAO,SAAS;AAClB;;;ACRO,IAAM,QAAQ,CAAC,OAAgB,WAAqC;AAEzE,MAAI,OAAO,UAAU,SAAU,QAAO;AAEtC,QAAM,kBAAkB,QAAQ,SAAS,MAAM,SAAS,IAAI,MAAM;AAGlE,MAAI,QAAQ,cAAc,UAAa,oBAAoB,cAAc,QAAQ,SAAS,EAAG,QAAO;AAGpG,SAAO,QAAQ,SAAS,mBAAmB,KAAK,KAAK,IAAI,SAAS,KAAK,KAAK;AAC9E;;;AFTO,IAAM,mBAAmB,CAAC,OAAe,SAAoB,CAAC,MAAW;AAC9E,QAAM;AAAA,IACJ,SAAS;AAAA,IAAO,WAAW;AAAA,IAAG;AAAA,EAChC,IAAI;AACJ,QAAM,iBAAiB,cAAc,QAAQ;AAC7C,QAAM,YAAY,MAAM,WAAW,IAAI,IAAI,MAAM,MAAM,CAAC,IAAI,OAAO,YAAY;AAC/E,MAAI,MAAM,QAAQ,GAAG;AACnB,UAAM,iBAAiB,SAAS,SAAS,KAAK,KAAK,SAAS,SAAS,cAAc,IAAI,gBAAgB,GAAG;AAC1G,UAAM,SAAS,SAAS,SAAS,IAAI,eAAe,SAAS,YAAY,GAAG,GAAG,IAAI;AACnF,YAAQ,SAAS,KAAK,MAAM,KAAK,QAAQ,YAAY;AAAA,EACvD,OAAO;AACL,UAAM,IAAI,MAAM,oCAAoC;AAAA,EACtD;AACF;;;AGrBO,IAAM,qBAAqB,CAEhC,QAEA,WACQ;AACR,QAAM,WAAW,CAAC,GAAG,IAAI,WAAW,MAAM,CAAC,EAAE,IAAI,OAAK,EAAE,SAAS,EAAE,EAAE,SAAS,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE;AAC9F,SAAO,iBAAiB,UAAU,MAAM;AAC1C;;;ACRO,IAAM,gBAAgB,CAE3B,OAEA,SAAoB,CAAC,MACb;AACR,QAAM,WAAW,MAAM,SAAS,EAAE;AAClC,SAAO,iBAAiB,UAAU,MAAM;AAC1C;;;ACHO,IAAM,gBAAgB,CAAC,OAAe,WAA4B;AACvE,SAAO,cAAc,OAAO,KAAK,GAAG,MAAM;AAC5C;;;ACJO,IAAM,UAAU,CAErB,OAEA,WACQ;AACR,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK,UAAU;AACb,aAAO,iBAAiB,OAAO,MAAM;AAAA,IACvC;AAAA,IACA,KAAK,UAAU;AACb,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAAA,IACA,KAAK,UAAU;AACb,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAAA,IACA,KAAK,UAAU;AACb,aAAO,mBAAmB,OAAO,MAAM;AAAA,IACzC;AAAA,IACA,SAAS;AACP,YAAM,IAAI,MAAM,iBAAiB,OAAO,KAAK,EAAE;AAAA,IACjD;AAAA,EACF;AACF;;;APfO,SAAS,MAAM,OAAgB,QAAwC;AAC5E,MAAI,cAAkC;AAEtC,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK,UAAU;AACb,oBAAc,iBAAiB,KAAK;AACpC;AAAA,IACF;AAAA,IACA,SAAS;AACP,aAAO,YAAY,OAAO,QAAQ,qBAAqB,OAAO,KAAK,GAAG;AAAA,IACxE;AAAA,EACF;AAEA,SAAO,MAAM,WAAW,IAAI,cAAc,YAAY,OAAO,QAAQ,qBAAqB,KAAK,GAAG;AACpG;;;AQ5BA,YAAYC,QAAO;AAQZ,IAAM,SAAW,UAAO,EAAE,MAAM,UAAU,EAAE,SAAS,qBAAqB,CAAC,EAAE,UAAU,SAAO,GAAiB;;;ACTtH,SAAS,gBAAgB;AASlB,IAAM,YAAY,CAAC,UAAmB;AAC3C,SAAO,SAAS,KAAK,IAAI,OAAO,iBAAiB,OAAO,EAAE,QAAQ,KAAK,CAAC,CAAC,MAAM,KAAK;AACtF;;;ACNO,IAAM,cAAc,CAAC,WAAwB;AAClD,SAAO,CAAC,GAAG,IAAI,WAAW,MAAM,CAAC,EAAE,IAAI,OAAK,EAAE,SAAS,EAAE,EAAE,SAAS,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE;AACtF;;;ACHO,IAAM,QAAQ,CAEnB,OAEA,SAAoB,CAAC,MAClB;AACH,QAAM,EAAE,SAAS,MAAM,IAAI;AAC3B,SAAO,QAAQ,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC;AAC7C;;;AZLO,IAAM,uBAAyB,UAAO,EAC1C,OAAO,OAAK,OAAO,UAAU,CAAC,EAAE,OAAO,EACvC,OAAO,OAAK,EAAE,WAAW,gBAAgB,EAAE,OAAO,OAAK,IAAI,MAAM,oCAAoC,EAAE,KAAK,GAAG,EAAE,CAAC,EAClH,UAAU,OAAK,CAAY;;;ADJvB,IAAM,sBAAwB,SAAM,CAAG,UAAO,GAAK,UAAO,GAAK,UAAO,CAAC,CAAC,EAC5E,UAAU,CAAC,UAAU;AACpB,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK,UAAU;AACb,aAAO,MAAM,SAAS,EAAE,EAAE,SAAS,gBAAgB,GAAG;AAAA,IACxD;AAAA,IACA,KAAK,UAAU;AACb,UAAI,MAAM,WAAW,IAAI,GAAG;AAC1B,eAAO,MAAM,MAAM,CAAC;AAAA,MACtB;AACA,aAAO;AAAA,IACT;AAAA,IACA,KAAK,UAAU;AACb,aAAO,OAAO,KAAK,EAAE,SAAS,EAAE,EAAE,SAAS,gBAAgB,GAAG;AAAA,IAChE;AAAA,EACF;AACF,CAAC,EACA,OAAO,OAAK,qBAAqB,UAAU,CAAC,EAAE,IAAI,EAClD,UAAU,OAAK,CAAY;;;AcvB9B,SAAS,eAAAC,oBAAmB;AAC5B,SAAS,gBAAgB;;;ACSlB,IAAM,YAAY,CAAC,OAAiB,SAAoB,CAAC,MAAwB;AACtF,QAAM,EAAE,YAAY,KAAK,SAAS,MAAM,IAAI;AAC5C,SAAO,MAAM,OAAO,EAAE,WAAW,OAAO,CAAC;AAC3C;AAGO,SAAS,YAAY,OAAmC;AAC7D,SAAO,qBAAqB,UAAU,KAAK,EAAE;AAC/C;;;ADFO,SAAS,UAAU,OAAgB,QAA4C;AACpF,MAAI;AACF,QAAI,cAAkC;AAEtC,YAAQ,OAAO,OAAO;AAAA,MACpB,KAAK,UAAU;AACb,sBAAc,iBAAiB,OAAO,EAAE,QAAQ,OAAO,UAAU,EAAE,CAAC;AACpE;AAAA,MACF;AAAA,MACA,SAAS;AACP,eAAO,SAAS,MAAM,IAAIC,aAAY,OAAO,QAAQ,qBAAqB,OAAO,KAAK,GAAG,IAAI;AAAA,MAC/F;AAAA,IACF;AACA,WAAO,UAAU,WAAW,IAAI,cAAcA,aAAY,OAAO,QAAQ,4BAA4B,KAAK,GAAG;AAAA,EAC/G,SAAS,IAAI;AACX,UAAM,QAAQ;AACd,WAAOA,aAAY,QAAW,QAAQ,MAAM,OAAO;AAAA,EACrD;AACF;AAGO,SAAS,YAAY,OAAgB,SAAkB,OAA4B;AACxF,SAAO,SACH,qBAAqB,MAAM,KAAK,IAChC,qBAAqB,UAAU,KAAK,EAAE;AAC5C;;;AE/BO,IAAM,YAAY,CAAC,OAAmD,SAAoB,CAAC,MAAe;AAC/G,QAAM,EAAE,YAAY,KAAK,SAAS,MAAM,IAAI;AAC5C,SAAO,QAAQ,OAAO;AAAA,IACpB;AAAA,IAAW;AAAA,IAAQ,GAAG;AAAA,EACxB,CAAC;AACH;AAGO,SAAS,YAAY,OAAgB,SAAkB,OAA4B;AACxF,SAAO,SACH,oBAAoB,MAAM,KAAK,IAC/B,oBAAoB,UAAU,KAAK,EAAE;AAC3C;;;ACtBA,SAAS,eAAAC,oBAAmB;AAE5B,YAAYC,QAAO;AASZ,IAAM,kBAAkB,kCAAkC,IAAI,EAAE;AAGhE,IAAM,wBAA0B,UAAO,EAAE,MAAM,eAAe;AAG9D,IAAM,2BAA2B;AAGjC,IAAM,0BAA4B,UAAO,EAAE,MAAM,eAAe,EAAE,UAAU,OAAK,aAAa,CAAC,CAAC;AAGhG,IAAM,6BAA6B;AAOnC,IAAM,mBAAmB;AAQzB,IAAM,eAAe,CAAC,OAAmD,SAAoB,CAAC,MAAkB;AACrH,QAAM,EAAE,YAAY,KAAK,SAAS,MAAM,IAAI;AAC5C,SAAO,KAAK,QAAQ,OAAO;AAAA,IACzB;AAAA,IAAW;AAAA,IAAQ,GAAG;AAAA,EACxB,CAAC,CAAC;AACJ;AAQO,IAAM,eAAe,CAAC,OAAgB,SAAoB,CAAC,MAA2B;AAC3F,QAAM,EAAE,YAAY,KAAK,SAAS,KAAK,IAAI;AAC3C,QAAM,eAAe,OAAO,UAAU,WAAW,MAAM,YAAY,IAAI;AACvE,SAAO,MAAM,cAAc,EAAE,WAAW,OAAO,CAAC;AAClD;AAGO,IAAM,gBAAkB,UAAO,EACnC,MAAM,iBAAiB,EAAE,SAAS,yBAAyB,CAAC,EAC5D;AAAA,EACC;AACF;AAUK,SAAS,aAAa,OAAgB,QAA+C;AAC1F,MAAI;AACF,QAAI,cAAkC;AAEtC,YAAQ,OAAO,OAAO;AAAA,MACpB,KAAK,UAAU;AACb,sBAAc,iBAAiB,OAAO,EAAE,QAAQ,MAAM,UAAU,EAAE,CAAC;AACnE;AAAA,MACF;AAAA,MACA,SAAS;AACP,YAAI,UAAU,QAAW;AACvB,iBAAOC,aAAY,OAAO,QAAQ,qBAAqB,OAAO,KAAK,GAAG;AAAA,QACxE;AAAA,MACF;AAAA,IACF;AACA,WAAO,aAAa,WAAW,IAAI,cAAcA,aAAY,OAAO,QAAQ,+BAA+B,KAAK,GAAG;AAAA,EACrH,SAAS,IAAI;AACX,UAAM,QAAQ;AACd,WAAOA,aAAY,QAAW,QAAQ,MAAM,OAAO;AAAA,EACrD;AACF;;;AC5FA,SAAS,eAAAC,oBAAmB;AAC5B,SAAS,mBAAmB;;;ACOrB,IAAM,SAAS,CAAC,OAAgB,YAA2B,QAAuB;AACvF,SAAO,MAAM,OAAO,EAAE,UAAU,CAAC;AACnC;;;ADKO,SAAS,OAAO,OAAgB,QAAyC;AAC9E,MAAI,cAAkC;AAEtC,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK,UAAU;AACb,oBAAc,iBAAiB,KAAK;AACpC;AAAA,IACF;AAAA,IACA,SAAS;AACP,aAAO,YAAY,MAAM,IAAI,SAAYC,aAAY,OAAO,QAAQ,qBAAqB,OAAO,KAAK,GAAG;AAAA,IAC1G;AAAA,EACF;AACA,SAAO,OAAO,WAAW,IAAI,cAAcA,aAAY,OAAO,QAAQ,wBAAwB,KAAK,GAAG;AACxG;;;AE5BA,YAAYC,QAAO;AAMZ,IAAM,cAAc;AAGpB,IAAM,YAAY,eAAe,aAAa,WAAW;AAGzD,IAAM,YAAY;AAKlB,IAAM,gBAAiC,CAAC,IAAI,IAAI,KAAK,KAAK,KAAK,MAAM,MAAM,IAAI;AAO/E,IAAM,kBAAkB,CAAC,UAA2C;AACzE,SAAO,OAAO,UAAU,YAAY,cAAc,SAAS,KAAsB;AACnF;AAMO,IAAM,UAAY,UAAO,EAC7B,MAAM,WAAW,EAAE,SAAS,qBAAqB,CAAC,EAAE,UAAU,SAAO,GAAkB;;;AClC1F,YAAYC,QAAO;AAOZ,IAAM,gBAAgB,QAAQ,UAAkB,OAAK,CAAC;AAEtD,IAAM,gBAAkB,UAAO,EAAE,UAAgB,OAAK,OAAO,GAAG,IAAI,CAAC;;;ACFrE,SAAS,YAAY,KAAkB;AAC5C,SAAO,OAAO,iBAAiB,KAAK,EAAE,QAAQ,KAAK,CAAC,CAAC;AACvD;;;ACTA,YAAYC,QAAO;AAMZ,IAAM,kBAAoB,UAAO,EAAE,YAAY,EAAE,UAAU,OAAK,MAAM,CAAC,CAAC;AAExE,IAAM,kBAAoB,UAAO,EAAE,UAAU,OAAK,MAAM,CAAC,CAAC,EAAE,UAAU,OAAK,YAAY,CAAC,CAAC;","names":["z","z","z","assertError","assertError","assertError","z","assertError","assertError","assertError","z","z","z"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/hex",
-  "version": "5.0.84",
+  "version": "5.0.86",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "hex",
@@ -42,13 +42,13 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/error": "~5.0.84",
-    "@xylabs/typeof": "~5.0.84"
+    "@xylabs/error": "~5.0.86",
+    "@xylabs/typeof": "~5.0.86"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.13",
-    "@xylabs/tsconfig": "~7.4.13",
-    "@xylabs/vitest-extended": "~5.0.84",
+    "@xylabs/ts-scripts-yarn3": "~7.4.16",
+    "@xylabs/tsconfig": "~7.4.16",
+    "@xylabs/vitest-extended": "~5.0.86",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18",
     "zod": "^4.3.6"