@pezkuwi/util 14.0.10 → 14.0.12

package/u8a/toFloat.d.ts

@@ -0,0 +1,11 @@
+interface Options {
+    bitLength?: 32 | 64;
+    isLe?: boolean;
+}
+/**
+ * @name u8aToFloat
+ * @description Converts a Uint8Array value into the float (either 32 or 64-bit)
+ * representation.
+ */
+export declare function u8aToFloat(value: Uint8Array, { bitLength, isLe }?: Options): number;
+export {};

package/u8a/toFloat.js

@@ -0,0 +1,17 @@
+/**
+ * @name u8aToFloat
+ * @description Converts a Uint8Array value into the float (either 32 or 64-bit)
+ * representation.
+ */
+export function u8aToFloat(value, { bitLength = 32, isLe = true } = {}) {
+    if (bitLength !== 32 && bitLength !== 64) {
+        throw new Error('Invalid bitLength provided, expected 32 or 64');
+    }
+    else if (value.length < (bitLength / 8)) {
+        throw new Error(`Invalid input buffer provided, expected at least ${bitLength / 8} bytes, found ${value.length}`);
+    }
+    const dv = new DataView(value.buffer, value.byteOffset);
+    return bitLength === 32
+        ? dv.getFloat32(0, isLe)
+        : dv.getFloat64(0, isLe);
+}

package/u8a/toHex.d.ts

@@ -0,0 +1,16 @@
+import type { HexString } from '../types.js';
+/**
+ * @name u8aToHex
+ * @summary Creates a hex string from a Uint8Array object.
+ * @description
+ * `UInt8Array` input values return the actual hex string. `null` or `undefined` values returns an `0x` string.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aToHex } from '@pezkuwi/util';
+ *
+ * u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f
+ * ```
+ */
+export declare function u8aToHex(value?: Uint8Array | null, bitLength?: number, isPrefixed?: boolean): HexString;

package/u8a/toHex.js

@@ -0,0 +1,53 @@
+const U8 = new Array(256);
+const U16 = new Array(256 * 256);
+for (let n = 0; n < 256; n++) {
+    U8[n] = n.toString(16).padStart(2, '0');
+}
+for (let i = 0; i < 256; i++) {
+    const s = i << 8;
+    for (let j = 0; j < 256; j++) {
+        U16[s | j] = U8[i] + U8[j];
+    }
+}
+/** @internal */
+function hex(value, result) {
+    const mod = (value.length % 2) | 0;
+    const length = (value.length - mod) | 0;
+    for (let i = 0; i < length; i += 2) {
+        result += U16[(value[i] << 8) | value[i + 1]];
+    }
+    if (mod) {
+        result += U8[value[length] | 0];
+    }
+    return result;
+}
+/**
+ * @name u8aToHex
+ * @summary Creates a hex string from a Uint8Array object.
+ * @description
+ * `UInt8Array` input values return the actual hex string. `null` or `undefined` values returns an `0x` string.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aToHex } from '@pezkuwi/util';
+ *
+ * u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f
+ * ```
+ */
+export function u8aToHex(value, bitLength = -1, isPrefixed = true) {
+    // this is not 100% correct sinmce we support isPrefixed = false....
+    const empty = isPrefixed
+        ? '0x'
+        : '';
+    if (!value?.length) {
+        return empty;
+    }
+    else if (bitLength > 0) {
+        const length = Math.ceil(bitLength / 8);
+        if (value.length > length) {
+            return `${hex(value.subarray(0, length / 2), empty)}…${hex(value.subarray(value.length - length / 2), '')}`;
+        }
+    }
+    return hex(value, empty);
+}

package/u8a/toHexBuffer.d.ts

@@ -0,0 +1,16 @@
+import type { HexString } from '../types.js';
+/**
+ * @name u8aToHex
+ * @summary Creates a hex string from a Uint8Array object.
+ * @description
+ * `UInt8Array` input values return the actual hex string. `null` or `undefined` values returns an `0x` string.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aToHex } from '@pezkuwi/util';
+ *
+ * u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f
+ * ```
+ */
+export declare function u8aToHex(value?: Uint8Array | null, bitLength?: number, isPrefixed?: boolean): HexString;

