@pezkuwi/types-codec 16.5.6 → 16.5.8

package/build-tsc-esm/base/Null.js

@@ -0,0 +1,77 @@
+import { isNull } from '@pezkuwi/util';
+/**
+ * @name Null
+ * @description
+ * Implements a type that does not contain anything (apart from `null`)
+ */
+export class Null {
+    encodedLength = 0;
+    isEmpty = true;
+    registry;
+    createdAtHash;
+    initialU8aLength = 0;
+    isStorageFallback;
+    constructor(registry) {
+        this.registry = registry;
+    }
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash() {
+        throw new Error('.hash is not implemented on Null');
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        return other instanceof Null || isNull(other);
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return {};
+    }
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex() {
+        return '0x';
+    }
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman() {
+        return this.toJSON();
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON() {
+        return null;
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive() {
+        return null;
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'Null';
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        return '';
+    }
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     */
+    toU8a(_isBare) {
+        return new Uint8Array();
+    }
+}

package/build-tsc-esm/base/Option.js

@@ -0,0 +1,232 @@
+import { identity, isCodec, isNull, isU8a, isUndefined, u8aToHex } from '@pezkuwi/util';
+import { typeToConstructor } from '../utils/index.js';
+import { Null } from './Null.js';
+class None extends Null {
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'None';
+    }
+}
+/** @internal */
+function decodeOption(registry, Type, value) {
+    if (value instanceof Type) {
+        // don't re-create, use as it (which also caters for derived types)
+        return value;
+    }
+    else if (value instanceof Option) {
+        if (value.value instanceof Type) {
+            // same instance, return it
+            return value.value;
+        }
+        else if (value.isNone) {
+            // internal is None, we are also none
+            return new None(registry);
+        }
+        // convert the actual value into known
+        return new Type(registry, value.value);
+    }
+    else if (isNull(value) || isUndefined(value) || value === '0x' || value instanceof None) {
+        // anything empty we pass as-is
+        return new None(registry);
+    }
+    else if (isU8a(value)) {
+        // the isU8a check happens last in the if-tree - since the wrapped value
+        // may be an instance of it, so Type and Option checks go in first
+        return !value.length || value[0] === 0
+            ? new None(registry)
+            : new Type(registry, value.subarray(1));
+    }
+    return new Type(registry, value);
+}
+/**
+ * @name Option
+ * @description
+ * An Option is an optional field. Basically the first byte indicates that there is
+ * is value to follow. If the byte is `1` there is an actual value. So the Option
+ * implements that - decodes, checks for optionality and wraps the required structure
+ * with a value if/as required/found.
+ */
+export class Option {
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    #Type;
+    #raw;
+    constructor(registry, typeName, value, { definition, setDefinition = identity } = {}) {
+        const Type = definition || setDefinition(typeToConstructor(registry, typeName));
+        const decoded = isU8a(value) && value.length && !isCodec(value)
+            ? value[0] === 0
+                ? new None(registry)
+                : new Type(registry, value.subarray(1))
+            : decodeOption(registry, Type, value);
+        this.registry = registry;
+        this.#Type = Type;
+        this.#raw = decoded;
+        if (decoded?.initialU8aLength) {
+            this.initialU8aLength = 1 + decoded.initialU8aLength;
+        }
+    }
+    static with(Type) {
+        let definition;
+        const setDefinition = (d) => {
+            definition = d;
+            return d;
+        };
+        return class extends Option {
+            constructor(registry, value) {
+                super(registry, Type, value, { definition, setDefinition });
+            }
+        };
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        // boolean byte (has value, doesn't have) along with wrapped length
+        return 1 + this.#raw.encodedLength;
+    }
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash() {
+        return this.registry.hash(this.toU8a());
+    }
+    /**
+     * @description Checks if the Option has no value
+     */
+    get isEmpty() {
+        return this.isNone;
+    }
+    /**
+     * @description Checks if the Option has no value
+     */
+    get isNone() {
+        return this.#raw instanceof None;
+    }
+    /**
+     * @description Checks if the Option has a value
+     */
+    get isSome() {
+        return !this.isNone;
+    }
+    /**
+     * @description The actual value for the Option
+     */
+    get value() {
+        return this.#raw;
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        if (other instanceof Option) {
+            return (this.isSome === other.isSome) && this.value.eq(other.value);
+        }
+        return this.value.eq(other);
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        if (this.isNone) {
+            return { outer: [new Uint8Array([0])] };
+        }
+        const { inner, outer = [] } = this.#raw.inspect();
+        return {
+            inner,
+            outer: [new Uint8Array([1]), ...outer]
+        };
+    }
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex() {
+        // This attempts to align with the JSON encoding - actually in this case
+        // the isSome value is correct, however the `isNone` may be problematic
+        return this.isNone
+            ? '0x'
+            : u8aToHex(this.toU8a().subarray(1));
+    }
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExtended, disableAscii) {
+        return this.#raw.toHuman(isExtended, disableAscii);
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON() {
+        return this.isNone
+            ? null
+            : this.#raw.toJSON();
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii) {
+        return this.isNone
+            ? null
+            : this.#raw.toPrimitive(disableAscii);
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(isBare) {
+        const wrapped = this.registry.getClassName(this.#Type) || new this.#Type(this.registry).toRawType();
+        return isBare
+            ? wrapped
+            : `Option<${wrapped}>`;
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        return this.#raw.toString();
+    }
+    /**
+     * @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 this.#raw.toU8a(true);
+        }
+        const u8a = new Uint8Array(this.encodedLength);
+        if (this.isSome) {
+            u8a.set([1]);
+            u8a.set(this.#raw.toU8a(), 1);
+        }
+        return u8a;
+    }
+    /**
+     * @description Returns the value that the Option represents (if available), throws if null
+     */
+    unwrap() {
+        if (this.isNone) {
+            throw new Error('Option: unwrapping a None value');
+        }
+        return this.#raw;
+    }
+    /**
+     * @description Returns the value that the Option represents (if available) or defaultValue if none
+     * @param defaultValue The value to return if the option isNone
+     */
+    unwrapOr(defaultValue) {
+        return this.isSome
+            ? this.unwrap()
+            : defaultValue;
+    }
+    /**
+     * @description Returns the value that the Option represents (if available) or defaultValue if none
+     * @param defaultValue The value to return if the option isNone
+     */
+    unwrapOrDefault() {
+        return this.isSome
+            ? this.unwrap()
+            : new this.#Type(this.registry);
+    }
+}

package/build-tsc-esm/base/Result.js

@@ -0,0 +1,63 @@
+import { Enum } from './Enum.js';
+/**
+ * @name Result
+ * @description
+ * A Result maps to the Rust Result type, that can either wrap a success or error value
+ */
+export class Result extends Enum {
+    constructor(registry, Ok, Err, value) {
+        // NOTE This is order-dependent, Ok (with index 0) needs to be first
+        // eslint-disable-next-line sort-keys
+        super(registry, { Ok, Err }, value);
+    }
+    static with(Types) {
+        return class extends Result {
+            constructor(registry, value) {
+                super(registry, Types.Ok, Types.Err, value);
+            }
+        };
+    }
+    /**
+     * @description Returns the wrapper Err value (if isErr)
+     */
+    get asErr() {
+        if (!this.isErr) {
+            throw new Error('Cannot extract Err value from Ok result, check isErr first');
+        }
+        return this.value;
+    }
+    /**
+     * @description Returns the wrapper Ok value (if isOk)
+     */
+    get asOk() {
+        if (!this.isOk) {
+            throw new Error('Cannot extract Ok value from Err result, check isOk first');
+        }
+        return this.value;
+    }
+    /**
+     * @description Checks if the Result has no value
+     */
+    get isEmpty() {
+        return this.isOk && this.value.isEmpty;
+    }
+    /**
+     * @description Checks if the Result wraps an Err value
+     */
+    get isErr() {
+        return !this.isOk;
+    }
+    /**
+     * @description Checks if the Result wraps an Ok value
+     */
+    get isOk() {
+        return this.index === 0;
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        const Types = this._toRawStruct();
+        return `Result<${Types.Ok},${Types.Err}>`;
+    }
+}

package/build-tsc-esm/base/Tuple.js

@@ -0,0 +1,110 @@
+import { identity, isFunction, isHex, isString, isU8a, stringify, u8aConcatStrict, u8aToU8a } from '@pezkuwi/util';
+import { AbstractArray } from '../abstract/Array.js';
+import { decodeU8a, mapToTypeMap, typesToConstructors, typeToConstructor } from '../utils/index.js';
+/** @internal */
+function decodeTuple(registry, result, value, Classes) {
+    if (Array.isArray(value)) {
+        const Types = Classes[0];
+        for (let i = 0, count = Types.length; i < count; i++) {
+            try {
+                const entry = value?.[i];
+                result[i] = entry instanceof Types[i]
+                    ? entry
+                    : new Types[i](registry, entry);
+            }
+            catch (error) {
+                throw new Error(`Tuple: failed on ${i}:: ${error.message}`);
+            }
+        }
+        return [result, 0];
+    }
+    else if (isHex(value)) {
+        return decodeU8a(registry, result, u8aToU8a(value), Classes);
+    }
+    else if (!value || !result.length) {
+        const Types = Classes[0];
+        for (let i = 0, count = Types.length; i < count; i++) {
+            result[i] = new Types[i](registry);
+        }
+        return [result, 0];
+    }
+    throw new Error(`Expected array input to Tuple decoding, found ${typeof value}: ${stringify(value)}`);
+}
+/**
+ * @name Tuple
+ * @description
+ * A Tuple defines an anonymous fixed-length array, where each element has its
+ * own type. It extends the base JS `Array` object.
+ */
+export class Tuple extends AbstractArray {
+    #Types;
+    constructor(registry, Types, value, { definition, setDefinition = identity } = {}) {
+        const Classes = definition || setDefinition(Array.isArray(Types)
+            ? [typesToConstructors(registry, Types), []]
+            : isFunction(Types) || isString(Types)
+                ? [[typeToConstructor(registry, Types)], []]
+                : mapToTypeMap(registry, Types));
+        super(registry, Classes[0].length);
+        this.initialU8aLength = (isU8a(value)
+            ? decodeU8a(registry, this, value, Classes)
+            : decodeTuple(registry, this, value, Classes))[1];
+        this.#Types = Classes;
+    }
+    static with(Types) {
+        let definition;
+        // eslint-disable-next-line no-return-assign
+        const setDefinition = (d) => definition = d;
+        return class extends Tuple {
+            constructor(registry, value) {
+                super(registry, Types, value, { definition, setDefinition });
+            }
+        };
+    }
+    /**
+     * @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 The types definition of the tuple
+     */
+    get Types() {
+        return this.#Types[1].length
+            ? this.#Types[1]
+            : this.#Types[0].map((T) => new T(this.registry).toRawType());
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return {
+            inner: this.inspectInner()
+        };
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        const types = this.#Types[0].map((T) => this.registry.getClassName(T) || new T(this.registry).toRawType());
+        return `(${types.join(',')})`;
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        // Overwrite the default toString representation of Array.
+        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) {
+        return u8aConcatStrict(this.toU8aInner(isBare));
+    }
+}

package/build-tsc-esm/base/UInt.js

@@ -0,0 +1,23 @@
+import { AbstractInt } from '../abstract/Int.js';
+/**
+ * @name UInt
+ * @description
+ * A generic unsigned integer codec. For Bizinikiwi all numbers are Little Endian encoded,
+ * this handles the encoding and decoding of those numbers. Upon construction
+ * the bitLength is provided and any additional use keeps the number to this
+ * length. This extends `BN`, so all methods available on a normal `BN` object
+ * is available here.
+ * @noInheritDoc
+ */
+export class UInt extends AbstractInt {
+    static with(bitLength, typeName) {
+        return class extends UInt {
+            constructor(registry, value) {
+                super(registry, value, bitLength);
+            }
+            toRawType() {
+                return typeName || super.toRawType();
+            }
+        };
+    }
+}

package/build-tsc-esm/base/Vec.js

@@ -0,0 +1,102 @@
+import { compactFromU8aLim, identity, isHex, isU8a, logger, stringify, u8aToU8a } from '@pezkuwi/util';
+import { AbstractArray } from '../abstract/Array.js';
+import { decodeU8aVec, typeToConstructor } from '../utils/index.js';
+const MAX_LENGTH = 512 * 1024;
+const l = logger('Vec');
+function decodeVecLength(value) {
+    if (Array.isArray(value)) {
+        return [value, value.length, 0];
+    }
+    else if (isU8a(value) || isHex(value)) {
+        const u8a = u8aToU8a(value);
+        const [startAt, length] = compactFromU8aLim(u8a);
+        if (length > MAX_LENGTH) {
+            throw new Error(`Vec length ${length.toString()} exceeds ${MAX_LENGTH}`);
+        }
+        return [u8a, length, startAt];
+    }
+    else if (!value) {
+        return [null, 0, 0];
+    }
+    throw new Error(`Expected array/hex input to Vec<*> decoding, found ${typeof value}: ${stringify(value)}`);
+}
+export function decodeVec(registry, result, value, startAt, Type) {
+    if (Array.isArray(value)) {
+        const count = result.length;
+        for (let i = 0; i < count; i++) {
+            // 26/08/2022 this is actually a false positive - after recent eslint upgdates
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            const entry = value[i];
+            try {
+                result[i] = entry instanceof Type
+                    ? entry
+                    : new Type(registry, entry);
+            }
+            catch (error) {
+                l.error(`Unable to decode on index ${i}`, error.message);
+                throw error;
+            }
+        }
+        return [0, 0];
+    }
+    else if (!value) {
+        return [0, 0];
+    }
+    // we don't need more checks, we already limited it via the length decoding
+    return decodeU8aVec(registry, result, u8aToU8a(value), startAt, Type);
+}
+/**
+ * @name Vec
+ * @description
+ * This manages codec arrays. Internally it keeps track of the length (as decoded) and allows
+ * construction with the passed `Type` in the constructor. It is an extension to Array, providing
+ * specific encoding/decoding on top of the base type.
+ */
+export class Vec extends AbstractArray {
+    #Type;
+    constructor(registry, Type, value = [], { definition, setDefinition = identity } = {}) {
+        const [decodeFrom, length, startAt] = decodeVecLength(value);
+        super(registry, length);
+        this.#Type = definition || setDefinition(typeToConstructor(registry, Type));
+        this.initialU8aLength = (isU8a(decodeFrom)
+            ? decodeU8aVec(registry, this, decodeFrom, startAt, this.#Type)
+            : decodeVec(registry, this, decodeFrom, startAt, this.#Type))[0];
+    }
+    static with(Type) {
+        let definition;
+        // eslint-disable-next-line no-return-assign
+        const setDefinition = (d) => (definition = d);
+        return class extends Vec {
+            constructor(registry, value) {
+                super(registry, Type, value, { definition, setDefinition });
+            }
+        };
+    }
+    /**
+     * @description The type for the items
+     */
+    get Type() {
+        return this.#Type.name;
+    }
+    /**
+     * @description Finds the index of the value in the array
+     */
+    indexOf(other) {
+        // convert type first, this removes overhead from the eq
+        const check = other instanceof this.#Type
+            ? other
+            : new this.#Type(this.registry, other);
+        for (let i = 0, count = this.length; i < count; i++) {
+            if (check.eq(this[i])) {
+                return i;
+            }
+        }
+        return -1;
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `Vec<${this.registry.getClassName(this.#Type) || new this.#Type(this.registry).toRawType()}>`;
+    }
+}

package/build-tsc-esm/base/VecAny.js

@@ -0,0 +1,17 @@
+import { AbstractArray } from '../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
+ */
+export class VecAny extends 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>';
+    }
+}

package/build-tsc-esm/base/VecFixed.js

@@ -0,0 +1,67 @@
+import { identity, isU8a, u8aConcatStrict } from '@pezkuwi/util';
+import { AbstractArray } from '../abstract/Array.js';
+import { decodeU8aVec, typeToConstructor } from '../utils/index.js';
+import { decodeVec } from './Vec.js';
+/**
+ * @name VecFixed
+ * @description
+ * This manages codec arrays of a fixed length
+ */
+export class VecFixed extends AbstractArray {
+    #Type;
+    constructor(registry, Type, length, value = [], { definition, setDefinition = identity } = {}) {
+        super(registry, length);
+        this.#Type = definition || setDefinition(typeToConstructor(registry, Type));
+        this.initialU8aLength = (isU8a(value)
+            ? decodeU8aVec(registry, this, value, 0, this.#Type)
+            : 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
+            ? u8aConcatStrict(encoded)
+            : new Uint8Array([]);
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `[${this.Type};${this.length}]`;
+    }
+}