@polkadot/types-codec 6.12.2-20 → 6.12.2-24

package/base/Compact.d.ts

@@ -1,83 +0,0 @@
-/// <reference types="bn.js" />
-import type { BN } from '@polkadot/util';
-import type { HexString } from '@polkadot/util/types';
-import type { AnyJson, AnyNumber, CodecClass, CodecRegistry, ICompact, INumber, IU8a } from '../types';
-/**
- * @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: CodecRegistry;
-    createdAtHash?: IU8a;
-    readonly initialU8aLength?: number;
-    constructor(registry: CodecRegistry, Type: CodecClass<T> | string, value?: Compact<T> | AnyNumber);
-    static with<T extends INumber>(Type: CodecClass<T> | string): CodecClass<Compact<T>>;
-    /** @internal */
-    static decodeCompact<T extends INumber>(registry: CodecRegistry, Type: CodecClass<T>, value: Compact<T> | AnyNumber): [T, 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 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 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): 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 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 embedded [[UInt]] or [[Moment]] value
-     */
-    unwrap(): T;
-}

package/base/DoNotConstruct.d.ts

@@ -1,33 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { AnyJson, Codec, CodecClass, CodecRegistry, IU8a } from '../types';
-/**
- * @name DoNotConstruct
- * @description
- * An unknown type that fails on construction with the type info
- */
-export declare class DoNotConstruct implements Codec {
-    #private;
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    constructor(registry: CodecRegistry, 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;
-    eq(): boolean;
-    toHex(): HexString;
-    toHuman(): AnyJson;
-    toJSON(): AnyJson;
-    toRawType(): string;
-    toString(): string;
-    toU8a(): Uint8Array;
-}

package/base/Enum.d.ts

@@ -1,105 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { AnyJson, Codec, CodecClass, CodecRegistry, IEnum, IU8a } from '../types';
-export interface EnumCodecClass<T = Codec> {
-    new (registry: CodecRegistry, value?: any, index?: number): T;
-}
-/**
- * @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: CodecRegistry;
-    createdAtHash?: IU8a;
-    readonly initialU8aLength?: number;
-    constructor(registry: CodecRegistry, Types: Record<string, string | CodecClass> | Record<string, number> | string[], value?: unknown, index?: number);
-    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 Checks if the Enum points to a [[Null]] type
-     * @deprecated use isNone
-     */
-    get isNull(): 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 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): 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 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;
-}

package/base/Int.d.ts

@@ -1,16 +0,0 @@
-import type { AnyNumber, CodecClass, CodecRegistry, UIntBitLength } from '../types';
-import { AbstractInt } from '../abstract/AbstractInt';
-/**
- * @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: CodecRegistry, value?: AnyNumber, bitLength?: UIntBitLength);
-    static with(bitLength: UIntBitLength, typeName?: string): CodecClass<Int>;
-}

package/base/Null.d.ts

@@ -1,54 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { Codec, CodecRegistry, IU8a } from '../types';
-/**
- * @name Null
- * @description
- * Implements a type that does not contain anything (apart from `null`)
- */
-export declare class Null implements Codec {
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    readonly initialU8aLength = 0;
-    constructor(registry: CodecRegistry);
-    /**
-     * @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 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(): null;
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON(): 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
-     * @param isBare true when the value has none of the type-specific prefixes (internal)
-     */
-    toU8a(isBare?: boolean): Uint8Array;
-}

package/base/Option.d.ts

@@ -1,88 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { AnyJson, Codec, CodecClass, CodecRegistry, IOption, IU8a } from '../types';
-/**
- * @name Option
- * @description
- * An Option is an optional field. Basically the first byte indicates that there is
- * is value to follow. If the byte is `1` there is an actual value. So the Option
- * implements that - decodes, checks for optionality and wraps the required structure
- * with a value if/as required/found.
- */
-export declare class Option<T extends Codec> implements IOption<T> {
-    #private;
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    constructor(registry: CodecRegistry, typeName: CodecClass<T> | string, value?: unknown);
-    static with<O extends Codec>(Type: CodecClass<O> | string): CodecClass<Option<O>>;
-    /**
-     * @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 Option has no value
-     */
-    get isEmpty(): boolean;
-    /**
-     * @description Checks if the Option has no value
-     */
-    get isNone(): boolean;
-    /**
-     * @description Checks if the Option has a value
-     */
-    get isSome(): boolean;
-    /**
-     * @description The actual value for the Option
-     */
-    get value(): Codec;
-    /**
-     * @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(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(isBare?: boolean): 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 value that the Option represents (if available), throws if null
-     */
-    unwrap(): T;
-    /**
-     * @description Returns the value that the Option represents (if available) or defaultValue if none
-     * @param defaultValue The value to return if the option isNone
-     */
-    unwrapOr<O>(defaultValue: O): T | O;
-    /**
-     * @description Returns the value that the Option represents (if available) or defaultValue if none
-     * @param defaultValue The value to return if the option isNone
-     */
-    unwrapOrDefault(): T;
-}

