@pezkuwi/types-codec 16.5.5 → 16.5.6

package/cjs/extended/WrapperKeepOpaque.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WrapperKeepOpaque = void 0;
+const util_1 = require("@pezkuwi/util");
+const Raw_js_1 = require("../native/Raw.js");
+const index_js_1 = require("../utils/index.js");
+const Bytes_js_1 = require("./Bytes.js");
+function decodeRaw(registry, typeName, value) {
+    const Type = (0, index_js_1.typeToConstructor)(registry, typeName);
+    if ((0, util_1.isU8a)(value) || (0, util_1.isHex)(value)) {
+        try {
+            const [, u8a] = (0, util_1.isHex)(value)
+                ? [0, (0, util_1.u8aToU8a)(value)]
+                : (value instanceof Raw_js_1.Raw)
+                    ? [0, value.subarray()]
+                    : (0, util_1.compactStripLength)(value);
+            return [Type, new Type(registry, u8a), value];
+        }
+        catch {
+            return [Type, null, value];
+        }
+    }
+    const instance = new Type(registry, value);
+    return [Type, instance, (0, util_1.compactAddLength)(instance.toU8a())];
+}
+class WrapperKeepOpaque extends Bytes_js_1.Bytes {
+    #Type;
+    #decoded;
+    #opaqueName;
+    constructor(registry, typeName, value, { opaqueName = 'WrapperKeepOpaque' } = {}) {
+        const [Type, decoded, u8a] = decodeRaw(registry, typeName, value);
+        super(registry, u8a);
+        this.#Type = Type;
+        this.#decoded = decoded;
+        this.#opaqueName = opaqueName;
+    }
+    static with(Type) {
+        return class extends WrapperKeepOpaque {
+            constructor(registry, value) {
+                super(registry, Type, value);
+            }
+        };
+    }
+    /**
+     * @description Checks if the wrapper is decodable
+     */
+    get isDecoded() {
+        return !!this.#decoded;
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return this.#decoded
+            ? {
+                inner: [this.#decoded.inspect()],
+                outer: [(0, util_1.compactToU8a)(this.length)]
+            }
+            : {
+                outer: [(0, util_1.compactToU8a)(this.length), this.toU8a(true)]
+            };
+    }
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExtended, disableAscii) {
+        return this.#decoded
+            ? this.#decoded.toHuman(isExtended, disableAscii)
+            : super.toHuman(isExtended, disableAscii);
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii) {
+        return this.#decoded
+            ? this.#decoded.toPrimitive(disableAscii)
+            : super.toPrimitive(disableAscii);
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `${this.#opaqueName}<${this.registry.getClassName(this.#Type) || (this.#decoded ? this.#decoded.toRawType() : new this.#Type(this.registry).toRawType())}>`;
+    }
+    /**
+     * @description Converts the Object to to a string (either decoded or bytes)
+     */
+    toString() {
+        return this.#decoded
+            ? this.#decoded.toString()
+            : super.toString();
+    }
+    /**
+     * @description Returns the decoded that the WrapperKeepOpaque represents (if available), throws if non-decodable
+     */
+    unwrap() {
+        if (!this.#decoded) {
+            throw new Error(`${this.#opaqueName}: unwrapping an undecodable value`);
+        }
+        return this.#decoded;
+    }
+}
+exports.WrapperKeepOpaque = WrapperKeepOpaque;

package/cjs/extended/WrapperOpaque.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WrapperOpaque = void 0;
+const WrapperKeepOpaque_js_1 = require("./WrapperKeepOpaque.js");
+class WrapperOpaque extends WrapperKeepOpaque_js_1.WrapperKeepOpaque {
+    constructor(registry, typeName, value) {
+        super(registry, typeName, value, { opaqueName: 'WrapperOpaque' });
+    }
+    static with(Type) {
+        return class extends WrapperOpaque {
+            constructor(registry, value) {
+                super(registry, Type, value);
+            }
+        };
+    }
+    /**
+     * @description The inner value for this wrapper, in all cases it _should_ be decodable (unlike KeepOpaque)
+     */
+    get inner() {
+        return this.unwrap();
+    }
+}
+exports.WrapperOpaque = WrapperOpaque;

