@xylabs/hex 2.13.10

package/dist/node/index.js

@@ -0,0 +1,130 @@
+// src/assert.ts
+var assertError = (value, assert, defaultMessage) => {
+  if (assert) {
+    const assertString = typeof assert === "string" ? assert : typeof assert === "boolean" ? defaultMessage : assert(value, defaultMessage);
+    if (assertString) {
+      throw Error(assertString === true ? defaultMessage : assertString);
+    }
+  }
+  return void 0;
+};
+
+// src/hex.ts
+var hexRegex = /^[0-9a-f]+$/i;
+var hexRegexWithPrefix = /0x[0-9a-f]+$/i;
+var hexFrom = (buffer) => {
+  return [...new Uint8Array(buffer)].map((x) => x.toString(16).padStart(2, "0")).join("");
+};
+var bitsToOctets = (value) => {
+  const octets = value >> 2;
+  if (value !== octets << 2)
+    throw Error("Bits for octets must multiple of 8");
+  return octets;
+};
+var octetsToBits = (value) => {
+  return value << 2;
+};
+var isRoundOctet = (value) => {
+  return value >> 2 << 2 === value;
+};
+var isHex = (value, bitLength) => {
+  if (typeof value !== "string")
+    return false;
+  if (bitLength !== void 0 && value.length !== bitsToOctets(bitLength))
+    return false;
+  return hexRegex.test(value);
+};
+function asHex(value, assertOrBitLength, assertOnly) {
+  const bitLength = typeof assertOrBitLength === "number" ? assertOrBitLength : void 0;
+  const assert = typeof assertOrBitLength !== "number" ? assertOrBitLength : assertOnly;
+  let stringValue = void 0;
+  switch (typeof value) {
+    case "string":
+      stringValue = hexRegexWithPrefix.test(value) ? value.substring(2) : value;
+      break;
+    case "number":
+      if (value === Math.floor(value)) {
+        stringValue = value.toString(16);
+      } else {
+        return assertError(value, assert, "Numbers must be whole");
+      }
+      break;
+    case "bigint":
+      stringValue = value.toString(16);
+      break;
+    case "object":
+      if (value instanceof ArrayBuffer) {
+        stringValue = hexFrom(value);
+      }
+      break;
+    default:
+      return assertError(value, assert, `Unsupported type [${typeof value}]`);
+  }
+  if (stringValue && bitLength) {
+    stringValue = stringValue.padStart(bitsToOctets(bitLength), "0");
+  }
+  return isHex(stringValue, bitLength) ? stringValue.toLowerCase() : assertError(value, assert, "Unable to convert to Hash");
+}
+
+// src/address.ts
+var addressRegex = /0x[0-9a-f]+/i;
+var isAddress = (value, bitLength = 160) => {
+  if (typeof value !== "string")
+    return false;
+  if (!addressRegex.test(value))
+    return false;
+  const valueHex = value.substring(2);
+  if (bitLength !== void 0 && valueHex.length !== bitsToOctets(bitLength))
+    return false;
+  return isHex(valueHex, bitLength);
+};
+function asAddress(value, assertOrBitLength, assertOnly) {
+  const bitLength = typeof assertOrBitLength === "number" ? assertOrBitLength : 160;
+  const assert = typeof assertOrBitLength !== "number" ? assertOrBitLength : assertOnly;
+  const result = `0x${asHex(value, bitLength, assert)}`;
+  return isAddress(result, bitLength) ? result : assertError(value, assert, "Resulting value is not an Address");
+}
+
+// src/hash.ts
+var HashBitLength = [32, 64, 128, 256, 512, 1024, 2048, 4096];
+var isHashBitLength = (value) => {
+  return typeof value === "number" && HashBitLength.includes(value);
+};
+var isHash = (value, bitLength = 256) => {
+  if (!isHex(value, bitLength))
+    return false;
+  const hex = asHex(value, bitLength);
+  if (!hex)
+    return false;
+  if (!isHashBitLength(octetsToBits(hex.length)))
+    return false;
+  return true;
+};
+var toHex = (buffer) => {
+  return [...new Uint8Array(buffer)].map((x) => x.toString(16).padStart(2, "0")).join("");
+};
+function asHash(value, assertOrBitLength, assertOnly) {
+  const bitLength = typeof assertOrBitLength === "number" ? assertOrBitLength : 256;
+  const assert = typeof assertOrBitLength !== "number" ? assertOrBitLength : assertOnly;
+  const result = asHex(value, bitLength, assert);
+  return isHash(result, bitLength) ? result : assertError(value, assert, "Resulting value is not a Hash");
+}
+export {
+  HashBitLength,
+  addressRegex,
+  asAddress,
+  asHash,
+  asHex,
+  bitsToOctets,
+  hexFrom,
+  hexRegex,
+  hexRegexWithPrefix,
+  isAddress,
+  isHash,
+  isHashBitLength,
+  isHex,
+  isRoundOctet,
+  octetsToBits,
+  toHex
+};
+//# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/assert.ts","../../src/hex.ts","../../src/address.ts","../../src/hash.ts"],"sourcesContent":["export type AssertCallback = (value: unknown, message: string) => string | boolean\n\nexport type AssertConfig = string | AssertCallback | boolean\n\nexport const assertError = (value: unknown, assert: AssertConfig | undefined, defaultMessage: string) => {\n  if (assert) {\n    const assertString = typeof assert === 'string' ? assert : typeof assert === 'boolean' ? defaultMessage : assert(value, defaultMessage)\n    if (assertString) {\n      throw Error(assertString === true ? defaultMessage : assertString)\n    }\n  }\n  return undefined\n}\n","import { AssertConfig, assertError } from './assert'\n\nexport const hexRegex = /^[0-9a-f]+$/i\nexport const hexRegexWithPrefix = /0x[0-9a-f]+$/i\n\nexport type Hex = string\n\nexport const hexFrom = (buffer: ArrayBuffer) => {\n  return [...new Uint8Array(buffer)].map((x) => x.toString(16).padStart(2, '0')).join('')\n}\n\n//determine the number of octets for a given number of bits\nexport const bitsToOctets = (value: number): number => {\n  const octets = value >> 2\n  if (value !== octets << 2) throw Error('Bits for octets must multiple of 8')\n  return octets\n}\n\n//determine the number of octets for a given number of bits\nexport const octetsToBits = (value: number): number => {\n  return value << 2\n}\n\n//are the number of bit a round octet (factor of 8)?\nexport const isRoundOctet = (value: number) => {\n  return (value >> 2) << 2 === value\n}\n\nexport const isHex = (value: unknown, bitLength?: number): value is Hex => {\n  //Is it a string?\n  if (typeof value !== 'string') return false\n\n  //If a bitLength specified, does it conform?\n  if (bitLength !== undefined && value.length !== bitsToOctets(bitLength)) return false\n\n  //Does it only has hex values?\n  return hexRegex.test(value)\n}\n\nexport function asHex(value: unknown): Hex | undefined\nexport function asHex(value: unknown, bitLength?: number): Hex | undefined\nexport function asHex(value: unknown, assert: AssertConfig): Hex\nexport function asHex(value: unknown, bitLength: number | undefined, assert?: AssertConfig): Hex\nexport function asHex(value: unknown, assertOrBitLength?: AssertConfig | number, assertOnly?: AssertConfig): Hex | undefined {\n  const bitLength = typeof assertOrBitLength === 'number' ? assertOrBitLength : undefined\n  const assert = typeof assertOrBitLength !== 'number' ? assertOrBitLength : assertOnly\n\n  let stringValue: string | undefined = undefined\n\n  switch (typeof value) {\n    case 'string':\n      //remove the leading 0x if it is there\n      stringValue = hexRegexWithPrefix.test(value) ? value.substring(2) : value\n      break\n    case 'number':\n      if (value === Math.floor(value)) {\n        stringValue = value.toString(16)\n      } else {\n        return assertError(value, assert, 'Numbers must be whole')\n      }\n      break\n    case 'bigint':\n      stringValue = value.toString(16)\n      break\n    case 'object':\n      if (value instanceof ArrayBuffer) {\n        stringValue = hexFrom(value)\n      }\n      break\n    default:\n      return assertError(value, assert, `Unsupported type [${typeof value}]`)\n  }\n\n  //make it conform to the bit length if shorter\n  if (stringValue && bitLength) {\n    stringValue = stringValue.padStart(bitsToOctets(bitLength), '0')\n  }\n\n  return isHex(stringValue, bitLength) ? stringValue.toLowerCase() : assertError(value, assert, 'Unable to convert to Hash')\n}\n","import { AssertConfig, assertError } from './assert'\nimport { asHex, bitsToOctets, isHex } from './hex'\n\nexport const addressRegex = /0x[0-9a-f]+/i\n\nexport type Address = string\n\nexport const isAddress = (value: unknown, bitLength = 160): value is Address => {\n  //Is it a string?\n  if (typeof value !== 'string') return false\n\n  //Does it only has hex values and leading 0x?\n  if (!addressRegex.test(value)) return false\n\n  const valueHex = value.substring(2)\n\n  //If a bitLength specified, does it conform?\n  if (bitLength !== undefined && valueHex.length !== bitsToOctets(bitLength)) return false\n\n  return isHex(valueHex, bitLength)\n}\n\nexport function asAddress(value: unknown): Address | undefined\nexport function asAddress(value: unknown, assert: AssertConfig): Address\nexport function asAddress(value: unknown, bitLength: number): Address | undefined\nexport function asAddress(value: unknown, bitLength: number, assert: AssertConfig): Address\nexport function asAddress(value: unknown, assertOrBitLength?: AssertConfig | number, assertOnly?: AssertConfig): Address | undefined {\n  const bitLength = typeof assertOrBitLength === 'number' ? assertOrBitLength : 160\n  const assert = typeof assertOrBitLength !== 'number' ? assertOrBitLength : assertOnly\n\n  const result = `0x${asHex(value, bitLength, assert)}`\n  return isAddress(result, bitLength) ? result : assertError(value, assert, 'Resulting value is not an Address')\n}\n","import { AssertConfig, assertError } from './assert'\nimport { asHex, Hex, isHex, octetsToBits } from './hex'\n\nexport type HashBitLength = 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096\nexport const HashBitLength: HashBitLength[] = [32, 64, 128, 256, 512, 1024, 2048, 4096]\n\nexport const isHashBitLength = (value: unknown): value is HashBitLength => {\n  return typeof value === 'number' && HashBitLength.includes(value as HashBitLength)\n}\n\nexport type Hash = Hex\nexport const isHash = (value: unknown, bitLength: HashBitLength = 256): value is Hash => {\n  if (!isHex(value, bitLength)) return false\n\n  const hex = asHex(value, bitLength)\n  if (!hex) return false\n\n  if (!isHashBitLength(octetsToBits(hex.length))) return false\n\n  return true\n}\n\nexport const toHex = (buffer: ArrayBuffer) => {\n  return [...new Uint8Array(buffer)].map((x) => x.toString(16).padStart(2, '0')).join('')\n}\n\nexport function asHash(value: unknown): Hash | undefined\nexport function asHash(value: unknown, assert: AssertConfig): Hash\nexport function asHash(value: unknown, bitLength?: HashBitLength): Hash | undefined\nexport function asHash(value: unknown, bitLength: HashBitLength | undefined, assert: AssertConfig): Hash\nexport function asHash(value: unknown, assertOrBitLength?: AssertConfig | HashBitLength, assertOnly?: AssertConfig): Hash | undefined {\n  const bitLength: HashBitLength = typeof assertOrBitLength === 'number' ? assertOrBitLength : 256\n  const assert = typeof assertOrBitLength !== 'number' ? assertOrBitLength : assertOnly\n\n  const result = asHex(value, bitLength, assert)\n  return isHash(result, bitLength) ? result : assertError(value, assert, 'Resulting value is not a Hash')\n}\n"],"mappings":";AAIO,IAAM,cAAc,CAAC,OAAgB,QAAkC,mBAA2B;AACvG,MAAI,QAAQ;AACV,UAAM,eAAe,OAAO,WAAW,WAAW,SAAS,OAAO,WAAW,YAAY,iBAAiB,OAAO,OAAO,cAAc;AACtI,QAAI,cAAc;AAChB,YAAM,MAAM,iBAAiB,OAAO,iBAAiB,YAAY;AAAA,IACnE;AAAA,EACF;AACA,SAAO;AACT;;;ACVO,IAAM,WAAW;AACjB,IAAM,qBAAqB;AAI3B,IAAM,UAAU,CAAC,WAAwB;AAC9C,SAAO,CAAC,GAAG,IAAI,WAAW,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE;AACxF;AAGO,IAAM,eAAe,CAAC,UAA0B;AACrD,QAAM,SAAS,SAAS;AACxB,MAAI,UAAU,UAAU;AAAG,UAAM,MAAM,oCAAoC;AAC3E,SAAO;AACT;AAGO,IAAM,eAAe,CAAC,UAA0B;AACrD,SAAO,SAAS;AAClB;AAGO,IAAM,eAAe,CAAC,UAAkB;AAC7C,SAAQ,SAAS,KAAM,MAAM;AAC/B;AAEO,IAAM,QAAQ,CAAC,OAAgB,cAAqC;AAEzE,MAAI,OAAO,UAAU;AAAU,WAAO;AAGtC,MAAI,cAAc,UAAa,MAAM,WAAW,aAAa,SAAS;AAAG,WAAO;AAGhF,SAAO,SAAS,KAAK,KAAK;AAC5B;AAMO,SAAS,MAAM,OAAgB,mBAA2C,YAA4C;AAC3H,QAAM,YAAY,OAAO,sBAAsB,WAAW,oBAAoB;AAC9E,QAAM,SAAS,OAAO,sBAAsB,WAAW,oBAAoB;AAE3E,MAAI,cAAkC;AAEtC,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AAEH,oBAAc,mBAAmB,KAAK,KAAK,IAAI,MAAM,UAAU,CAAC,IAAI;AACpE;AAAA,IACF,KAAK;AACH,UAAI,UAAU,KAAK,MAAM,KAAK,GAAG;AAC/B,sBAAc,MAAM,SAAS,EAAE;AAAA,MACjC,OAAO;AACL,eAAO,YAAY,OAAO,QAAQ,uBAAuB;AAAA,MAC3D;AACA;AAAA,IACF,KAAK;AACH,oBAAc,MAAM,SAAS,EAAE;AAC/B;AAAA,IACF,KAAK;AACH,UAAI,iBAAiB,aAAa;AAChC,sBAAc,QAAQ,KAAK;AAAA,MAC7B;AACA;AAAA,IACF;AACE,aAAO,YAAY,OAAO,QAAQ,qBAAqB,OAAO,KAAK,GAAG;AAAA,EAC1E;AAGA,MAAI,eAAe,WAAW;AAC5B,kBAAc,YAAY,SAAS,aAAa,SAAS,GAAG,GAAG;AAAA,EACjE;AAEA,SAAO,MAAM,aAAa,SAAS,IAAI,YAAY,YAAY,IAAI,YAAY,OAAO,QAAQ,2BAA2B;AAC3H;;;AC5EO,IAAM,eAAe;AAIrB,IAAM,YAAY,CAAC,OAAgB,YAAY,QAA0B;AAE9E,MAAI,OAAO,UAAU;AAAU,WAAO;AAGtC,MAAI,CAAC,aAAa,KAAK,KAAK;AAAG,WAAO;AAEtC,QAAM,WAAW,MAAM,UAAU,CAAC;AAGlC,MAAI,cAAc,UAAa,SAAS,WAAW,aAAa,SAAS;AAAG,WAAO;AAEnF,SAAO,MAAM,UAAU,SAAS;AAClC;AAMO,SAAS,UAAU,OAAgB,mBAA2C,YAAgD;AACnI,QAAM,YAAY,OAAO,sBAAsB,WAAW,oBAAoB;AAC9E,QAAM,SAAS,OAAO,sBAAsB,WAAW,oBAAoB;AAE3E,QAAM,SAAS,KAAK,MAAM,OAAO,WAAW,MAAM,CAAC;AACnD,SAAO,UAAU,QAAQ,SAAS,IAAI,SAAS,YAAY,OAAO,QAAQ,mCAAmC;AAC/G;;;AC5BO,IAAM,gBAAiC,CAAC,IAAI,IAAI,KAAK,KAAK,KAAK,MAAM,MAAM,IAAI;AAE/E,IAAM,kBAAkB,CAAC,UAA2C;AACzE,SAAO,OAAO,UAAU,YAAY,cAAc,SAAS,KAAsB;AACnF;AAGO,IAAM,SAAS,CAAC,OAAgB,YAA2B,QAAuB;AACvF,MAAI,CAAC,MAAM,OAAO,SAAS;AAAG,WAAO;AAErC,QAAM,MAAM,MAAM,OAAO,SAAS;AAClC,MAAI,CAAC;AAAK,WAAO;AAEjB,MAAI,CAAC,gBAAgB,aAAa,IAAI,MAAM,CAAC;AAAG,WAAO;AAEvD,SAAO;AACT;AAEO,IAAM,QAAQ,CAAC,WAAwB;AAC5C,SAAO,CAAC,GAAG,IAAI,WAAW,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE;AACxF;AAMO,SAAS,OAAO,OAAgB,mBAAkD,YAA6C;AACpI,QAAM,YAA2B,OAAO,sBAAsB,WAAW,oBAAoB;AAC7F,QAAM,SAAS,OAAO,sBAAsB,WAAW,oBAAoB;AAE3E,QAAM,SAAS,MAAM,OAAO,WAAW,MAAM;AAC7C,SAAO,OAAO,QAAQ,SAAS,IAAI,SAAS,YAAY,OAAO,QAAQ,+BAA+B;AACxG;","names":[]}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "license": "LGPL-3.0-only",
+  "name": "@xylabs/hex",
+  "author": {
+    "email": "support@xylabs.com",
+    "name": "XY Labs Development Team",
+    "url": "https://xylabs.com"
+  },
+  "bugs": {
+    "email": "support@xylabs.com",
+    "url": "https://github.com/xylabs/sdk-js/issues"
+  },
+  "workspaces": [
+    "packages/**/*"
+  ],
+  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/node/index.d.cts",
+        "default": "./dist/node/index.cjs"
+      },
+      "import": {
+        "types": "./dist/node/index.d.mts",
+        "default": "./dist/node/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/node/index.cjs",
+  "types": "./dist/node/index.d.ts",
+  "module": "./dist/node/index.js",
+  "homepage": "https://xylabs.com",
+  "keywords": [
+    "xylabs",
+    "utility",
+    "typescript",
+    "esm"
+  ],
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^3.2.8",
+    "@xylabs/tsconfig": "^3.2.8",
+    "typescript": "^5.3.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/xylabs/sdk-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.13.10",
+  "packageManager": "yarn@3.3.1",
+  "type": "module"
+}

