@pezkuwi/types-codec 16.5.5 → 16.5.8

package/abstract/Int.d.ts

@@ -0,0 +1,80 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyNumber, Inspect, INumber, IU8a, Registry, UIntBitLength } from '../types/index.js';
+import { BN } from '@pezkuwi/util';
+export declare const DEFAULT_UINT_BITS = 64;
+/**
+ * @name AbstractInt
+ * @ignore
+ * @noInheritDoc
+ */
+export declare abstract class AbstractInt extends BN implements INumber {
+    #private;
+    readonly registry: Registry;
+    readonly encodedLength: number;
+    readonly isUnsigned: boolean;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, value?: AnyNumber | null, bitLength?: UIntBitLength, isSigned?: boolean);
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Checks if the value is a zero value (align elsewhere)
+     */
+    get isEmpty(): 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 True if this value is the max of the type
+     */
+    isMax(): boolean;
+    /**
+     * @description Returns a BigInt representation of the number
+     */
+    toBigInt(): bigint;
+    /**
+     * @description Returns the BN representation of the number. (Compatibility)
+     */
+    toBn(): BN;
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(isLe?: boolean): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(_isExpanded?: boolean): string;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(onlyHex?: boolean): any;
+    /**
+     * @description Returns the value in a primitive form, either number when <= 52 bits, or string otherwise
+     */
+    toPrimitive(): number | string;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Returns the string representation of the value
+     * @param base The base to use for the conversion
+     */
+    toString(base?: number): string;
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     */
+    toU8a(_isBare?: boolean): Uint8Array;
+}

package/abstract/Int.js

