@pezkuwi/util 14.0.23 → 14.0.26

package/src/compact/toU8a.spec.ts

@@ -1,59 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { BN } from '../bn/index.js';
-import { compactToU8a } from './index.js';
-
-const TESTS: [output: string | Uint8Array, input: BN | number][] = [
-  // Rust tests
-  // Copied from https://github.com/paritytech/parity-codec/blob/master/src/codec.rs
-  ['00', new BN('0')],
-  ['fc', new BN('63')],
-  ['01 01', new BN('64')],
-  ['fd ff', new BN('16383')],
-  ['02 00 01 00', new BN('16384')],
-  ['fe ff ff ff', new BN('1073741823')],
-  ['03 00 00 00 40', new BN('1073741824')],
-  ['03 ff ff ff ff', new BN(`${1}${'0'.repeat(32)}`, 2).subn(1)],
-  ['07 00 00 00 00 01', new BN(`${1}${'0'.repeat(32)}`, 2)],
-  ['0b 00 00 00 00 00 01', new BN(`${1}${'0'.repeat(40)}`, 2)],
-  ['0f 00 00 00 00 00 00 01', new BN(`${1}${'0'.repeat(48)}`, 2)],
-  ['0f ff ff ff ff ff ff ff', new BN(`${1}${'0'.repeat(56)}`, 2).subn(1)],
-  ['13 00 00 00 00 00 00 00 01', new BN(`${1}${'0'.repeat(56)}`, 2)],
-  ['13 ff ff ff ff ff ff ff ff', new BN(`${1}${'0'.repeat(64)}`, 2).subn(1)],
-  // own tests
-  [new Uint8Array([18 << 2]), 18],
-  [new Uint8Array([0b11111100]), 63],
-  [new Uint8Array([0xbd, 0x01]), 111],
-  [new Uint8Array([0b11111101, 0b00000111]), 511],
-  [new Uint8Array([253, 127]), 0x1fff],
-  [new Uint8Array([254, 255, 3, 0]), 0xffff],
-  [new Uint8Array([3 + ((4 - 4) << 2), 249, 255, 255, 255]), 0xfffffff9],
-  [new Uint8Array([3 + ((6 - 4) << 2), 0x00, 0x40, 0x7a, 0x10, 0xf3, 0x5a]), new BN('00005af3107a4000', 16)],
-  [new Uint8Array([23, 52, 0x40, 0x7a, 0x10, 0xf3, 0x5a, 0, 0, 18]), new BN('1200005af3107a4034', 16)]
-];
-
-describe('encode', (): void => {
-  it('does not modify the original', (): void => {
-    const original = new BN(123456);
-
-    expect(compactToU8a(original)).toEqual(new Uint8Array([2, 137, 7, 0]));
-    expect(original.toString()).toEqual('123456');
-  });
-
-  describe('conversion tests', (): void => {
-    TESTS.forEach(([output, input], i): void => {
-      it(`#${i}: encodes ${input.toString()}`, (): void => {
-        expect(
-          compactToU8a(input)
-        ).toEqual(
-          output instanceof Uint8Array
-            ? output
-            : Uint8Array.from(output.split(' ').map((s) => parseInt(s, 16)))
-        );
-      });
-    });
-  });
-});

package/src/compact/toU8a.ts

@@ -1,53 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { BN, BN_ONE, BN_TWO, bnToBn, bnToU8a } from '../bn/index.js';
-import { u8aConcatStrict } from '../u8a/index.js';
-
-const MAX_U8 = BN_TWO.pow(new BN(8 - 2)).isub(BN_ONE);
-const MAX_U16 = BN_TWO.pow(new BN(16 - 2)).isub(BN_ONE);
-const MAX_U32 = BN_TWO.pow(new BN(32 - 2)).isub(BN_ONE);
-const BL_16 = { bitLength: 16 };
-const BL_32 = { bitLength: 32 };
-
-/**
- * @name compactToU8a
- * @description Encodes a number into a compact representation
- * @example
- * <BR>
- *
- * ```javascript
- * import { compactToU8a } from '@pezkuwi/util';
- *
- * console.log(compactToU8a(511, 32)); // Uint8Array([0b11111101, 0b00000111])
- * ```
- */
-export function compactToU8a (value: BN | bigint | number): Uint8Array {
-  const bn = bnToBn(value);
-
-  if (bn.lte(MAX_U8)) {
-    return new Uint8Array([bn.toNumber() << 2]);
-  } else if (bn.lte(MAX_U16)) {
-    return bnToU8a(bn.shln(2).iadd(BN_ONE), BL_16);
-  } else if (bn.lte(MAX_U32)) {
-    return bnToU8a(bn.shln(2).iadd(BN_TWO), BL_32);
-  }
-
-  const u8a = bnToU8a(bn);
-  let length = u8a.length;
-
-  // adjust to the minimum number of bytes
-  while (u8a[length - 1] === 0) {
-    length--;
-  }
-
-  if (length < 4) {
-    throw new Error('Invalid length, previous checks match anything less than 2^30');
-  }
-
-  return u8aConcatStrict([
-    // subtract 4 as minimum (also catered for in decoding)
-    new Uint8Array([((length - 4) << 2) + 0b11]),
-    u8a.subarray(0, length)
-  ]);
-}

