@pezkuwi/types-codec 16.5.6 → 16.5.8

package/build/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/build/cjs/native/Float.d.ts

@@ -0,0 +1,68 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyFloat, CodecClass, IFloat, Inspect, IU8a, Registry } from '../types/index.js';
+interface Options {
+    bitLength?: 32 | 64;
+}
+/**
+ * @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
+ */
+export declare class Float extends Number implements IFloat {
+    #private;
+    readonly encodedLength: number;
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, value?: AnyFloat, { bitLength }?: Options);
+    static with(bitLength: 32 | 64): CodecClass<Float>;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Returns true if the type wraps an empty/default all-0 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
+     */
+    toHex(): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(): string;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): string;
+    /**
+     * @description Returns the number representation (Same as valueOf)
+     */
+    toNumber(): number;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): number;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     */
+    toU8a(_isBare?: boolean): Uint8Array;
+}
+export {};

package/build/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/build/cjs/native/Json.d.ts

@@ -0,0 +1,69 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, Codec, Inspect, IU8a, Registry } from '../types/index.js';
+/**
+ * @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
+ */
+export declare class Json extends Map<string, any> implements Codec {
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, value?: Record<string, unknown> | null);
+    /**
+     * @description Always 0, never encodes as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    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 typed value from the internal map
+     */
+    getT<T>(key: string): T;
+    /**
+     * @description Unimplemented, will throw
+     */
+    inspect(): Inspect;
+    /**
+     * @description Unimplemented, will throw
+     */
+    toHex(): HexString;
+    /**
+     * @description Converts the Object to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(): 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): Record<string, AnyJson>;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString(): string;
+    /**
+     * @description Unimplemented, will throw
+     */
+    toU8a(_isBare?: boolean): Uint8Array;
+}

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

package/build/cjs/native/Raw.d.ts

@@ -0,0 +1,87 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, AnyU8a, Inspect, IU8a, Registry } from '../types/index.js';
+/**
+ * @name Raw
+ * @description
+ * A basic wrapper around Uint8Array, with no frills and no fuss. It does differ
+ * from other implementations where it will consume the full Uint8Array as passed to it.
+ * As such it is meant to be subclassed where the wrapper takes care of the
+ * actual lengths instead of used directly.
+ * @noInheritDoc
+ */
+export declare class Raw extends Uint8Array implements IU8a {
+    readonly registry: Registry;
+    createdAtHash?: IU8a | undefined;
+    initialU8aLength?: number | undefined;
+    isStorageFallback?: boolean;
+    /**
+     * @description This ensures that operators such as clice, filter, map, etc. return
+     * new Array instances (without this we need to apply overrides)
+     */
+    static get [Symbol.species](): typeof Uint8Array;
+    constructor(registry: Registry, value?: AnyU8a, initialU8aLength?: number);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Returns true if the wrapped value contains only ASCII printable characters
+     */
+    get isAscii(): boolean;
+    /**
+     * @description Returns true if the type wraps an empty/default all-0 value
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Returns true if the wrapped value contains only utf8 characters
+     */
+    get isUtf8(): boolean;
+    /**
+     * @description Returns the number of bits in the value
+     */
+    bitLength(): number;
+    /**
+     * @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
+     */
+    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(): string;
+    /**
+     * @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
+     */
+    toU8a(_isBare?: boolean): Uint8Array;
+    /**
+     * @description Returns the wrapped data as a UTF-8 string
+     */
+    toUtf8(): string;
+}