@polkadot/types-codec 9.5.2 → 9.6.2

package/base/Enum.js

@@ -1,32 +1,29 @@
 // Copyright 2017-2022 @polkadot/types-codec authors & contributors
 // SPDX-License-Identifier: Apache-2.0
+
 import { isHex, isNumber, isObject, isString, isU8a, objectProperties, stringCamelCase, stringify, stringPascalCase, u8aConcatStrict, u8aToHex, u8aToU8a } from '@polkadot/util';
 import { mapToTypeMap, typesToMap } from "../utils/index.js";
-import { Null } from "./Null.js"; // export interface, this is used in Enum.with, so required as public by TS
+import { Null } from "./Null.js";
+
+// export interface, this is used in Enum.with, so required as public by TS
 
 function noopSetDefinition(d) {
   return d;
 }
-
 function isRustEnum(def) {
   const defValues = Object.values(def);
-
   if (defValues.some(v => isNumber(v))) {
     if (!defValues.every(v => isNumber(v) && v >= 0 && v <= 255)) {
       throw new Error('Invalid number-indexed enum definition');
     }
-
     return false;
   }
-
   return true;
 }
-
 function extractDef(registry, _def) {
   const def = {};
   let isBasic;
   let isIndexed;
-
   if (Array.isArray(_def)) {
     for (let i = 0; i < _def.length; i++) {
       def[_def[i]] = {
@@ -34,26 +31,22 @@ function extractDef(registry, _def) {
         index: i
       };
     }
-
     isBasic = true;
     isIndexed = false;
   } else if (isRustEnum(_def)) {
     const [Types, keys] = mapToTypeMap(registry, _def);
-
     for (let i = 0; i < keys.length; i++) {
       def[keys[i]] = {
         Type: Types[i],
         index: i
       };
     }
-
     isBasic = !Object.values(def).some(({
       Type
     }) => Type !== Null);
     isIndexed = false;
   } else {
     const entries = Object.entries(_def);
-
     for (let i = 0; i < entries.length; i++) {
       const [key, index] = entries[i];
       def[key] = {
@@ -61,35 +54,28 @@ function extractDef(registry, _def) {
         index
       };
     }
-
     isBasic = true;
     isIndexed = true;
   }
-
   return {
     def,
     isBasic,
     isIndexed
   };
 }
-
 function getEntryType(def, checkIdx) {
   const values = Object.values(def);
-
   for (let i = 0; i < values.length; i++) {
     const {
       Type,
       index
     } = values[i];
-
     if (index === checkIdx) {
       return Type;
     }
   }
-
   throw new Error(`Unable to create Enum via index ${checkIdx}, in ${Object.keys(def).join(', ')}`);
 }
-
 function createFromU8a(registry, def, index, value) {
   const Type = getEntryType(def, index);
   return {
@@ -97,7 +83,6 @@ function createFromU8a(registry, def, index, value) {
     value: new Type(registry, value)
   };
 }
-
 function createFromValue(registry, def, index = 0, value) {
   const Type = getEntryType(def, index);
   return {
@@ -105,33 +90,30 @@ function createFromValue(registry, def, index = 0, value) {
     value: value instanceof Type ? value : new Type(registry, value)
   };
 }
-
 function decodeFromJSON(registry, def, key, value) {
   // JSON comes in the form of { "<type (camelCase)>": "<value for type>" }, here we
   // additionally force to lower to ensure forward compat
   const keys = Object.keys(def).map(k => k.toLowerCase());
   const keyLower = key.toLowerCase();
   const index = keys.indexOf(keyLower);
-
   if (index === -1) {
     throw new Error(`Cannot map Enum JSON, unable to find '${key}' in ${keys.join(', ')}`);
   }
-
   try {
     return createFromValue(registry, def, Object.values(def)[index].index, value);
   } catch (error) {
     throw new Error(`Enum(${key}):: ${error.message}`);
   }
 }
-
 function decodeEnum(registry, def, value, index) {
   // NOTE We check the index path first, before looking at values - this allows treating
   // the optional indexes before anything else, more-specific > less-specific
   if (isNumber(index)) {
     return createFromValue(registry, def, index, value);
   } else if (isU8a(value) || isHex(value)) {
-    const u8a = u8aToU8a(value); // nested, we don't want to match isObject below
+    const u8a = u8aToU8a(value);
 
+    // nested, we don't want to match isObject below
     if (u8a.length) {
       return createFromU8a(registry, def, u8a[0], u8a.subarray(1));
     }
@@ -144,19 +126,18 @@ function decodeEnum(registry, def, value, index) {
   } else if (isObject(value)) {
     const key = Object.keys(value)[0];
     return decodeFromJSON(registry, def, key, value[key]);
-  } // Worst-case scenario, return the first with default
-
+  }
 
+  // Worst-case scenario, return the first with default
   return createFromValue(registry, def, Object.values(def)[0].index);
 }
+
 /**
  * @name Enum
  * @description
  * This implements an enum, that based on the value wraps a different type. It is effectively
  * an extension to enum where the value type is determined by the actual index.
  */
-
-
 export class Enum {
   #def;
   #entryIndex;
@@ -164,7 +145,6 @@ export class Enum {
   #isBasic;
   #isIndexed;
   #raw;
-
   constructor(registry, Types, value, index, {
     definition,
     setDefinition = noopSetDefinition
@@ -173,8 +153,9 @@ export class Enum {
       def,
       isBasic,
       isIndexed
-    } = definition || setDefinition(extractDef(registry, Types)); // shortcut isU8a as used in SCALE decoding
+    } = definition || setDefinition(extractDef(registry, Types));
 
+    // shortcut isU8a as used in SCALE decoding
     const decoded = isU8a(value) && value.length && !isNumber(index) ? createFromU8a(registry, def, value[0], value.subarray(1)) : decodeEnum(registry, def, value, index);
     this.registry = registry;
     this.#def = def;
@@ -185,19 +166,16 @@ export class Enum {
     }) => index);
     this.#entryIndex = this.#indexes.indexOf(decoded.index);
     this.#raw = decoded.value;
-
     if (this.#raw.initialU8aLength) {
       this.initialU8aLength = 1 + this.#raw.initialU8aLength;
     }
   }
-
   static with(Types) {
     var _class;
+    let definition;
 
-    let definition; // eslint-disable-next-line no-return-assign
-
+    // eslint-disable-next-line no-return-assign
     const setDefinition = d => definition = d;
-
     return _class = class extends Enum {
       constructor(registry, value, index) {
         super(registry, Types, value, index, {
@@ -205,121 +183,105 @@ export class Enum {
           setDefinition
         });
       }
-
     }, (() => {
       const keys = Array.isArray(Types) ? Types : Object.keys(Types);
       const asKeys = new Array(keys.length);
       const isKeys = new Array(keys.length);
-
       for (let i = 0; i < keys.length; i++) {
         const name = stringPascalCase(keys[i]);
         asKeys[i] = `as${name}`;
         isKeys[i] = `is${name}`;
       }
-
       objectProperties(_class.prototype, isKeys, (_, i, self) => self.type === keys[i]);
       objectProperties(_class.prototype, asKeys, (k, i, self) => {
         if (self.type !== keys[i]) {
           throw new Error(`Cannot convert '${self.type}' via ${k}`);
         }
-
         return self.value;
       });
     })(), _class;
   }
+
   /**
    * @description The length of the value when encoded as a Uint8Array
    */
-
-
   get encodedLength() {
     return 1 + this.#raw.encodedLength;
   }
+
   /**
    * @description returns a hash of the contents
    */
-
-
   get hash() {
     return this.registry.hash(this.toU8a());
   }
+
   /**
    * @description The index of the enum value
    */
-
-
   get index() {
     return this.#indexes[this.#entryIndex];
   }
+
   /**
    * @description The value of the enum
    */
-
-
   get inner() {
     return this.#raw;
   }
+
   /**
    * @description true if this is a basic enum (no values)
    */
-
-
   get isBasic() {
     return this.#isBasic;
   }
+
   /**
    * @description Checks if the value is an empty value
    */
-
-
   get isEmpty() {
     return this.#raw.isEmpty;
   }
+
   /**
    * @description Checks if the Enum points to a [[Null]] type
    */
-
-
   get isNone() {
     return this.#raw instanceof Null;
   }
+
   /**
    * @description The available keys for this enum
    */
-
-
   get defIndexes() {
     return this.#indexes;
   }
+
   /**
    * @description The available keys for this enum
    */
-
-
   get defKeys() {
     return Object.keys(this.#def);
   }
+
   /**
    * @description The name of the type this enum value represents
    */
-
-
   get type() {
     return this.defKeys[this.#entryIndex];
   }
+
   /**
    * @description The value of the enum
    */
-
-
   get value() {
     return this.#raw;
   }
+
   /**
    * @description Compares the value of the input to see if there is a match
    */
-
-
   eq(other) {
     // cater for the case where we only pass the enum index
     if (isU8a(other)) {
@@ -334,23 +296,21 @@ export class Enum {
       return this.index === other.index && this.value.eq(other.value);
     } else if (isObject(other)) {
       return this.value.eq(other[this.type]);
-    } // compare the actual wrapper value
-
+    }
 
+    // compare the actual wrapper value
     return this.value.eq(other);
   }
+
   /**
    * @description Returns a breakdown of the hex encoding for this Codec
    */
-
-
   inspect() {
     if (this.#isBasic) {
       return {
         outer: [new Uint8Array([this.index])]
       };
     }
-
     const {
       inner,
       outer = []
@@ -360,57 +320,51 @@ export class Enum {
       outer: [new Uint8Array([this.index]), ...outer]
     };
   }
+
   /**
    * @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) {
     return this.#isBasic || this.isNone ? this.type : {
       [this.type]: this.#raw.toHuman(isExtended)
     };
   }
+
   /**
    * @description Converts the Object to JSON, typically used for RPC transfers
    */
-
-
   toJSON() {
     return this.#isBasic ? this.type : {
       [stringCamelCase(this.type)]: this.#raw.toJSON()
     };
   }
+
   /**
    * @description Returns the number representation for the value
    */
-
-
   toNumber() {
     return this.index;
   }
+
   /**
    * @description Converts the value in a best-fit primitive form
    */
-
-
   toPrimitive() {
     return this.#isBasic ? this.type : {
       [stringCamelCase(this.type)]: this.#raw.toPrimitive()
     };
   }
+
   /**
    * @description Returns a raw struct representation of the enum types
    */
-
-
   _toRawStruct() {
     if (this.#isBasic) {
       return this.#isIndexed ? this.defKeys.reduce((out, key, index) => {
@@ -418,7 +372,6 @@ export class Enum {
         return out;
       }, {}) : this.defKeys;
     }
-
     const entries = Object.entries(this.#def);
     return typesToMap(this.registry, entries.reduce((out, [key, {
       Type
@@ -428,32 +381,28 @@ export class Enum {
       return out;
     }, [new Array(entries.length), new Array(entries.length)]));
   }
+
   /**
    * @description Returns the base runtime type name for this instance
    */
-
-
   toRawType() {
     return stringify({
       _enum: this._toRawStruct()
     });
   }
+
   /**
    * @description Returns the string representation of the value
    */
-
-
   toString() {
     return this.isNone ? this.type : 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) {
     return isBare ? this.#raw.toU8a(isBare) : u8aConcatStrict([new Uint8Array([this.index]), this.#raw.toU8a(isBare)]);
   }
-
 }

package/base/Int.js

@@ -1,6 +1,8 @@
 // Copyright 2017-2022 @polkadot/types-codec authors & contributors
 // SPDX-License-Identifier: Apache-2.0
+
 import { AbstractInt } from "../abstract/Int.js";
+
 /**
  * @name Int
  * @description
@@ -11,23 +13,18 @@ import { AbstractInt } from "../abstract/Int.js";
  * is available here.
  * @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();
       }
-
     };
   }
-
 }

package/base/Null.js

@@ -1,102 +1,91 @@
 // Copyright 2017-2022 @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;
   // Added for compatibility reasons, e.g. see Option
   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();
   }
-
 }