package/src/address.ts

@@ -0,0 +1,33 @@
+import { AssertConfig, assertError } from './assert'
+import { asHex, bitsToOctets, isHex } from './hex'
+
+export const addressRegex = /0x[0-9a-f]+/i
+
+export type Address = string
+
+export const isAddress = (value: unknown, bitLength = 160): value is Address => {
+  //Is it a string?
+  if (typeof value !== 'string') return false
+
+  //Does it only has hex values and leading 0x?
+  if (!addressRegex.test(value)) return false
+
+  const valueHex = value.substring(2)
+
+  //If a bitLength specified, does it conform?
+  if (bitLength !== undefined && valueHex.length !== bitsToOctets(bitLength)) return false
+
+  return isHex(valueHex, bitLength)
+}
+
+export function asAddress(value: unknown): Address | undefined
+export function asAddress(value: unknown, assert: AssertConfig): Address
+export function asAddress(value: unknown, bitLength: number): Address | undefined
+export function asAddress(value: unknown, bitLength: number, assert: AssertConfig): Address
+export function asAddress(value: unknown, assertOrBitLength?: AssertConfig | number, assertOnly?: AssertConfig): Address | undefined {
+  const bitLength = typeof assertOrBitLength === 'number' ? assertOrBitLength : 160
+  const assert = typeof assertOrBitLength !== 'number' ? assertOrBitLength : assertOnly
+
+  const result = `0x${asHex(value, bitLength, assert)}`
+  return isAddress(result, bitLength) ? result : assertError(value, assert, 'Resulting value is not an Address')
+}

