@pezkuwi/types 16.5.5 → 16.5.8

package/build-tsc/generic/Block.d.ts

@@ -0,0 +1,42 @@
+import type { Vec } from '@pezkuwi/types-codec';
+import type { AnyNumber, AnyU8a, IU8a, Registry } from '@pezkuwi/types-codec/types';
+import type { GenericExtrinsic } from '../extrinsic/Extrinsic.js';
+import type { Digest, DigestItem, Header } from '../interfaces/runtime/index.js';
+import { Struct } from '@pezkuwi/types-codec';
+export interface HeaderValue {
+    digest?: Digest | {
+        logs: DigestItem[] | string[];
+    };
+    extrinsicsRoot?: AnyU8a;
+    number?: AnyNumber;
+    parentHash?: AnyU8a;
+    stateRoot?: AnyU8a;
+}
+export interface BlockValue {
+    extrinsics?: AnyU8a[];
+    header?: HeaderValue;
+}
+/**
+ * @name GenericBlock
+ * @description
+ * A block encoded with header and extrinsics
+ */
+export declare class GenericBlock extends Struct {
+    constructor(registry: Registry, value?: BlockValue | Uint8Array);
+    /**
+     * @description Encodes a content [[Hash]] for the block
+     */
+    get contentHash(): IU8a;
+    /**
+     * @description The [[Extrinsic]] contained in the block
+     */
+    get extrinsics(): Vec<GenericExtrinsic>;
+    /**
+     * @description Block/header [[Hash]]
+     */
+    get hash(): IU8a;
+    /**
+     * @description The [[Header]] of the block
+     */
+    get header(): Header;
+}

package/build-tsc/generic/Call.d.ts

@@ -0,0 +1,69 @@
+import type { AnyJson, AnyTuple, AnyU8a, ArgsDef, Codec, IMethod, Registry } from '@pezkuwi/types-codec/types';
+import type { FunctionMetadataLatest } from '../interfaces/metadata/index.js';
+import type { CallBase } from '../types/index.js';
+import { Struct, U8aFixed } from '@pezkuwi/types-codec';
+/**
+ * @name GenericCallIndex
+ * @description
+ * A wrapper around the `[sectionIndex, methodIndex]` value that uniquely identifies a method
+ */
+export declare class GenericCallIndex extends U8aFixed {
+    constructor(registry: Registry, value?: AnyU8a);
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): string;
+}
+/**
+ * @name GenericCall
+ * @description
+ * Extrinsic function descriptor
+ */
+export declare class GenericCall<A extends AnyTuple = AnyTuple> extends Struct implements CallBase<A> {
+    protected _meta: FunctionMetadataLatest;
+    constructor(registry: Registry, value: unknown, meta?: FunctionMetadataLatest);
+    /**
+     * @description The arguments for the function call
+     */
+    get args(): A;
+    /**
+     * @description The argument definitions
+     */
+    get argsDef(): ArgsDef;
+    /**
+     * @description The argument entries
+     */
+    get argsEntries(): [string, Codec][];
+    /**
+     * @description The encoded `[sectionIndex, methodIndex]` identifier
+     */
+    get callIndex(): Uint8Array;
+    /**
+     * @description The encoded data
+     */
+    get data(): Uint8Array;
+    /**
+     * @description The [[FunctionMetadata]]
+     */
+    get meta(): FunctionMetadataLatest;
+    /**
+     * @description Returns the name of the method
+     */
+    get method(): string;
+    /**
+     * @description Returns the module containing the method
+     */
+    get section(): string;
+    /**
+     * @description Checks if the source matches this in type
+     */
+    is(other: IMethod<AnyTuple>): other is IMethod<A>;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExpanded?: boolean, disableAscii?: boolean): Record<string, AnyJson>;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+}

package/build-tsc/generic/ChainProperties.d.ts

@@ -0,0 +1,22 @@
+import type { bool as Bool, Option, Text, u32, Vec } from '@pezkuwi/types-codec';
+import type { Registry } from '@pezkuwi/types-codec/types';
+import { Json } from '@pezkuwi/types-codec';
+export declare class GenericChainProperties extends Json {
+    constructor(registry: Registry, value?: Map<string, unknown> | Record<string, unknown> | null);
+    /**
+     * @description The chain uses Ethereum addresses
+     */
+    get isEthereum(): Bool;
+    /**
+     * @description The chain ss58Format
+     */
+    get ss58Format(): Option<u32>;
+    /**
+     * @description The decimals for each of the tokens
+     */
+    get tokenDecimals(): Option<Vec<u32>>;
+    /**
+     * @description The symbols for the tokens
+     */
+    get tokenSymbol(): Option<Vec<Text>>;
+}

