@pezkuwi/types-codec 16.5.5

package/README.md

@@ -0,0 +1,3 @@
+# @pezkuwi/types-codec
+
+Base scale-codec types.

package/build/abstract/Array.d.ts

@@ -0,0 +1,89 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, Codec, Inspect, IU8a, IVec, Registry } from '../types/index.js';
+/**
+ * @name AbstractArray
+ * @description
+ * This manages codec arrays. It is an extension to Array, providing
+ * specific encoding/decoding on top of the base type.
+ * @noInheritDoc
+ */
+export declare abstract class AbstractArray<T extends Codec> extends Array<T> implements IVec<T> {
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    /**
+     * @description This ensures that operators such as clice, filter, map, etc. return
+     * new Array instances (without this we need to apply overrides)
+     */
+    static get [Symbol.species](): typeof Array;
+    protected constructor(registry: Registry, length: number);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description The length of the value
+     */
+    get length(): number;
+    /**
+     * @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(): Inspect;
+    /**
+     * @internal
+     * @description Internal per-item inspection of internal values
+     */
+    inspectInner(): Inspect[];
+    /**
+     * @description Converts the Object to an standard JavaScript Array
+     */
+    toArray(): T[];
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    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
+     */
+    toPrimitive(disableAscii?: boolean): AnyJson;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    abstract 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)
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+    /**
+     * @internal
+     * @description Internal per-item SCALE encoding of contained values
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8aInner(isBare?: boolean): Uint8Array[];
+}

package/build/abstract/Base.d.ts

@@ -0,0 +1,75 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, BareOpts, Codec, Inspect, IU8a, Registry } from '../types/index.js';
+/**
+ * @name Base
+ * @description A type extends the Base class, when it holds a value
+ */
+export declare abstract class AbstractBase<T extends Codec> implements Codec {
+    #private;
+    readonly registry: Registry;
+    createdAtHash?: IU8a | undefined;
+    initialU8aLength?: number | undefined;
+    isStorageFallback?: boolean;
+    protected constructor(registry: Registry, value: T, initialU8aLength?: number);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description returns the inner (wrapped value)
+     */
+    get inner(): T;
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty(): boolean;
+    /**
+     * @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(): 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
+     */
+    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
+     */
+    toPrimitive(disableAscii?: boolean): AnyJson;
+    /**
+     * @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)
+     */
+    toU8a(isBare?: BareOpts): Uint8Array;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    abstract toRawType(): string;
+    /**
+     * @description Returns the inner wrapped value (equivalent to valueOf)
+     */
+    unwrap(): T;
+    /**
+     * @description Returns the inner wrapped value
+     */
+    valueOf(): T;
+}

package/build/abstract/Int.d.ts

@@ -0,0 +1,80 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyNumber, Inspect, INumber, IU8a, Registry, UIntBitLength } from '../types/index.js';
+import { BN } from '@pezkuwi/util';
+export declare const DEFAULT_UINT_BITS = 64;
+/**
+ * @name AbstractInt
+ * @ignore
+ * @noInheritDoc
+ */
+export declare abstract class AbstractInt extends BN implements INumber {
+    #private;
+    readonly registry: Registry;
+    readonly encodedLength: number;
+    readonly isUnsigned: boolean;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, value?: AnyNumber | null, bitLength?: UIntBitLength, isSigned?: boolean);
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Checks if the value is a zero value (align elsewhere)
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Returns the number of bits in the value
+     */
+    bitLength(): number;
+    /**
+     * @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(): Inspect;
+    /**
+     * @description True if this value is the max of the type
+     */
+    isMax(): boolean;
+    /**
+     * @description Returns a BigInt representation of the number
+     */
+    toBigInt(): bigint;
+    /**
+     * @description Returns the BN representation of the number. (Compatibility)
+     */
+    toBn(): BN;
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(isLe?: boolean): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(_isExpanded?: boolean): string;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(onlyHex?: boolean): any;
+    /**
+     * @description Returns the value in a primitive form, either number when <= 52 bits, or string otherwise
+     */
+    toPrimitive(): number | string;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Returns the string representation of the value
+     * @param base The base to use for the conversion
+     */
+    toString(base?: number): string;
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     */
+    toU8a(_isBare?: boolean): Uint8Array;
+}

