@polkadot/types-codec 9.11.3 → 9.13.1

package/types/codec.d.ts

@@ -1,5 +1,5 @@
 import type { HexString } from '@polkadot/util/types';
-import type { AnyJson } from './helpers';
+import type { AnyJson, ToString } from './helpers';
 import type { IU8a } from './interfaces';
 import type { Registry } from './registry';
 export type BareOpts = boolean | Record<string, boolean>;
@@ -11,11 +11,35 @@ export interface Inspect {
 /**
  * @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
+ * 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;
+    /**
+     * @description
+     * The length of the initial encoded value (Only available when the value was
+     * constructed from a Uint8Array input)
+     */
+    initialU8aLength?: number;
+    /**
+     * @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 Substrate runtime)
+     */
+    isStorageFallback?: boolean;
     /**
      * @description The length of the value when encoded as a Uint8Array
      */
@@ -24,10 +48,6 @@ export interface Codec {
      * @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
      */
@@ -36,10 +56,6 @@ export interface Codec {
      * @description The registry associated with this object
      */
     readonly registry: Registry;
-    /**
-     * @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
      */
@@ -85,5 +101,9 @@ export interface CodecClass<T = Codec> {
     readonly __fallbackType?: string;
     new (registry: Registry, ...args: any[]): 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/types/helpers.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="bn.js" />
 import type { BN } from '@polkadot/util';
+import type { HexString } from '@polkadot/util/types';
 import type { Codec } from './codec';
 export type AnyJson = string | number | boolean | null | undefined | AnyJson[] | {
     [index: string]: AnyJson;
@@ -13,4 +14,11 @@ export type AnyTuple = Codec[];
 export type AnyU8a = Uint8Array | number[] | string;
 export type UIntBitLength = 8 | 16 | 32 | 64 | 128 | 256;
 export type U8aBitLength = 8 | 16 | 32 | 64 | 128 | 160 | 256 | 264 | 512 | 520 | 1024 | 2048;
-export type AnyTupleValue = AnyU8a | (Codec | AnyU8a | AnyNumber | AnyString | undefined | null)[];
+export type AnyTupleValue = Exclude<AnyU8a, string> | HexString | (Codec | AnyU8a | AnyNumber | AnyString | undefined | null)[];
+export interface ToString {
+    toString: () => string;
+}
+export interface ToBn {
+    toBn: () => BN;
+}
+export type LookupString = `Lookup${number}`;

package/types/registry.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="bn.js" />
 import type { BN } from '@polkadot/util';
 import type { Codec, CodecClass } from './codec';
-import type { AnyTuple } from './helpers';
+import type { AnyTuple, LookupString } from './helpers';
 import type { ICompact, IEnum, IMap, IMethod, INumber, IOption, IResult, ISet, IStruct, ITuple, IU8a, IVec } from './interfaces';
 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 {
@@ -19,6 +19,7 @@ export type RegistryTypes = Record<string, CodecClass | string | Record<string,
 }>;
 export interface CodecCreateOptions {
     blockHash?: Uint8Array | string | null;
+    isFallback?: boolean;
     isOptional?: boolean;
     isPedantic?: boolean;
 }
@@ -44,8 +45,8 @@ export interface Registry {
         index: BN;
     }): RegistryError;
     findMetaEvent(eventIndex: Uint8Array): CodecClass<any>;
-    isLookupType(value: string): boolean;
-    createLookupType(lookupId: ICompact<INumber> | number): string;
+    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;
     getClassName(clazz: CodecClass): string | undefined;

package/abstract/BigInt.d.ts

@@ -1,4 +0,0 @@
-import { BigInt } from '@polkadot/x-bigint';
-export declare abstract class AbstractBigInt extends BigInt {
-    constructor(value: string | number | bigint | boolean);
-}

package/abstract/BigInt.js

@@ -1,14 +0,0 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { BigInt } from '@polkadot/x-bigint';
-
-// @ts-expect-error not extensible, we make it extensible here
-export class AbstractBigInt extends BigInt {
-  // @ts-expect-error super() not required, the self magic does that
-  constructor(value) {
-    const self = Object(BigInt(value));
-    Object.setPrototypeOf(self, AbstractBigInt.prototype);
-    return self;
-  }
-}

package/cjs/abstract/BigInt.js

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.AbstractBigInt = void 0;
-var _xBigint = require("@polkadot/x-bigint");
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-// @ts-expect-error not extensible, we make it extensible here
-class AbstractBigInt extends _xBigint.BigInt {
-  // @ts-expect-error super() not required, the self magic does that
-  constructor(value) {
-    const self = Object((0, _xBigint.BigInt)(value));
-    Object.setPrototypeOf(self, AbstractBigInt.prototype);
-    return self;
-  }
-}
-exports.AbstractBigInt = AbstractBigInt;