@pezkuwi/types-codec 16.5.5 → 16.5.8

package/build/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/build/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/build/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/build/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/build/extended/Map.js

@@ -0,0 +1,200 @@
+import { compactFromU8aLim, compactToU8a, isHex, isObject, isU8a, logger, stringify, u8aConcatStrict, u8aToHex, u8aToU8a } from '@pezkuwi/util';
+import { AbstractArray } from '../abstract/Array.js';
+import { Enum } from '../base/Enum.js';
+import { Raw } from '../native/Raw.js';
+import { Struct } from '../native/Struct.js';
+import { compareMap, decodeU8a, sortMap, typeToConstructor } from '../utils/index.js';
+const l = logger('Map');
+/** @internal */
+function decodeMapFromU8a(registry, KeyClass, ValClass, u8a) {
+    const output = new Map();
+    const [offset, count] = compactFromU8aLim(u8a);
+    const types = [];
+    for (let i = 0; i < count; i++) {
+        types.push(KeyClass, ValClass);
+    }
+    const [values, decodedLength] = decodeU8a(registry, new Array(types.length), u8a.subarray(offset), [types, []]);
+    for (let i = 0, count = values.length; i < count; i += 2) {
+        output.set(values[i], values[i + 1]);
+    }
+    return [KeyClass, ValClass, output, offset + decodedLength];
+}
+/** @internal */
+function decodeMapFromMap(registry, KeyClass, ValClass, value) {
+    const output = new Map();
+    for (const [key, val] of value.entries()) {
+        const isComplex = KeyClass.prototype instanceof AbstractArray ||
+            KeyClass.prototype instanceof Struct ||
+            KeyClass.prototype instanceof Enum;
+        try {
+            output.set(key instanceof KeyClass
+                ? key
+                : new KeyClass(registry, isComplex && typeof key === 'string' ? JSON.parse(key) : key), val instanceof ValClass
+                ? val
+                : new ValClass(registry, val));
+        }
+        catch (error) {
+            l.error('Failed to decode key or value:', error.message);
+            throw error;
+        }
+    }
+    return [KeyClass, ValClass, output, 0];
+}
+/**
+ * Decode input to pass into constructor.
+ *
+ * @param KeyClass - Type of the map key
+ * @param ValClass - Type of the map value
+ * @param value - Value to decode, one of:
+ * - null
+ * - undefined
+ * - hex
+ * - Uint8Array
+ * - Map<any, any>, where both key and value types are either
+ *   constructors or decodeable values for their types.
+ * @param jsonMap
+ * @internal
+ */
+function decodeMap(registry, keyType, valType, value) {
+    const KeyClass = typeToConstructor(registry, keyType);
+    const ValClass = typeToConstructor(registry, valType);
+    if (!value) {
+        return [KeyClass, ValClass, new Map(), 0];
+    }
+    else if (isU8a(value) || isHex(value)) {
+        return decodeMapFromU8a(registry, KeyClass, ValClass, u8aToU8a(value));
+    }
+    else if (value instanceof Map) {
+        return decodeMapFromMap(registry, KeyClass, ValClass, value);
+    }
+    else if (isObject(value)) {
+        return decodeMapFromMap(registry, KeyClass, ValClass, new Map(Object.entries(value)));
+    }
+    throw new Error('Map: cannot decode type');
+}
+export class CodecMap extends Map {
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    #KeyClass;
+    #ValClass;
+    #type;
+    constructor(registry, keyType, valType, rawValue, type = 'HashMap') {
+        const [KeyClass, ValClass, decoded, decodedLength] = decodeMap(registry, keyType, valType, rawValue);
+        super(type === 'BTreeMap' ? sortMap(decoded) : decoded);
+        this.registry = registry;
+        this.initialU8aLength = decodedLength;
+        this.#KeyClass = KeyClass;
+        this.#ValClass = ValClass;
+        this.#type = type;
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        let len = compactToU8a(this.size).length;
+        for (const [k, v] of this.entries()) {
+            len += k.encodedLength + 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 Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        return compareMap(this, other);
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        const inner = [];
+        for (const [k, v] of this.entries()) {
+            inner.push(k.inspect());
+            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 [k, v] of this.entries()) {
+            json[k instanceof Raw && !disableAscii && k.isAscii
+                ? k.toUtf8()
+                : k.toString()] = v.toHuman(isExtended, disableAscii);
+        }
+        return json;
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON() {
+        const json = {};
+        for (const [k, v] of this.entries()) {
+            json[k.toString()] = v.toJSON();
+        }
+        return json;
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii) {
+        const json = {};
+        for (const [k, v] of this.entries()) {
+            json[k instanceof Raw && !disableAscii && k.isAscii
+                ? k.toUtf8()
+                : k.toString()] = v.toPrimitive(disableAscii);
+        }
+        return json;
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `${this.#type}<${this.registry.getClassName(this.#KeyClass) || new this.#KeyClass(this.registry).toRawType()},${this.registry.getClassName(this.#ValClass) || new this.#ValClass(this.registry).toRawType()}>`;
+    }
+    /**
+     * @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 [k, v] of this.entries()) {
+            encoded.push(k.toU8a(isBare), v.toU8a(isBare));
+        }
+        return u8aConcatStrict(encoded);
+    }
+}

package/build/extended/OptionBool.js

@@ -0,0 +1,72 @@
+import { isHex, isU8a, u8aToU8a } from '@pezkuwi/util';
+import { Option } from '../base/Option.js';
+import { bool as Bool } from '../native/Bool.js';
+function decodeU8a(registry, value) {
+    // Encoded as -
+    //  - 0 = None
+    //  - 1 = True
+    //  - 2 = False
+    return value[0] === 0
+        ? null
+        : new Bool(registry, value[0] === 1);
+}
+/**
+ * @name OptionBool
+ * @description A specific implementation of Option<bool> than allows for single-byte encoding
+ */
+export class OptionBool extends Option {
+    constructor(registry, value) {
+        super(registry, Bool, isU8a(value) || isHex(value)
+            ? decodeU8a(registry, u8aToU8a(value))
+            : value);
+        this.initialU8aLength = 1;
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        return 1 | 0;
+    }
+    /**
+     * @description Checks if the value is an empty value (always false)
+     */
+    get isFalse() {
+        return this.isSome
+            ? !this.value.valueOf()
+            : false;
+    }
+    /**
+     * @description Checks if the value is an empty value (always false)
+     */
+    get isTrue() {
+        return this.isSome
+            ? this.value.valueOf()
+            : false;
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return { outer: [this.toU8a()] };
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(isBare) {
+        return isBare
+            ? 'bool'
+            : 'Option<bool>';
+    }
+    /**
+     * @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) {
+        if (isBare) {
+            return super.toU8a(true);
+        }
+        return this.isSome
+            ? new Uint8Array([this.isTrue ? 1 : 2])
+            : new Uint8Array([0]);
+    }
+}

package/build/extended/Range.js

@@ -0,0 +1,38 @@
+import { Tuple } from '../base/Tuple.js';
+/**
+ * @name Range
+ * @description
+ * Rust `Range<T>` representation
+ */
+export class Range extends Tuple {
+    #rangeName;
+    constructor(registry, Type, value, { rangeName = 'Range' } = {}) {
+        super(registry, [Type, Type], value);
+        this.#rangeName = rangeName;
+    }
+    static with(Type) {
+        return class extends Range {
+            constructor(registry, value) {
+                super(registry, Type, value);
+            }
+        };
+    }
+    /**
+     * @description Returns the starting range value
+     */
+    get start() {
+        return this[0];
+    }
+    /**
+     * @description Returns the ending range value
+     */
+    get end() {
+        return this[1];
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `${this.#rangeName}<${this.start.toRawType()}>`;
+    }
+}

package/build/extended/RangeInclusive.js

@@ -0,0 +1,13 @@
+import { Range } from './Range.js';
+export class RangeInclusive extends Range {
+    constructor(registry, Type, value) {
+        super(registry, Type, value, { rangeName: 'RangeInclusive' });
+    }
+    static with(Type) {
+        return class extends RangeInclusive {
+            constructor(registry, value) {
+                super(registry, Type, value);
+            }
+        };
+    }
+}

package/build/extended/Type.js

@@ -0,0 +1,21 @@
+import { Text } from '../native/Text.js';
+import { sanitize } from '../utils/index.js';
+/**
+ * @name Type
+ * @description
+ * This is a extended version of Text, specifically to handle types. Here we rely fully
+ * on what Text provides us, however we also adjust the types received from the runtime,
+ * i.e. we remove the `T::` prefixes found in some types for consistency across implementation.
+ */
+export class Type extends Text {
+    constructor(registry, value = '') {
+        super(registry, value);
+        this.setOverride(sanitize(this.toString()));
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'Type';
+    }
+}

package/build/extended/U8aFixed.js

@@ -0,0 +1,42 @@
+import { isU8a, u8aToU8a } from '@pezkuwi/util';
+import { Raw } from '../native/Raw.js';
+/** @internal */
+function decodeU8aFixed(value, bitLength) {
+    const u8a = u8aToU8a(value);
+    const byteLength = bitLength / 8;
+    if (!u8a.length) {
+        return [new Uint8Array(byteLength), 0];
+    }
+    if (isU8a(value) ? u8a.length < byteLength : u8a.length !== byteLength) {
+        throw new Error(`Expected input with ${byteLength} bytes (${bitLength} bits), found ${u8a.length} bytes`);
+    }
+    return [u8a.subarray(0, byteLength), byteLength];
+}
+/**
+ * @name U8aFixed
+ * @description
+ * A U8a that manages a a sequence of bytes up to the specified bitLength. Not meant
+ * to be used directly, rather is should be subclassed with the specific lengths.
+ */
+export class U8aFixed extends Raw {
+    constructor(registry, value = new Uint8Array(), bitLength = 256) {
+        const [u8a, decodedLength] = decodeU8aFixed(value, bitLength);
+        super(registry, u8a, decodedLength);
+    }
+    static with(bitLength, typeName) {
+        return class extends U8aFixed {
+            constructor(registry, value) {
+                super(registry, value, bitLength);
+            }
+            toRawType() {
+                return typeName || super.toRawType();
+            }
+        };
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `[u8;${this.length}]`;
+    }
+}