@pezkuwi/util 14.0.6 → 14.0.7

package/src/bi/toBigInt.spec.ts

@@ -1,69 +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 { nToBigInt } from './index.js';
-
-describe('nToBigInt', (): void => {
-  it('converts null values to 0x00', (): void => {
-    expect(
-      nToBigInt(null)
-    ).toEqual(0n);
-  });
-
-  it('converts 0x values to 0x00', (): void => {
-    expect(
-      nToBigInt('0x')
-    ).toEqual(0n);
-  });
-
-  it('converts BN values to bigint', (): void => {
-    expect(
-      nToBigInt(new BN(128))
-    ).toEqual(128n);
-  });
-
-  it('converts BigInt values to bigint', (): void => {
-    expect(
-      nToBigInt(128821n)
-    ).toEqual(128821n);
-  });
-
-  it('converts number values to bigint', (): void => {
-    expect(
-      nToBigInt(128)
-    ).toEqual(128n);
-  });
-
-  it('converts string to bigint', (): void => {
-    expect(
-      nToBigInt('123')
-    ).toEqual(123n);
-  });
-
-  it('converts hex to bigint', (): void => {
-    expect(
-      nToBigInt('0x0123')
-    ).toEqual(0x123n);
-  });
-
-  it('converts Compact to bigint (via toBn)', (): void => {
-    expect(
-      nToBigInt({
-        something: 'test',
-        toBn: () => new BN(1234)
-      })
-    ).toEqual(1234n);
-  });
-
-  it('converts Compact to bigint (via toBigInt)', (): void => {
-    expect(
-      nToBigInt({
-        something: 'test',
-        toBigInt: () => 1234n
-      })
-    ).toEqual(1234n);
-  });
-});

package/src/bi/toBigInt.ts

@@ -1,33 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { BN } from '../bn/bn.js';
-import type { ToBigInt, ToBn } from '../types.js';
-
-import { BigInt } from '@pezkuwi/x-bigint';
-
-import { hexToBigInt } from '../hex/toBigInt.js';
-import { isBn } from '../is/bn.js';
-import { isHex } from '../is/hex.js';
-import { isToBigInt } from '../is/toBigInt.js';
-import { isToBn } from '../is/toBn.js';
-
-/**
- * @name nToBigInt
- * @summary Creates a bigInt value from a BN, bigint, string (base 10 or hex) or number input.
- */
-export function nToBigInt <ExtToBn extends ToBigInt | ToBn> (value?: ExtToBn | BN | bigint | string | number | null): bigint {
-  return typeof value === 'bigint'
-    ? value
-    : !value
-      ? BigInt(0)
-      : isHex(value)
-        ? hexToBigInt(value.toString())
-        : isBn(value)
-          ? BigInt(value.toString())
-          : isToBigInt(value)
-            ? value.toBigInt()
-            : isToBn(value)
-              ? BigInt(value.toBn().toString())
-              : BigInt(value);
-}

package/src/bi/toHex.spec.ts

@@ -1,56 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { nToHex } from './index.js';
-
-describe('nToHex', (): void => {
-  it('converts null values to 0x00', (): void => {
-    expect(
-      nToHex(null)
-    ).toBe('0x00');
-  });
-
-  it('converts null values to 0x00000000 (with bitLength)', (): void => {
-    expect(
-      nToHex(null, { bitLength: 32 })
-    ).toBe('0x00000000');
-  });
-
-  it('converts values to a prefixed hex representation', (): void => {
-    expect(
-      nToHex(128)
-    ).toBe('0x80');
-  });
-
-  it('converts values to a prefixed hex representation (bitLength)', (): void => {
-    expect(
-      nToHex(128n, { bitLength: 16 })
-    ).toBe('0x0080');
-  });
-
-  it('converts values to a prefixed hex representation (bitLength + le)', (): void => {
-    expect(
-      nToHex(128, { bitLength: 16, isLe: true })
-    ).toBe('0x8000');
-  });
-
-  it('converts values to a prefixed hex representation (LE)', (): void => {
-    expect(
-      nToHex(128, { bitLength: 16, isLe: true })
-    ).toBe('0x8000');
-  });
-
-  it('handles negative numbers', (): void => {
-    expect(
-      nToHex(-1234, { isNegative: true })
-    ).toBe('0xfb2e');
-  });
-
-  it('handles negative numbers (with bitLength)', (): void => {
-    expect(
-      nToHex(-1234, { bitLength: 32, isNegative: true })
-    ).toBe('0xfffffb2e');
-  });
-});