package/u8a/toHexBuffer.js

@@ -0,0 +1,22 @@
+/**
+ * @name u8aToHex
+ * @summary Creates a hex string from a Uint8Array object.
+ * @description
+ * `UInt8Array` input values return the actual hex string. `null` or `undefined` values returns an `0x` string.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aToHex } from '@pezkuwi/util';
+ *
+ * u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f
+ * ```
+ */
+export function u8aToHex(value, bitLength = -1, isPrefixed = true) {
+    const length = Math.ceil(bitLength / 8);
+    return `${isPrefixed ? '0x' : ''}${!value?.length
+        ? ''
+        : (bitLength > 0 && value.length > length)
+            ? `${Buffer.from(value.subarray(0, length / 2)).toString('hex')}…${Buffer.from(value.subarray(value.length - length / 2)).toString('hex')}`
+            : Buffer.from(value).toString('hex')}`;
+}

package/u8a/toNumber.d.ts

@@ -0,0 +1,6 @@
+import type { ToBnOptions } from '../types.js';
+/**
+ * @name u8aToNumber
+ * @summary Creates a number from a Uint8Array object.
+ */
+export declare function u8aToNumber(value: Uint8Array, { isLe, isNegative }?: ToBnOptions): number;

package/u8a/toNumber.js

@@ -0,0 +1,58 @@
+/**
+ * @name u8aToNumber
+ * @summary Creates a number from a Uint8Array object.
+ */
+export function u8aToNumber(value, { isLe = true, isNegative = false } = {}) {
+    // slice + reverse is expensive, however SCALE is LE by default so this is the path
+    // we are most interested in (the BE is added for the sake of being comprehensive)
+    if (!isLe) {
+        value = value.slice().reverse();
+    }
+    const count = value.length;
+    // When the value is a i{8, 16, 24, 32, 40, 40} values and the top-most bit
+    // indicates a signed value, we use a two's complement conversion. If one of these
+    // flags are not set, we just do a normal unsigned conversion (the same shortcut
+    // applies in both the u8aTo{BigInt, Bn} conversions as well)
+    if (isNegative && count && (value[count - 1] & 0x80)) {
+        switch (count) {
+            case 0:
+                return 0;
+            case 1:
+                return (((value[0] ^ 0x0000_00ff) * -1) - 1);
+            case 2:
+                return ((((value[0] + (value[1] << 8)) ^ 0x0000_ffff) * -1) - 1);
+            case 3:
+                return ((((value[0] + (value[1] << 8) + (value[2] << 16)) ^ 0x00ff_ffff) * -1) - 1);
+            case 4:
+                // for the 3rd byte, we don't << 24 - since JS converts all bitwise operators to
+                // 32-bit, in the case where the top-most bit is set this yields a negative value
+                return ((((value[0] + (value[1] << 8) + (value[2] << 16) + (value[3] * 0x1_00_00_00)) ^ 0xffff_ffff) * -1) - 1);
+            case 5:
+                return (((((value[0] + (value[1] << 8) + (value[2] << 16) + (value[3] * 0x1_00_00_00)) ^ 0xffff_ffff) + ((value[4] ^ 0xff) * 0x1_00_00_00_00)) * -1) - 1);
+            case 6:
+                return (((((value[0] + (value[1] << 8) + (value[2] << 16) + (value[3] * 0x1_00_00_00)) ^ 0xffff_ffff) + (((value[4] + (value[5] << 8)) ^ 0x0000_ffff) * 0x1_00_00_00_00)) * -1) - 1);
+            default:
+                throw new Error('Value more than 48-bits cannot be reliably converted');
+        }
+    }
+    switch (count) {
+        case 0:
+            return 0;
+        case 1:
+            return value[0];
+        case 2:
+            return value[0] + (value[1] << 8);
+        case 3:
+            return value[0] + (value[1] << 8) + (value[2] << 16);
+        case 4:
+            // for the 3rd byte, we don't << 24 - since JS converts all bitwise operators to
+            // 32-bit, in the case where the top-most bit is set this yields a negative value
+            return value[0] + (value[1] << 8) + (value[2] << 16) + (value[3] * 0x1_00_00_00);
+        case 5:
+            return value[0] + (value[1] << 8) + (value[2] << 16) + ((value[3] + (value[4] << 8)) * 0x1_00_00_00);
+        case 6:
+            return value[0] + (value[1] << 8) + (value[2] << 16) + ((value[3] + (value[4] << 8) + (value[5] << 16)) * 0x1_00_00_00);
+        default:
+            throw new Error('Value more than 48-bits cannot be reliably converted');
+    }
+}

