@pezkuwi/types-codec 16.5.8 → 16.5.9

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.$;
-  }
-}

package/src/abstract/index.ts

@@ -1,6 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export { AbstractArray } from './Array.js';
-export { AbstractBase } from './Base.js';
-export { AbstractInt } from './Int.js';

package/src/base/Compact.spec.ts

@@ -1,99 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { TypeRegistry } from '@pezkuwi/types';
-import { CodecDate, Compact, U32 } from '@pezkuwi/types-codec';
-import { BN } from '@pezkuwi/util';
-
-import { perf } from '../test/performance.js';
-
-const CompactU32 = Compact.with(U32);
-
-describe('Compact', (): void => {
-  const registry = new TypeRegistry();
-
-  describe('constructor', (): void => {
-    it('fails on > MAX_SAFE_INTEGER', (): void => {
-      // eslint-disable-next-line @typescript-eslint/no-loss-of-precision, no-loss-of-precision
-      expect(() => new Compact(registry, 'u128', 9007199254740999)).toThrow(/integer <= Number.MAX_SAFE_INTEGER/);
-    });
-
-    it('has support for BigInt', (): void => {
-      expect(
-        new Compact(registry, 'u128', 123456789000123456789n).toHuman()
-      ).toEqual('123,456,789,000,123,456,789');
-    });
-
-    it('has the correct bitLength for constructor values (BlockNumber)', (): void => {
-      expect(
-        new (Compact.with(registry.createClass('BlockNumber')))(registry, 0xfffffff9).bitLength()
-      ).toEqual(32);
-    });
-
-    it('has the correct encodedLength for constructor values (string BlockNumber)', (): void => {
-      expect(
-        new (Compact.with('BlockNumber'))(registry, 0xfffffff9).encodedLength
-      ).toEqual(5);
-    });
-
-    it('has the correct encodedLength for constructor values (class BlockNumber)', (): void => {
-      expect(
-        new (Compact.with(registry.createClass('BlockNumber')))(registry, 0xfffffff9).encodedLength
-      ).toEqual(5);
-    });
-
-    it('has the correct encodedLength for constructor values (u32)', (): void => {
-      expect(
-        new (Compact.with(U32))(registry, 0xffff9).encodedLength
-      ).toEqual(4);
-    });
-
-    it('constructs properly via Uint8Array as U32', (): void => {
-      expect(
-        new (Compact.with(U32))(registry, new Uint8Array([254, 255, 3, 0])).toNumber()
-      ).toEqual(new BN(0xffff).toNumber());
-    });
-
-    it('constructs properly via number as Moment', (): void => {
-      expect(
-        new (Compact.with(CodecDate))(registry, 1537968546).toString().startsWith('Wed Sep 26 2018') // The time depends on the timezone this test is run in
-      ).toBe(true);
-    });
-  });
-
-  describe('utils', (): void => {
-    it('compares against another Compact', (): void => {
-      expect(new (Compact.with(U32))(registry, 12345).eq(new (Compact.with(U32))(registry, 12345))).toBe(true);
-    });
-
-    it('compares against a primitive', (): void => {
-      expect(new (Compact.with(U32))(registry, 12345).eq(12345)).toBe(true);
-    });
-
-    it('unwraps to the wrapped value', (): void => {
-      expect(new (Compact.with(U32))(registry, 12345).unwrap() instanceof U32).toBe(true);
-    });
-
-    it('has a valid toBn interface', (): void => {
-      expect(new (Compact.with('u128'))(registry, '12345678987654321').toBn().eq(new BN('12345678987654321'))).toBe(true);
-    });
-
-    it('has a valid toBigInt interface', (): void => {
-      expect(
-        (new (Compact.with('u128'))(registry, 12345678987654321n).toBigInt() + 1n) === 12345678987654322n
-      ).toBe(true);
-    });
-
-    it('has a sane inspect', (): void => {
-      expect(
-        new (Compact.with(U32))(registry, 0xffff).inspect()
-      ).toEqual({
-        outer: [new Uint8Array([254, 255, 3, 0])]
-      });
-    });
-  });
-
-  perf('Compact', 75_000, [[new Uint8Array([63 << 2])]], (v: Uint8Array) => new CompactU32(registry, v));
-});

package/src/base/Compact.ts