package/cjs/extended/index.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WrapperOpaque = exports.WrapperKeepOpaque = exports.U8aFixed = exports.Type = exports.RangeInclusive = exports.Range = exports.OptionBool = exports.Map = exports.CodecMap = exports.Linkage = exports.HashMap = exports.Bytes = exports.BTreeSet = exports.BTreeMap = exports.BitVec = void 0;
+var BitVec_js_1 = require("./BitVec.js");
+Object.defineProperty(exports, "BitVec", { enumerable: true, get: function () { return BitVec_js_1.BitVec; } });
+var BTreeMap_js_1 = require("./BTreeMap.js");
+Object.defineProperty(exports, "BTreeMap", { enumerable: true, get: function () { return BTreeMap_js_1.BTreeMap; } });
+var BTreeSet_js_1 = require("./BTreeSet.js");
+Object.defineProperty(exports, "BTreeSet", { enumerable: true, get: function () { return BTreeSet_js_1.BTreeSet; } });
+var Bytes_js_1 = require("./Bytes.js");
+Object.defineProperty(exports, "Bytes", { enumerable: true, get: function () { return Bytes_js_1.Bytes; } });
+var HashMap_js_1 = require("./HashMap.js");
+Object.defineProperty(exports, "HashMap", { enumerable: true, get: function () { return HashMap_js_1.HashMap; } });
+var Linkage_js_1 = require("./Linkage.js");
+Object.defineProperty(exports, "Linkage", { enumerable: true, get: function () { return Linkage_js_1.Linkage; } });
+var Map_js_1 = require("./Map.js");
+Object.defineProperty(exports, "CodecMap", { enumerable: true, get: function () { return Map_js_1.CodecMap; } });
+Object.defineProperty(exports, "Map", { enumerable: true, get: function () { return Map_js_1.CodecMap; } });
+var OptionBool_js_1 = require("./OptionBool.js");
+Object.defineProperty(exports, "OptionBool", { enumerable: true, get: function () { return OptionBool_js_1.OptionBool; } });
+var Range_js_1 = require("./Range.js");
+Object.defineProperty(exports, "Range", { enumerable: true, get: function () { return Range_js_1.Range; } });
+var RangeInclusive_js_1 = require("./RangeInclusive.js");
+Object.defineProperty(exports, "RangeInclusive", { enumerable: true, get: function () { return RangeInclusive_js_1.RangeInclusive; } });
+var Type_js_1 = require("./Type.js");
+Object.defineProperty(exports, "Type", { enumerable: true, get: function () { return Type_js_1.Type; } });
+var U8aFixed_js_1 = require("./U8aFixed.js");
+Object.defineProperty(exports, "U8aFixed", { enumerable: true, get: function () { return U8aFixed_js_1.U8aFixed; } });
+var WrapperKeepOpaque_js_1 = require("./WrapperKeepOpaque.js");
+Object.defineProperty(exports, "WrapperKeepOpaque", { enumerable: true, get: function () { return WrapperKeepOpaque_js_1.WrapperKeepOpaque; } });
+var WrapperOpaque_js_1 = require("./WrapperOpaque.js");
+Object.defineProperty(exports, "WrapperOpaque", { enumerable: true, get: function () { return WrapperOpaque_js_1.WrapperOpaque; } });

package/cjs/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+require("./packageDetect.js");
+tslib_1.__exportStar(require("./bundle.js"), exports);

