@pezkuwi/types-codec 16.5.13 → 16.5.15

package/src/abstract/Array.ts

@@ -1,213 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { HexString } from '@pezkuwi/util/types';
-import type { AnyJson, Codec, Inspect, IU8a, IVec, Registry } from '../types/index.js';
-
-import { compactToU8a, u8aConcatStrict, u8aToHex } from '@pezkuwi/util';
-
-import { compareArray } from '../utils/compareArray.js';
-
-/**
- * @name AbstractArray
- * @description
- * This manages codec arrays. It is an extension to Array, providing
- * specific encoding/decoding on top of the base type.
- * @noInheritDoc
- */
-export abstract class AbstractArray<T extends Codec> extends Array<T> implements IVec<T> {
-  readonly registry: Registry;
-
-  public createdAtHash?: IU8a;
-  public initialU8aLength?: number;
-  public 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 override get [Symbol.species] (): typeof Array {
-    return Array;
-  }
-
-  protected constructor (registry: Registry, length: number) {
-    super(length);
-
-    this.registry = registry;
-  }
-
-  /**
-   * @description The length of the value when encoded as a Uint8Array
-   */
-  public get encodedLength (): number {
-    // We need to loop through all entries since they may have a variable length themselves,
-    // e.g. when a Vec or Compact is contained withing, it has a variable length based on data
-    const count = this.length;
-    let total = compactToU8a(count).length;
-
-    for (let i = 0; i < count; i++) {
-      total += this[i].encodedLength;
-    }
-
-    return total;
-  }
-
-  /**
-   * @description returns a hash of the contents
-   */
-  public get hash (): IU8a {
-    return this.registry.hash(this.toU8a());
-  }
-
-  /**
-   * @description Checks if the value is an empty value
-   */
-  public get isEmpty (): boolean {
-    return this.length === 0;
-  }
-
-  /**
-   * @description The length of the value
-   */
-  public override get length (): number {
-    // only included here since we ignore inherited docs
-    return super.length;
-  }
-
-  /**
-   * @description Compares the value of the input to see if there is a match
-   */
-  public eq (other?: unknown): boolean {
-    return compareArray(this, other);
-  }
-
-  /**
-   * @description Returns a breakdown of the hex encoding for this Codec
-   */
-  public inspect (): Inspect {
-    return {
-      inner: this.inspectInner(),
-      outer: [compactToU8a(this.length)]
-    };
-  }
-
-  /**
-   * @internal
-   * @description Internal per-item inspection of internal values
-   */
-  public inspectInner (): Inspect[] {
-    const count = this.length;
-    const inner = new Array<Inspect>(count);
-
-    for (let i = 0; i < count; i++) {
-      inner[i] = this[i].inspect();
-    }
-
-    return inner;
-  }
-
-  /**
-   * @description Converts the Object to an standard JavaScript Array
-   */
-  public toArray (): T[] {
-    return Array.from(this);
-  }
-
-  /**
-   * @description Returns a hex string representation of the value
-   */
-  public toHex (): HexString {
-    return u8aToHex(this.toU8a());
-  }
-
-  /**
-   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-   */
-  public toHuman (isExtended?: boolean, disableAscii?: boolean): AnyJson {
-    const count = this.length;
-    const result = new Array<AnyJson>(count);
-
-    for (let i = 0; i < count; i++) {
-      result[i] = this[i] && this[i].toHuman(isExtended, disableAscii);
-    }
-
-    return result;
-  }
-
-  /**
-   * @description Converts the Object to JSON, typically used for RPC transfers
-   */
-  public toJSON (): AnyJson {
-    const count = this.length;
-    const result = new Array<AnyJson>(count);
-
-    for (let i = 0; i < count; i++) {
-      // We actually log inside the U8a decoding and use JSON.stringify(...), which
-      // means that the Vec may be partially populated (same applies to toHuman, same check)
-      result[i] = this[i] && this[i].toJSON();
-    }
-
-    return result;
-  }
-
-  /**
-   * @description Converts the value in a best-fit primitive form
-   */
-  public toPrimitive (disableAscii?: boolean): AnyJson {
-    const count = this.length;
-    const result = new Array<AnyJson>(count);
-
-    for (let i = 0; i < count; i++) {
-      result[i] = this[i] && this[i].toPrimitive(disableAscii);
-    }
-
-    return result;
-  }
-
-  /**
-   * @description Returns the base runtime type name for this instance
-   */
-  abstract toRawType (): string;
-
-  /**
-   * @description Returns the string representation of the value
-   */
-  public override toString (): string {
-    const count = this.length;
-    const result = new Array<string>(count);
-
-    for (let i = 0; i < count; i++) {
-      result[i] = this[i].toString();
-    }
-
-    return `[${result.join(', ')}]`;
-  }
-
-  /**
-   * @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)
-   */
-  public toU8a (isBare?: boolean): Uint8Array {
-    const encoded = this.toU8aInner();
-
-    return isBare
-      ? u8aConcatStrict(encoded)
-      : u8aConcatStrict([compactToU8a(this.length), ...encoded]);
-  }
-
-  /**
-   * @internal
-   * @description Internal per-item SCALE encoding of contained values
-   * @param isBare true when the value has none of the type-specific prefixes (internal)
-   */
-  public toU8aInner (isBare?: boolean): Uint8Array[] {
-    const count = this.length;
-    const encoded = new Array<Uint8Array>(count);
-
-    for (let i = 0; i < count; i++) {
-      encoded[i] = this[i].toU8a(isBare);
-    }
-
-    return encoded;
-  }
-}

