@pezkuwi/util-crypto 14.0.2 → 14.0.4

package/cjs/base32/bs32.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.base32Encode = exports.base32Decode = exports.isBase32 = exports.base32Validate = void 0;
+const base_1 = require("@scure/base");
+const helpers_js_1 = require("./helpers.js");
+const chars = 'abcdefghijklmnopqrstuvwxyz234567';
+const config = {
+    chars,
+    coder: base_1.utils.chain(
+    // We define our own chain, the default base32 has padding
+    base_1.utils.radix2(5), base_1.utils.alphabet(chars), {
+        decode: (input) => input.split(''),
+        encode: (input) => input.join('')
+    }),
+    ipfs: 'b',
+    type: 'base32'
+};
+/**
+ * @name base32Validate
+ * @summary Validates a base32 value.
+ * @description
+ * Validates that the supplied value is valid base32, throwing exceptions if not
+ */
+exports.base32Validate = (0, helpers_js_1.createValidate)(config);
+/**
+* @name isBase32
+* @description Checks if the input is in base32, returning true/false
+*/
+exports.isBase32 = (0, helpers_js_1.createIs)(exports.base32Validate);
+/**
+ * @name base32Decode
+ * @summary Delookup a base32 value.
+ * @description
+ * From the provided input, decode the base32 and return the result as an `Uint8Array`.
+ */
+exports.base32Decode = (0, helpers_js_1.createDecode)(config, exports.base32Validate);
+/**
+* @name base32Encode
+* @summary Creates a base32 value.
+* @description
+* From the provided input, create the base32 and return the result as a string.
+*/
+exports.base32Encode = (0, helpers_js_1.createEncode)(config);

package/cjs/base32/helpers.d.ts

@@ -0,0 +1,25 @@
+import type { U8aLike } from '@polkadot/util/types';
+export type { U8aLike } from '@polkadot/util/types';
+interface Coder {
+    decode: (value: string) => Uint8Array;
+    encode: (value: Uint8Array) => string;
+}
+interface Config {
+    chars: string;
+    coder: Coder;
+    ipfs?: string;
+    regex?: RegExp;
+    type: string;
+    withPadding?: boolean;
+}
+type DecodeFn = (value: string, ipfsCompat?: boolean) => Uint8Array;
+type EncodeFn = (value: U8aLike, ipfsCompat?: boolean) => string;
+type ValidateFn = (value?: unknown, ipfsCompat?: boolean) => value is string;
+/** @internal */
+export declare function createDecode({ coder, ipfs }: Config, validate: ValidateFn): DecodeFn;
+/** @internal */
+export declare function createEncode({ coder, ipfs }: Config): EncodeFn;
+/** @internal */
+export declare function createIs(validate: ValidateFn): ValidateFn;
+/** @internal */
+export declare function createValidate({ chars, ipfs, type, withPadding }: Config): ValidateFn;

package/cjs/base32/helpers.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDecode = createDecode;
+exports.createEncode = createEncode;
+exports.createIs = createIs;
+exports.createValidate = createValidate;
+const util_1 = require("@pezkuwi/util");
+/** @internal */
+function createDecode({ coder, ipfs }, validate) {
+    return (value, ipfsCompat) => {
+        validate(value, ipfsCompat);
+        return coder.decode(ipfs && ipfsCompat
+            ? value.substring(1)
+            : value);
+    };
+}
+/** @internal */
+function createEncode({ coder, ipfs }) {
+    return (value, ipfsCompat) => {
+        const out = coder.encode((0, util_1.u8aToU8a)(value));
+        return ipfs && ipfsCompat
+            ? `${ipfs}${out}`
+            : out;
+    };
+}
+/** @internal */
+function createIs(validate) {
+    return (value, ipfsCompat) => {
+        try {
+            return validate(value, ipfsCompat);
+        }
+        catch {
+            return false;
+        }
+    };
+}
+/** @internal */
+function createValidate({ chars, ipfs, type, withPadding }) {
+    return (value, ipfsCompat) => {
+        if (typeof value !== 'string') {
+            throw new Error(`Expected ${type} string input`);
+        }
+        else if (ipfs && ipfsCompat && !value.startsWith(ipfs)) {
+            throw new Error(`Expected ipfs-compatible ${type} to start with '${ipfs}'`);
+        }
+        for (let i = (ipfsCompat ? 1 : 0), count = value.length; i < count; i++) {
+            if (chars.includes(value[i])) {
+                // all ok, character found
+            }
+            else if (withPadding && value[i] === '=') {
+                if (i === count - 1) {
+                    // last character, everything ok
+                }
+                else if (value[i + 1] === '=') {
+                    // next one is also padding, sequence ok
+                }
+                else {
+                    throw new Error(`Invalid ${type} padding sequence "${value[i]}${value[i + 1]}" at index ${i}`);
+                }
+            }
+            else {
+                throw new Error(`Invalid ${type} character "${value[i]}" (0x${value.charCodeAt(i).toString(16)}) at index ${i}`);
+            }
+        }
+        return true;
+    };
+}