package/src/bi/toHex.ts

@@ -1,16 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { BN } from '../bn/bn.js';
-import type { HexString, NumberOptions, ToBigInt, ToBn } from '../types.js';
-
-import { u8aToHex } from '../u8a/index.js';
-import { nToU8a } from './toU8a.js';
-
-/**
- * @name nToHex
- * @summary Creates a hex value from a bigint object.
- */
-export function nToHex <ExtToBn extends ToBn | ToBigInt> (value?: ExtToBn | BN | bigint | number | null, { bitLength = -1, isLe = false, isNegative = false }: NumberOptions = {}): HexString {
-  return u8aToHex(nToU8a(value || 0, { bitLength, isLe, isNegative }));
-}

package/src/bi/toU8a.spec.ts

@@ -1,99 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { arrayRange } from '../array/index.js';
-import { perf } from '../test/index.js';
-import { nToU8a } from './index.js';
-
-// eslint-disable-next-line jest/no-export
-export const TESTS: [isLe: boolean, isNegative: boolean, numarr: number[], strval: string][] = [
-  // LE, positive numbers
-  [true, false, [0x12], '18'],
-  [true, false, [0x12, 0x34], '13330'],
-  [true, false, [0x12, 0x34, 0x56], '5649426'],
-  [true, false, [0x12, 0x34, 0x56, 0x78], '2018915346'],
-  [true, false, [0x12, 0x34, 0x56, 0x78, 0x9a], '663443878930'],
-  [true, false, [0x12, 0x34, 0x56, 0x78, 0x9a, 0xbc], '207371629900818'],
-  [true, false, [0x12, 0x34, 0x56, 0x78, 0x12, 0x34, 0x56, 0x78, 0x12, 0x34, 0x56, 0x78, 0x12, 0x34, 0x56, 0x78], '159954953172672629770948536149615195154'],
-  // LE, positive numbers (w/ signed flag)
-  [true, true, [12], '12'],
-  [true, true, [210, 4], '1234'],
-  [true, true, [64, 226, 1], '123456'],
-  [true, true, [21, 205, 91, 7], '123456789'],
-  [true, true, [203, 36, 104, 12, 8], '34567890123'],
-  [true, true, [255, 159, 114, 78, 24, 9], '9999999999999'],
-  // LE, negative numbers
-  [true, true, [244], '-12'],
-  [true, true, [46, 251], '-1234'],
-  [true, true, [192, 29, 254], '-123456'],
-  [true, true, [255, 255, 255, 255], '-1'],
-  [true, true, [254, 255, 255, 255], '-2'],
-  [true, true, [235, 50, 164, 248], '-123456789'],
-  [true, true, [0, 0, 0, 128], '-2147483648'],
-  [true, true, [0, 0, 0, 240], '-268435456'],
-  [true, true, [65, 86, 129, 173, 254], '-5678999999'],
-  [true, true, [1, 96, 141, 177, 231, 246], '-9999999999999'],
-  [true, true, [1, 0, 156, 88, 76, 73, 31, 242], '-999999999999999999'],
-  // BE
-  [false, false, [0x12], '18'],
-  [false, false, [0x12, 0x34], '4660'],
-  [false, false, [0x12, 0x34, 0x56], '1193046'],
-  [false, false, [0x12, 0x34, 0x56, 0x78], '305419896'],
-  [false, true, [0xf2, 0x34, 0x56, 0x78], '-231451016'],
-  [false, false, [0x12, 0x34, 0x56, 0x78, 0x9a], '78187493530'],
-  [false, false, [0x12, 0x34, 0x56, 0x78, 0x9a, 0xbc], '20015998343868'],
-  [false, false, [0x12, 0x34, 0x56, 0x78, 0x12, 0x34, 0x56, 0x78, 0x12, 0x34, 0x56, 0x78, 0x12, 0x34, 0x56, 0x78], '24197857161011715162171839636988778104']
-];
-
-const ptest = arrayRange(65536).map((v) => [v]);
-
-describe('nToU8a', (): void => {
-  describe('conversion tests', (): void => {
-    TESTS.forEach(([isLe, isNegative, numarr, strval], i): void => {
-      const bitLength = numarr.length * 8;
-
-      it(`#${i}: converts from ${strval} (bitLength=${bitLength}, isLe=${isLe}, isNegative=${isNegative})`, (): void => {
-        expect(
-          nToU8a(
-            BigInt(strval),
-            { bitLength, isLe, isNegative }
-          )
-        ).toEqual(new Uint8Array(numarr));
-      });
-    });
-  });
-
-  it('converts null values to 0x00', (): void => {
-    expect(
-      nToU8a(null)
-    ).toEqual(new Uint8Array(1));
-  });
-
-  it('converts null values to 0x00000000 (bitLength)', (): void => {
-    expect(
-      nToU8a(null, { bitLength: 32 })
-    ).toEqual(new Uint8Array([0, 0, 0, 0]));
-  });
-
-  it('converts values to a prefixed hex representation', (): void => {
-    expect(
-      nToU8a(0x123456n, { isLe: false })
-    ).toEqual(new Uint8Array([0x12, 0x34, 0x56]));
-  });
-
-  it('converts values to a prefixed hex representation (bitLength)', (): void => {
-    expect(
-      nToU8a(0x123456n, { bitLength: 32, isLe: false })
-    ).toEqual(new Uint8Array([0x00, 0x12, 0x34, 0x56]));
-  });
-
-  it('converts using little endian (as set)', (): void => {
-    expect(
-      nToU8a(0x123456n, { bitLength: 32, isLe: true })
-    ).toEqual(new Uint8Array([0x56, 0x34, 0x12, 0x00]));
-  });
-
-  perf('nToU8a', 250000, ptest, nToU8a);
-});

