@pezkuwi/types-codec 16.5.6 → 16.5.8

package/build-deno/base/VecFixed.ts

@@ -0,0 +1,90 @@
+
+import type { HexString } from 'https://deno.land/x/pezkuwi/util/types.ts';
+import type { Codec, CodecClass, DefinitionSetter, Inspect, Registry } from '../types/index.ts';
+
+import { identity, isU8a, u8aConcatStrict } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+import { AbstractArray } from '../abstract/Array.ts';
+import { decodeU8aVec, typeToConstructor } from '../utils/index.ts';
+import { decodeVec } from './Vec.ts';
+
+/**
+ * @name VecFixed
+ * @description
+ * This manages codec arrays of a fixed length
+ */
+export class VecFixed<T extends Codec> extends AbstractArray<T> {
+  #Type: CodecClass<T>;
+
+  constructor (registry: Registry, Type: CodecClass<T> | string, length: number, value: Uint8Array | HexString | unknown[] = [] as unknown[], { definition, setDefinition = identity }: DefinitionSetter<CodecClass<T>> = {}) {
+    super(registry, length);
+
+    this.#Type = definition || setDefinition(typeToConstructor<T>(registry, Type));
+
+    this.initialU8aLength = (
+      isU8a(value)
+        ? decodeU8aVec(registry, this, value, 0, this.#Type)
+        : decodeVec(registry, this, value, 0, this.#Type)
+    )[1];
+  }
+
+  public static with<O extends Codec> (Type: CodecClass<O> | string, length: number): CodecClass<VecFixed<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 VecFixed<O> {
+      constructor (registry: Registry, value?: any[]) {
+        super(registry, Type, length, value, { definition, setDefinition });
+      }
+    };
+  }
+
+  /**
+   * @description The type for the items
+   */
+  public get Type (): string {
+    return new this.#Type(this.registry).toRawType();
+  }
+
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+  public override get encodedLength (): number {
+    let total = 0;
+
+    for (let i = 0, count = this.length; i < count; i++) {
+      total += this[i].encodedLength;
+    }
+
+    return total;
+  }
+
+  /**
+   * @description Returns a breakdown of the hex encoding for this Codec
+   */
+  public override inspect (): Inspect {
+    return {
+      inner: this.inspectInner()
+    };
+  }
+
+  public override toU8a (): Uint8Array {
+    // we override, we don't add the length prefix for ourselves, and at the same time we
+    // ignore isBare on entries, since they should be properly encoded at all times
+    const encoded = this.toU8aInner();
+
+    return encoded.length
+      ? u8aConcatStrict(encoded)
+      : new Uint8Array([]);
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public toRawType (): string {
+    return `[${this.Type};${this.length}]`;
+  }
+}

package/build-deno/base/index.ts

@@ -0,0 +1,13 @@
+
+export { Compact } from './Compact.ts';
+export { DoNotConstruct } from './DoNotConstruct.ts';
+export { Enum } from './Enum.ts';
+export { Int } from './Int.ts';
+export { Null } from './Null.ts';
+export { Option } from './Option.ts';
+export { Result } from './Result.ts';
+export { Tuple } from './Tuple.ts';
+export { UInt } from './UInt.ts';
+export { Vec } from './Vec.ts';
+export { VecAny } from './VecAny.ts';
+export { VecFixed } from './VecFixed.ts';

package/build-deno/bundle.ts

@@ -0,0 +1,9 @@
+
+export { packageInfo } from './packageInfo.ts';
+
+export * from './abstract/index.ts';
+export * from './base/index.ts';
+export * from './extended/index.ts';
+export * from './native/index.ts';
+export * from './primitive/index.ts';
+export * from './utils/index.ts';

package/build-deno/checkTypes.manual.ts

@@ -0,0 +1,10 @@
+
+import 'https://deno.land/x/pezkuwi/types-augment/mod.ts';
+
+import { TypeRegistry } from 'https://deno.land/x/pezkuwi/types/mod.ts';
+
+import { U32 } from './index.ts';
+
+const registry = new TypeRegistry();
+
+console.log(new U32(registry).divn(1));

package/build-deno/extended/BTreeMap.ts

@@ -0,0 +1,14 @@
+
+import type { Codec, CodecClass, Registry } from '../types/index.ts';
+
+import { CodecMap } from './Map.ts';
+
+export class BTreeMap<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 BTreeMap<K, V> {
+      constructor (registry: Registry, value?: Uint8Array | string | Map<any, any>) {
+        super(registry, keyType, valType, value, 'BTreeMap');
+      }
+    };
+  }
+}

