Share TypeSpec between registry instances (#3972)

jacogr · web-flow · commit 6ef410e375a4 · 2021-09-19T21:29:11.000+02:00
* Share TypeSpec between registry instances

* 6.0.3
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,12 @@
 # CHANGELOG
 
-## master
+## 6.0.3 Sep 19, 2021
+
+Upgrade priority: Low. Recommended for all users on 6.0.2 using `api.query.*.*.at` calls
 
 Changes:
 
+- Fix `api.query.<module>.<method>.at` queries
 - Adjust typegen formatting for metadata documentation
 
 
diff --git a/package.json b/package.json
@@ -35,6 +35,6 @@
     "@types/jest": "^27.0.1",
     "copyfiles": "^2.4.1"
   },
-  "version": "6.0.3-0",
+  "version": "6.0.3",
   "packageManager": "yarn@3.0.1"
 }
diff --git a/packages/api-contract/package.json b/packages/api-contract/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/api-contract",
-  "version": "6.0.3-0",
+  "version": "6.0.3",
   "type": "module",
   "description": "Interfaces for interacting with contracts and contract ABIs",
   "main": "index.js",
@@ -20,8 +20,8 @@
   "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-contract#readme",
   "dependencies": {
     "@babel/runtime": "^7.15.4",
-    "@polkadot/api": "6.0.3-0",
-    "@polkadot/types": "6.0.3-0",
+    "@polkadot/api": "6.0.3",
+    "@polkadot/types": "6.0.3",
     "@polkadot/util": "^7.4.1",
     "rxjs": "^7.3.0"
   }
diff --git a/packages/api-derive/package.json b/packages/api-derive/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/api-derive",
-  "version": "6.0.3-0",
+  "version": "6.0.3",
   "type": "module",
   "description": "Common functions used across Polkadot, derived from RPC calls and storage queries.",
   "main": "index.js",
@@ -20,15 +20,15 @@
   "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-derive#readme",
   "dependencies": {
     "@babel/runtime": "^7.15.4",
-    "@polkadot/api": "6.0.3-0",
-    "@polkadot/rpc-core": "6.0.3-0",
-    "@polkadot/types": "6.0.3-0",
+    "@polkadot/api": "6.0.3",
+    "@polkadot/rpc-core": "6.0.3",
+    "@polkadot/types": "6.0.3",
     "@polkadot/util": "^7.4.1",
     "@polkadot/util-crypto": "^7.4.1",
     "rxjs": "^7.3.0"
   },
   "devDependencies": {
     "@polkadot/keyring": "^7.4.1",
-    "@polkadot/rpc-provider": "6.0.3-0"
+    "@polkadot/rpc-provider": "6.0.3"
   }
 }
diff --git a/packages/api/package.json b/packages/api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/api",
-  "version": "6.0.3-0",
+  "version": "6.0.3",
   "type": "module",
   "description": "Promise and RxJS wrappers around the Polkadot JS RPC",
   "main": "index.js",