@@ -0,0 +1,226 @@
+import { BN, BN_BILLION, BN_HUNDRED, BN_MILLION, BN_QUINTILL, bnToBn, bnToHex, bnToU8a, formatBalance, formatNumber, hexToBn, isBigInt, isBn, isFunction, isHex, isNumber, isObject, isString, isU8a, u8aToBn, u8aToNumber } from '@pezkuwi/util';
+export const DEFAULT_UINT_BITS = 64;
+const MAX_NUMBER_BITS = 52;
+const MUL_P = new BN(1_00_00);
+const FORMATTERS = [
+    ['Perquintill', BN_QUINTILL],
+    ['Perbill', BN_BILLION],
+    ['Permill', BN_MILLION],
+    ['Percent', BN_HUNDRED]
+];
+function isToBn(value) {
+    return isFunction(value.toBn);
+}
+function toPercentage(value, divisor) {
+    return `${(value.mul(MUL_P).div(divisor).toNumber() / 100).toFixed(2)}%`;
+}
+/** @internal */
+function decodeAbstractInt(value, isNegative) {
+    if (isNumber(value)) {
+        if (!Number.isInteger(value) || value > Number.MAX_SAFE_INTEGER || value < Number.MIN_SAFE_INTEGER) {
+            throw new Error('Number needs to be an integer <= Number.MAX_SAFE_INTEGER, i.e. 2 ^ 53 - 1');
+        }
+        return value;
+    }
+    else if (isString(value)) {
+        if (isHex(value, -1, true)) {
+            return hexToBn(value, { isLe: false, isNegative }).toString();
+        }
+        if (value.includes('.') || value.includes(',') || value.includes('e')) {
+            throw new Error('String should not contain decimal points or scientific notation');
+        }
+        return value;
+    }
+    else if (isBn(value) || isBigInt(value)) {
+        return value.toString();
+    }
+    else if (isObject(value)) {
+        if (isToBn(value)) {
+            return value.toBn().toString();
+        }
+        // Allow the construction from an object with a single top-level key. This means that
+        // single key objects can be treated equivalently to numbers, assuming they meet the
+        // specific requirements. (This is useful in Weights 1.5 where Objects are compact)
+        const keys = Object.keys(value);
+        if (keys.length !== 1) {
+            throw new Error('Unable to construct number from multi-key object');
+        }
+        return decodeAbstractInt(value[keys[0]], isNegative);
+    }
+    else if (!value) {
+        return 0;
+    }
+    throw new Error(`Unable to create BN from unknown type ${typeof value}`);
+}
+/**
+ * @name AbstractInt
+ * @ignore
+ * @noInheritDoc
+ */
+export class AbstractInt extends BN {
+    registry;
+    encodedLength;
+    isUnsigned;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    #bitLength;
+    constructor(registry, value = 0, bitLength = DEFAULT_UINT_BITS, isSigned = false) {
+        // Construct via a string/number, which will be passed in the BN constructor.
+        // It would be ideal to actually return a BN, but there is an issue:
+        // https://github.com/indutny/bn.js/issues/206
+        super(
+        // shortcut isU8a as used in SCALE decoding
+        isU8a(value)
+            ? bitLength <= 48
+                ? u8aToNumber(value.subarray(0, bitLength / 8), { isNegative: isSigned })
+                : u8aToBn(value.subarray(0, bitLength / 8), { isLe: true, isNegative: isSigned }).toString()
+            : decodeAbstractInt(value, isSigned));
+        this.registry = registry;
+        this.#bitLength = bitLength;
+        this.encodedLength = this.#bitLength / 8;
+        this.initialU8aLength = this.#bitLength / 8;
+        this.isUnsigned = !isSigned;
+        const isNegative = this.isNeg();
+        const maxBits = bitLength - (isSigned && !isNegative ? 1 : 0);
+        if (isNegative && !isSigned) {
+            throw new Error(`${this.toRawType()}: Negative number passed to unsigned type`);
+        }
+        else if (super.bitLength() > maxBits) {
+            throw new Error(`${this.toRawType()}: Input too large. Found input with ${super.bitLength()} bits, expected ${maxBits}`);
+        }
+    }
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash() {
+        return this.registry.hash(this.toU8a());
+    }
+    /**
+     * @description Checks if the value is a zero value (align elsewhere)
+     */
+    get isEmpty() {
+        return this.isZero();
+    }
+    /**
+     * @description Returns the number of bits in the value
+     */
+    bitLength() {
+        return this.#bitLength;
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    eq(other) {
+        // Here we are actually overriding the built-in .eq to take care of both
+        // number and BN inputs (no `.eqn` needed) - numbers will be converted
+        return super.eq(isHex(other)
+            ? hexToBn(other.toString(), { isLe: false, isNegative: !this.isUnsigned })
+            : bnToBn(other));
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return {
+            outer: [this.toU8a()]
+        };
+    }
+    /**
+     * @description True if this value is the max of the type
+     */
+    isMax() {
+        const u8a = this.toU8a().filter((b) => b === 0xff);
+        return u8a.length === (this.#bitLength / 8);
+    }
+    /**
+     * @description Returns a BigInt representation of the number
+     */
+    toBigInt() {
+        return BigInt(this.toString());
+    }
+    /**
+     * @description Returns the BN representation of the number. (Compatibility)
+     */
+    toBn() {
+        return this;
+    }
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(isLe = false) {
+        // For display/JSON, this is BE, for compare, use isLe
+        return bnToHex(this, {
+            bitLength: this.bitLength(),
+            isLe,
+            isNegative: !this.isUnsigned
+        });
+    }
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(_isExpanded) {
+        const rawType = this.toRawType();
+        if (rawType === 'Balance') {
+            return this.isMax()
+                ? 'everything'
+                // FIXME In the case of multiples we need some way of detecting which instance this belongs
+                // to. as it stands we will always format (incorrectly) against the first token defined
+                : formatBalance(this, { decimals: this.registry.chainDecimals[0], withSi: true, withUnit: this.registry.chainTokens[0] });
+        }
+        const [, divisor] = FORMATTERS.find(([type]) => type === rawType) || [];
+        return divisor
+            ? toPercentage(this, divisor)
+            : formatNumber(this);
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(onlyHex = false) {
+        // FIXME this return type should by string | number, however BN returns string
+        // Options here are
+        //   - super.bitLength() - the actual used bits, use hex when close to MAX_SAFE_INTEGER
+        //   - this.#bitLength - the max used bits, use hex when larger than native Rust type
+        return onlyHex || (this.#bitLength > 128) || (super.bitLength() > MAX_NUMBER_BITS)
+            ? this.toHex()
+            : this.toNumber();
+    }
+    /**
+     * @description Returns the value in a primitive form, either number when <= 52 bits, or string otherwise
+     */
+    toPrimitive() {
+        return super.bitLength() > MAX_NUMBER_BITS
+            ? this.toString()
+            : this.toNumber();
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        // NOTE In the case of balances, which have a special meaning on the UI
+        // and can be interpreted differently, return a specific value for it so
+        // underlying it always matches (no matter which length it actually is)
+        return this instanceof this.registry.createClassUnsafe('Balance')
+            ? 'Balance'
+            : `${this.isUnsigned ? 'u' : 'i'}${this.bitLength()}`;
+    }
+    /**
+     * @description Returns the string representation of the value
+     * @param base The base to use for the conversion
+     */
+    toString(base) {
+        // only included here since we do not inherit docs
+        return super.toString(base);
+    }
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     */
+    toU8a(_isBare) {
+        return bnToU8a(this, {
+            bitLength: this.bitLength(),
+            isLe: true,
+            isNegative: !this.isUnsigned
+        });
+    }
+}

package/abstract/Object.d.ts

@@ -0,0 +1,67 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, BareOpts, CodecObject, Inspect, IU8a, Registry, ToString } from '../types/index.js';
+/**
+ * @name Object
+ * @description A type extends the Base class, when it holds a value
+ */
+export declare abstract class AbstractObject<T extends ToString> implements CodecObject<T> {
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number | undefined;
+    isStorageFallback?: boolean;
+    readonly $: T;
+    protected constructor(registry: Registry, value: T, 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 Checks if the value is an empty value
+     */
+    abstract get isEmpty(): boolean;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    abstract eq(other?: unknown): boolean;
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    abstract inspect(): Inspect;
+    /**
+     * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+     */
+    abstract toHex(isLe?: boolean): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    abstract toHuman(isExtended?: boolean, disableAscii?: boolean): AnyJson;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    abstract toJSON(): AnyJson;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    abstract 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)
+     */
+    abstract toU8a(isBare?: BareOpts): Uint8Array;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    abstract toRawType(): string;
+    /**
+     * @description Return the internal value (JS-aligned, same result as $)
+     */
+    valueOf(): T;
+}

package/abstract/Object.js

@@ -0,0 +1,40 @@
+/**
+ * @name Object
+ * @description A type extends the Base class, when it holds a value
+ */
+export class AbstractObject {
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    $;
+    constructor(registry, value, initialU8aLength) {
+        this.$ = value;
+        this.initialU8aLength = initialU8aLength;
+        this.registry = registry;
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        return this.toU8a().length;
+    }
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash() {
+        return this.registry.hash(this.toU8a());
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        return this.$.toString();
+    }
+    /**
+     * @description Return the internal value (JS-aligned, same result as $)
+     */
+    valueOf() {
+        return this.$;
+    }
+}

package/abstract/index.d.ts

@@ -0,0 +1,3 @@
+export { AbstractArray } from './Array.js';
+export { AbstractBase } from './Base.js';
+export { AbstractInt } from './Int.js';

package/abstract/index.js

@@ -0,0 +1,3 @@
+export { AbstractArray } from './Array.js';
+export { AbstractBase } from './Base.js';
+export { AbstractInt } from './Int.js';

package/base/Compact.d.ts

@@ -0,0 +1,88 @@
+import type { BN } from '@pezkuwi/util';
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, AnyNumber, CodecClass, DefinitionSetter, ICompact, Inspect, INumber, IU8a, Registry } from '../types/index.js';
+/**
+ * @name Compact
+ * @description
+ * A compact length-encoding codec wrapper. It performs the same function as Length, however
+ * differs in that it uses a variable number of bytes to do the actual encoding. This is mostly
+ * used by other types to add length-prefixed encoding, or in the case of wrapped types, taking
+ * a number and making the compact representation thereof
+ */
+export declare class Compact<T extends INumber> implements ICompact<T> {
+    #private;
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, Type: CodecClass<T> | string, value?: Compact<T> | AnyNumber, { definition, setDefinition }?: DefinitionSetter<CodecClass<T>>);
+    static with<O extends INumber>(Type: CodecClass<O> | string): CodecClass<Compact<O>>;
+    /**
+     * @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 Checks if the value is an empty value
+     */
+    get isEmpty(): 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 BigInt representation of the number
+     */
+    toBigInt(): bigint;
+    /**
+     * @description Returns the BN representation of the number
+     */
+    toBn(): BN;
+    /**
+     * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+     */
+    toHex(isLe?: boolean): 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 number representation for the value
+     */
+    toNumber(): number;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii?: boolean): string | number;
+    /**
+     * @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 embedded [[UInt]] or [[Moment]] value
+     */
+    unwrap(): T;
+}

