@polkadot/types-codec 8.5.2-1 → 8.5.2-4

package/base/Option.d.ts

@@ -41,7 +41,7 @@ export declare class Option<T extends Codec> implements IOption<T> {
     /**
      * @description The actual value for the Option
      */
-    get value(): Codec;
+    get value(): T;
     /**
      * @description Compares the value of the input to see if there is a match
      */

package/cjs/extended/OptionBool.js

@@ -0,0 +1,99 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.OptionBool = void 0;
+
+var _util = require("@polkadot/util");
+
+var _Option = require("../base/Option");
+
+var _Bool = require("../native/Bool");
+
+// Copyright 2017-2022 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+function decodeU8a(registry, value) {
+  // Encoded as -
+  //  - 0 = None
+  //  - 1 = True
+  //  - 2 = False
+  return value[0] === 0 ? null : new _Bool.bool(registry, value[0] === 1);
+}
+/**
+ * @name OptionBool
+ * @description A specific implementation of Option<bool> than allows for single-byte encoding
+ */
+
+
+class OptionBool extends _Option.Option {
+  constructor(registry, value) {
+    super(registry, _Bool.bool, (0, _util.isU8a)(value) || (0, _util.isHex)(value) ? decodeU8a(registry, (0, _util.u8aToU8a)(value)) : value);
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return 1;
+  }
+  /**
+   * @description The length of the initial encoded value (Only available when constructed from a Uint8Array)
+   */
+
+
+  get initialU8aLength() {
+    return 1;
+  }
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+
+
+  get isFalse() {
+    return this.isSome ? !this.value.valueOf() : false;
+  }
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+
+
+  get isTrue() {
+    return this.isSome ? this.value.valueOf() : false;
+  }
+  /**
+   * @description Returns a breakdown of the hex encoding for this Codec
+   */
+
+
+  inspect() {
+    return {
+      outer: [this.toU8a()]
+    };
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType(isBare) {
+    return isBare ? 'bool' : 'Option<bool>';
+  }
+  /**
+   * @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 super.toU8a(true);
+    }
+
+    return this.isSome ? new Uint8Array([this.isTrue ? 1 : 2]) : new Uint8Array([0]);
+  }
+
+}
+
+exports.OptionBool = OptionBool;

package/cjs/extended/index.js

@@ -51,6 +51,12 @@ Object.defineProperty(exports, "Map", {
     return _Map.CodecMap;
   }
 });
+Object.defineProperty(exports, "OptionBool", {
+  enumerable: true,
+  get: function () {
+    return _OptionBool.OptionBool;
+  }
+});
 Object.defineProperty(exports, "Range", {
   enumerable: true,
   get: function () {
@@ -102,6 +108,8 @@ var _Linkage = require("./Linkage");
 
 var _Map = require("./Map");
 
+var _OptionBool = require("./OptionBool");
+
 var _Range = require("./Range");
 
 var _RangeInclusive = require("./RangeInclusive");

package/cjs/packageInfo.js

@@ -11,6 +11,6 @@ const packageInfo = {
   name: '@polkadot/types-codec',
   path: typeof __dirname === 'string' ? __dirname : 'auto',
   type: 'cjs',
-  version: '8.5.2-1'
+  version: '8.5.2-4'
 };
 exports.packageInfo = packageInfo;

package/cjs/utils/sanitize.js

@@ -14,6 +14,7 @@ exports.removePairOf = removePairOf;
 exports.removeTraits = removeTraits;
 exports.removeWrap = removeWrap;
 exports.sanitize = sanitize;
+exports.trim = trim;
 // Copyright 2017-2022 @polkadot/types-codec authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 const BOUNDED = ['BTreeMap', 'BTreeSet', 'HashMap', 'Vec'];
@@ -35,7 +36,13 @@ alias('RawAddress', 'Address'), // lookups, mapped to Address/AccountId as appro
 alias('Lookup::Source', 'LookupSource'), alias('Lookup::Target', 'LookupTarget'), // HACK duplication between contracts & primitives, however contracts prefixed with exec
 alias('exec::StorageKey', 'ContractStorageKey'), // flattens tuples with one value, `(AccountId)` -> `AccountId`
 flattenSingleTuple(), // converts ::Type to Type, <T as Trait<I>>::Proposal -> Proposal
-removeColons()]; // given a starting index, find the closing >
+removeColons(), // remove all trailing spaces - this should always be the last
+trim()]; // given a string, trim it
+
+function trim() {
+  return value => value.trim();
+} // given a starting index, find the closing >
+
 
 function findClosing(value, start) {
   let depth = 0;
@@ -218,10 +225,11 @@ function removeWrap(check) {
 const sanitizeMap = new Map(); // eslint-disable-next-line @typescript-eslint/ban-types
 
 function sanitize(value, options) {
-  let result = value.toString();
+  const startValue = value.toString();
+  let result = startValue;
 
   if (!options) {
-    const memoized = sanitizeMap.get(result);
+    const memoized = sanitizeMap.get(startValue);
 
     if (memoized) {
       return memoized;
@@ -232,10 +240,8 @@ function sanitize(value, options) {
     result = mappings[i](result, options);
   }
 
-  result = result.trim();
-
   if (!options) {
-    sanitizeMap.set(value.toString(), result);
+    sanitizeMap.set(startValue, result);
   }
 
   return result;

package/extended/OptionBool.d.ts

@@ -0,0 +1,40 @@
+import type { HexString } from '@polkadot/util/types';
+import type { AnyBool, Inspect, Registry } from '../types';
+import { Option } from '../base/Option';
+import { bool as Bool } from '../native/Bool';
+/**
+ * @name OptionBool
+ * @description A specific implementation of Option<bool> than allows for single-byte encoding
+ */
+export declare class OptionBool extends Option<Bool> {
+    constructor(registry: Registry, value?: Option<Bool> | AnyBool | Uint8Array | HexString | null);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description The length of the initial encoded value (Only available when constructed from a Uint8Array)
+     */
+    get initialU8aLength(): number;
+    /**
+     * @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 Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(): Inspect;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(isBare?: boolean): 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/extended/OptionBool.js

@@ -0,0 +1,88 @@
+// Copyright 2017-2022 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+import { isHex, isU8a, u8aToU8a } from '@polkadot/util';
+import { Option } from "../base/Option.js";
+import { bool as Bool } from "../native/Bool.js";
+
+function decodeU8a(registry, value) {
+  // Encoded as -
+  //  - 0 = None
+  //  - 1 = True
+  //  - 2 = False
+  return value[0] === 0 ? null : new Bool(registry, value[0] === 1);
+}
+/**
+ * @name OptionBool
+ * @description A specific implementation of Option<bool> than allows for single-byte encoding
+ */
+
+
+export class OptionBool extends Option {
+  constructor(registry, value) {
+    super(registry, Bool, isU8a(value) || isHex(value) ? decodeU8a(registry, u8aToU8a(value)) : value);
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return 1;
+  }
+  /**
+   * @description The length of the initial encoded value (Only available when constructed from a Uint8Array)
+   */
+
+
+  get initialU8aLength() {
+    return 1;
+  }
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+
+
+  get isFalse() {
+    return this.isSome ? !this.value.valueOf() : false;
+  }
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+
+
+  get isTrue() {
+    return this.isSome ? this.value.valueOf() : false;
+  }
+  /**
+   * @description Returns a breakdown of the hex encoding for this Codec
+   */
+
+
+  inspect() {
+    return {
+      outer: [this.toU8a()]
+    };
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType(isBare) {
+    return isBare ? 'bool' : 'Option<bool>';
+  }
+  /**
+   * @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 super.toU8a(true);
+    }
+
+    return this.isSome ? new Uint8Array([this.isTrue ? 1 : 2]) : new Uint8Array([0]);
+  }
+
+}

package/extended/index.d.ts

@@ -5,6 +5,7 @@ export { Bytes } from './Bytes';
 export { HashMap } from './HashMap';
 export { Linkage } from './Linkage';
 export { CodecMap, CodecMap as Map } from './Map';
+export { OptionBool } from './OptionBool';
 export { Range } from './Range';
 export { RangeInclusive } from './RangeInclusive';
 export { Type } from './Type';

package/extended/index.js

@@ -7,6 +7,7 @@ export { Bytes } from "./Bytes.js";
 export { HashMap } from "./HashMap.js";
 export { Linkage } from "./Linkage.js";
 export { CodecMap, CodecMap as Map } from "./Map.js";
+export { OptionBool } from "./OptionBool.js";
 export { Range } from "./Range.js";
 export { RangeInclusive } from "./RangeInclusive.js";
 export { Type } from "./Type.js";

package/native/Text.d.ts

@@ -1,5 +1,5 @@
 import type { HexString } from '@polkadot/util/types';
-import type { AnyU8a, Inspect, IText, IU8a, Registry } from '../types';
+import type { AnyString, AnyU8a, Inspect, IText, IU8a, Registry } from '../types';
 /**
  * @name Text
  * @description
@@ -12,7 +12,7 @@ export declare class Text extends String implements IText {
     #private;
     readonly registry: Registry;
     createdAtHash?: IU8a;
-    constructor(registry: Registry, value?: null | Text | string | AnyU8a | {
+    constructor(registry: Registry, value?: null | AnyString | AnyU8a | {
         toString: () => string;
     });
     /**

package/package.json

@@ -20,7 +20,7 @@
     "./cjs/detectPackage.js"
   ],
   "type": "module",
-  "version": "8.5.2-1",
+  "version": "8.5.2-4",
   "main": "./cjs/index.js",
   "module": "./index.js",
   "types": "./index.d.ts",
@@ -172,6 +172,11 @@
       "require": "./cjs/extended/Map.js",
       "default": "./extended/Map.js"
     },
+    "./extended/OptionBool": {
+      "types": "./extended/OptionBool.d.ts",
+      "require": "./cjs/extended/OptionBool.js",
+      "default": "./extended/OptionBool.js"
+    },
     "./extended/Range": {
       "types": "./extended/Range.d.ts",
       "require": "./cjs/extended/Range.js",

package/packageInfo.js

@@ -5,5 +5,5 @@ export const packageInfo = {
   name: '@polkadot/types-codec',
   path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto',
   type: 'esm',
-  version: '8.5.2-1'
+  version: '8.5.2-4'
 };

package/utils/sanitize.d.ts

@@ -2,6 +2,7 @@ interface SanitizeOptions {
     allowNamespaces?: boolean;
 }
 declare type Mapper = (value: string, options?: SanitizeOptions) => string;
+export declare function trim(): Mapper;
 export declare function findClosing(value: string, start: number): number;
 export declare function alias(src: string, dest: string, withChecks?: boolean): Mapper;
 export declare function cleanupCompact(): Mapper;

package/utils/sanitize.js

@@ -19,7 +19,12 @@ alias('RawAddress', 'Address'), // lookups, mapped to Address/AccountId as appro
 alias('Lookup::Source', 'LookupSource'), alias('Lookup::Target', 'LookupTarget'), // HACK duplication between contracts & primitives, however contracts prefixed with exec
 alias('exec::StorageKey', 'ContractStorageKey'), // flattens tuples with one value, `(AccountId)` -> `AccountId`
 flattenSingleTuple(), // converts ::Type to Type, <T as Trait<I>>::Proposal -> Proposal
-removeColons()]; // given a starting index, find the closing >
+removeColons(), // remove all trailing spaces - this should always be the last
+trim()]; // given a string, trim it
+
+export function trim() {
+  return value => value.trim();
+} // given a starting index, find the closing >
 
 export function findClosing(value, start) {
   let depth = 0;
@@ -191,10 +196,11 @@ export function removeWrap(check) {
 const sanitizeMap = new Map(); // eslint-disable-next-line @typescript-eslint/ban-types
 
 export function sanitize(value, options) {
-  let result = value.toString();
+  const startValue = value.toString();
+  let result = startValue;
 
   if (!options) {
-    const memoized = sanitizeMap.get(result);
+    const memoized = sanitizeMap.get(startValue);
 
     if (memoized) {
       return memoized;
@@ -205,10 +211,8 @@ export function sanitize(value, options) {
     result = mappings[i](result, options);
   }
 
-  result = result.trim();
-
   if (!options) {
-    sanitizeMap.set(value.toString(), result);
+    sanitizeMap.set(startValue, result);
   }
 
   return result;