@pezkuwi/types-codec 16.5.5 → 16.5.8

package/extended/BTreeSet.js

@@ -0,0 +1,185 @@
+import { compactFromU8aLim, compactToU8a, isHex, isU8a, logger, stringify, u8aConcatStrict, u8aToHex, u8aToU8a } from '@pezkuwi/util';
+import { compareSet, decodeU8aVec, sortSet, typeToConstructor } from '../utils/index.js';
+const l = logger('BTreeSet');
+/** @internal */
+function decodeSetFromU8a(registry, ValClass, u8a) {
+    const output = new Set();
+    const [offset, count] = compactFromU8aLim(u8a);
+    const result = new Array(count);
+    const [decodedLength] = decodeU8aVec(registry, result, u8a, offset, ValClass);
+    for (let i = 0; i < count; i++) {
+        output.add(result[i]);
+    }
+    return [ValClass, output, decodedLength];
+}
+/** @internal */
+function decodeSetFromSet(registry, ValClass, value) {
+    const output = new Set();
+    value.forEach((val) => {
+        try {
+            output.add((val instanceof ValClass) ? val : new ValClass(registry, val));
+        }
+        catch (error) {
+            l.error('Failed to decode key or value:', error.message);
+            throw error;
+        }
+    });
+    return [ValClass, output, 0];
+}
+/**
+ * Decode input to pass into constructor.
+ *
+ * @param ValClass - Type of the map value
+ * @param value - Value to decode, one of:
+ * - null
+ * - undefined
+ * - hex
+ * - Uint8Array
+ * - Set<any>, where both key and value types are either
+ *   constructors or decodeable values for their types.
+ * @param jsonSet
+ * @internal
+ */
+function decodeSet(registry, valType, value) {
+    const ValClass = typeToConstructor(registry, valType);
+    if (!value) {
+        return [ValClass, new Set(), 0];
+    }
+    else if (isU8a(value) || isHex(value)) {
+        return decodeSetFromU8a(registry, ValClass, u8aToU8a(value));
+    }
+    else if (Array.isArray(value) || value instanceof Set) {
+        return decodeSetFromSet(registry, ValClass, value);
+    }
+    throw new Error('BTreeSet: cannot decode type');
+}
+export class BTreeSet extends Set {
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    #ValClass;
+    constructor(registry, valType, rawValue) {
+        const [ValClass, values, decodedLength] = decodeSet(registry, valType, rawValue);
+        super(sortSet(values));
+        this.registry = registry;
+        this.initialU8aLength = decodedLength;
+        this.#ValClass = ValClass;
+    }
+    static with(valType) {
+        return class extends BTreeSet {
+            constructor(registry, value) {
+                super(registry, valType, value);
+            }
+        };
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        let len = compactToU8a(this.size).length;
+        for (const v of this.values()) {
+            len += v.encodedLength;
+        }
+        return len;
+    }
+    /**
+     * @description Returns a hash of the value
+     */
+    get hash() {
+        return this.registry.hash(this.toU8a());
+    }
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty() {
+        return this.size === 0;
+    }
+    /**
+     * @description The actual set values as a string[]
+     */
+    get strings() {
+        return [...super.values()].map((v) => v.toString());
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        return compareSet(this, other);
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        const inner = [];
+        for (const v of this.values()) {
+            inner.push(v.inspect());
+        }
+        return {
+            inner,
+            outer: [compactToU8a(this.size)]
+        };
+    }
+    /**
+     * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+     */
+    toHex() {
+        return u8aToHex(this.toU8a());
+    }
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExtended, disableAscii) {
+        const json = [];
+        for (const v of this.values()) {
+            json.push(v.toHuman(isExtended, disableAscii));
+        }
+        return json;
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON() {
+        const json = [];
+        for (const v of this.values()) {
+            json.push(v.toJSON());
+        }
+        return json;
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `BTreeSet<${this.registry.getClassName(this.#ValClass) || new this.#ValClass(this.registry).toRawType()}>`;
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii) {
+        const json = [];
+        for (const v of this.values()) {
+            json.push(v.toPrimitive(disableAscii));
+        }
+        return json;
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        return stringify(this.toJSON());
+    }
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare) {
+        const encoded = [];
+        if (!isBare) {
+            encoded.push(compactToU8a(this.size));
+        }
+        for (const v of this.values()) {
+            encoded.push(v.toU8a(isBare));
+        }
+        return u8aConcatStrict(encoded);
+    }
+}

