@polkadot/types
Version:
Implementation of the Parity codec
424 lines (423 loc) • 14.8 kB
TypeScript
import type { GenericChainProperties, GenericEvent } from '@polkadot/types';
import type { Bytes, Compact, Enum, HashMap, Option, Result, Struct, Text, U8aFixed, Vec, bool, i32, u32, u64, u8 } from '@polkadot/types-codec';
import type { ITuple } from '@polkadot/types-codec/types';
import type { AccountData } from '@polkadot/types/interfaces/balances';
import type { AccountId, BlockNumber, Digest, Hash, Index, Pays, Weight } from '@polkadot/types/interfaces/runtime';
/** @name AccountInfo */
export interface AccountInfo extends AccountInfoWithTripleRefCount {
}
/** @name AccountInfoWithDualRefCount */
export interface AccountInfoWithDualRefCount extends Struct {
readonly nonce: Index;
readonly consumers: RefCount;
readonly providers: RefCount;
readonly data: AccountData;
}
/** @name AccountInfoWithProviders */
export interface AccountInfoWithProviders extends AccountInfoWithDualRefCount {
}
/** @name AccountInfoWithRefCount */
export interface AccountInfoWithRefCount extends Struct {
readonly nonce: Index;
readonly refcount: RefCount;
readonly data: AccountData;
}
/** @name AccountInfoWithRefCountU8 */
export interface AccountInfoWithRefCountU8 extends Struct {
readonly nonce: Index;
readonly refcount: u8;
readonly data: AccountData;
}
/** @name AccountInfoWithTripleRefCount */
export interface AccountInfoWithTripleRefCount extends Struct {
readonly nonce: Index;
readonly consumers: RefCount;
readonly providers: RefCount;
readonly sufficients: RefCount;
readonly data: AccountData;
}
/** @name ApplyExtrinsicResult */
export interface ApplyExtrinsicResult extends Result<DispatchOutcome, TransactionValidityError> {
readonly isErr: boolean;
readonly asErr: TransactionValidityError;
readonly isOk: boolean;
readonly asOk: DispatchOutcome;
}
/** @name ApplyExtrinsicResultPre6 */
export interface ApplyExtrinsicResultPre6 extends Result<DispatchOutcomePre6, TransactionValidityError> {
readonly isErr: boolean;
readonly asErr: TransactionValidityError;
readonly isOk: boolean;
readonly asOk: DispatchOutcomePre6;
}
/** @name ArithmeticError */
export interface ArithmeticError extends Enum {
readonly isUnderflow: boolean;
readonly isOverflow: boolean;
readonly isDivisionByZero: boolean;
readonly type: 'Underflow' | 'Overflow' | 'DivisionByZero';
}
/** @name BlockLength */
export interface BlockLength extends Struct {
readonly max: PerDispatchClassU32;
}
/** @name BlockWeights */
export interface BlockWeights extends Struct {
readonly baseBlock: Weight;
readonly maxBlock: Weight;
readonly perClass: PerDispatchClassWeightsPerClass;
}
/** @name ChainProperties */
export interface ChainProperties extends GenericChainProperties {
}
/** @name ChainType */
export interface ChainType extends Enum {
readonly isDevelopment: boolean;
readonly isLocal: boolean;
readonly isLive: boolean;
readonly isCustom: boolean;
readonly asCustom: Text;
readonly type: 'Development' | 'Local' | 'Live' | 'Custom';
}
/** @name ConsumedWeight */
export interface ConsumedWeight extends PerDispatchClassWeight {
}
/** @name DigestOf */
export interface DigestOf extends Digest {
}
/** @name DispatchClass */
export interface DispatchClass extends Enum {
readonly isNormal: boolean;
readonly isOperational: boolean;
readonly isMandatory: boolean;
readonly type: 'Normal' | 'Operational' | 'Mandatory';
}
/** @name DispatchError */
export interface DispatchError extends Enum {
readonly isOther: boolean;
readonly isCannotLookup: boolean;
readonly isBadOrigin: boolean;
readonly isModule: boolean;
readonly asModule: DispatchErrorModule;
readonly isConsumerRemaining: boolean;
readonly isNoProviders: boolean;
readonly isTooManyConsumers: boolean;
readonly isToken: boolean;
readonly asToken: TokenError;
readonly isArithmetic: boolean;
readonly asArithmetic: ArithmeticError;
readonly isTransactional: boolean;
readonly asTransactional: TransactionalError;
readonly isExhausted: boolean;
readonly isCorruption: boolean;
readonly isUnavailable: boolean;
readonly type: 'Other' | 'CannotLookup' | 'BadOrigin' | 'Module' | 'ConsumerRemaining' | 'NoProviders' | 'TooManyConsumers' | 'Token' | 'Arithmetic' | 'Transactional' | 'Exhausted' | 'Corruption' | 'Unavailable';
}
/** @name DispatchErrorModule */
export interface DispatchErrorModule extends DispatchErrorModuleU8a {
}
/** @name DispatchErrorModulePre6 */
export interface DispatchErrorModulePre6 extends DispatchErrorModuleU8 {
}
/** @name DispatchErrorModuleU8 */
export interface DispatchErrorModuleU8 extends Struct {
readonly index: u8;
readonly error: u8;
}
/** @name DispatchErrorModuleU8a */
export interface DispatchErrorModuleU8a extends Struct {
readonly index: u8;
readonly error: U8aFixed;
}
/** @name DispatchErrorPre6 */
export interface DispatchErrorPre6 extends Enum {
readonly isOther: boolean;
readonly isCannotLookup: boolean;
readonly isBadOrigin: boolean;
readonly isModule: boolean;
readonly asModule: DispatchErrorModulePre6;
readonly isConsumerRemaining: boolean;
readonly isNoProviders: boolean;
readonly isTooManyConsumers: boolean;
readonly isToken: boolean;
readonly asToken: TokenError;
readonly isArithmetic: boolean;
readonly asArithmetic: ArithmeticError;
readonly isTransactional: boolean;
readonly asTransactional: TransactionalError;
readonly type: 'Other' | 'CannotLookup' | 'BadOrigin' | 'Module' | 'ConsumerRemaining' | 'NoProviders' | 'TooManyConsumers' | 'Token' | 'Arithmetic' | 'Transactional';
}
/** @name DispatchErrorPre6First */
export interface DispatchErrorPre6First extends Enum {
readonly isOther: boolean;
readonly isCannotLookup: boolean;
readonly isBadOrigin: boolean;
readonly isModule: boolean;
readonly asModule: DispatchErrorModulePre6;
readonly isConsumerRemaining: boolean;
readonly isNoProviders: boolean;
readonly isToken: boolean;
readonly asToken: TokenError;
readonly isArithmetic: boolean;
readonly asArithmetic: ArithmeticError;
readonly isTransactional: boolean;
readonly asTransactional: TransactionalError;
readonly type: 'Other' | 'CannotLookup' | 'BadOrigin' | 'Module' | 'ConsumerRemaining' | 'NoProviders' | 'Token' | 'Arithmetic' | 'Transactional';
}
/** @name DispatchErrorTo198 */
export interface DispatchErrorTo198 extends Struct {
readonly module: Option<u8>;
readonly error: u8;
}
/** @name DispatchInfo */
export interface DispatchInfo extends Struct {
readonly weight: Weight;
readonly class: DispatchClass;
readonly paysFee: Pays;
}
/** @name DispatchInfoTo190 */
export interface DispatchInfoTo190 extends Struct {
readonly weight: Weight;
readonly class: DispatchClass;
}
/** @name DispatchInfoTo244 */
export interface DispatchInfoTo244 extends Struct {
readonly weight: Weight;
readonly class: DispatchClass;
readonly paysFee: bool;
}
/** @name DispatchOutcome */
export interface DispatchOutcome extends Result<ITuple<[]>, DispatchError> {
readonly isErr: boolean;
readonly asErr: DispatchError;
readonly isOk: boolean;
readonly asOk: ITuple<[]>;
}
/** @name DispatchOutcomePre6 */
export interface DispatchOutcomePre6 extends Result<ITuple<[]>, DispatchErrorPre6> {
readonly isErr: boolean;
readonly asErr: DispatchErrorPre6;
readonly isOk: boolean;
readonly asOk: ITuple<[]>;
}
/** @name DispatchResult */
export interface DispatchResult extends Result<ITuple<[]>, DispatchError> {
readonly isErr: boolean;
readonly asErr: DispatchError;
readonly isOk: boolean;
readonly asOk: ITuple<[]>;
}
/** @name DispatchResultOf */
export interface DispatchResultOf extends DispatchResult {
}
/** @name DispatchResultTo198 */
export interface DispatchResultTo198 extends Result<ITuple<[]>, Text> {
readonly isErr: boolean;
readonly asErr: Text;
readonly isOk: boolean;
readonly asOk: ITuple<[]>;
}
/** @name Event */
export interface Event extends GenericEvent {
}
/** @name EventId */
export interface EventId extends U8aFixed {
}
/** @name EventIndex */
export interface EventIndex extends u32 {
}
/** @name EventRecord */
export interface EventRecord extends Struct {
readonly phase: Phase;
readonly event: Event;
readonly topics: Vec<Hash>;
}
/** @name Health */
export interface Health extends Struct {
readonly peers: u64;
readonly isSyncing: bool;
readonly shouldHavePeers: bool;
}
/** @name InvalidTransaction */
export interface InvalidTransaction extends Enum {
readonly isCall: boolean;
readonly isPayment: boolean;
readonly isFuture: boolean;
readonly isStale: boolean;
readonly isBadProof: boolean;
readonly isAncientBirthBlock: boolean;
readonly isExhaustsResources: boolean;
readonly isCustom: boolean;
readonly asCustom: u8;
readonly isBadMandatory: boolean;
readonly isMandatoryDispatch: boolean;
readonly isBadSigner: boolean;
readonly type: 'Call' | 'Payment' | 'Future' | 'Stale' | 'BadProof' | 'AncientBirthBlock' | 'ExhaustsResources' | 'Custom' | 'BadMandatory' | 'MandatoryDispatch' | 'BadSigner';
}
/** @name Key */
export interface Key extends Bytes {
}
/** @name LastRuntimeUpgradeInfo */
export interface LastRuntimeUpgradeInfo extends Struct {
readonly specVersion: Compact<u32>;
readonly specName: Text;
}
/** @name NetworkState */
export interface NetworkState extends Struct {
readonly peerId: Text;
readonly listenedAddresses: Vec<Text>;
readonly externalAddresses: Vec<Text>;
readonly connectedPeers: HashMap<Text, Peer>;
readonly notConnectedPeers: HashMap<Text, NotConnectedPeer>;
readonly averageDownloadPerSec: u64;
readonly averageUploadPerSec: u64;
readonly peerset: NetworkStatePeerset;
}
/** @name NetworkStatePeerset */
export interface NetworkStatePeerset extends Struct {
readonly messageQueue: u64;
readonly nodes: HashMap<Text, NetworkStatePeersetInfo>;
}
/** @name NetworkStatePeersetInfo */
export interface NetworkStatePeersetInfo extends Struct {
readonly connected: bool;
readonly reputation: i32;
}
/** @name NodeRole */
export interface NodeRole extends Enum {
readonly isFull: boolean;
readonly isLightClient: boolean;
readonly isAuthority: boolean;
readonly isUnknownRole: boolean;
readonly asUnknownRole: u8;
readonly type: 'Full' | 'LightClient' | 'Authority' | 'UnknownRole';
}
/** @name NotConnectedPeer */
export interface NotConnectedPeer extends Struct {
readonly knownAddresses: Vec<Text>;
readonly latestPingTime: Option<PeerPing>;
readonly versionString: Option<Text>;
}
/** @name Peer */
export interface Peer extends Struct {
readonly enabled: bool;
readonly endpoint: PeerEndpoint;
readonly knownAddresses: Vec<Text>;
readonly latestPingTime: PeerPing;
readonly open: bool;
readonly versionString: Text;
}
/** @name PeerEndpoint */
export interface PeerEndpoint extends Struct {
readonly listening: PeerEndpointAddr;
}
/** @name PeerEndpointAddr */
export interface PeerEndpointAddr extends Struct {
readonly localAddr: Text;
readonly sendBackAddr: Text;
}
/** @name PeerInfo */
export interface PeerInfo extends Struct {
readonly peerId: Text;
readonly roles: Text;
readonly protocolVersion: u32;
readonly bestHash: Hash;
readonly bestNumber: BlockNumber;
}
/** @name PeerPing */
export interface PeerPing extends Struct {
readonly nanos: u64;
readonly secs: u64;
}
/** @name PerDispatchClassU32 */
export interface PerDispatchClassU32 extends Struct {
readonly normal: u32;
readonly operational: u32;
readonly mandatory: u32;
}
/** @name PerDispatchClassWeight */
export interface PerDispatchClassWeight extends Struct {
readonly normal: Weight;
readonly operational: Weight;
readonly mandatory: Weight;
}
/** @name PerDispatchClassWeightsPerClass */
export interface PerDispatchClassWeightsPerClass extends Struct {
readonly normal: WeightPerClass;
readonly operational: WeightPerClass;
readonly mandatory: WeightPerClass;
}
/** @name Phase */
export interface Phase extends Enum {
readonly isApplyExtrinsic: boolean;
readonly asApplyExtrinsic: u32;
readonly isFinalization: boolean;
readonly isInitialization: boolean;
readonly type: 'ApplyExtrinsic' | 'Finalization' | 'Initialization';
}
/** @name RawOrigin */
export interface RawOrigin extends Enum {
readonly isRoot: boolean;
readonly isSigned: boolean;
readonly asSigned: AccountId;
readonly isNone: boolean;
readonly type: 'Root' | 'Signed' | 'None';
}
/** @name RefCount */
export interface RefCount extends u32 {
}
/** @name RefCountTo259 */
export interface RefCountTo259 extends u8 {
}
/** @name SyncState */
export interface SyncState extends Struct {
readonly startingBlock: BlockNumber;
readonly currentBlock: BlockNumber;
readonly highestBlock: Option<BlockNumber>;
}
/** @name SystemOrigin */
export interface SystemOrigin extends RawOrigin {
}
/** @name TokenError */
export interface TokenError extends Enum {
readonly isNoFunds: boolean;
readonly isWouldDie: boolean;
readonly isBelowMinimum: boolean;
readonly isCannotCreate: boolean;
readonly isUnknownAsset: boolean;
readonly isFrozen: boolean;
readonly isUnsupported: boolean;
readonly isUnderflow: boolean;
readonly isOverflow: boolean;
readonly type: 'NoFunds' | 'WouldDie' | 'BelowMinimum' | 'CannotCreate' | 'UnknownAsset' | 'Frozen' | 'Unsupported' | 'Underflow' | 'Overflow';
}
/** @name TransactionalError */
export interface TransactionalError extends Enum {
readonly isLimitReached: boolean;
readonly isNoLayer: boolean;
readonly type: 'LimitReached' | 'NoLayer';
}
/** @name TransactionValidityError */
export interface TransactionValidityError extends Enum {
readonly isInvalid: boolean;
readonly asInvalid: InvalidTransaction;
readonly isUnknown: boolean;
readonly asUnknown: UnknownTransaction;
readonly type: 'Invalid' | 'Unknown';
}
/** @name UnknownTransaction */
export interface UnknownTransaction extends Enum {
readonly isCannotLookup: boolean;
readonly isNoUnsignedValidator: boolean;
readonly isCustom: boolean;
readonly asCustom: u8;
readonly type: 'CannotLookup' | 'NoUnsignedValidator' | 'Custom';
}
/** @name WeightPerClass */
export interface WeightPerClass extends Struct {
readonly baseExtrinsic: Weight;
readonly maxExtrinsic: Option<Weight>;
readonly maxTotal: Option<Weight>;
readonly reserved: Option<Weight>;
}
export type PHANTOM_SYSTEM = 'system';