package/src/bi/toU8a.ts

@@ -1,72 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { BN } from '../bn/bn.js';
-import type { NumberOptions, ToBigInt, ToBn } from '../types.js';
-
-import { BigInt } from '@pezkuwi/x-bigint';
-
-import { _0n, _1n } from './consts.js';
-import { nToBigInt } from './toBigInt.js';
-
-const DIV = BigInt(256);
-const NEG_MASK = BigInt(0xff);
-
-function toU8a (value: bigint, isLe: boolean, isNegative: boolean): Uint8Array {
-  const arr: number[] = [];
-  const withSigned = isNegative && (value < _0n);
-
-  if (withSigned) {
-    value = (value + _1n) * -_1n;
-  }
-
-  while (value !== _0n) {
-    const mod = value % DIV;
-    const val = Number(
-      withSigned
-        ? mod ^ NEG_MASK
-        : mod
-    );
-
-    if (isLe) {
-      arr.push(val);
-    } else {
-      arr.unshift(val);
-    }
-
-    value = (value - mod) / DIV;
-  }
-
-  return Uint8Array.from(arr);
-}
-
-/**
- * @name nToU8a
- * @summary Creates a Uint8Array object from a bigint.
- */
-export function nToU8a <ExtToBn extends ToBn | ToBigInt> (value?: ExtToBn | BN | bigint | number | null, { bitLength = -1, isLe = true, isNegative = false }: NumberOptions = {}): Uint8Array {
-  const valueBi = nToBigInt(value);
-
-  if (valueBi === _0n) {
-    return bitLength === -1
-      ? new Uint8Array(1)
-      : new Uint8Array(Math.ceil((bitLength || 0) / 8));
-  }
-
-  const u8a = toU8a(valueBi, isLe, isNegative);
-
-  if (bitLength === -1) {
-    return u8a;
-  }
-
-  const byteLength = Math.ceil((bitLength || 0) / 8);
-  const output = new Uint8Array(byteLength);
-
-  if (isNegative) {
-    output.fill(0xff);
-  }
-
-  output.set(u8a, isLe ? 0 : byteLength - u8a.length);
-
-  return output;
-}

package/src/bn/bn.ts

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

package/src/bn/consts.spec.ts

