@pezkuwi/types-codec 16.5.5 → 16.5.8

package/build/packageDetect.js

@@ -0,0 +1,3 @@
+import { detectPackage } from '@pezkuwi/util';
+import { packageInfo } from './packageInfo.js';
+detectPackage(packageInfo, null, []);

package/build/packageInfo.js

@@ -0,0 +1 @@
+export const packageInfo = { name: '@pezkuwi/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: '16.5.8' };

package/build/primitive/F32.js

@@ -0,0 +1,10 @@
+import { Float } from '../native/Float.js';
+/**
+ * @name f32
+ * @description
+ * A 32-bit float
+ */
+export class f32 extends Float.with(32) {
+    // NOTE without this, we cannot properly determine extensions
+    __FloatType = 'f32';
+}

package/build/primitive/F64.js

@@ -0,0 +1,10 @@
+import { Float } from '../native/Float.js';
+/**
+ * @name f64
+ * @description
+ * A 64-bit float
+ */
+export class f64 extends Float.with(64) {
+    // NOTE without this, we cannot properly determine extensions
+    __FloatType = 'f64';
+}

package/build/primitive/I128.js

@@ -0,0 +1,10 @@
+import { Int } from '../base/Int.js';
+/**
+ * @name i128
+ * @description
+ * A 128-bit signed integer
+ */
+export class i128 extends Int.with(128) {
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i128';
+}

package/build/primitive/I16.js

@@ -0,0 +1,10 @@
+import { Int } from '../base/Int.js';
+/**
+ * @name i16
+ * @description
+ * A 16-bit signed integer
+ */
+export class i16 extends Int.with(16) {
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i16';
+}

package/build/primitive/I256.js

@@ -0,0 +1,10 @@
+import { Int } from '../base/Int.js';
+/**
+ * @name i256
+ * @description
+ * A 256-bit signed integer
+ */
+export class i256 extends Int.with(256) {
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i256';
+}

package/build/primitive/I32.js

@@ -0,0 +1,10 @@
+import { Int } from '../base/Int.js';
+/**
+ * @name i32
+ * @description
+ * A 32-bit signed integer
+ */
+export class i32 extends Int.with(32) {
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i32';
+}

package/build/primitive/I64.js

@@ -0,0 +1,10 @@
+import { Int } from '../base/Int.js';
+/**
+ * @name i64
+ * @description
+ * A 64-bit signed integer
+ */
+export class i64 extends Int.with(64) {
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i64';
+}

package/build/primitive/I8.js

@@ -0,0 +1,10 @@
+import { Int } from '../base/Int.js';
+/**
+ * @name i8
+ * @description
+ * An 8-bit signed integer
+ */
+export class i8 extends Int.with(8) {
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i8';
+}

package/build/primitive/ISize.js

@@ -0,0 +1,14 @@
+import { i32 } from './I32.js';
+/**
+ * @name ISize
+ * @description
+ * A System default signed number, typically used in RPC to report non-consensus
+ * data. It is a wrapper for [[I32]] as a WASM default (as generated by Rust bindings).
+ * It is not to be used, since it creates consensus mismatches.
+ */
+export class isize extends i32 {
+    constructor(registry, value) {
+        super(registry, value);
+        throw new Error('The `isize` type should not be used. Since it is platform-specific, it creates incompatibilities between native (generally i64) and WASM (always i32) code. Use one of the `i32` or `i64` types explicitly.');
+    }
+}

package/build/primitive/U128.js

@@ -0,0 +1,10 @@
+import { UInt } from '../base/UInt.js';
+/**
+ * @name u128
+ * @description
+ * A 128-bit unsigned integer
+ */
+export class u128 extends UInt.with(128) {
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u128';
+}

package/build/primitive/U16.js

@@ -0,0 +1,10 @@
+import { UInt } from '../base/UInt.js';
+/**
+ * @name u16
+ * @description
+ * A 16-bit unsigned integer
+ */
+export class u16 extends UInt.with(16) {
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u16';
+}

package/build/primitive/U256.js

@@ -0,0 +1,10 @@
+import { UInt } from '../base/UInt.js';
+/**
+ * @name u256
+ * @description
+ * A 256-bit unsigned integer
+ */
+export class u256 extends UInt.with(256) {
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u256';
+}

package/build/primitive/U32.js

@@ -0,0 +1,10 @@
+import { UInt } from '../base/UInt.js';
+/**
+ * @name u32
+ * @description
+ * A 32-bit unsigned integer
+ */
+export class u32 extends UInt.with(32) {
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u32';
+}

package/build/primitive/U64.js

@@ -0,0 +1,10 @@
+import { UInt } from '../base/UInt.js';
+/**
+ * @name u64
+ * @description
+ * A 64-bit unsigned integer
+ */
+export class u64 extends UInt.with(64) {
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u64';
+}

package/build/primitive/U8.js

@@ -0,0 +1,10 @@
+import { UInt } from '../base/UInt.js';
+/**
+ * @name u8
+ * @description
+ * An 8-bit unsigned integer
+ */
+export class u8 extends UInt.with(8) {
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u8';
+}

package/build/primitive/USize.js

@@ -0,0 +1,14 @@
+import { u32 } from './U32.js';
+/**
+ * @name USize
+ * @description
+ * A System default unsigned number, typically used in RPC to report non-consensus
+ * data. It is a wrapper for [[U32]] as a WASM default (as generated by Rust bindings).
+ * It is not to be used, since it created consensus mismatches.
+ */
+export class usize extends u32 {
+    constructor(registry, value) {
+        super(registry, value);
+        throw new Error('The `usize` type should not be used. Since it is platform-specific, it creates incompatibilities between native (generally u64) and WASM (always u32) code. Use one of the `u32` or `u64` types explicitly.');
+    }
+}

package/build/primitive/index.js

@@ -0,0 +1,16 @@
+export { f32 as F32, f32 } from './F32.js';
+export { f64 as F64, f64 } from './F64.js';
+export { i8 as I8, i8 } from './I8.js';
+export { i16 as I16, i16 } from './I16.js';
+export { i32 as I32, i32 } from './I32.js';
+export { i64 as I64, i64 } from './I64.js';
+export { i128 as I128, i128 } from './I128.js';
+export { i256 as I256, i256 } from './I256.js';
+export { isize as ISize, isize } from './ISize.js';
+export { u8 as U8, u8 } from './U8.js';
+export { u16 as U16, u16 } from './U16.js';
+export { u32 as U32, u32 } from './U32.js';
+export { u64 as U64, u64 } from './U64.js';
+export { u128 as U128, u128 } from './U128.js';
+export { u256 as U256, u256 } from './U256.js';
+export { usize as USize, usize } from './USize.js';

package/build/types/codec.d.ts

@@ -37,7 +37,7 @@ export interface Codec {
      *
      * With metadata fallback values (available as defaults on most storage entries)
      * any empty storage item should erturn the default. (This is the same as the
-     * implementation on the Substrate runtime)
+     * implementation on the Bizinikiwi runtime)
      */
     isStorageFallback?: boolean;
     /**

package/build/types/codec.js

@@ -0,0 +1 @@
+export {};

package/build/types/helpers.js

@@ -0,0 +1 @@
+export {};

package/build/types/index.js

@@ -0,0 +1,4 @@
+export * from './codec.js';
+export * from './helpers.js';
+export * from './interfaces.js';
+export * from './registry.js';

package/build/types/interfaces.js

@@ -0,0 +1 @@
+export {};

package/build/types/registry.js

@@ -0,0 +1 @@
+export {};

package/build/utils/compareArray.js

@@ -0,0 +1,10 @@
+import { isUndefined } from '@pezkuwi/util';
+import { hasEq } from './util.js';
+export function compareArray(a, b) {
+    if (Array.isArray(b)) {
+        return (a.length === b.length) && isUndefined(a.find((v, index) => hasEq(v)
+            ? !v.eq(b[index])
+            : v !== b[index]));
+    }
+    return false;
+}

package/build/utils/compareMap.js

@@ -0,0 +1,27 @@
+import { isObject, isUndefined } from '@pezkuwi/util';
+import { hasEq } from './util.js';
+function hasMismatch(a, b) {
+    return isUndefined(a) || (hasEq(a)
+        ? !a.eq(b)
+        : a !== b);
+}
+function notEntry(value) {
+    return !Array.isArray(value) || value.length !== 2;
+}
+function compareMapArray(a, b) {
+    // equal number of entries and each entry in the array should match
+    return (a.size === b.length) && !b.some((e) => notEntry(e) ||
+        hasMismatch(a.get(e[0]), e[1]));
+}
+export function compareMap(a, b) {
+    if (Array.isArray(b)) {
+        return compareMapArray(a, b);
+    }
+    else if (b instanceof Map) {
+        return compareMapArray(a, [...b.entries()]);
+    }
+    else if (isObject(b)) {
+        return compareMapArray(a, Object.entries(b));
+    }
+    return false;
+}

package/build/utils/compareSet.js

@@ -0,0 +1,17 @@
+import { isObject } from '@pezkuwi/util';
+function compareSetArray(a, b) {
+    // equal number of entries and each entry in the array should match
+    return (a.size === b.length) && !b.some((e) => !a.has(e));
+}
+export function compareSet(a, b) {
+    if (Array.isArray(b)) {
+        return compareSetArray(a, b);
+    }
+    else if (b instanceof Set) {
+        return compareSetArray(a, [...b.values()]);
+    }
+    else if (isObject(b)) {
+        return compareSetArray(a, Object.values(b));
+    }
+    return false;
+}

package/build/utils/decodeU8a.js

@@ -0,0 +1,100 @@
+import { u8aToHex } from '@pezkuwi/util';
+const MAX_DEPTH = 1024;
+/** @internal */
+function isComplexType(Type) {
+    const typeName = Type.name?.toLowerCase() || '';
+    return ['enum', 'hashmap', 'linkage', 'null', 'option', 'range', 'rangeinclusive', 'result', 'struct', 'tuple', 'vec', 'vecfixed'].includes(typeName);
+}
+/** @internal */
+function formatFailure(registry, fn, _result, { message }, u8a, i, count, Type, key) {
+    let type = '';
+    try {
+        type = `: ${new Type(registry).toRawType()}`;
+    }
+    catch {
+        // ignore
+    }
+    // This is extra debugging info (we most-probably want this in in some way, shape or form,
+    // but at this point not quite sure how to include and format it (it can be quite massive)
+    // console.error(JSON.stringify(result, null, 2));
+    return `${fn}: failed at ${u8aToHex(u8a.subarray(0, 16))}…${key ? ` on ${key}` : ''} (index ${i + 1}/${count})${type}:: ${message}`;
+}
+/**
+ * @internal
+ *
+ * Given an u8a, and an array of Type constructors, decode the u8a against the
+ * types, and return an array of decoded values.
+ *
+ * @param u8a - The u8a to decode.
+ * @param result - The result array (will be returned with values pushed)
+ * @param types - The array of CodecClass to decode the U8a against.
+ */
+export function decodeU8a(registry, result, u8a, [Types, keys]) {
+    const count = result.length;
+    let offset = 0;
+    let i = 0;
+    try {
+        while (i < count) {
+            const value = new Types[i](registry, u8a.subarray(offset));
+            offset += value.initialU8aLength || value.encodedLength;
+            result[i] = value;
+            i++;
+        }
+    }
+    catch (error) {
+        throw new Error(formatFailure(registry, 'decodeU8a', result, error, u8a.subarray(offset), i, count, Types[i], keys[i]));
+    }
+    return [result, offset];
+}
+/**
+ * @internal
+ *
+ * Split from decodeU8a since this is specialized to zip returns ... while we duplicate, this
+ * is all on the hot-path, so it is not great, however there is (some) method behind the madness
+ */
+export function decodeU8aStruct(registry, result, u8a, [Types, keys]) {
+    const count = result.length;
+    let offset = 0;
+    let i = 0;
+    if (count > MAX_DEPTH && isComplexType(Types[i])) {
+        throw new Error(`decodeU8aStruct: Maximum depth exceeded, received ${count} elements, limit ${MAX_DEPTH}`);
+    }
+    try {
+        while (i < count) {
+            const value = new Types[i](registry, u8a.subarray(offset));
+            offset += value.initialU8aLength || value.encodedLength;
+            result[i] = [keys[i], value];
+            i++;
+        }
+    }
+    catch (error) {
+        throw new Error(formatFailure(registry, 'decodeU8aStruct', result, error, u8a.subarray(offset), i, count, Types[i], keys[i]));
+    }
+    return [result, offset];
+}
+/**
+ * @internal
+ *
+ * Split from decodeU8a since this is specialized to 1 instance ... while we duplicate, this
+ * is all on the hot-path, so it is not great, however there is (some) method behind the madness
+ */
+export function decodeU8aVec(registry, result, u8a, startAt, Type) {
+    const count = result.length;
+    if (count > MAX_DEPTH && isComplexType(Type)) {
+        throw new Error(`decodeU8aVec: Maximum depth exceeded, received ${count} elements, limit ${MAX_DEPTH}`);
+    }
+    let offset = startAt;
+    let i = 0;
+    try {
+        while (i < count) {
+            const value = new Type(registry, u8a.subarray(offset));
+            offset += value.initialU8aLength || value.encodedLength;
+            result[i] = value;
+            i++;
+        }
+    }
+    catch (error) {
+        throw new Error(formatFailure(registry, 'decodeU8aVec', result, error, u8a.subarray(offset), i, count, Type));
+    }
+    return [offset, offset - startAt];
+}

package/build/utils/index.js

@@ -0,0 +1,8 @@
+export { compareArray } from './compareArray.js';
+export { compareMap } from './compareMap.js';
+export { compareSet } from './compareSet.js';
+export { decodeU8a, decodeU8aStruct, decodeU8aVec } from './decodeU8a.js';
+export { sanitize } from './sanitize.js';
+export { sortAsc, sortMap, sortSet } from './sortValues.js';
+export { mapToTypeMap, typesToConstructors, typeToConstructor } from './toConstructors.js';
+export { typesToMap } from './typesToMap.js';

package/build/utils/sanitize.js

@@ -0,0 +1,219 @@
+const BOUNDED = ['BTreeMap', 'BTreeSet', 'HashMap', 'Vec'];
+const ALLOWED_BOXES = BOUNDED.concat(['Compact', 'DoNotConstruct', 'Int', 'Linkage', 'Range', 'RangeInclusive', 'Result', 'Opaque', 'Option', 'UInt', 'WrapperKeepOpaque', 'WrapperOpaque']);
+const BOX_PRECEDING = ['<', '(', '[', '"', ',', ' ']; // start of vec, tuple, fixed array, part of struct def or in tuple
+const mappings = [
+    // alias <T::InherentOfflineReport as InherentOfflineReport>::Inherent -> InherentOfflineReport
+    alias('<T::InherentOfflineReport as InherentOfflineReport>::Inherent', 'InherentOfflineReport', false),
+    alias('VecDeque<', 'Vec<', false),
+    // <T::Balance as HasCompact>
+    cleanupCompact(),
+    // Change BoundedVec<Type, Size> to Vec<Type>
+    removeExtensions('Bounded', true),
+    // Change WeakVec<Type> to Vec<Type>
+    removeExtensions('Weak', false),
+    // Remove all the trait prefixes
+    removeTraits(),
+    // remove PairOf<T> -> (T, T)
+    removePairOf(),
+    // remove boxing, `Box<Proposal>` -> `Proposal`
+    removeWrap('Box<'),
+    // remove generics, `MisbehaviorReport<Hash, BlockNumber>` -> `MisbehaviorReport`
+    removeGenerics(),
+    // alias String -> Text (compat with jsonrpc methods)
+    alias('String', 'Text'),
+    // alias Vec<u8> -> Bytes
+    alias('Vec<u8>', 'Bytes'),
+    alias('&\\[u8\\]', 'Bytes'),
+    alias("&'static\\[u8\\]", 'Bytes'),
+    // alias RawAddress -> Address
+    alias('RawAddress', 'Address'),
+    // lookups, mapped to Address/AccountId as appropriate in runtime
+    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(),
+    // remove all trailing spaces - this should always be the last
+    trim()
+];
+export function trim() {
+    return (value) => value.trim();
+}
+export function findClosing(value, start) {
+    let depth = 0;
+    for (let i = start, count = value.length; i < count; i++) {
+        if (value[i] === '>') {
+            if (!depth) {
+                return i;
+            }
+            depth--;
+        }
+        else if (value[i] === '<') {
+            depth++;
+        }
+    }
+    throw new Error(`Unable to find closing matching <> on '${value}' (start ${start})`);
+}
+export function alias(src, dest, withChecks = true) {
+    const from = new RegExp(`(^${src}|${BOX_PRECEDING.map((box) => `\\${box}${src}`).join('|')})`, 'g');
+    const to = (src) => {
+        from.lastIndex = 0;
+        return withChecks && BOX_PRECEDING.includes(src[0])
+            ? `${src[0]}${dest}`
+            : dest;
+    };
+    return (value) => value.replace(from, to);
+}
+export function cleanupCompact() {
+    return (value) => {
+        if (value.includes(' as HasCompact')) {
+            for (let i = 0, count = value.length; i < count; i++) {
+                if (value[i] === '<') {
+                    const end = findClosing(value, i + 1) - 14;
+                    if (value.substring(end, end + 14) === ' as HasCompact') {
+                        value = `Compact<${value.substring(i + 1, end)}>`;
+                    }
+                }
+            }
+        }
+        return value;
+    };
+}
+export function flattenSingleTuple() {
+    const from1 = /,\)/g;
+    const from2 = /\(([^,]+)\)/;
+    return (value) => {
+        from1.lastIndex = 0;
+        return value
+            // tuples may have trailing commas, e.g. (u32, BlockNumber, )
+            .replace(from1, ')')
+            // change (u32) -> u32
+            .replace(from2, '$1');
+    };
+}
+function replaceTagWith(value, matcher, replacer) {
+    let index = -1;
+    while (true) {
+        index = value.indexOf(matcher, index + 1);
+        if (index === -1) {
+            return value;
+        }
+        const start = index + matcher.length;
+        const end = findClosing(value, start);
+        value = `${value.substring(0, index)}${replacer(value.substring(start, end))}${value.substring(end + 1)}`;
+    }
+}
+export function removeExtensions(type, isSized) {
+    return (value) => {
+        for (let i = 0, count = BOUNDED.length; i < count; i++) {
+            const tag = BOUNDED[i];
+            value = replaceTagWith(value, `${type}${tag}<`, (v) => {
+                const parts = v
+                    .split(',')
+                    .map((s) => s.trim())
+                    .filter((s) => s);
+                if (isSized) {
+                    parts.pop();
+                }
+                return `${tag}<${parts.join(',')}>`;
+            });
+        }
+        return value;
+    };
+}
+export function removeColons() {
+    return (value) => {
+        let index = 0;
+        while (index !== -1) {
+            index = value.indexOf('::');
+            if (index === 0) {
+                value = value.substring(2);
+            }
+            else if (index !== -1) {
+                let start = index;
+                while (start !== -1 && !BOX_PRECEDING.includes(value[start])) {
+                    start--;
+                }
+                value = `${value.substring(0, start + 1)}${value.substring(index + 2)}`;
+            }
+        }
+        return value;
+    };
+}
+export function removeGenerics() {
+    return (value) => {
+        for (let i = 0, count = value.length; i < count; i++) {
+            if (value[i] === '<') {
+                // check against the allowed wrappers, be it Vec<..>, Option<...> ...
+                const box = ALLOWED_BOXES.find((box) => {
+                    const start = i - box.length;
+                    return ((start >= 0 &&
+                        value.substring(start, i) === box) && (
+                    // make sure it is stand-alone, i.e. don't catch ElectionResult<...> as Result<...>
+                    start === 0 ||
+                        BOX_PRECEDING.includes(value[start - 1])));
+                });
+                // we have not found anything, unwrap generic innards
+                if (!box) {
+                    const end = findClosing(value, i + 1);
+                    value = `${value.substring(0, i)}${value.substring(end + 1)}`;
+                }
+            }
+        }
+        return value;
+    };
+}
+export function removePairOf() {
+    const replacer = (v) => `(${v},${v})`;
+    return (value) => replaceTagWith(value, 'PairOf<', replacer);
+}
+export function removeTraits() {
+    const from1 = /\s/g;
+    const from2 = /(T|Self)::/g;
+    const from3 = /<(T|Self)asTrait>::/g;
+    const from4 = /<Tas[a-z]+::Trait>::/g;
+    const from5 = /<LookupasStaticLookup>/g;
+    const from6 = /::Type/g;
+    return (value) => {
+        from1.lastIndex = 0;
+        from2.lastIndex = 0;
+        from3.lastIndex = 0;
+        from4.lastIndex = 0;
+        from5.lastIndex = 0;
+        from6.lastIndex = 0;
+        return value
+            // remove all whitespaces
+            .replace(from1, '')
+            // anything `T::<type>` to end up as `<type>`
+            .replace(from2, '')
+            // replace `<T as Trait>::` (whitespaces were removed above)
+            .replace(from3, '')
+            // replace `<T as something::Trait>::` (whitespaces were removed above)
+            .replace(from4, '')
+            // replace <Lookup as StaticLookup>
+            .replace(from5, 'Lookup')
+            // replace `<...>::Type`
+            .replace(from6, '');
+    };
+}
+export function removeWrap(check) {
+    const replacer = (v) => v;
+    return (value) => replaceTagWith(value, check, replacer);
+}
+const sanitizeMap = new Map();
+export function sanitize(value) {
+    const startValue = value.toString();
+    const memoized = sanitizeMap.get(startValue);
+    if (memoized) {
+        return memoized;
+    }
+    let result = startValue;
+    for (let i = 0, count = mappings.length; i < count; i++) {
+        result = mappings[i](result);
+    }
+    sanitizeMap.set(startValue, result);
+    return result;
+}