@pezkuwi/types-codec 16.5.8 → 16.5.9

package/src/primitive/I256.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Int } from '../base/Int.js';
-
-/**
- * @name i256
- * @description
- * A 256-bit signed integer
- */
-export class i256 extends Int.with(256) {
-  // NOTE without this, we cannot properly determine extensions
-  readonly __IntType = 'i256';
-}

package/src/primitive/I32.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Int } from '../base/Int.js';
-
-/**
- * @name i32
- * @description
- * A 32-bit signed integer
- */
-export class i32 extends Int.with(32) {
-  // NOTE without this, we cannot properly determine extensions
-  readonly __IntType = 'i32';
-}

package/src/primitive/I64.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Int } from '../base/Int.js';
-
-/**
- * @name i64
- * @description
- * A 64-bit signed integer
- */
-export class i64 extends Int.with(64) {
-  // NOTE without this, we cannot properly determine extensions
-  readonly __IntType = 'i64';
-}

package/src/primitive/I8.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Int } from '../base/Int.js';
-
-/**
- * @name i8
- * @description
- * An 8-bit signed integer
- */
-export class i8 extends Int.with(8) {
-  // NOTE without this, we cannot properly determine extensions
-  readonly __IntType = 'i8';
-}

package/src/primitive/ISize.ts

@@ -1,21 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Registry } from '../types/index.js';
-
-import { i32 } from './I32.js';
-
-/**
- * @name ISize
- * @description
- * A System default signed number, typically used in RPC to report non-consensus
- * data. It is a wrapper for [[I32]] as a WASM default (as generated by Rust bindings).
- * It is not to be used, since it creates consensus mismatches.
- */
-export class isize extends i32 {
-  constructor (registry: Registry, value?: unknown) {
-    super(registry, value);
-
-    throw new Error('The `isize` type should not be used. Since it is platform-specific, it creates incompatibilities between native (generally i64) and WASM (always i32) code. Use one of the `i32` or `i64` types explicitly.');
-  }
-}

package/src/primitive/U128.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from '../base/UInt.js';
-
-/**
- * @name u128
- * @description
- * A 128-bit unsigned integer
- */
-export class u128 extends UInt.with(128) {
-  // NOTE without this, we cannot properly determine extensions
-  readonly __UIntType = 'u128';
-}

package/src/primitive/U16.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from '../base/UInt.js';
-
-/**
- * @name u16
- * @description
- * A 16-bit unsigned integer
- */
-export class u16 extends UInt.with(16) {
-  // NOTE without this, we cannot properly determine extensions
-  readonly __UIntType = 'u16';
-}

package/src/primitive/U256.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from '../base/UInt.js';
-
-/**
- * @name u256
- * @description
- * A 256-bit unsigned integer
- */
-export class u256 extends UInt.with(256) {
-  // NOTE without this, we cannot properly determine extensions
-  readonly __UIntType = 'u256';
-}

package/src/primitive/U32.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from '../base/UInt.js';
-
-/**
- * @name u32
- * @description
- * A 32-bit unsigned integer
- */
-export class u32 extends UInt.with(32) {
-  // NOTE without this, we cannot properly determine extensions
-  readonly __UIntType = 'u32';
-}

package/src/primitive/U64.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from '../base/UInt.js';
-
-/**
- * @name u64
- * @description
- * A 64-bit unsigned integer
- */
-export class u64 extends UInt.with(64) {
-  // NOTE without this, we cannot properly determine extensions
-  readonly __UIntType = 'u64';
-}

package/src/primitive/U8.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from '../base/UInt.js';
-
-/**
- * @name u8
- * @description
- * An 8-bit unsigned integer
- */
-export class u8 extends UInt.with(8) {
-  // NOTE without this, we cannot properly determine extensions
-  readonly __UIntType = 'u8';
-}

package/src/primitive/USize.ts

