@polkadot/types-codec 9.14.1 → 10.0.1

package/base/Int.js

@@ -1,8 +1,4 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { AbstractInt } from "../abstract/Int.js";
-
+import { AbstractInt } from '../abstract/Int.js';
 /**
  * @name Int
  * @description
@@ -14,17 +10,17 @@ import { AbstractInt } from "../abstract/Int.js";
  * @noInheritDoc
  */
 export class Int extends AbstractInt {
-  constructor(registry, value = 0, bitLength) {
-    super(registry, value, bitLength, true);
-  }
-  static with(bitLength, typeName) {
-    return class extends Int {
-      constructor(registry, value) {
-        super(registry, value, bitLength);
-      }
-      toRawType() {
-        return typeName || super.toRawType();
-      }
-    };
-  }
+    constructor(registry, value = 0, bitLength) {
+        super(registry, value, bitLength, true);
+    }
+    static with(bitLength, typeName) {
+        return class extends Int {
+            constructor(registry, value) {
+                super(registry, value, bitLength);
+            }
+            toRawType() {
+                return typeName || super.toRawType();
+            }
+        };
+    }
 }

package/base/Null.js

@@ -1,90 +1,79 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
 import { isNull } from '@polkadot/util';
-
 /**
  * @name Null
  * @description
  * Implements a type that does not contain anything (apart from `null`)
  */
 export class Null {
-  encodedLength = 0;
-  isEmpty = true;
-  initialU8aLength = 0;
-  constructor(registry) {
-    this.registry = registry;
-  }
-
-  /**
-   * @description returns a hash of the contents
-   */
-  get hash() {
-    throw new Error('.hash is not implemented on Null');
-  }
-
-  /**
-   * @description Compares the value of the input to see if there is a match
-   */
-  eq(other) {
-    return other instanceof Null || isNull(other);
-  }
-
-  /**
-   * @description Returns a breakdown of the hex encoding for this Codec
-   */
-  inspect() {
-    return {};
-  }
-
-  /**
-   * @description Returns a hex string representation of the value
-   */
-  toHex() {
-    return '0x';
-  }
-
-  /**
-   * @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 null;
-  }
-
-  /**
-   * @description Converts the value in a best-fit primitive form
-   */
-  toPrimitive() {
-    return null;
-  }
-
-  /**
-   * @description Returns the base runtime type name for this instance
-   */
-  toRawType() {
-    return 'Null';
-  }
-
-  /**
-   * @description Returns the string representation of the value
-   */
-  toString() {
-    return '';
-  }
-
-  /**
-   * @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();
-  }
+    encodedLength = 0;
+    isEmpty = true;
+    registry;
+    createdAtHash;
+    initialU8aLength = 0;
+    isStorageFallback;
+    constructor(registry) {
+        this.registry = registry;
+    }
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash() {
+        throw new Error('.hash is not implemented on Null');
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        return other instanceof Null || isNull(other);
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return {};
+    }
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex() {
+        return '0x';
+    }
+    /**
+     * @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 null;
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive() {
+        return null;
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'Null';
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        return '';
+    }
+    /**
+     * @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();
+    }
 }

package/base/Option.js

@@ -1,48 +1,48 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
 import { isCodec, isNull, isU8a, isUndefined, u8aToHex } from '@polkadot/util';
-import { typeToConstructor } from "../utils/index.js";
-import { Null } from "./Null.js";
+import { typeToConstructor } from '../utils/index.js';
+import { Null } from './Null.js';
 function noopSetDefinition(d) {
-  return d;
+    return d;
 }
 class None extends Null {
-  /**
-   * @description Returns the base runtime type name for this instance
-   */
-  toRawType() {
-    return 'None';
-  }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'None';
+    }
 }
-
 /** @internal */
 function decodeOption(registry, Type, value) {
-  if (value instanceof Type) {
-    // don't re-create, use as it (which also caters for derived types)
-    return value;
-  } else if (value instanceof Option) {
-    if (value.value instanceof Type) {
-      // same instance, return it
-      return value.value;
-    } else if (value.isNone) {
-      // internal is None, we are also none
-      return new None(registry);
-    }
-
-    // convert the actual value into known
-    return new Type(registry, value.value);
-  } else if (isNull(value) || isUndefined(value) || value === '0x' || value instanceof None) {
-    // anyhting empty we pass as-is
-    return new None(registry);
-  } else if (isU8a(value)) {
-    // the isU8a check happens last in the if-tree - since the wrapped value
-    // may be an instance of it, so Type and Option checks go in first
-    return !value.length || value[0] === 0 ? new None(registry) : new Type(registry, value.subarray(1));
-  }
-  return new Type(registry, value);
+    if (value instanceof Type) {
+        // don't re-create, use as it (which also caters for derived types)
+        return value;
+    }
+    else if (value instanceof Option) {
+        if (value.value instanceof Type) {
+            // same instance, return it
+            return value.value;
+        }
+        else if (value.isNone) {
+            // internal is None, we are also none
+            return new None(registry);
+        }
+        // convert the actual value into known
+        return new Type(registry, value.value);
+    }
+    else if (isNull(value) || isUndefined(value) || value === '0x' || value instanceof None) {
+        // anyhting empty we pass as-is
+        return new None(registry);
+    }
+    else if (isU8a(value)) {
+        // the isU8a check happens last in the if-tree - since the wrapped value
+        // may be an instance of it, so Type and Option checks go in first
+        return !value.length || value[0] === 0
+            ? new None(registry)
+            : new Type(registry, value.subarray(1));
+    }
+    return new Type(registry, value);
 }