package/build/abstract/Object.d.ts

@@ -0,0 +1,67 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, BareOpts, CodecObject, Inspect, IU8a, Registry, ToString } from '../types/index.js';
+/**
+ * @name Object
+ * @description A type extends the Base class, when it holds a value
+ */
+export declare abstract class AbstractObject<T extends ToString> implements CodecObject<T> {
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number | undefined;
+    isStorageFallback?: boolean;
+    readonly $: T;
+    protected constructor(registry: Registry, value: T, initialU8aLength?: number);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Checks if the value is an empty value
+     */
+    abstract get isEmpty(): boolean;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    abstract eq(other?: unknown): boolean;
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    abstract inspect(): Inspect;
+    /**
+     * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+     */
+    abstract toHex(isLe?: boolean): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    abstract toHuman(isExtended?: boolean, disableAscii?: boolean): AnyJson;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    abstract toJSON(): AnyJson;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    abstract toPrimitive(disableAscii?: boolean): AnyJson;
+    /**
+     * @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)
+     */
+    abstract toU8a(isBare?: BareOpts): Uint8Array;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    abstract toRawType(): string;
+    /**
+     * @description Return the internal value (JS-aligned, same result as $)
+     */
+    valueOf(): T;
+}

package/build/abstract/index.d.ts

@@ -0,0 +1,3 @@
+export { AbstractArray } from './Array.js';
+export { AbstractBase } from './Base.js';
+export { AbstractInt } from './Int.js';

package/build/base/Compact.d.ts

@@ -0,0 +1,88 @@
+import type { BN } from '@pezkuwi/util';
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, AnyNumber, CodecClass, DefinitionSetter, ICompact, Inspect, INumber, IU8a, Registry } from '../types/index.js';
+/**
+ * @name Compact
+ * @description
+ * A compact length-encoding codec wrapper. It performs the same function as Length, however
+ * differs in that it uses a variable number of bytes to do the actual encoding. This is mostly
+ * used by other types to add length-prefixed encoding, or in the case of wrapped types, taking
+ * a number and making the compact representation thereof
+ */
+export declare class Compact<T extends INumber> implements ICompact<T> {
+    #private;
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, Type: CodecClass<T> | string, value?: Compact<T> | AnyNumber, { definition, setDefinition }?: DefinitionSetter<CodecClass<T>>);
+    static with<O extends INumber>(Type: CodecClass<O> | string): CodecClass<Compact<O>>;
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Returns the number of bits in the value
+     */
+    bitLength(): number;
+    /**
+     * @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(): Inspect;
+    /**
+     * @description Returns a BigInt representation of the number
+     */
+    toBigInt(): bigint;
+    /**
+     * @description Returns the BN representation of the number
+     */
+    toBn(): BN;
+    /**
+     * @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
+     */
+    toHuman(isExtended?: boolean, disableAscii?: boolean): AnyJson;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): AnyJson;
+    /**
+     * @description Returns the number representation for the value
+     */
+    toNumber(): number;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii?: boolean): string | number;
+    /**
+     * @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
+     */
+    toU8a(_isBare?: boolean): Uint8Array;
+    /**
+     * @description Returns the embedded [[UInt]] or [[Moment]] value
+     */
+    unwrap(): T;
+}

package/build/base/DoNotConstruct.d.ts

@@ -0,0 +1,63 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, Codec, CodecClass, Inspect, IU8a, Registry } from '../types/index.js';
+/**
+ * @name DoNotConstruct
+ * @description
+ * An unknown type that fails on construction with the type info
+ */
+export declare class DoNotConstruct implements Codec {
+    #private;
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, typeName?: string);
+    static with(typeName?: string): CodecClass;
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Checks if the value is an empty value (always true)
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Unimplemented
+     */
+    eq(): boolean;
+    /**
+     * @description Unimplemented
+     */
+    inspect(): Inspect;
+    /**
+     * @description Unimplemented
+     */
+    toHex(): HexString;
+    /**
+     * @description Unimplemented
+     */
+    toHuman(): AnyJson;
+    /**
+     * @description Unimplemented
+     */
+    toJSON(): AnyJson;
+    /**
+     * @description Unimplemented
+     */
+    toPrimitive(): AnyJson;
+    /**
+     * @description Unimplemented
+     */
+    toRawType(): string;
+    /**
+     * @description Unimplemented
+     */
+    toString(): string;
+    /**
+     * @description Unimplemented
+     */
+    toU8a(): Uint8Array;
+}

