@polkadot/types-codec 6.12.2-10

package/native/Bool.cjs

@@ -0,0 +1,141 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.bool = void 0;
+
+var _util = require("@polkadot/util");
+
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/** @internal */
+function decodeBool(value) {
+  if ((0, _util.isU8a)(value)) {
+    return value[0] === 1;
+  } else if (value instanceof Boolean) {
+    return value.valueOf();
+  }
+
+  return !!value;
+}
+/**
+ * @name bool
+ * @description
+ * Representation for a boolean value in the system. It extends the base JS `Boolean` class
+ * @noInheritDoc
+ */
+
+
+class bool extends Boolean {
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  constructor(registry) {
+    let value = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    super(decodeBool(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 1;
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    return this.registry.hash(this.toU8a());
+  }
+  /**
+   * @description Checks if the value is an empty value (true when it wraps false/default)
+   */
+
+
+  get isEmpty() {
+    return this.isFalse;
+  }
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+
+
+  get isFalse() {
+    return !this.isTrue;
+  }
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+
+
+  get isTrue() {
+    return this.valueOf();
+  }
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+
+
+  eq(other) {
+    return this.valueOf() === (other instanceof Boolean ? other.valueOf() : other);
+  }
+  /**
+   * @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.valueOf();
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return 'bool';
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    return this.toJSON().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 new Uint8Array([this.valueOf() ? 1 : 0]);
+  }
+
+}
+
+exports.bool = bool;

package/native/Bool.d.ts

@@ -0,0 +1,62 @@
+import type { HexString } from '@polkadot/util/types';
+import type { Codec, CodecRegistry, IU8a } from '../types';
+/**
+ * @name bool
+ * @description
+ * Representation for a boolean value in the system. It extends the base JS `Boolean` class
+ * @noInheritDoc
+ */
+export declare class bool extends Boolean implements Codec {
+    readonly registry: CodecRegistry;
+    createdAtHash?: IU8a;
+    constructor(registry: CodecRegistry, value?: bool | Boolean | Uint8Array | boolean | 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 Checks if the value is an empty value (true when it wraps false/default)
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Checks if the value is an empty value (always false)
+     */
+    get isFalse(): boolean;
+    /**
+     * @description Checks if the value is an empty value (always false)
+     */
+    get isTrue(): boolean;
+    /**
+     * @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(): boolean;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): boolean;
+    /**
+     * @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;
+}

package/native/Bool.js

@@ -0,0 +1,130 @@
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+import { isU8a, u8aToHex } from '@polkadot/util';
+/** @internal */
+
+function decodeBool(value) {
+  if (isU8a(value)) {
+    return value[0] === 1;
+  } else if (value instanceof Boolean) {
+    return value.valueOf();
+  }
+
+  return !!value;
+}
+/**
+ * @name bool
+ * @description
+ * Representation for a boolean value in the system. It extends the base JS `Boolean` class
+ * @noInheritDoc
+ */
+
+
+export class bool extends Boolean {
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  constructor(registry, value = false) {
+    super(decodeBool(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 1;
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    return this.registry.hash(this.toU8a());
+  }
+  /**
+   * @description Checks if the value is an empty value (true when it wraps false/default)
+   */
+
+
+  get isEmpty() {
+    return this.isFalse;
+  }
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+
+
+  get isFalse() {
+    return !this.isTrue;
+  }
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+
+
+  get isTrue() {
+    return this.valueOf();
+  }
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+
+
+  eq(other) {
+    return this.valueOf() === (other instanceof Boolean ? other.valueOf() : other);
+  }
+  /**
+   * @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() {
+    return this.toJSON();
+  }
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+
+
+  toJSON() {
+    return this.valueOf();
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return 'bool';
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    return this.toJSON().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 new Uint8Array([this.valueOf() ? 1 : 0]);
+  }
+
+}

package/native/Date.cjs

@@ -0,0 +1,170 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CodecDate = void 0;
+
+var _util = require("@polkadot/util");
+
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+const BITLENGTH = 64;
+
+function decodeDate(value) {
+  if ((0, _util.isU8a)(value)) {
+    value = (0, _util.u8aToBn)(value.subarray(0, BITLENGTH / 8), true);
+  } else if (value instanceof Date) {
+    return value;
+  } else if ((0, _util.isString)(value)) {
+    value = new _util.BN(value.toString(), 10, 'le');
+  }
+
+  return new Date((0, _util.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
+ */
+
+
+class CodecDate extends Date {
+  constructor(registry) {
+    let value = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 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 _util.BN(this.toNumber());
+  }
+  /**
+   * @description Returns a hex string representation of the value
+   */
+
+
+  toHex() {
+    let isLe = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+    return (0, _util.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 (0, _util.bnToU8a)(this.toNumber(), BITLENGTH, true);
+  }
+
+}
+
+exports.CodecDate = CodecDate;

package/native/Date.d.ts

@@ -0,0 +1,76 @@
+/// <reference types="bn.js" />
+import type { HexString } from '@polkadot/util/types';
+import type { AnyNumber, CodecRegistry, INumber, IU8a, UIntBitLength } from '../types';
+import { BN } from '@polkadot/util';
+/**
+ * @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 declare class CodecDate extends Date implements INumber {
+    readonly registry: CodecRegistry;
+    createdAtHash?: IU8a;
+    constructor(registry: CodecRegistry, value?: CodecDate | Date | AnyNumber);
+    /**
+     * @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
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other?: unknown): boolean;
+    /**
+     * @description Returns the number of bits in the value
+     */
+    bitLength(): UIntBitLength;
+    /**
+     * @description Returns a BigInt representation of the number
+     */
+    toBigInt(): bigint;
+    /**
+     * @description Returns the BN representation of the timestamp
+     */
+    toBn(): BN;
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(isLe?: boolean): 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(): any;
+    /**
+     * @description Returns the number representation for the timestamp
+     */
+    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;
+}