package/build-deno/extended/BTreeSet.ts

@@ -0,0 +1,231 @@
+
+import type { HexString } from 'https://deno.land/x/pezkuwi/util/types.ts';
+import type { AnyJson, Codec, CodecClass, Inspect, ISet, IU8a, Registry } from '../types/index.ts';
+
+import { compactFromU8aLim, compactToU8a, isHex, isU8a, logger, stringify, u8aConcatStrict, u8aToHex, u8aToU8a } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+import { compareSet, decodeU8aVec, sortSet, typeToConstructor } from '../utils/index.ts';
+
+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/build-deno/extended/BitVec.ts

@@ -0,0 +1,135 @@
+
+import type { AnyU8a, Inspect, Registry } from '../types/index.ts';
+
+import { compactFromU8aLim, compactToU8a, isString, u8aConcatStrict, u8aToU8a } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+import { Raw } from '../native/Raw.ts';
+
+/** @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/build-deno/extended/Bytes.ts

@@ -0,0 +1,85 @@
+
+import type { AnyU8a, Inspect, Registry } from '../types/index.ts';
+
+import { compactAddLength, compactFromU8aLim, compactToU8a, isString, isU8a, u8aToU8a } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+import { Raw } from '../native/Raw.ts';
+
+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/build-deno/extended/HashMap.ts

@@ -0,0 +1,14 @@
+
+import type { Codec, CodecClass, Registry } from '../types/index.ts';
+
+import { CodecMap } from './Map.ts';
+
+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);
+      }
+    };
+  }
+}

package/build-deno/extended/Linkage.ts

@@ -0,0 +1,79 @@
+
+import type { HexString } from 'https://deno.land/x/pezkuwi/util/types.ts';
+import type { Codec, CodecClass, Registry } from '../types/index.ts';
+
+import { Option } from '../base/Option.ts';
+import { Tuple } from '../base/Tuple.ts';
+import { Vec } from '../base/Vec.ts';
+import { Struct } from '../native/Struct.ts';
+
+type TypeWithValues = [CodecClass, any[]];
+
+const EMPTY = new Uint8Array();
+
+/**
+ * @name Linkage
+ * @description The wrapper for the result from a LinkedMap
+ */
+export class Linkage<T extends Codec> extends Struct {
+  constructor (registry: Registry, Type: CodecClass | string, value?: unknown) {
+    super(registry, {
+      previous: Option.with(Type),
+      // eslint-disable-next-line sort-keys
+      next: Option.with(Type)
+    }, value as HexString);
+  }
+
+  public static withKey<O extends Codec> (Type: CodecClass | string): CodecClass<Linkage<O>> {
+    return class extends Linkage<O> {
+      constructor (registry: Registry, value?: unknown) {
+        super(registry, Type, value);
+      }
+    };
+  }
+
+  /**
+   * @description Returns the next item the Linkage is pointing to
+   */
+  public get previous (): Option<T> {
+    return this.get('previous') as Option<T>;
+  }
+
+  /**
+   * @description Returns the previous item the Linkage is pointing to
+   */
+  public get next (): Option<T> {
+    return this.get('next') as Option<T>;
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public override toRawType (): string {
+    return `Linkage<${this.next.toRawType(true)}>`;
+  }
+
+  /**
+   * @description Custom toU8a which with bare mode does not return the linkage if empty
+   */
+  public override toU8a (isBare?: boolean): Uint8Array {
+    // As part of a storage query (where these appear), in the case of empty, the values
+    // are NOT populated by the node - follow the same logic, leaving it empty
+    return this.isEmpty
+      ? EMPTY
+      : super.toU8a(isBare);
+  }
+}
+
+/**
+ * @name LinkageResult
+ * @description A Linkage keys/Values tuple
+ */
+export class LinkageResult extends Tuple {
+  constructor (registry: Registry, [TypeKey, keys]: TypeWithValues, [TypeValue, values]: TypeWithValues) {
+    super(registry, {
+      Keys: Vec.with(TypeKey),
+      Values: Vec.with(TypeValue)
+    }, [keys, values]);
+  }
+}