package/cjs/base32/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @summary Encode and decode base32 values
+ */
+export { base32Decode, base32Encode, base32Validate, isBase32 } from './bs32.js';

package/cjs/base32/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBase32 = exports.base32Validate = exports.base32Encode = exports.base32Decode = void 0;
+/**
+ * @summary Encode and decode base32 values
+ */
+var bs32_js_1 = require("./bs32.js");
+Object.defineProperty(exports, "base32Decode", { enumerable: true, get: function () { return bs32_js_1.base32Decode; } });
+Object.defineProperty(exports, "base32Encode", { enumerable: true, get: function () { return bs32_js_1.base32Encode; } });
+Object.defineProperty(exports, "base32Validate", { enumerable: true, get: function () { return bs32_js_1.base32Validate; } });
+Object.defineProperty(exports, "isBase32", { enumerable: true, get: function () { return bs32_js_1.isBase32; } });

package/cjs/base58/bs58.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name base58Validate
+ * @summary Validates a base58 value.
+ * @description
+ * Validates that the supplied value is valid base58, throwing exceptions if not
+ */
+export declare const base58Validate: (value?: unknown, ipfsCompat?: boolean) => value is string;
+/**
+ * @name base58Decode
+ * @summary Decodes a base58 value.
+ * @description
+ * From the provided input, decode the base58 and return the result as an `Uint8Array`.
+ */
+export declare const base58Decode: (value: string, ipfsCompat?: boolean) => Uint8Array;
+/**
+* @name base58Encode
+* @summary Creates a base58 value.
+* @description
+* From the provided input, create the base58 and return the result as a string.
+*/
+export declare const base58Encode: (value: import("@polkadot/util/types").U8aLike, ipfsCompat?: boolean) => string;
+/**
+* @name isBase58
+* @description Checks if the input is in base58, returning true/false
+*/
+export declare const isBase58: (value?: unknown, ipfsCompat?: boolean) => value is string;

package/cjs/base58/bs58.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBase58 = exports.base58Encode = exports.base58Decode = exports.base58Validate = void 0;
+const base_1 = require("@scure/base");
+const helpers_js_1 = require("../base32/helpers.js");
+const config = {
+    chars: '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz',
+    coder: base_1.base58,
+    ipfs: 'z',
+    type: 'base58'
+};
+/**
+ * @name base58Validate
+ * @summary Validates a base58 value.
+ * @description
+ * Validates that the supplied value is valid base58, throwing exceptions if not
+ */
+exports.base58Validate = (0, helpers_js_1.createValidate)(config);
+/**
+ * @name base58Decode
+ * @summary Decodes a base58 value.
+ * @description
+ * From the provided input, decode the base58 and return the result as an `Uint8Array`.
+ */
+exports.base58Decode = (0, helpers_js_1.createDecode)(config, exports.base58Validate);
+/**
+* @name base58Encode
+* @summary Creates a base58 value.
+* @description
+* From the provided input, create the base58 and return the result as a string.
+*/
+exports.base58Encode = (0, helpers_js_1.createEncode)(config);
+/**
+* @name isBase58
+* @description Checks if the input is in base58, returning true/false
+*/
+exports.isBase58 = (0, helpers_js_1.createIs)(exports.base58Validate);

package/cjs/base58/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @summary Encode and decode base58 values
+ */
+export { base58Decode, base58Encode, base58Validate, isBase58 } from './bs58.js';

