@pezkuwi/types-codec 16.5.6 → 16.5.8

package/build/cjs/base/VecAny.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VecAny = void 0;
+const Array_js_1 = require("../abstract/Array.js");
+/**
+ * @name VecAny
+ * @description
+ * This manages codec arrays, assuming that the inputs are already of type Codec. Unlike
+ * a vector, this can be used to manage array-like structures with variable arguments of
+ * any types
+ */
+class VecAny extends Array_js_1.AbstractArray {
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        // FIXME This is basically an any type, cannot instantiate via createType
+        return 'Vec<Codec>';
+    }
+}
+exports.VecAny = VecAny;

package/build/cjs/base/VecFixed.d.ts

@@ -0,0 +1,30 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { Codec, CodecClass, DefinitionSetter, Inspect, Registry } from '../types/index.js';
+import { AbstractArray } from '../abstract/Array.js';
+/**
+ * @name VecFixed
+ * @description
+ * This manages codec arrays of a fixed length
+ */
+export declare class VecFixed<T extends Codec> extends AbstractArray<T> {
+    #private;
+    constructor(registry: Registry, Type: CodecClass<T> | string, length: number, value?: Uint8Array | HexString | unknown[], { definition, setDefinition }?: DefinitionSetter<CodecClass<T>>);
+    static with<O extends Codec>(Type: CodecClass<O> | string, length: number): CodecClass<VecFixed<O>>;
+    /**
+     * @description The type for the items
+     */
+    get Type(): string;
+    /**
+     * @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;
+    toU8a(): Uint8Array;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+}

package/build/cjs/base/VecFixed.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VecFixed = void 0;
+const util_1 = require("@pezkuwi/util");
+const Array_js_1 = require("../abstract/Array.js");
+const index_js_1 = require("../utils/index.js");
+const Vec_js_1 = require("./Vec.js");
+/**
+ * @name VecFixed
+ * @description
+ * This manages codec arrays of a fixed length
+ */
+class VecFixed extends Array_js_1.AbstractArray {
+    #Type;
+    constructor(registry, Type, length, value = [], { definition, setDefinition = util_1.identity } = {}) {
+        super(registry, length);
+        this.#Type = definition || setDefinition((0, index_js_1.typeToConstructor)(registry, Type));
+        this.initialU8aLength = ((0, util_1.isU8a)(value)
+            ? (0, index_js_1.decodeU8aVec)(registry, this, value, 0, this.#Type)
+            : (0, Vec_js_1.decodeVec)(registry, this, value, 0, this.#Type))[1];
+    }
+    static with(Type, length) {
+        let definition;
+        // eslint-disable-next-line no-return-assign
+        const setDefinition = (d) => (definition = d);
+        return class extends VecFixed {
+            constructor(registry, value) {
+                super(registry, Type, length, value, { definition, setDefinition });
+            }
+        };
+    }
+    /**
+     * @description The type for the items
+     */
+    get Type() {
+        return new this.#Type(this.registry).toRawType();
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        let total = 0;
+        for (let i = 0, count = this.length; i < count; i++) {
+            total += this[i].encodedLength;
+        }
+        return total;
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return {
+            inner: this.inspectInner()
+        };
+    }
+    toU8a() {
+        // we override, we don't add the length prefix for ourselves, and at the same time we
+        // ignore isBare on entries, since they should be properly encoded at all times
+        const encoded = this.toU8aInner();
+        return encoded.length
+            ? (0, util_1.u8aConcatStrict)(encoded)
+            : new Uint8Array([]);
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `[${this.Type};${this.length}]`;
+    }
+}
+exports.VecFixed = VecFixed;

package/build/cjs/base/index.d.ts

@@ -0,0 +1,12 @@
+export { Compact } from './Compact.js';
+export { DoNotConstruct } from './DoNotConstruct.js';
+export { Enum } from './Enum.js';
+export { Int } from './Int.js';
+export { Null } from './Null.js';
+export { Option } from './Option.js';
+export { Result } from './Result.js';
+export { Tuple } from './Tuple.js';
+export { UInt } from './UInt.js';
+export { Vec } from './Vec.js';
+export { VecAny } from './VecAny.js';
+export { VecFixed } from './VecFixed.js';

package/build/cjs/base/index.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VecFixed = exports.VecAny = exports.Vec = exports.UInt = exports.Tuple = exports.Result = exports.Option = exports.Null = exports.Int = exports.Enum = exports.DoNotConstruct = exports.Compact = void 0;
+var Compact_js_1 = require("./Compact.js");
+Object.defineProperty(exports, "Compact", { enumerable: true, get: function () { return Compact_js_1.Compact; } });
+var DoNotConstruct_js_1 = require("./DoNotConstruct.js");
+Object.defineProperty(exports, "DoNotConstruct", { enumerable: true, get: function () { return DoNotConstruct_js_1.DoNotConstruct; } });
+var Enum_js_1 = require("./Enum.js");
+Object.defineProperty(exports, "Enum", { enumerable: true, get: function () { return Enum_js_1.Enum; } });
+var Int_js_1 = require("./Int.js");
+Object.defineProperty(exports, "Int", { enumerable: true, get: function () { return Int_js_1.Int; } });
+var Null_js_1 = require("./Null.js");
+Object.defineProperty(exports, "Null", { enumerable: true, get: function () { return Null_js_1.Null; } });
+var Option_js_1 = require("./Option.js");
+Object.defineProperty(exports, "Option", { enumerable: true, get: function () { return Option_js_1.Option; } });
+var Result_js_1 = require("./Result.js");
+Object.defineProperty(exports, "Result", { enumerable: true, get: function () { return Result_js_1.Result; } });
+var Tuple_js_1 = require("./Tuple.js");
+Object.defineProperty(exports, "Tuple", { enumerable: true, get: function () { return Tuple_js_1.Tuple; } });
+var UInt_js_1 = require("./UInt.js");
+Object.defineProperty(exports, "UInt", { enumerable: true, get: function () { return UInt_js_1.UInt; } });
+var Vec_js_1 = require("./Vec.js");
+Object.defineProperty(exports, "Vec", { enumerable: true, get: function () { return Vec_js_1.Vec; } });
+var VecAny_js_1 = require("./VecAny.js");
+Object.defineProperty(exports, "VecAny", { enumerable: true, get: function () { return VecAny_js_1.VecAny; } });
+var VecFixed_js_1 = require("./VecFixed.js");
+Object.defineProperty(exports, "VecFixed", { enumerable: true, get: function () { return VecFixed_js_1.VecFixed; } });

package/build/cjs/bundle.d.ts

@@ -0,0 +1,7 @@
+export { packageInfo } from './packageInfo.js';
+export * from './abstract/index.js';
+export * from './base/index.js';
+export * from './extended/index.js';
+export * from './native/index.js';
+export * from './primitive/index.js';
+export * from './utils/index.js';

package/build/cjs/bundle.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.packageInfo = void 0;
+const tslib_1 = require("tslib");
+var packageInfo_js_1 = require("./packageInfo.js");
+Object.defineProperty(exports, "packageInfo", { enumerable: true, get: function () { return packageInfo_js_1.packageInfo; } });
+tslib_1.__exportStar(require("./abstract/index.js"), exports);
+tslib_1.__exportStar(require("./base/index.js"), exports);
+tslib_1.__exportStar(require("./extended/index.js"), exports);
+tslib_1.__exportStar(require("./native/index.js"), exports);
+tslib_1.__exportStar(require("./primitive/index.js"), exports);
+tslib_1.__exportStar(require("./utils/index.js"), exports);

package/build/cjs/extended/BTreeMap.d.ts

@@ -0,0 +1,5 @@
+import type { Codec, CodecClass } from '../types/index.js';
+import { CodecMap } from './Map.js';
+export declare class BTreeMap<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/build/cjs/extended/BTreeMap.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BTreeMap = void 0;
+const Map_js_1 = require("./Map.js");
+class BTreeMap extends Map_js_1.CodecMap {
+    static with(keyType, valType) {
+        return class extends BTreeMap {
+            constructor(registry, value) {
+                super(registry, keyType, valType, value, 'BTreeMap');
+            }
+        };
+    }
+}
+exports.BTreeMap = BTreeMap;

package/build/cjs/extended/BTreeSet.d.ts

@@ -0,0 +1,64 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, Codec, CodecClass, Inspect, ISet, IU8a, Registry } from '../types/index.js';
+export declare class BTreeSet<V extends Codec = Codec> extends Set<V> implements ISet<V> {
+    #private;
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, valType: CodecClass<V> | string, rawValue?: Uint8Array | string | string[] | Set<any>);
+    static with<V extends Codec>(valType: CodecClass<V> | string): CodecClass<BTreeSet<V>>;
+    /**
+     * @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 The actual set values as a string[]
+     */
+    get strings(): string[];
+    /**
+     * @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): AnyJson;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): AnyJson;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii?: boolean): AnyJson;
+    /**
+     * @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;
+}

package/build/cjs/extended/BTreeSet.js

@@ -0,0 +1,189 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BTreeSet = void 0;
+const util_1 = require("@pezkuwi/util");
+const index_js_1 = require("../utils/index.js");
+const l = (0, util_1.logger)('BTreeSet');
+/** @internal */
+function decodeSetFromU8a(registry, ValClass, u8a) {
+    const output = new Set();
+    const [offset, count] = (0, util_1.compactFromU8aLim)(u8a);
+    const result = new Array(count);
+    const [decodedLength] = (0, index_js_1.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 = (0, index_js_1.typeToConstructor)(registry, valType);
+    if (!value) {
+        return [ValClass, new Set(), 0];
+    }
+    else if ((0, util_1.isU8a)(value) || (0, util_1.isHex)(value)) {
+        return decodeSetFromU8a(registry, ValClass, (0, util_1.u8aToU8a)(value));
+    }
+    else if (Array.isArray(value) || value instanceof Set) {
+        return decodeSetFromSet(registry, ValClass, value);
+    }
+    throw new Error('BTreeSet: cannot decode type');
+}
+class BTreeSet extends Set {
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    #ValClass;
+    constructor(registry, valType, rawValue) {
+        const [ValClass, values, decodedLength] = decodeSet(registry, valType, rawValue);
+        super((0, index_js_1.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 = (0, util_1.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 (0, index_js_1.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: [(0, util_1.compactToU8a)(this.size)]
+        };
+    }
+    /**
+     * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+     */
+    toHex() {
+        return (0, util_1.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 (0, util_1.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((0, util_1.compactToU8a)(this.size));
+        }
+        for (const v of this.values()) {
+            encoded.push(v.toU8a(isBare));
+        }
+        return (0, util_1.u8aConcatStrict)(encoded);
+    }
+}
+exports.BTreeSet = BTreeSet;

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

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitVec = void 0;
+const util_1 = require("@pezkuwi/util");
+const Raw_js_1 = require("../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] = (0, util_1.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) || (0, util_1.isString)(value)) {
+        const u8a = (0, util_1.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
+ */
+class BitVec extends Raw_js_1.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 + (0, util_1.compactToU8a)(this.#decodedLength).length;
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return {
+            outer: [(0, util_1.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
+            : (0, util_1.u8aConcatStrict)([(0, util_1.compactToU8a)(this.#decodedLength), bitVec]);
+    }
+}
+exports.BitVec = BitVec;

package/build/cjs/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;
+}