package/u8a/toString.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @name u8aToString
+ * @summary Creates a utf-8 string from a Uint8Array object.
+ * @description
+ * `UInt8Array` input values return the actual decoded utf-8 string. `null` or `undefined` values returns an empty string.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aToString } from '@pezkuwi/util';
+ *
+ * u8aToString(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f])); // hello
+ * ```
+ */
+export declare function u8aToString(value?: Uint8Array | null): string;

package/u8a/toString.js

@@ -0,0 +1,21 @@
+import { TextDecoder } from '@pezkuwi/x-textdecoder';
+const decoder = new TextDecoder('utf-8');
+/**
+ * @name u8aToString
+ * @summary Creates a utf-8 string from a Uint8Array object.
+ * @description
+ * `UInt8Array` input values return the actual decoded utf-8 string. `null` or `undefined` values returns an empty string.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aToString } from '@pezkuwi/util';
+ *
+ * u8aToString(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f])); // hello
+ * ```
+ */
+export function u8aToString(value) {
+    return value
+        ? decoder.decode(value)
+        : '';
+}

package/u8a/toU8a.d.ts

@@ -0,0 +1,19 @@
+import type { U8aLike } from '../types.js';
+/**
+ * @name u8aToU8a
+ * @summary Creates a Uint8Array value from a Uint8Array, Buffer, string or hex input.
+ * @description
+ * `null` or `undefined` inputs returns a `[]` result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.
+ * If `strict` is true, `null` or `undefined` will throw an error instead of returning an empty array.
+ * Supports input types: Uint8Array, Buffer, hex string, string, or number array.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aToU8a } from '@pezkuwi/util';
+ *
+ * u8aToU8a(new Uint8Array([0x12, 0x34]); // => Uint8Array([0x12, 0x34])
+ * u8aToU8a(0x1234); // => Uint8Array([0x12, 0x34])
+ * ```
+ */
+export declare function u8aToU8a(value?: U8aLike | null, strict?: boolean): Uint8Array;

package/u8a/toU8a.js

@@ -0,0 +1,39 @@
+import { hexToU8a } from '../hex/toU8a.js';
+import { isBuffer } from '../is/buffer.js';
+import { isHex } from '../is/hex.js';
+import { isU8a } from '../is/u8a.js';
+import { stringToU8a } from '../string/toU8a.js';
+/**
+ * @name u8aToU8a
+ * @summary Creates a Uint8Array value from a Uint8Array, Buffer, string or hex input.
+ * @description
+ * `null` or `undefined` inputs returns a `[]` result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.
+ * If `strict` is true, `null` or `undefined` will throw an error instead of returning an empty array.
+ * Supports input types: Uint8Array, Buffer, hex string, string, or number array.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aToU8a } from '@pezkuwi/util';
+ *
+ * u8aToU8a(new Uint8Array([0x12, 0x34]); // => Uint8Array([0x12, 0x34])
+ * u8aToU8a(0x1234); // => Uint8Array([0x12, 0x34])
+ * ```
+ */
+export function u8aToU8a(value, strict = false) {
+    if (strict && (value === null || value === undefined)) {
+        throw new Error('u8aToU8a: Expected non-null, non-undefined value');
+    }
+    return isU8a(value)
+        // NOTE isBuffer needs to go here since it actually extends
+        // Uint8Array on Node.js environments, so all Buffer are Uint8Array,
+        // but Uint8Array is not Buffer
+        ? isBuffer(value)
+            ? new Uint8Array(value)
+            : value
+        : isHex(value)
+            ? hexToU8a(value)
+            : Array.isArray(value)
+                ? new Uint8Array(value)
+                : stringToU8a(value);
+}