package/src/abstract/Base.ts

@@ -1,129 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { HexString } from '@pezkuwi/util/types';
-import type { AnyJson, BareOpts, Codec, Inspect, IU8a, Registry } from '../types/index.js';
-
-/**
- * @name Base
- * @description A type extends the Base class, when it holds a value
- */
-export abstract class AbstractBase<T extends Codec> implements Codec {
-  readonly registry: Registry;
-
-  public createdAtHash?: IU8a | undefined;
-  public initialU8aLength?: number | undefined;
-  public isStorageFallback?: boolean;
-
-  readonly #raw: T;
-
-  protected constructor (registry: Registry, value: T, initialU8aLength?: number) {
-    this.initialU8aLength = initialU8aLength;
-    this.#raw = value;
-    this.registry = registry;
-  }
-
-  /**
-   * @description The length of the value when encoded as a Uint8Array
-   */
-  public get encodedLength (): number {
-    return this.toU8a().length;
-  }
-
-  /**
-   * @description returns a hash of the contents
-   */
-  public get hash (): IU8a {
-    return this.registry.hash(this.toU8a());
-  }
-
-  /**
-   * @description returns the inner (wrapped value)
-   */
-  public get inner (): T {
-    return this.#raw;
-  }
-
-  /**
-   * @description Checks if the value is an empty value
-   */
-  public get isEmpty (): boolean {
-    return this.#raw.isEmpty;
-  }
-
-  /**
-   * @description Compares the value of the input to see if there is a match
-   */
-  public eq (other?: unknown): boolean {
-    return this.#raw.eq(other);
-  }
-
-  /**
-   * @description Returns a breakdown of the hex encoding for this Codec
-   */
-  public inspect (): Inspect {
-    return this.#raw.inspect();
-  }
-
-  /**
-   * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
-   */
-  public toHex (isLe?: boolean): HexString {
-    return this.#raw.toHex(isLe);
-  }
-
-  /**
-   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-   */
-  public toHuman (isExtended?: boolean, disableAscii?: boolean): AnyJson {
-    return this.#raw.toHuman(isExtended, disableAscii);
-  }
-
-  /**
-   * @description Converts the Object to JSON, typically used for RPC transfers
-   */
-  public toJSON (): AnyJson {
-    return this.#raw.toJSON();
-  }
-
-  /**
-   * @description Converts the value in a best-fit primitive form
-   */
-  public toPrimitive (disableAscii?: boolean): AnyJson {
-    return this.#raw.toPrimitive(disableAscii);
-  }
-
-  /**
-   * @description Returns the string representation of the value
-   */
-  public toString (): string {
-    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)
-   */
-  public toU8a (isBare?: BareOpts): Uint8Array {
-    return this.#raw.toU8a(isBare);
-  }
-
-  /**
-   * @description Returns the base runtime type name for this instance
-   */
-  public abstract toRawType (): string;
-
-  /**
-   * @description Returns the inner wrapped value (equivalent to valueOf)
-   */
-  public unwrap (): T {
-    return this.#raw;
-  }
-
-  /**
-   * @description Returns the inner wrapped value
-   */
-  public valueOf (): T {
-    return this.#raw;
-  }
-}

package/src/abstract/Int.ts