@@ -1,21 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Registry } from '../types/index.js';
-
-import { u32 } from './U32.js';
-
-/**
- * @name USize
- * @description
- * A System default unsigned number, typically used in RPC to report non-consensus
- * data. It is a wrapper for [[U32]] as a WASM default (as generated by Rust bindings).
- * It is not to be used, since it created consensus mismatches.
- */
-export class usize extends u32 {
-  constructor (registry: Registry, value?: unknown) {
-    super(registry, value);
-
-    throw new Error('The `usize` type should not be used. Since it is platform-specific, it creates incompatibilities between native (generally u64) and WASM (always u32) code. Use one of the `u32` or `u64` types explicitly.');
-  }
-}

package/src/primitive/index.ts

@@ -1,19 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export { f32 as F32, f32 } from './F32.js';
-export { f64 as F64, f64 } from './F64.js';
-export { i8 as I8, i8 } from './I8.js';
-export { i16 as I16, i16 } from './I16.js';
-export { i32 as I32, i32 } from './I32.js';
-export { i64 as I64, i64 } from './I64.js';
-export { i128 as I128, i128 } from './I128.js';
-export { i256 as I256, i256 } from './I256.js';
-export { isize as ISize, isize } from './ISize.js';
-export { u8 as U8, u8 } from './U8.js';
-export { u16 as U16, u16 } from './U16.js';
-export { u32 as U32, u32 } from './U32.js';
-export { u64 as U64, u64 } from './U64.js';
-export { u128 as U128, u128 } from './U128.js';
-export { u256 as U256, u256 } from './U256.js';
-export { usize as USize, usize } from './USize.js';

package/src/test/performance.ts

@@ -1,61 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/* global it */
-
-// Shamelessly copied from @pezkuwi/util/test
-
-import { formatDecimal, formatNumber } from '@pezkuwi/util';
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type ExecFn = (...params: any[]) => unknown;
-
-const NUM_PAD = 16;
-const PRE_PAD = 32;
-
-function loop (count: number, inputs: unknown[][], exec: ExecFn): [number, unknown[]] {
-  const start = performance.now();
-  const inputsCount = inputs.length;
-  const results = new Array<unknown>(inputsCount);
-
-  for (let i = 0; i < count; i++) {
-    const result = exec(...inputs[i % inputsCount]);
-
-    if (i < inputsCount) {
-      results[i] = result;
-    }
-  }
-
-  return [performance.now() - start, results];
-}
-
-export function formatFixed (value: number): string {
-  const [a, b] = value.toFixed(2).split('.');
-
-  return [formatDecimal(a), b].join('.');
-}
-
-export function formatOps (count: number, time: number): string {
-  const micro = (time * 1000) / count;
-  const ops = 1_000_000 / micro;
-
-  return `
-${formatFixed(ops).padStart(NUM_PAD + PRE_PAD + 1)} ops/s
-${formatFixed(micro).padStart(NUM_PAD + PRE_PAD + 1)} μs/op`;
-}
-
-export function perf (name: string, count: number, inputs: unknown[][], exec: ExecFn): void {
-  const test = process.env['GITHUB_REPOSITORY']
-    ? it.skip
-    : it;
-
-  test(`performance: ${name}`, (): void => {
-    const [time] = loop(count, inputs, exec);
-
-    console.error(`
-performance run for ${name} completed with ${formatNumber(count)} iterations.
-
-${`${name}:`.padStart(PRE_PAD)} ${time.toFixed(2).padStart(NUM_PAD)} ms${formatOps(count, time)}
-`);
-  });
-}

package/src/types/codec.ts

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

package/src/types/helpers.ts