package/base/Compact.js

@@ -0,0 +1,159 @@
+import { compactFromU8a, compactFromU8aLim, compactToU8a, identity, isU8a } from '@pezkuwi/util';
+import { typeToConstructor } from '../utils/index.js';
+function decodeCompact(registry, Type, value) {
+    if (isU8a(value)) {
+        const [decodedLength, bn] = (value[0] & 0b11) < 0b11
+            ? compactFromU8aLim(value)
+            : compactFromU8a(value);
+        return [new Type(registry, bn), decodedLength];
+    }
+    else if (value instanceof Compact) {
+        const raw = value.unwrap();
+        return raw instanceof Type
+            ? [raw, 0]
+            : [new Type(registry, raw), 0];
+    }
+    else if (value instanceof Type) {
+        return [value, 0];
+    }
+    return [new Type(registry, value), 0];
+}
+/**
+ * @name Compact
+ * @description
+ * A compact length-encoding codec wrapper. It performs the same function as Length, however
+ * differs in that it uses a variable number of bytes to do the actual encoding. This is mostly
+ * used by other types to add length-prefixed encoding, or in the case of wrapped types, taking
+ * a number and making the compact representation thereof
+ */
+export class Compact {
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    #Type;
+    #raw;
+    constructor(registry, Type, value = 0, { definition, setDefinition = identity } = {}) {
+        this.registry = registry;
+        this.#Type = definition || setDefinition(typeToConstructor(registry, Type));
+        const [raw, decodedLength] = decodeCompact(registry, this.#Type, value);
+        this.initialU8aLength = decodedLength;
+        this.#raw = raw;
+    }
+    static with(Type) {
+        let definition;
+        // eslint-disable-next-line no-return-assign
+        const setDefinition = (d) => (definition = d);
+        return class extends Compact {
+            constructor(registry, value) {
+                super(registry, Type, value, { definition, setDefinition });
+            }
+        };
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        return this.toU8a().length;
+    }
+    /**
+     * @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.#raw.isEmpty;
+    }
+    /**
+     * @description Returns the number of bits in the value
+     */
+    bitLength() {
+        return this.#raw.bitLength();
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        return this.#raw.eq(other instanceof Compact
+            ? other.#raw
+            : other);
+    }
+    /**
+     * @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 this.#raw.toBigInt();
+    }
+    /**
+     * @description Returns the BN representation of the number
+     */
+    toBn() {
+        return this.#raw.toBn();
+    }
+    /**
+     * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+     */
+    toHex(isLe) {
+        return this.#raw.toHex(isLe);
+    }
+    /**
+     * @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.#raw.toJSON();
+    }
+    /**
+     * @description Returns the number representation for the value
+     */
+    toNumber() {
+        return this.#raw.toNumber();
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii) {
+        return this.#raw.toPrimitive(disableAscii);
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `Compact<${this.registry.getClassName(this.#Type) || this.#raw.toRawType()}>`;
+    }
+    /**
+     * @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
+     */
+    toU8a(_isBare) {
+        return compactToU8a(this.#raw.toBn());
+    }
+    /**
+     * @description Returns the embedded [[UInt]] or [[Moment]] value
+     */
+    unwrap() {
+        return this.#raw;
+    }
+}