package/src/assert.ts

@@ -0,0 +1,13 @@
+export type AssertCallback = (value: unknown, message: string) => string | boolean
+
+export type AssertConfig = string | AssertCallback | boolean
+
+export const assertError = (value: unknown, assert: AssertConfig | undefined, defaultMessage: string) => {
+  if (assert) {
+    const assertString = typeof assert === 'string' ? assert : typeof assert === 'boolean' ? defaultMessage : assert(value, defaultMessage)
+    if (assertString) {
+      throw Error(assertString === true ? defaultMessage : assertString)
+    }
+  }
+  return undefined
+}

package/src/hash.ts

@@ -0,0 +1,37 @@
+import { AssertConfig, assertError } from './assert'
+import { asHex, Hex, isHex, octetsToBits } from './hex'
+
+export type HashBitLength = 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096
+export const HashBitLength: HashBitLength[] = [32, 64, 128, 256, 512, 1024, 2048, 4096]
+
+export const isHashBitLength = (value: unknown): value is HashBitLength => {
+  return typeof value === 'number' && HashBitLength.includes(value as HashBitLength)
+}
+
+export type Hash = Hex
+export const isHash = (value: unknown, bitLength: HashBitLength = 256): value is Hash => {
+  if (!isHex(value, bitLength)) return false
+
+  const hex = asHex(value, bitLength)
+  if (!hex) return false
+
+  if (!isHashBitLength(octetsToBits(hex.length))) return false
+
+  return true
+}
+
+export const toHex = (buffer: ArrayBuffer) => {
+  return [...new Uint8Array(buffer)].map((x) => x.toString(16).padStart(2, '0')).join('')
+}
+
+export function asHash(value: unknown): Hash | undefined
+export function asHash(value: unknown, assert: AssertConfig): Hash
+export function asHash(value: unknown, bitLength?: HashBitLength): Hash | undefined
+export function asHash(value: unknown, bitLength: HashBitLength | undefined, assert: AssertConfig): Hash
+export function asHash(value: unknown, assertOrBitLength?: AssertConfig | HashBitLength, assertOnly?: AssertConfig): Hash | undefined {
+  const bitLength: HashBitLength = typeof assertOrBitLength === 'number' ? assertOrBitLength : 256
+  const assert = typeof assertOrBitLength !== 'number' ? assertOrBitLength : assertOnly
+
+  const result = asHex(value, bitLength, assert)
+  return isHash(result, bitLength) ? result : assertError(value, assert, 'Resulting value is not a Hash')
+}

