From a47b2ec1d2300bff2d67d51f4944258710e8f3be Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Thu, 29 Aug 2019 14:56:56 +0200 Subject: [PATCH] Allow override of Extrinsic V1-V3 (#1349) * Allow override of Extrinsic V1-V3 * Options only used once, pass in directly * Linting, unused type --- packages/types/src/interfaceRegistry.ts | 11 +++++- .../src/interfaces/runtime/definitions.ts | 3 ++ .../types/src/interfaces/runtime/types.ts | 11 +++++- .../src/primitive/Extrinsic/Extrinsic.ts | 34 +++++++++++-------- .../types/src/primitive/Extrinsic/index.ts | 3 ++ 5 files changed, 45 insertions(+), 17 deletions(-) diff --git a/packages/types/src/interfaceRegistry.ts b/packages/types/src/interfaceRegistry.ts index c30b0541b0..6ffbe6f4d5 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, 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, 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'; @@ -170,6 +170,15 @@ export interface InterfaceRegistry { ExtrinsicUnknown: ExtrinsicUnknown; 'Option': Option; 'Vec': Vec; + ExtrinsicV1: ExtrinsicV1; + 'Option': Option; + 'Vec': Vec; + ExtrinsicV2: ExtrinsicV2; + 'Option': Option; + 'Vec': Vec; + ExtrinsicV3: ExtrinsicV3; + 'Option': Option; + 'Vec': Vec; Hash: Hash; 'Option': Option; 'Vec': Vec; diff --git a/packages/types/src/interfaces/runtime/definitions.ts b/packages/types/src/interfaces/runtime/definitions.ts index 0485b1c6ae..21500572b6 100644 --- a/packages/types/src/interfaces/runtime/definitions.ts +++ b/packages/types/src/interfaces/runtime/definitions.ts @@ -21,6 +21,9 @@ export default { ExtrinsicEra: 'GenericExtrinsicEra', ExtrinsicPayload: 'GenericExtrinsicPayload', ExtrinsicUnknown: 'GenericExtrinsicUnknown', + ExtrinsicV1: 'GenericExtrinsicV1', + ExtrinsicV2: 'GenericExtrinsicV2', + ExtrinsicV3: 'GenericExtrinsicV3', Hash: 'H256', Header: { parentHash: 'Hash', diff --git a/packages/types/src/interfaces/runtime/types.ts b/packages/types/src/interfaces/runtime/types.ts index b637b2869e..7a52f52be6 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, 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, GenericExtrinsicUnknown, GenericExtrinsicV1, GenericExtrinsicV2, GenericExtrinsicV3, GenericImmortalEra, GenericMortalEra, GenericOrigin, H256, H512, Null, StorageData, StorageKey, u128, u32, u64 } from '../../primitive'; /** GenericAccountId */ export type AccountId = GenericAccountId; @@ -62,6 +62,15 @@ export type ExtrinsicPayload = GenericExtrinsicPayload; /** GenericExtrinsicUnknown */ export type ExtrinsicUnknown = GenericExtrinsicUnknown; +/** GenericExtrinsicV1 */ +export type ExtrinsicV1 = GenericExtrinsicV1; + +/** GenericExtrinsicV2 */ +export type ExtrinsicV2 = GenericExtrinsicV2; + +/** GenericExtrinsicV3 */ +export type ExtrinsicV3 = GenericExtrinsicV3; + /** H256 */ export type Hash = H256; diff --git a/packages/types/src/primitive/Extrinsic/Extrinsic.ts b/packages/types/src/primitive/Extrinsic/Extrinsic.ts index d6ec13e466..a67e774409 100644 --- a/packages/types/src/primitive/Extrinsic/Extrinsic.ts +++ b/packages/types/src/primitive/Extrinsic/Extrinsic.ts @@ -3,18 +3,17 @@ // of the Apache-2.0 license. See the LICENSE file for details. import { FunctionMetadataV7 } from '../../interfaces/metadata/types'; -import { Address, Balance, Call, ExtrinsicUnknown, Index } from '../../interfaces/runtime'; -import { AnyU8a, ArgsDef, Codec, ExtrinsicPayloadValue, IExtrinsic, IHash, IKeyringPair, SignatureOptions } from '../../types'; -import { ExtrinsicOptions } from './types'; +import { Address, Balance, Call, ExtrinsicUnknown, ExtrinsicV1, ExtrinsicV2, ExtrinsicV3, Index } from '../../interfaces/runtime'; +import { AnyU8a, ArgsDef, Codec, ExtrinsicPayloadValue, IExtrinsic, IHash, IKeyringPair, InterfaceTypes, SignatureOptions } from '../../types'; import { assert, isHex, isU8a, u8aConcat, u8aToHex, u8aToU8a } from '@polkadot/util'; import { createType, ClassOf } from '../../codec/create'; import Base from '../../codec/Base'; import Compact from '../../codec/Compact'; -import ExtrinsicV1, { ExtrinsicValueV1 } from './v1/Extrinsic'; -import ExtrinsicV2, { ExtrinsicValueV2 } from './v2/Extrinsic'; -import ExtrinsicV3, { ExtrinsicValueV3 } from './v3/Extrinsic'; +import { ExtrinsicValueV1 } from './v1/Extrinsic'; +import { ExtrinsicValueV2 } from './v2/Extrinsic'; +import { ExtrinsicValueV3 } from './v3/Extrinsic'; import ExtrinsicEra from './ExtrinsicEra'; import { BIT_SIGNED, BIT_UNSIGNED, DEFAULT_VERSION, UNMASK_VERSION } from './constants'; @@ -28,6 +27,15 @@ interface CreateOptions { version?: number; } +const VERSIONS: InterfaceTypes[] = [ + 'ExtrinsicUnknown', // v0 is unknown + 'ExtrinsicV1', + 'ExtrinsicV2', + 'ExtrinsicV2' +]; + +const VERSION_UNKNOWN = VERSIONS[0]; + /** * @name Extrinsic * @description @@ -51,15 +59,11 @@ export default class Extrinsic extends Base impl } const isSigned = (version & BIT_SIGNED) === BIT_SIGNED; - const type = version & UNMASK_VERSION; - const options: ExtrinsicOptions = { isSigned, version }; + const type = VERSIONS[version & UNMASK_VERSION] || VERSION_UNKNOWN; - switch (type) { - case 1: return new ExtrinsicV1(value, options); - case 2: return new ExtrinsicV2(value, options); - case 3: return new ExtrinsicV3(value, options); - default: return createType('ExtrinsicUnknown', value, options); - } + // 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 + return createType(type, value, { isSigned, version }) as ExtrinsicVx; } public static decodeExtrinsic (value: Extrinsic | ExtrinsicValue | AnyU8a | Call | undefined, version: number = DEFAULT_VERSION): ExtrinsicVx | ExtrinsicUnknown { @@ -228,7 +232,7 @@ export default class Extrinsic extends Base impl } /** - * @description Add an [[ExtrinsicSignature]] to the extrinsic (already generated) + * @description Injects an already-generated signature into the extrinsic */ public addSignature (signer: Address | Uint8Array | string, signature: Uint8Array | string, ...args: [ExtrinsicPayloadValue | Uint8Array | string]): Extrinsic { // FIXME Support for current extensions where 2 values are being passed in here, i.e. diff --git a/packages/types/src/primitive/Extrinsic/index.ts b/packages/types/src/primitive/Extrinsic/index.ts index ffa0998cd5..34b483d1fe 100644 --- a/packages/types/src/primitive/Extrinsic/index.ts +++ b/packages/types/src/primitive/Extrinsic/index.ts @@ -6,3 +6,6 @@ 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 GenericExtrinsicUnknown } from './ExtrinsicUnknown'; +export { default as GenericExtrinsicV1 } from './v1/Extrinsic'; +export { default as GenericExtrinsicV2 } from './v2/Extrinsic'; +export { default as GenericExtrinsicV3 } from './v3/Extrinsic';