@@ -1,198 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-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';
-
-import { compactFromU8a, compactFromU8aLim, compactToU8a, identity, isU8a } from '@pezkuwi/util';
-
-import { typeToConstructor } from '../utils/index.js';
-
-function decodeCompact<T extends INumber> (registry: Registry, Type: CodecClass<T>, value: Compact<T> | AnyNumber): [T, number] {
-  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<T extends INumber> implements ICompact<T> {
-  readonly registry: Registry;
-
-  public createdAtHash?: IU8a;
-  public initialU8aLength?: number;
-  public isStorageFallback?: boolean;
-
-  readonly #Type: CodecClass<T>;
-  readonly #raw: T;
-
-  constructor (registry: Registry, Type: CodecClass<T> | string, value: Compact<T> | AnyNumber = 0, { definition, setDefinition = identity }: DefinitionSetter<CodecClass<T>> = {}) {
-    this.registry = registry;
-    this.#Type = definition || setDefinition(typeToConstructor(registry, Type));
-
-    const [raw, decodedLength] = decodeCompact<T>(registry, this.#Type, value);
-
-    this.initialU8aLength = decodedLength;
-    this.#raw = raw;
-  }
-
-  public static with<O extends INumber> (Type: CodecClass<O> | string): CodecClass<Compact<O>> {
-    let definition: CodecClass<O> | undefined;
-
-    // eslint-disable-next-line no-return-assign
-    const setDefinition = <T> (d: CodecClass<T>) =>
-      (definition = d as unknown as CodecClass<O>) as unknown as CodecClass<T>;
-
-    return class extends Compact<O> {
-      constructor (registry: Registry, value?: Compact<O> | AnyNumber) {
-        super(registry, Type, value, { definition, setDefinition });
-      }
-    };
-  }
-
-  /**
-   * @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 get isEmpty (): boolean {
-    return this.#raw.isEmpty;
-  }
-
-  /**
-   * @description Returns the number of bits in the value
-   */
-  public bitLength (): number {
-    return this.#raw.bitLength();
-  }
-
-  /**
-   * @description Compares the value of the input to see if there is a match
-   */
-  public eq (other?: unknown): boolean {
-    return this.#raw.eq(
-      other instanceof Compact
-        ? other.#raw
-        : other
-    );
-  }
-
-  /**
-   * @description Returns a breakdown of the hex encoding for this Codec
-   */
-  public inspect (): Inspect {
-    return {
-      outer: [this.toU8a()]
-    };
-  }
-
-  /**
-   * @description Returns a BigInt representation of the number
-   */
-  public toBigInt (): bigint {
-    return this.#raw.toBigInt();
-  }
-
-  /**
-   * @description Returns the BN representation of the number
-   */
-  public toBn (): BN {
-    return this.#raw.toBn();
-  }
-
-  /**
-   * @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 Returns the number representation for the value
-   */
-  public toNumber (): number {
-    return this.#raw.toNumber();
-  }
-
-  /**
-   * @description Converts the value in a best-fit primitive form
-   */
-  public toPrimitive (disableAscii?: boolean): string | number {
-    return this.#raw.toPrimitive(disableAscii);
-  }
-
-  /**
-   * @description Returns the base runtime type name for this instance
-   */
-  public toRawType (): string {
-    return `Compact<${this.registry.getClassName(this.#Type) || this.#raw.toRawType()}>`;
-  }
-
-  /**
-   * @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
-   */
-  public toU8a (_isBare?: boolean): Uint8Array {
-    return compactToU8a(this.#raw.toBn());
-  }
-
-  /**
-   * @description Returns the embedded [[UInt]] or [[Moment]] value
-   */
-  public unwrap (): T {
-    return this.#raw;
-  }
-}

package/src/base/DoNotConstruct.spec.ts

@@ -1,23 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { TypeRegistry } from '@pezkuwi/types';
-import { DoNotConstruct } from '@pezkuwi/types-codec';
-
-describe('DoNotConstruct', (): void => {
-  const registry = new TypeRegistry();
-
-  it('does not allow construction', (): void => {
-    expect(
-      () => new (DoNotConstruct.with())(registry)
-    ).toThrow(/Cannot construct unknown type DoNotConstruct/);
-  });
-
-  it('does not allow construction (with Name)', (): void => {
-    expect(
-      () => new (DoNotConstruct.with('Something'))(registry)
-    ).toThrow(/Cannot construct unknown type Something/);
-  });
-});