package/build-tsc/generic/ConsensusEngineId.d.ts

@@ -0,0 +1,53 @@
+import type { Bytes } from '@pezkuwi/types-codec';
+import type { AnyU8a, Registry } from '@pezkuwi/types-codec/types';
+import type { AccountId } from '../interfaces/index.js';
+import { U8aFixed } from '@pezkuwi/types-codec';
+export declare const CID_AURA: Uint8Array;
+export declare const CID_BABE: Uint8Array;
+export declare const CID_GRPA: Uint8Array;
+export declare const CID_POW: Uint8Array;
+export declare const CID_NMBS: Uint8Array;
+/**
+ * @name GenericConsensusEngineId
+ * @description
+ * A 4-byte identifier identifying the engine
+ */
+export declare class GenericConsensusEngineId extends U8aFixed {
+    constructor(registry: Registry, value?: AnyU8a);
+    /**
+     * @description `true` if the engine matches aura
+     */
+    get isAura(): boolean;
+    /**
+     * @description `true` is the engine matches babe
+     */
+    get isBabe(): boolean;
+    /**
+     * @description `true` is the engine matches grandpa
+     */
+    get isGrandpa(): boolean;
+    /**
+     * @description `true` is the engine matches pow
+     */
+    get isPow(): boolean;
+    /**
+     * @description `true` is the engine matches nimbus
+     */
+    get isNimbus(): boolean;
+    /**
+     * @description From the input bytes, decode into an author
+     */
+    extractAuthor(bytes: Bytes, sessionValidators: AccountId[]): AccountId | undefined;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(): string;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Override the default toString to return a 4-byte string
+     */
+    toString(): string;
+}

package/build-tsc/generic/Event.d.ts

@@ -0,0 +1,76 @@
+import type { AnyJson, Codec } from '@pezkuwi/types-codec/types';
+import type { TypeDef } from '@pezkuwi/types-create/types';
+import type { EventMetadataLatest } from '../interfaces/metadata/index.js';
+import type { EventId } from '../interfaces/system/index.js';
+import type { IEvent, IEventData, Registry } from '../types/index.js';
+import { Struct, Tuple } from '@pezkuwi/types-codec';
+/**
+ * @name GenericEventData
+ * @description
+ * Wrapper for the actual data that forms part of an [[Event]]
+ */
+export declare class GenericEventData extends Tuple implements IEventData {
+    #private;
+    constructor(registry: Registry, value: Uint8Array, meta: EventMetadataLatest, section?: string, method?: string);
+    /**
+     * @description The wrapped [[EventMetadata]]
+     */
+    get meta(): EventMetadataLatest;
+    /**
+     * @description The method as a string
+     */
+    get method(): string;
+    /**
+     * @description The field names (as available)
+     */
+    get names(): string[] | null;
+    /**
+     * @description The section as a string
+     */
+    get section(): string;
+    /**
+     * @description The [[TypeDef]] for this event
+     */
+    get typeDef(): TypeDef[];
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExtended?: boolean, disableAscii?: boolean): AnyJson;
+}
+/**
+ * @name GenericEvent
+ * @description
+ * A representation of a system event. These are generated via the [[Metadata]] interfaces and
+ * specific to a specific Bizinikiwi runtime
+ */
+export declare class GenericEvent extends Struct implements IEvent<Codec[]> {
+    constructor(registry: Registry, _value?: Uint8Array);
+    /**
+     * @description The wrapped [[EventData]]
+     */
+    get data(): IEvent<Codec[]>['data'];
+    /**
+     * @description The [[EventId]], identifying the raw event
+     */
+    get index(): EventId;
+    /**
+     * @description The [[EventMetadata]] with the documentation
+     */
+    get meta(): EventMetadataLatest;
+    /**
+     * @description The method string identifying the event
+     */
+    get method(): string;
+    /**
+     * @description The section string identifying the event
+     */
+    get section(): string;
+    /**
+     * @description The [[TypeDef]] for the event
+     */
+    get typeDef(): TypeDef[];
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExpanded?: boolean, disableAscii?: boolean): Record<string, AnyJson>;
+}

package/build-tsc/generic/LookupSource.d.ts