package/u8a/wrap.d.ts

@@ -0,0 +1,22 @@
+import type { U8aLike } from '../types.js';
+/** @internal */
+export declare const U8A_WRAP_ETHEREUM: Uint8Array;
+/** @internal */
+export declare const U8A_WRAP_PREFIX: Uint8Array;
+/** @internal */
+export declare const U8A_WRAP_POSTFIX: Uint8Array;
+/** @internal */
+export declare function u8aIsWrapped(u8a: Uint8Array, withEthereum: boolean): boolean;
+/**
+ * @name u8aUnwrapBytes
+ * @description Removes all <Bytes>...</Bytes> wrappers from the supplied value
+ */
+export declare function u8aUnwrapBytes(bytes: U8aLike): Uint8Array;
+/**
+ * @name u8aWrapBytes
+ * @description
+ * Adds a <Bytes>...</Bytes> wrapper to the supplied value, if
+ * - We don't already have a Bytes wrapper
+ * - The message is not an Ethereum-style message
+ */
+export declare function u8aWrapBytes(bytes: U8aLike): Uint8Array;

package/u8a/wrap.js

@@ -0,0 +1,43 @@
+import { u8aConcatStrict } from './concat.js';
+import { u8aEq } from './eq.js';
+import { u8aToU8a } from './toU8a.js';
+/** @internal */
+export const U8A_WRAP_ETHEREUM = /*#__PURE__*/ u8aToU8a('\x19Ethereum Signed Message:\n');
+/** @internal */
+export const U8A_WRAP_PREFIX = /*#__PURE__*/ u8aToU8a('<Bytes>');
+/** @internal */
+export const U8A_WRAP_POSTFIX = /*#__PURE__*/ u8aToU8a('</Bytes>');
+const WRAP_LEN = U8A_WRAP_PREFIX.length + U8A_WRAP_POSTFIX.length;
+/** @internal */
+export function u8aIsWrapped(u8a, withEthereum) {
+    return ((u8a.length >= WRAP_LEN &&
+        u8aEq(u8a.subarray(0, U8A_WRAP_PREFIX.length), U8A_WRAP_PREFIX) &&
+        u8aEq(u8a.slice(-U8A_WRAP_POSTFIX.length), U8A_WRAP_POSTFIX)) ||
+        (withEthereum &&
+            u8a.length >= U8A_WRAP_ETHEREUM.length &&
+            u8aEq(u8a.subarray(0, U8A_WRAP_ETHEREUM.length), U8A_WRAP_ETHEREUM)));
+}
+/**
+ * @name u8aUnwrapBytes
+ * @description Removes all <Bytes>...</Bytes> wrappers from the supplied value
+ */
+export function u8aUnwrapBytes(bytes) {
+    const u8a = u8aToU8a(bytes);
+    // we don't want to unwrap Ethereum-style wraps
+    return u8aIsWrapped(u8a, false)
+        ? u8a.subarray(U8A_WRAP_PREFIX.length, u8a.length - U8A_WRAP_POSTFIX.length)
+        : u8a;
+}
+/**
+ * @name u8aWrapBytes
+ * @description
+ * Adds a <Bytes>...</Bytes> wrapper to the supplied value, if
+ * - We don't already have a Bytes wrapper
+ * - The message is not an Ethereum-style message
+ */
+export function u8aWrapBytes(bytes) {
+    const u8a = u8aToU8a(bytes);
+    return u8aIsWrapped(u8a, true)
+        ? u8a
+        : u8aConcatStrict([U8A_WRAP_PREFIX, u8a, U8A_WRAP_POSTFIX]);
+}