-
 /**
  * @name Option
  * @description
@@ -52,193 +52,184 @@ function decodeOption(registry, Type, value) {
  * with a value if/as required/found.
  */
 export class Option {
-  #Type;
-  #raw;
-  constructor(registry, typeName, value, {
-    definition,
-    setDefinition = noopSetDefinition
-  } = {}) {
-    const Type = definition || setDefinition(typeToConstructor(registry, typeName));
-    const decoded = isU8a(value) && value.length && !isCodec(value) ? value[0] === 0 ? new None(registry) : new Type(registry, value.subarray(1)) : decodeOption(registry, Type, value);
-    this.registry = registry;
-    this.#Type = Type;
-    this.#raw = decoded;
-    if (decoded != null && decoded.initialU8aLength) {
-      this.initialU8aLength = 1 + decoded.initialU8aLength;
-    }
-  }
-  static with(Type) {
-    let definition;
-    const setDefinition = d => {
-      definition = d;
-      return d;
-    };
-    return class extends Option {
-      constructor(registry, value) {
-        super(registry, Type, value, {
-          definition,
-          setDefinition
-        });
-      }
-    };
-  }
-
-  /**
-   * @description The length of the value when encoded as a Uint8Array
-   */
-  get encodedLength() {
-    // boolean byte (has value, doesn't have) along with wrapped length
-    return 1 + this.#raw.encodedLength;
-  }
-
-  /**
-   * @description returns a hash of the contents
-   */
-  get hash() {
-    return this.registry.hash(this.toU8a());
-  }
-
-  /**
-   * @description Checks if the Option has no value
-   */
-  get isEmpty() {
-    return this.isNone;
-  }
-
-  /**
-   * @description Checks if the Option has no value
-   */
-  get isNone() {
-    return this.#raw instanceof None;
-  }
-
-  /**
-   * @description Checks if the Option has a value
-   */
-  get isSome() {
-    return !this.isNone;
-  }
-
-  /**
-   * @description The actual value for the Option
-   */
-  get value() {
-    return this.#raw;
-  }
-
-  /**
-   * @description Compares the value of the input to see if there is a match
-   */
-  eq(other) {
-    if (other instanceof Option) {
-      return this.isSome === other.isSome && this.value.eq(other.value);
-    }
-    return this.value.eq(other);
-  }
-
-  /**
-   * @description Returns a breakdown of the hex encoding for this Codec
-   */
-  inspect() {
-    if (this.isNone) {
-      return {
-        outer: [new Uint8Array([0])]
-      };
-    }
-    const {
-      inner,
-      outer = []
-    } = this.#raw.inspect();
-    return {
-      inner,
-      outer: [new Uint8Array([1]), ...outer]
-    };
-  }
-
-  /**
-   * @description Returns a hex string representation of the value
-   */
-  toHex() {
-    // This attempts to align with the JSON encoding - actually in this case
-    // the isSome value is correct, however the `isNone` may be problematic
-    return this.isNone ? '0x' : u8aToHex(this.toU8a().subarray(1));
-  }
-
-  /**
-   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-   */
-  toHuman(isExtended) {
-    return this.#raw.toHuman(isExtended);
-  }
-
-  /**
-   * @description Converts the Object to JSON, typically used for RPC transfers
-   */
-  toJSON() {
-    return this.isNone ? null : this.#raw.toJSON();
-  }
-
-  /**
-   * @description Converts the value in a best-fit primitive form
-   */
-  toPrimitive() {
-    return this.isNone ? null : this.#raw.toPrimitive();
-  }
-
-  /**
-   * @description Returns the base runtime type name for this instance
-   */
-  toRawType(isBare) {
-    const wrapped = this.registry.getClassName(this.#Type) || new this.#Type(this.registry).toRawType();
-    return isBare ? wrapped : `Option<${wrapped}>`;
-  }
-
-  /**
-   * @description Returns the string representation of the value
-   */
-  toString() {
-    return this.#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)
-   */
-  toU8a(isBare) {
-    if (isBare) {
-      return this.#raw.toU8a(true);
-    }
-    const u8a = new Uint8Array(this.encodedLength);
-    if (this.isSome) {
-      u8a.set([1]);
-      u8a.set(this.#raw.toU8a(), 1);
-    }
-    return u8a;
-  }
-
-  /**
-   * @description Returns the value that the Option represents (if available), throws if null
-   */
-  unwrap() {
-    if (this.isNone) {
-      throw new Error('Option: unwrapping a None value');
-    }
-    return this.#raw;
-  }
-
-  /**
-   * @description Returns the value that the Option represents (if available) or defaultValue if none
-   * @param defaultValue The value to return if the option isNone
-   */
-  unwrapOr(defaultValue) {
-    return this.isSome ? this.unwrap() : defaultValue;
-  }
-
-  /**
-   * @description Returns the value that the Option represents (if available) or defaultValue if none
-   * @param defaultValue The value to return if the option isNone
-   */
-  unwrapOrDefault() {
-    return this.isSome ? this.unwrap() : new this.#Type(this.registry);
-  }
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    #Type;
+    #raw;
+    constructor(registry, typeName, value, { definition, setDefinition = noopSetDefinition } = {}) {
+        const Type = definition || setDefinition(typeToConstructor(registry, typeName));
+        const decoded = isU8a(value) && value.length && !isCodec(value)
+            ? value[0] === 0
+                ? new None(registry)
+                : new Type(registry, value.subarray(1))
+            : decodeOption(registry, Type, value);
+        this.registry = registry;
+        this.#Type = Type;
+        this.#raw = decoded;
+        if (decoded?.initialU8aLength) {
+            this.initialU8aLength = 1 + decoded.initialU8aLength;
+        }
+    }
+    static with(Type) {
+        let definition;
+        const setDefinition = (d) => {
+            definition = d;
+            return d;
+        };
+        return class extends Option {
+            constructor(registry, value) {
+                super(registry, Type, value, { definition, setDefinition });
+            }
+        };
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        // boolean byte (has value, doesn't have) along with wrapped length
+        return 1 + this.#raw.encodedLength;
+    }
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash() {
+        return this.registry.hash(this.toU8a());
+    }
+    /**
+     * @description Checks if the Option has no value
+     */
+    get isEmpty() {
+        return this.isNone;
+    }
+    /**
+     * @description Checks if the Option has no value
+     */
+    get isNone() {
+        return this.#raw instanceof None;
+    }
+    /**
+     * @description Checks if the Option has a value
+     */
+    get isSome() {
+        return !this.isNone;
+    }
+    /**
+     * @description The actual value for the Option
+     */
+    get value() {
+        return this.#raw;
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        if (other instanceof Option) {
+            return (this.isSome === other.isSome) && this.value.eq(other.value);
+        }
+        return this.value.eq(other);
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        if (this.isNone) {
+            return { outer: [new Uint8Array([0])] };
+        }
+        const { inner, outer = [] } = this.#raw.inspect();
+        return {
+            inner,
+            outer: [new Uint8Array([1]), ...outer]
+        };
+    }
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex() {
+        // This attempts to align with the JSON encoding - actually in this case
+        // the isSome value is correct, however the `isNone` may be problematic
+        return this.isNone
+            ? '0x'
+            : u8aToHex(this.toU8a().subarray(1));
+    }
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExtended) {
+        return this.#raw.toHuman(isExtended);
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON() {
+        return this.isNone
+            ? null
+            : this.#raw.toJSON();
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive() {
+        return this.isNone
+            ? null
+            : this.#raw.toPrimitive();
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(isBare) {
+        const wrapped = this.registry.getClassName(this.#Type) || new this.#Type(this.registry).toRawType();
+        return isBare
+            ? wrapped
+            : `Option<${wrapped}>`;
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        return this.#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)
+     */
+    toU8a(isBare) {
+        if (isBare) {
+            return this.#raw.toU8a(true);
+        }
+        const u8a = new Uint8Array(this.encodedLength);
+        if (this.isSome) {
+            u8a.set([1]);
+            u8a.set(this.#raw.toU8a(), 1);
+        }
+        return u8a;
+    }
+    /**
+     * @description Returns the value that the Option represents (if available), throws if null
+     */
+    unwrap() {
+        if (this.isNone) {
+            throw new Error('Option: unwrapping a None value');
+        }
+        return this.#raw;
+    }
+    /**
+     * @description Returns the value that the Option represents (if available) or defaultValue if none
+     * @param defaultValue The value to return if the option isNone
+     */
+    unwrapOr(defaultValue) {
+        return this.isSome
+            ? this.unwrap()
+            : defaultValue;
+    }
+    /**
+     * @description Returns the value that the Option represents (if available) or defaultValue if none
+     * @param defaultValue The value to return if the option isNone
+     */
+    unwrapOrDefault() {
+        return this.isSome
+            ? this.unwrap()
+            : new this.#Type(this.registry);
+    }
 }