@pezkuwi/types-codec 16.5.6 → 16.5.8

package/build-deno/native/Bool.ts

@@ -0,0 +1,135 @@
+
+import type { HexString } from 'https://deno.land/x/pezkuwi/util/types.ts';
+import type { AnyBool, Codec, Inspect, IU8a, Registry } from '../types/index.ts';
+
+import { isU8a, u8aToHex } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+/**
+ * @name bool
+ * @description
+ * Representation for a boolean value in the system. It extends the base JS `Boolean` class
+ * @noInheritDoc
+ */
+export class bool extends Boolean implements Codec {
+  readonly registry: Registry;
+
+  public createdAtHash?: IU8a;
+  public initialU8aLength = 1;
+  public isStorageFallback?: boolean;
+
+  constructor (registry: Registry, value: bool | AnyBool | Uint8Array | number = false) {
+    super(
+      isU8a(value)
+        ? value[0] === 1
+        : value instanceof Boolean
+          ? value.valueOf()
+          : !!value
+    );
+
+    this.registry = registry;
+  }
+
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+  public get encodedLength (): number {
+    return 1 | 0;
+  }
+
+  /**
+   * @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 (true when it wraps false/default)
+   */
+  public get isEmpty (): boolean {
+    return this.isFalse;
+  }
+
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+  public get isFalse (): boolean {
+    return !this.isTrue;
+  }
+
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+  public get isTrue (): boolean {
+    return this.valueOf();
+  }
+
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+  public eq (other?: unknown): boolean {
+    return this.valueOf() === (
+      other instanceof Boolean
+        ? other.valueOf()
+        : other
+    );
+  }
+
+  /**
+   * @description Returns a breakdown of the hex encoding for this Codec
+   */
+  public inspect (): Inspect {
+    return {
+      outer: [this.toU8a()]
+    };
+  }
+
+  /**
+   * @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 (): boolean {
+    return this.toJSON();
+  }
+
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+  public toJSON (): boolean {
+    return this.valueOf();
+  }
+
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+  public toPrimitive (): boolean {
+    return this.toJSON();
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public toRawType (): string {
+    return 'bool';
+  }
+
+  /**
+   * @description Returns the string representation of the value
+   */
+  public override toString (): string {
+    return this.toJSON().toString();
+  }
+
+  /**
+   * @description Encodes the value as a Uint8Array as per the SCALE specifications
+   */
+  public toU8a (_isBare?: boolean): Uint8Array {
+    return new Uint8Array([this.valueOf() ? 1 : 0]);
+  }
+}

package/build-deno/native/Date.ts

