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

package/extended/Bytes.d.ts

@@ -1,25 +0,0 @@
-import type { AnyU8a, CodecRegistry } from '../types';
-import { Raw } from '../native/Raw';
-/**
- * @name Bytes
- * @description
- * A Bytes wrapper for Vec<u8>. The significant difference between this and a normal Uint8Array
- * is that this version allows for length-encoding. (i.e. it is a variable-item codec, the same
- * as what is found in [[Text]] and [[Vec]])
- */
-export declare class Bytes extends Raw {
-    constructor(registry: CodecRegistry, value?: AnyU8a);
-    /**
-     * @description The length of the value when encoded as a Uint8Array
-     */
-    get encodedLength(): number;
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): 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/HashMap.d.ts

@@ -1,5 +0,0 @@
-import type { Codec, CodecClass } from '../types';
-import { CodecMap } from './Map';
-export declare class HashMap<K extends Codec = Codec, V extends Codec = Codec> extends CodecMap<K, V> {
-    static with<K extends Codec, V extends Codec>(keyType: CodecClass<K> | string, valType: CodecClass<V> | string): CodecClass<CodecMap<K, V>>;
-}

package/extended/Linkage.d.ts

@@ -1,31 +0,0 @@
-import type { Codec, CodecClass, CodecRegistry } from '../types';
-import { Option } from '../base/Option';
-import { Tuple } from '../base/Tuple';
-import { Struct } from '../native/Struct';
-declare type TypeWithValues = [CodecClass, any[]];
-/**
- * @name Linkage
- * @description The wrapper for the result from a LinkedMap
- */
-export declare class Linkage<T extends Codec> extends Struct {
-    constructor(registry: CodecRegistry, Type: CodecClass | string, value?: unknown);
-    static withKey<O extends Codec>(Type: CodecClass | string): CodecClass<Linkage<O>>;
-    get previous(): Option<T>;
-    get next(): Option<T>;
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-    /**
-     * @description Custom toU8a which with bare mode does not return the linkage if empty
-     */
-    toU8a(): Uint8Array;
-}
-/**
- * @name LinkageResult
- * @description A Linkage keys/Values tuple
- */
-export declare class LinkageResult extends Tuple {
-    constructor(registry: CodecRegistry, [TypeKey, keys]: TypeWithValues, [TypeValue, values]: TypeWithValues);
-}
-export {};

package/extended/Map.d.ts

@@ -1,50 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { AnyJson, Codec, CodecClass, CodecRegistry, IMap, IU8a } from '../types';
-export declare class CodecMap<K extends Codec = Codec, V extends Codec = Codec> extends Map<K, V> implements IMap<K, V> {
-    #private;
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    readonly initialU8aLength?: number;
-    constructor(registry: CodecRegistry, keyType: CodecClass<K> | string, valType: CodecClass<V> | string, rawValue: Uint8Array | string | Map<any, any> | undefined, type?: 'BTreeMap' | 'HashMap');
-    /**
-     * @description The length of the value when encoded as a Uint8Array
-     */
-    get encodedLength(): number;
-    /**
-     * @description Returns a hash of the value
-     */
-    get hash(): IU8a;
-    /**
-     * @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 hex string representation of the value. isLe returns a LE (number-only) representation
-     */
-    toHex(): HexString;
-    /**
-     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-     */
-    toHuman(isExtended?: boolean): Record<string, AnyJson>;
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON(): Record<string, 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?: boolean): Uint8Array;
-}

package/extended/Range.d.ts

