@polkadot/types-codec 9.5.2 → 9.6.2

package/native/Raw.js

@@ -1,6 +1,8 @@
 // Copyright 2017-2022 @polkadot/types-codec authors & contributors
 // SPDX-License-Identifier: Apache-2.0
+
 import { isAscii, isUndefined, isUtf8, u8aToHex, u8aToString, u8aToU8a } from '@polkadot/util';
+
 /**
  * @name Raw
  * @description
@@ -10,7 +12,6 @@ import { isAscii, isUndefined, isUtf8, u8aToHex, u8aToString, u8aToU8a } from '@
  * actual lengths instead of used directly.
  * @noInheritDoc
  */
-
 export class Raw extends Uint8Array {
   /**
    * @description This ensures that operators such as clice, filter, map, etc. return
@@ -19,159 +20,139 @@ export class Raw extends Uint8Array {
   static get [Symbol.species]() {
     return Uint8Array;
   }
-
   constructor(registry, value, initialU8aLength) {
     super(u8aToU8a(value));
     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 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 Returns a breakdown of the hex encoding for this Codec
    */
-
-
   inspect() {
     return {
       outer: [this.toU8a()]
     };
   }
+
   /**
    * @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() {
     return this.toPrimitive();
   }
+
   /**
    * @description Converts the Object to JSON, typically used for RPC transfers
    */
-
-
   toJSON() {
     return this.toHex();
   }
+
   /**
    * @description Converts the value in a best-fit primitive form
    */
-
-
   toPrimitive() {
     if (this.isAscii) {
-      const text = this.toUtf8(); // ensure we didn't end up with multibyte codepoints
+      const text = this.toUtf8();
 
+      // ensure we didn't end up with multibyte codepoints
       if (isAscii(text)) {
         return text;
       }
     }
-
     return this.toJSON();
   }
+
   /**
    * @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() {
     if (!this.isUtf8) {
       throw new Error('The character sequence is not a valid Utf8 string');
     }
-
     return u8aToString(this);
   }
-
 }

package/native/Set.js

@@ -1,69 +1,53 @@
 // Copyright 2017-2022 @polkadot/types-codec authors & contributors
 // SPDX-License-Identifier: Apache-2.0
+
 import { BN, bnToBn, bnToU8a, isBn, isNumber, isString, isU8a, isUndefined, objectProperties, stringify, stringPascalCase, u8aToBn, u8aToHex, u8aToU8a } from '@polkadot/util';
 import { compareArray } from "../utils/index.js";
-
 function encodeSet(setValues, values) {
   const encoded = new BN(0);
-
   for (let i = 0; i < values.length; i++) {
     encoded.ior(bnToBn(setValues[values[i]] || 0));
   }
-
   return encoded;
 }
-/** @internal */
-
 
+/** @internal */
 function decodeSetArray(setValues, values) {
   const result = new Array(values.length);
-
   for (let i = 0; i < values.length; i++) {
     const key = values[i];
-
     if (isUndefined(setValues[key])) {
       throw new Error(`Set: Invalid key '${key}' passed to Set, allowed ${Object.keys(setValues).join(', ')}`);
     }
-
     result[i] = key;
   }
-
   return result;
 }
-/** @internal */
-
 
+/** @internal */
 function decodeSetNumber(setValues, _value) {
   const bn = bnToBn(_value);
   const keys = Object.keys(setValues);
   const result = [];
-
   for (let i = 0; i < keys.length; i++) {
     const key = keys[i];
-
     if (bn.and(bnToBn(setValues[key])).eq(bnToBn(setValues[key]))) {
       result.push(key);
     }
   }
-
   const computed = encodeSet(setValues, result);
-
   if (!bn.eq(computed)) {
     throw new Error(`Set: Mismatch decoding '${bn.toString()}', computed as '${computed.toString()}' with ${result.join(', ')}`);
   }
-
   return result;
 }
-/** @internal */
-
 
+/** @internal */
 function decodeSet(setValues, value = 0, bitLength) {
   if (bitLength % 8 !== 0) {
     throw new Error(`Expected valid bitLength, power of 8, found ${bitLength}`);
   }
-
   const byteLength = bitLength / 8;
-
   if (isU8a(value)) {
     return value.length === 0 ? [] : decodeSetNumber(setValues, u8aToBn(value.subarray(0, byteLength), {
       isLe: true
@@ -74,92 +58,78 @@ function decodeSet(setValues, value = 0, bitLength) {
     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.
  */
-
-
 export class CodecSet extends Set {
   #allowed;
   #byteLength;
-
   constructor(registry, setValues, value, bitLength = 8) {
     super(decodeSet(setValues, value, bitLength));
     this.registry = registry;
     this.#allowed = setValues;
     this.#byteLength = bitLength / 8;
   }
-
   static with(values, bitLength) {
     var _class;
-
     return _class = class extends CodecSet {
       constructor(registry, value) {
         super(registry, values, value, bitLength);
       }
-
     }, (() => {
       const keys = Object.keys(values);
       const isKeys = new Array(keys.length);
-
       for (let i = 0; i < keys.length; i++) {
         isKeys[i] = `is${stringPascalCase(keys[i])}`;
       }
-
       objectProperties(_class.prototype, isKeys, (_, i, self) => self.strings.includes(keys[i]));
     })(), _class;
   }
+
   /**
    * @description The length of the value when encoded as a Uint8Array
    */
-
-
   get encodedLength() {
     return this.#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(this.#allowed, this.strings);
   }
+
   /**
    * @description adds a value to the Set (extended to allow for validity checking)
    */
-
-
   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
@@ -167,14 +137,13 @@ export class CodecSet extends Set {
     if (this.#allowed && isUndefined(this.#allowed[key])) {
       throw new Error(`Set: Invalid key '${key}' on add`);
     }
-
     super.add(key);
     return this;
   };
+
   /**
    * @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
@@ -184,89 +153,78 @@ export class CodecSet extends Set {
     } else if (isNumber(other) || isBn(other)) {
       return this.valueEncoded.eq(bnToBn(other));
     }
-
     return false;
   }
+
   /**
    * @description Returns a breakdown of the hex encoding for this Codec
    */
-
-
   inspect() {
     return {
       outer: [this.toU8a()]
     };
   }
+
   /**
    * @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.strings;
   }
+
   /**
    * @description The encoded value for the set members
    */
-
-
   toNumber() {
     return this.valueEncoded.toNumber();
   }
+
   /**
    * @description Converts the value in a best-fit primitive form
    */
-
-
   toPrimitive() {
     return this.toJSON();
   }
+
   /**
    * @description Returns the base runtime type name for this instance
    */
-
-
   toRawType() {
     return stringify({
       _set: this.#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 bnToU8a(this.valueEncoded, {
       bitLength: this.#byteLength * 8,
       isLe: true
     });
   }
-
 }