@@ -1,38 +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, BN_HUNDRED, BN_ONE, BN_TEN, BN_THOUSAND, BN_ZERO } from './index.js';
-
-describe('consts', (): void => {
-  it('BN_ZERO equals 0', (): void => {
-    expect(
-      BN_ZERO
-    ).toEqual(new BN(0));
-  });
-
-  it('BN_ONE equals 1', (): void => {
-    expect(
-      BN_ONE
-    ).toEqual(new BN(1));
-  });
-
-  it('BN_TEN equals 10', (): void => {
-    expect(
-      BN_TEN
-    ).toEqual(new BN(10));
-  });
-
-  it('BN_HUNDRED equals 100', (): void => {
-    expect(
-      BN_HUNDRED
-    ).toEqual(new BN(100));
-  });
-
-  it('BN_THOUSAND equals 1000', (): void => {
-    expect(
-      BN_THOUSAND
-    ).toEqual(new BN(1000));
-  });
-});

package/src/bn/consts.ts

@@ -1,112 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { BN } from './bn.js';
-
-/**
- * @name BN_ZERO
- * @summary BN constant for 0.
- */
-export const BN_ZERO: BN = /*#__PURE__*/ new BN(0);
-
-/**
- * @name BN_ONE
- * @summary BN constant for 1.
- */
-export const BN_ONE: BN = /*#__PURE__*/ new BN(1);
-
-/**
- * @name BN_TWO
- * @summary BN constant for 2.
- */
-export const BN_TWO: BN = /*#__PURE__*/ new BN(2);
-
-/**
- * @name BN_THREE
- * @summary BN constant for 3.
- */
-export const BN_THREE: BN = /*#__PURE__*/ new BN(3);
-
-/**
- * @name BN_FOUR
- * @summary BN constant for 4.
- */
-export const BN_FOUR: BN = /*#__PURE__*/ new BN(4);
-
-/**
- * @name BN_FIVE
- * @summary BN constant for 5.
- */
-export const BN_FIVE: BN = /*#__PURE__*/ new BN(5);
-
-/**
- * @name BN_SIX
- * @summary BN constant for 6.
- */
-export const BN_SIX: BN = /*#__PURE__*/ new BN(6);
-
-/**
- * @name BN_SEVEN
- * @summary BN constant for 7.
- */
-export const BN_SEVEN: BN = /*#__PURE__*/ new BN(7);
-
-/**
- * @name BN_EIGHT
- * @summary BN constant for 8.
- */
-export const BN_EIGHT: BN = /*#__PURE__*/ new BN(8);
-
-/**
- * @name BN_NINE
- * @summary BN constant for 9.
- */
-export const BN_NINE: BN = /*#__PURE__*/ new BN(9);
-
-/**
- * @name BN_TEN
- * @summary BN constant for 10.
- */
-export const BN_TEN: BN = /*#__PURE__*/ new BN(10);
-
-/**
- * @name BN_HUNDRED
- * @summary BN constant for 100.
- */
-export const BN_HUNDRED: BN = /*#__PURE__*/ new BN(100);
-
-/**
- * @name BN_THOUSAND
- * @summary BN constant for 1,000.
- */
-export const BN_THOUSAND: BN = /*#__PURE__*/ new BN(1_000);
-
-/**
- * @name BN_MILLION
- * @summary BN constant for 1,000,000.
- */
-export const BN_MILLION: BN = /*#__PURE__*/ new BN(1_000_000);
-
-/**
- * @name BN_BILLION
- * @summary BN constant for 1,000,000,000.
- */
-export const BN_BILLION: BN = /*#__PURE__*/ new BN(1_000_000_000);
-
-/**
- * @name BN_QUINTILL
- * @summary BN constant for 1,000,000,000,000,000,000.
- */
-export const BN_QUINTILL: BN = BN_BILLION.mul(BN_BILLION);
-
-/**
- * @name BN_MAX_INTEGER
- * @summary BN constant for MAX_SAFE_INTEGER
- */
-export const BN_MAX_INTEGER: BN = /*#__PURE__*/ new BN(Number.MAX_SAFE_INTEGER);
-
-/**
- * @name BN_SQRT_MAX_INTEGER
- * @summary BN constant for Math.sqrt(MAX_SAFE_INTEGER)
- */
-export const BN_SQRT_MAX_INTEGER: BN = /*#__PURE__*/ new BN(94906265);

package/src/bn/fromHex.spec.ts

@@ -1,15 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { isFunction } from '../is/function.js';
-import { bnFromHex } from './index.js';
-
-describe('bnFromHex', (): void => {
-  it('exists as a function', (): void => {
-    expect(
-      isFunction(bnFromHex)
-    ).toEqual(true);
-  });
-});