@@ -0,0 +1,45 @@
+import type { Inspect, Registry } from '@pezkuwi/types-codec/types';
+import type { BN } from '@pezkuwi/util';
+import type { HexString } from '@pezkuwi/util/types';
+import { AbstractBase } from '@pezkuwi/types-codec';
+import { GenericAccountId } from './AccountId.js';
+import { GenericAccountIndex } from './AccountIndex.js';
+type AnyAddress = bigint | BN | GenericLookupSource | GenericAccountId | GenericAccountIndex | number[] | Uint8Array | number | string;
+export declare const ACCOUNT_ID_PREFIX: Uint8Array;
+/**
+ * @name LookupSource
+ * @description
+ * A wrapper around an AccountId and/or AccountIndex that is encoded with a prefix.
+ * Since we are dealing with underlying publicKeys (or shorter encoded addresses),
+ * we extend from Base with an AccountId/AccountIndex wrapper. Basically the Address
+ * is encoded as `[ <prefix-byte>, ...publicKey/...bytes ]` as per spec
+ */
+export declare class GenericLookupSource extends AbstractBase<GenericAccountId | GenericAccountIndex> {
+    constructor(registry: Registry, value?: AnyAddress);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description The length of the raw value, either AccountIndex or AccountId
+     */
+    protected get _rawLength(): number;
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(): Inspect;
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(): HexString;
+    /**
+     * @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;
+}
+export {};

package/build-tsc/generic/MultiAddress.d.ts

@@ -0,0 +1,13 @@
+import type { Inspect, Registry } from '@pezkuwi/types-codec/types';
+import { Enum } from '@pezkuwi/types-codec';
+export declare class GenericMultiAddress extends Enum {
+    constructor(registry: Registry, value?: unknown);
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(): Inspect;
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString(): string;
+}

package/build-tsc/generic/Vote.d.ts

@@ -0,0 +1,44 @@
+import type { AnyJson, Registry } from '@pezkuwi/types-codec/types';
+import type { AllConvictions } from '../interfaces/democracy/definitions.js';
+import type { Conviction } from '../interfaces/democracy/index.js';
+import type { ArrayElementType } from '../types/index.js';
+import { U8aFixed } from '@pezkuwi/types-codec';
+interface VoteType {
+    aye: boolean;
+    conviction?: number | ArrayElementType<typeof AllConvictions>;
+}
+type InputTypes = boolean | number | Boolean | Uint8Array | VoteType;
+/**
+ * @name GenericVote
+ * @description
+ * A number of lock periods, plus a vote, one way or the other.
+ */
+export declare class GenericVote extends U8aFixed {
+    #private;
+    constructor(registry: Registry, value?: InputTypes);
+    /**
+     * @description returns a V2 conviction
+     */
+    get conviction(): Conviction;
+    /**
+     * @description true if the wrapped value is a positive vote
+     */
+    get isAye(): boolean;
+    /**
+     * @description true if the wrapped value is a negative vote
+     */
+    get isNay(): boolean;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExpanded?: boolean): AnyJson;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): any;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+}
+export {};

package/build-tsc/generic/index.d.ts

@@ -0,0 +1,11 @@
+export { GenericAccountId, GenericAccountId as GenericAccountId32, GenericAccountId33 } from './AccountId.js';
+export { GenericAccountIndex } from './AccountIndex.js';
+export { GenericBlock } from './Block.js';
+export { GenericCall } from './Call.js';
+export { GenericChainProperties } from './ChainProperties.js';
+export { GenericConsensusEngineId } from './ConsensusEngineId.js';
+export { GenericEvent, GenericEventData } from './Event.js';
+export { GenericLookupSource } from './LookupSource.js';
+export { GenericMultiAddress as GenericAddress, GenericMultiAddress } from './MultiAddress.js';
+export { GenericVote } from './Vote.js';
+export * from '../ethereum/index.js';

package/build-tsc/index.d.ts

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

package/build-tsc/index.types.d.ts

@@ -0,0 +1,3 @@
+export * from './extrinsic/index.js';
+export * from './generic/index.js';
+export * from './primitive/index.js';

package/build-tsc/interfaces/alias.d.ts

@@ -0,0 +1,5 @@
+import type { OverrideModuleType, Registry } from '../types/index.js';
+/**
+ * @description Get types for specific modules (metadata override)
+ */
+export declare function getAliasTypes({ knownTypes }: Registry, section: string): OverrideModuleType;

package/build-tsc/interfaces/assetConversion/types.d.ts

