@pezkuwi/types-codec 16.5.20 → 16.5.22

package/src/extended/BTreeSet.ts

@@ -1,233 +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, CodecClass, Inspect, ISet, IU8a, Registry } from '../types/index.js';
-
-import { compactFromU8aLim, compactToU8a, isHex, isU8a, logger, stringify, u8aConcatStrict, u8aToHex, u8aToU8a } from '@pezkuwi/util';
-
-import { compareSet, decodeU8aVec, sortSet, typeToConstructor } from '../utils/index.js';
-
-const l = logger('BTreeSet');
-
-/** @internal */
-function decodeSetFromU8a<V extends Codec> (registry: Registry, ValClass: CodecClass<V>, u8a: Uint8Array): [CodecClass<V>, Set<V>, number] {
-  const output = new Set<V>();
-  const [offset, count] = compactFromU8aLim(u8a);
-  const result = new Array<V>(count);
-  const [decodedLength] = decodeU8aVec(registry, result, u8a, offset, ValClass);
-
-  for (let i = 0; i < count; i++) {
-    output.add(result[i] as unknown as V);
-  }
-
-  return [ValClass, output, decodedLength];
-}
-
-/** @internal */
-function decodeSetFromSet<V extends Codec> (registry: Registry, ValClass: CodecClass<V>, value: Set<any> | string[]): [CodecClass<V>, Set<V>, number] {
-  const output = new Set<V>();
-
-  value.forEach((val: any) => {
-    try {
-      output.add((val instanceof ValClass) ? val : new ValClass(registry, val));
-    } catch (error) {
-      l.error('Failed to decode key or value:', (error as Error).message);
-
-      throw error;
-    }
-  });
-
-  return [ValClass, output, 0];
-}
-
-/**
- * Decode input to pass into constructor.
- *
- * @param ValClass - Type of the map value
- * @param value - Value to decode, one of:
- * - null
- * - undefined
- * - hex
- * - Uint8Array
- * - Set<any>, where both key and value types are either
- *   constructors or decodeable values for their types.
- * @param jsonSet
- * @internal
- */
-function decodeSet<V extends Codec> (registry: Registry, valType: CodecClass<V> | string, value?: Uint8Array | string | string[] | Set<any>): [CodecClass<V>, Set<V>, number] {
-  const ValClass = typeToConstructor(registry, valType);
-
-  if (!value) {
-    return [ValClass, new Set<V>(), 0];
-  } else if (isU8a(value) || isHex(value)) {
-    return decodeSetFromU8a<V>(registry, ValClass, u8aToU8a(value));
-  } else if (Array.isArray(value) || value instanceof Set) {
-    return decodeSetFromSet<V>(registry, ValClass, value);
-  }
-
-  throw new Error('BTreeSet: cannot decode type');
-}
-
-export class BTreeSet<V extends Codec = Codec> extends Set<V> implements ISet<V> {
-  readonly registry: Registry;
-
-  public createdAtHash?: IU8a;
-  public initialU8aLength?: number;
-  public isStorageFallback?: boolean;
-
-  readonly #ValClass: CodecClass<V>;
-
-  constructor (registry: Registry, valType: CodecClass<V> | string, rawValue?: Uint8Array | string | string[] | Set<any>) {
-    const [ValClass, values, decodedLength] = decodeSet(registry, valType, rawValue);
-
-    super(sortSet(values));
-
-    this.registry = registry;
-    this.initialU8aLength = decodedLength;
-    this.#ValClass = ValClass;
-  }
-
-  public static with<V extends Codec> (valType: CodecClass<V> | string): CodecClass<BTreeSet<V>> {
-    return class extends BTreeSet<V> {
-      constructor (registry: Registry, value?: Uint8Array | string | Set<any>) {
-        super(registry, valType, value);
-      }
-    };
-  }
-
-  /**
-   * @description The length of the value when encoded as a Uint8Array
-   */
-  public get encodedLength (): number {
-    let len = compactToU8a(this.size).length;
-
-    for (const v of this.values()) {
-      len += v.encodedLength;
-    }
-
-    return len;
-  }
-
-  /**
-   * @description Returns a hash of the value
-   */
-  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.size === 0;
-  }
-
-  /**
-   * @description The actual set values as a string[]
-   */
-  public get strings (): string[] {
-    return [...super.values()].map((v) => v.toString());
-  }
-
-  /**
-   * @description Compares the value of the input to see if there is a match
-   */
-  public eq (other?: unknown): boolean {
-    return compareSet(this, other);
-  }
-
-  /**
-   * @description Returns a breakdown of the hex encoding for this Codec
-   */
-  public inspect (): Inspect {
-    const inner: Inspect[] = [];
-
-    for (const v of this.values()) {
-      inner.push(v.inspect());
-    }
-
-    return {
-      inner,
-      outer: [compactToU8a(this.size)]
-    };
-  }
-
-  /**
-   * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
-   */
-  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 json: AnyJson = [];
-
-    for (const v of this.values()) {
-      json.push(v.toHuman(isExtended, disableAscii));
-    }
-
-    return json;
-  }
-
-  /**
-   * @description Converts the Object to JSON, typically used for RPC transfers
-   */
-  public toJSON (): AnyJson {
-    const json: AnyJson = [];
-
-    for (const v of this.values()) {
-      json.push(v.toJSON());
-    }
-
-    return json;
-  }
-
-  /**
-   * @description Returns the base runtime type name for this instance
-   */
-  public toRawType (): string {
-    return `BTreeSet<${this.registry.getClassName(this.#ValClass) || new this.#ValClass(this.registry).toRawType()}>`;
-  }
-
-  /**
-   * @description Converts the value in a best-fit primitive form
-   */
-  public toPrimitive (disableAscii?: boolean): AnyJson {
-    const json: AnyJson = [];
-
-    for (const v of this.values()) {
-      json.push(v.toPrimitive(disableAscii));
-    }
-
-    return json;
-  }
-
-  /**
-   * @description Returns the string representation of the value
-   */
-  public override toString (): string {
-    return stringify(this.toJSON());
-  }
-
-  /**
-   * @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: Uint8Array[] = [];
-
-    if (!isBare) {
-      encoded.push(compactToU8a(this.size));
-    }
-
-    for (const v of this.values()) {
-      encoded.push(v.toU8a(isBare));
-    }
-
-    return u8aConcatStrict(encoded);
-  }
-}

package/src/extended/BitVec.spec.ts

@@ -1,97 +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 { hexToU8a } from '@pezkuwi/util';
-
-import { BitVec } from './index.js';
-
-// form Inclusion BitVec<lsb0, u8>
-const TESTS = ['0x00', '0x0817', '0x0837', '0x087b', '0x0c33'];
-const registry = new TypeRegistry();
-
-describe('BitVec', (): void => {
-  describe('decoding known', (): void => {
-    TESTS.forEach((test): void => {
-      describe(`${test}`, (): void => {
-        const input = hexToU8a(test);
-        const bitvec = new BitVec(registry, input);
-
-        it('has the right encodedLength', (): void => {
-          expect(
-            bitvec.encodedLength
-          ).toEqual((test.length - 2) / 2);
-        });
-
-        it('re-encodes to the same input value', (): void => {
-          expect(
-            bitvec.toU8a()
-          ).toEqual(input);
-        });
-      });
-    });
-  });
-
-  describe('toHuman() ordering', (): void => {
-    it('defaults to Lsb', (): void => {
-      expect(
-        new BitVec(registry, '0x0100010500').toHuman()
-      ).toEqual('0b10000000_00000000_10000000_10100000_00000000');
-    });
-
-    it('can output to Msb', (): void => {
-      expect(
-        new BitVec(registry, '0x0100010500', true).toHuman()
-      ).toEqual('0b00000001_00000000_00000001_00000101_00000000');
-    });
-  });
-
-  describe('toBoolArray() ordering', (): void => {
-    it('defaults to Lsb', (): void => {
-      expect(
-        new BitVec(registry, '0x0100010500').toBoolArray()
-      ).toEqual([
-        true, false, false, false, false, false, false, false,
-        false, false, false, false, false, false, false, false,
-        true, false, false, false, false, false, false, false,
-        true, false, true, false, false, false, false, false,
-        false, false, false, false, false, false, false, false
-      ]);
-    });
-
-    it('can output to Msb', (): void => {
-      expect(
-        new BitVec(registry, '0x0100010500', true).toBoolArray()
-      ).toEqual([
-        false, false, false, false, false, false, false, true,
-        false, false, false, false, false, false, false, false,
-        false, false, false, false, false, false, false, true,
-        false, false, false, false, false, true, false, true,
-        false, false, false, false, false, false, false, false
-      ]);
-    });
-
-    it('outputs all LSB bits', (): void => {
-      expect(
-        new BitVec(registry, '0x01000105ff').toBoolArray()
-      ).toEqual([
-        true, false, false, false, false, false, false, false,
-        false, false, false, false, false, false, false, false,
-        true, false, false, false, false, false, false, false,
-        true, false, true, false, false, false, false, false,
-        true, true, true, true, true, true, true, true
-      ]);
-    });
-  });
-
-  it('has a sane inspect', (): void => {
-    expect(
-      new BitVec(registry, '0x0837').inspect()
-    ).toEqual({
-      // For input '0x0837' (yields 16 bits): compactToU8a(16) is 16<<2 = 64.
-      outer: [new Uint8Array([64]), new Uint8Array([0x08, 0x37])]
-    });
-  });
-});

package/src/extended/BitVec.ts

@@ -1,137 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { AnyU8a, Inspect, Registry } from '../types/index.js';
-
-import { compactFromU8aLim, compactToU8a, isString, u8aConcatStrict, u8aToU8a } from '@pezkuwi/util';
-
-import { Raw } from '../native/Raw.js';
-
-/** @internal */
-function decodeBitVecU8a (value?: Uint8Array): [number, Uint8Array] {
-  if (!value?.length) {
-    return [0, new Uint8Array()];
-  }
-
-  // handle all other Uint8Array inputs, these do have a length prefix which is the number of bits encoded
-  const [offset, length] = compactFromU8aLim(value);
-  const total = offset + Math.ceil(length / 8);
-
-  if (total > value.length) {
-    throw new Error(`BitVec: required length less than remainder, expected at least ${total}, found ${value.length}`);
-  }
-
-  return [length, value.subarray(offset, total)];
-}
-
-/** @internal */
-function decodeBitVec (value?: AnyU8a): [number, Uint8Array] {
-  if (Array.isArray(value) || isString(value)) {
-    const u8a = u8aToU8a(value);
-
-    return [u8a.length * 8, u8a];
-  }
-
-  return decodeBitVecU8a(value);
-}
-
-/**
- * @name BitVec
- * @description
- * A BitVec that represents an array of bits. The bits are however stored encoded. The difference between this
- * and a normal Bytes would be that the length prefix indicates the number of bits encoded, not the bytes
- */
-export class BitVec extends Raw {
-  readonly #decodedLength: number;
-  readonly #isMsb?: boolean;
-
-  // In lieu of having the Msb/Lsb identifiers passed through, we default to assuming
-  // we are dealing with Lsb, which is the default (as of writing) BitVec format used
-  // in the Pezkuwi code (this only affects the toHuman displays)
-  constructor (registry: Registry, value?: AnyU8a, isMsb = false) {
-    const [decodedLength, u8a] = decodeBitVec(value);
-
-    super(registry, u8a);
-
-    this.#decodedLength = decodedLength;
-    this.#isMsb = isMsb;
-  }
-
-  /**
-   * @description The length of the value when encoded as a Uint8Array
-   */
-  public override get encodedLength (): number {
-    return this.length + compactToU8a(this.#decodedLength).length;
-  }
-
-  /**
-   * @description Returns a breakdown of the hex encoding for this Codec
-   */
-  public override inspect (): Inspect {
-    return {
-      outer: [compactToU8a(this.#decodedLength), super.toU8a()]
-    };
-  }
-
-  /**
-   * @description Creates a boolean array of the bit values
-   */
-  public toBoolArray (): boolean[] {
-    const map = [...this.toU8a(true)].map((v) => [
-      !!(v & 0b1000_0000),
-      !!(v & 0b0100_0000),
-      !!(v & 0b0010_0000),
-      !!(v & 0b0001_0000),
-      !!(v & 0b0000_1000),
-      !!(v & 0b0000_0100),
-      !!(v & 0b0000_0010),
-      !!(v & 0b0000_0001)
-    ]);
-    const count = map.length;
-    const result = new Array<boolean>(8 * count);
-
-    for (let i = 0; i < count; i++) {
-      const off = i * 8;
-      const v = map[i];
-
-      for (let j = 0; j < 8; j++) {
-        result[off + j] = this.#isMsb
-          ? v[j]
-          : v[7 - j];
-      }
-    }
-
-    return result;
-  }
-
-  /**
-   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-   */
-  public override toHuman (): string {
-    return `0b${
-      [...this.toU8a(true)]
-        .map((d) => `00000000${d.toString(2)}`.slice(-8))
-        .map((s) => this.#isMsb ? s : s.split('').reverse().join(''))
-        .join('_')
-    }`;
-  }
-
-  /**
-   * @description Returns the base runtime type name for this instance
-   */
-  public override toRawType (): string {
-    return 'BitVec';
-  }
-
-  /**
-   * @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 override toU8a (isBare?: boolean): Uint8Array {
-    const bitVec = super.toU8a(isBare);
-
-    return isBare
-      ? bitVec
-      : u8aConcatStrict([compactToU8a(this.#decodedLength), bitVec]);
-  }
-}

package/src/extended/Bytes.spec.ts

@@ -1,75 +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 { Bytes } from '@pezkuwi/types-codec';
-
-describe('Bytes', (): void => {
-  const registry = new TypeRegistry();
-  const NUM = [0x3a, 0x63, 0x6f, 0x64, 0x65];
-  const U8A = new Uint8Array([0x14, ...NUM]);
-  const HEX = '0x3a636f6465';
-
-  describe('construction', (): void => {
-    it('decodes when input is string', (): void => {
-      expect(
-        new Bytes(registry, ':code').toU8a()
-      ).toEqual(U8A);
-    });
-
-    it('decodes when hex is not length prefixed', (): void => {
-      expect(
-        new Bytes(registry, HEX).toU8a()
-      ).toEqual(U8A);
-    });
-
-    it('decodes from UInt8Array', (): void => {
-      expect(
-        new Bytes(registry, U8A).toU8a()
-      ).toEqual(U8A);
-    });
-
-    it('decodes from number[]', (): void => {
-      expect(
-        new Bytes(registry, NUM).toU8a()
-      ).toEqual(U8A);
-    });
-
-    it('creates via storagedata (no prefix)', (): void => {
-      expect(
-        new Bytes(
-          registry,
-          registry.createType('StorageData', HEX)
-        ).toU8a()
-      ).toEqual(U8A);
-    });
-
-    it('encodes from itself', (): void => {
-      expect(
-        new Bytes(registry, new Bytes(registry, HEX)).toU8a()
-      ).toEqual(U8A);
-    });
-
-    it('strips length with toU8a(true)', (): void => {
-      expect(
-        new Bytes(registry, HEX).toU8a(true)
-      ).toEqual(U8A.subarray(1));
-    });
-
-    it('strips length with toHex', (): void => {
-      expect(
-        new Bytes(registry, HEX).toHex()
-      ).toEqual(HEX);
-    });
-  });
-
-  it('has a sane inspect', (): void => {
-    expect(
-      new Bytes(registry, '0x12345678').inspect()
-    ).toEqual({
-      outer: [new Uint8Array([4 << 2]), new Uint8Array([0x12, 0x34, 0x56, 0x78])]
-    });
-  });
-});

package/src/extended/Bytes.ts

@@ -1,88 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { AnyU8a, Inspect, Registry } from '../types/index.js';
-
-import { compactAddLength, compactFromU8aLim, compactToU8a, isString, isU8a, u8aToU8a } from '@pezkuwi/util';
-
-import { Raw } from '../native/Raw.js';
-
-// Bytes are used for things like on-chain code, so it has a healthy limit
-const MAX_LENGTH = 10 * 1024 * 1024;
-
-/** @internal */
-function decodeBytesU8a (value: Uint8Array): [Uint8Array, number] {
-  if (!value.length) {
-    return [new Uint8Array(), 0];
-  }
-
-  // handle all other Uint8Array inputs, these do have a length prefix
-  const [offset, length] = compactFromU8aLim(value);
-  const total = offset + length;
-
-  if (length > MAX_LENGTH) {
-    throw new Error(`Bytes length ${length.toString()} exceeds ${MAX_LENGTH}`);
-  } else if (total > value.length) {
-    throw new Error(`Bytes: required length less than remainder, expected at least ${total}, found ${value.length}`);
-  }
-
-  return [value.subarray(offset, total), total];
-}
-
-/**
- * @name Bytes
- * @description
- * A Bytes wrapper for Vec<u8>. The significant difference between this and a normal Uint8Array
- * is that this version allows for length-encoding. (i.e. it is a variable-item codec, the same
- * as what is found in [[Text]] and [[Vec]])
- */
-export class Bytes extends Raw {
-  constructor (registry: Registry, value?: AnyU8a) {
-    const [u8a, decodedLength] = isU8a(value) && !(value instanceof Raw)
-      ? decodeBytesU8a(value)
-      : Array.isArray(value) || isString(value)
-        ? [u8aToU8a(value), 0]
-        : [value, 0];
-
-    super(registry, u8a, decodedLength);
-  }
-
-  /**
-   * @description The length of the value when encoded as a Uint8Array
-   */
-  public override get encodedLength (): number {
-    return this.length + compactToU8a(this.length).length;
-  }
-
-  /**
-   * @description Returns a breakdown of the hex encoding for this Codec
-   */
-  public override inspect (isBare?: boolean): Inspect {
-    const clength = compactToU8a(this.length);
-
-    return {
-      outer: isBare
-        ? [super.toU8a()]
-        : this.length
-          ? [clength, super.toU8a()]
-          : [clength]
-    };
-  }
-
-  /**
-   * @description Returns the base runtime type name for this instance
-   */
-  public override toRawType (): string {
-    return 'Bytes';
-  }
-
-  /**
-   * @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 override toU8a (isBare?: boolean): Uint8Array {
-    return isBare
-      ? super.toU8a(isBare)
-      : compactAddLength(this);
-  }
-}

package/src/extended/HashMap.spec.ts

@@ -1,36 +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 { HashMap, Struct, Text, U32 } from '@pezkuwi/types-codec';
-import { stringToU8a } from '@pezkuwi/util';
-
-const registry = new TypeRegistry();
-
-describe('HashMap', (): void => {
-  it('generates sane toRawTypes', (): void => {
-    expect(new (HashMap.with(Text, U32))(registry).toRawType()).toBe('HashMap<Text,u32>');
-    expect(new (HashMap.with(Text, Text))(registry).toRawType()).toBe('HashMap<Text,Text>');
-    expect(new (HashMap.with(Text, Struct.with({ a: U32, b: Text })))(registry).toRawType())
-      .toBe('HashMap<Text,{"a":"u32","b":"Text"}>');
-  });
-
-  it('has a sane inspect', (): void => {
-    expect(
-      new (HashMap.with(Text, Text))(registry, new Map([
-        [new Text(registry, '1'), new Text(registry, 'foo')],
-        [new Text(registry, '2'), new Text(registry, 'bar')]
-      ])).inspect()
-    ).toEqual({
-      inner: [
-        { outer: [new Uint8Array([1 << 2]), stringToU8a('1')] },
-        { outer: [new Uint8Array([3 << 2]), stringToU8a('foo')] },
-        { outer: [new Uint8Array([1 << 2]), stringToU8a('2')] },
-        { outer: [new Uint8Array([3 << 2]), stringToU8a('bar')] }
-      ],
-      outer: [new Uint8Array([2 << 2])]
-    });
-  });
-});

package/src/extended/HashMap.ts

@@ -1,16 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Codec, CodecClass, Registry } from '../types/index.js';
-
-import { CodecMap } from './Map.js';
-
-export class HashMap<K extends Codec = Codec, V extends Codec = Codec> extends CodecMap<K, V> {
-  public static with<K extends Codec, V extends Codec> (keyType: CodecClass<K> | string, valType: CodecClass<V> | string): CodecClass<CodecMap<K, V>> {
-    return class extends HashMap<K, V> {
-      constructor (registry: Registry, value?: Uint8Array | string | Map<any, any>) {
-        super(registry, keyType, valType, value);
-      }
-    };
-  }
-}