package/src/bn/fromHex.ts

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

package/src/bn/index.ts

@@ -1,18 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/**
- * @summary Utility methods to convert to and from `BN` objects
- */
-
-// all named
-export { BN } from './bn.js';
-export { bnFromHex } from './fromHex.js';
-export { bnMax, bnMin } from './min.js';
-export { bnSqrt } from './sqrt.js';
-export { bnToBn } from './toBn.js';
-export { bnToHex } from './toHex.js';
-export { bnToU8a } from './toU8a.js';
-
-// all starred
-export * from './consts.js';

package/src/bn/max.spec.ts

@@ -1,32 +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, bnMax } from './index.js';
-
-describe('bnMax', (): void => {
-  it('finds BN maximum (sorted)', (): void => {
-    expect(
-      bnMax(new BN(1), new BN(2), new BN(3))
-    ).toEqual(new BN(3));
-  });
-
-  it('finds BN maximum (unsorted)', (): void => {
-    expect(
-      bnMax(new BN(2), new BN(3), new BN(1))
-    ).toEqual(new BN(3));
-  });
-
-  it('returns a single item', (): void => {
-    expect(
-      bnMax(new BN(1))
-    ).toEqual(new BN(1));
-  });
-
-  it('fails when no items are available', (): void => {
-    expect(
-      () => bnMax()
-    ).toThrow(/Must provide one or more arguments/);
-  });
-});

package/src/bn/min.spec.ts

@@ -1,26 +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, bnMin } from './index.js';
-
-describe('bnMin', (): void => {
-  it('finds BN minimum', (): void => {
-    expect(
-      bnMin(new BN(2), new BN(1), new BN(3))
-    ).toEqual(new BN(1));
-  });
-
-  it('returns a single item', (): void => {
-    expect(
-      bnMin(new BN(1))
-    ).toEqual(new BN(1));
-  });
-
-  it('fails when no items are available', (): void => {
-    expect(
-      () => bnMin()
-    ).toThrow(/Must provide one or more arguments/);
-  });
-});

package/src/bn/min.ts

@@ -1,36 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { BN } from './bn.js';
-
-import { createCmp } from '../bi/helpers.js';
-
-/**
- * @name bnMax
- * @summary Finds and returns the highest value in an array of BNs.
- * @example
- * <BR>
- *
- * ```javascript
- * import BN from 'bn.js';
- * import { bnMax } from '@pezkuwi/util';
- *
- * bnMax([new BN(1), new BN(3), new BN(2)]).toString(); // => '3'
- * ```
- */
-export const bnMax = /*#__PURE__*/ createCmp<BN>((a, b) => a.gt(b));
-
-/**
- * @name bnMin
- * @summary Finds and returns the smallest value in an array of BNs.
- * @example
- * <BR>
- *
- * ```javascript
- * import BN from 'bn.js';
- * import { bnMin } from '@pezkuwi/util';
- *
- * bnMin([new BN(1), new BN(3), new BN(2)]).toString(); // => '1'
- * ```
- */
-export const bnMin = /*#__PURE__*/ createCmp<BN>((a, b) => a.lt(b));

package/src/bn/sqrt.spec.ts

@@ -1,37 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { TESTS } from '../bi/sqrt.spec.js';
-import { BN, BN_SQRT_MAX_INTEGER, bnSqrt } from './index.js';
-
-describe('bnSqrt', (): void => {
-  it('fails on < 0 roots', (): void => {
-    expect(
-      () => bnSqrt(new BN(-1))
-    ).toThrow(/negative numbers is not supported/);
-  });
-
-  it('has the correct constant for sqrt(Number.MAX_SAFE_INTEGER)', (): void => {
-    expect(
-      BN_SQRT_MAX_INTEGER.eq(
-        new BN(
-          ~~Math.sqrt(
-            Number.MAX_SAFE_INTEGER
-          )
-        )
-      )
-    ).toEqual(true);
-  });
-
-  describe('conversion tests', (): void => {
-    TESTS.forEach(([value, expected], i): void => {
-      it(`#${i}: calcs ${expected}`, (): void => {
-        expect(
-          bnSqrt(value).eq(new BN(expected))
-        ).toEqual(true);
-      });
-    });
-  });
-});