@polkadot/types-codec 6.12.2-10

package/native/Date.js

@@ -0,0 +1,158 @@
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+import { BN, bnToBn, bnToHex, bnToU8a, isString, isU8a, u8aToBn } from '@polkadot/util';
+const BITLENGTH = 64;
+
+function decodeDate(value) {
+  if (isU8a(value)) {
+    value = u8aToBn(value.subarray(0, BITLENGTH / 8), true);
+  } else if (value instanceof Date) {
+    return value;
+  } else if (isString(value)) {
+    value = new BN(value.toString(), 10, 'le');
+  }
+
+  return new Date(bnToBn(value).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 {
+  constructor(registry, value = 0) {
+    super(decodeDate(value));
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    this.registry = registry;
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return BITLENGTH / 8;
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    return this.registry.hash(this.toU8a());
+  }
+  /**
+   * @description Checks if the value is an empty value
+   */
+
+
+  get isEmpty() {
+    return this.getTime() === 0;
+  }
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+
+
+  eq(other) {
+    return decodeDate(other).getTime() === this.getTime();
+  }
+  /**
+   * @description Returns the number of bits in the value
+   */
+
+
+  bitLength() {
+    return BITLENGTH;
+  }
+  /**
+   * @description Returns a BigInt representation of the number
+   */
+
+
+  toBigInt() {
+    return BigInt(this.toNumber());
+  }
+  /**
+   * @description Returns the BN representation of the timestamp
+   */
+
+
+  toBn() {
+    return new BN(this.toNumber());
+  }
+  /**
+   * @description Returns a hex string representation of the value
+   */
+
+
+  toHex(isLe = false) {
+    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
+   */
+
+
+  toHuman() {
+    return this.toISOString();
+  }
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+
+
+  toJSON() {
+    // 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
+   */
+
+
+  toNumber() {
+    return Math.ceil(this.getTime() / 1000);
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return 'Moment';
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    // only included here since we do not inherit docs
+    return super.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)
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+
+
+  toU8a(isBare) {
+    return bnToU8a(this.toNumber(), BITLENGTH, true);
+  }
+
+}

package/native/Json.cjs

@@ -0,0 +1,137 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Json = void 0;
+
+var _util = require("@polkadot/util");
+
+var _index = require("../utils/index.cjs");
+
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/** @internal */
+function decodeJson(value) {
+  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
+ */
+
+
+class Json extends Map {
+  constructor(registry, value) {
+    const decoded = decodeJson(value);
+    super(decoded);
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    this.registry = registry;
+    (0, _util.objectProperties)(this, decoded.map(_ref => {
+      let [k] = _ref;
+      return k;
+    }), k => this.get(k));
+  }
+  /**
+   * @description Always 0, never encodes as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return 0;
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    return this.registry.hash(this.toU8a());
+  }
+  /**
+   * @description Checks if the value is an empty value
+   */
+
+
+  get isEmpty() {
+    return [...this.keys()].length === 0;
+  }
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+
+
+  eq(other) {
+    return (0, _index.compareMap)(this, other);
+  }
+
+  getT(key) {
+    return this.get(key);
+  }
+  /**
+   * @description Unimplemented, will throw
+   */
+
+
+  toHex() {
+    throw new Error('Unimplemented');
+  }
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+
+
+  toHuman() {
+    return [...this.entries()].reduce((json, _ref2) => {
+      let [key, value] = _ref2;
+      json[key] = (0, _util.isFunction)(value.toHuman) ? value.toHuman() : value;
+      return json;
+    }, {});
+  }
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+
+
+  toJSON() {
+    return [...this.entries()].reduce((json, _ref3) => {
+      let [key, value] = _ref3;
+      json[key] = value;
+      return json;
+    }, {});
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return 'Json';
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    return (0, _util.stringify)(this.toJSON());
+  }
+  /**
+   * @description Unimplemented, will throw
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+
+
+  toU8a(isBare) {
+    throw new Error('Unimplemented');
+  }
+
+}
+
+exports.Json = Json;

package/native/Json.d.ts

@@ -0,0 +1,56 @@
+import type { HexString } from '@polkadot/util/types';
+import type { AnyJson, Codec, CodecRegistry, IU8a } from '../types';
+/**
+ * @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 declare class Json extends Map<string, any> implements Codec {
+    readonly registry: CodecRegistry;
+    createdAtHash?: IU8a;
+    constructor(registry: CodecRegistry, value?: Record<string, unknown> | null);
+    /**
+     * @description Always 0, never encodes as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other?: unknown): boolean;
+    getT<T>(key: string): T;
+    /**
+     * @description Unimplemented, will throw
+     */
+    toHex(): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(): Record<string, AnyJson>;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): Record<string, AnyJson>;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString(): string;
+    /**
+     * @description Unimplemented, will throw
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+}

package/native/Json.js

@@ -0,0 +1,121 @@
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+import { isFunction, objectProperties, stringify } from '@polkadot/util';
+import { compareMap } from "../utils/index.js";
+/** @internal */
+
+function decodeJson(value) {
+  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 {
+  constructor(registry, value) {
+    const decoded = decodeJson(value);
+    super(decoded);
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    this.registry = registry;
+    objectProperties(this, decoded.map(([k]) => k), k => this.get(k));
+  }
+  /**
+   * @description Always 0, never encodes as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return 0;
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    return this.registry.hash(this.toU8a());
+  }
+  /**
+   * @description Checks if the value is an empty value
+   */
+
+
+  get isEmpty() {
+    return [...this.keys()].length === 0;
+  }
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+
+
+  eq(other) {
+    return compareMap(this, other);
+  }
+
+  getT(key) {
+    return this.get(key);
+  }
+  /**
+   * @description Unimplemented, will throw
+   */
+
+
+  toHex() {
+    throw new Error('Unimplemented');
+  }
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+
+
+  toHuman() {
+    return [...this.entries()].reduce((json, [key, value]) => {
+      json[key] = isFunction(value.toHuman) ? value.toHuman() : value;
+      return json;
+    }, {});
+  }
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+
+
+  toJSON() {
+    return [...this.entries()].reduce((json, [key, value]) => {
+      json[key] = value;
+      return json;
+    }, {});
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return 'Json';
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    return stringify(this.toJSON());
+  }
+  /**
+   * @description Unimplemented, will throw
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+
+
+  toU8a(isBare) {
+    throw new Error('Unimplemented');
+  }
+
+}

package/native/Raw.cjs

@@ -0,0 +1,192 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Raw = void 0;
+
+var _util = require("@polkadot/util");
+
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @name Raw
+ * @description
+ * A basic wrapper around Uint8Array, with no frills and no fuss. It does differ
+ * from other implementations where it will consume the full Uint8Array as passed to it.
+ * As such it is meant to be subclassed where the wrapper takes care of the
+ * actual lengths instead of used directly.
+ * @noInheritDoc
+ */
+class Raw extends Uint8Array {
+  constructor(registry, value, initialU8aLength) {
+    super((0, _util.u8aToU8a)(value));
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    this.initialU8aLength = void 0;
+    this.registry = registry;
+    this.initialU8aLength = initialU8aLength;
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return this.length;
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    return this.registry.hash(this.toU8a());
+  }
+  /**
+   * @description Returns true if the wrapped value contains only ASCII printable characters
+   */
+
+
+  get isAscii() {
+    return (0, _util.isAscii)(this);
+  }
+  /**
+   * @description Returns true if the type wraps an empty/default all-0 value
+   */
+
+
+  get isEmpty() {
+    return !this.length || (0, _util.isUndefined)(this.find(b => !!b));
+  }
+  /**
+   * @description Returns true if the wrapped value contains only utf8 characters
+   */
+
+
+  get isUtf8() {
+    return (0, _util.isUtf8)(this);
+  }
+  /**
+   * @description The length of the value
+   */
+
+
+  get length() {
+    // only included here since we ignore inherited docs
+    return super.length;
+  }
+  /**
+   * @description Returns the number of bits in the value
+   */
+
+
+  bitLength() {
+    return this.length * 8;
+  }
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+
+
+  eq(other) {
+    if (other instanceof Uint8Array) {
+      return this.length === other.length && !this.some((b, index) => b !== other[index]);
+    }
+
+    return this.eq((0, _util.u8aToU8a)(other));
+  }
+  /**
+   * @description Create a new slice from the actual buffer. (compat)
+   * @param start The position to start at
+   * @param end The position to end at
+   */
+
+
+  slice(start, end) {
+    // Like subarray below, we have to follow this approach since we are extending the TypeArray.
+    // This happens especially when it comes to further extensions, the length may be an override
+    return Uint8Array.from(this).slice(start, end);
+  }
+  /**
+   * @description Create a new subarray from the actual buffer. (compat)
+   * @param begin The position to start at
+   * @param end The position to end at
+   */
+
+
+  subarray(begin, end) {
+    return Uint8Array.from(this).subarray(begin, end);
+  }
+  /**
+   * @description Returns a hex string representation of the value
+   */
+
+
+  toHex() {
+    return (0, _util.u8aToHex)(this);
+  }
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+
+
+  toHuman() {
+    if (this.isAscii) {
+      const text = this.toUtf8(); // ensure we didn't end up with multibyte codepoints
+
+      if ((0, _util.isAscii)(text)) {
+        return text;
+      }
+    }
+
+    return this.toJSON();
+  }
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+
+
+  toJSON() {
+    return this.toHex();
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return 'Raw';
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    return this.toHex();
+  }
+  /**
+   * @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)
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+
+
+  toU8a(isBare) {
+    return Uint8Array.from(this);
+  }
+  /**
+   * @description Returns the wrapped data as a UTF-8 string
+   */
+
+
+  toUtf8() {
+    (0, _util.assert)(this.isUtf8, 'The character sequence is not a valid Utf8 string');
+    return (0, _util.u8aToString)(this);
+  }
+
+}
+
+exports.Raw = Raw;