package/src/compact/types.ts

@@ -1,4 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export type BitLength = 8 | 16 | 32 | 64 | 128 | 256;

package/src/detectPackage.spec.ts

@@ -1,110 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { detectPackage, POLKADOTJS_DISABLE_ESM_CJS_WARNING_FLAG } from './detectPackage.js';
-
-describe('detectPackage', (): void => {
-  const PKG = '@pezkuwi/util';
-  const VER1 = '9.8.0-beta.45';
-  const VER2 = '9.7.1';
-  const VER3 = '9.6.1';
-  const PATH = '/Users/jaco/Projects/polkadot-js/api/node_modules/@pezkuwi/util';
-
-  const MISMATCH = `@pezkuwi/util has multiple versions, ensure that there is only one installed.
-Either remove and explicitly install matching versions or dedupe using your package manager.
-The following conflicting packages were found:
-\tesm ${VER1}\t<unknown>
-\tesm ${VER2}        \tnode_modules/@pezkuwi/api/node_modules/@pezkuwi/util`;
-
-  it('should not log the first time', (): void => {
-    const spy = jest.spyOn(console, 'warn');
-
-    detectPackage({ name: PKG, path: 'auto', type: 'esm', version: VER1 }, PATH);
-    expect(spy).not.toHaveBeenCalled();
-    spy.mockRestore();
-  });
-
-  it('should log the second time', (): void => {
-    const spy = jest.spyOn(console, 'warn');
-
-    detectPackage({ name: PKG, path: '/Users/jaco/Projects/polkadot-js/api/node_modules/@pezkuwi/api/node_modules/@pezkuwi/util', type: 'esm', version: VER2 });
-    expect(spy).toHaveBeenCalledWith(MISMATCH);
-    spy.mockRestore();
-  });
-
-  it('should allow for function use', (): void => {
-    const spy = jest.spyOn(console, 'warn');
-
-    detectPackage({ name: PKG, path: 'node_modules/@pezkuwi/util', type: 'cjs', version: VER3 }, () => PATH);
-    expect(spy).toHaveBeenCalledWith(`${MISMATCH}
-\tcjs ${VER3}        \tnode_modules/@pezkuwi/util`);
-    spy.mockRestore();
-  });
-});
-
-describe('detectPackageDeps', (): void => {
-  const DEP0 = { name: '@pezkuwi/keyring', path: 'auto', type: 'esm', version: '1.1.1' };
-  const DEP1 = { name: '@pezkuwi/util', path: 'auto', type: 'esm', version: '1.1.2' };
-  const DEP2 = { name: '@pezkuwi/util-crypto', path: 'auto', type: 'esm', version: '1.1.3' };
-  const DEP3 = { name: '@pezkuwi/networks', path: 'auto', type: 'esm', version: '1.1.1' };
-
-  it('should not log when no mismatches are found', (): void => {
-    const spy = jest.spyOn(console, 'warn');
-
-    detectPackage({ name: '@pezkuwi/one', path: 'auto', type: 'esm', version: '1.1.1' }, false, [DEP0, DEP3]);
-    expect(spy).not.toHaveBeenCalled();
-    spy.mockRestore();
-  });
-
-  it('should log when mismatches are found', (): void => {
-    const spy = jest.spyOn(console, 'warn');
-
-    detectPackage({ name: '@pezkuwi/two', path: 'auto', type: 'esm', version: '1.1.1' }, false, [DEP0, DEP1, DEP2, DEP3]);
-    expect(spy).toHaveBeenCalledWith(`@pezkuwi/two requires direct dependencies exactly matching version 1.1.1.
-Either remove and explicitly install matching versions or dedupe using your package manager.
-The following conflicting packages were found:
-\t1.1.2\t@pezkuwi/util
-\t1.1.3\t@pezkuwi/util-crypto`);
-    spy.mockRestore();
-  });
-});
-
-describe('detectPackageEsmCjsNoWarnings', (): void => {
-  const PKG = '@pezkuwi/wasm-crypto';
-  const VER1 = '9.8.0-beta.45';
-  const PATH = '/Users/jaco/Projects/polkadot-js/api/node_modules/@pezkuwi/api/node_modules/@pezkuwi/wasm-crypto';
-
-  it('should not log when there are concurrent esm and cjs versions of the same package with the same version number and warnings are disabled', (): void => {
-    const spy = jest.spyOn(console, 'warn');
-    const pkgEsm = { name: PKG, path: PATH, type: 'esm', version: VER1 };
-    const pkgCjs = { name: PKG, path: `${PATH}/cjs`, type: 'cjs', version: VER1 };
-
-    process.env[POLKADOTJS_DISABLE_ESM_CJS_WARNING_FLAG] = '1';
-    detectPackage(pkgEsm, false, []);
-    detectPackage(pkgCjs, false, []);
-
-    expect(spy).not.toHaveBeenCalled();
-    spy.mockRestore();
-  });
-});
-
-describe('detectPackageEsmCjs', (): void => {
-  const PKG = '@pezkuwi/wasm-crypto-wasm';
-  const VER1 = '9.8.0-beta.45';
-  const PATH = '/Users/jaco/Projects/polkadot-js/api/node_modules/@pezkuwi/api/node_modules/@pezkuwi/wasm-crypto-wasm';
-
-  it('should log when there are concurrent esm and cjs versions of the same package with the same version number and warnings are not disabled', (): void => {
-    const spy = jest.spyOn(console, 'warn');
-    const pkgEsm = { name: PKG, path: PATH, type: 'esm', version: VER1 };
-    const pkgCjs = { name: PKG, path: `${PATH}/cjs`, type: 'cjs', version: VER1 };
-
-    process.env[POLKADOTJS_DISABLE_ESM_CJS_WARNING_FLAG] = undefined;
-    detectPackage(pkgEsm, false, []);
-    detectPackage(pkgCjs, false, []);
-
-    expect(spy).toHaveBeenCalled();
-    spy.mockRestore();
-  });
-});