package/base/Result.d.ts

@@ -1,46 +0,0 @@
-import type { Codec, CodecClass, CodecRegistry, IResult } from '../types';
-import { Enum } from './Enum';
-/**
- * @name Result
- * @description
- * A Result maps to the Rust Result type, that can either wrap a success or error value
- */
-export declare class Result<O extends Codec, E extends Codec> extends Enum implements IResult<O, E> {
-    constructor(registry: CodecRegistry, Ok: CodecClass<O> | string, Err: CodecClass<E> | string, value?: unknown);
-    static with<O extends Codec, E extends Codec>(Types: {
-        Ok: CodecClass<O> | string;
-        Err: CodecClass<E> | string;
-    }): CodecClass<Result<O, E>>;
-    /**
-     * @description Returns the wrapper Err value (if isErr)
-     */
-    get asErr(): E;
-    /**
-     * @deprecated Use asErr
-     */
-    get asError(): E;
-    /**
-     * @description Returns the wrapper Ok value (if isOk)
-     */
-    get asOk(): O;
-    /**
-     * @description Checks if the Result has no value
-     */
-    get isEmpty(): boolean;
-    /**
-     * @description Checks if the Result wraps an Err value
-     */
-    get isErr(): boolean;
-    /**
-     * @deprecated Use isErr
-     */
-    get isError(): boolean;
-    /**
-     * @description Checks if the Result wraps an Ok value
-     */
-    get isOk(): boolean;
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-}

package/base/Tuple.d.ts

@@ -1,39 +0,0 @@
-import type { AnyTupleValue, Codec, CodecClass, CodecRegistry, ITuple } from '../types';
-import { AbstractArray } from '../abstract/AbstractArray';
-declare type TupleType = (CodecClass | string);
-declare type TupleTypes = TupleType[] | {
-    [index: string]: CodecClass | string;
-};
-/**
- * @name Tuple
- * @description
- * A Tuple defines an anonymous fixed-length array, where each element has its
- * own type. It extends the base JS `Array` object.
- */
-export declare class Tuple extends AbstractArray<Codec> implements ITuple<Codec[]> {
-    #private;
-    constructor(registry: CodecRegistry, Types: TupleTypes | TupleType, value?: AnyTupleValue);
-    static with(Types: TupleTypes | TupleType): CodecClass<Tuple>;
-    /**
-     * @description The length of the value when encoded as a Uint8Array
-     */
-    get encodedLength(): number;
-    /**
-     * @description The types definition of the tuple
-     */
-    get Types(): 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;
-}
-export {};

package/base/UInt.d.ts

@@ -1,15 +0,0 @@
-import type { CodecClass, UIntBitLength } from '../types';
-import { AbstractInt } from '../abstract/AbstractInt';
-/**
- * @name UInt
- * @description
- * A generic unsigned 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 UInt extends AbstractInt {
-    static with(bitLength: UIntBitLength, typeName?: string): CodecClass<UInt>;
-}

package/base/Vec.d.ts

@@ -1,28 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { Codec, CodecClass, CodecRegistry } from '../types';
-import { AbstractArray } from '../abstract/AbstractArray';
-export declare function decodeVec<T extends Codec>(registry: CodecRegistry, Type: CodecClass<T>, value: Uint8Array | HexString | unknown[], length?: number): [T[], number, number];
-/**
- * @name Vec
- * @description
- * This manages codec arrays. Internally it keeps track of the length (as decoded) and allows
- * construction with the passed `Type` in the constructor. It is an extension to Array, providing
- * specific encoding/decoding on top of the base type.
- */
-export declare class Vec<T extends Codec> extends AbstractArray<T> {
-    #private;
-    constructor(registry: CodecRegistry, Type: CodecClass<T> | string, value?: Uint8Array | HexString | unknown[]);
-    static with<O extends Codec>(Type: CodecClass<O> | string): CodecClass<Vec<O>>;
-    /**
-     * @description The type for the items
-     */
-    get Type(): string;
-    /**
-     * @description Finds the index of the value in the array
-     */
-    indexOf(_other?: unknown): number;
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-}

