diff --git a/packages/types/src/index.spec.ts b/packages/types/src/index.spec.ts index b7027fff00..379512eb47 100644 --- a/packages/types/src/index.spec.ts +++ b/packages/types/src/index.spec.ts @@ -17,6 +17,7 @@ import * as definitions from './interfaces/definitions'; // `usize` is not allowed (runtime incompat) and `origin` is not passed through // to any calls. All other types _must_ pass and allow for empty defaults const UNCONSTRUCTABLE = [ + 'ExtrinsicPayloadUnknown', 'GenericExtrinsicPayloadUnknown', 'ExtrinsicUnknown', 'GenericExtrinsicUnknown', 'GenericOrigin', 'Origin', 'usize' diff --git a/packages/types/src/interfaceRegistry.ts b/packages/types/src/interfaceRegistry.ts index 6ffbe6f4d5..da277428c5 100644 --- a/packages/types/src/interfaceRegistry.ts +++ b/packages/types/src/interfaceRegistry.ts @@ -3,7 +3,7 @@ import { Compact, Option, Vec } from './codec'; import { Bytes, Data, Fixed64, H160, H256, H512, Null, StorageData, StorageHasher, StorageKey, Text, Type, bool, i128, i16, i256, i32, i64, i8, u128, u16, u256, u32, u64, u8, usize } from './primitive'; -import { AccountId, AccountIdOf, AccountIndex, Address, AssetId, Balance, BalanceOf, Block, BlockNumber, Call, Consensus, ConsensusEngineId, Digest, DigestItem, Ed25519Signature, Extrinsic, ExtrinsicEra, ExtrinsicPayload, ExtrinsicUnknown, ExtrinsicV1, ExtrinsicV2, ExtrinsicV3, Hash, Header, ImmortalEra, Index, Justification, KeyTypeId, KeyValue, LockIdentifier, Moment, MortalEra, Origin, Perbill, Permill, Phantom, PhantomData, PreRuntime, Seal, SealV0, Signature, SignedBlock, Sr25519Signature, ValidatorId, Weight, WeightMultiplier } from './interfaces/runtime'; +import { AccountId, AccountIdOf, AccountIndex, Address, AssetId, Balance, BalanceOf, Block, BlockNumber, Call, Consensus, ConsensusEngineId, Digest, DigestItem, Ed25519Signature, Extrinsic, ExtrinsicEra, ExtrinsicPayload, ExtrinsicPayloadUnknown, ExtrinsicPayloadV1, ExtrinsicPayloadV2, ExtrinsicPayloadV3, ExtrinsicUnknown, ExtrinsicV1, ExtrinsicV2, ExtrinsicV3, Hash, Header, ImmortalEra, Index, Justification, KeyTypeId, KeyValue, LockIdentifier, Moment, MortalEra, Origin, Perbill, Permill, Phantom, PhantomData, PreRuntime, Seal, SealV0, Signature, SignedBlock, Sr25519Signature, ValidatorId, Weight, WeightMultiplier } from './interfaces/runtime'; import { InclusionHeight, Uncle, UncleEntryItem } from './interfaces/authorship'; import { RawAuraPreDigest } from './interfaces/aura'; import { BabeAuthorityWeight, BabeBlockWeight, BabeWeight, RawBabePreDigest, RawBabePreDigestPrimary, RawBabePreDigestSecondary, SlotNumber } from './interfaces/babe'; @@ -167,6 +167,18 @@ export interface InterfaceRegistry { ExtrinsicPayload: ExtrinsicPayload; 'Option': Option; 'Vec': Vec; + ExtrinsicPayloadUnknown: ExtrinsicPayloadUnknown; + 'Option': Option; + 'Vec': Vec; + ExtrinsicPayloadV1: ExtrinsicPayloadV1; + 'Option': Option; + 'Vec': Vec; + ExtrinsicPayloadV2: ExtrinsicPayloadV2; + 'Option': Option; + 'Vec': Vec; + ExtrinsicPayloadV3: ExtrinsicPayloadV3; + 'Option': Option; + 'Vec': Vec; ExtrinsicUnknown: ExtrinsicUnknown; 'Option': Option; 'Vec': Vec; diff --git a/packages/types/src/interfaces/runtime/definitions.ts b/packages/types/src/interfaces/runtime/definitions.ts index 21500572b6..deef9e72b5 100644 --- a/packages/types/src/interfaces/runtime/definitions.ts +++ b/packages/types/src/interfaces/runtime/definitions.ts @@ -20,6 +20,10 @@ export default { Extrinsic: 'GenericExtrinsic', ExtrinsicEra: 'GenericExtrinsicEra', ExtrinsicPayload: 'GenericExtrinsicPayload', + ExtrinsicPayloadUnknown: 'GenericExtrinsicPayloadUnknown', + ExtrinsicPayloadV1: 'GenericExtrinsicPayloadV1', + ExtrinsicPayloadV2: 'GenericExtrinsicPayloadV2', + ExtrinsicPayloadV3: 'GenericExtrinsicPayloadV3', ExtrinsicUnknown: 'GenericExtrinsicUnknown', ExtrinsicV1: 'GenericExtrinsicV1', ExtrinsicV2: 'GenericExtrinsicV2', diff --git a/packages/types/src/interfaces/runtime/types.ts b/packages/types/src/interfaces/runtime/types.ts index 7a52f52be6..72027e5e6d 100644 --- a/packages/types/src/interfaces/runtime/types.ts +++ b/packages/types/src/interfaces/runtime/types.ts @@ -3,7 +3,7 @@ import { Codec } from '../../types'; import { Compact, Struct } from '../../codec'; -import { Bytes, Fixed64, GenericAccountId, GenericAccountIndex, GenericAddress, GenericBlock, GenericCall, GenericConsensusEngineId, GenericDigest, GenericDigestItem, GenericExtrinsic, GenericExtrinsicEra, GenericExtrinsicPayload, GenericExtrinsicUnknown, GenericExtrinsicV1, GenericExtrinsicV2, GenericExtrinsicV3, GenericImmortalEra, GenericMortalEra, GenericOrigin, H256, H512, Null, StorageData, StorageKey, u128, u32, u64 } from '../../primitive'; +import { Bytes, Fixed64, GenericAccountId, GenericAccountIndex, GenericAddress, GenericBlock, GenericCall, GenericConsensusEngineId, GenericDigest, GenericDigestItem, GenericExtrinsic, GenericExtrinsicEra, GenericExtrinsicPayload, GenericExtrinsicPayloadUnknown, GenericExtrinsicPayloadV1, GenericExtrinsicPayloadV2, GenericExtrinsicPayloadV3, GenericExtrinsicUnknown, GenericExtrinsicV1, GenericExtrinsicV2, GenericExtrinsicV3, GenericImmortalEra, GenericMortalEra, GenericOrigin, H256, H512, Null, StorageData, StorageKey, u128, u32, u64 } from '../../primitive'; /** GenericAccountId */ export type AccountId = GenericAccountId; @@ -59,6 +59,18 @@ export type ExtrinsicEra = GenericExtrinsicEra; /** GenericExtrinsicPayload */ export type ExtrinsicPayload = GenericExtrinsicPayload; +/** GenericExtrinsicPayloadUnknown */ +export type ExtrinsicPayloadUnknown = GenericExtrinsicPayloadUnknown; + +/** GenericExtrinsicPayloadV1 */ +export type ExtrinsicPayloadV1 = GenericExtrinsicPayloadV1; + +/** GenericExtrinsicPayloadV2 */ +export type ExtrinsicPayloadV2 = GenericExtrinsicPayloadV2; + +/** GenericExtrinsicPayloadV3 */ +export type ExtrinsicPayloadV3 = GenericExtrinsicPayloadV3; + /** GenericExtrinsicUnknown */ export type ExtrinsicUnknown = GenericExtrinsicUnknown; diff --git a/packages/types/src/primitive/Extrinsic/Extrinsic.ts b/packages/types/src/primitive/Extrinsic/Extrinsic.ts index 3e0d3d4e27..9212c018a5 100644 --- a/packages/types/src/primitive/Extrinsic/Extrinsic.ts +++ b/packages/types/src/primitive/Extrinsic/Extrinsic.ts @@ -34,8 +34,6 @@ const VERSIONS: InterfaceTypes[] = [ 'ExtrinsicV3' ]; -const VERSION_UNKNOWN = VERSIONS[0]; - /** * @name Extrinsic * @description @@ -59,7 +57,7 @@ export default class Extrinsic extends Base impl } const isSigned = (version & BIT_SIGNED) === BIT_SIGNED; - const type = VERSIONS[version & UNMASK_VERSION] || VERSION_UNKNOWN; + const type = VERSIONS[version & UNMASK_VERSION] || VERSIONS[0]; // we cast here since the VERSION definition is incredibly broad - we don't have a slice for // "only add extrinsic types", and more string definitions become unwieldly diff --git a/packages/types/src/primitive/Extrinsic/ExtrinsicPayload.ts b/packages/types/src/primitive/Extrinsic/ExtrinsicPayload.ts index 5e6800ab2f..c3c138d724 100644 --- a/packages/types/src/primitive/Extrinsic/ExtrinsicPayload.ts +++ b/packages/types/src/primitive/Extrinsic/ExtrinsicPayload.ts @@ -2,8 +2,8 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import { Balance, Hash, Index } from '../../interfaces/runtime'; -import { ExtrinsicPayloadValue, IKeyringPair } from '../../types'; +import { Balance, ExtrinsicPayloadV1, ExtrinsicPayloadV2, ExtrinsicPayloadV3, Hash, Index } from '../../interfaces/runtime'; +import { ExtrinsicPayloadValue, IKeyringPair, InterfaceTypes } from '../../types'; import { u8aToHex } from '@polkadot/util'; @@ -12,9 +12,6 @@ import Base from '../../codec/Base'; import Compact from '../../codec/Compact'; import U8a from '../../codec/U8a'; import u32 from '../../primitive/U32'; -import ExtrinsicPayloadV1 from './v1/ExtrinsicPayload'; -import ExtrinsicPayloadV2 from './v2/ExtrinsicPayload'; -import ExtrinsicPayloadV3 from './v3/ExtrinsicPayload'; import ExtrinsicEra from './ExtrinsicEra'; import { DEFAULT_VERSION } from './constants'; @@ -22,30 +19,35 @@ interface ExtrinsicPayloadOptions { version?: number; } +// all our known types that can be returned +type ExtrinsicPayloadVx = ExtrinsicPayloadV1 | ExtrinsicPayloadV2 | ExtrinsicPayloadV3; + +const VERSIONS: InterfaceTypes[] = [ + 'ExtrinsicPayloadUnknown', // v0 is unknown + 'ExtrinsicPayloadV1', + 'ExtrinsicPayloadV2', + 'ExtrinsicPayloadV3' +]; + /** * @name ExtrinsicPayload * @description * A signing payload for an [[Extrinsic]]. For the final encoding, it is variable length based * on the contents included */ -export default class ExtrinsicPayload extends Base { +export default class ExtrinsicPayload extends Base { public constructor (value: Partial | Uint8Array | string | undefined, { version }: ExtrinsicPayloadOptions = {}) { super( ExtrinsicPayload.decodeExtrinsicPayload(value as ExtrinsicPayloadValue, version) ); } - public static decodeExtrinsicPayload (value: ExtrinsicPayload | ExtrinsicPayloadValue | Uint8Array | string | undefined, version: number = DEFAULT_VERSION): ExtrinsicPayloadV1 | ExtrinsicPayloadV2 | ExtrinsicPayloadV3 { + public static decodeExtrinsicPayload (value: ExtrinsicPayload | ExtrinsicPayloadValue | Uint8Array | string | undefined, version: number = DEFAULT_VERSION): ExtrinsicPayloadVx { if (value instanceof ExtrinsicPayload) { return value.raw; } - switch (version) { - case 1: return new ExtrinsicPayloadV1(value as Uint8Array); - case 2: return new ExtrinsicPayloadV2(value as Uint8Array); - case 3: return new ExtrinsicPayloadV3(value as Uint8Array); - default: throw new Error(`Unsupported extrinsic version ${version}`); - } + return createType(VERSIONS[version] || VERSIONS[0], value, { version }) as ExtrinsicPayloadVx; } /** diff --git a/packages/types/src/primitive/Extrinsic/ExtrinsicPayloadUnknown.ts b/packages/types/src/primitive/Extrinsic/ExtrinsicPayloadUnknown.ts new file mode 100644 index 0000000000..284818625c --- /dev/null +++ b/packages/types/src/primitive/Extrinsic/ExtrinsicPayloadUnknown.ts @@ -0,0 +1,20 @@ +// Copyright 2017-2019 @polkadot/types authors & contributors +// This software may be modified and distributed under the terms +// of the Apache-2.0 license. See the LICENSE file for details. + +import { ExtrinsicPayloadOptions } from './types'; + +import Struct from '../../codec/Struct'; + +/** + * @name ExtrinsicPayloadUnknown + * @description + * A default handler for payloads where the version is not known (default throw) + */ +export default class ExtrinsicPayloadUnknown extends Struct { + public constructor (value?: any, { version = 0 }: Partial = {}) { + super({}); + + throw new Error(`Unsupported extrinsic payload version ${version}`); + } +} diff --git a/packages/types/src/primitive/Extrinsic/index.ts b/packages/types/src/primitive/Extrinsic/index.ts index 34b483d1fe..6dcd6f6a82 100644 --- a/packages/types/src/primitive/Extrinsic/index.ts +++ b/packages/types/src/primitive/Extrinsic/index.ts @@ -5,7 +5,11 @@ export { default as GenericExtrinsic } from './Extrinsic'; export { default as GenericExtrinsicEra, MortalEra as GenericMortalEra, ImmortalEra as GenericImmortalEra } from './ExtrinsicEra'; export { default as GenericExtrinsicPayload } from './ExtrinsicPayload'; +export { default as GenericExtrinsicPayloadUnknown } from './ExtrinsicPayloadUnknown'; export { default as GenericExtrinsicUnknown } from './ExtrinsicUnknown'; export { default as GenericExtrinsicV1 } from './v1/Extrinsic'; +export { default as GenericExtrinsicPayloadV1 } from './v1/ExtrinsicPayload'; export { default as GenericExtrinsicV2 } from './v2/Extrinsic'; +export { default as GenericExtrinsicPayloadV2 } from './v2/ExtrinsicPayload'; export { default as GenericExtrinsicV3 } from './v3/Extrinsic'; +export { default as GenericExtrinsicPayloadV3 } from './v3/ExtrinsicPayload'; diff --git a/packages/types/src/primitive/Extrinsic/types.ts b/packages/types/src/primitive/Extrinsic/types.ts index 8c1849aeeb..0903c1260c 100644 --- a/packages/types/src/primitive/Extrinsic/types.ts +++ b/packages/types/src/primitive/Extrinsic/types.ts @@ -9,6 +9,10 @@ export interface ExtrinsicOptions { version: number; } +export interface ExtrinsicPayloadOptions { + version: number; +} + export interface ExtrinsicSignatureOptions { isSigned?: boolean; }