@pezkuwi/util 14.0.5 → 14.0.6

package/src/test/performance.ts

@@ -0,0 +1,92 @@
+// Copyright 2017-2025 @pezkuwi/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+/* global it, expect */
+
+import { formatDecimal, formatNumber, stringify } from '../index.js';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type ExecFn = (...params: any[]) => unknown;
+
+const NUM_PAD = 16;
+const PRE_PAD = 32;
+
+function loop (exec: ExecFn, count: number, inputs: readonly unknown[][]): [number, unknown[]] {
+  const start = performance.now();
+  const results = new Array<unknown>(inputs.length);
+
+  for (let i = 0; i < count; i++) {
+    const result = exec(...inputs[i % inputs.length]);
+
+    if (i < inputs.length) {
+      results[i] = result;
+    }
+  }
+
+  return [performance.now() - start, results];
+}
+
+export function formatFixed (value: number): string {
+  const [a, b] = value.toFixed(2).split('.');
+
+  return [formatDecimal(a), b].join('.');
+}
+
+export function formatOps (count: number, time: number): string {
+  const micro = (time * 1000) / count;
+  const ops = 1_000_000 / micro;
+
+  return `
+${formatFixed(ops).padStart(NUM_PAD + PRE_PAD + 1)} ops/s
+${formatFixed(micro).padStart(NUM_PAD + PRE_PAD + 1)} μs/op`;
+}
+
+export function perf (name: string, count: number, inputs: readonly unknown[][], exec: ExecFn, withLog?: boolean): void {
+  const test = process.env['GITHUB_REPOSITORY']
+    ? it.skip
+    : it;
+
+  test(`performance: ${name}`, (): void => {
+    const [time, results] = loop(exec, count, inputs);
+
+    console.error(`
+performance run for ${name} completed with ${formatNumber(count)} iterations.
+
+${`${name}:`.padStart(PRE_PAD)} ${time.toFixed(2).padStart(NUM_PAD)} ms${formatOps(count, time)}
+`);
+
+    if (withLog) {
+      console.log(results);
+    }
+  });
+}
+
+export function perfCmp (name: string, [first, second]: [string, string], count: number, inputs: readonly unknown[][], exec: ExecFn): void {
+  const test = process.env['GITHUB_REPOSITORY']
+    ? it.skip
+    : it;
+
+  test(`performance: ${name}`, (): void => {
+    const [[t1, r1], [t2, r2]] = [false, true].map((flag) =>
+      loop(exec, count, inputs.map((values) =>
+        [...values, flag]
+      ))
+    );
+
+    console.error(`
+performance run for ${name} completed with ${formatNumber(count)} iterations.
+
+${`${first}:`.padStart(PRE_PAD)} ${t1.toFixed(2).padStart(NUM_PAD)} ms ${t1 < t2 ? '(fastest)' : `(slowest, ${(t1 / t2).toFixed(2)}x)`}${formatOps(count, t1)}
+
+${`${second}:`.padStart(PRE_PAD)} ${t2.toFixed(2).padStart(NUM_PAD)} ms ${t1 > t2 ? '(fastest)' : `(slowest, ${(t2 / t1).toFixed(2)}x)`}${formatOps(count, t2)}
+`);
+
+    expect(
+      r1.filter((_, i) =>
+        stringify(r1[i]) !== stringify(r2[i])
+      )
+    ).toHaveLength(0);
+  });
+}

package/src/types.ts