package/extended/BitVec.d.ts

@@ -0,0 +1,37 @@
+import type { AnyU8a, Inspect, Registry } from '../types/index.js';
+import { Raw } from '../native/Raw.js';
+/**
+ * @name BitVec
+ * @description
+ * A BitVec that represents an array of bits. The bits are however stored encoded. The difference between this
+ * and a normal Bytes would be that the length prefix indicates the number of bits encoded, not the bytes
+ */
+export declare class BitVec extends Raw {
+    #private;
+    constructor(registry: Registry, value?: AnyU8a, isMsb?: boolean);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(): Inspect;
+    /**
+     * @description Creates a boolean array of the bit values
+     */
+    toBoolArray(): boolean[];
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(): string;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+}

package/extended/BitVec.js

@@ -0,0 +1,108 @@
+import { compactFromU8aLim, compactToU8a, isString, u8aConcatStrict, u8aToU8a } from '@pezkuwi/util';
+import { Raw } from '../native/Raw.js';
+/** @internal */
+function decodeBitVecU8a(value) {
+    if (!value?.length) {
+        return [0, new Uint8Array()];
+    }
+    // handle all other Uint8Array inputs, these do have a length prefix which is the number of bits encoded
+    const [offset, length] = compactFromU8aLim(value);
+    const total = offset + Math.ceil(length / 8);
+    if (total > value.length) {
+        throw new Error(`BitVec: required length less than remainder, expected at least ${total}, found ${value.length}`);
+    }
+    return [length, value.subarray(offset, total)];
+}
+/** @internal */
+function decodeBitVec(value) {
+    if (Array.isArray(value) || isString(value)) {
+        const u8a = u8aToU8a(value);
+        return [u8a.length * 8, u8a];
+    }
+    return decodeBitVecU8a(value);
+}
+/**
+ * @name BitVec
+ * @description
+ * A BitVec that represents an array of bits. The bits are however stored encoded. The difference between this
+ * and a normal Bytes would be that the length prefix indicates the number of bits encoded, not the bytes
+ */
+export class BitVec extends Raw {
+    #decodedLength;
+    #isMsb;
+    // In lieu of having the Msb/Lsb identifiers passed through, we default to assuming
+    // we are dealing with Lsb, which is the default (as of writing) BitVec format used
+    // in the Pezkuwi code (this only affects the toHuman displays)
+    constructor(registry, value, isMsb = false) {
+        const [decodedLength, u8a] = decodeBitVec(value);
+        super(registry, u8a);
+        this.#decodedLength = decodedLength;
+        this.#isMsb = isMsb;
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        return this.length + compactToU8a(this.#decodedLength).length;
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return {
+            outer: [compactToU8a(this.#decodedLength), super.toU8a()]
+        };
+    }
+    /**
+     * @description Creates a boolean array of the bit values
+     */
+    toBoolArray() {
+        const map = [...this.toU8a(true)].map((v) => [
+            !!(v & 0b1000_0000),
+            !!(v & 0b0100_0000),
+            !!(v & 0b0010_0000),
+            !!(v & 0b0001_0000),
+            !!(v & 0b0000_1000),
+            !!(v & 0b0000_0100),
+            !!(v & 0b0000_0010),
+            !!(v & 0b0000_0001)
+        ]);
+        const count = map.length;
+        const result = new Array(8 * count);
+        for (let i = 0; i < count; i++) {
+            const off = i * 8;
+            const v = map[i];
+            for (let j = 0; j < 8; j++) {
+                result[off + j] = this.#isMsb
+                    ? v[j]
+                    : v[7 - j];
+            }
+        }
+        return result;
+    }
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman() {
+        return `0b${[...this.toU8a(true)]
+            .map((d) => `00000000${d.toString(2)}`.slice(-8))
+            .map((s) => this.#isMsb ? s : s.split('').reverse().join(''))
+            .join('_')}`;
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'BitVec';
+    }
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare) {
+        const bitVec = super.toU8a(isBare);
+        return isBare
+            ? bitVec
+            : u8aConcatStrict([compactToU8a(this.#decodedLength), bitVec]);
+    }
+}

package/extended/Bytes.d.ts

@@ -0,0 +1,29 @@
+import type { AnyU8a, Inspect, Registry } from '../types/index.js';
+import { Raw } from '../native/Raw.js';
+/**
+ * @name Bytes
+ * @description
+ * A Bytes wrapper for Vec<u8>. The significant difference between this and a normal Uint8Array
+ * is that this version allows for length-encoding. (i.e. it is a variable-item codec, the same
+ * as what is found in [[Text]] and [[Vec]])
+ */
+export declare class Bytes extends Raw {
+    constructor(registry: Registry, value?: AnyU8a);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(isBare?: boolean): Inspect;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+}

package/extended/Bytes.js

@@ -0,0 +1,70 @@
+import { compactAddLength, compactFromU8aLim, compactToU8a, isString, isU8a, u8aToU8a } from '@pezkuwi/util';
+import { Raw } from '../native/Raw.js';
+const MAX_LENGTH = 10 * 1024 * 1024;
+/** @internal */
+function decodeBytesU8a(value) {
+    if (!value.length) {
+        return [new Uint8Array(), 0];
+    }
+    // handle all other Uint8Array inputs, these do have a length prefix
+    const [offset, length] = compactFromU8aLim(value);
+    const total = offset + length;
+    if (length > MAX_LENGTH) {
+        throw new Error(`Bytes length ${length.toString()} exceeds ${MAX_LENGTH}`);
+    }
+    else if (total > value.length) {
+        throw new Error(`Bytes: required length less than remainder, expected at least ${total}, found ${value.length}`);
+    }
+    return [value.subarray(offset, total), total];
+}
+/**
+ * @name Bytes
+ * @description
+ * A Bytes wrapper for Vec<u8>. The significant difference between this and a normal Uint8Array
+ * is that this version allows for length-encoding. (i.e. it is a variable-item codec, the same
+ * as what is found in [[Text]] and [[Vec]])
+ */
+export class Bytes extends Raw {
+    constructor(registry, value) {
+        const [u8a, decodedLength] = isU8a(value) && !(value instanceof Raw)
+            ? decodeBytesU8a(value)
+            : Array.isArray(value) || isString(value)
+                ? [u8aToU8a(value), 0]
+                : [value, 0];
+        super(registry, u8a, decodedLength);
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        return this.length + compactToU8a(this.length).length;
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(isBare) {
+        const clength = compactToU8a(this.length);
+        return {
+            outer: isBare
+                ? [super.toU8a()]
+                : this.length
+                    ? [clength, super.toU8a()]
+                    : [clength]
+        };
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'Bytes';
+    }
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare) {
+        return isBare
+            ? super.toU8a(isBare)
+            : compactAddLength(this);
+    }
+}

package/extended/HashMap.d.ts

@@ -0,0 +1,5 @@
+import type { Codec, CodecClass } from '../types/index.js';
+import { CodecMap } from './Map.js';
+export declare class HashMap<K extends Codec = Codec, V extends Codec = Codec> extends CodecMap<K, V> {
+    static with<K extends Codec, V extends Codec>(keyType: CodecClass<K> | string, valType: CodecClass<V> | string): CodecClass<CodecMap<K, V>>;
+}

package/extended/HashMap.js

@@ -0,0 +1,10 @@
+import { CodecMap } from './Map.js';
+export class HashMap extends CodecMap {
+    static with(keyType, valType) {
+        return class extends HashMap {
+            constructor(registry, value) {
+                super(registry, keyType, valType, value);
+            }
+        };
+    }
+}

package/extended/Linkage.d.ts

@@ -0,0 +1,37 @@
+import type { Codec, CodecClass, Registry } from '../types/index.js';
+import { Option } from '../base/Option.js';
+import { Tuple } from '../base/Tuple.js';
+import { Struct } from '../native/Struct.js';
+type TypeWithValues = [CodecClass, any[]];
+/**
+ * @name Linkage
+ * @description The wrapper for the result from a LinkedMap
+ */
+export declare class Linkage<T extends Codec> extends Struct {
+    constructor(registry: Registry, Type: CodecClass | string, value?: unknown);
+    static withKey<O extends Codec>(Type: CodecClass | string): CodecClass<Linkage<O>>;
+    /**
+     * @description Returns the next item the Linkage is pointing to
+     */
+    get previous(): Option<T>;
+    /**
+     * @description Returns the previous item the Linkage is pointing to
+     */
+    get next(): Option<T>;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Custom toU8a which with bare mode does not return the linkage if empty
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+}
+/**
+ * @name LinkageResult
+ * @description A Linkage keys/Values tuple
+ */
+export declare class LinkageResult extends Tuple {
+    constructor(registry: Registry, [TypeKey, keys]: TypeWithValues, [TypeValue, values]: TypeWithValues);
+}
+export {};

package/extended/Linkage.js

@@ -0,0 +1,65 @@
+import { Option } from '../base/Option.js';
+import { Tuple } from '../base/Tuple.js';
+import { Vec } from '../base/Vec.js';
+import { Struct } from '../native/Struct.js';
+const EMPTY = new Uint8Array();
+/**
+ * @name Linkage
+ * @description The wrapper for the result from a LinkedMap
+ */
+export class Linkage extends Struct {
+    constructor(registry, Type, value) {
+        super(registry, {
+            previous: Option.with(Type),
+            // eslint-disable-next-line sort-keys
+            next: Option.with(Type)
+        }, value);
+    }
+    static withKey(Type) {
+        return class extends Linkage {
+            constructor(registry, value) {
+                super(registry, Type, value);
+            }
+        };
+    }
+    /**
+     * @description Returns the next item the Linkage is pointing to
+     */
+    get previous() {
+        return this.get('previous');
+    }
+    /**
+     * @description Returns the previous item the Linkage is pointing to
+     */
+    get next() {
+        return this.get('next');
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `Linkage<${this.next.toRawType(true)}>`;
+    }
+    /**
+     * @description Custom toU8a which with bare mode does not return the linkage if empty
+     */
+    toU8a(isBare) {
+        // As part of a storage query (where these appear), in the case of empty, the values
+        // are NOT populated by the node - follow the same logic, leaving it empty
+        return this.isEmpty
+            ? EMPTY
+            : super.toU8a(isBare);
+    }
+}
+/**
+ * @name LinkageResult
+ * @description A Linkage keys/Values tuple
+ */
+export class LinkageResult extends Tuple {
+    constructor(registry, [TypeKey, keys], [TypeValue, values]) {
+        super(registry, {
+            Keys: Vec.with(TypeKey),
+            Values: Vec.with(TypeValue)
+        }, [keys, values]);
+    }
+}

package/extended/Map.d.ts

@@ -0,0 +1,59 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, Codec, CodecClass, IMap, Inspect, IU8a, Registry } from '../types/index.js';
+export declare class CodecMap<K extends Codec = Codec, V extends Codec = Codec> extends Map<K, V> implements IMap<K, V> {
+    #private;
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, keyType: CodecClass<K> | string, valType: CodecClass<V> | string, rawValue: Uint8Array | string | Map<any, any> | undefined, type?: 'BTreeMap' | 'HashMap');
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description Returns a hash of the value
+     */
+    get hash(): IU8a;
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other?: unknown): boolean;
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(): Inspect;
+    /**
+     * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+     */
+    toHex(): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExtended?: boolean, disableAscii?: boolean): Record<string, AnyJson>;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): Record<string, AnyJson>;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii?: boolean): AnyJson;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString(): string;
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+}