package/cjs/base58/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBase58 = exports.base58Validate = exports.base58Encode = exports.base58Decode = void 0;
+/**
+ * @summary Encode and decode base58 values
+ */
+var bs58_js_1 = require("./bs58.js");
+Object.defineProperty(exports, "base58Decode", { enumerable: true, get: function () { return bs58_js_1.base58Decode; } });
+Object.defineProperty(exports, "base58Encode", { enumerable: true, get: function () { return bs58_js_1.base58Encode; } });
+Object.defineProperty(exports, "base58Validate", { enumerable: true, get: function () { return bs58_js_1.base58Validate; } });
+Object.defineProperty(exports, "isBase58", { enumerable: true, get: function () { return bs58_js_1.isBase58; } });

package/cjs/base64/bs64.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name base64Validate
+ * @summary Validates a base64 value.
+ * @description
+ * Validates that the supplied value is valid base64
+ */
+export declare const base64Validate: (value?: unknown, ipfsCompat?: boolean) => value is string;
+/**
+ * @name isBase64
+ * @description Checks if the input is in base64, returning true/false
+ */
+export declare const isBase64: (value?: unknown, ipfsCompat?: boolean) => value is string;
+/**
+ * @name base64Decode
+ * @summary Decodes a base64 value.
+ * @description
+ * From the provided input, decode the base64 and return the result as an `Uint8Array`.
+ */
+export declare const base64Decode: (value: string, ipfsCompat?: boolean) => Uint8Array;
+/**
+ * @name base64Encode
+ * @summary Creates a base64 value.
+ * @description
+ * From the provided input, create the base64 and return the result as a string.
+ */
+export declare const base64Encode: (value: import("@polkadot/util/types").U8aLike, ipfsCompat?: boolean) => string;

package/cjs/base64/bs64.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.base64Encode = exports.base64Decode = exports.isBase64 = exports.base64Validate = void 0;
+const base_1 = require("@scure/base");
+const helpers_js_1 = require("../base32/helpers.js");
+const config = {
+    chars: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/',
+    coder: base_1.base64,
+    type: 'base64',
+    withPadding: true
+};
+/**
+ * @name base64Validate
+ * @summary Validates a base64 value.
+ * @description
+ * Validates that the supplied value is valid base64
+ */
+exports.base64Validate = (0, helpers_js_1.createValidate)(config);
+/**
+ * @name isBase64
+ * @description Checks if the input is in base64, returning true/false
+ */
+exports.isBase64 = (0, helpers_js_1.createIs)(exports.base64Validate);
+/**
+ * @name base64Decode
+ * @summary Decodes a base64 value.
+ * @description
+ * From the provided input, decode the base64 and return the result as an `Uint8Array`.
+ */
+exports.base64Decode = (0, helpers_js_1.createDecode)(config, exports.base64Validate);
+/**
+ * @name base64Encode
+ * @summary Creates a base64 value.
+ * @description
+ * From the provided input, create the base64 and return the result as a string.
+ */
+exports.base64Encode = (0, helpers_js_1.createEncode)(config);

package/cjs/base64/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @summary Encode and decode base64 values
+ */
+export { base64Decode, base64Encode, base64Validate, isBase64 } from './bs64.js';
+export { base64Pad } from './pad.js';
+export { base64Trim } from './trim.js';

package/cjs/base64/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.base64Trim = exports.base64Pad = exports.isBase64 = exports.base64Validate = exports.base64Encode = exports.base64Decode = void 0;
+/**
+ * @summary Encode and decode base64 values
+ */
+var bs64_js_1 = require("./bs64.js");
+Object.defineProperty(exports, "base64Decode", { enumerable: true, get: function () { return bs64_js_1.base64Decode; } });
+Object.defineProperty(exports, "base64Encode", { enumerable: true, get: function () { return bs64_js_1.base64Encode; } });
+Object.defineProperty(exports, "base64Validate", { enumerable: true, get: function () { return bs64_js_1.base64Validate; } });
+Object.defineProperty(exports, "isBase64", { enumerable: true, get: function () { return bs64_js_1.isBase64; } });
+var pad_js_1 = require("./pad.js");
+Object.defineProperty(exports, "base64Pad", { enumerable: true, get: function () { return pad_js_1.base64Pad; } });
+var trim_js_1 = require("./trim.js");
+Object.defineProperty(exports, "base64Trim", { enumerable: true, get: function () { return trim_js_1.base64Trim; } });

package/cjs/base64/pad.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @name base64Pad
+ * @description Adds padding characters for correct length
+ */
+export declare function base64Pad(value: string): string;