@@ -0,0 +1,100 @@
+// Copyright 2017-2025 @pezkuwi/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { BN } from './bn/bn.js';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+/** An interface that defines an actual JS class */
+export interface Class<T = any, A extends unknown[] = any[]> {
+  prototype: T;
+
+  new (...args: A): T;
+
+  hasOwnProperty (prop: string): boolean;
+  isPrototypeOf (other: unknown): boolean;
+}
+
+// @deprecated Use Class<T, A> instead
+export type Constructor<T = any, A extends unknown[] = any[]> = Class<T, A>;
+
+export interface ToBigInt {
+  toBigInt: () => bigint;
+}
+
+export interface ToBn {
+  toBn: () => BN;
+}
+
+export interface SiDef {
+  power: number;
+  text: string;
+  value: string;
+}
+
+export interface Logger {
+  debug: (...values: unknown[]) => void;
+  error: (...values: unknown[]) => void;
+  log: (...values: unknown[]) => void;
+  noop: (...values: unknown[]) => void;
+  warn: (...values: unknown[]) => void;
+}
+
+export interface ToBnOptions {
+  /** Convert in LE format */
+  isLe?: boolean;
+  /** Number is signed, apply two's complement */
+  isNegative?: boolean;
+}
+
+export interface NumberOptions extends ToBnOptions {
+  /** Limit to the specified bitLength, despite input length */
+  bitLength?: number;
+}
+
+export interface Time {
+  days: number;
+  hours: number;
+  minutes: number;
+  seconds: number;
+  milliseconds: number;
+}
+
+export type Memoized<F> = F & {
+  unmemoize: (...args: unknown[]) => void;
+}
+
+// eslint-disable-next-line @typescript-eslint/ban-types
+export type AnyString = string | String;
+
+export type HexDigit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'a' | 'b' | 'c' | 'd' | 'e' | 'f';
+
+// One day when template strings support regex, we can improve this
+export type HexString = `0x${string}`;
+
+// BufferObject interface compatible with Buffer since we don't want to require
+// references to the Buffer types from the node typings
+//
+// Caveat: the references still do sneak in in the d.ts files, specifically
+// inside u8a/toBuffer & is/buffer (but not in compiled outputs)
+export interface BufferObject extends Uint8Array {
+  // Possibly used externally via type imports
+  equals: (otherBuffer: Uint8Array) => boolean;
+  // As used in is/buffer
+  readDoubleLE: (offset?: number) => number;
+}
+
+// We define a scappy low-level interface to mock Buffer
+// (this removes the need for the node typings in built bundles)
+export interface BufferClass extends Class<BufferObject> {
+  // As used in u8a/toBuffer
+  from: <T = BufferObject>(value: unknown) => T;
+  // As used in is/buffer
+  isBuffer: (value: unknown) => boolean;
+}
+
+export type U8aLike = number[] | Uint8Array | AnyString;
+
+export interface Observable {
+  next: (...params: unknown[]) => unknown;
+}

package/src/u8a/cmp.spec.ts

@@ -0,0 +1,62 @@
+// Copyright 2017-2025 @pezkuwi/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import { perf } from '../test/index.js';
+import { u8aCmp } from './index.js';
+
+const ltest = new Uint8Array(32768);
+const stest = new Uint8Array(256);
+const ztest = new Uint8Array(64);
+
+for (let i = 0, count = ltest.length; i < count; i++) {
+  if (i < ztest.length) {
+    ztest[i] = i % 256;
+  }
+
+  if (i < stest.length) {
+    stest[i] = i % 256;
+  }
+
+  ltest[i] = i % 256;
+}
+
+describe('u8aCmp', (): void => {
+  it('has the same result as localCompare (equal length)', (): void => {
+    const a = 'test abc';
+    const b = 'test def';
+
+    expect(
+      u8aCmp(a, b)
+    ).toEqual(a.localeCompare(b));
+    expect(
+      u8aCmp(b, a)
+    ).toEqual(b.localeCompare(a));
+  });
+
+  it('has the same result as localCompare (diff length)', (): void => {
+    const a = 'test';
+    const b = 'test abc';
+
+    expect(
+      u8aCmp(a, b)
+    ).toEqual(a.localeCompare(b));
+    expect(
+      u8aCmp(b, a)
+    ).toEqual(b.localeCompare(a));
+  });
+
+  it('compares between string and Uint8Array', (): void => {
+    expect(
+      u8aCmp(
+        '0x12345678',
+        new Uint8Array([0x12, 0x34, 0x56, 0x78])
+      )
+    ).toEqual(0);
+  });
+
+  perf('u8aCmp (64 cmp)', 100_000, [[ztest, ztest]], u8aCmp);
+  perf('u8aCmp (256 cmp)', 50_000, [[stest, stest]], u8aCmp);
+  perf('u8aCmp (32k cmp)', 500, [[ltest, ltest]], u8aCmp);
+});

package/src/u8a/cmp.ts