package/src/detectPackage.ts

@@ -1,138 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { xglobal } from '@pezkuwi/x-global';
-
-import { isFunction } from './is/function.js';
-
-type This = typeof globalThis;
-
-interface VersionPath {
-  path: string;
-  type: string;
-  version: string;
-}
-
-interface PackageInfo extends VersionPath {
-  name: string;
-}
-
-interface PjsChecks extends This {
-  __polkadotjs: Record<string, VersionPath[]>;
-}
-
-type PjsGlobal = This & PjsChecks & Record<string, unknown>;
-type FnString = () => string | undefined;
-
-const DEDUPE = 'Either remove and explicitly install matching versions or dedupe using your package manager.\nThe following conflicting packages were found:';
-
-export const POLKADOTJS_DISABLE_ESM_CJS_WARNING_FLAG = 'POLKADOTJS_DISABLE_ESM_CJS_WARNING';
-
-/** @internal */
-function getEntry (name: string): VersionPath[] {
-  const _global = xglobal as PjsGlobal;
-
-  if (!_global.__polkadotjs) {
-    _global.__polkadotjs = {};
-  }
-
-  if (!_global.__polkadotjs[name]) {
-    _global.__polkadotjs[name] = [];
-  }
-
-  return _global.__polkadotjs[name];
-}
-
-/** @internal */
-function formatDisplay <T extends { version: string }> (all: T[], fmt: (version: string, data: T) => string[]): string {
-  let max = 0;
-
-  for (let i = 0, count = all.length; i < count; i++) {
-    max = Math.max(max, all[i].version.length);
-  }
-
-  return all
-    .map((d) => `\t${fmt(d.version.padEnd(max), d).join('\t')}`)
-    .join('\n');
-}
-
-/** @internal */
-function formatInfo (version: string, { name }: PackageInfo): string[] {
-  return [
-    version,
-    name
-  ];
-}
-
-/** @internal */
-function formatVersion (version: string, { path, type }: VersionPath): string[] {
-  let extracted: string;
-
-  if (path && path.length >= 5) {
-    const nmIndex = path.indexOf('node_modules');
-
-    extracted = nmIndex === -1
-      ? path
-      : path.substring(nmIndex);
-  } else {
-    extracted = '<unknown>';
-  }
-
-  return [
-    `${`${type || ''}`.padStart(3)} ${version}`,
-    extracted
-  ];
-}
-
-/** @internal */
-function getPath (infoPath?: string, pathOrFn?: FnString | string | false | null): string {
-  if (infoPath) {
-    return infoPath;
-  } else if (isFunction(pathOrFn)) {
-    try {
-      return pathOrFn() || '';
-    } catch {
-      return '';
-    }
-  }
-
-  return pathOrFn || '';
-}
-
-/** @internal */
-function warn <T extends { version: string }> (pre: string, all: T[], fmt: (version: string, data: T) => string[]): void {
-  console.warn(`${pre}\n${DEDUPE}\n${formatDisplay(all, fmt)}`);
-}
-
-/**
- * @name detectPackage
- * @summary Checks that a specific package is only imported once
- * @description A `@pezkuwi/*` version detection utility, checking for one occurrence of a package in addition to checking for dependency versions.
- */
-export function detectPackage ({ name, path, type, version }: PackageInfo, pathOrFn?: FnString | string | false | null, deps: PackageInfo[] = []): void {
-  if (!name.startsWith('@pezkuwi')) {
-    throw new Error(`Invalid package descriptor ${name}`);
-  }
-
-  const entry = getEntry(name);
-
-  entry.push({ path: getPath(path, pathOrFn), type, version });
-
-  // if we have more than one entry at DIFFERENT version types then warn. If there is
-  // more than one entry at the same version and ESM/CJS dual warnings are disabled,
-  // then do not display warnings
-  const entriesSameVersion = entry.every((e) => e.version === version);
-  const esmCjsWarningDisabled = xglobal.process?.env?.[POLKADOTJS_DISABLE_ESM_CJS_WARNING_FLAG] === '1';
-  const multipleEntries = entry.length !== 1;
-  const disableWarnings = esmCjsWarningDisabled && entriesSameVersion;
-
-  if (multipleEntries && !disableWarnings) {
-    warn(`${name} has multiple versions, ensure that there is only one installed.`, entry, formatVersion);
-  } else {
-    const mismatches = deps.filter((d) => d && d.version !== version);
-
-    if (mismatches.length) {
-      warn(`${name} requires direct dependencies exactly matching version ${version}.`, mismatches, formatInfo);
-    }
-  }
-}

