@polkadot/types-codec 6.12.2-2 → 6.12.2-23

package/native/Text.d.ts

@@ -1,71 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { AnyU8a, Codec, CodecRegistry, IU8a } from '../types';
-/**
- * @name Text
- * @description
- * This is a string wrapper, along with the length. It is used both for strings as well
- * as items such as documentation. It simply extends the standard JS `String` built-in
- * object, inheriting all methods exposed from `String`.
- * @noInheritDoc
- */
-export declare class Text extends String implements Codec {
-    #private;
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    constructor(registry: CodecRegistry, value?: null | Text | string | AnyU8a | {
-        toString: () => string;
-    });
-    /**
-     * @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 | undefined;
-    /**
-     * @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 Set an override value for this
-     */
-    setOverride(override: string): void;
-    /**
-     * @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(): string;
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON(): string;
-    /**
-     * @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;
-}

package/native/index.d.ts

@@ -1,7 +0,0 @@
-export { bool, bool as Bool } from './Bool';
-export { CodecDate, CodecDate as Date } from './Date';
-export { Json } from './Json';
-export { Raw } from './Raw';
-export { CodecSet, CodecSet as Set } from './Set';
-export { Struct } from './Struct';
-export { Text } from './Text';

package/packageInfo.d.ts

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

package/primitive/I128.d.ts

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

package/primitive/I16.d.ts

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

package/primitive/I256.d.ts

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

package/primitive/I32.d.ts

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

package/primitive/I64.d.ts

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

package/primitive/I8.d.ts

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

package/primitive/U128.d.ts

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

package/primitive/U16.d.ts

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

package/primitive/U256.d.ts

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

package/primitive/U32.d.ts

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

package/primitive/U64.d.ts

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

package/primitive/U8.d.ts

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

package/primitive/USize.d.ts

@@ -1,12 +0,0 @@
-import type { CodecRegistry } from '../types';
-import { u32 } from './U32';
-/**
- * @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: CodecRegistry, value?: unknown);
-}

package/primitive/index.d.ts

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

package/types/codec.d.ts

@@ -1,77 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { AnyJson } from './helpers';
-import type { IU8a } from './interfaces';
-import type { CodecRegistry } from './registry';
-export declare type BareOpts = boolean | Record<string, boolean>;
-/**
- * @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 length of the value when encoded as a Uint8Array
-     */
-    readonly encodedLength: number;
-    /**
-     * @description Returns a hash of the value
-     */
-    readonly hash: IU8a;
-    /**
-     * @description The length of the initial encoded value (Only available when constructed from a Uint8Array)
-     */
-    readonly initialU8aLength?: number;
-    /**
-     * @description Checks if the value is an empty value
-     */
-    readonly isEmpty: boolean;
-    /**
-     * @description The registry associated with this object
-     */
-    readonly registry: CodecRegistry;
-    /**
-     * @description The block at which this value was retrieved/created (set to non-empty when retrieved from storage)
-     */
-    createdAtHash?: IU8a;
-    /**
-     * @description Compares the value of the input to see if there is a match
-     */
-    eq(other?: unknown): boolean;
-    /**
-     * @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): AnyJson;
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON(): 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)
-     */
-    toU8a(isBare?: BareOpts): Uint8Array;
-}
-export interface CodecClass<T = Codec> {
-    /**
-     * @description An internal fallback type (previous generation) if encoding fails
-     */
-    readonly __fallbackType?: string;
-    new (registry: CodecRegistry, ...args: any[]): T;
-}
-export declare type CodecClassDef<T = Codec> = Record<string, CodecClass<T>>;
-export declare type CodecTo = 'toHex' | 'toJSON' | 'toString' | 'toU8a';
-export declare type ArgsDef = Record<string, CodecClass | string>;

package/types/helpers.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="bn.js" />
-import type { BN } from '@polkadot/util';
-import type { Codec } from './codec';
-export declare type AnyJson = string | number | boolean | null | undefined | AnyJson[] | {
-    [index: string]: AnyJson;
-};
-export declare type AnyFunction = (...args: any[]) => any;
-export declare type AnyNumber = BN | bigint | Uint8Array | number | string;
-export declare type AnyString = string | string;
-export declare type AnyTuple = Codec[];
-export declare type AnyU8a = Uint8Array | number[] | string;
-export declare type UIntBitLength = 8 | 16 | 32 | 64 | 128 | 256;
-export declare type U8aBitLength = 8 | 16 | 32 | 64 | 128 | 160 | 256 | 264 | 512 | 520 | 1024 | 2048;
-export declare type AnyTupleValue = AnyU8a | (Codec | AnyU8a | AnyNumber | AnyString | undefined | null)[];

