@polkadot/types-codec 6.12.2-10

package/native/Raw.d.ts

@@ -0,0 +1,90 @@
+import type { HexString } from '@polkadot/util/types';
+import type { AnyJson, AnyU8a, CodecRegistry, IU8a } from '../types';
+/**
+ * @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
+ */
+export declare class Raw extends Uint8Array implements IU8a {
+    readonly registry: CodecRegistry;
+    createdAtHash?: IU8a;
+    readonly initialU8aLength?: number;
+    constructor(registry: CodecRegistry, value?: AnyU8a, initialU8aLength?: number);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Returns true if the wrapped value contains only ASCII printable characters
+     */
+    get isAscii(): boolean;
+    /**
+     * @description Returns true if the type wraps an empty/default all-0 value
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Returns true if the wrapped value contains only utf8 characters
+     */
+    get isUtf8(): boolean;
+    /**
+     * @description The length of the value
+     */
+    get length(): number;
+    /**
+     * @description Returns the number of bits in the value
+     */
+    bitLength(): number;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other?: unknown): boolean;
+    /**
+     * @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?: number, end?: number): Uint8Array;
+    /**
+     * @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?: number, end?: number): Uint8Array;
+    /**
+     * @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(): AnyJson;
+    /**
+     * @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;
+    /**
+     * @description Returns the wrapped data as a UTF-8 string
+     */
+    toUtf8(): string;
+}

package/native/Raw.js