package/base/VecAny.d.ts

@@ -1,15 +0,0 @@
-import type { Codec } from '../types';
-import { AbstractArray } from '../abstract/AbstractArray';
-/**
- * @name VecAny
- * @description
- * This manages codec arrays, assuming that the inputs are already of type Codec. Unlike
- * a vector, this can be used to manage array-like structures with variable arguments of
- * any types
- */
-export declare class VecAny<T extends Codec> extends AbstractArray<T> {
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-}

package/base/VecFixed.d.ts

@@ -1,26 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { Codec, CodecClass, CodecRegistry } from '../types';
-import { AbstractArray } from '../abstract/AbstractArray';
-/**
- * @name VecFixed
- * @description
- * This manages codec arrays of a fixed length
- */
-export declare class VecFixed<T extends Codec> extends AbstractArray<T> {
-    #private;
-    constructor(registry: CodecRegistry, Type: CodecClass<T> | string, length: number, value?: Uint8Array | HexString | unknown[]);
-    static with<O extends Codec>(Type: CodecClass<O> | string, length: number): CodecClass<VecFixed<O>>;
-    /**
-     * @description The type for the items
-     */
-    get Type(): string;
-    /**
-     * @description The length of the value when encoded as a Uint8Array
-     */
-    get encodedLength(): number;
-    toU8a(): Uint8Array;
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-}

package/base/index.d.ts

@@ -1,13 +0,0 @@
-export { Base } from './Base';
-export { Compact } from './Compact';
-export { DoNotConstruct } from './DoNotConstruct';
-export { Enum } from './Enum';
-export { Int } from './Int';
-export { Null } from './Null';
-export { Option } from './Option';
-export { Result } from './Result';
-export { Tuple } from './Tuple';
-export { UInt } from './UInt';
-export { Vec } from './Vec';
-export { VecAny } from './VecAny';
-export { VecFixed } from './VecFixed';

package/bundle.d.ts

@@ -1,7 +0,0 @@
-export { packageInfo } from './packageInfo';
-export * from './abstract';
-export * from './base';
-export * from './extended';
-export * from './native';
-export * from './primitive';
-export * from './utils';

package/checkTypes.manual.cjs

@@ -1,12 +0,0 @@
-"use strict";
-
-require("@polkadot/types-augment");
-
-var _types = require("@polkadot/types");
-
-var _index = require("./index.cjs");
-
-// Copyright 2017-2021 @polkadot/types authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-const registry = new _types.TypeRegistry();
-console.log(new _index.U32(registry).divn(1));

package/checkTypes.manual.js

@@ -1,7 +0,0 @@
-// Copyright 2017-2021 @polkadot/types authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-import '@polkadot/types-augment';
-import { TypeRegistry } from '@polkadot/types';
-import { U32 } from "./index.js";
-const registry = new TypeRegistry();
-console.log(new U32(registry).divn(1));

package/detectPackage.d.ts

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

package/extended/BTreeMap.d.ts

@@ -1,5 +0,0 @@
-import type { Codec, CodecClass } from '../types';
-import { CodecMap } from './Map';
-export declare class BTreeMap<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/BTreeSet.d.ts

@@ -1,55 +0,0 @@
-import type { HexString } from '@polkadot/util/types';
-import type { AnyJson, Codec, CodecClass, CodecRegistry, ISet, IU8a } from '../types';
-export declare class BTreeSet<V extends Codec = Codec> extends Set<V> implements ISet<V> {
-    #private;
-    readonly registry: CodecRegistry;
-    createdAtHash?: IU8a;
-    readonly initialU8aLength?: number;
-    constructor(registry: CodecRegistry, valType: CodecClass<V> | string, rawValue?: Uint8Array | string | string[] | Set<any>);
-    static with<V extends Codec>(valType: CodecClass<V> | string): CodecClass<BTreeSet<V>>;
-    /**
-     * @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 The actual set values as a string[]
-     */
-    get strings(): string[];
-    /**
-     * @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): 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?: boolean): Uint8Array;
-}