@@ -0,0 +1,50 @@
+// Copyright 2017-2025 @pezkuwi/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { u8aToU8a } from './toU8a.js';
+
+/**
+ * @name u8aCmp
+ * @summary Compares two Uint8Arrays for sorting.
+ * @description
+ * For `UInt8Array` (or hex string) input values returning -1, 0 or +1
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aCmp } from '@pezkuwi/util';
+ *
+ * u8aCmp(new Uint8Array([0x67, 0x65]), new Uint8Array([0x68, 0x65])); // -1
+ * u8aCmp(new Uint8Array([0x68, 0x65]), new Uint8Array([0x68, 0x65])); // 0
+ * u8aCmp(new Uint8Array([0x69, 0x65]), new Uint8Array([0x68, 0x65])); // +1
+ * ```
+ */
+export function u8aCmp (a: string | Uint8Array, b: string | Uint8Array): number {
+  const u8aa = u8aToU8a(a);
+  const u8ab = u8aToU8a(b);
+  let i = 0;
+
+  while (true) {
+    const overA = i >= u8aa.length;
+    const overB = i >= u8ab.length;
+
+    if (overA && overB) {
+      // both ends reached
+      return 0;
+    } else if (overA) {
+      // a has no more data, b has data
+      return -1;
+    } else if (overB) {
+      // b has no more data, a has data
+      return 1;
+    } else if (u8aa[i] !== u8ab[i]) {
+      // the number in this index doesn't match
+      // (we don't use u8aa[i] - u8ab[i] since that doesn't match with localeCompare)
+      return u8aa[i] > u8ab[i]
+        ? 1
+        : -1;
+    }
+
+    i++;
+  }
+}

package/src/u8a/concat.spec.ts

@@ -0,0 +1,42 @@
+// Copyright 2017-2025 @pezkuwi/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import { getRandomValues } from '@pezkuwi/x-randomvalues';
+
+import { arrayRange } from '../array/index.js';
+import { perf } from '../test/index.js';
+import { u8aConcat, u8aConcatStrict } from './index.js';
+
+const ptest = arrayRange(10).map(() => getRandomValues(new Uint8Array(32)));
+
+describe('u8aConcat', (): void => {
+  it('concatenates arrays', (): void => {
+    expect(
+      u8aConcat(
+        new Uint8Array([1, 2, 3, 4]),
+        new Uint8Array([5, 6]),
+        new Uint8Array([7, 8, 9])
+      )
+    ).toEqual(
+      new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 9])
+    );
+  });
+
+  it('concatenates arrays & hex values', (): void => {
+    expect(
+      u8aConcat(
+        new Uint8Array([1, 2, 3, 4]),
+        '0x0506',
+        '0x070809'
+      )
+    ).toEqual(
+      new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 9])
+    );
+  });
+
+  perf('u8aConcat', 10000, [[ptest]], u8aConcat);
+  perf('u8aConcatStrict', 10000, [[[ptest]]], u8aConcatStrict);
+  perf('u8aConcatStrict (len)', 10000, [[[ptest], 320]], u8aConcatStrict);
+});

package/src/u8a/concat.ts

@@ -0,0 +1,60 @@
+// Copyright 2017-2025 @pezkuwi/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { U8aLike } from '../types.js';
+
+import { u8aToU8a } from './toU8a.js';
+
+/**
+ * @name u8aConcat
+ * @summary Creates a concatenated Uint8Array from the inputs.
+ * @description
+ * Concatenates the input arrays into a single `UInt8Array`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { { u8aConcat } from '@pezkuwi/util';
+ *
+ * u8aConcat(
+ *   new Uint8Array([1, 2, 3]),
+ *   new Uint8Array([4, 5, 6])
+ * ); // [1, 2, 3, 4, 5, 6]
+ * ```
+ */
+export function u8aConcat (...list: readonly U8aLike[]): Uint8Array {
+  const count = list.length;
+  const u8as = new Array<Uint8Array>(count);
+  let length = 0;
+
+  for (let i = 0; i < count; i++) {
+    u8as[i] = u8aToU8a(list[i]);
+    length += u8as[i].length;
+  }
+
+  return u8aConcatStrict(u8as, length);
+}
+
+/**
+ * @name u8aConcatStrict
+ * @description A strict version of [[u8aConcat]], accepting only Uint8Array inputs
+ */
+export function u8aConcatStrict (u8as: readonly Uint8Array[], length = 0): Uint8Array {
+  const count = u8as.length;
+  let offset = 0;
+
+  if (!length) {
+    for (let i = 0; i < count; i++) {
+      length += u8as[i].length;
+    }
+  }
+
+  const result = new Uint8Array(length);
+
+  for (let i = 0; i < count; i++) {
+    result.set(u8as[i], offset);
+    offset += u8as[i].length;
+  }
+
+  return result;
+}

