@pezkuwi/types-codec 16.5.6 → 16.5.8

package/build/packageDetect.d.ts

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

package/build/packageDetect.js

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

package/build/packageInfo.d.ts

@@ -0,0 +1,6 @@
+export declare const packageInfo: {
+    name: string;
+    path: string;
+    type: string;
+    version: string;
+};

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.d.ts

@@ -0,0 +1,11 @@
+import { Float } from '../native/Float.js';
+declare const f32_base: import("../types/codec.js").CodecClass<Float, any[]>;
+/**
+ * @name f32
+ * @description
+ * A 32-bit float
+ */
+export declare class f32 extends f32_base {
+    readonly __FloatType = "f32";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { Float } from '../native/Float.js';
+declare const f64_base: import("../types/codec.js").CodecClass<Float, any[]>;
+/**
+ * @name f64
+ * @description
+ * A 64-bit float
+ */
+export declare class f64 extends f64_base {
+    readonly __FloatType = "f64";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { Int } from '../base/Int.js';
+declare const i128_base: import("../types/codec.js").CodecClass<Int, any[]>;
+/**
+ * @name i128
+ * @description
+ * A 128-bit signed integer
+ */
+export declare class i128 extends i128_base {
+    readonly __IntType = "i128";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { Int } from '../base/Int.js';
+declare const i16_base: import("../types/codec.js").CodecClass<Int, any[]>;
+/**
+ * @name i16
+ * @description
+ * A 16-bit signed integer
+ */
+export declare class i16 extends i16_base {
+    readonly __IntType = "i16";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { Int } from '../base/Int.js';
+declare const i256_base: import("../types/codec.js").CodecClass<Int, any[]>;
+/**
+ * @name i256
+ * @description
+ * A 256-bit signed integer
+ */
+export declare class i256 extends i256_base {
+    readonly __IntType = "i256";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { Int } from '../base/Int.js';
+declare const i32_base: import("../types/codec.js").CodecClass<Int, any[]>;
+/**
+ * @name i32
+ * @description
+ * A 32-bit signed integer
+ */
+export declare class i32 extends i32_base {
+    readonly __IntType = "i32";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { Int } from '../base/Int.js';
+declare const i64_base: import("../types/codec.js").CodecClass<Int, any[]>;
+/**
+ * @name i64
+ * @description
+ * A 64-bit signed integer
+ */
+export declare class i64 extends i64_base {
+    readonly __IntType = "i64";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { Int } from '../base/Int.js';
+declare const i8_base: import("../types/codec.js").CodecClass<Int, any[]>;
+/**
+ * @name i8
+ * @description
+ * An 8-bit signed integer
+ */
+export declare class i8 extends i8_base {
+    readonly __IntType = "i8";
+}
+export {};

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.d.ts

@@ -0,0 +1,12 @@
+import type { Registry } from '../types/index.js';
+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 declare class isize extends i32 {
+    constructor(registry: Registry, value?: unknown);
+}

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.d.ts

@@ -0,0 +1,11 @@
+import { UInt } from '../base/UInt.js';
+declare const u128_base: import("../types/codec.js").CodecClass<UInt, any[]>;
+/**
+ * @name u128
+ * @description
+ * A 128-bit unsigned integer
+ */
+export declare class u128 extends u128_base {
+    readonly __UIntType = "u128";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { UInt } from '../base/UInt.js';
+declare const u16_base: import("../types/codec.js").CodecClass<UInt, any[]>;
+/**
+ * @name u16
+ * @description
+ * A 16-bit unsigned integer
+ */
+export declare class u16 extends u16_base {
+    readonly __UIntType = "u16";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { UInt } from '../base/UInt.js';
+declare const u256_base: import("../types/codec.js").CodecClass<UInt, any[]>;
+/**
+ * @name u256
+ * @description
+ * A 256-bit unsigned integer
+ */
+export declare class u256 extends u256_base {
+    readonly __UIntType = "u256";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { UInt } from '../base/UInt.js';
+declare const u32_base: import("../types/codec.js").CodecClass<UInt, any[]>;
+/**
+ * @name u32
+ * @description
+ * A 32-bit unsigned integer
+ */
+export declare class u32 extends u32_base {
+    readonly __UIntType = "u32";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { UInt } from '../base/UInt.js';
+declare const u64_base: import("../types/codec.js").CodecClass<UInt, any[]>;
+/**
+ * @name u64
+ * @description
+ * A 64-bit unsigned integer
+ */
+export declare class u64 extends u64_base {
+    readonly __UIntType = "u64";
+}
+export {};

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.d.ts

@@ -0,0 +1,11 @@
+import { UInt } from '../base/UInt.js';
+declare const u8_base: import("../types/codec.js").CodecClass<UInt, any[]>;
+/**
+ * @name u8
+ * @description
+ * An 8-bit unsigned integer
+ */
+export declare class u8 extends u8_base {
+    readonly __UIntType = "u8";
+}
+export {};

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.d.ts

@@ -0,0 +1,12 @@
+import type { Registry } from '../types/index.js';
+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 declare class usize extends u32 {
+    constructor(registry: Registry, value?: unknown);
+}

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.d.ts

@@ -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/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

@@ -0,0 +1,113 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, ToString } from './helpers.js';
+import type { IU8a } from './interfaces.js';
+import type { Registry } from './registry.js';
+export type BareOpts = boolean | Record<string, boolean>;
+export interface Inspect {
+    inner?: Inspect[] | undefined;
+    name?: string;
+    outer?: Uint8Array[];
+}
+/**
+ * @name Codec
+ * @description
+ * The base Codec interface. All types implement the interface provided here.
+ * Additionally implementors can add their own specific interfaces and helpers
+ * with getters and functions. The Codec Base is however required for operating
+ * as an encoding/decoding layer
+ */
+export interface Codec {
+    /**
+     * @description
+     * The block at which this value was retrieved/created (set to non-empty when
+     * retrieved from storage)
+     */
+    createdAtHash?: IU8a | undefined;
+    /**
+     * @description
+     * The length of the initial encoded value (Only available when the value was
+     * constructed from a Uint8Array input)
+     */
+    initialU8aLength?: number | undefined;
+    /**
+     * @description
+     * (internal usage) Indicates that the value was created via a fallback. This
+     * is used when with data specified in the metadata when the storage entry is
+     * empty.
+     *
+     * 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 Bizinikiwi runtime)
+     */
+    isStorageFallback?: boolean;
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    readonly encodedLength: number;
+    /**
+     * @description Returns a hash of the value
+     */
+    readonly hash: IU8a;
+    /**
+     * @description Checks if the value is an empty value
+     */
+    readonly isEmpty: boolean;
+    /**
+     * @description The registry associated with this object
+     */
+    readonly registry: Registry;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other?: unknown): boolean;
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(isBare?: BareOpts): Inspect;
+    /**
+     * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+     */
+    toHex(isLe?: boolean): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     * @param isExtended When set, for some (e.g. call) it can add more info, e.g. metadata documentation. (Generally not needed in all cases, but can be useful in Events, Calls, ...)
+     * @param disableAscii When set, for some (e.g. `Raw` types) it will disable converting the value to ascii.
+     */
+    toHuman(isExtended?: boolean, disableAscii?: boolean): AnyJson;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): AnyJson;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     * @param disableAscii
+     */
+    toPrimitive(disableAscii?: boolean): AnyJson;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString(): 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 use, only available on
+     * some Codec types, specifically those that add encodings such as length of indexes)
+     */
+    toU8a(isBare?: BareOpts): Uint8Array;
+}
+export interface CodecClass<T = Codec, A extends unknown[] = any[]> {
+    /**
+     * @description An internal fallback type (previous generation) if encoding fails
+     */
+    readonly __fallbackType?: string;
+    new (registry: Registry, ...args: A): T;
+}
+export interface CodecObject<T extends ToString> extends Codec {
+    readonly $: T;
+    valueOf(): T;
+}
+export type CodecTo = 'toHex' | 'toJSON' | 'toPrimitive' | 'toString' | 'toU8a';
+export type ArgsDef = Record<string, CodecClass | string>;

package/build/types/codec.js

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

package/build/types/helpers.d.ts

@@ -0,0 +1,27 @@
+import type { BN } from '@pezkuwi/util';
+import type { HexString } from '@pezkuwi/util/types';
+import type { Codec } from './codec.js';
+export type AnyJson = string | number | boolean | null | undefined | AnyJson[] | {
+    [index: string]: AnyJson;
+};
+export type AnyFunction = (...args: any[]) => any;
+export type AnyNumber = BN | bigint | Uint8Array | number | string;
+export type AnyFloat = Number | number | Uint8Array | string;
+export type AnyString = String | string;
+export type AnyBool = Boolean | boolean;
+export type AnyTuple = Codec[];
+export type AnyU8a = Uint8Array | number[] | string;
+export type UIntBitLength = 8 | 16 | 32 | 64 | 128 | 256;
+export type U8aBitLength = 8 | 16 | 32 | 64 | 128 | 160 | 256 | 264 | 512 | 520 | 1024 | 2048;
+export type AnyTupleValue = Exclude<AnyU8a, string> | HexString | (Codec | AnyU8a | AnyNumber | AnyString | undefined | null)[];
+export interface ToString {
+    toString: () => string;
+}
+export interface ToBn {
+    toBn: () => BN;
+}
+export interface DefinitionSetter<T> {
+    definition?: T | undefined;
+    setDefinition?: (d: T) => T;
+}
+export type LookupString = `Lookup${number}`;

package/build/types/helpers.js

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

package/build/types/index.d.ts

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

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';