@@ -1,50 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { BN } from '@pezkuwi/util';
-import type { HexString } from '@pezkuwi/util/types';
-import type { Codec } from './codec.js';
-
-export type AnyJson = string | number | boolean | null | undefined | AnyJson[] | { [index: string]: AnyJson };
-
-export type AnyFunction = (...args: any[]) => any;
-
-export type AnyNumber = BN | bigint | Uint8Array | number | string;
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type AnyFloat = Number | number | Uint8Array | string;
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type AnyString = String | string;
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type AnyBool = Boolean | boolean;
-
-export type AnyTuple = Codec[];
-
-export type AnyU8a = Uint8Array | number[] | string;
-
-export type UIntBitLength = 8 | 16 | 32 | 64 | 128 | 256;
-
-// The 520 here is a weird one - it is explicitly for a [u8; 65] as found as a EcdsaSignature,
-// and 264 here is explicitly for a [u8; 33] as found as EcdsaPublic key.
-// Likewise 160 is for [u8; 20], which is also a H160, i.e. an Ethereum address. Both these are
-// as a result of the Pezkuwi claims module. (Technically we don't need the 520 in here)
-export type U8aBitLength = 8 | 16 | 32 | 64 | 128 | 160 | 256 | 264 | 512 | 520 | 1024 | 2048;
-
-export type AnyTupleValue = Exclude<AnyU8a, string> | HexString | (Codec | AnyU8a | AnyNumber | AnyString | undefined | null)[];
-
-export interface ToString {
-  toString: () => string;
-}
-
-export interface ToBn {
-  toBn: () => BN;
-}
-
-export interface DefinitionSetter <T> {
-  definition?: T | undefined;
-  setDefinition?: (d: T) => T;
-}
-
-export type LookupString = `Lookup${number}`;

package/src/types/index.ts

@@ -1,7 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export * from './codec.js';
-export * from './helpers.js';
-export * from './interfaces.js';
-export * from './registry.js';

package/src/types/interfaces.ts

@@ -1,98 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-// import type { SignOptions } from '@pezkuwi/keyring/types';
-import type { BN } from '@pezkuwi/util';
-import type { ArgsDef, Codec } from './codec.js';
-import type { AnyTuple } from './helpers.js';
-
-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;
-  toPrimitive (disableAscii?: boolean): string | number;
-}
-
-export interface IFloat extends Codec {
-  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[];
-}
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-export interface IText extends String, Codec {
-  // nothing additional
-}
-
-export 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, disableAscii?: 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, M = any> extends Codec {
-  readonly args: A;
-  readonly argsDef: ArgsDef;
-  readonly callIndex: Uint8Array;
-  readonly data: Uint8Array;
-  readonly meta: M;
-
-  is: (tx: IMethod<AnyTuple>) => tx is IMethod<A>;
-}

package/src/types/registry.ts

@@ -1,86 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { BN } from '@pezkuwi/util';
-import type { Codec, CodecClass } from './codec.js';
-import type { AnyTuple, LookupString } from './helpers.js';
-import type { ICompact, IEnum, IMap, IMethod, INumber, IOption, IResult, ISet, IStruct, ITuple, IU8a, IVec } from './interfaces.js';
-
-export 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 interface RegistryError {
-  args: string[];
-  docs: string[];
-  index: number;
-  // compat
-  method: string;
-  name: string;
-  section: string;
-}
-
-export 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 | undefined;
-  isFallback?: boolean;
-  isOptional?: boolean;
-  isPedantic?: boolean;
-}
-
-export interface CallBase<A extends AnyTuple, M = any> extends IMethod<A, M> {
-  readonly method: string;
-  readonly section: string;
-
-  toJSON: () => any;
-}
-
-export interface CallFunction<A extends AnyTuple = AnyTuple, M = any> extends CallBase<A, M> {
-  (...args: any[]): IMethod<A, M>;
-}
-
-export interface Registry {
-  readonly chainDecimals: number[];
-  readonly chainIsEthereum: boolean;
-  readonly chainSS58: number | undefined;
-  readonly chainTokens: string[];
-
-  createdAtHash?: IU8a;
-
-  findMetaCall (callIndex: Uint8Array): CallFunction;
-  findMetaError (errorIndex: Uint8Array | { error: BN, index: BN } | { error: BN | Uint8Array, index: BN }): RegistryError;
-  findMetaEvent (eventIndex: Uint8Array): CodecClass<any>;
-
-  isLookupType (value: string): value is LookupString;
-  createLookupType (lookupId: ICompact<INumber> | number): LookupString;
-  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;
-
-  // get is for Compat, overridden in derived classes
-  get (...params: never[]): any;
-
-  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>;
-  getTransactionExtensionVersion (): number;
-  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, noInitWarn?: boolean): void;
-}