package/src/u8a/concatBuffer.ts

@@ -0,0 +1,34 @@
+// Copyright 2017-2025 @pezkuwi/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { U8aLike } from '../types.js';
+
+import { u8aToU8a } from './toU8a.js';
+
+/**
+ * @name u8aConcat
+ * @summary Creates a concatenated Uint8Array from the inputs.
+ * @description
+ * Concatenates the input arrays into a single `UInt8Array`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { { u8aConcat } from '@pezkuwi/util';
+ *
+ * u8aConcat(
+ *   new Uint8Array([1, 2, 3]),
+ *   new Uint8Array([4, 5, 6])
+ * ); // [1, 2, 3, 4, 5, 6]
+ * ```
+ */
+export function u8aConcat (...list: readonly U8aLike[]): Uint8Array {
+  const count = list.length;
+  const u8as = new Array<Uint8Array>(count);
+
+  for (let i = 0; i < count; i++) {
+    u8as[i] = u8aToU8a(list[i]);
+  }
+
+  return Uint8Array.from(Buffer.concat(u8as));
+}

package/src/u8a/empty.spec.ts

@@ -0,0 +1,46 @@
+// Copyright 2017-2025 @pezkuwi/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import { perf } from '../test/index.js';
+import { u8aEmpty } from './index.js';
+
+describe('u8aEmpty', (): void => {
+  it('returns true on zero length', (): void => {
+    expect(
+      u8aEmpty(new Uint8Array())
+    ).toEqual(true);
+  });
+
+  it('returns true on all zero values', (): void => {
+    expect(
+      u8aEmpty(new Uint8Array([0, 0, 0, 0, 0, 0]))
+    ).toEqual(true);
+  });
+
+  it('returns false when value is found', (): void => {
+    expect(
+      u8aEmpty(new Uint8Array([0, 0, 0, 0, 0, 1]))
+    ).toEqual(false);
+  });
+
+  it('returns false when value is found (256)', (): void => {
+    const test = new Uint8Array(256);
+
+    expect(
+      u8aEmpty(test)
+    ).toEqual(true);
+
+    test[128] = 1;
+
+    expect(
+      u8aEmpty(test)
+    ).toEqual(false);
+  });
+
+  perf('u8aEmpty (32 cmp)', 1_000_000, [[new Uint8Array(32)]], u8aEmpty);
+  perf('u8aEmpty (64 cmp)', 500_000, [[new Uint8Array(64)]], u8aEmpty);
+  perf('u8aEmpty (128 cmp)', 250_000, [[new Uint8Array(128)]], u8aEmpty);
+  perf('u8aEmpty (256 cmp)', 125_000, [[new Uint8Array(256)]], u8aEmpty);
+});

package/src/u8a/empty.ts

@@ -0,0 +1,22 @@
+// Copyright 2017-2025 @pezkuwi/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @name u8aEmpty
+ * @summary Tests for a `Uint8Array` for emptyness
+ * @description
+ * Checks to see if the input `Uint8Array` has zero length or contains all 0 values.
+ */
+export function u8aEmpty (value: Uint8Array): boolean {
+  const len = value.length | 0;
+
+  // on smaller sizes, the byte-by-byte compare is faster than allocating
+  // another object for DataView (on very large arrays the DataView is faster)
+  for (let i = 0; i < len; i++) {
+    if (value[i] | 0) {
+      return false;
+    }
+  }
+
+  return true;
+}

package/src/u8a/eq.spec.ts