package/types/index.d.ts

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

package/types/interfaces.d.ts

@@ -1,68 +0,0 @@
-/// <reference types="bn.js" />
-import type { BN } from '@polkadot/util';
-import type { ArgsDef, Codec } from './codec';
-import type { AnyTuple } from './helpers';
-export interface ICompact<T extends INumber = INumber> extends Codec {
-    toBigInt(): bigint;
-    toBn(): BN;
-    toNumber(): number;
-    unwrap(): T;
-}
-export interface IEnum extends Codec {
-    readonly defIndexes: number[];
-    readonly defKeys: string[];
-    readonly index: number;
-    readonly isBasic: boolean;
-    readonly type: string;
-    readonly value: Codec;
-    toNumber(): number;
-}
-export interface IMap<K extends Codec = Codec, V extends Codec = Codec> extends Map<K, V>, Codec {
-}
-export interface INumber extends Codec {
-    bitLength(): number;
-    toBigInt(): bigint;
-    toBn(): BN;
-    toNumber(): number;
-}
-export interface IOption<T extends Codec = Codec> extends Codec {
-    readonly isNone: boolean;
-    readonly isSome: boolean;
-    readonly value: Codec;
-    unwrap(): T;
-    unwrapOr<O>(other: O): T | O;
-    unwrapOrDefault(): T;
-}
-export interface IResult<O extends Codec = Codec, E extends Codec = Codec> extends IEnum {
-    readonly asErr: E;
-    readonly asOk: O;
-    readonly isErr: boolean;
-    readonly isOk: boolean;
-}
-export interface ISet<K = string> extends Set<K>, Codec {
-    readonly strings: string[];
-}
-export interface IStruct<K = string, V extends Codec = Codec> extends Map<K, V>, Codec {
-    readonly defKeys: string[];
-    getAtIndex(index: number): Codec;
-    toArray(): Codec[];
-}
-export declare type ITuple<T extends AnyTuple = Codec[]> = T & Codec;
-export interface IU8a extends Uint8Array, Codec {
-    readonly isAscii: boolean;
-    readonly isUtf8: boolean;
-    bitLength(): number;
-    toHuman(isExtended?: boolean): any;
-    toJSON(): any;
-    toUtf8(): string;
-}
-export interface IVec<T extends Codec = Codec> extends Array<T>, Codec {
-    toArray(): T[];
-}
-export interface IMethod<A extends AnyTuple = AnyTuple> extends Codec {
-    readonly args: A;
-    readonly argsDef: ArgsDef;
-    readonly callIndex: Uint8Array;
-    readonly data: Uint8Array;
-    is: (tx: IMethod<AnyTuple>) => tx is IMethod<A>;
-}

package/types/registry.d.ts

@@ -1,44 +0,0 @@
-/// <reference types="bn.js" />
-import type { BN } from '@polkadot/util';
-import type { Codec, CodecClass } from './codec';
-import type { ICompact, IEnum, IMap, IMethod, INumber, IOption, IResult, ISet, IStruct, ITuple, IU8a, IVec } from './interfaces';
-export declare type OnlyCodec<K, T, Types> = K extends keyof Types ? Types[K] : T extends ICompact | IEnum | IMap | IMethod | INumber | IOption | IResult | ISet | IStruct | ITuple | IU8a | IVec ? T : T extends Codec ? T : never;
-export declare type RegistryTypes = Record<string, CodecClass | string | Record<string, string> | {
-    _enum: string[] | Record<string, number> | Record<string, string | null>;
-} | {
-    _set: Record<string, number>;
-}>;
-export interface CodecCreateOptions {
-    blockHash?: Uint8Array | string | null;
-    isOptional?: boolean;
-    isPedantic?: boolean;
-}
-export interface CodecRegistry {
-    readonly chainDecimals: number[];
-    readonly chainSS58: number | undefined;
-    readonly chainTokens: string[];
-    createdAtHash?: IU8a;
-    findMetaCall(callIndex: Uint8Array): unknown;
-    findMetaError(errorIndex: Uint8Array | {
-        error: BN;
-        index: BN;
-    }): unknown;
-    findMetaEvent(eventIndex: Uint8Array): CodecClass<any>;
-    isLookupType(value: string): boolean;
-    createLookupType(lookupId: ICompact<INumber> | number): string;
-    createClassUnsafe<T extends Codec = Codec, K extends string = string>(type: K): CodecClass<T>;
-    createTypeUnsafe<T extends Codec = Codec, K extends string = string>(type: K, params: unknown[], options?: CodecCreateOptions): T;
-    getClassName(clazz: CodecClass): string | undefined;
-    getOrThrow<T extends Codec = Codec, K extends string = string>(name: K, msg?: string): CodecClass<T>;
-    getOrUnknown<T extends Codec = Codec, K extends string = string>(name: K): CodecClass<T>;
-    getSignedExtensionExtra(): Record<string, string>;
-    getSignedExtensionTypes(): Record<string, string>;
-    hasClass(name: string): boolean;
-    hasDef(name: string): boolean;
-    hasType(name: string): boolean;
-    hash(data: Uint8Array): IU8a;
-    register(type: CodecClass | RegistryTypes): void;
-    register(name: string, type: CodecClass): void;
-    register(arg1: string | CodecClass | RegistryTypes, arg2?: CodecClass): void;
-    setMetadata(metadata: unknown, signedExtensions?: string[], userExtensions?: unknown): void;
-}