package/cjs/base64/pad.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.base64Pad = base64Pad;
+/**
+ * @name base64Pad
+ * @description Adds padding characters for correct length
+ */
+function base64Pad(value) {
+    return value.padEnd(value.length + (value.length % 4), '=');
+}

package/cjs/base64/trim.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @name base64Trim
+ * @description Trims padding characters
+ */
+export declare function base64Trim(value: string): string;

package/cjs/base64/trim.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.base64Trim = base64Trim;
+/**
+ * @name base64Trim
+ * @description Trims padding characters
+ */
+function base64Trim(value) {
+    while (value.length && value.endsWith('=')) {
+        value = value.slice(0, -1);
+    }
+    return value;
+}

package/cjs/blake2/asU8a.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @name blake2AsU8a
+ * @summary Creates a blake2b u8a from the input.
+ * @description
+ * From a `Uint8Array` input, create the blake2b and return the result as a u8a with the specified `bitLength`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { blake2AsU8a } from '@polkadot/util-crypto';
+ *
+ * blake2AsU8a('abc'); // => [0xba, 0x80, 0xa5, 0x3f, 0x98, 0x1c, 0x4d, 0x0d]
+ * ```
+ */
+export declare function blake2AsU8a(data: string | Uint8Array, bitLength?: 64 | 128 | 256 | 384 | 512, key?: Uint8Array | null, onlyJs?: boolean): Uint8Array;
+/**
+ * @name blake2AsHex
+ * @description Creates a blake2b hex from the input.
+ */
+export declare const blake2AsHex: (data: string | Uint8Array, bitLength?: 256 | 512 | 64 | 128 | 384 | undefined, key?: Uint8Array | null | undefined, onlyJs?: boolean | undefined) => import("@polkadot/util/types").HexString;

package/cjs/blake2/asU8a.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.blake2AsHex = void 0;
+exports.blake2AsU8a = blake2AsU8a;
+const blake2b_1 = require("@noble/hashes/blake2b");
+const util_1 = require("@pezkuwi/util");
+const wasm_crypto_1 = require("@pezkuwi/wasm-crypto");
+const helpers_js_1 = require("../helpers.js");
+/**
+ * @name blake2AsU8a
+ * @summary Creates a blake2b u8a from the input.
+ * @description
+ * From a `Uint8Array` input, create the blake2b and return the result as a u8a with the specified `bitLength`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { blake2AsU8a } from '@pezkuwi/util-crypto';
+ *
+ * blake2AsU8a('abc'); // => [0xba, 0x80, 0xa5, 0x3f, 0x98, 0x1c, 0x4d, 0x0d]
+ * ```
+ */
+function blake2AsU8a(data, bitLength = 256, key, onlyJs) {
+    const byteLength = Math.ceil(bitLength / 8);
+    const u8a = (0, util_1.u8aToU8a)(data);
+    return !util_1.hasBigInt || (!onlyJs && (0, wasm_crypto_1.isReady)())
+        ? (0, wasm_crypto_1.blake2b)(u8a, (0, util_1.u8aToU8a)(key), byteLength)
+        : key
+            ? (0, blake2b_1.blake2b)(u8a, { dkLen: byteLength, key })
+            : (0, blake2b_1.blake2b)(u8a, { dkLen: byteLength });
+}
+/**
+ * @name blake2AsHex
+ * @description Creates a blake2b hex from the input.
+ */
+exports.blake2AsHex = (0, helpers_js_1.createAsHex)(blake2AsU8a);

package/cjs/blake2/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @summary Create blake2b values with specified bitlengths
+ */
+export { blake2AsHex, blake2AsU8a } from './asU8a.js';

package/cjs/blake2/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.blake2AsU8a = exports.blake2AsHex = void 0;
+/**
+ * @summary Create blake2b values with specified bitlengths
+ */
+var asU8a_js_1 = require("./asU8a.js");
+Object.defineProperty(exports, "blake2AsHex", { enumerable: true, get: function () { return asU8a_js_1.blake2AsHex; } });
+Object.defineProperty(exports, "blake2AsU8a", { enumerable: true, get: function () { return asU8a_js_1.blake2AsU8a; } });

package/cjs/bn.d.ts