@@ -1,30 +0,0 @@
-import type { AnyTuple, CodecClass, CodecRegistry, INumber } from '../types';
-import { Tuple } from '../base/Tuple';
-declare type RangeType = 'Range' | 'RangeInclusive';
-/**
- * @name Range
- * @description
- * Rust `Range<T>` representation
- */
-export declare class Range<T extends INumber> extends Tuple {
-    #private;
-    constructor(registry: CodecRegistry, Type: CodecClass<T> | string, value?: AnyTuple, rangeName?: RangeType);
-    static with<T extends INumber>(Types: CodecClass<T> | string): CodecClass<Range<T>>;
-    /**
-     * @description Returns the starting range value
-     */
-    get start(): T;
-    /**
-     * @description Returns the ending range value
-     */
-    get end(): T;
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-}
-export declare class RangeInclusive<T extends INumber = INumber> extends Range<T> {
-    constructor(registry: CodecRegistry, type: CodecClass<T> | string, value?: AnyTuple);
-    static with<T extends INumber>(Types: CodecClass<T> | string): CodecClass<RangeInclusive<T>>;
-}
-export {};

package/extended/Type.d.ts

@@ -1,16 +0,0 @@
-import type { CodecRegistry } from '../types';
-import { Text } from '../native/Text';
-/**
- * @name Type
- * @description
- * This is a extended version of Text, specifically to handle types. Here we rely fully
- * on what Text provides us, however we also adjust the types received from the runtime,
- * i.e. we remove the `T::` prefixes found in some types for consistency across implementation.
- */
-export declare class Type extends Text {
-    constructor(registry: CodecRegistry, value?: Text | Uint8Array | string);
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-}

package/extended/U8aFixed.d.ts

@@ -1,16 +0,0 @@
-import type { AnyU8a, CodecClass, CodecRegistry, U8aBitLength } from '../types';
-import { Raw } from '../native/Raw';
-/**
- * @name U8aFixed
- * @description
- * A U8a that manages a a sequence of bytes up to the specified bitLength. Not meant
- * to be used directly, rather is should be subclassed with the specific lengths.
- */
-export declare class U8aFixed extends Raw {
-    constructor(registry: CodecRegistry, value?: AnyU8a, bitLength?: U8aBitLength);
-    static with(bitLength: U8aBitLength, typeName?: string): CodecClass<U8aFixed>;
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-}

package/extended/WrapperOpaque.d.ts

@@ -1,18 +0,0 @@
-import type { Codec, CodecClass, CodecRegistry } from '../types';
-import { Base } from '../base/Base';
-export declare class WrapperOpaque<T extends Codec> extends Base<T> {
-    constructor(registry: CodecRegistry, Type: CodecClass<T> | string, value?: unknown);
-    static with<T extends Codec>(Type: CodecClass<T> | string): CodecClass<WrapperOpaque<T>>;
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-    /**
-     * @description The length of the value when encoded as a Uint8Array
-     */
-    toU8a(isBare?: boolean): Uint8Array;
-    /**
-     * @description Return the inner value for the wrapped type
-     */
-    unwrap(): T;
-}

package/extended/index.d.ts

@@ -1,11 +0,0 @@
-export { BitVec } from './BitVec';
-export { BTreeMap } from './BTreeMap';
-export { BTreeSet } from './BTreeSet';
-export { Bytes } from './Bytes';
-export { HashMap } from './HashMap';
-export { Linkage } from './Linkage';
-export { CodecMap, CodecMap as Map } from './Map';
-export { Range, RangeInclusive } from './Range';
-export { Type } from './Type';
-export { U8aFixed } from './U8aFixed';
-export { WrapperOpaque } from './WrapperOpaque';

package/index.d.ts

@@ -1,2 +0,0 @@
-import './detectPackage';
-export * from './bundle';

package/native/Bool.d.ts

