@pezkuwi/types-codec 16.5.6 → 16.5.8

package/build-tsc-esm/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-tsc-esm/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-tsc-esm/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-tsc-esm/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-tsc-esm/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}]`;
+    }
+}

package/build-tsc-esm/extended/WrapperKeepOpaque.js

@@ -0,0 +1,99 @@
+import { compactAddLength, compactStripLength, compactToU8a, isHex, isU8a, u8aToU8a } from '@pezkuwi/util';
+import { Raw } from '../native/Raw.js';
+import { typeToConstructor } from '../utils/index.js';
+import { Bytes } from './Bytes.js';
+function decodeRaw(registry, typeName, value) {
+    const Type = typeToConstructor(registry, typeName);
+    if (isU8a(value) || isHex(value)) {
+        try {
+            const [, u8a] = isHex(value)
+                ? [0, u8aToU8a(value)]
+                : (value instanceof Raw)
+                    ? [0, value.subarray()]
+                    : compactStripLength(value);
+            return [Type, new Type(registry, u8a), value];
+        }
+        catch {
+            return [Type, null, value];
+        }
+    }
+    const instance = new Type(registry, value);
+    return [Type, instance, compactAddLength(instance.toU8a())];
+}
+export class WrapperKeepOpaque extends 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: [compactToU8a(this.length)]
+            }
+            : {
+                outer: [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;
+    }
+}

package/build-tsc-esm/extended/WrapperOpaque.js

@@ -0,0 +1,19 @@
+import { WrapperKeepOpaque } from './WrapperKeepOpaque.js';
+export class WrapperOpaque extends 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();
+    }
+}

package/build-tsc-esm/extended/index.js

@@ -0,0 +1,14 @@
+export { BitVec } from './BitVec.js';
+export { BTreeMap } from './BTreeMap.js';
+export { BTreeSet } from './BTreeSet.js';
+export { Bytes } from './Bytes.js';
+export { HashMap } from './HashMap.js';
+export { Linkage } from './Linkage.js';
+export { CodecMap, CodecMap as Map } from './Map.js';
+export { OptionBool } from './OptionBool.js';
+export { Range } from './Range.js';
+export { RangeInclusive } from './RangeInclusive.js';
+export { Type } from './Type.js';
+export { U8aFixed } from './U8aFixed.js';
+export { WrapperKeepOpaque } from './WrapperKeepOpaque.js';
+export { WrapperOpaque } from './WrapperOpaque.js';

package/build-tsc-esm/index.js

@@ -0,0 +1,2 @@
+import './packageDetect.js';
+export * from './bundle.js';

package/build-tsc-esm/native/Bool.js

@@ -0,0 +1,109 @@
+import { isU8a, u8aToHex } from '@pezkuwi/util';
+/**
+ * @name bool
+ * @description
+ * Representation for a boolean value in the system. It extends the base JS `Boolean` class
+ * @noInheritDoc
+ */
+export class bool extends Boolean {
+    registry;
+    createdAtHash;
+    initialU8aLength = 1;
+    isStorageFallback;
+    constructor(registry, value = false) {
+        super(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 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]);
+    }
+}

package/build-tsc-esm/native/Date.js

@@ -0,0 +1,140 @@
+import { BN, bnToBn, bnToHex, bnToU8a, isString, isU8a, u8aToBn } from '@pezkuwi/util';
+const BITLENGTH = 64;
+const U8A_OPTS = { bitLength: BITLENGTH, isLe: true };
+function decodeDate(value) {
+    if (isU8a(value)) {
+        value = u8aToBn(value.subarray(0, BITLENGTH / 8));
+    }
+    else if (value instanceof Date) {
+        return value;
+    }
+    else if (isString(value)) {
+        value = new BN(value.toString(), 10, 'le');
+    }
+    return new Date(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
+ */
+export 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 BN(this.toNumber());
+    }
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(isLe = false) {
+        return 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 bnToU8a(this.toNumber(), U8A_OPTS);
+    }
+}

package/build-tsc-esm/native/Float.js

@@ -0,0 +1,107 @@
+import { floatToU8a, isHex, isU8a, u8aToFloat, u8aToHex, u8aToU8a } from '@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
+ */
+export class Float extends Number {
+    encodedLength;
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    #bitLength;
+    constructor(registry, value, { bitLength = 32 } = {}) {
+        super(isU8a(value) || isHex(value)
+            ? value.length === 0
+                ? 0
+                : u8aToFloat(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 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 floatToU8a(this, {
+            bitLength: this.#bitLength
+        });
+    }
+}