package/utils/compareArray.d.ts

@@ -1 +0,0 @@
-export declare function compareArray(a: unknown[], b?: unknown): boolean;

package/utils/compareMap.d.ts

@@ -1 +0,0 @@
-export declare function compareMap(a: Map<unknown, unknown>, b?: unknown): boolean;

package/utils/compareSet.d.ts

@@ -1 +0,0 @@
-export declare function compareSet(a: Set<unknown>, b?: unknown): boolean;

package/utils/decodeU8a.d.ts

@@ -1,13 +0,0 @@
-import type { Codec, CodecClass, CodecRegistry } from '../types';
-/**
- * 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 declare function decodeU8a<T extends Codec = Codec, E = T>(registry: CodecRegistry, u8a: Uint8Array, types: CodecClass[] | {
-    [index: string]: CodecClass;
-}, withZip?: boolean): [E[], number];
-export declare function decodeU8aVec<T extends Codec = Codec>(registry: CodecRegistry, u8a: Uint8Array, start: number, Type: CodecClass<T>, count: number): [T[], number, number];

package/utils/index.d.ts

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

package/utils/mapToTypeMap.d.ts

@@ -1,5 +0,0 @@
-import type { CodecClass, CodecRegistry } from '../types';
-/**
- * @description takes an input map of the form `{ [string]: string | CodecClass }` and returns a map of `{ [string]: CodecClass }`
- */
-export declare function mapToTypeMap(registry: CodecRegistry, input: Record<string, string | CodecClass>): Record<string, CodecClass>;

package/utils/sanitize.d.ts

@@ -1,16 +0,0 @@
-interface SanitizeOptions {
-    allowNamespaces?: boolean;
-}
-declare type Mapper = (value: string, options?: SanitizeOptions) => string;
-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;
-export declare function flattenSingleTuple(): Mapper;
-export declare function removeExtensions(type: string, isSized: boolean): Mapper;
-export declare function removeColons(): Mapper;
-export declare function removeGenerics(): Mapper;
-export declare function removePairOf(): Mapper;
-export declare function removeTraits(): Mapper;
-export declare function removeWrap(check: string): Mapper;
-export declare function sanitize(value: String | string, options?: SanitizeOptions): string;
-export {};

package/utils/sortValues.d.ts

@@ -1,13 +0,0 @@
-/// <reference types="bn.js" />
-import type { BN } from '@polkadot/util';
-import type { Codec } from '../types';
-declare type SortArg = Codec | Codec[] | number[] | BN | bigint | number | Uint8Array;
-/**
-* Sort keys/values of BTreeSet/BTreeMap in ascending order for encoding compatibility with Rust's BTreeSet/BTreeMap
-* (https://doc.rust-lang.org/stable/std/collections/struct.BTreeSet.html)
-* (https://doc.rust-lang.org/stable/std/collections/struct.BTreeMap.html)
-*/
-export declare function sortAsc<V extends SortArg = Codec>(a: V, b: V): number;
-export declare function sortSet<V extends Codec = Codec>(set: Set<V>): Set<V>;
-export declare function sortMap<K extends Codec = Codec, V extends Codec = Codec>(map: Map<K, V>): Map<K, V>;
-export {};

package/utils/typeToConstructor.d.ts

@@ -1,2 +0,0 @@
-import type { Codec, CodecClass, CodecRegistry } from '../types';
-export declare function typeToConstructor<T extends Codec = Codec>(registry: CodecRegistry, type: string | CodecClass<T>): CodecClass<T>;

package/utils/typesToMap.d.ts

@@ -1,2 +0,0 @@
-import type { CodecClass, CodecRegistry } from '../types';
-export declare function typesToMap(registry: CodecRegistry, Types: Record<string, CodecClass>): Record<string, string>;

package/utils/util.d.ts

@@ -1,3 +0,0 @@
-export declare function hasEq(o: unknown): o is {
-    eq: (other: unknown) => boolean;
-};