package/src/extractTime.spec.ts

@@ -1,21 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { extractTime } from './index.js';
-
-describe('extractTime', (): void => {
-  const milliseconds = 1e9 + 123;
-
-  it('extracts time components correctly', (): void => {
-    expect(extractTime(milliseconds))
-      .toEqual({
-        days: 11,
-        hours: 13,
-        milliseconds: 123,
-        minutes: 46,
-        seconds: 40
-      });
-  });
-});

package/src/extractTime.ts

@@ -1,71 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Time } from './types.js';
-
-const MIN_MS = 60 * 1000;
-const HR_MS = MIN_MS * 60;
-const DAY_MS = HR_MS * 24;
-const ZERO: Time = { days: 0, hours: 0, milliseconds: 0, minutes: 0, seconds: 0 };
-
-/** @internal */
-function add (a: Partial<Time>, b: Time): Time {
-  return {
-    days: (a.days || 0) + b.days,
-    hours: (a.hours || 0) + b.hours,
-    milliseconds: (a.milliseconds || 0) + b.milliseconds,
-    minutes: (a.minutes || 0) + b.minutes,
-    seconds: (a.seconds || 0) + b.seconds
-  };
-}
-
-/** @internal */
-function extractSecs (ms: number): Time {
-  const s = ms / 1000;
-
-  if (s < 60) {
-    const seconds = ~~s;
-
-    return add({ seconds }, extractTime(ms - (seconds * 1000)));
-  }
-
-  const m = s / 60;
-
-  if (m < 60) {
-    const minutes = ~~m;
-
-    return add({ minutes }, extractTime(ms - (minutes * MIN_MS)));
-  }
-
-  const h = m / 60;
-
-  if (h < 24) {
-    const hours = ~~h;
-
-    return add({ hours }, extractTime(ms - (hours * HR_MS)));
-  }
-
-  const days = ~~(h / 24);
-
-  return add({ days }, extractTime(ms - (days * DAY_MS)));
-}
-
-/**
- * @name extractTime
- * @summary Convert a quantity of seconds to Time array representing accumulated {days, minutes, hours, seconds, milliseconds}
- * @example
- * <BR>
- *
- * ```javascript
- * import { extractTime } from '@pezkuwi/util';
- *
- * const { days, minutes, hours, seconds, milliseconds } = extractTime(6000); // 0, 0, 10, 0, 0
- * ```
- */
-export function extractTime (milliseconds?: number): Time {
-  return !milliseconds
-    ? ZERO
-    : milliseconds < 1000
-      ? add({ milliseconds }, ZERO)
-      : extractSecs(milliseconds);
-}

