@polkadot/types-codec 6.12.2-10

package/base/Compact.js

@@ -0,0 +1,186 @@
+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 { compactFromU8a, compactToU8a, isBigInt, isBn, isNumber, isString } from '@polkadot/util';
+import { typeToConstructor } from "../utils/index.js";
+/**
+ * @name Compact
+ * @description
+ * A compact length-encoding codec wrapper. It performs the same function as Length, however
+ * differs in that it uses a variable number of bytes to do the actual encoding. This is mostly
+ * used by other types to add length-prefixed encoding, or in the case of wrapped types, taking
+ * a number and making the compact representation thereof
+ */
+
+var _Type = /*#__PURE__*/_classPrivateFieldLooseKey("Type");
+
+var _raw = /*#__PURE__*/_classPrivateFieldLooseKey("raw");
+
+export class Compact {
+  constructor(registry, Type, value = 0) {
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    this.initialU8aLength = void 0;
+    Object.defineProperty(this, _Type, {
+      writable: true,
+      value: void 0
+    });
+    Object.defineProperty(this, _raw, {
+      writable: true,
+      value: void 0
+    });
+    this.registry = registry;
+    _classPrivateFieldLooseBase(this, _Type)[_Type] = typeToConstructor(registry, Type);
+    const [raw, decodedLength] = Compact.decodeCompact(registry, _classPrivateFieldLooseBase(this, _Type)[_Type], value);
+    this.initialU8aLength = decodedLength;
+    _classPrivateFieldLooseBase(this, _raw)[_raw] = raw;
+  }
+
+  static with(Type) {
+    return class extends Compact {
+      constructor(registry, value) {
+        super(registry, Type, value);
+      }
+
+    };
+  }
+  /** @internal */
+
+
+  static decodeCompact(registry, Type, value) {
+    if (value instanceof Compact) {
+      return [new Type(registry, _classPrivateFieldLooseBase(value, _raw)[_raw]), 0];
+    } else if (value instanceof Type) {
+      return [value, 0];
+    } else if (isString(value) || isNumber(value) || isBn(value) || isBigInt(value)) {
+      return [new Type(registry, value), 0];
+    }
+
+    const [decodedLength, bn] = compactFromU8a(value);
+    return [new Type(registry, bn), decodedLength];
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return this.toU8a().length;
+  }
+  /**
+   * @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 _classPrivateFieldLooseBase(this, _raw)[_raw].isEmpty;
+  }
+  /**
+   * @description Returns the number of bits in the value
+   */
+
+
+  bitLength() {
+    return _classPrivateFieldLooseBase(this, _raw)[_raw].bitLength();
+  }
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+
+
+  eq(other) {
+    return _classPrivateFieldLooseBase(this, _raw)[_raw].eq(other instanceof Compact ? _classPrivateFieldLooseBase(other, _raw)[_raw] : other);
+  }
+  /**
+   * @description Returns a BigInt representation of the number
+   */
+
+
+  toBigInt() {
+    return _classPrivateFieldLooseBase(this, _raw)[_raw].toBigInt();
+  }
+  /**
+   * @description Returns the BN representation of the number
+   */
+
+
+  toBn() {
+    return _classPrivateFieldLooseBase(this, _raw)[_raw].toBn();
+  }
+  /**
+   * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+   */
+
+
+  toHex(isLe) {
+    return _classPrivateFieldLooseBase(this, _raw)[_raw].toHex(isLe);
+  }
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+
+
+  toHuman(isExtended) {
+    return _classPrivateFieldLooseBase(this, _raw)[_raw].toHuman(isExtended);
+  }
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+
+
+  toJSON() {
+    return _classPrivateFieldLooseBase(this, _raw)[_raw].toJSON();
+  }
+  /**
+   * @description Returns the number representation for the value
+   */
+
+
+  toNumber() {
+    return _classPrivateFieldLooseBase(this, _raw)[_raw].toNumber();
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return `Compact<${this.registry.getClassName(_classPrivateFieldLooseBase(this, _Type)[_Type]) || _classPrivateFieldLooseBase(this, _raw)[_raw].toRawType()}>`;
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    return _classPrivateFieldLooseBase(this, _raw)[_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)
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+
+
+  toU8a(isBare) {
+    return compactToU8a(_classPrivateFieldLooseBase(this, _raw)[_raw].toBn());
+  }
+  /**
+   * @description Returns the embedded [[UInt]] or [[Moment]] value
+   */
+
+
+  unwrap() {
+    return _classPrivateFieldLooseBase(this, _raw)[_raw];
+  }
+
+}

package/base/DoNotConstruct.cjs

@@ -0,0 +1,101 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DoNotConstruct = void 0;
+
+var _classPrivateFieldLooseBase2 = _interopRequireDefault(require("@babel/runtime/helpers/classPrivateFieldLooseBase"));
+
+var _classPrivateFieldLooseKey2 = _interopRequireDefault(require("@babel/runtime/helpers/classPrivateFieldLooseKey"));
+
+var _neverError = /*#__PURE__*/(0, _classPrivateFieldLooseKey2.default)("neverError");
+
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @name DoNotConstruct
+ * @description
+ * An unknown type that fails on construction with the type info
+ */
+class DoNotConstruct {
+  constructor(registry) {
+    let typeName = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'DoNotConstruct';
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    Object.defineProperty(this, _neverError, {
+      writable: true,
+      value: void 0
+    });
+    this.registry = registry;
+    (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError] = new Error(`DoNotConstruct: Cannot construct unknown type ${typeName}`);
+    throw (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError];
+  }
+
+  static with(typeName) {
+    return class extends DoNotConstruct {
+      constructor(registry) {
+        super(registry, typeName);
+      }
+
+    };
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    throw (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError];
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    throw (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError];
+  }
+  /**
+   * @description Checks if the value is an empty value (always true)
+   */
+
+
+  get isEmpty() {
+    throw (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError];
+  }
+
+  eq() {
+    throw (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError];
+  }
+
+  toHex() {
+    throw (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError];
+  }
+
+  toHuman() {
+    throw (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError];
+  }
+
+  toJSON() {
+    throw (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError];
+  }
+
+  toRawType() {
+    throw (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError];
+  }
+
+  toString() {
+    throw (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError];
+  }
+
+  toU8a() {
+    throw (0, _classPrivateFieldLooseBase2.default)(this, _neverError)[_neverError];
+  }
+
+}
+
+exports.DoNotConstruct = DoNotConstruct;

package/base/DoNotConstruct.d.ts

@@ -0,0 +1,33 @@
+import type { HexString } from '@polkadot/util/types';
+import type { AnyJson, Codec, CodecClass, CodecRegistry, IU8a } from '../types';
+/**
+ * @name DoNotConstruct
+ * @description
+ * An unknown type that fails on construction with the type info
+ */
+export declare class DoNotConstruct implements Codec {
+    #private;
+    readonly registry: CodecRegistry;
+    createdAtHash?: IU8a;
+    constructor(registry: CodecRegistry, typeName?: string);
+    static with(typeName?: string): CodecClass;
+    /**
+     * @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 Checks if the value is an empty value (always true)
+     */
+    get isEmpty(): boolean;
+    eq(): boolean;
+    toHex(): HexString;
+    toHuman(): AnyJson;
+    toJSON(): AnyJson;
+    toRawType(): string;
+    toString(): string;
+    toU8a(): Uint8Array;
+}

package/base/DoNotConstruct.js

@@ -0,0 +1,88 @@
+import _classPrivateFieldLooseBase from "@babel/runtime/helpers/esm/classPrivateFieldLooseBase";
+import _classPrivateFieldLooseKey from "@babel/runtime/helpers/esm/classPrivateFieldLooseKey";
+
+var _neverError = /*#__PURE__*/_classPrivateFieldLooseKey("neverError");
+
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @name DoNotConstruct
+ * @description
+ * An unknown type that fails on construction with the type info
+ */
+export class DoNotConstruct {
+  constructor(registry, typeName = 'DoNotConstruct') {
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    Object.defineProperty(this, _neverError, {
+      writable: true,
+      value: void 0
+    });
+    this.registry = registry;
+    _classPrivateFieldLooseBase(this, _neverError)[_neverError] = new Error(`DoNotConstruct: Cannot construct unknown type ${typeName}`);
+    throw _classPrivateFieldLooseBase(this, _neverError)[_neverError];
+  }
+
+  static with(typeName) {
+    return class extends DoNotConstruct {
+      constructor(registry) {
+        super(registry, typeName);
+      }
+
+    };
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    throw _classPrivateFieldLooseBase(this, _neverError)[_neverError];
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    throw _classPrivateFieldLooseBase(this, _neverError)[_neverError];
+  }
+  /**
+   * @description Checks if the value is an empty value (always true)
+   */
+
+
+  get isEmpty() {
+    throw _classPrivateFieldLooseBase(this, _neverError)[_neverError];
+  }
+
+  eq() {
+    throw _classPrivateFieldLooseBase(this, _neverError)[_neverError];
+  }
+
+  toHex() {
+    throw _classPrivateFieldLooseBase(this, _neverError)[_neverError];
+  }
+
+  toHuman() {
+    throw _classPrivateFieldLooseBase(this, _neverError)[_neverError];
+  }
+
+  toJSON() {
+    throw _classPrivateFieldLooseBase(this, _neverError)[_neverError];
+  }
+
+  toRawType() {
+    throw _classPrivateFieldLooseBase(this, _neverError)[_neverError];
+  }
+
+  toString() {
+    throw _classPrivateFieldLooseBase(this, _neverError)[_neverError];
+  }
+
+  toU8a() {
+    throw _classPrivateFieldLooseBase(this, _neverError)[_neverError];
+  }
+
+}