From caff93941b011396461cfde7f5797adec1ab35de Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Wed, 19 Dec 2018 14:43:30 +0100 Subject: [PATCH] Method -> Extrinsic circular dep (#495) * Method -> Extrinsic circular dep * Cleanup test formatting --- packages/api-observable/src/Base.ts | 6 +-- packages/api/src/Base.ts | 6 +-- .../src/promise/SubmittableExtrinsic.spec.ts | 2 +- packages/api/src/promise/index.ts | 10 ++--- packages/api/src/promise/types.ts | 4 +- packages/api/src/rx/index.ts | 10 ++--- packages/api/src/rx/types.ts | 4 +- .../type-extrinsics/src/fromMetadata.spec.ts | 6 ++- packages/type-extrinsics/src/fromMetadata.ts | 6 +-- packages/type-extrinsics/src/index.spec.ts | 14 +++---- packages/type-extrinsics/src/index.ts | 4 +- .../src/utils/createUnchecked.ts | 20 ++++----- packages/types/src/Extrinsic.spec.ts | 2 +- packages/types/src/Method.spec.ts | 2 +- packages/types/src/Method.ts | 41 +++++++++---------- packages/types/src/SignedBlock.spec.ts | 2 +- packages/types/src/codec/Tuple.spec.ts | 2 +- packages/types/src/codec/Vector.spec.ts | 2 +- 18 files changed, 71 insertions(+), 72 deletions(-) diff --git a/packages/api-observable/src/Base.ts b/packages/api-observable/src/Base.ts index 4cfd1f982f..1793043dc7 100644 --- a/packages/api-observable/src/Base.ts +++ b/packages/api-observable/src/Base.ts @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import { Extrinsics } from '@polkadot/types/Method'; +import { ModulesWithMethods } from '@polkadot/types/Method'; import { RpcMethod } from '@polkadot/jsonrpc/types'; import { RpcRxInterface, RpcRxInterface$Method, RpcRxInterface$Section } from '@polkadot/rpc-rx/types'; import { Storage } from '@polkadot/storage/types'; @@ -38,7 +38,7 @@ export default class ApiBase { this.whenReady = from(this.init()); } - static extrinsics: Extrinsics = extrinsicsStatic; + static extrinsics: ModulesWithMethods = extrinsicsStatic; static storage: Storage = storageStatic; // FIXME This logic is duplicated in api-rx, since that should derive @@ -64,7 +64,7 @@ export default class ApiBase { ApiBase.storage = storageFromMeta(meta); Event.injectMetadata(meta); - Method.injectExtrinsics(ApiBase.extrinsics); + Method.injectMethods(ApiBase.extrinsics); if (!isReady) { isReady = true; diff --git a/packages/api/src/Base.ts b/packages/api/src/Base.ts index 032d6f98f3..33b0997f66 100644 --- a/packages/api/src/Base.ts +++ b/packages/api/src/Base.ts @@ -12,7 +12,7 @@ import { Storage } from '@polkadot/storage/types'; import storageFromMeta from '@polkadot/storage/fromMetadata'; import registry from '@polkadot/types/codec/typeRegistry'; import { Event, Hash, Metadata, Method, RuntimeVersion } from '@polkadot/types/index'; -import { Extrinsics } from '@polkadot/types/Method'; +import { ModulesWithMethods } from '@polkadot/types/Method'; import { assert, isFunction, isObject, isUndefined, logger } from '@polkadot/util'; type MetaDecoration = { @@ -253,7 +253,7 @@ export default abstract class ApiBase implements ApiBaseInterface implements ApiBaseInterface { let api: any; beforeEach(() => { - Method.injectExtrinsics(extrinsics); + Method.injectMethods(extrinsics); api = { hasSubscriptions: true, diff --git a/packages/api/src/promise/index.ts b/packages/api/src/promise/index.ts index b4c3983927..f8f4c0a621 100644 --- a/packages/api/src/promise/index.ts +++ b/packages/api/src/promise/index.ts @@ -8,9 +8,9 @@ import { ApiPromiseInterface, QueryableStorageFunction, QueryableModuleStorage, import Rpc from '@polkadot/rpc-core/index'; import { Storage } from '@polkadot/storage/types'; -import { Hash } from '@polkadot/types/index'; +import { Extrinsic, Hash } from '@polkadot/types/index'; import { Codec } from '@polkadot/types/types'; -import { Extrinsics, ExtrinsicFunction } from '@polkadot/types/Method'; +import { MethodFunction, ModulesWithMethods } from '@polkadot/types/Method'; import { StorageFunction } from '@polkadot/types/StorageKey'; import { isFunction, logger } from '@polkadot/util'; @@ -201,7 +201,7 @@ export default class ApiPromise extends ApiBase { const section = extrinsics[sectionName]; @@ -215,9 +215,9 @@ export default class ApiPromise extends ApiBase): SubmittableExtrinsic => - new SubmittableExtrinsic(this, method(...args)); + new SubmittableExtrinsic(this, new Extrinsic({ method: method(...args) })); return this.decorateFunctionMeta(method, decorated) as SubmittableExtrinsicFunction; } diff --git a/packages/api/src/promise/types.ts b/packages/api/src/promise/types.ts index 1ea4ecd550..92bfb61a72 100644 --- a/packages/api/src/promise/types.ts +++ b/packages/api/src/promise/types.ts @@ -4,7 +4,7 @@ import { Hash } from '@polkadot/types/index'; import { Codec } from '@polkadot/types/types'; -import { ExtrinsicFunction } from '@polkadot/types/Method'; +import { MethodFunction } from '@polkadot/types/Method'; import { StorageFunction } from '@polkadot/types/StorageKey'; import { ApiBaseInterface } from '../types'; @@ -25,7 +25,7 @@ export interface QueryableStorage { [index: string]: QueryableModuleStorage; } -export interface SubmittableExtrinsicFunction extends ExtrinsicFunction { +export interface SubmittableExtrinsicFunction extends MethodFunction { (...args: any[]): SubmittableExtrinsic; } diff --git a/packages/api/src/rx/index.ts b/packages/api/src/rx/index.ts index 48a092730b..414a846278 100644 --- a/packages/api/src/rx/index.ts +++ b/packages/api/src/rx/index.ts @@ -11,9 +11,9 @@ import { catchError, map } from 'rxjs/operators'; import Rpc from '@polkadot/rpc-core/index'; import RpcRx from '@polkadot/rpc-rx/index'; import { Storage } from '@polkadot/storage/types'; -import { Hash } from '@polkadot/types/index'; +import { Extrinsic, Hash } from '@polkadot/types/index'; import { Codec } from '@polkadot/types/types'; -import { Extrinsics, ExtrinsicFunction } from '@polkadot/types/Method'; +import { MethodFunction, ModulesWithMethods } from '@polkadot/types/Method'; import { StorageFunction } from '@polkadot/types/StorageKey'; import { assert } from '@polkadot/util'; @@ -193,7 +193,7 @@ export default class ApiRx extends ApiBase { const section = extrinsics[sectionName]; @@ -207,9 +207,9 @@ export default class ApiRx extends ApiBase): SubmittableExtrinsic => - new SubmittableExtrinsic(this, method(...args)); + new SubmittableExtrinsic(this, new Extrinsic({ method: method(...args) })); return this.decorateFunctionMeta(method, decorated) as SubmittableExtrinsicFunction; } diff --git a/packages/api/src/rx/types.ts b/packages/api/src/rx/types.ts index 0ec00941cc..fdaa2d9827 100644 --- a/packages/api/src/rx/types.ts +++ b/packages/api/src/rx/types.ts @@ -4,7 +4,7 @@ import { Hash } from '@polkadot/types/index'; import { Codec } from '@polkadot/types/types'; -import { ExtrinsicFunction } from '@polkadot/types/Method'; +import { MethodFunction } from '@polkadot/types/Method'; import { StorageFunction } from '@polkadot/types/StorageKey'; import { ApiBaseInterface } from '../types'; @@ -26,7 +26,7 @@ export interface QueryableStorage { [index: string]: QueryableModuleStorage; } -export interface SubmittableExtrinsicFunction extends ExtrinsicFunction { +export interface SubmittableExtrinsicFunction extends MethodFunction { (...args: any[]): SubmittableExtrinsic; } diff --git a/packages/type-extrinsics/src/fromMetadata.spec.ts b/packages/type-extrinsics/src/fromMetadata.spec.ts index 52b42ad136..22a366c5e5 100644 --- a/packages/type-extrinsics/src/fromMetadata.spec.ts +++ b/packages/type-extrinsics/src/fromMetadata.spec.ts @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import Metadata from '@polkadot/types/Metadata'; +import { Extrinsic, Metadata } from '@polkadot/types/index'; import json from '@polkadot/types/Metadata/static'; import fromMetadata from './fromMetadata'; @@ -21,7 +21,9 @@ describe('fromMetadata', () => { }); it('should return properly-encoded transactions', () => { - expect(newExtrinsics.timestamp.set([10101]).toU8a()).toEqual( + expect( + new Extrinsic({ method: newExtrinsics.timestamp.set([10101]) }).toU8a() + ).toEqual( new Uint8Array([ // length (encoded) 11 << 2, diff --git a/packages/type-extrinsics/src/fromMetadata.ts b/packages/type-extrinsics/src/fromMetadata.ts index 5aafb5391d..00adc6900b 100644 --- a/packages/type-extrinsics/src/fromMetadata.ts +++ b/packages/type-extrinsics/src/fromMetadata.ts @@ -3,7 +3,7 @@ // of the Apache-2.0 license. See the LICENSE file for details. import { RuntimeModuleMetadata } from '@polkadot/types/Metadata/Modules'; -import { Extrinsics, ModuleExtrinsics } from '@polkadot/types/Method'; +import { Methods, ModulesWithMethods } from '@polkadot/types/Method'; import { Metadata } from '@polkadot/types/index'; import { stringCamelCase } from '@polkadot/util'; @@ -18,7 +18,7 @@ import extrinsics from './index'; * @param extrinsics - An extrinsics object to be extended. * @param metadata - The metadata to extend the storage object against. */ -export default function fromMetadata (metadata: Metadata): Extrinsics { +export default function fromMetadata (metadata: Metadata): ModulesWithMethods { let indexCount = -1; const findIndex = (prefix: string): number => { @@ -51,7 +51,7 @@ export default function fromMetadata (metadata: Metadata): Extrinsics { newModule[funcName] = createUnchecked(prefix, funcName, index, funcMeta); return newModule; - }, {} as ModuleExtrinsics); + }, {} as Methods); return result; }, { ...extrinsics }); diff --git a/packages/type-extrinsics/src/index.spec.ts b/packages/type-extrinsics/src/index.spec.ts index ced690b69d..e19cf79c8b 100644 --- a/packages/type-extrinsics/src/index.spec.ts +++ b/packages/type-extrinsics/src/index.spec.ts @@ -3,6 +3,7 @@ // of the Apache-2.0 license. See the LICENSE file for details. import testingPairs from '@polkadot/keyring/testingPairs'; +import { Extrinsic } from '@polkadot/types/index'; import { hexToU8a } from '@polkadot/util'; import extrinsics from './static'; @@ -12,9 +13,9 @@ const keyring = testingPairs(); describe('extrinsics', () => { it('encodes extrinsic correctly (nobody)', () => { expect( - extrinsics.timestamp.set( - 10101 - ).sign( + new Extrinsic({ + method: extrinsics.timestamp.set(10101) + }).sign( keyring.nobody, 1234, new Uint8Array() @@ -43,10 +44,9 @@ describe('extrinsics', () => { it('encodes an actual transfer (actual data)', () => { expect( - extrinsics.balances - .transfer(keyring.bob.publicKey(), 6969) - .sign(keyring.alice, 0, '0xec7afaf1cca720ce88c1d1b689d81f0583cc15a97d621cf046dd9abf605ef22f') - .toU8a() + new Extrinsic({ + method: extrinsics.balances.transfer(keyring.bob.publicKey(), 6969) + }).sign(keyring.alice, 0, '0xec7afaf1cca720ce88c1d1b689d81f0583cc15a97d621cf046dd9abf605ef22f').toU8a() ).toEqual( hexToU8a( '0x' + diff --git a/packages/type-extrinsics/src/index.ts b/packages/type-extrinsics/src/index.ts index dbb3b3f4a3..6fa54de52b 100644 --- a/packages/type-extrinsics/src/index.ts +++ b/packages/type-extrinsics/src/index.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 { Extrinsics } from '@polkadot/types/Method'; +import { ModulesWithMethods } from '@polkadot/types/Method'; -const extrinsics: Extrinsics = {}; +const extrinsics: ModulesWithMethods = {}; export default extrinsics; diff --git a/packages/type-extrinsics/src/utils/createUnchecked.ts b/packages/type-extrinsics/src/utils/createUnchecked.ts index 5251afc055..c1762e5934 100644 --- a/packages/type-extrinsics/src/utils/createUnchecked.ts +++ b/packages/type-extrinsics/src/utils/createUnchecked.ts @@ -3,8 +3,8 @@ // of the Apache-2.0 license. See the LICENSE file for details. import { FunctionMetadata } from '@polkadot/types/Metadata/Modules'; -import { ExtrinsicFunction } from '@polkadot/types/Method'; -import { Extrinsic, Method } from '@polkadot/types/index'; +import { MethodFunction } from '@polkadot/types/Method'; +import { Method } from '@polkadot/types/index'; import { assert } from '@polkadot/util'; /** @@ -18,21 +18,19 @@ export default function createDescriptor ( method: string, index: number, meta: FunctionMetadata -): ExtrinsicFunction { +): MethodFunction { const callIndex = new Uint8Array([index, meta.id.toNumber()]); let extrinsicFn: any; const expectedArgs = Method.filterOrigin(meta); - extrinsicFn = (...args: any[]): Extrinsic => { + extrinsicFn = (...args: any[]): Method => { assert(expectedArgs.length.valueOf() === args.length, `Extrinsic ${section}.${method} expects ${expectedArgs.length.valueOf()} arguments, got ${args.length}.`); - return new Extrinsic({ - method: new Method({ - args, - callIndex - }, meta) - }); + return new Method({ + args, + callIndex + }, meta); }; extrinsicFn.callIndex = callIndex; @@ -42,5 +40,5 @@ export default function createDescriptor ( extrinsicFn.toJSON = (): any => meta.toJSON(); - return extrinsicFn as ExtrinsicFunction; + return extrinsicFn as MethodFunction; } diff --git a/packages/types/src/Extrinsic.spec.ts b/packages/types/src/Extrinsic.spec.ts index 9e8100073f..9f2fbe2b5c 100644 --- a/packages/types/src/Extrinsic.spec.ts +++ b/packages/types/src/Extrinsic.spec.ts @@ -9,7 +9,7 @@ import Method from './Method'; describe('Extrinsic', () => { beforeAll(() => { - Method.injectExtrinsics(extrinsics); + Method.injectMethods(extrinsics); }); it('decodes a non-signed properly via JSON', () => { diff --git a/packages/types/src/Method.spec.ts b/packages/types/src/Method.spec.ts index fff6931420..5ccbf541d3 100644 --- a/packages/types/src/Method.spec.ts +++ b/packages/types/src/Method.spec.ts @@ -8,7 +8,7 @@ import Method from './Method'; describe('Method', () => { beforeEach(() => { - Method.injectExtrinsics(extrinsics); + Method.injectMethods(extrinsics); }); it('throws when not decodable', () => { diff --git a/packages/types/src/Method.ts b/packages/types/src/Method.ts index 5413f2d4b7..6557bab0dd 100644 --- a/packages/types/src/Method.ts +++ b/packages/types/src/Method.ts @@ -9,14 +9,8 @@ import { assert, isHex, isObject, isU8a, hexToU8a } from '@polkadot/util'; import { getTypeDef, getTypeClass } from './codec/createType'; import Struct from './codec/Struct'; import U8aFixed from './codec/U8aFixed'; -import Extrinsic from './Extrinsic'; import { FunctionMetadata, FunctionArgumentMetadata } from './Metadata/Modules'; -const FN_UNKNOWN = { - method: 'unknown', - section: 'unknown' -} as ExtrinsicFunction; - interface ArgsDef { [index: string]: Constructor; } @@ -31,8 +25,8 @@ interface DecodedMethod extends DecodeMethodInput { meta: FunctionMetadata; } -export interface ExtrinsicFunction { - (...args: any[]): Extrinsic; +export interface MethodFunction { + (...args: any[]): Method; callIndex: Uint8Array; meta: FunctionMetadata; method: string; @@ -40,15 +34,20 @@ export interface ExtrinsicFunction { toJSON: () => any; } -export interface ModuleExtrinsics { - [key: string]: ExtrinsicFunction; +export interface Methods { + [key: string]: MethodFunction; } -export interface Extrinsics { - [key: string]: ModuleExtrinsics; // Will hold modules returned by state_getMetadata +export interface ModulesWithMethods { + [key: string]: Methods; // Will hold modules returned by state_getMetadata } -const extrinsicFns: { [index: string]: ExtrinsicFunction } = {}; +const FN_UNKNOWN = { + method: 'unknown', + section: 'unknown' +} as MethodFunction; + +const injected: { [index: string]: MethodFunction } = {}; /** * @name MethodIndex @@ -88,7 +87,7 @@ export default class Method extends Struct { * - hex * - Uint8Array * - {@see DecodeMethodInput} - * @param _meta - Metadata to use, so that `injectExtrinsics` lookup is not + * @param _meta - Metadata to use, so that `injectMethods` lookup is not * necessary. */ private static decodeMethod (value: DecodedMethod | Uint8Array | string, _meta?: FunctionMetadata): DecodedMethod { @@ -140,17 +139,17 @@ export default class Method extends Struct { : []; } - // We could only inject the meta (see injectExtrinsics below) and then do a + // We could only inject the meta (see injectMethods below) and then do a // meta-only lookup via // // metadata.modules[callIndex[0]].module.call.functions[callIndex[1]] // // As a convenience helper though, we return the full constructor function, // which includes the meta, name, section & actual interface for calling - static findFunction (callIndex: Uint8Array): ExtrinsicFunction { - assert(Object.keys(extrinsicFns).length > 0, 'Calling Method.findFunction before extrinsics have been injected.'); + static findFunction (callIndex: Uint8Array): MethodFunction { + assert(Object.keys(injected).length > 0, 'Calling Method.findFunction before extrinsics have been injected.'); - return extrinsicFns[callIndex.toString()] || FN_UNKNOWN; + return injected[callIndex.toString()] || FN_UNKNOWN; } /** @@ -172,10 +171,10 @@ export default class Method extends Struct { // This is called/injected by the API on init, allowing a snapshot of // the available system extrinsics to be used in lookups - static injectExtrinsics (extrinsics: Extrinsics): void { - Object.values(extrinsics).forEach((methods) => + static injectMethods (moduleMethods: ModulesWithMethods): void { + Object.values(moduleMethods).forEach((methods) => Object.values(methods).forEach((method) => - extrinsicFns[method.callIndex.toString()] = method + injected[method.callIndex.toString()] = method ) ); } diff --git a/packages/types/src/SignedBlock.spec.ts b/packages/types/src/SignedBlock.spec.ts index 9d535bb0a6..4440760e22 100644 --- a/packages/types/src/SignedBlock.spec.ts +++ b/packages/types/src/SignedBlock.spec.ts @@ -14,7 +14,7 @@ describe('SignedBlock', () => { let block: SignedBlock; beforeEach(() => { - Method.injectExtrinsics(extrinsics); + Method.injectMethods(extrinsics); block = new SignedBlock(rpc.result); }); diff --git a/packages/types/src/codec/Tuple.spec.ts b/packages/types/src/codec/Tuple.spec.ts index b602aea801..dad7bbf415 100644 --- a/packages/types/src/codec/Tuple.spec.ts +++ b/packages/types/src/codec/Tuple.spec.ts @@ -53,7 +53,7 @@ describe('Tuple', () => { }); it('creates properly via actual hex string', () => { - Method.injectExtrinsics(extrinsics); + Method.injectMethods(extrinsics); const test = new (Tuple.with([ BlockNumber, Proposal, VoteThreshold diff --git a/packages/types/src/codec/Vector.spec.ts b/packages/types/src/codec/Vector.spec.ts index 0317feabf7..956c769a9d 100644 --- a/packages/types/src/codec/Vector.spec.ts +++ b/packages/types/src/codec/Vector.spec.ts @@ -20,7 +20,7 @@ describe('Vector', () => { beforeEach(() => { vector = new Vector(Text, ['1', '23', '345', '4567', new Text('56789')]); - Method.injectExtrinsics(extrinsics); + Method.injectMethods(extrinsics); }); it('wraps a sequence of values', () => {