@polkadot/types-codec 6.12.2-10

package/native/Struct.js

@@ -0,0 +1,286 @@
+import _classPrivateFieldLooseBase from "@babel/runtime/helpers/esm/classPrivateFieldLooseBase";
+import _classPrivateFieldLooseKey from "@babel/runtime/helpers/esm/classPrivateFieldLooseKey";
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+import { assert, isBoolean, isFunction, isHex, isObject, isU8a, isUndefined, objectProperties, stringCamelCase, stringify, u8aConcat, u8aToHex, u8aToU8a } from '@polkadot/util';
+import { compareMap, decodeU8a, mapToTypeMap, typesToMap } from "../utils/index.js";
+
+/** @internal */
+function decodeStructFromObject(registry, Types, value, jsonMap) {
+  let jsonObj;
+  const inputKeys = Object.keys(Types);
+  const typeofArray = Array.isArray(value);
+  const typeofMap = value instanceof Map;
+  assert(typeofArray || typeofMap || isObject(value), () => `Struct: Cannot decode value ${stringify(value)} (typeof ${typeof value}), expected an input object, map or array`);
+  assert(!typeofArray || value.length === inputKeys.length, () => `Struct: Unable to map ${stringify(value)} array to object with known keys ${inputKeys.join(', ')}`);
+  const raw = new Array(inputKeys.length);
+
+  for (let i = 0; i < inputKeys.length; i++) {
+    const key = inputKeys[i];
+    const jsonKey = jsonMap.get(key) || key;
+    const Type = Types[key];
+    let assign;
+
+    try {
+      if (typeofArray) {
+        assign = value[i];
+      } else if (typeofMap) {
+        assign = jsonKey && value.get(jsonKey);
+      } else {
+        assign = jsonKey && value[jsonKey];
+
+        if (isUndefined(assign)) {
+          if (isUndefined(jsonObj)) {
+            const entries = Object.entries(value);
+            jsonObj = {};
+
+            for (let e = 0; e < entries.length; e++) {
+              jsonObj[stringCamelCase(entries[e][0])] = entries[e][1];
+            }
+          }
+
+          assign = jsonKey && jsonObj[jsonKey];
+        }
+      }
+
+      raw[i] = [key, assign instanceof Type ? assign : new Type(registry, assign)];
+    } catch (error) {
+      let type = Type.name;
+
+      try {
+        type = new Type(registry).toRawType();
+      } catch (error) {// ignore
+      }
+
+      throw new Error(`Struct: failed on ${jsonKey}: ${type}:: ${error.message}`);
+    }
+  }
+
+  return [raw, 0];
+}
+/**
+ * @name Struct
+ * @description
+ * A Struct defines an Object with key-value pairs - where the values are Codec values. It removes
+ * a lot of repetition from the actual coding, define a structure type, pass it the key/Codec
+ * values in the constructor and it manages the decoding. It is important that the constructor
+ * values matches 100% to the order in th Rust code, i.e. don't go crazy and make it alphabetical,
+ * it needs to decoded in the specific defined order.
+ * @noInheritDoc
+ */
+
+
+var _registry = /*#__PURE__*/_classPrivateFieldLooseKey("registry");
+
+var _jsonMap = /*#__PURE__*/_classPrivateFieldLooseKey("jsonMap");
+
+var _Types = /*#__PURE__*/_classPrivateFieldLooseKey("Types");
+
+export class Struct extends Map {
+  constructor(registry, Types, value, jsonMap = new Map()) {
+    const typeMap = mapToTypeMap(registry, Types);
+    const [decoded, decodedLength] = isU8a(value) ? decodeU8a(registry, value, typeMap, true) : isHex(value) ? decodeU8a(registry, u8aToU8a(value), typeMap, true) : value instanceof Struct ? [value, 0] : decodeStructFromObject(registry, typeMap, value || {}, jsonMap);
+    super(decoded);
+    Object.defineProperty(this, _registry, {
+      writable: true,
+      value: void 0
+    });
+    this.createdAtHash = void 0;
+    this.initialU8aLength = void 0;
+    Object.defineProperty(this, _jsonMap, {
+      writable: true,
+      value: void 0
+    });
+    Object.defineProperty(this, _Types, {
+      writable: true,
+      value: void 0
+    });
+    _classPrivateFieldLooseBase(this, _registry)[_registry] = registry;
+    this.initialU8aLength = decodedLength;
+    _classPrivateFieldLooseBase(this, _jsonMap)[_jsonMap] = jsonMap;
+    _classPrivateFieldLooseBase(this, _Types)[_Types] = typeMap;
+  }
+
+  static with(Types, jsonMap) {
+    const keys = Object.keys(Types);
+    return class extends Struct {
+      constructor(registry, value) {
+        super(registry, Types, value, jsonMap);
+        objectProperties(this, keys, k => this.get(k));
+      }
+
+    };
+  }
+  /**
+   * @description The available keys for this struct
+   */
+
+
+  get defKeys() {
+    return Object.keys(_classPrivateFieldLooseBase(this, _Types)[_Types]);
+  }
+
+  getT(key) {
+    return this.get(key);
+  }
+  /**
+   * @description Checks if the value is an empty value
+   */
+
+
+  get isEmpty() {
+    for (const v of this.values()) {
+      if (!v.isEmpty) {
+        return false;
+      }
+    }
+
+    return true;
+  }
+  /**
+   * @description Returns the Type description of the structure
+   */
+
+
+  get Type() {
+    const result = {};
+    const defs = Object.entries(_classPrivateFieldLooseBase(this, _Types)[_Types]);
+
+    for (let i = 0; i < defs.length; i++) {
+      const [key, Type] = defs[i];
+      result[key] = new Type(this.registry).toRawType();
+    }
+
+    return result;
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    let total = 0;
+
+    for (const v of this.values()) {
+      total += v.encodedLength;
+    }
+
+    return total;
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    return this.registry.hash(this.toU8a());
+  }
+
+  get registry() {
+    return _classPrivateFieldLooseBase(this, _registry)[_registry];
+  }
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+
+
+  eq(other) {
+    return compareMap(this, other);
+  }
+  /**
+   * @description Returns a specific names entry in the structure
+   * @param name The name of the entry to retrieve
+   */
+
+
+  get(name) {
+    return super.get(name);
+  }
+  /**
+   * @description Returns the values of a member at a specific index (Rather use get(name) for performance)
+   */
+
+
+  getAtIndex(index) {
+    return this.toArray()[index];
+  }
+  /**
+   * @description Converts the Object to an standard JavaScript Array
+   */
+
+
+  toArray() {
+    return [...this.values()];
+  }
+  /**
+   * @description Returns a hex string representation of the value
+   */
+
+
+  toHex() {
+    return u8aToHex(this.toU8a());
+  }
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+
+
+  toHuman(isExtended) {
+    const json = {};
+
+    for (const [k, v] of this.entries()) {
+      json[k] = v && v.toHuman(isExtended);
+    }
+
+    return json;
+  }
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+
+
+  toJSON() {
+    const json = {};
+
+    for (const [k, v] of this.entries()) {
+      const jsonKey = _classPrivateFieldLooseBase(this, _jsonMap)[_jsonMap].get(k) || k;
+      json[jsonKey] = v && v.toJSON();
+    }
+
+    return json;
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return stringify(typesToMap(this.registry, _classPrivateFieldLooseBase(this, _Types)[_Types]));
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    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)
+   */
+
+
+  toU8a(isBare) {
+    const encoded = [];
+
+    for (const [k, v] of this.entries()) {
+      if (v && isFunction(v.toU8a)) {
+        encoded.push(v.toU8a(!isBare || isBoolean(isBare) ? isBare : isBare[k]));
+      }
+    }
+
+    return u8aConcat(...encoded);
+  }
+
+}