package/cjs/native/Bool.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bool = void 0;
+const util_1 = require("@pezkuwi/util");
+/**
+ * @name bool
+ * @description
+ * Representation for a boolean value in the system. It extends the base JS `Boolean` class
+ * @noInheritDoc
+ */
+class bool extends Boolean {
+    registry;
+    createdAtHash;
+    initialU8aLength = 1;
+    isStorageFallback;
+    constructor(registry, value = false) {
+        super((0, util_1.isU8a)(value)
+            ? value[0] === 1
+            : value instanceof Boolean
+                ? value.valueOf()
+                : !!value);
+        this.registry = registry;
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        return 1 | 0;
+    }
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash() {
+        return this.registry.hash(this.toU8a());
+    }
+    /**
+     * @description Checks if the value is an empty value (true when it wraps false/default)
+     */
+    get isEmpty() {
+        return this.isFalse;
+    }
+    /**
+     * @description Checks if the value is an empty value (always false)
+     */
+    get isFalse() {
+        return !this.isTrue;
+    }
+    /**
+     * @description Checks if the value is an empty value (always false)
+     */
+    get isTrue() {
+        return this.valueOf();
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        return this.valueOf() === (other instanceof Boolean
+            ? other.valueOf()
+            : other);
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return {
+            outer: [this.toU8a()]
+        };
+    }
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    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() {
+        return this.toJSON();
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON() {
+        return this.valueOf();
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive() {
+        return this.toJSON();
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'bool';
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        return this.toJSON().toString();
+    }
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     */
+    toU8a(_isBare) {
+        return new Uint8Array([this.valueOf() ? 1 : 0]);
+    }
+}
+exports.bool = bool;

package/cjs/native/Date.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CodecDate = void 0;
+const util_1 = require("@pezkuwi/util");
+const BITLENGTH = 64;
+const U8A_OPTS = { bitLength: BITLENGTH, isLe: true };
+function decodeDate(value) {
+    if ((0, util_1.isU8a)(value)) {
+        value = (0, util_1.u8aToBn)(value.subarray(0, BITLENGTH / 8));
+    }
+    else if (value instanceof Date) {
+        return value;
+    }
+    else if ((0, util_1.isString)(value)) {
+        value = new util_1.BN(value.toString(), 10, 'le');
+    }
+    return new Date((0, util_1.bnToBn)(value).toNumber() * 1000);
+}
+/**
+ * @name Date
+ * @description
+ * A wrapper around seconds/timestamps. Internally the representation only has
+ * second precicion (aligning with Rust), so any numbers passed an/out are always
+ * per-second. For any encoding/decoding the 1000 multiplier would be applied to
+ * get it in line with JavaScript formats. It extends the base JS `Date` object
+ * and has all the methods available that are applicable to any `Date`
+ * @noInheritDoc
+ */
+class CodecDate extends Date {
+    registry;
+    createdAtHash;
+    initialU8aLength = BITLENGTH / 8;
+    isStorageFallback;
+    constructor(registry, value = 0) {
+        super(decodeDate(value));
+        this.registry = registry;
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        return BITLENGTH / 8;
+    }
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash() {
+        return this.registry.hash(this.toU8a());
+    }
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty() {
+        return this.getTime() === 0;
+    }
+    /**
+     * @description Returns the number of bits in the value
+     */
+    bitLength() {
+        return BITLENGTH;
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        return decodeDate(other).getTime() === this.getTime();
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return {
+            outer: [this.toU8a()]
+        };
+    }
+    /**
+     * @description Returns a BigInt representation of the number
+     */
+    toBigInt() {
+        return BigInt(this.toNumber());
+    }
+    /**
+     * @description Returns the BN representation of the timestamp
+     */
+    toBn() {
+        return new util_1.BN(this.toNumber());
+    }
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(isLe = false) {
+        return (0, util_1.bnToHex)(this.toBn(), {
+            bitLength: BITLENGTH,
+            isLe,
+            isNegative: false
+        });
+    }
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman() {
+        return this.toISOString();
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON() {
+        // FIXME Return type should be number, but conflicts with Date.toJSON()
+        // which returns string
+        return this.toNumber();
+    }
+    /**
+     * @description Returns the number representation for the timestamp
+     */
+    toNumber() {
+        return Math.ceil(this.getTime() / 1000);
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive() {
+        return this.toNumber();
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'Moment';
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        // only included here since we do not inherit docs
+        return super.toString();
+    }
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     */
+    toU8a(_isBare) {
+        return (0, util_1.bnToU8a)(this.toNumber(), U8A_OPTS);
+    }
+}
+exports.CodecDate = CodecDate;

package/cjs/native/Float.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Float = void 0;
+const util_1 = require("@pezkuwi/util");
+/**
+ * @name Float
+ * @description
+ * A Codec wrapper for F32 & F64 values. You generally don't want to be using
+ * f32/f64 in your runtime, operations on fixed points numbers are preferable. This class
+ * was explicitly added since scale-codec has a flag that enables this and it is available
+ * in some eth_* RPCs
+ */
+class Float extends Number {
+    encodedLength;
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    #bitLength;
+    constructor(registry, value, { bitLength = 32 } = {}) {
+        super((0, util_1.isU8a)(value) || (0, util_1.isHex)(value)
+            ? value.length === 0
+                ? 0
+                : (0, util_1.u8aToFloat)((0, util_1.u8aToU8a)(value), { bitLength })
+            : (value || 0));
+        this.#bitLength = bitLength;
+        this.encodedLength = bitLength / 8;
+        this.initialU8aLength = this.encodedLength;
+        this.registry = registry;
+    }
+    static with(bitLength) {
+        return class extends Float {
+            constructor(registry, value) {
+                super(registry, value, { bitLength });
+            }
+        };
+    }
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash() {
+        return this.registry.hash(this.toU8a());
+    }
+    /**
+     * @description Returns true if the type wraps an empty/default all-0 value
+     */
+    get isEmpty() {
+        return this.valueOf() === 0;
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        return this.valueOf() === Number(other);
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return {
+            outer: [this.toU8a()]
+        };
+    }
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    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() {
+        return this.toString();
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON() {
+        // Not sure if this is actually a hex or a string value
+        // (would need to check against RPCs to see the result here)
+        return this.toHex();
+    }
+    /**
+     * @description Returns the number representation (Same as valueOf)
+     */
+    toNumber() {
+        return this.valueOf();
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive() {
+        return this.toNumber();
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `f${this.#bitLength}`;
+    }
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     */
+    toU8a(_isBare) {
+        return (0, util_1.floatToU8a)(this, {
+            bitLength: this.#bitLength
+        });
+    }
+}
+exports.Float = Float;

package/cjs/native/Json.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Json = void 0;
+const util_1 = require("@pezkuwi/util");
+const index_js_1 = require("../utils/index.js");
+/** @internal */
+function decodeJson(value) {
+    return Object.entries(value || {});
+}
+/**
+ * @name Json
+ * @description
+ * Wraps the a JSON structure retrieve via RPC. It extends the standard JS Map with. While it
+ * implements a Codec, it is limited in that it can only be used with input objects via RPC,
+ * i.e. no hex decoding. Unlike a struct, this waps a JSON object with unknown keys
+ * @noInheritDoc
+ */
+class Json extends Map {
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    constructor(registry, value) {
+        const decoded = decodeJson(value);
+        super(decoded);
+        this.registry = registry;
+        (0, util_1.objectProperties)(this, decoded.map(([k]) => k), (k) => this.get(k));
+    }
+    /**
+     * @description Always 0, never encodes as a Uint8Array
+     */
+    get encodedLength() {
+        return 0 | 0;
+    }
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash() {
+        return this.registry.hash(this.toU8a());
+    }
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty() {
+        return [...this.keys()].length === 0;
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        return (0, index_js_1.compareMap)(this, other);
+    }
+    /**
+     * @description Returns a typed value from the internal map
+     */
+    getT(key) {
+        return this.get(key);
+    }
+    /**
+     * @description Unimplemented, will throw
+     */
+    inspect() {
+        throw new Error('Unimplemented');
+    }
+    /**
+     * @description Unimplemented, will throw
+     */
+    toHex() {
+        throw new Error('Unimplemented');
+    }
+    /**
+     * @description Converts the Object to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman() {
+        return [...this.entries()].reduce((json, [key, value]) => {
+            json[key] = (0, util_1.isFunction)(value?.toHuman)
+                ? value.toHuman()
+                : value;
+            return json;
+        }, {});
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON() {
+        return [...this.entries()].reduce((json, [key, value]) => {
+            json[key] = value;
+            return json;
+        }, {});
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii) {
+        return [...this.entries()].reduce((json, [key, value]) => {
+            json[key] = (0, util_1.isFunction)(value.toPrimitive)
+                ? value.toPrimitive(disableAscii)
+                : value;
+            return json;
+        }, {});
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'Json';
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        return (0, util_1.stringify)(this.toJSON());
+    }
+    /**
+     * @description Unimplemented, will throw
+     */
+    toU8a(_isBare) {
+        throw new Error('Unimplemented');
+    }
+}
+exports.Json = Json;