package/src/float/index.ts

@@ -1,4 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export { floatToU8a } from './toU8a.js';

package/src/float/toU8a.spec.ts

@@ -1,52 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { u8aToHex } from '../u8a/index.js';
-import { floatToU8a } from './index.js';
-
-class ExtNumber extends Number {
-  foo = 'bar';
-}
-
-class ExtString extends String {
-  foo = 'bar';
-}
-
-// NOTE Hex value outputs created via online conversion tool:
-// https://www.h-schmidt.net/FloatConverter/IEEE754.html
-// eslint-disable-next-line @typescript-eslint/ban-types
-const TESTS: [isLe: boolean | undefined, bitLength: 32 | 64 | undefined, input: String | string | number | Number, output: string][] = [
-  [undefined, undefined, +0.0, '0x00000000'],
-  [undefined, undefined, -0.0, '0x00000080'],
-  [undefined, undefined, 123.456, '0x79e9f642'],
-  [undefined, undefined, '123.456', '0x79e9f642'],
-  [undefined, undefined, new ExtNumber(123.456), '0x79e9f642'],
-  [undefined, undefined, new ExtString(123.456), '0x79e9f642'],
-  [true, 32, new ExtString(123.456), '0x79e9f642'],
-  [true, undefined, Number.NaN, '0x0000c07f'],
-  [false, undefined, -0.0, '0x80000000'],
-  [undefined, 64, +0.0, '0x0000000000000000'],
-  [true, 64, -0.0, '0x0000000000000080'],
-  [false, 64, -0.0, '0x8000000000000000'],
-  [undefined, 64, Number.NaN, '0x000000000000f87f']
-];
-
-describe('floatToU8a', (): void => {
-  it('throws on invalid bitLength', (): void => {
-    expect(
-      () => floatToU8a(123, { bitLength: 48 as 32 })
-    ).toThrow();
-  });
-
-  describe('conversion tests', (): void => {
-    TESTS.forEach(([isLe, bitLength, input, output], i): void => {
-      it(`#${i}: correctly encodes ${typeof input === 'number' ? input : input.toString()} (typeof=${typeof input})`, (): void => {
-        expect(
-          u8aToHex(floatToU8a(input, { bitLength, isLe }))
-        ).toEqual(output);
-      });
-    });
-  });
-});

package/src/float/toU8a.ts

@@ -1,30 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-interface Options {
-  bitLength?: 32 | 64;
-  isLe?: boolean;
-}
-
-/**
- * @name floatToU8a
- * @description Converts a float into a U8a representation (While we don't use BE in SCALE
- * we still allow for either representation, although, as elsewhere, isLe is default)
- */
-// eslint-disable-next-line @typescript-eslint/ban-types
-export function floatToU8a (value: String | string | number | Number = 0.0, { bitLength = 32, isLe = true }: Options = {}): Uint8Array {
-  if (bitLength !== 32 && bitLength !== 64) {
-    throw new Error('Invalid bitLength provided, expected 32 or 64');
-  }
-
-  const result = new Uint8Array(bitLength / 8);
-  const dv = new DataView(result.buffer, result.byteOffset);
-
-  if (bitLength === 32) {
-    dv.setFloat32(0, Number(value), isLe);
-  } else {
-    dv.setFloat64(0, Number(value), isLe);
-  }
-
-  return result;
-}