@pezkuwi/types-codec 16.5.5 → 16.5.8

package/build/utils/sortValues.js

@@ -0,0 +1,79 @@
+import { bnToBn, isBigInt, isBn, isBoolean, isCodec, isNumber, stringify } from '@pezkuwi/util';
+/** @internal **/
+function isArrayLike(arg) {
+    return arg instanceof Uint8Array || Array.isArray(arg);
+}
+/** @internal **/
+function isEnum(arg) {
+    return isCodec(arg) && isNumber(arg.index) && isCodec(arg.value);
+}
+/** @internal **/
+function isOption(arg) {
+    return isCodec(arg) && isBoolean(arg.isSome) && isCodec(arg.value);
+}
+/** @internal */
+function isNumberLike(arg) {
+    return isNumber(arg) || isBn(arg) || isBigInt(arg);
+}
+/** @internal */
+function sortArray(a, b) {
+    // Vec, Tuple, Bytes etc.
+    let sortRes = 0;
+    const minLen = Math.min(a.length, b.length);
+    for (let i = 0; i < minLen; ++i) {
+        sortRes = sortAsc(a[i], b[i]);
+        if (sortRes !== 0) {
+            return sortRes;
+        }
+    }
+    return a.length - b.length;
+}
+/** @internal */
+function checkForDuplicates(container, seen, arg) {
+    // Convert the value to hex.
+    if (isCodec(arg)) {
+        const hex = arg.toHex();
+        // Check if we have seen the value.
+        if (seen.has(hex)) {
+            // Duplicates are not allowed.
+            throw new Error(`Duplicate value in ${container}: ${stringify(arg)}`);
+        }
+        seen.add(hex);
+    }
+    return true;
+}
+/**
+* Sort keys/values of BTreeSet/BTreeMap in ascending order for encoding compatibility with Rust's BTreeSet/BTreeMap
+* (https://doc.rust-lang.org/stable/std/collections/struct.BTreeSet.html)
+* (https://doc.rust-lang.org/stable/std/collections/struct.BTreeMap.html)
+*/
+export function sortAsc(a, b) {
+    if (isNumberLike(a) && isNumberLike(b)) {
+        return bnToBn(a).cmp(bnToBn(b));
+    }
+    else if (a instanceof Map && b instanceof Map) {
+        return sortAsc(Array.from(a.values()), Array.from(b.values()));
+    }
+    else if (isEnum(a) && isEnum(b)) {
+        return sortAsc(a.index, b.index) || sortAsc(a.value, b.value);
+    }
+    else if (isOption(a) && isOption(b)) {
+        return sortAsc(a.isNone ? 0 : 1, b.isNone ? 0 : 1) || sortAsc(a.value, b.value);
+    }
+    else if (isArrayLike(a) && isArrayLike(b)) {
+        return sortArray(a, b);
+    }
+    else if (isCodec(a) && isCodec(b)) {
+        // Text, Bool etc.
+        return sortAsc(a.toU8a(true), b.toU8a(true));
+    }
+    throw new Error(`Attempting to sort unrecognized values: ${stringify(a)} (typeof ${typeof a}) <-> ${stringify(b)} (typeof ${typeof b})`);
+}
+export function sortSet(set) {
+    const seen = new Set();
+    return new Set(Array.from(set).filter((value) => checkForDuplicates('BTreeSet', seen, value)).sort(sortAsc));
+}
+export function sortMap(map) {
+    const seen = new Set();
+    return new Map(Array.from(map.entries()).filter(([key]) => checkForDuplicates('BTreeMap', seen, key)).sort(([keyA], [keyB]) => sortAsc(keyA, keyB)));
+}

package/build/utils/toConstructors.js

@@ -0,0 +1,35 @@
+/**
+ * @internal
+ * From a type string or class, return the associated type class
+ */
+export function typeToConstructor(registry, type) {
+    return typeof type === 'function'
+        ? type
+        : registry.createClassUnsafe(type);
+}
+/**
+ * @internal
+ * Takes an input array of types and returns the associated classes for it
+*/
+export function typesToConstructors(registry, types) {
+    const count = types.length;
+    const result = new Array(count);
+    for (let i = 0; i < count; i++) {
+        result[i] = typeToConstructor(registry, types[i]);
+    }
+    return result;
+}
+/**
+ * @internal
+ * Takes an input map of the form `{ [string]: string | CodecClass }` and returns a map of `{ [string]: CodecClass }`
+ */
+export function mapToTypeMap(registry, input) {
+    const entries = Object.entries(input);
+    const count = entries.length;
+    const output = [new Array(count), new Array(count)];
+    for (let i = 0; i < count; i++) {
+        output[1][i] = entries[i][0];
+        output[0][i] = typeToConstructor(registry, entries[i][1]);
+    }
+    return output;
+}

package/build/utils/typesToMap.js

@@ -0,0 +1,7 @@
+export function typesToMap(registry, [Types, keys]) {
+    const result = {};
+    for (let i = 0, count = keys.length; i < count; i++) {
+        result[keys[i]] = registry.getClassName(Types[i]) || new Types[i](registry).toRawType();
+    }
+    return result;
+}

package/build/utils/util.js

@@ -0,0 +1,4 @@
+import { isFunction } from '@pezkuwi/util';
+export function hasEq(o) {
+    return isFunction(o.eq);
+}

package/build-deno/README.md

@@ -0,0 +1,3 @@
+# @pezkuwi/types-codec
+
+Base scale-codec types.

package/build-deno/abstract/Array.ts

@@ -0,0 +1,211 @@
+
+import type { HexString } from 'https://deno.land/x/pezkuwi/util/types.ts';
+import type { AnyJson, Codec, Inspect, IU8a, IVec, Registry } from '../types/index.ts';
+
+import { compactToU8a, u8aConcatStrict, u8aToHex } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+import { compareArray } from '../utils/compareArray.ts';
+
+/**
+ * @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 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/build-deno/abstract/Base.ts

@@ -0,0 +1,127 @@
+
+import type { HexString } from 'https://deno.land/x/pezkuwi/util/types.ts';
+import type { AnyJson, BareOpts, Codec, Inspect, IU8a, Registry } from '../types/index.ts';
+
+/**
+ * @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;
+  }
+}