@@ -0,0 +1,30 @@
+export declare const BN_BE_OPTS: {
+    isLe: boolean;
+};
+export declare const BN_LE_OPTS: {
+    isLe: boolean;
+};
+export declare const BN_LE_16_OPTS: {
+    bitLength: number;
+    isLe: boolean;
+};
+export declare const BN_BE_32_OPTS: {
+    bitLength: number;
+    isLe: boolean;
+};
+export declare const BN_LE_32_OPTS: {
+    bitLength: number;
+    isLe: boolean;
+};
+export declare const BN_BE_256_OPTS: {
+    bitLength: number;
+    isLe: boolean;
+};
+export declare const BN_LE_256_OPTS: {
+    bitLength: number;
+    isLe: boolean;
+};
+export declare const BN_LE_512_OPTS: {
+    bitLength: number;
+    isLe: boolean;
+};

package/cjs/bn.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BN_LE_512_OPTS = exports.BN_LE_256_OPTS = exports.BN_BE_256_OPTS = exports.BN_LE_32_OPTS = exports.BN_BE_32_OPTS = exports.BN_LE_16_OPTS = exports.BN_LE_OPTS = exports.BN_BE_OPTS = void 0;
+exports.BN_BE_OPTS = { isLe: false };
+exports.BN_LE_OPTS = { isLe: true };
+exports.BN_LE_16_OPTS = { bitLength: 16, isLe: true };
+exports.BN_BE_32_OPTS = { bitLength: 32, isLe: false };
+exports.BN_LE_32_OPTS = { bitLength: 32, isLe: true };
+exports.BN_BE_256_OPTS = { bitLength: 256, isLe: false };
+exports.BN_LE_256_OPTS = { bitLength: 256, isLe: true };
+exports.BN_LE_512_OPTS = { bitLength: 512, isLe: true };

package/cjs/bridge.d.ts

@@ -0,0 +1,82 @@
+import type { BridgeBase, InitFn, WasmBaseInstance } from './types.js';
+/**
+ * @name Bridge
+ * @description
+ * Creates a bridge between the JS and WASM environments.
+ *
+ * For any bridge it is passed an function which is then called internally at the
+ * time of initialization. This affectively implements the layer between WASM and
+ * the native environment, providing all the plumbing needed for the Wbg classes.
+ */
+export declare class Bridge<C extends WasmBaseInstance> implements BridgeBase<C> {
+    #private;
+    constructor(createWasm: InitFn<C>);
+    /** @description Returns the init error */
+    get error(): string | null;
+    /** @description Returns the init type */
+    get type(): 'asm' | 'wasm' | 'none';
+    /** @description Returns the created wasm interface */
+    get wasm(): C | null;
+    /** @description Performs the wasm initialization */
+    init(createWasm?: InitFn<C>): Promise<C | null>;
+    /**
+     * @internal
+     * @description Gets an object from the heap
+     */
+    getObject(idx: number): unknown;
+    /**
+     * @internal
+     * @description Removes an object from the heap
+     */
+    dropObject(idx: number): void;
+    /**
+     * @internal
+     * @description Retrieves and removes an object to the heap
+     */
+    takeObject(idx: number): unknown;
+    /**
+     * @internal
+     * @description Adds an object to the heap
+     */
+    addObject(obj: unknown): number;
+    /**
+     * @internal
+     * @description Retrieve an Int32 in the WASM interface
+     */
+    getInt32(): Int32Array;
+    /**
+     * @internal
+     * @description Retrieve an Uint8Array in the WASM interface
+     */
+    getUint8(): Uint8Array;
+    /**
+     * @internal
+     * @description Retrieves an Uint8Array in the WASM interface
+     */
+    getU8a(ptr: number, len: number): Uint8Array;
+    /**
+     * @internal
+     * @description Retrieves a string in the WASM interface
+     */
+    getString(ptr: number, len: number): string;
+    /**
+     * @internal
+     * @description Allocates an Uint8Array in the WASM interface
+     */
+    allocU8a(arg: Uint8Array): [number, number];
+    /**
+     * @internal
+     * @description Allocates a string in the WASM interface
+     */
+    allocString(arg: string): [number, number];
+    /**
+     * @internal
+     * @description Retrieves an Uint8Array from the WASM interface
+     */
+    resultU8a(): Uint8Array;
+    /**
+     * @internal
+     * @description Retrieve a string from the WASM interface
+     */
+    resultString(): string;
+}