package/src/hex.ts

@@ -0,0 +1,80 @@
+import { AssertConfig, assertError } from './assert'
+
+export const hexRegex = /^[0-9a-f]+$/i
+export const hexRegexWithPrefix = /0x[0-9a-f]+$/i
+
+export type Hex = string
+
+export const hexFrom = (buffer: ArrayBuffer) => {
+  return [...new Uint8Array(buffer)].map((x) => x.toString(16).padStart(2, '0')).join('')
+}
+
+//determine the number of octets for a given number of bits
+export const bitsToOctets = (value: number): number => {
+  const octets = value >> 2
+  if (value !== octets << 2) throw Error('Bits for octets must multiple of 8')
+  return octets
+}
+
+//determine the number of octets for a given number of bits
+export const octetsToBits = (value: number): number => {
+  return value << 2
+}
+
+//are the number of bit a round octet (factor of 8)?
+export const isRoundOctet = (value: number) => {
+  return (value >> 2) << 2 === value
+}
+
+export const isHex = (value: unknown, bitLength?: number): value is Hex => {
+  //Is it a string?
+  if (typeof value !== 'string') return false
+
+  //If a bitLength specified, does it conform?
+  if (bitLength !== undefined && value.length !== bitsToOctets(bitLength)) return false
+
+  //Does it only has hex values?
+  return hexRegex.test(value)
+}
+
+export function asHex(value: unknown): Hex | undefined
+export function asHex(value: unknown, bitLength?: number): Hex | undefined
+export function asHex(value: unknown, assert: AssertConfig): Hex
+export function asHex(value: unknown, bitLength: number | undefined, assert?: AssertConfig): Hex
+export function asHex(value: unknown, assertOrBitLength?: AssertConfig | number, assertOnly?: AssertConfig): Hex | undefined {
+  const bitLength = typeof assertOrBitLength === 'number' ? assertOrBitLength : undefined
+  const assert = typeof assertOrBitLength !== 'number' ? assertOrBitLength : assertOnly
+
+  let stringValue: string | undefined = undefined
+
+  switch (typeof value) {
+    case 'string':
+      //remove the leading 0x if it is there
+      stringValue = hexRegexWithPrefix.test(value) ? value.substring(2) : value
+      break
+    case 'number':
+      if (value === Math.floor(value)) {
+        stringValue = value.toString(16)
+      } else {
+        return assertError(value, assert, 'Numbers must be whole')
+      }
+      break
+    case 'bigint':
+      stringValue = value.toString(16)
+      break
+    case 'object':
+      if (value instanceof ArrayBuffer) {
+        stringValue = hexFrom(value)
+      }
+      break
+    default:
+      return assertError(value, assert, `Unsupported type [${typeof value}]`)
+  }
+
+  //make it conform to the bit length if shorter
+  if (stringValue && bitLength) {
+    stringValue = stringValue.padStart(bitsToOctets(bitLength), '0')
+  }
+
+  return isHex(stringValue, bitLength) ? stringValue.toLowerCase() : assertError(value, assert, 'Unable to convert to Hash')
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './address'
+export * from './hash'
+export * from './hex'