@@ -0,0 +1,167 @@
+
+import type { HexString } from 'https://deno.land/x/pezkuwi/util/types.ts';
+import type { AnyNumber, Inspect, INumber, IU8a, Registry, UIntBitLength } from '../types/index.ts';
+
+import { BN, bnToBn, bnToHex, bnToU8a, isString, isU8a, u8aToBn } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+const BITLENGTH: UIntBitLength = 64;
+const U8A_OPTS = { bitLength: BITLENGTH, isLe: true };
+
+function decodeDate (value: CodecDate | Date | AnyNumber): Date {
+  if (isU8a(value)) {
+    value = u8aToBn(value.subarray(0, BITLENGTH / 8));
+  } else if (value instanceof Date) {
+    return value;
+  } else if (isString(value)) {
+    value = new BN(value.toString(), 10, 'le');
+  }
+
+  return new Date(
+    bnToBn(value as BN).toNumber() * 1000
+  );
+}
+
+/**
+ * @name Date
+ * @description
+ * A wrapper around seconds/timestamps. Internally the representation only has
+ * second precicion (aligning with Rust), so any numbers passed an/out are always
+ * per-second. For any encoding/decoding the 1000 multiplier would be applied to
+ * get it in line with JavaScript formats. It extends the base JS `Date` object
+ * and has all the methods available that are applicable to any `Date`
+ * @noInheritDoc
+ */
+export class CodecDate extends Date implements INumber {
+  readonly registry: Registry;
+
+  public createdAtHash?: IU8a;
+  public initialU8aLength = BITLENGTH / 8;
+  public isStorageFallback?: boolean;
+
+  constructor (registry: Registry, value: CodecDate | Date | AnyNumber = 0) {
+    super(decodeDate(value));
+
+    this.registry = registry;
+  }
+
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+  public get encodedLength (): number {
+    return BITLENGTH / 8;
+  }
+
+  /**
+   * @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.getTime() === 0;
+  }
+
+  /**
+   * @description Returns the number of bits in the value
+   */
+  public bitLength (): UIntBitLength {
+    return BITLENGTH;
+  }
+
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+  public eq (other?: unknown): boolean {
+    return decodeDate(other as AnyNumber).getTime() === this.getTime();
+  }
+
+  /**
+   * @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 BigInt(this.toNumber());
+  }
+
+  /**
+   * @description Returns the BN representation of the timestamp
+   */
+  public toBn (): BN {
+    return new BN(this.toNumber());
+  }
+
+  /**
+   * @description Returns a hex string representation of the value
+   */
+  public toHex (isLe = false): HexString {
+    return bnToHex(this.toBn(), {
+      bitLength: BITLENGTH,
+      isLe,
+      isNegative: false
+    });
+  }
+
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+  public toHuman (): string {
+    return this.toISOString();
+  }
+
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+  public override toJSON (): any {
+    // FIXME Return type should be number, but conflicts with Date.toJSON()
+    // which returns string
+    return this.toNumber();
+  }
+
+  /**
+   * @description Returns the number representation for the timestamp
+   */
+  public toNumber (): number {
+    return Math.ceil(this.getTime() / 1000);
+  }
+
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+  public toPrimitive (): number {
+    return this.toNumber();
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public toRawType (): string {
+    return 'Moment';
+  }
+
+  /**
+   * @description Returns the string representation of the value
+   */
+  public override toString (): string {
+    // only included here since we do not inherit docs
+    return super.toString();
+  }
+
+  /**
+   * @description Encodes the value as a Uint8Array as per the SCALE specifications
+   */
+  public toU8a (_isBare?: boolean): Uint8Array {
+    return bnToU8a(this.toNumber(), U8A_OPTS);
+  }
+}

package/build-deno/native/Float.ts

@@ -0,0 +1,134 @@
+
+import type { HexString } from 'https://deno.land/x/pezkuwi/util/types.ts';
+import type { AnyFloat, CodecClass, IFloat, Inspect, IU8a, Registry } from '../types/index.ts';
+
+import { floatToU8a, isHex, isU8a, u8aToFloat, u8aToHex, u8aToU8a } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+interface Options {
+  bitLength?: 32 | 64;
+}
+
+/**
+ * @name Float
+ * @description
+ * A Codec wrapper for F32 & F64 values. You generally don't want to be using
+ * f32/f64 in your runtime, operations on fixed points numbers are preferable. This class
+ * was explicitly added since scale-codec has a flag that enables this and it is available
+ * in some eth_* RPCs
+ */
+export class Float extends Number implements IFloat {
+  readonly encodedLength: number;
+  readonly registry: Registry;
+
+  public createdAtHash?: IU8a;
+  public initialU8aLength?: number;
+  public isStorageFallback?: boolean;
+
+  readonly #bitLength: 32 | 64;
+
+  constructor (registry: Registry, value?: AnyFloat, { bitLength = 32 }: Options = {}) {
+    super(
+      isU8a(value) || isHex(value)
+        ? value.length === 0
+          ? 0
+          : u8aToFloat(u8aToU8a(value), { bitLength })
+        : (value || 0)
+    );
+
+    this.#bitLength = bitLength;
+    this.encodedLength = bitLength / 8;
+    this.initialU8aLength = this.encodedLength;
+    this.registry = registry;
+  }
+
+  public static with (bitLength: 32 | 64): CodecClass<Float> {
+    return class extends Float {
+      constructor (registry: Registry, value?: AnyFloat) {
+        super(registry, value, { bitLength });
+      }
+    };
+  }
+
+  /**
+   * @description returns a hash of the contents
+   */
+  public get hash (): IU8a {
+    return this.registry.hash(this.toU8a());
+  }
+
+  /**
+   * @description Returns true if the type wraps an empty/default all-0 value
+   */
+  get isEmpty (): boolean {
+    return this.valueOf() === 0;
+  }
+
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+  public eq (other?: unknown): boolean {
+    return this.valueOf() === Number(other);
+  }
+
+  /**
+   * @description Returns a breakdown of the hex encoding for this Codec
+   */
+  public inspect (): Inspect {
+    return {
+      outer: [this.toU8a()]
+    };
+  }
+
+  /**
+   * @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 (): string {
+    return this.toString();
+  }
+
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+  public toJSON (): string {
+    // Not sure if this is actually a hex or a string value
+    // (would need to check against RPCs to see the result here)
+    return this.toHex();
+  }
+
+  /**
+   * @description Returns the number representation (Same as valueOf)
+   */
+  public toNumber (): number {
+    return this.valueOf();
+  }
+
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+  public toPrimitive (): number {
+    return this.toNumber();
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public toRawType (): string {
+    return `f${this.#bitLength}`;
+  }
+
+  /**
+   * @description Encodes the value as a Uint8Array as per the SCALE specifications
+   */
+  public toU8a (_isBare?: boolean): Uint8Array {
+    return floatToU8a(this, {
+      bitLength: this.#bitLength
+    });
+  }
+}

package/build-deno/native/Json.ts

@@ -0,0 +1,145 @@
+
+import type { HexString } from 'https://deno.land/x/pezkuwi/util/types.ts';
+import type { AnyJson, Codec, Inspect, IU8a, Registry } from '../types/index.ts';
+
+import { isFunction, objectProperties, stringify } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+import { compareMap } from '../utils/index.ts';
+
+/** @internal */
+function decodeJson (value?: Record<string, unknown> | null): [string, any][] {
+  return Object.entries(value || {});
+}
+
+/**
+ * @name Json
+ * @description
+ * Wraps the a JSON structure retrieve via RPC. It extends the standard JS Map with. While it
+ * implements a Codec, it is limited in that it can only be used with input objects via RPC,
+ * i.e. no hex decoding. Unlike a struct, this waps a JSON object with unknown keys
+ * @noInheritDoc
+ */
+export class Json extends Map<string, any> implements Codec {
+  readonly registry: Registry;
+
+  public createdAtHash?: IU8a;
+  public initialU8aLength?: number;
+  public isStorageFallback?: boolean;
+
+  constructor (registry: Registry, value?: Record<string, unknown> | null) {
+    const decoded = decodeJson(value);
+
+    super(decoded);
+
+    this.registry = registry;
+
+    objectProperties(this, decoded.map(([k]) => k), (k) => this.get(k));
+  }
+
+  /**
+   * @description Always 0, never encodes as a Uint8Array
+   */
+  public get encodedLength (): number {
+    return 0 | 0;
+  }
+
+  /**
+   * @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.keys()].length === 0;
+  }
+
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+  public eq (other?: unknown): boolean {
+    return compareMap(this, other);
+  }
+
+  /**
+   * @description Returns a typed value from the internal map
+   */
+  public getT <T> (key: string): T {
+    return this.get(key) as unknown as T;
+  }
+
+  /**
+   * @description Unimplemented, will throw
+   */
+  public inspect (): Inspect {
+    throw new Error('Unimplemented');
+  }
+
+  /**
+   * @description Unimplemented, will throw
+   */
+  public toHex (): HexString {
+    throw new Error('Unimplemented');
+  }
+
+  /**
+   * @description Converts the Object to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+  public toHuman (): Record<string, AnyJson> {
+    return [...this.entries()].reduce<Record<string, AnyJson>>((json, [key, value]): Record<string, AnyJson> => {
+      json[key] = isFunction((value as Codec)?.toHuman)
+        ? (value as Codec).toHuman()
+        : value as AnyJson;
+
+      return json;
+    }, {});
+  }
+
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+  public toJSON (): Record<string, AnyJson> {
+    return [...this.entries()].reduce<Record<string, AnyJson>>((json, [key, value]): Record<string, AnyJson> => {
+      json[key] = value as AnyJson;
+
+      return json;
+    }, {});
+  }
+
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+  public toPrimitive (disableAscii?: boolean): Record<string, AnyJson> {
+    return [...this.entries()].reduce<Record<string, AnyJson>>((json, [key, value]): Record<string, AnyJson> => {
+      json[key] = isFunction((value as Codec).toPrimitive)
+        ? (value as Codec).toPrimitive(disableAscii)
+        : value as AnyJson;
+
+      return json;
+    }, {});
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public toRawType (): string {
+    return 'Json';
+  }
+
+  /**
+   * @description Returns the string representation of the value
+   */
+  public override toString (): string {
+    return stringify(this.toJSON());
+  }
+
+  /**
+   * @description Unimplemented, will throw
+   */
+  public toU8a (_isBare?: boolean): Uint8Array {
+    throw new Error('Unimplemented');
+  }
+}