@@ -1,271 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { HexString } from '@pezkuwi/util/types';
-import type { AnyNumber, Inspect, INumber, IU8a, Registry, ToBn, UIntBitLength } from '../types/index.js';
-
-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;
-
-// Maximum allowed integer for JS is 2^53 - 1, set limit at 52
-// In this case however, we always print any >32 as hex
-const MAX_NUMBER_BITS = 52;
-const MUL_P = new BN(1_00_00);
-
-const FORMATTERS: [string, BN][] = [
-  ['Perquintill', BN_QUINTILL],
-  ['Perbill', BN_BILLION],
-  ['Permill', BN_MILLION],
-  ['Percent', BN_HUNDRED]
-];
-
-function isToBn (value: unknown): value is ToBn {
-  return isFunction((value as ToBn).toBn);
-}
-
-function toPercentage (value: BN, divisor: BN): string {
-  return `${(value.mul(MUL_P).div(divisor).toNumber() / 100).toFixed(2)}%`;
-}
-
-/** @internal */
-function decodeAbstractInt (value: Exclude<AnyNumber, Uint8Array> | Record<string, string> | ToBn | null, isNegative: boolean): string | number {
-  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 abstract class AbstractInt extends BN implements INumber {
-  readonly registry: Registry;
-  readonly encodedLength: number;
-  readonly isUnsigned: boolean;
-
-  public createdAtHash?: IU8a;
-  public initialU8aLength?: number;
-  public isStorageFallback?: boolean;
-
-  readonly #bitLength: UIntBitLength;
-
-  constructor (registry: Registry, value: AnyNumber | null = 0, bitLength: UIntBitLength = 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
-   */
-  public get hash (): IU8a {
-    return this.registry.hash(this.toU8a());
-  }
-
-  /**
-   * @description Checks if the value is a zero value (align elsewhere)
-   */
-  public get isEmpty (): boolean {
-    return this.isZero();
-  }
-
-  /**
-   * @description Returns the number of bits in the value
-   */
-  public override bitLength (): number {
-    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
-  public override eq (other?: unknown): boolean {
-    // 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 as string)
-    );
-  }
-
-  /**
-   * @description Returns a breakdown of the hex encoding for this Codec
-   */
-  public inspect (): Inspect {
-    return {
-      outer: [this.toU8a()]
-    };
-  }
-
-  /**
-   * @description True if this value is the max of the type
-   */
-  public isMax (): boolean {
-    const u8a = this.toU8a().filter((b) => b === 0xff);
-
-    return u8a.length === (this.#bitLength / 8);
-  }
-
-  /**
-   * @description Returns a BigInt representation of the number
-   */
-  public toBigInt (): bigint {
-    return BigInt(this.toString());
-  }
-
-  /**
-   * @description Returns the BN representation of the number. (Compatibility)
-   */
-  public toBn (): BN {
-    return this;
-  }
-
-  /**
-   * @description Returns a hex string representation of the value
-   */
-  public toHex (isLe = false): HexString {
-    // 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
-   */
-  public toHuman (_isExpanded?: boolean): string {
-    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
-   */
-  public override toJSON (onlyHex = false): any {
-    // 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
-   */
-  public toPrimitive (): number | string {
-    return super.bitLength() > MAX_NUMBER_BITS
-      ? this.toString()
-      : this.toNumber();
-  }
-
-  /**
-   * @description Returns the base runtime type name for this instance
-   */
-  public toRawType (): string {
-    // 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
-   */
-  public override toString (base?: number): string {
-    // 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
-   */
-  public toU8a (_isBare?: boolean): Uint8Array {
-    return bnToU8a(this, {
-      bitLength: this.bitLength(),
-      isLe: true,
-      isNegative: !this.isUnsigned
-    });
-  }
-}

package/src/abstract/Object.ts

@@ -1,99 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-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 abstract class AbstractObject<T extends ToString> implements CodecObject<T> {
-  readonly registry: Registry;
-
-  public createdAtHash?: IU8a;
-  public initialU8aLength?: number | undefined;
-  public isStorageFallback?: boolean;
-
-  readonly $: T;
-
-  protected constructor (registry: Registry, value: T, initialU8aLength?: number) {
-    this.$ = value;
-    this.initialU8aLength = initialU8aLength;
-    this.registry = registry;
-  }
-
-  /**
-   * @description The length of the value when encoded as a Uint8Array
-   */
-  public get encodedLength (): number {
-    return this.toU8a().length;
-  }
-
-  /**
-   * @description returns a hash of the contents
-   */
-  public get hash (): IU8a {
-    return this.registry.hash(this.toU8a());
-  }
-
-  /**
-   * @description Checks if the value is an empty value
-   */
-  public abstract get isEmpty (): boolean;
-
-  /**
-   * @description Compares the value of the input to see if there is a match
-   */
-  public abstract eq (other?: unknown): boolean;
-
-  /**
-   * @description Returns a breakdown of the hex encoding for this Codec
-   */
-  public abstract inspect (): Inspect;
-
-  /**
-   * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
-   */
-  public abstract toHex (isLe?: boolean): HexString;
-
-  /**
-   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-   */
-  public abstract toHuman (isExtended?: boolean, disableAscii?: boolean): AnyJson;
-
-  /**
-   * @description Converts the Object to JSON, typically used for RPC transfers
-   */
-  public abstract toJSON (): AnyJson;
-
-  /**
-   * @description Converts the value in a best-fit primitive form
-   */
-  public abstract toPrimitive (disableAscii?: boolean): AnyJson;
-
-  /**
-   * @description Returns the string representation of the value
-   */
-  public toString (): string {
-    return this.$.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)
-   */
-  public abstract toU8a (isBare?: BareOpts): Uint8Array;
-
-  /**
-   * @description Returns the base runtime type name for this instance
-   */
-  public abstract toRawType (): string;
-
-  /**
-   * @description Return the internal value (JS-aligned, same result as $)
-   */
-  public valueOf (): T {
-    return this.$;
-  }
-}