@@ -20,12 +20,12 @@
   "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme",
   "dependencies": {
     "@babel/runtime": "^7.15.4",
-    "@polkadot/api-derive": "6.0.3-0",
+    "@polkadot/api-derive": "6.0.3",
     "@polkadot/keyring": "^7.4.1",
-    "@polkadot/rpc-core": "6.0.3-0",
-    "@polkadot/rpc-provider": "6.0.3-0",
-    "@polkadot/types": "6.0.3-0",
-    "@polkadot/types-known": "6.0.3-0",
+    "@polkadot/rpc-core": "6.0.3",
+    "@polkadot/rpc-provider": "6.0.3",
+    "@polkadot/types": "6.0.3",
+    "@polkadot/types-known": "6.0.3",
     "@polkadot/util": "^7.4.1",
     "@polkadot/util-crypto": "^7.4.1",
     "eventemitter3": "^4.0.7",
diff --git a/packages/api/src/base/Decorate.ts b/packages/api/src/base/Decorate.ts
@@ -358,12 +358,12 @@ export abstract class Decorate<ApiType extends ApiTypes> extends Events {
       (this.hasSubscriptions
         ? this._rpcCore.state.subscribeStorage
         : this._rpcCore.state.queryStorageAt)(
-        calls.map((arg: QueryableStorageMultiArg<ApiType>) =>
-          Array.isArray(arg)
-            ? arg[0].creator.meta.type.asMap.hashers.length === 1
-              ? [arg[0].creator, arg.slice(1)]
-              : [arg[0].creator, ...arg.slice(1)]
-            : [arg.creator])));
+        calls.map((args: QueryableStorageMultiArg<ApiType>) =>
+          Array.isArray(args)
+            ? args[0].creator.meta.type.asMap.hashers.length === 1
+              ? [args[0].creator, args.slice(1)]
+              : [args[0].creator, ...args.slice(1)]
+            : [args.creator])));
   }
 
   protected _decorateExtrinsics<ApiType extends ApiTypes> ({ tx }: DecoratedMeta, decorateMethod: DecorateMethod<ApiType>): SubmittableExtrinsics<ApiType> {
@@ -418,7 +418,7 @@ export abstract class Decorate<ApiType extends ApiTypes> extends Events {
 
   private _decorateStorageEntry<ApiType extends ApiTypes> (creator: StorageEntry, decorateMethod: DecorateMethod<ApiType>): QueryableStorageEntry<ApiType> {
     // get the storage arguments, with DoubleMap as an array entry, otherwise spread
-    const getArgs = (args: unknown[]): unknown[] => extractStorageArgs(this.#registry, creator, args);
+    const getArgs = (args: unknown[]) => extractStorageArgs(this.#registry, creator, args);
 
     // Disable this where it occurs for each field we are decorating
     /* eslint-disable @typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-assignment */
diff --git a/packages/api/src/base/Init.ts b/packages/api/src/base/Init.ts
@@ -165,7 +165,7 @@ export abstract class Init<ApiType extends ApiTypes> extends Decorate<ApiType> {
     }
 
     // nothing has been found, construct new
-    const registry = new TypeRegistry(blockHash);
+    const registry = new TypeRegistry(blockHash, this.registry.compatSpecs);
     const metadata = new Metadata(registry,
       await firstValueFrom((this._rpcCore.state.getMetadata as RpcInterfaceMethod).raw(header.parentHash))
     );
diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/rpc-core",
-  "version": "6.0.3-0",
+  "version": "6.0.3",
   "type": "module",
   "description": "A JavaScript wrapper for the Polkadot JsonRPC interface",
   "main": "index.js",
@@ -20,8 +20,8 @@
   "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme",
   "dependencies": {
     "@babel/runtime": "^7.15.4",
-    "@polkadot/rpc-provider": "6.0.3-0",
-    "@polkadot/types": "6.0.3-0",
+    "@polkadot/rpc-provider": "6.0.3",
+    "@polkadot/types": "6.0.3",
     "@polkadot/util": "^7.4.1",
     "rxjs": "^7.3.0"
   },
diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/rpc-provider",
-  "version": "6.0.3-0",
+  "version": "6.0.3",
   "type": "module",
   "description": "Transport providers for the API",
   "main": "index.js",
@@ -20,7 +20,7 @@
   "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-provider#readme",
   "dependencies": {
     "@babel/runtime": "^7.15.4",
-    "@polkadot/types": "6.0.3-0",
+    "@polkadot/types": "6.0.3",
     "@polkadot/util": "^7.4.1",
     "@polkadot/util-crypto": "^7.4.1",
     "@polkadot/x-fetch": "^7.4.1",
@@ -30,7 +30,7 @@
   },
   "devDependencies": {
     "@polkadot/keyring": "^7.4.1",
-    "@polkadot/types": "6.0.3-0",
+    "@polkadot/types": "6.0.3",
     "mock-socket": "^9.0.3",
     "nock": "^13.1.3"
   }
diff --git a/packages/typegen/package.json b/packages/typegen/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/typegen",
-  "version": "6.0.3-0",
+  "version": "6.0.3",
   "type": "module",
   "description": "Type generation scripts",
   "main": "index.js",
@@ -29,10 +29,10 @@
     "@babel/core": "^7.15.5",
     "@babel/register": "^7.15.3",
     "@babel/runtime": "^7.15.4",
-    "@polkadot/api": "6.0.3-0",
-    "@polkadot/rpc-provider": "6.0.3-0",
-    "@polkadot/types": "6.0.3-0",
-    "@polkadot/types-support": "6.0.3-0",
+    "@polkadot/api": "6.0.3",
+    "@polkadot/rpc-provider": "6.0.3",
+    "@polkadot/types": "6.0.3",
+    "@polkadot/types-support": "6.0.3",
     "@polkadot/util": "^7.4.1",
     "handlebars": "^4.7.7",
     "websocket": "^1.0.34",
diff --git a/packages/types-known/package.json b/packages/types-known/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/types-known",
-  "version": "6.0.3-0",
+  "version": "6.0.3",
   "type": "module",
   "description": "Known type definitions",
   "main": "index.js",
@@ -21,7 +21,7 @@
   "dependencies": {
     "@babel/runtime": "^7.15.4",
     "@polkadot/networks": "^7.4.1",
-    "@polkadot/types": "6.0.3-0",
+    "@polkadot/types": "6.0.3",
     "@polkadot/util": "^7.4.1"
   }
 }
diff --git a/packages/types-support/package.json b/packages/types-support/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/types-support",
-  "version": "6.0.3-0",
+  "version": "6.0.3",
   "type": "module",
   "description": "Supporting files for types, mostly for testing",
   "main": "index.js",
diff --git a/packages/types/package.json b/packages/types/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/types",
-  "version": "6.0.3-0",
+  "version": "6.0.3",
   "type": "module",
   "description": "Implementation of the Parity codec",
   "main": "index.js",
@@ -26,7 +26,7 @@
   },
   "devDependencies": {
     "@polkadot/keyring": "^7.4.1",
-    "@polkadot/types-support": "6.0.3-0",
+    "@polkadot/types-support": "6.0.3",
     "@types/bn.js": "^4.11.6",
     "bn.js": "^4.12.0"
   }
diff --git a/packages/types/src/create/registry.ts b/packages/types/src/create/registry.ts
@@ -3,7 +3,7 @@
 
 import type { ExtDef } from '../extrinsic/signedExtensions/types';
 import type { ChainProperties, CodecHash, DispatchErrorModule, Hash, MetadataLatest, PortableRegistry, SiLookupTypeId } from '../interfaces/types';
-import type { CallFunction, Codec, CodecHasher, Constructor, DetectCodec, DetectConstructor, RegisteredTypes, Registry, RegistryError, RegistryTypes } from '../types';
+import type { CallFunction, Codec, CodecHasher, Constructor, DetectCodec, DetectConstructor, RegisteredTypes, Registry, RegistryError, RegistryTypes, TypeSpec } from '../types';
 import type { CreateOptions } from './types';
 
 import { assert, assertReturn, BN_ZERO, formatBalance, isFunction, isString, isU8a, logger, stringCamelCase, stringify, u8aToHex } from '@polkadot/util';
@@ -145,14 +145,20 @@ export class TypeRegistry implements Registry {
 
   #userExtensions?: ExtDef;
 
+  public compatSpecs: TypeSpec[] = [];
+
   public createdAtHash?: Hash;
 
-  constructor (createdAtHash?: Hash | Uint8Array | string) {
+  constructor (createdAtHash?: Hash | Uint8Array | string, compatSpecs?: TypeSpec[]) {
     this.#knownDefaults = { Json, Metadata, Raw, ...baseTypes };
     this.#knownDefinitions = definitions as unknown as Record<string, { types: RegistryTypes }>;
 
     this.init();
 
+    if (compatSpecs) {
+      this.compatSpecs = compatSpecs;
+    }
+
     if (createdAtHash) {
       this.createdAtHash = this.createType('Hash', createdAtHash);
     }
diff --git a/packages/types/src/metadata/v13/toV14.ts b/packages/types/src/metadata/v13/toV14.ts
diff --git a/packages/types/src/types/registry.ts b/packages/types/src/types/registry.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,6 @@`
`35`	`35`	`"@types/jest": "^27.0.1",`
`36`	`36`	`"copyfiles": "^2.4.1"`
`37`	`37`	`},`
`38`		`- "version": "6.0.3-0",`
	`38`	`+ "version": "6.0.3",`
`39`	`39`	`"packageManager": "[email protected]"`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@ export abstract class Init<ApiType extends ApiTypes> extends Decorate<ApiType> {`
`165`	`165`	`}`
`166`	`166`
`167`	`167`	`// nothing has been found, construct new`
`168`		`- const registry = new TypeRegistry(blockHash);`
	`168`	`+ const registry = new TypeRegistry(blockHash, this.registry.compatSpecs);`
`169`	`169`	`const metadata = new Metadata(registry,`
`170`	`170`	`await firstValueFrom((this._rpcCore.state.getMetadata as RpcInterfaceMethod).raw(header.parentHash))`
`171`	`171`	`);`