@pezkuwi/util 14.0.1

package/src/detectPackage.ts

@@ -0,0 +1,138 @@
+// Copyright 2017-2025 @polkadot/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 `@polkadot/*` 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('@polkadot')) {
+    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

@@ -0,0 +1,21 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@polkadot/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

@@ -0,0 +1,71 @@
+// Copyright 2017-2025 @polkadot/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

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

package/src/float/toU8a.spec.ts

@@ -0,0 +1,52 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@polkadot/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

@@ -0,0 +1,30 @@
+// Copyright 2017-2025 @polkadot/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;
+}

package/src/format/formatBalance.spec.ts

@@ -0,0 +1,296 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@polkadot/dev-test/globals.d.ts" />
+
+import { BN } from '../bn/index.js';
+import { formatBalance } from './index.js';
+
+const FMT_DEFAULTS = {
+  decimals: 0,
+  unit: 'Unit'
+};
+
+describe('formatBalance', (): void => {
+  const TESTVAL = new BN('123456789000');
+
+  // We mess around with the global setDefaults inside some tests,
+  // ensure we restore it to the defaults straight after each run
+  afterEach((): void => {
+    formatBalance.setDefaults(FMT_DEFAULTS);
+  });
+
+  it('returns options for dropdown', (): void => {
+    formatBalance.setDefaults({ decimals: 0, unit: 'TEST' });
+
+    expect(
+      formatBalance.getOptions()
+    ).toEqual([
+      { power: 0, text: 'TEST', value: '-' },
+      { power: 3, text: 'Kilo', value: 'k' },
+      { power: 6, text: 'Mill', value: 'M' },
+      { power: 9, text: 'Bill', value: 'B' },
+      { power: 12, text: 'Tril', value: 'T' },
+      { power: 15, text: 'Peta', value: 'P' },
+      { power: 18, text: 'Exa', value: 'E' },
+      { power: 21, text: 'Zeta', value: 'Z' },
+      { power: 24, text: 'Yotta', value: 'Y' }
+    ]);
+  });
+
+  it('can set defaults from array values', (): void => {
+    formatBalance.setDefaults({ decimals: [12, 24], unit: ['Multi', 'Unit'] });
+
+    expect(
+      formatBalance(TESTVAL)
+    ).toEqual('123.4567 mMulti');
+  });
+
+  describe('SI formatting', (): void => {
+    it('formats empty to 0', (): void => {
+      expect(formatBalance()).toEqual('0');
+      expect(formatBalance('0')).toEqual('0');
+    });
+
+    // this is after an issue/test from actual values with forceUnit
+    it('formats 1000 (BN) (decimals = 12, withAll, withZero = false)', (): void => {
+      expect(
+        formatBalance(new BN(1000), { decimals: 12, forceUnit: '-', withAll: true, withSi: false, withZero: true })
+      ).toEqual('0.000000001000');
+    });
+
+    it('formats 123,456,789,000 (decimals=15)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 15, withSi: true })
+      ).toEqual('123.4567 µUnit');
+    });
+
+    it('formats 123,456 (decimals=0)', (): void => {
+      expect(
+        formatBalance(123456, { decimals: 0, withSi: true })
+      ).toEqual('123.4560 kUnit');
+    });
+
+    it('formats BigInt numbers', (): void => {
+      expect(
+        formatBalance(123456789000n, { decimals: 15, withSi: true })
+      ).toEqual('123.4567 µUnit');
+    });
+
+    it('formats 123,456,789,000 (decimals=15, old style)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 15, withSi: true })
+      ).toEqual('123.4567 µUnit');
+    });
+
+    it('formats 123,456,789,000 (decimals=10, withAll=true)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 10, forceUnit: '-', withAll: true, withSi: true })
+      ).toEqual('12.3456789000 Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=10, withAll=true, withZero=false)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 10, forceUnit: '-', withAll: true, withSi: true, withZero: false })
+      ).toEqual('12.3456789 Unit');
+    });
+
+    it('formats 123,000,000,000 (decimals=9, withAll=true, withZero=false)', (): void => {
+      expect(
+        formatBalance('123000000000', { decimals: 9, forceUnit: '-', withAll: true, withSi: true, withZero: false })
+      ).toEqual('123 Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=15, Compact)', (): void => {
+      const compact = {
+        something: 'else',
+        toBn: (): BN => TESTVAL,
+        unwrap: (): BN => TESTVAL
+      };
+
+      expect(
+        formatBalance(compact, { decimals: 15, withSi: true })
+      ).toEqual('123.4567 µUnit');
+    });
+
+    it('formats 123,456,789,000 (decimals=12)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 12, withSi: true })
+      ).toEqual('123.4567 mUnit');
+    });
+
+    it('formats 123,456,789,000 (decimals=9)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 9, withSi: true })
+      ).toEqual('123.4567 Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=9, no unit)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 9, withSi: true, withUnit: false })
+      ).toEqual('123.4567');
+    });
+
+    it('formats 123,456,789,000 (decimals=9, unit given)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 9, withSi: true, withUnit: 'FOO' })
+      ).toEqual('123.4567 FOO');
+    });
+
+    it('formats 123,456,789,000 (decimals=12, no SI)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 12, withSi: false })
+      ).toEqual('123.4567');
+    });
+
+    it('formats 123,456,789,000 (decimals=12, full SI)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 12, withSiFull: true })
+      ).toEqual('123.4567 milli Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=12, full SI, no unit)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 12, withSiFull: true, withUnit: false })
+      ).toEqual('123.4567 milli');
+    });
+
+    it('formats 123,456,789,000 (decimals=9, full SI)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 9, withSiFull: true })
+      ).toEqual('123.4567 Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=6)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 6, withSi: true })
+      ).toEqual('123.4567 kUnit');
+    });
+
+    it('formats 123,456,789,000 (decimals=6, unit specified)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 6, withSi: true, withUnit: 'BAR' })
+      ).toEqual('123.4567 kBAR');
+    });
+
+    it('formats 123,456,789,000 (decimals=0, unit specified)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 0, withSi: true, withUnit: 'BAR' })
+      ).toEqual('123.4567 BBAR');
+    });
+
+    it('formats 123,456,789,000 * 10 (decimals=12)', (): void => {
+      expect(
+        formatBalance(TESTVAL.muln(10), { decimals: 12, withSi: true })
+      ).toEqual('1.2345 Unit');
+    });
+
+    it('formats 123,456,789,000 * 100 (decimals=12)', (): void => {
+      expect(
+        formatBalance(TESTVAL.muln(100), { decimals: 12, withSi: true })
+      ).toEqual('12.3456 Unit');
+    });
+
+    it('formats 123,456,789,000 * 1000 (decimals=12)', (): void => {
+      expect(
+        formatBalance(TESTVAL.muln(1000), { decimals: 12, withSi: true })
+      ).toEqual('123.4567 Unit');
+    });
+
+    it('formats -123,456,789,000 (decimals=15)', (): void => {
+      expect(
+        formatBalance(new BN('-123456789000'), { decimals: 15, withSi: true })
+      ).toEqual('-123.4567 µUnit');
+    });
+  });
+
+  describe('Forced formatting', (): void => {
+    it('formats 123,456,789,000 (decimals=12, forceUnit=base)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 12, forceUnit: '-' })
+      ).toEqual('0.1234 Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=9, forceUnit=base)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 9, forceUnit: '-' })
+      ).toEqual('123.4567 Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=7, forceUnit=base)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 7, forceUnit: '-' })
+      ).toEqual('12,345.6789 Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=15, forceUnit=micro)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 15, forceUnit: 'µ' })
+      ).toEqual('123.4567 µUnit');
+    });
+
+    it('formats 123,456 (decimals=0, locale=sl)', (): void => {
+      expect(
+        formatBalance(123456, { decimals: 0, locale: 'sl', withSi: true })
+      ).toEqual('123,4560 kUnit');
+    });
+
+    it('formats BigInt numbers (locale=sl)', (): void => {
+      expect(
+        formatBalance(123456789000n, { decimals: 15, locale: 'sl', withSi: true })
+      ).toEqual('123,4567 µUnit');
+    });
+
+    it('formats 123,456,789,000 (decimals=7, forceUnit=base locale=sl)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { decimals: 7, forceUnit: '-', locale: 'sl' })
+      ).toEqual('12.345,6789 Unit');
+    });
+  });
+
+  describe('calcSi', (): void => {
+    it('exposes calcSi on formatBalance', (): void => {
+      expect(
+        formatBalance.calcSi('12345').value
+      ).toEqual('k');
+    });
+  });
+
+  describe('findSi', (): void => {
+    it('finds the SI value', (): void => {
+      expect(
+        formatBalance.findSi('k')
+      ).toEqual({ power: 3, text: 'Kilo', value: 'k' });
+    });
+
+    it('returns default on not found', (): void => {
+      expect(
+        formatBalance.findSi('blah')
+      ).toEqual({ power: 0, text: 'Unit', value: '-' });
+    });
+  });
+
+  describe('defaults', (): void => {
+    it('returns defaults', (): void => {
+      expect(
+        formatBalance.getDefaults()
+      ).toEqual(FMT_DEFAULTS);
+    });
+
+    it('formats 123,456,789,000 (defaultDecimals=12)', (): void => {
+      formatBalance.setDefaults({ decimals: 12 });
+
+      expect(
+        formatBalance(TESTVAL)
+      ).toEqual('123.4567 mUnit');
+    });
+
+    it('formats 123,456,789,000 (defaultUnit=TEST)', (): void => {
+      formatBalance.setDefaults({ decimals: 12, unit: 'TEST' });
+
+      expect(
+        formatBalance(TESTVAL)
+      ).toEqual('123.4567 mTEST');
+    });
+  });
+});