package/build/base/Enum.d.ts

@@ -0,0 +1,118 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, Codec, CodecClass, DefinitionSetter, IEnum, Inspect, IU8a, Registry } from '../types/index.js';
+export type EnumCodecClass<T = Codec> = new (registry: Registry, value?: any, index?: number) => T;
+interface Definition {
+    def: TypesDef;
+    isBasic: boolean;
+    isIndexed: boolean;
+}
+interface EntryDef {
+    Type: CodecClass;
+    index: number;
+}
+type TypesDef = Record<string, EntryDef>;
+/**
+ * @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 declare class Enum implements IEnum {
+    #private;
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, Types: Record<string, string | CodecClass> | Record<string, number> | string[], value?: unknown, index?: number, { definition, setDefinition }?: DefinitionSetter<Definition>);
+    static with(Types: Record<string, string | CodecClass> | Record<string, number> | string[]): EnumCodecClass<Enum>;
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description The index of the enum value
+     */
+    get index(): number;
+    /**
+     * @description The value of the enum
+     */
+    get inner(): Codec;
+    /**
+     * @description true if this is a basic enum (no values)
+     */
+    get isBasic(): boolean;
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Checks if the Enum points to a [[Null]] type
+     */
+    get isNone(): boolean;
+    /**
+     * @description The available keys for this enum
+     */
+    get defIndexes(): number[];
+    /**
+     * @description The available keys for this enum
+     */
+    get defKeys(): string[];
+    /**
+     * @description The name of the type this enum value represents
+     */
+    get type(): string;
+    /**
+     * @description The value of the enum
+     */
+    get value(): Codec;
+    /**
+     * @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(): Inspect;
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExtended?: boolean, disableAscii?: boolean): AnyJson;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): AnyJson;
+    /**
+     * @description Returns the number representation for the value
+     */
+    toNumber(): number;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii?: boolean): AnyJson;
+    /**
+     * @description Returns a raw struct representation of the enum types
+     */
+    protected _toRawStruct(): string[] | Record<string, string | number>;
+    /**
+     * @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)
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+}
+export {};

package/build/base/Int.d.ts

@@ -0,0 +1,16 @@
+import type { AnyNumber, CodecClass, Registry, UIntBitLength } from '../types/index.js';
+import { AbstractInt } from '../abstract/Int.js';
+/**
+ * @name Int
+ * @description
+ * A generic signed integer codec. For Substrate all numbers are Little Endian encoded,
+ * this handles the encoding and decoding of those numbers. Upon construction
+ * the bitLength is provided and any additional use keeps the number to this
+ * length. This extends `BN`, so all methods available on a normal `BN` object
+ * is available here.
+ * @noInheritDoc
+ */
+export declare class Int extends AbstractInt {
+    constructor(registry: Registry, value?: AnyNumber | null, bitLength?: UIntBitLength);
+    static with(bitLength: UIntBitLength, typeName?: string): CodecClass<Int>;
+}

package/build/base/Null.d.ts

@@ -0,0 +1,56 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { Codec, Inspect, IU8a, Registry } from '../types/index.js';
+/**
+ * @name Null
+ * @description
+ * Implements a type that does not contain anything (apart from `null`)
+ */
+export declare class Null implements Codec {
+    readonly encodedLength = 0;
+    readonly isEmpty = true;
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry);
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @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(): Inspect;
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(): null;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): null;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): null;
+    /**
+     * @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
+     */
+    toU8a(_isBare?: boolean): Uint8Array;
+}