@@ -0,0 +1,6 @@
+import type { Option } from '@pezkuwi/types-codec';
+import type { MultiLocation } from '@pezkuwi/types/interfaces/xcm';
+/** @name TAssetConversion */
+export interface TAssetConversion extends Option<MultiLocation> {
+}
+export type PHANTOM_ASSETCONVERSION = 'assetConversion';

package/build-tsc/interfaces/assets/types.d.ts

@@ -0,0 +1,54 @@
+import type { Bytes, Compact, Struct, bool, u32, u64, u8 } from '@pezkuwi/types-codec';
+import type { AccountId, BalanceOf } from '@pezkuwi/types/interfaces/runtime';
+/** @name AssetApproval */
+export interface AssetApproval extends Struct {
+    readonly amount: TAssetBalance;
+    readonly deposit: TAssetDepositBalance;
+}
+/** @name AssetApprovalKey */
+export interface AssetApprovalKey extends Struct {
+    readonly owner: AccountId;
+    readonly delegate: AccountId;
+}
+/** @name AssetBalance */
+export interface AssetBalance extends Struct {
+    readonly balance: TAssetBalance;
+    readonly isFrozen: bool;
+    readonly isSufficient: bool;
+}
+/** @name AssetDestroyWitness */
+export interface AssetDestroyWitness extends Struct {
+    readonly accounts: Compact<u32>;
+    readonly sufficients: Compact<u32>;
+    readonly approvals: Compact<u32>;
+}
+/** @name AssetDetails */
+export interface AssetDetails extends Struct {
+    readonly owner: AccountId;
+    readonly issuer: AccountId;
+    readonly admin: AccountId;
+    readonly freezer: AccountId;
+    readonly supply: TAssetBalance;
+    readonly deposit: TAssetDepositBalance;
+    readonly minBalance: TAssetBalance;
+    readonly isSufficient: bool;
+    readonly accounts: u32;
+    readonly sufficients: u32;
+    readonly approvals: u32;
+    readonly isFrozen: bool;
+}
+/** @name AssetMetadata */
+export interface AssetMetadata extends Struct {
+    readonly deposit: TAssetDepositBalance;
+    readonly name: Bytes;
+    readonly symbol: Bytes;
+    readonly decimals: u8;
+    readonly isFrozen: bool;
+}
+/** @name TAssetBalance */
+export interface TAssetBalance extends u64 {
+}
+/** @name TAssetDepositBalance */
+export interface TAssetDepositBalance extends BalanceOf {
+}
+export type PHANTOM_ASSETS = 'assets';

package/build-tsc/interfaces/attestations/definitions.d.ts

@@ -0,0 +1,3 @@
+import type { Definitions } from '../../types/index.js';
+declare const _default: Definitions;
+export default _default;

package/build-tsc/interfaces/attestations/index.d.ts

@@ -0,0 +1 @@
+export * from './types.js';

package/build-tsc/interfaces/attestations/types.d.ts

@@ -0,0 +1,22 @@
+import type { Struct, Vec } from '@pezkuwi/types-codec';
+import type { AccountId, BlockNumber, H256, Hash } from '@pezkuwi/types/interfaces/runtime';
+import type { SessionIndex } from '@pezkuwi/types/interfaces/session';
+import type { CandidateReceipt, ParaId } from '@pezkuwi/types/interfaces/teyrchains';
+/** @name BlockAttestations */
+export interface BlockAttestations extends Struct {
+    readonly receipt: CandidateReceipt;
+    readonly valid: Vec<AccountId>;
+    readonly invalid: Vec<AccountId>;
+}
+/** @name IncludedBlocks */
+export interface IncludedBlocks extends Struct {
+    readonly actualNumber: BlockNumber;
+    readonly session: SessionIndex;
+    readonly randomSeed: H256;
+    readonly activeTeyrchains: Vec<ParaId>;
+    readonly paraBlocks: Vec<Hash>;
+}
+/** @name MoreAttestations */
+export interface MoreAttestations extends Struct {
+}
+export type PHANTOM_ATTESTATIONS = 'attestations';

package/build-tsc/interfaces/aura/definitions.d.ts

@@ -0,0 +1,3 @@
+import type { Definitions } from '../../types/index.js';
+declare const _default: Definitions;
+export default _default;

package/build-tsc/interfaces/aura/index.d.ts

@@ -0,0 +1 @@
+export * from './types.js';

package/build-tsc/interfaces/aura/runtime.d.ts

@@ -0,0 +1,2 @@
+import type { DefinitionsCall } from '../../types/index.js';
+export declare const runtime: DefinitionsCall;