@@ -0,0 +1,182 @@
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+import { assert, isAscii, isUndefined, isUtf8, u8aToHex, u8aToString, u8aToU8a } from '@polkadot/util';
+/**
+ * @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
+ */
+
+export class Raw extends Uint8Array {
+  constructor(registry, value, initialU8aLength) {
+    super(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 isAscii(this);
+  }
+  /**
+   * @description Returns true if the type wraps an empty/default all-0 value
+   */
+
+
+  get isEmpty() {
+    return !this.length || isUndefined(this.find(b => !!b));
+  }
+  /**
+   * @description Returns true if the wrapped value contains only utf8 characters
+   */
+
+
+  get isUtf8() {
+    return 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(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 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 (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() {
+    assert(this.isUtf8, 'The character sequence is not a valid Utf8 string');
+    return u8aToString(this);
+  }
+
+}

package/native/Set.cjs

@@ -0,0 +1,268 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CodecSet = void 0;
+
+var _classPrivateFieldLooseBase2 = _interopRequireDefault(require("@babel/runtime/helpers/classPrivateFieldLooseBase"));
+
+var _classPrivateFieldLooseKey2 = _interopRequireDefault(require("@babel/runtime/helpers/classPrivateFieldLooseKey"));
+
+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
+function encodeSet(setValues, values) {
+  const encoded = new _util.BN(0);
+
+  for (let i = 0; i < values.length; i++) {
+    encoded.ior((0, _util.bnToBn)(setValues[values[i]] || 0));
+  }
+
+  return encoded;
+}
+/** @internal */
+
+
+function decodeSetArray(setValues, values) {
+  const result = new Array(values.length);
+
+  for (let i = 0; i < values.length; i++) {
+    const key = values[i];
+    (0, _util.assert)(!(0, _util.isUndefined)(setValues[key]), () => `Set: Invalid key '${key}' passed to Set, allowed ${Object.keys(setValues).join(', ')}`);
+    result[i] = key;
+  }
+
+  return result;
+}
+/** @internal */
+
+
+function decodeSetNumber(setValues, _value) {
+  const bn = (0, _util.bnToBn)(_value);
+  const keys = Object.keys(setValues);
+  const result = [];
+
+  for (let i = 0; i < keys.length; i++) {
+    const key = keys[i];
+
+    if (bn.and((0, _util.bnToBn)(setValues[key])).eq((0, _util.bnToBn)(setValues[key]))) {
+      result.push(key);
+    }
+  }
+
+  const computed = encodeSet(setValues, result);
+  (0, _util.assert)(bn.eq(computed), () => `Set: Mismatch decoding '${bn.toString()}', computed as '${computed.toString()}' with ${result.join(', ')}`);
+  return result;
+}
+/** @internal */
+
+
+function decodeSet(setValues) {
+  let value = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
+  let bitLength = arguments.length > 2 ? arguments[2] : undefined;
+  (0, _util.assert)(bitLength % 8 === 0, () => `Expected valid bitLength, power of 8, found ${bitLength}`);
+  const byteLength = bitLength / 8;
+
+  if ((0, _util.isU8a)(value)) {
+    return value.length === 0 ? [] : decodeSetNumber(setValues, (0, _util.u8aToBn)(value.subarray(0, byteLength), {
+      isLe: true
+    }));
+  } else if ((0, _util.isString)(value)) {
+    return decodeSet(setValues, (0, _util.u8aToU8a)(value), byteLength);
+  } else if (value instanceof Set || Array.isArray(value)) {
+    const input = Array.isArray(value) ? value : [...value.values()];
+    return decodeSetArray(setValues, input);
+  }
+
+  return decodeSetNumber(setValues, value);
+}
+/**
+ * @name Set
+ * @description
+ * An Set is an array of string values, represented an an encoded type by
+ * a bitwise representation of the values.
+ */
+
+
+var _allowed = /*#__PURE__*/(0, _classPrivateFieldLooseKey2.default)("allowed");
+
+var _byteLength = /*#__PURE__*/(0, _classPrivateFieldLooseKey2.default)("byteLength");
+
+class CodecSet extends Set {
+  constructor(registry, setValues, value) {
+    let bitLength = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 8;
+    super(decodeSet(setValues, value, bitLength));
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    Object.defineProperty(this, _allowed, {
+      writable: true,
+      value: void 0
+    });
+    Object.defineProperty(this, _byteLength, {
+      writable: true,
+      value: void 0
+    });
+
+    this.add = key => {
+      // ^^^ add = () property done to assign this instance's this, otherwise Set.add creates "some" chaos
+      // we have the isUndefined(this._setValues) in here as well, add is used internally
+      // in the Set constructor (so it is undefined at this point, and should allow)
+      (0, _util.assert)((0, _util.isUndefined)((0, _classPrivateFieldLooseBase2.default)(this, _allowed)[_allowed]) || !(0, _util.isUndefined)((0, _classPrivateFieldLooseBase2.default)(this, _allowed)[_allowed][key]), () => `Set: Invalid key '${key}' on add`);
+      super.add(key);
+      return this;
+    };
+
+    this.registry = registry;
+    (0, _classPrivateFieldLooseBase2.default)(this, _allowed)[_allowed] = setValues;
+    (0, _classPrivateFieldLooseBase2.default)(this, _byteLength)[_byteLength] = bitLength / 8;
+  }
+
+  static with(values, bitLength) {
+    const keys = Object.keys(values);
+    const isKeys = new Array(keys.length);
+
+    for (let i = 0; i < keys.length; i++) {
+      isKeys[i] = `is${(0, _util.stringPascalCase)(keys[i])}`;
+    }
+
+    return class extends CodecSet {
+      constructor(registry, value) {
+        super(registry, values, value, bitLength);
+        (0, _util.objectProperties)(this, isKeys, (_, i) => this.strings.includes(keys[i]));
+      }
+
+    };
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return (0, _classPrivateFieldLooseBase2.default)(this, _byteLength)[_byteLength];
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    return this.registry.hash(this.toU8a());
+  }
+  /**
+   * @description true is the Set contains no values
+   */
+
+
+  get isEmpty() {
+    return this.size === 0;
+  }
+  /**
+   * @description The actual set values as a string[]
+   */
+
+
+  get strings() {
+    return [...super.values()];
+  }
+  /**
+   * @description The encoded value for the set members
+   */
+
+
+  get valueEncoded() {
+    return encodeSet((0, _classPrivateFieldLooseBase2.default)(this, _allowed)[_allowed], this.strings);
+  }
+  /**
+   * @description adds a value to the Set (extended to allow for validity checking)
+   */
+
+
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+  eq(other) {
+    if (Array.isArray(other)) {
+      // we don't actually care about the order, sort the values
+      return (0, _index.compareArray)(this.strings.sort(), other.sort());
+    } else if (other instanceof Set) {
+      return this.eq([...other.values()]);
+    } else if ((0, _util.isNumber)(other) || (0, _util.isBn)(other)) {
+      return this.valueEncoded.eq((0, _util.bnToBn)(other));
+    }
+
+    return false;
+  }
+  /**
+   * @description Returns a hex string representation of the value
+   */
+
+
+  toHex() {
+    return (0, _util.u8aToHex)(this.toU8a());
+  }
+  /**
+   * @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.strings;
+  }
+  /**
+   * @description The encoded value for the set members
+   */
+
+
+  toNumber() {
+    return this.valueEncoded.toNumber();
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return (0, _util.stringify)({
+      _set: (0, _classPrivateFieldLooseBase2.default)(this, _allowed)[_allowed]
+    });
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    return `[${this.strings.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)
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+
+
+  toU8a(isBare) {
+    return (0, _util.bnToU8a)(this.valueEncoded, {
+      bitLength: (0, _classPrivateFieldLooseBase2.default)(this, _byteLength)[_byteLength] * 8,
+      isLe: true
+    });
+  }
+
+}
+
+exports.CodecSet = CodecSet;

package/native/Set.d.ts

@@ -0,0 +1,76 @@
+/// <reference types="bn.js" />
+import type { HexString } from '@polkadot/util/types';
+import type { CodecClass, CodecRegistry, ISet, IU8a } from '../types';
+import { BN } from '@polkadot/util';
+declare type SetValues = Record<string, number | BN>;
+/**
+ * @name Set
+ * @description
+ * An Set is an array of string values, represented an an encoded type by
+ * a bitwise representation of the values.
+ */
+export declare class CodecSet extends Set<string> implements ISet<string> {
+    #private;
+    readonly registry: CodecRegistry;
+    createdAtHash?: IU8a;
+    constructor(registry: CodecRegistry, setValues: SetValues, value?: string[] | Set<string> | Uint8Array | BN | number | string, bitLength?: number);
+    static with(values: SetValues, bitLength?: number): CodecClass<CodecSet>;
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description true is the Set contains no values
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description The actual set values as a string[]
+     */
+    get strings(): string[];
+    /**
+     * @description The encoded value for the set members
+     */
+    get valueEncoded(): BN;
+    /**
+     * @description adds a value to the Set (extended to allow for validity checking)
+     */
+    add: (key: string) => this;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other?: unknown): boolean;
+    /**
+     * @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 The encoded value for the set members
+     */
+    toNumber(): number;
+    /**
+     * @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;
+}
+export {};