package/native/Text.cjs

@@ -0,0 +1,193 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Text = void 0;
+
+var _classPrivateFieldLooseBase2 = _interopRequireDefault(require("@babel/runtime/helpers/classPrivateFieldLooseBase"));
+
+var _classPrivateFieldLooseKey2 = _interopRequireDefault(require("@babel/runtime/helpers/classPrivateFieldLooseKey"));
+
+var _util = require("@polkadot/util");
+
+var _Raw = require("./Raw.cjs");
+
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+const MAX_LENGTH = 128 * 1024;
+/** @internal */
+
+function decodeText(value) {
+  if ((0, _util.isU8a)(value)) {
+    if (!value.length) {
+      return ['', 0];
+    } // for Raw, the internal buffer does not have an internal length
+    // (the same applies in e.g. Bytes, where length is added at encoding-time)
+
+
+    if (value instanceof _Raw.Raw) {
+      return [(0, _util.u8aToString)(value), 0];
+    }
+
+    const [offset, length] = (0, _util.compactFromU8a)(value);
+    const total = offset + length.toNumber();
+    (0, _util.assert)(length.lten(MAX_LENGTH), () => `Text: length ${length.toString()} exceeds ${MAX_LENGTH}`);
+    (0, _util.assert)(total <= value.length, () => `Text: required length less than remainder, expected at least ${total}, found ${value.length}`);
+    return [(0, _util.u8aToString)(value.subarray(offset, total)), total];
+  } else if ((0, _util.isHex)(value)) {
+    return [(0, _util.u8aToString)((0, _util.hexToU8a)(value)), 0];
+  }
+
+  return [value ? value.toString() : '', 0];
+}
+/**
+ * @name Text
+ * @description
+ * This is a string wrapper, along with the length. It is used both for strings as well
+ * as items such as documentation. It simply extends the standard JS `String` built-in
+ * object, inheriting all methods exposed from `String`.
+ * @noInheritDoc
+ */
+// TODO
+//   - Strings should probably be trimmed (docs do come through with extra padding)
+
+
+var _initialU8aLength = /*#__PURE__*/(0, _classPrivateFieldLooseKey2.default)("initialU8aLength");
+
+var _override = /*#__PURE__*/(0, _classPrivateFieldLooseKey2.default)("override");
+
+class Text extends String {
+  constructor(registry, value) {
+    const [str, decodedLength] = decodeText(value);
+    super(str);
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    Object.defineProperty(this, _initialU8aLength, {
+      writable: true,
+      value: void 0
+    });
+    Object.defineProperty(this, _override, {
+      writable: true,
+      value: null
+    });
+    this.registry = registry;
+    (0, _classPrivateFieldLooseBase2.default)(this, _initialU8aLength)[_initialU8aLength] = decodedLength;
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return this.toU8a().length;
+  }
+  /**
+   * @description The length of the initial encoded value (Only available when constructed from a Uint8Array)
+   */
+
+
+  get initialU8aLength() {
+    return (0, _classPrivateFieldLooseBase2.default)(this, _initialU8aLength)[_initialU8aLength];
+  }
+  /**
+   * @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.length === 0;
+  }
+  /**
+   * @description The length of the value
+   */
+
+
+  get length() {
+    // 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
+   */
+
+
+  eq(other) {
+    return (0, _util.isString)(other) ? this.toString() === other.toString() : false;
+  }
+  /**
+   * @description Set an override value for this
+   */
+
+
+  setOverride(override) {
+    (0, _classPrivateFieldLooseBase2.default)(this, _override)[_override] = override;
+  }
+  /**
+   * @description Returns a hex string representation of the value
+   */
+
+
+  toHex() {
+    // like with Vec<u8>, when we are encoding to hex, we don't actually add
+    // the length prefix (it is already implied by the actual string length)
+    return (0, _util.u8aToHex)(this.toU8a(true));
+  }
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+
+
+  toHuman() {
+    return this.toJSON();
+  }
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+
+
+  toJSON() {
+    return this.toString();
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return 'Text';
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    return (0, _classPrivateFieldLooseBase2.default)(this, _override)[_override] || 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)
+   */
+
+
+  toU8a(isBare) {
+    // NOTE Here we use the super toString (we are not taking overrides into account,
+    // rather encoding the original value the string was constructed with)
+    const encoded = (0, _util.stringToU8a)(super.toString());
+    return isBare ? encoded : (0, _util.compactAddLength)(encoded);
+  }
+
+}
+
+exports.Text = Text;

package/native/Text.d.ts

@@ -0,0 +1,71 @@
+import type { HexString } from '@polkadot/util/types';
+import type { AnyU8a, Codec, CodecRegistry, IU8a } from '../types';
+/**
+ * @name Text
+ * @description
+ * This is a string wrapper, along with the length. It is used both for strings as well
+ * as items such as documentation. It simply extends the standard JS `String` built-in
+ * object, inheriting all methods exposed from `String`.
+ * @noInheritDoc
+ */
+export declare class Text extends String implements Codec {
+    #private;
+    readonly registry: CodecRegistry;
+    createdAtHash?: IU8a;
+    constructor(registry: CodecRegistry, value?: null | Text | string | AnyU8a | {
+        toString: () => string;
+    });
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description The length of the initial encoded value (Only available when constructed from a Uint8Array)
+     */
+    get initialU8aLength(): number | undefined;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description The length of the value
+     */
+    get length(): number;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other?: unknown): boolean;
+    /**
+     * @description Set an override value for this
+     */
+    setOverride(override: string): void;
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(): string;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): string;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString(): string;
+    /**
+     * @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)
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+}