@@ -0,0 +1,113 @@
+// Copyright 2017-2025 @pezkuwi/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import { perf } from '../test/index.js';
+import { u8aEq } from './index.js';
+
+const ltest = new Uint8Array(32768);
+const stest = new Uint8Array(256);
+const ztest = new Uint8Array(64);
+
+for (let i = 0, count = ltest.length; i < count; i++) {
+  if (i < ztest.length) {
+    ztest[i] = i % 256;
+  }
+
+  if (i < stest.length) {
+    stest[i] = i % 256;
+  }
+
+  ltest[i] = i % 256;
+}
+
+describe('u8aEq', (): void => {
+  it('returns false when the lengths do not match', (): void => {
+    expect(
+      u8aEq(
+        new Uint8Array([1, 2, 3]),
+        new Uint8Array([1, 2])
+      )
+    ).toEqual(false);
+  });
+
+  it('returns false when the contents do not match', (): void => {
+    expect(
+      u8aEq(
+        new Uint8Array([1, 2, 3]),
+        new Uint8Array([1, 2, 4])
+      )
+    ).toEqual(false);
+  });
+
+  it('returns true when the contents do match', (): void => {
+    expect(
+      u8aEq(
+        new Uint8Array([1, 2, 3]),
+        new Uint8Array([1, 2, 3])
+      )
+    ).toEqual(true);
+  });
+
+  it('returns false when the contents do not match (with u32 start)', (): void => {
+    expect(
+      u8aEq(
+        new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3]),
+        new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 4])
+      )
+    ).toEqual(false);
+  });
+
+  it('returns true when the contents do match (with u32 start)', (): void => {
+    expect(
+      u8aEq(
+        new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3]),
+        new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3])
+      )
+    ).toEqual(true);
+  });
+
+  it('returns false when the contents do not match (u32 only)', (): void => {
+    expect(
+      u8aEq(
+        new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]),
+        new Uint8Array([1, 2, 3, 4, 5, 6, 7, 9])
+      )
+    ).toEqual(false);
+  });
+
+  it('returns true when the contents do match (u32 only)', (): void => {
+    expect(
+      u8aEq(
+        new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]),
+        new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8])
+      )
+    ).toEqual(true);
+  });
+
+  it('returns true with equalvalent hex & Uint8array', (): void => {
+    expect(
+      u8aEq(
+        '0x010203',
+        new Uint8Array([1, 2, 3])
+      )
+    ).toEqual(true);
+  });
+
+  it('works on aubarray values', (): void => {
+    const a = new Uint8Array(16);
+
+    for (let i = 0, count = a.length; i < count; i++) {
+      a[i] = i;
+    }
+
+    expect(
+      u8aEq(a.subarray(0, 5), a.subarray(0, 5))
+    ).toEqual(true);
+  });
+
+  perf('u8aEq (64 cmp)', 200_000, [[ztest, ztest]], u8aEq);
+  perf('u8aEq (256 cmp)', 200_000, [[stest, stest]], u8aEq);
+  perf('u8aEq (32k cmp)', 10_000, [[ltest, ltest]], u8aEq);
+});

package/src/u8a/eq.ts

@@ -0,0 +1,46 @@
+// Copyright 2017-2025 @pezkuwi/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { u8aToU8a } from './toU8a.js';
+
+/**
+ * @name u8aEq
+ * @summary Compares two Uint8Arrays for equality.
+ * @description
+ * For `UInt8Array` (or hex string) input values true if there is a match.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aEq } from '@pezkuwi/util';
+ *
+ * u8aEq(new Uint8Array([0x68, 0x65]), new Uint8Array([0x68, 0x65])); // true
+ * ```
+ */
+export function u8aEq (a: string | Uint8Array, b: string | Uint8Array): boolean {
+  const u8aa = u8aToU8a(a);
+  const u8ab = u8aToU8a(b);
+
+  if (u8aa.length === u8ab.length) {
+    const dvA = new DataView(u8aa.buffer, u8aa.byteOffset);
+    const dvB = new DataView(u8ab.buffer, u8ab.byteOffset);
+    const mod = (u8aa.length % 4) | 0;
+    const length = (u8aa.length - mod) | 0;
+
+    for (let i = 0; i < length; i += 4) {
+      if (dvA.getUint32(i) !== dvB.getUint32(i)) {
+        return false;
+      }
+    }
+
+    for (let i = length, count = u8aa.length; i < count; i++) {
+      if (u8aa[i] !== u8ab[i]) {
+        return false;
+      }
+    }
+
+    return true;
+  }
+
+  return false;
+}