@@ -1,62 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { Codec, CodecRegistry, IU8a } from '../types';
-/**
- * @name bool
- * @description
- * Representation for a boolean value in the system. It extends the base JS `Boolean` class
- * @noInheritDoc
- */
-export declare class bool extends Boolean implements Codec {
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    constructor(registry: CodecRegistry, value?: bool | Boolean | Uint8Array | boolean | 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 (true when it wraps false/default)
-     */
-    get isEmpty(): boolean;
-    /**
-     * @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 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
-     */
-    toHex(): HexString;
-    /**
-     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-     */
-    toHuman(): boolean;
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON(): boolean;
-    /**
-     * @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/Date.d.ts

@@ -1,76 +0,0 @@
-/// <reference types="bn.js" />
-import type { HexString } from '@polkadot/util/types';
-import type { AnyNumber, CodecRegistry, INumber, IU8a, UIntBitLength } from '../types';
-import { BN } from '@polkadot/util';
-/**
- * @name Date
- * @description
- * A wrapper around seconds/timestamps. Internally the representation only has
- * second precicion (aligning with Rust), so any numbers passed an/out are always
- * per-second. For any encoding/decoding the 1000 multiplier would be applied to
- * get it in line with JavaScript formats. It extends the base JS `Date` object
- * and has all the methods available that are applicable to any `Date`
- * @noInheritDoc
- */
-export declare class CodecDate extends Date implements INumber {
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    constructor(registry: CodecRegistry, value?: CodecDate | Date | AnyNumber);
-    /**
-     * @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 Compares the value of the input to see if there is a match
-     */
-    eq(other?: unknown): boolean;
-    /**
-     * @description Returns the number of bits in the value
-     */
-    bitLength(): UIntBitLength;
-    /**
-     * @description Returns a BigInt representation of the number
-     */
-    toBigInt(): bigint;
-    /**
-     * @description Returns the BN representation of the timestamp
-     */
-    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(): string;
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON(): any;
-    /**
-     * @description Returns the number representation for the timestamp
-     */
-    toNumber(): 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;
-}

package/native/Json.d.ts

@@ -1,55 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { AnyJson, Codec, CodecRegistry, IU8a } from '../types';
-/**
- * @name Json
- * @description
- * Wraps the a JSON structure retrieve via RPC. It extends the standard JS Map with. While it
- * implements a Codec, it is limited in that it can only be used with input objects via RPC,
- * i.e. no hex decoding. Unlike a struct, this waps a JSON object with unknown keys
- * @noInheritDoc
- */
-export declare class Json extends Map<string, any> implements Codec {
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    constructor(registry: CodecRegistry, value?: Record<string, unknown> | null);
-    /**
-     * @description Always 0, never encodes 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 Compares the value of the input to see if there is a match
-     */
-    eq(other?: unknown): boolean;
-    /**
-     * @description Unimplemented, will throw
-     */
-    toHex(): HexString;
-    /**
-     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-     */
-    toHuman(): Record<string, AnyJson>;
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON(): Record<string, AnyJson>;
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-    /**
-     * @description Returns the string representation of the value
-     */
-    toString(): string;
-    /**
-     * @description Unimplemented, will throw
-     */
-    toU8a(isBare?: boolean): Uint8Array;
-}

package/native/Raw.d.ts

@@ -1,90 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { AnyJson, AnyU8a, CodecRegistry, IU8a } from '../types';
-/**
- * @name Raw
- * @description
- * A basic wrapper around Uint8Array, with no frills and no fuss. It does differ
- * from other implementations where it will consume the full Uint8Array as passed to it.
- * As such it is meant to be subclassed where the wrapper takes care of the
- * actual lengths instead of used directly.
- * @noInheritDoc
- */
-export declare class Raw extends Uint8Array implements IU8a {
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    readonly initialU8aLength?: number;
-    constructor(registry: CodecRegistry, value?: AnyU8a, 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 true if the wrapped value contains only ASCII printable characters
-     */
-    get isAscii(): boolean;
-    /**
-     * @description Returns true if the type wraps an empty/default all-0 value
-     */
-    get isEmpty(): boolean;
-    /**
-     * @description Returns true if the wrapped value contains only utf8 characters
-     */
-    get isUtf8(): boolean;
-    /**
-     * @description The length of the value
-     */
-    get length(): number;
-    /**
-     * @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 Create a new slice from the actual buffer. (compat)
-     * @param start The position to start at
-     * @param end The position to end at
-     */
-    slice(start?: number, end?: number): Uint8Array;
-    /**
-     * @description Create a new subarray from the actual buffer. (compat)
-     * @param begin The position to start at
-     * @param end The position to end at
-     */
-    subarray(begin?: number, end?: number): Uint8Array;
-    /**
-     * @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(): AnyJson;
-    /**
-     * @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;
-    /**
-     * @description Returns the wrapped data as a UTF-8 string
-     */
-    toUtf8(): string;
-}

package/native/Set.d.ts

@@ -1,76 +0,0 @@
-/// <reference types="bn.js" />
-import type { HexString } from '@polkadot/util/types';
-import type { CodecClass, CodecRegistry, ISet, IU8a } from '../types';
-import { BN } from '@polkadot/util';
-declare type SetValues = Record<string, number | BN>;
-/**
- * @name Set
- * @description
- * An Set is an array of string values, represented an an encoded type by
- * a bitwise representation of the values.
- */
-export declare class CodecSet extends Set<string> implements ISet<string> {
-    #private;
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    constructor(registry: CodecRegistry, setValues: SetValues, value?: string[] | Set<string> | Uint8Array | BN | number | string, bitLength?: number);
-    static with(values: SetValues, bitLength?: number): CodecClass<CodecSet>;
-    /**
-     * @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 true is the Set contains no values
-     */
-    get isEmpty(): boolean;
-    /**
-     * @description The actual set values as a string[]
-     */
-    get strings(): string[];
-    /**
-     * @description The encoded value for the set members
-     */
-    get valueEncoded(): BN;
-    /**
-     * @description adds a value to the Set (extended to allow for validity checking)
-     */
-    add: (key: string) => this;
-    /**
-     * @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
-     */
-    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 The encoded value for the set members
-     */
-    toNumber(): 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/native/Struct.d.ts

@@ -1,92 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { AnyJson, BareOpts, Codec, CodecClass, CodecRegistry, IStruct, IU8a } from '../types';
-declare type TypesDef<T = Codec> = Record<string, string | CodecClass<T>>;
-/**
- * @name Struct
- * @description
- * A Struct defines an Object with key-value pairs - where the values are Codec values. It removes
- * a lot of repetition from the actual coding, define a structure type, pass it the key/Codec
- * values in the constructor and it manages the decoding. It is important that the constructor
- * values matches 100% to the order in th Rust code, i.e. don't go crazy and make it alphabetical,
- * it needs to decoded in the specific defined order.
- * @noInheritDoc
- */
-export declare class Struct<S extends TypesDef = TypesDef, V extends {
-    [K in keyof S]: any;
-} = {
-    [K in keyof S]: any;
-}, E extends {
-    [K in keyof S]: string;
-} = {
-    [K in keyof S]: string;
-}> extends Map<keyof S, Codec> implements IStruct<keyof S> {
-    #private;
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    readonly initialU8aLength?: number;
-    constructor(registry: CodecRegistry, Types: S, value?: V | Map<unknown, unknown> | unknown[] | HexString | null, jsonMap?: Map<string, string>);
-    static with<S extends TypesDef>(Types: S, jsonMap?: Map<string, string>): CodecClass<Struct<S>>;
-    /**
-     * @description The available keys for this struct
-     */
-    get defKeys(): string[];
-    /**
-     * @description Checks if the value is an empty value
-     */
-    get isEmpty(): boolean;
-    /**
-     * @description Returns the Type description of the structure
-     */
-    get Type(): E;
-    /**
-     * @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 Compares the value of the input to see if there is a match
-     */
-    eq(other?: unknown): boolean;
-    /**
-     * @description Returns a specific names entry in the structure
-     * @param name The name of the entry to retrieve
-     */
-    get(name: keyof S): Codec | undefined;
-    /**
-     * @description Returns the values of a member at a specific index (Rather use get(name) for performance)
-     */
-    getAtIndex(index: number): Codec;
-    /**
-     * @description Converts the Object to an standard JavaScript Array
-     */
-    toArray(): Codec[];
-    /**
-     * @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): Record<string, AnyJson>;
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON(): Record<string, 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 {};