package/build-tsc/interfaces/aura/types.d.ts

@@ -0,0 +1,6 @@
+import type { Struct, u64 } from '@pezkuwi/types-codec';
+/** @name RawAuraPreDigest */
+export interface RawAuraPreDigest extends Struct {
+    readonly slotNumber: u64;
+}
+export type PHANTOM_AURA = 'aura';

package/build-tsc/interfaces/author/definitions.d.ts

@@ -0,0 +1,3 @@
+import type { Definitions } from '../../types/index.js';
+declare const _default: Definitions;
+export default _default;

package/build-tsc/interfaces/author/index.d.ts

@@ -0,0 +1 @@
+export * from './types.js';

package/build-tsc/interfaces/author/rpc.d.ts

@@ -0,0 +1,2 @@
+import type { DefinitionsRpc } from '../../types/index.js';
+export declare const rpc: DefinitionsRpc;

package/build-tsc/interfaces/author/types.d.ts

@@ -0,0 +1,31 @@
+import type { Bytes, Enum, Text, Vec } from '@pezkuwi/types-codec';
+import type { Hash } from '@pezkuwi/types/interfaces/runtime';
+/** @name ExtrinsicOrHash */
+export interface ExtrinsicOrHash extends Enum {
+    readonly isHash: boolean;
+    readonly asHash: Hash;
+    readonly isExtrinsic: boolean;
+    readonly asExtrinsic: Bytes;
+    readonly type: 'Hash' | 'Extrinsic';
+}
+/** @name ExtrinsicStatus */
+export interface ExtrinsicStatus extends Enum {
+    readonly isFuture: boolean;
+    readonly isReady: boolean;
+    readonly isBroadcast: boolean;
+    readonly asBroadcast: Vec<Text>;
+    readonly isInBlock: boolean;
+    readonly asInBlock: Hash;
+    readonly isRetracted: boolean;
+    readonly asRetracted: Hash;
+    readonly isFinalityTimeout: boolean;
+    readonly asFinalityTimeout: Hash;
+    readonly isFinalized: boolean;
+    readonly asFinalized: Hash;
+    readonly isUsurped: boolean;
+    readonly asUsurped: Hash;
+    readonly isDropped: boolean;
+    readonly isInvalid: boolean;
+    readonly type: 'Future' | 'Ready' | 'Broadcast' | 'InBlock' | 'Retracted' | 'FinalityTimeout' | 'Finalized' | 'Usurped' | 'Dropped' | 'Invalid';
+}
+export type PHANTOM_AUTHOR = 'author';

package/build-tsc/interfaces/authorship/definitions.d.ts

@@ -0,0 +1,3 @@
+import type { Definitions } from '../../types/index.js';
+declare const _default: Definitions;
+export default _default;

package/build-tsc/interfaces/authorship/index.d.ts

@@ -0,0 +1 @@
+export * from './types.js';

package/build-tsc/interfaces/authorship/types.d.ts

@@ -0,0 +1,12 @@
+import type { Enum, Option } from '@pezkuwi/types-codec';
+import type { ITuple } from '@pezkuwi/types-codec/types';
+import type { AccountId, BlockNumber, Hash } from '@pezkuwi/types/interfaces/runtime';
+/** @name UncleEntryItem */
+export interface UncleEntryItem extends Enum {
+    readonly isInclusionHeight: boolean;
+    readonly asInclusionHeight: BlockNumber;
+    readonly isUncle: boolean;
+    readonly asUncle: ITuple<[Hash, Option<AccountId>]>;
+    readonly type: 'InclusionHeight' | 'Uncle';
+}
+export type PHANTOM_AUTHORSHIP = 'authorship';

package/build-tsc/interfaces/babe/definitions.d.ts

@@ -0,0 +1,3 @@
+import type { Definitions } from '../../types/index.js';
+declare const _default: Definitions;
+export default _default;

package/build-tsc/interfaces/babe/index.d.ts

@@ -0,0 +1 @@
+export * from './types.js';

package/build-tsc/interfaces/babe/rpc.d.ts

@@ -0,0 +1,2 @@
+import type { DefinitionsRpc } from '../../types/index.js';
+export declare const rpc: DefinitionsRpc;

package/build-tsc/interfaces/babe/runtime.d.ts

@@ -0,0 +1,2 @@
+import type { DefinitionsCall } from '../../types/index.js';
+export declare const runtime: DefinitionsCall;