[CI Skip] release/stable 2.9.1

skip-checks: true

.123trigger

@@ -4,4 +4,4 @@
 1.11.2
 1.12.2
 1.17.2
-1.31.2
+1.31.22.8.2

.eslintrc.js

@@ -1,7 +1,7 @@
 // Copyright 2017-2020 @polkadot/api authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-const base = require('@polkadot/dev/config/eslint');
+const base = require('@polkadot/dev/config/eslint.cjs');
 
 module.exports = {
   ...base,

CHANGELOG.md

@@ -1,5 +1,71 @@
 # CHANGELOG
 
+## 2.9.1 Nov 30, 2020
+
+Upgrade priority: Low. No major changes when on at least 2.8.2. Users encouraged to upgrade to at least that patch.
+
+- **Breaking change** The API will now not attempt to queue calls made while not connected and send on connection. Rather when making a call and the RPC node is not connected, an error will be thrown.
+
+Contributed:
+
+- Add typegen capability for custom RPCs (Thanks to https://github.com/holygits)
+
+Changes:
+
+- Remove rpc-core send queue, only allow sends while connected
+- Adjust staking derive for `electedInfo` to contain details of current validators
+- Extract identity-only derive from `accounts.info` for simpler reusability
+- Add types for Substrate master node (to allow for consistent swapping to `MultiAddress`)
+- Adjust `Bytes` with `.slice` to be consistent for `Uint8array` extensions (already released in 2.8.2 as a bugfix)
+
+
+## 2.8.1 Nov 23, 2020
+
+Upgrade priority: Low. Recommended if using Substrate master with new `MultiAddress`.
+
+Contributed:
+
+- Export `derive.chain.getBlock` (Thanks to https://github.com/lovesh)
+
+Changes:
+
+- Expand `MultiAddress` construction with multi type detection
+- Rename `GenericLookupSource` to `IndicesLookupSource` (internal use)
+- Cleanup list retrievals with `Raw` data results for undecodable entries
+- Export actual version via `RegistryMetadata`
+- Dedupe bn.js (one version shared between dependencies)
+
+
+## 2.7.1 Nov 16, 2020
+
+Upgrade priority: Medium. Recommended for users of Polkadot/Kusama and api-contract users.
+
+Changes:
+
+- Allow for `ExtrinsicSignature` overrides (defaults to `MultiSignature`)
+- Update api-contract `Blueprint` to allow for optional salt (auto if not provided)
+- Support for ink! `.contract` files (in addition to ABI `.json`)
+- Fix contract event decoding with pass-through of raw `Bytes`
+- Fix support for enum encoding in api-contract
+- Support new contract `Schedule` type as per Substrate
+- Update Kusama/Polkadot known upgrade blocks
+- Adjust typegen generated `@polkadot/types` imports
+- Adjust internal `@polkadot/types` imports/exports (overall bundle sizes)
+
+
+## 2.6.1 Nov 9, 2020
+
+Upgrade priority: Low. Should be done alongside an update to `@polkadot/util` to 4.0
+
+Changes:
+
+- Adjust auto-gas to contract RPC call to 5 * 10 ^ 12 (align with Rust)
+- Adjust derive `AccountId` check to take Ethereum-compatible chains into account
+- Fallback for chains with invalid council proposal data in derives
+- Bump static v12 Metadata (tests) to latest Substrate version
+- Bump `@polkadot/{util,util-crypto}` to 4.0 (optimized WASM layers)
+
+
 ## 2.5.1 Nov 2, 2020
 
 Upgrade priority: Low. Recommended for `api-contract` developers.

README.md

@@ -28,19 +28,3 @@ The API is split up into a number of internal packages -
 Type definitions for interfaces as exposed by Polkadot & Substrate clients -
 
 - [@polkadot/types](packages/types/) Codecs for all Polkadot and Substrate primitives
-
-## development
-
-Contributions are welcome!
-
-To start off, this repo (along with others in the [@polkadot](https://github.com/polkadot-js/) family) uses yarn workspaces to organise the code. As such, after cloning, its dependencies _should_ be installed via `yarn`, not via npm; the latter will result in broken dependencies.
-
-To get started -
-
-1. Clone the repo locally, via `git clone https://github.com/polkadot-js/api <optional local path>`
-2. Ensure that you have a recent version of Node.js, for development purposes [Node 10](https://nodejs.org/en/) is recommended.
-3. Ensure that you have a recent version of Yarn, for development purposes [Yarn >=1.10.1](https://yarnpkg.com/docs/install) is required.
-4. Install the dependencies by running `yarn`
-5. Build the everything via `yarn run build`
-6. You can also launch the API Docs, via `yarn vuepress dev docs`
-7. Access the docs via [http://localhost:8080](http://localhost:8080)

babel.config.js

@@ -1,4 +1,4 @@
 // Copyright 2017-2020 @polkadot/api authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-module.exports = require('@polkadot/dev/config/babel');
+module.exports = require('@polkadot/dev/config/babel-config-cjs.cjs');

docker-compose.yml

@@ -1,102 +0,0 @@
-# Docker compose file to run Polkadot-JS API e2e test files on supported versions of Polkadot and Substrate
-# 
-# Setup:
-# Builds 5 containers with different supported versions of Substrate and Polkadot.
-# Runs Polkadot-JS API Tests 
-#
-# Before you can run this script, you need to install Docker and 'Docker Compose' on your machine.
-# Please follow the steps described here (including the prerequisites): https://docs.docker.com/compose/install/
-#
-# Usage:
-# 1. BUILD: Run `docker-compose pull && docker-compose up -d` to pull the latest docker imaged and run docker-compose in detached mode. This will run the substrate and polkadot containers in the background.
-# 2. INFO: Run `docker ps` to get a list of Docker containers running in the background including their mapped ports on localhost
-# 3. TEST: Run `docker-compose logs -f js-api-tests` to run the API tests and print the logs
-# 4. QUIT: Run `docker-compose down` to stop and remove all running containers.
-#
-# Provided Endpoints for localhost:
-#   - Substrate Master: ws://127.0.0.1:9945/
-#   - Substrate 1.0: ws://127.0.0.1:9946/
-#   - Substrate 2.0: ws://127.0.0.1:9947/
-#   - Polkadot Master: ws://127.0.0.1:9948/
-#   - Polkadot Alexander: ws://127.0.0.1:9949/
-# 
-# Find more Docker images of Substrate https://hub.docker.com/r/parity/substrate/tags
-# Find more Docker images of Polkadot https://hub.docker.com/r/parity/polkadot/tags
-
-
-version: "3.7"
-services:
-  substrate-master:
-    image: parity/substrate:latest
-    ports:
-      - "9945:9944"
-      - "9935:9933"
-    networks:
-      - internet
-    command:
-      - "--dev"
-      - "--ws-external"
-      - "--rpc-external"
-    
-  substrate-1.0:
-    image: parity/substrate:v1.0.0
-    ports:
-      - "9946:9944"
-      - "9936:9933"
-    networks:
-      - internet
-    command:
-      - "--dev"
-      - "--ws-external"
-      - "--rpc-external"
-
-  substrate-2.0:
-    image: parity/substrate:2.0.0-b65c315a1
-    ports:
-      - "9947:9944"
-      - "9937:9933"
-    networks:
-      - internet
-    command:
-      - "--dev"
-      - "--ws-external"
-      - "--rpc-external"
-  
-  polkadot-master:
-    image: parity/polkadot:latest
-    ports:
-      - "9948:9944"
-      - "9938:9933"
-    networks:
-      - internet
-    command:
-      - "--dev"
-      - "--ws-external"
-      - "--rpc-external"
-
-  polkadot-alexander:
-      image: parity/polkadot:v0.4.4
-      ports:
-        - "9949:9944"
-        - "9939:9933"
-      networks:
-        - internet
-      command:
-        - "--dev"
-        - "--ws-external"
-        - "--rpc-external"
-
-  # This is the container running the API tests
-  js-api-tests:
-    image: node:11
-    volumes: 
-      - ./:/polkadot-js/api
-    working_dir: /polkadot-js/api
-    network_mode: host
-    tty: true
-    environment: 
-      - TERM=xterm-256color`
-    command: bash -c "NODE_ENV=abc /usr/local/bin/yarn && /usr/local/bin/yarn test:all"
-
-networks:
-  internet:

jest.config.js

@@ -1,29 +1,30 @@
 // Copyright 2017-2020 @polkadot/api authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-const config = require('@polkadot/dev/config/jest');
+const config = require('@polkadot/dev/config/jest.cjs');
 
 module.exports = Object.assign({}, config, {
   moduleNameMapper: {
-    '@polkadot/api-contract(.*)$': '<rootDir>/packages/api-contract/src/$1',
-    '@polkadot/api-derive(.*)$': '<rootDir>/packages/api-derive/src/$1',
+    '@polkadot/api-(contract|derive)(.*)$': '<rootDir>/packages/api-$1/src/$2',
     // eslint-disable-next-line sort-keys
     '@polkadot/api(.*)$': '<rootDir>/packages/api/src/$1',
     '@polkadot/metadata(.*)$': '<rootDir>/packages/metadata/src/$1',
     '@polkadot/rpc-(core|provider)(.*)$': '<rootDir>/packages/rpc-$1/src/$2',
+    '@polkadot/typegen(.*)$': '<rootDir>/packages/typegen/src/$1',
     '@polkadot/types-known(.*)$': '<rootDir>/packages/types-known/src/$1',
     // eslint-disable-next-line sort-keys
     '@polkadot/types(.*)$': '<rootDir>/packages/types/src/$1'
   },
   modulePathIgnorePatterns: [
     '<rootDir>/packages/api/build',
-    '<rootDir>/packages/api-derive/build',
     '<rootDir>/packages/api-contract/build',
+    '<rootDir>/packages/api-derive/build',
     '<rootDir>/packages/metadata/build',
     '<rootDir>/packages/rpc-core/build',
     '<rootDir>/packages/rpc-provider/build',
+    '<rootDir>/packages/typegen/build',
     '<rootDir>/packages/types/build',
     '<rootDir>/packages/types-known/build'
   ],
-  resolver: '@polkadot/dev/config/jest-resolver'
+  resolver: '@polkadot/dev/config/jest-resolver.cjs'
 });

package.json

@@ -7,8 +7,7 @@
     "packages/*"
   ],
   "resolutions": {
-    "babel-core": "^7.0.0-bridge.0",
-    "typescript": "^4.0.5"
+    "typescript": "^4.1.2"
   },
   "scripts": {
     "build": "yarn build:interfaces && polkadot-dev-build-ts && (cd packages/typegen && copyfiles scripts/* build)",
@@ -24,14 +23,14 @@
     "test:watch": "polkadot-dev-run-test --watch"
   },
   "devDependencies": {
-    "@babel/core": "^7.12.3",
+    "@babel/core": "^7.12.8",
     "@babel/register": "^7.12.1",
-    "@babel/runtime": "^7.12.1",
-    "@polkadot/dev": "^0.59.14",
-    "@polkadot/ts": "^0.3.53",
+    "@babel/runtime": "^7.12.5",
+    "@polkadot/dev": "^0.60.5",
+    "@polkadot/ts": "^0.3.55",
     "@polkadot/typegen": "workspace:packages/typegen",
     "@types/jest": "^26.0.15",
     "copyfiles": "^2.4.0"
   },
-  "version": "2.5.1"
+  "version": "2.9.1"
 }

packages/api-contract/package.json

@@ -1,37 +1,26 @@
 {
   "name": "@polkadot/api-contract",
-  "version": "2.5.1",
+  "version": "2.9.1",
   "description": "Interfaces for interacting with contracts and contract ABIs",
   "main": "index.js",
+  "sideEffects": false,
   "keywords": [
     "Polkadot",
     "ABI"
   ],
   "author": "Jaco Greeff <jacogr@gmail.com>",
-  "maintainers": [
-    "Jaco Greeff <jacogr@gmail.com>"
-  ],
+  "maintainers": [],
   "contributors": [],
   "license": "Apache-2.0",
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/polkadot-js/api.git"
-  },
-  "bugs": {
-    "url": "https://github.com/polkadot-js/api/issues"
-  },
+  "repository": "github:polkadot-js/api",
+  "bugs": "https://github.com/polkadot-js/api/issues",
   "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-contract#readme",
   "dependencies": {
-    "@babel/runtime": "^7.12.1",
-    "@polkadot/api": "^2.5.1",
-    "@polkadot/rpc-core": "^2.5.1",
-    "@polkadot/types": "^2.5.1",
-    "@polkadot/util": "^3.7.1",
-    "bn.js": "^5.1.3",
+    "@babel/runtime": "^7.12.5",
+    "@polkadot/api": "2.9.1",
+    "@polkadot/types": "2.9.1",
+    "@polkadot/util": "^4.2.1",
+    "bn.js": "^4.11.9",
     "rxjs": "^6.6.3"
   }
 }

packages/api-contract/src/Abi.spec.ts

@@ -1,11 +1,9 @@
 // Copyright 2017-2020 @polkadot/api-contract authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import Abi from './Abi';
+import { Abi } from '.';
 
-import * as testContracts from '../test/contracts';
-
-const abis: Record<string, any> = { ...testContracts };
+import abis from '../test/contracts';
 
 interface JSONAbi {
   spec: {

packages/api-contract/src/Abi.ts

@@ -5,9 +5,12 @@ import { AnyJson, Codec, CodecArg } from '@polkadot/types/types';
 import { ChainProperties, ContractConstructorSpec, ContractEventSpec, ContractMessageSpec, ContractMessageParamSpec, ContractProject } from '@polkadot/types/interfaces';
 import { AbiConstructor, AbiEvent, AbiMessage, AbiParam, DecodedEvent, DecodedMessage } from './types';
 
+import { Bytes } from '@polkadot/types';
 import { assert, assertReturn, compactAddLength, compactStripLength, isNumber, isObject, isString, logger, stringCamelCase, u8aConcat, u8aToHex } from '@polkadot/util';
 
-import MetaRegistry from './MetaRegistry';
+import { MetaRegistry } from './MetaRegistry';
+
+const EMPTY_U8A = new Uint8Array();
 
 const l = logger('Abi');
 
@@ -21,7 +24,7 @@ function findMessage <T extends AbiMessage> (list: T[], messageOrId: T | string
   return assertReturn(message, `Attempted to call an invalid contract interface, ${JSON.stringify(messageOrId)}`);
 }
 
-export default class Abi {
+export class Abi {
   readonly #events: AbiEvent[];
 
   public readonly constructors: AbiConstructor[];
@@ -74,7 +77,7 @@ export default class Abi {
   /**
    * Warning: Unstable API, bound to change
    */
-  public decodeEvent (data: Uint8Array): DecodedEvent {
+  public decodeEvent (data: Bytes | Uint8Array): DecodedEvent {
     const index = data[0];
     const event = this.#events[index];
 
@@ -151,8 +154,8 @@ export default class Abi {
       identifier: spec.name.toString(),
       index,
       selector: spec.selector,
-      toU8a: (params: CodecArg[]) =>
-        this.#encodeArgs(spec, args, params)
+      toU8a: (params: CodecArg[], additional?: Uint8Array) =>
+        this.#encodeArgs(spec, args, params, additional)
     };
 
     return message;
@@ -182,13 +185,14 @@ export default class Abi {
     return message.fromU8a(trimmed.subarray(4));
   }
 
-  #encodeArgs = ({ name, selector }: ContractMessageSpec | ContractConstructorSpec, args: AbiParam[], data: CodecArg[]): Uint8Array => {
+  #encodeArgs = ({ name, selector }: ContractMessageSpec | ContractConstructorSpec, args: AbiParam[], data: CodecArg[], additional = EMPTY_U8A): Uint8Array => {
     assert(data.length === args.length, `Expected ${args.length} arguments to contract message '${name.toString()}', found ${data.length}`);
 
     return compactAddLength(
       u8aConcat(
         this.registry.createType('ContractSelector', selector).toU8a(),
-        ...args.map(({ type }, index) => this.registry.createType(type.type as 'Text', data[index]).toU8a())
+        ...args.map(({ type }, index) => this.registry.createType(type.type as 'Text', data[index]).toU8a()),
+        additional
       )
     );
   }

packages/api-contract/src/MetaRegistry.spec.ts

@@ -4,11 +4,9 @@
 import fs from 'fs';
 import path from 'path';
 
-import Abi from './Abi';
+import { Abi } from '.';
 
-import * as testContracts from '../test/contracts';
-
-const abis: Record<string, any> = { ...testContracts };
+import abis from '../test/contracts';
 
 describe('MetaRegistry', (): void => {
   Object.keys(abis).forEach((abiName) => {
@@ -33,6 +31,6 @@ describe('MetaRegistry', (): void => {
   });
 
   it('stores base project as JSON', (): void => {
-    expect(new Abi(abis.dns).json).toEqual(abis.dns);
+    expect(new Abi(abis.ink_dns).json).toEqual(abis.ink_dns);
   });
 });

packages/api-contract/src/MetaRegistry.ts

@@ -5,7 +5,7 @@ import { ContractDisplayName, ChainProperties, SiField, SiLookupTypeId, SiType,
 import { InterfaceTypes, TypeDef, TypeDefInfo } from '@polkadot/types/types';
 
 import { assert, isUndefined } from '@polkadot/util';
-import { TypeRegistry, withTypeString } from '@polkadot/types';
+import { TypeRegistry, withTypeString } from '@polkadot/types/create';
 
 interface PartialTypeSpec {
   readonly type: SiLookupTypeId;
@@ -24,7 +24,7 @@ const PRIMITIVE_ALIAS: Record<string, keyof InterfaceTypes> = {
 
 const PRIMITIVE_ALWAYS = ['AccountId', 'AccountIndex', 'Address', 'Balance'];
 
-export default class MetaRegistry extends TypeRegistry {
+export class MetaRegistry extends TypeRegistry {
   public readonly metaTypeDefs: TypeDef[] = [];
 
   #siTypes: SiType[] = [];
@@ -119,7 +119,7 @@ export default class MetaRegistry extends TypeRegistry {
         : {}
       ),
       ...(type.params.length > 0
-        ? { params: type.params.map((type) => this.getMetaTypeDef({ type })) }
+        ? { sub: type.params.map((type) => this.getMetaTypeDef({ type })) }
         : {}
       ),
       ...typeDef

packages/api-contract/src/base/Base.ts

@@ -4,12 +4,12 @@
 import { ApiTypes, DecorateMethod } from '@polkadot/api/types';
 import { AnyJson, Registry } from '@polkadot/types/types';
 
-import ApiBase from '@polkadot/api/base';
+import { ApiBase } from '@polkadot/api/base';
 import { assert } from '@polkadot/util';
 
-import Abi from '../Abi';
+import { Abi } from '../Abi';
 
-export default abstract class Base<ApiType extends ApiTypes> {
+export abstract class Base<ApiType extends ApiTypes> {
   public readonly abi: Abi;
 
   public readonly api: ApiBase<ApiType>;

packages/api-contract/src/base/Blueprint.ts

@@ -5,18 +5,44 @@ import { ApiTypes, DecorateMethod } from '@polkadot/api/types';
 import { SubmittableExtrinsic } from '@polkadot/api/submittable/types';
 import { AccountId, EventRecord, Hash } from '@polkadot/types/interfaces';
 import { AnyJson, CodecArg, ISubmittableResult } from '@polkadot/types/types';
-import { AbiConstructor } from '../types';
-import { MapConstructorExec } from './types';
+import { AbiConstructor, BlueprintOptions } from '../types';
+import { BlueprintDeploy, ContractGeneric, MapConstructorExec } from './types';
 
 import BN from 'bn.js';
 import { SubmittableResult } from '@polkadot/api';
-import ApiBase from '@polkadot/api/base';
-import { isUndefined, stringCamelCase } from '@polkadot/util';
+import { ApiBase } from '@polkadot/api/base';
+import { Bytes } from '@polkadot/types';
+import { isUndefined, stringCamelCase, compactAddLength, u8aToU8a } from '@polkadot/util';
+import { randomAsU8a } from '@polkadot/util-crypto';
 
-import Abi from '../Abi';
-import { applyOnEvent } from '../util';
-import Base from './Base';
-import Contract from './Contract';
+import { Abi } from '../Abi';
+import { applyOnEvent, extractOptions, isOptions } from '../util';
+import { Base } from './Base';
+import { Contract } from './Contract';
+
+const EMPTY_SALT = new Uint8Array();
+
+function createTx <ApiType extends ApiTypes> (fn: (options: BlueprintOptions, params: CodecArg[]) => SubmittableExtrinsic<ApiType, BlueprintSubmittableResult<ApiType>>): BlueprintDeploy<ApiType> {
+  return (options: BigInt | string | number | BN | BlueprintOptions, ...params: CodecArg[]): SubmittableExtrinsic<ApiType, BlueprintSubmittableResult<ApiType>> =>
+    isOptions(options)
+      ? fn(options, params)
+      : fn(...extractOptions(options, params));
+}
+
+function createWithId <T> (fn: (constructorOrId: AbiConstructor | string | number, options: BlueprintOptions, params: CodecArg[]) => T): ContractGeneric<BlueprintOptions, T> {
+  return (constructorOrId: AbiConstructor | string | number, options: BigInt | string | number | BN | BlueprintOptions, ...params: CodecArg[]): T =>
+    isOptions(options)
+      ? fn(constructorOrId, options, params)
+      : fn(constructorOrId, ...extractOptions(options, params));
+}
+
+function encodeSalt (salt: Uint8Array | string | null = randomAsU8a()) {
+  return salt instanceof Bytes
+    ? salt
+    : salt && salt.length
+      ? compactAddLength(u8aToU8a(salt))
+      : EMPTY_SALT;
+}
 
 export class BlueprintSubmittableResult<ApiType extends ApiTypes> extends SubmittableResult {
   public readonly contract?: Contract<ApiType>;
@@ -28,22 +54,31 @@ export class BlueprintSubmittableResult<ApiType extends ApiTypes> extends Submit
   }
 }
 
-export default class Blueprint<ApiType extends ApiTypes> extends Base<ApiType> {
+export class Blueprint<ApiType extends ApiTypes> extends Base<ApiType> {
+  /**
+   * @description The on-chain code hash for this blueprint
+   */
   public readonly codeHash: Hash;
 
+  /**
+   * @deprecated
+   * @description Deprecated. Use `.tx.<constructorName>`. Creates a contract in a non-deterministic way.
+   */
+  public readonly createContract: ContractGeneric<BlueprintOptions, SubmittableExtrinsic<ApiType, BlueprintSubmittableResult<ApiType>>>;
+
   readonly #tx: MapConstructorExec<ApiType> = {};
 
   constructor (api: ApiBase<ApiType>, abi: AnyJson | Abi, codeHash: string | Hash | Uint8Array, decorateMethod: DecorateMethod<ApiType>) {
     super(api, abi, decorateMethod);
 
     this.codeHash = this.registry.createType('Hash', codeHash);
+    this.createContract = createWithId(this.#deploy);
 
     this.abi.constructors.forEach((c): void => {
       const messageName = stringCamelCase(c.identifier);
 
       if (isUndefined(this.#tx[messageName])) {
-        this.#tx[messageName] = (endowment: BigInt | string | number | BN, gasLimit: BigInt | string | number | BN, ...params: CodecArg[]) =>
-          this.#deploy(c, endowment, gasLimit, params);
+        this.#tx[messageName] = createTx((o, p) => this.#deploy(c, o, p));
       }
     });
   }
@@ -52,17 +87,20 @@ export default class Blueprint<ApiType extends ApiTypes> extends Base<ApiType> {
     return this.#tx;
   }
 
-  #deploy = (constructorOrId: AbiConstructor | string| number, endowment: BigInt | string | number | BN, gasLimit: BigInt | string | number | BN, params: CodecArg[]): SubmittableExtrinsic<ApiType, BlueprintSubmittableResult<ApiType>> => {
-    return this.api.tx.contracts
-      .instantiate(endowment, gasLimit, this.codeHash, this.abi.findConstructor(constructorOrId).toU8a(params))
-      .withResultTransform((result: ISubmittableResult) =>
-        new BlueprintSubmittableResult(result, applyOnEvent(result, 'Instantiated', ([record]: EventRecord[]) =>
-          new Contract<ApiType>(this.api, this.abi, record.event.data[1] as AccountId, this._decorateMethod)
-        ))
-      );
-  }
+  #deploy = (constructorOrId: AbiConstructor | string| number, { gasLimit = 0, salt, value = 0 }: BlueprintOptions, params: CodecArg[]): SubmittableExtrinsic<ApiType, BlueprintSubmittableResult<ApiType>> => {
+    const encodedSalt = encodeSalt(salt);
+    const withSalt = this.api.tx.contracts.instantiate.meta.args.length === 5;
+    const encoded = this.abi.findConstructor(constructorOrId).toU8a(params, withSalt ? EMPTY_SALT : encodedSalt);
+    const tx = withSalt
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore new style with salt included
+      ? this.api.tx.contracts.instantiate(value, gasLimit, this.codeHash, encoded, encodedSalt)
+      : this.api.tx.contracts.instantiate(value, gasLimit, this.codeHash, encoded);
 
-  public createContract (constructorOrId: AbiConstructor | string| number, endowment: BigInt | string | number | BN, gasLimit: BigInt | string | number | BN, ...params: CodecArg[]): SubmittableExtrinsic<ApiType, BlueprintSubmittableResult<ApiType>> {
-    return this.#deploy(constructorOrId, endowment, gasLimit, params);
+    return tx.withResultTransform((result: ISubmittableResult) =>
+      new BlueprintSubmittableResult(result, applyOnEvent(result, 'Instantiated', ([record]: EventRecord[]) =>
+        new Contract<ApiType>(this.api, this.abi, record.event.data[1] as AccountId, this._decorateMethod)
+      ))
+    );
   }
 }

packages/api-contract/src/base/Code.spec.ts

@@ -0,0 +1,27 @@
+// Copyright 2017-2020 @polkadot/api-contract authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import fs from 'fs';
+import path from 'path';
+import { decorateMethod } from '@polkadot/api/promise';
+
+import contractFlipper from '../../test/contracts/ink/flipper.contract.json';
+import abiFlipper from '../../test/contracts/ink/flipper.json';
+import { mockApi } from './mock';
+import { Code } from './Code';
+
+const wasmFlipper = fs.readFileSync(path.join(__dirname, '../../test/contracts/ink/flipper.wasm'));
+
+describe('Code', (): void => {
+  it('can construct with an individual ABI/WASM combo', (): void => {
+    expect(
+      () => new Code(mockApi, abiFlipper, wasmFlipper, decorateMethod)
+    ).not.toThrow();
+  });
+
+  it('can construct with an .contract ABI', (): void => {
+    expect(
+      () => new Code(mockApi, contractFlipper, null, decorateMethod)
+    ).not.toThrow();
+  });
+});

packages/api-contract/src/base/Code.ts

@@ -7,13 +7,13 @@ import { EventRecord, Hash } from '@polkadot/types/interfaces';
 import { AnyJson, ISubmittableResult } from '@polkadot/types/types';
 
 import { SubmittableResult } from '@polkadot/api';
-import ApiBase from '@polkadot/api/base';
-import { compactAddLength, u8aToU8a } from '@polkadot/util';
+import { ApiBase } from '@polkadot/api/base';
+import { assert, compactAddLength, isWasm, u8aToU8a } from '@polkadot/util';
 
-import Abi from '../Abi';
+import { Abi } from '../Abi';
 import { applyOnEvent } from '../util';
-import Base from './Base';
-import Blueprint from './Blueprint';
+import { Base } from './Base';
+import { Blueprint } from './Blueprint';
 
 export class CodeSubmittableResult<ApiType extends ApiTypes> extends SubmittableResult {
   public readonly blueprint?: Blueprint<ApiType>;
@@ -25,15 +25,22 @@ export class CodeSubmittableResult<ApiType extends ApiTypes> extends Submittable
   }
 }
 
-export default class Code<ApiType extends ApiTypes> extends Base<ApiType> {
+export class Code<ApiType extends ApiTypes> extends Base<ApiType> {
   public readonly code: Uint8Array;
 
-  constructor (api: ApiBase<ApiType>, abi: AnyJson | Abi, wasm: Uint8Array | string | Buffer, decorateMethod: DecorateMethod<ApiType>) {
+  constructor (api: ApiBase<ApiType>, abi: AnyJson | Abi, wasm: Uint8Array | string | Buffer | null | undefined, decorateMethod: DecorateMethod<ApiType>) {
     super(api, abi, decorateMethod);
 
-    this.code = u8aToU8a(wasm);
+    this.code = isWasm(this.abi.project.source.wasm)
+      ? this.abi.project.source.wasm
+      : u8aToU8a(wasm);
+
+    assert(isWasm(this.code), 'No WASM code provided');
   }
 
+  /**
+   * @description Deploy the code bundle, creating a Blueprint.
+   */
   public createBlueprint (): SubmittableExtrinsic<ApiType, CodeSubmittableResult<ApiType>> {
     return this.api.tx.contracts
       .putCode(compactAddLength(this.code))

packages/api-contract/src/base/Contract.ts

@@ -5,22 +5,46 @@ import { ApiTypes, DecorateMethod } from '@polkadot/api/types';
 import { SubmittableExtrinsic } from '@polkadot/api/submittable/types';
 import { AccountId, ContractExecResult, EventRecord } from '@polkadot/types/interfaces';
 import { AnyJson, CodecArg, ISubmittableResult, Registry } from '@polkadot/types/types';
-import { AbiMessage, ContractCallOutcome, DecodedEvent } from '../types';
-import { ContractRead, MapMessageExec, MapMessageRead } from './types';
+import { AbiMessage, ContractCallOutcome, ContractOptions, DecodedEvent } from '../types';
+import { ContractCallResult, ContractCallSend, ContractGeneric, ContractQuery, ContractTx, MapMessageQuery, MapMessageTx } from './types';
 
 import BN from 'bn.js';
 import { map } from 'rxjs/operators';
 import { SubmittableResult } from '@polkadot/api';
-import ApiBase from '@polkadot/api/base';
+import { ApiBase } from '@polkadot/api/base';
+import { Bytes } from '@polkadot/types';
 import { assert, bnToBn, isFunction, isUndefined, logger, stringCamelCase } from '@polkadot/util';
 
-import Abi from '../Abi';
-import { applyOnEvent, formatData } from '../util';
-import Base from './Base';
+import { Abi } from '../Abi';
+import { applyOnEvent, extractOptions, formatData, isOptions } from '../util';
+import { Base } from './Base';
 
+// As per Rust, 5 * GAS_PER_SEC
+const MAX_CALL_GAS = new BN(5_000_000_000_000).subn(1);
 const ERROR_NO_CALL = 'Your node does not expose the contracts.call RPC. This is most probably due to a runtime configuration.';
 const l = logger('Contract');
 
+function createQuery <ApiType extends ApiTypes> (fn: (origin: string | AccountId | Uint8Array, options: ContractOptions, params: CodecArg[]) => ContractCallResult<ApiType, ContractCallOutcome>): ContractQuery<ApiType> {
+  return (origin: string | AccountId | Uint8Array, options: BigInt | string | number | BN | ContractOptions, ...params: CodecArg[]): ContractCallResult<ApiType, ContractCallOutcome> =>
+    isOptions(options)
+      ? fn(origin, options, params)
+      : fn(origin, ...extractOptions(options, params));
+}
+
+function createTx <ApiType extends ApiTypes> (fn: (options: ContractOptions, params: CodecArg[]) => SubmittableExtrinsic<ApiType>): ContractTx<ApiType> {
+  return (options: BigInt | string | number | BN | ContractOptions, ...params: CodecArg[]): SubmittableExtrinsic<ApiType> =>
+    isOptions(options)
+      ? fn(options, params)
+      : fn(...extractOptions(options, params));
+}
+
+function createWithId <T> (fn: (messageOrId: AbiMessage | string | number, options: ContractOptions, params: CodecArg[]) => T): ContractGeneric<ContractOptions, T> {
+  return (messageOrId: AbiMessage | string | number, options: BigInt | string | number | BN | ContractOptions, ...params: CodecArg[]): T =>
+    isOptions(options)
+      ? fn(messageOrId, options, params)
+      : fn(messageOrId, ...extractOptions(options, params));
+}
+
 export class ContractSubmittableResult extends SubmittableResult {
   public readonly contractEvents?: DecodedEvent[];
 
@@ -58,29 +82,44 @@ function mapExecResult (registry: Registry, json: Record<string, AnyJson>): Cont
   return registry.createType('ContractExecResult', { result: { err: { other: 'unknown' } } });
 }
 
-export default class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
+export class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
+  /**
+   * @description The on-chain address for this contract
+   */
   public readonly address: AccountId;
 
-  readonly #tx: MapMessageExec<ApiType> = {};
+  /**
+   * @deprecated
+   * @description Deprecated. Use `.tx.<messageName>` to send a transaction.
+   */
+  public readonly exec: ContractGeneric<ContractOptions, SubmittableExtrinsic<ApiType>>;
 
-  readonly #query: MapMessageRead<ApiType> = {};
+  /**
+   * @deprecated
+   * @description Deprecated. Use `.tx.<messageName>` to send a transaction.
+   */
+  public readonly read: ContractGeneric<ContractOptions, ContractCallSend<ApiType>>;
+
+  readonly #query: MapMessageQuery<ApiType> = {};
+
+  readonly #tx: MapMessageTx<ApiType> = {};
 
   constructor (api: ApiBase<ApiType>, abi: AnyJson | Abi, address: string | AccountId, decorateMethod: DecorateMethod<ApiType>) {
     super(api, abi, decorateMethod);
 
     this.address = this.registry.createType('AccountId', address);
+    this.exec = createWithId(this.#exec);
+    this.read = createWithId(this.#read);
 
     this.abi.messages.forEach((m): void => {
       const messageName = stringCamelCase(m.identifier);
 
       if (isUndefined(this.#tx[messageName])) {
-        this.#tx[messageName] = (value: BigInt | BN | string | number, gasLimit: BigInt | BN | string | number, ...params: CodecArg[]) =>
-          this.#exec(m, value, gasLimit, params);
+        this.#tx[messageName] = createTx((o, p) => this.#exec(m, o, p));
       }
 
       if (isUndefined(this.#query[messageName])) {
-        this.#query[messageName] = (origin: string | AccountId | Uint8Array, value: BigInt | BN | string | number, gasLimit: BigInt | BN | string | number, ...params: CodecArg[]) =>
-          this.#read(m, value, gasLimit, params).send(origin);
+        this.#query[messageName] = createQuery((f, o, p) => this.#read(m, o, p).send(f));
       }
     });
   }
@@ -89,25 +128,27 @@ export default class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
     return isFunction(this.api.rx.rpc.contracts?.call);
   }
 
-  public get query (): MapMessageRead<ApiType> {
+  public get query (): MapMessageQuery<ApiType> {
     assert(this.hasRpcContractsCall, ERROR_NO_CALL);
 
     return this.#query;
   }
 
-  public get tx (): MapMessageExec<ApiType> {
+  public get tx (): MapMessageTx<ApiType> {
     return this.#tx;
   }
 
-  #getGas = (_gasLimit: BigInt | BN | string | number): BN => {
+  #getGas = (_gasLimit: BigInt | BN | string | number, isCall = false): BN => {
     const gasLimit = bnToBn(_gasLimit);
 
     return gasLimit.lten(0)
-      ? this.api.consts.system.maximumBlockWeight.muln(64).divn(100)
+      ? isCall
+        ? MAX_CALL_GAS
+        : this.api.consts.system.maximumBlockWeight.muln(64).divn(100)
       : gasLimit;
   }
 
-  #exec = (messageOrId: AbiMessage | string | number, value: BigInt | BN | string | number, gasLimit: BigInt | BN | string | number, params: CodecArg[]): SubmittableExtrinsic<ApiType> => {
+  #exec = (messageOrId: AbiMessage | string | number, { gasLimit = 0, value = 0 }: ContractOptions, params: CodecArg[]): SubmittableExtrinsic<ApiType> => {
     return this.api.tx.contracts
       .call(this.address, value, this.#getGas(gasLimit), this.abi.findMessage(messageOrId).toU8a(params))
       .withResultTransform((result: ISubmittableResult) =>
@@ -115,7 +156,7 @@ export default class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
           records
             .map(({ event: { data: [, data] } }): DecodedEvent | null => {
               try {
-                return this.abi.decodeEvent(data.toU8a());
+                return this.abi.decodeEvent(data as Bytes);
               } catch (error) {
                 l.error(`Unable to decode contract event: ${(error as Error).message}`);
 
@@ -127,7 +168,7 @@ export default class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
       );
   }
 
-  #read = (messageOrId: AbiMessage | string | number, value: BigInt | BN | string | number, gasLimit: BigInt | BN | string | number, params: CodecArg[]): ContractRead<ApiType> => {
+  #read = (messageOrId: AbiMessage | string | number, { gasLimit = 0, value = 0 }: ContractOptions, params: CodecArg[]): ContractCallSend<ApiType> => {
     assert(this.hasRpcContractsCall, ERROR_NO_CALL);
 
     const message = this.abi.findMessage(messageOrId);
@@ -137,7 +178,7 @@ export default class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
       send: this._decorateMethod((origin: string | AccountId | Uint8Array) =>
         this.api.rx.rpc.contracts.call.json({
           dest: this.address,
-          gasLimit: this.#getGas(gasLimit),
+          gasLimit: this.#getGas(gasLimit, true),
           inputData: message.toU8a(params),
           origin,
           value
@@ -156,12 +197,4 @@ export default class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
       )
     };
   }
-
-  public exec (messageOrId: AbiMessage | string | number, value: BigInt | BN | string | number, gasLimit: BigInt | BN | string | number, ...params: CodecArg[]): SubmittableExtrinsic<ApiType> {
-    return this.#exec(messageOrId, value, gasLimit, params);
-  }
-
-  public read (messageOrId: AbiMessage | string | number, value: BigInt | BN | string | number, gasLimit: BigInt | BN | string | number, ...params: CodecArg[]): ContractRead<ApiType> {
-    return this.#read(messageOrId, value, gasLimit, params);
-  }
 }

packages/api-contract/src/base/index.ts

@@ -1,6 +1,6 @@
 // Copyright 2017-2020 @polkadot/api authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-export { default as Blueprint, BlueprintSubmittableResult } from './Blueprint';
-export { default as Code, CodeSubmittableResult } from './Code';
-export { default as Contract } from './Contract';
+export { Blueprint, BlueprintSubmittableResult } from './Blueprint';
+export { Code, CodeSubmittableResult } from './Code';
+export { Contract } from './Contract';

packages/api-contract/src/base/mock.ts

@@ -0,0 +1,20 @@
+// Copyright 2017-2020 @polkadot/api-contract authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { ApiBase } from '@polkadot/api/base';
+import { TypeRegistry } from '@polkadot/types';
+
+const registry = new TypeRegistry();
+
+export const mockApi = {
+  registry,
+  rx: {
+    tx: {
+      contracts: {
+        putCode: (): never => {
+          throw new Error('mock');
+        }
+      }
+    }
+  }
+} as unknown as ApiBase<'promise'>;

packages/api-contract/src/base/types.ts

@@ -5,27 +5,47 @@ import { ApiTypes, ObsInnerType } from '@polkadot/api/types';
 import { SubmittableExtrinsic } from '@polkadot/api/submittable/types';
 import { AccountId } from '@polkadot/types/interfaces';
 import { CodecArg } from '@polkadot/types/types';
-import { ContractCallOutcome } from '../types';
+import { AbiMessage, BlueprintOptions, ContractCallOutcome, ContractOptions } from '../types';
 
 import BN from 'bn.js';
 import { Observable } from 'rxjs';
 
-type ContractCallResult<ApiType extends ApiTypes, T> = ApiType extends 'rxjs'
+export interface BlueprintDeploy<ApiType extends ApiTypes> {
+  (options: BlueprintOptions, ...params: CodecArg[]): SubmittableExtrinsic<ApiType>;
+  (value: BigInt | string | number | BN, gasLimit: BigInt | string | number | BN, ...params: CodecArg[]): SubmittableExtrinsic<ApiType>;
+}
+
+export interface ContractQuery<ApiType extends ApiTypes> {
+  (origin: AccountId | string | Uint8Array, options: ContractOptions, ...params: CodecArg[]): ContractCallResult<ApiType, ContractCallOutcome>;
+  (origin: AccountId | string | Uint8Array, value: BigInt | BN | string | number, gasLimit: BigInt | BN | string | number, ...params: CodecArg[]): ContractCallResult<ApiType, ContractCallOutcome>;
+}
+
+export interface ContractTx<ApiType extends ApiTypes> {
+  (options: ContractOptions, ...params: CodecArg[]): SubmittableExtrinsic<ApiType>;
+  (value: BigInt | BN | string | number, gasLimit: BigInt | BN | string | number, ...params: CodecArg[]): SubmittableExtrinsic<ApiType>;
+}
+
+export interface ContractGeneric<O, T> {
+  (messageOrId: AbiMessage | string | number, options: O, ...params: CodecArg[]): T;
+  (messageOrId: AbiMessage | string | number, value: BigInt | BN | string | number, gasLimit: BigInt | BN | string | number, ...params: CodecArg[]): T;
+}
+
+export type ContractCallResult<ApiType extends ApiTypes, T> = ApiType extends 'rxjs'
   ? Observable<Observable<T>>
   : Promise<ObsInnerType<Observable<T>>>;
 
-export interface ContractRead<ApiType extends ApiTypes> {
+export interface ContractCallSend<ApiType extends ApiTypes> {
   send (account: string | AccountId | Uint8Array): ContractCallResult<ApiType, ContractCallOutcome>;
 }
 
 export interface MapConstructorExec<ApiType extends ApiTypes> {
-  [message: string]: (endowment: BigInt | string | number | BN, gasLimit: BigInt | string | number | BN, ...params: CodecArg[]) => SubmittableExtrinsic<ApiType>;
+  [message: string]: BlueprintDeploy<ApiType>;
 }
 
-export interface MapMessageExec<ApiType extends ApiTypes> {
-  [message: string]: (value: BigInt | BN | string | number, gasLimit: BigInt | BN | string | number, ...params: CodecArg[]) => SubmittableExtrinsic<ApiType>;
+export interface MapMessageTx<ApiType extends ApiTypes> {
+  [message: string]: ContractTx<ApiType>;
 }
 
-export interface MapMessageRead<ApiType extends ApiTypes> {
-  [message: string]: (origin: AccountId | string | Uint8Array, value: BigInt | BN | string | number, gasLimit: BigInt | BN | string | number, ...params: CodecArg[]) => ContractCallResult<ApiType, ContractCallOutcome>;
+export interface MapMessageQuery<ApiType extends ApiTypes> {
+  [message: string]: ContractQuery<ApiType>;
 }

packages/api-contract/src/checkTypes.manual.ts

@@ -0,0 +1,51 @@
+// Copyright 2017-2020 @polkadot/api-contract authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Simple non-runnable checks to test type definitions in the editor itself
+
+import { ApiPromise } from '@polkadot/api';
+import { TestKeyringMap, createTestPairs } from '@polkadot/keyring/testingPairs';
+
+import abiIncrementer from '../test/contracts/ink/incrementer.json';
+import { BlueprintPromise, ContractPromise } from '.';
+
+async function checkBlueprint (api: ApiPromise, pairs: TestKeyringMap): Promise<void> {
+  const blueprint = new BlueprintPromise(api, abiIncrementer, '0x1234');
+
+  // new style
+  await blueprint.tx.new({ gasLimit: 456, salt: '0x1234', value: 123 }, 42).signAndSend(pairs.bob);
+  await blueprint.tx.new({ gasLimit: 456, value: 123 }, 42).signAndSend(pairs.bob);
+
+  // old style
+  await blueprint.tx.new(123, 456, 42).signAndSend(pairs.bob);
+}
+
+async function checkContract (api: ApiPromise, pairs: TestKeyringMap): Promise<void> {
+  const contract = new ContractPromise(api, abiIncrementer, '0x1234');
+
+  // queries
+  await contract.query.get(pairs.alice.address, {});
+  await contract.query.get(pairs.alice.address, 0, 0);
+
+  // execute
+  await contract.tx.inc({ gasLimit: 1234 }, 123).signAndSend(pairs.eve);
+  await contract.tx.inc(123, 456, 69).signAndSend(pairs.eve);
+
+  // deprecated
+  await contract.read('get', {}).send(pairs.eve.address);
+  await contract.exec('inc', {}, 123).signAndSend(pairs.dave);
+}
+
+async function main (): Promise<void> {
+  const api = await ApiPromise.create();
+  const pairs = createTestPairs();
+
+  // eslint-disable-next-line @typescript-eslint/no-floating-promises
+  Promise.all([
+    checkBlueprint(api, pairs),
+    checkContract(api, pairs)
+  ]);
+}
+
+// eslint-disable-next-line @typescript-eslint/unbound-method
+main().catch(console.error);

packages/api-contract/src/index.ts

@@ -1,7 +1,7 @@
 // Copyright 2017-2020 @polkadot/api-contract authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-export { default as Abi } from './Abi';
+export { Abi } from './Abi';
 
 export { Blueprint as BlueprintRx, Code as CodeRx, Contract as ContractRx } from './rx';
 export { Blueprint as BlueprintPromise, Code as CodePromise, Contract as ContractPromise } from './promise';

packages/api-contract/src/promise/Blueprint.ts

@@ -7,10 +7,10 @@ import { AnyJson } from '@polkadot/types/types';
 import { ApiPromise } from '@polkadot/api';
 import { decorateMethod } from '@polkadot/api/promise';
 
-import Abi from '../Abi';
-import BaseBlueprint from '../base/Blueprint';
+import { Abi } from '../Abi';
+import { Blueprint as BaseBlueprint } from '../base';
 
-export default class Blueprint extends BaseBlueprint<'promise'> {
+export class Blueprint extends BaseBlueprint<'promise'> {
   constructor (api: ApiPromise, abi: AnyJson | Abi, codeHash: string | Hash) {
     super(api, abi, codeHash, decorateMethod);
   }

packages/api-contract/src/promise/Code.ts

@@ -5,11 +5,11 @@ import { ApiPromise } from '@polkadot/api';
 import { decorateMethod } from '@polkadot/api/promise';
 import { AnyJson } from '@polkadot/types/types';
 
-import Abi from '../Abi';
-import BaseCode from '../base/Code';
+import { Abi } from '../Abi';
+import { Code as BaseCode } from '../base';
 
-export default class Code extends BaseCode<'promise'> {
-  constructor (api: ApiPromise, abi: AnyJson | Abi, wasm: Uint8Array | string | Buffer) {
+export class Code extends BaseCode<'promise'> {
+  constructor (api: ApiPromise, abi: AnyJson | Abi, wasm: Uint8Array | string | Buffer | null | undefined) {
     super(api, abi, wasm, decorateMethod);
   }
 }

packages/api-contract/src/promise/Contract.ts

@@ -7,10 +7,10 @@ import { AnyJson } from '@polkadot/types/types';
 import { ApiPromise } from '@polkadot/api';
 import { decorateMethod } from '@polkadot/api/promise';
 
-import Abi from '../Abi';
-import BaseContract from '../base/Contract';
+import { Abi } from '../Abi';
+import { Contract as BaseContract } from '../base';
 
-export default class Contract extends BaseContract<'promise'> {
+export class Contract extends BaseContract<'promise'> {
   constructor (api: ApiPromise, abi: AnyJson | Abi, address: string | AccountId) {
     super(api, abi, address, decorateMethod);
   }

packages/api-contract/src/promise/index.ts

@@ -1,6 +1,6 @@
 // Copyright 2017-2020 @polkadot/api-contract authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-export { default as Blueprint } from './Blueprint';
-export { default as Code } from './Code';
-export { default as Contract } from './Contract';
+export { Blueprint } from './Blueprint';
+export { Code } from './Code';
+export { Contract } from './Contract';

packages/api-contract/src/rx/Blueprint.ts

@@ -7,10 +7,10 @@ import { AnyJson } from '@polkadot/types/types';
 import { ApiRx } from '@polkadot/api';
 import { decorateMethod } from '@polkadot/api/rx';
 
-import Abi from '../Abi';
-import BaseBlueprint from '../base/Blueprint';
+import { Abi } from '../Abi';
+import { Blueprint as BaseBlueprint } from '../base';
 
-export default class Blueprint extends BaseBlueprint<'rxjs'> {
+export class Blueprint extends BaseBlueprint<'rxjs'> {
   constructor (api: ApiRx, abi: AnyJson | Abi, codeHash: string | Hash) {
     super(api, abi, codeHash, decorateMethod);
   }

packages/api-contract/src/rx/Code.ts

@@ -6,11 +6,11 @@ import { AnyJson } from '@polkadot/types/types';
 import { ApiRx } from '@polkadot/api';
 import { decorateMethod } from '@polkadot/api/rx';
 
-import Abi from '../Abi';
-import BaseCode from '../base/Code';
+import { Abi } from '../Abi';
+import { Code as BaseCode } from '../base';
 
-export default class Code extends BaseCode<'rxjs'> {
-  constructor (api: ApiRx, abi: AnyJson | Abi, wasm: Uint8Array | string | Buffer) {
+export class Code extends BaseCode<'rxjs'> {
+  constructor (api: ApiRx, abi: AnyJson | Abi, wasm: Uint8Array | string | Buffer | null | undefined) {
     super(api, abi, wasm, decorateMethod);
   }
 }

packages/api-contract/src/rx/Contract.ts

@@ -7,10 +7,10 @@ import { AnyJson } from '@polkadot/types/types';
 import { ApiRx } from '@polkadot/api';
 import { decorateMethod } from '@polkadot/api/rx';
 
-import Abi from '../Abi';
-import BaseContract from '../base/Contract';
+import { Abi } from '../Abi';
+import { Contract as BaseContract } from '../base';
 
-export default class Contract extends BaseContract<'rxjs'> {
+export class Contract extends BaseContract<'rxjs'> {
   constructor (api: ApiRx, abi: AnyJson | Abi, address: string | AccountId) {
     super(api, abi, address, decorateMethod);
   }

packages/api-contract/src/rx/index.ts

@@ -1,6 +1,6 @@
 // Copyright 2017-2020 @polkadot/api-contract authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-export { default as Blueprint } from './Blueprint';
-export { default as Code } from './Code';
-export { default as Contract } from './Contract';
+export { Blueprint } from './Blueprint';
+export { Code } from './Code';
+export { Contract } from './Contract';

packages/api-contract/src/types.ts

@@ -5,10 +5,11 @@ import { ApiTypes } from '@polkadot/api/types';
 import { ContractExecResultResult, ContractSelector } from '@polkadot/types/interfaces';
 import { Codec, CodecArg, TypeDef } from '@polkadot/types/types';
 
-import ApiBase from '@polkadot/api/base';
+import BN from 'bn.js';
+import { ApiBase } from '@polkadot/api/base';
 import { Text, u64 } from '@polkadot/types';
 
-import Abi from './Abi';
+import { Abi } from '.';
 
 export interface ContractBase<ApiType extends ApiTypes> {
   readonly abi: Abi;
@@ -42,7 +43,7 @@ export interface AbiMessage {
   isPayable?: boolean;
   returnType?: TypeDef | null;
   selector: ContractSelector;
-  toU8a: (params: CodecArg[]) => Uint8Array;
+  toU8a: (params: CodecArg[], additional?: Uint8Array) => Uint8Array;
 }
 
 export type AbiConstructor = AbiMessage;
@@ -68,3 +69,14 @@ export interface DecodedMessage {
   args: Codec[];
   message: AbiMessage;
 }
+
+export interface BlueprintOptions {
+  gasLimit?: BigInt | string | number | BN;
+  salt?: Uint8Array | string | null;
+  value?: BigInt | string | number | BN;
+}
+
+export interface ContractOptions {
+  gasLimit?: BigInt | BN | string | number;
+  value?: BigInt | BN | string | number;
+}

packages/api-contract/src/util.ts

@@ -1,14 +1,20 @@
-// Copyright 2017-2020 @polkadot/rpc-core authors & contributors
+// Copyright 2017-2020 @polkadot/rpc-contract authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
 import { SubmittableResult } from '@polkadot/api';
 import { EventRecord } from '@polkadot/types/interfaces';
-import { Codec, Registry, TypeDef } from '@polkadot/types/types';
+import { Codec, CodecArg, Registry, TypeDef } from '@polkadot/types/types';
+import { BlueprintOptions, ContractOptions } from './types';
 
-import { Raw, createTypeUnsafe } from '@polkadot/types';
+import BN from 'bn.js';
+import { Raw } from '@polkadot/types';
+import { createTypeUnsafe } from '@polkadot/types/create';
+import { isBn, isBigInt, isNumber, isString } from '@polkadot/util';
 
 type ContractEvents = 'CodeStored' | 'ContractExecution' | 'Instantiated';
 
+type TOptions = BlueprintOptions | ContractOptions;
+
 export function formatData (registry: Registry, data: Raw, { type }: TypeDef): Codec {
   return createTypeUnsafe(registry, type, [data], true);
 }
@@ -24,3 +30,13 @@ export function applyOnEvent <T> (result: SubmittableResult, type: ContractEvent
 
   return undefined;
 }
+
+export function isOptions <T> (options: BigInt | string | number | BN | T): options is T {
+  return !(isBn(options) || isBigInt(options) || isNumber(options) || isString(options));
+}
+
+export function extractOptions <T extends TOptions> (value: BigInt | string | number | BN, params: CodecArg[]): [T, CodecArg[]] {
+  const gasLimit = params.shift() as BN;
+
+  return [{ gasLimit, value } as T, params];
+}

packages/api-contract/test/compare/ink_dns.test.json

@@ -29,15 +29,6 @@
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "displayName": "Hash",
-        "namespace": "ink_env::types",
-        "info": 6,
-        "type": "Hash"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -66,6 +57,7 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"Hash\"}}"
   },
   {
@@ -108,15 +100,6 @@
   {
     "displayName": "ValueEntry",
     "namespace": "ink_storage::collections::hashmap",
-    "params": [
-      {
-        "displayName": "AccountId",
-        "namespace": "ink_env::types",
-        "info": 6,
-        "type": "AccountId"
-      }
-    ],
-    "info": 9,
     "sub": [
       {
         "displayName": "AccountId",
@@ -131,6 +114,7 @@
         "name": "key_index"
       }
     ],
+    "info": 9,
     "type": "{\"value\":\"AccountId\",\"key_index\":\"u32\"}"
   },
   {
@@ -141,38 +125,6 @@
   },
   {
     "displayName": "Result",
-    "params": [
-      {
-        "info": 10,
-        "sub": [],
-        "type": "()"
-      },
-      {
-        "displayName": "Error",
-        "namespace": "dns::dns",
-        "info": 3,
-        "sub": [
-          {
-            "ext": {
-              "discriminant": 0
-            },
-            "info": 6,
-            "name": "NameAlreadyExists",
-            "type": "Null"
-          },
-          {
-            "ext": {
-              "discriminant": 1
-            },
-            "info": 6,
-            "name": "CallerIsNotOwner",
-            "type": "Null"
-          }
-        ],
-        "type": "{ _enum: [\"NameAlreadyExists\", \"CallerIsNotOwner\"] }"
-      }
-    ],
-    "info": 7,
     "sub": [
       {
         "name": "Ok",
@@ -203,9 +155,10 @@
             "type": "Null"
           }
         ],
-        "type": "{ _enum: [\"NameAlreadyExists\", \"CallerIsNotOwner\"] }"
+        "type": "{\"_enum\":[\"NameAlreadyExists\",\"CallerIsNotOwner\"]}"
       }
     ],
+    "info": 7,
     "type": "Result<(), Error>"
   },
   {
@@ -235,25 +188,17 @@
         "type": "Null"
       }
     ],
-    "type": "{ _enum: [\"NameAlreadyExists\", \"CallerIsNotOwner\"] }"
+    "type": "{\"_enum\":[\"NameAlreadyExists\",\"CallerIsNotOwner\"]}"
   },
   {
     "displayName": "Option",
-    "params": [
-      {
-        "displayName": "AccountId",
-        "namespace": "ink_env::types",
-        "info": 6,
-        "type": "AccountId"
-      }
-    ],
-    "info": 5,
     "sub": {
       "displayName": "AccountId",
       "namespace": "ink_env::types",
       "info": 6,
       "type": "AccountId"
     },
+    "info": 5,
     "type": "Option<AccountId>"
   }
 ]

packages/api-contract/test/compare/ink_erc20.test.json

@@ -33,15 +33,6 @@
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "displayName": "AccountId",
-        "namespace": "ink_env::types",
-        "info": 6,
-        "type": "AccountId"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -70,6 +61,7 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"AccountId\"}}"
   },
   {
@@ -112,13 +104,6 @@
   {
     "displayName": "ValueEntry",
     "namespace": "ink_storage::collections::hashmap",
-    "params": [
-      {
-        "info": 6,
-        "type": "u128"
-      }
-    ],
-    "info": 9,
     "sub": [
       {
         "info": 6,
@@ -131,32 +116,12 @@
         "name": "key_index"
       }
     ],
+    "info": 9,
     "type": "{\"value\":\"u128\",\"key_index\":\"u32\"}"
   },
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "info": 10,
-        "sub": [
-          {
-            "displayName": "AccountId",
-            "namespace": "ink_env::types",
-            "info": 6,
-            "type": "AccountId"
-          },
-          {
-            "displayName": "AccountId",
-            "namespace": "ink_env::types",
-            "info": 6,
-            "type": "AccountId"
-          }
-        ],
-        "type": "(AccountId, AccountId)"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -197,6 +162,7 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"(AccountId, AccountId)\"}}"
   },
   {
@@ -223,21 +189,13 @@
   },
   {
     "displayName": "Option",
-    "params": [
-      {
-        "displayName": "AccountId",
-        "namespace": "ink_env::types",
-        "info": 6,
-        "type": "AccountId"
-      }
-    ],
-    "info": 5,
     "sub": {
       "displayName": "AccountId",
       "namespace": "ink_env::types",
       "info": 6,
       "type": "AccountId"
     },
+    "info": 5,
     "type": "Option<AccountId>"
   }
 ]

packages/api-contract/test/compare/ink_erc721.test.json

@@ -29,13 +29,6 @@
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "info": 6,
-        "type": "u32"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -62,6 +55,7 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"u32\"}}"
   },
   {
@@ -85,15 +79,6 @@
   {
     "displayName": "ValueEntry",
     "namespace": "ink_storage::collections::hashmap",
-    "params": [
-      {
-        "displayName": "AccountId",
-        "namespace": "ink_env::types",
-        "info": 6,
-        "type": "AccountId"
-      }
-    ],
-    "info": 9,
     "sub": [
       {
         "displayName": "AccountId",
@@ -108,6 +93,7 @@
         "name": "key_index"
       }
     ],
+    "info": 9,
     "type": "{\"value\":\"AccountId\",\"key_index\":\"u32\"}"
   },
   {
@@ -132,15 +118,6 @@
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "displayName": "AccountId",
-        "namespace": "ink_env::types",
-        "info": 6,
-        "type": "AccountId"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -169,18 +146,12 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"AccountId\"}}"
   },
   {
     "displayName": "ValueEntry",
     "namespace": "ink_storage::collections::hashmap",
-    "params": [
-      {
-        "info": 6,
-        "type": "u32"
-      }
-    ],
-    "info": 9,
     "sub": [
       {
         "info": 6,
@@ -193,32 +164,12 @@
         "name": "key_index"
       }
     ],
+    "info": 9,
     "type": "{\"value\":\"u32\",\"key_index\":\"u32\"}"
   },
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "info": 10,
-        "sub": [
-          {
-            "displayName": "AccountId",
-            "namespace": "ink_env::types",
-            "info": 6,
-            "type": "AccountId"
-          },
-          {
-            "displayName": "AccountId",
-            "namespace": "ink_env::types",
-            "info": 6,
-            "type": "AccountId"
-          }
-        ],
-        "type": "(AccountId, AccountId)"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -259,6 +210,7 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"(AccountId, AccountId)\"}}"
   },
   {
@@ -282,13 +234,6 @@
   {
     "displayName": "ValueEntry",
     "namespace": "ink_storage::collections::hashmap",
-    "params": [
-      {
-        "info": 6,
-        "type": "bool"
-      }
-    ],
-    "info": 9,
     "sub": [
       {
         "info": 6,
@@ -301,6 +246,7 @@
         "name": "key_index"
       }
     ],
+    "info": 9,
     "type": "{\"value\":\"bool\",\"key_index\":\"u32\"}"
   },
   {
@@ -309,105 +255,17 @@
   },
   {
     "displayName": "Option",
-    "params": [
-      {
-        "displayName": "AccountId",
-        "namespace": "ink_env::types",
-        "info": 6,
-        "type": "AccountId"
-      }
-    ],
-    "info": 5,
     "sub": {
       "displayName": "AccountId",
       "namespace": "ink_env::types",
       "info": 6,
       "type": "AccountId"
     },
+    "info": 5,
     "type": "Option<AccountId>"
   },
   {
     "displayName": "Result",
-    "params": [
-      {
-        "info": 10,
-        "sub": [],
-        "type": "()"
-      },
-      {
-        "displayName": "Error",
-        "namespace": "erc721::erc721",
-        "info": 3,
-        "sub": [
-          {
-            "ext": {
-              "discriminant": 0
-            },
-            "info": 6,
-            "name": "NotOwner",
-            "type": "Null"
-          },
-          {
-            "ext": {
-              "discriminant": 1
-            },
-            "info": 6,
-            "name": "NotApproved",
-            "type": "Null"
-          },
-          {
-            "ext": {
-              "discriminant": 2
-            },
-            "info": 6,
-            "name": "TokenExists",
-            "type": "Null"
-          },
-          {
-            "ext": {
-              "discriminant": 3
-            },
-            "info": 6,
-            "name": "TokenNotFound",
-            "type": "Null"
-          },
-          {
-            "ext": {
-              "discriminant": 4
-            },
-            "info": 6,
-            "name": "CannotInsert",
-            "type": "Null"
-          },
-          {
-            "ext": {
-              "discriminant": 5
-            },
-            "info": 6,
-            "name": "CannotRemove",
-            "type": "Null"
-          },
-          {
-            "ext": {
-              "discriminant": 6
-            },
-            "info": 6,
-            "name": "CannotFetchValue",
-            "type": "Null"
-          },
-          {
-            "ext": {
-              "discriminant": 7
-            },
-            "info": 6,
-            "name": "NotAllowed",
-            "type": "Null"
-          }
-        ],
-        "type": "{ _enum: [\"NotOwner\", \"NotApproved\", \"TokenExists\", \"TokenNotFound\", \"CannotInsert\", \"CannotRemove\", \"CannotFetchValue\", \"NotAllowed\"] }"
-      }
-    ],
-    "info": 7,
     "sub": [
       {
         "name": "Ok",
@@ -486,9 +344,10 @@
             "type": "Null"
           }
         ],
-        "type": "{ _enum: [\"NotOwner\", \"NotApproved\", \"TokenExists\", \"TokenNotFound\", \"CannotInsert\", \"CannotRemove\", \"CannotFetchValue\", \"NotAllowed\"] }"
+        "type": "{\"_enum\":[\"NotOwner\",\"NotApproved\",\"TokenExists\",\"TokenNotFound\",\"CannotInsert\",\"CannotRemove\",\"CannotFetchValue\",\"NotAllowed\"]}"
       }
     ],
+    "info": 7,
     "type": "Result<(), Error>"
   },
   {
@@ -566,6 +425,6 @@
         "type": "Null"
       }
     ],
-    "type": "{ _enum: [\"NotOwner\", \"NotApproved\", \"TokenExists\", \"TokenNotFound\", \"CannotInsert\", \"CannotRemove\", \"CannotFetchValue\", \"NotAllowed\"] }"
+    "type": "{\"_enum\":[\"NotOwner\",\"NotApproved\",\"TokenExists\",\"TokenNotFound\",\"CannotInsert\",\"CannotRemove\",\"CannotFetchValue\",\"NotAllowed\"]}"
   }
 ]

packages/api-contract/test/compare/ink_multisigPlain.test.json

@@ -29,25 +29,6 @@
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "info": 10,
-        "sub": [
-          {
-            "info": 6,
-            "type": "u32"
-          },
-          {
-            "displayName": "AccountId",
-            "namespace": "ink_env::types",
-            "info": 6,
-            "type": "AccountId"
-          }
-        ],
-        "type": "(u32, AccountId)"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -86,6 +67,7 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"(u32, AccountId)\"}}"
   },
   {
@@ -144,14 +126,6 @@
   {
     "displayName": "ValueEntry",
     "namespace": "ink_storage::collections::hashmap",
-    "params": [
-      {
-        "info": 10,
-        "sub": [],
-        "type": "()"
-      }
-    ],
-    "info": 9,
     "sub": [
       {
         "info": 10,
@@ -165,6 +139,7 @@
         "name": "key_index"
       }
     ],
+    "info": 9,
     "type": "{\"value\":\"()\",\"key_index\":\"u32\"}"
   },
   {
@@ -175,13 +150,6 @@
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "info": 6,
-        "type": "u32"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -208,18 +176,12 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"u32\"}}"
   },
   {
     "displayName": "ValueEntry",
     "namespace": "ink_storage::collections::hashmap",
-    "params": [
-      {
-        "info": 6,
-        "type": "u32"
-      }
-    ],
-    "info": 9,
     "sub": [
       {
         "info": 6,
@@ -232,58 +194,12 @@
         "name": "key_index"
       }
     ],
+    "info": 9,
     "type": "{\"value\":\"u32\",\"key_index\":\"u32\"}"
   },
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "displayName": "Transaction",
-        "namespace": "multisig_plain::multisig_plain",
-        "info": 9,
-        "sub": [
-          {
-            "displayName": "AccountId",
-            "namespace": "ink_env::types",
-            "info": 6,
-            "type": "AccountId",
-            "name": "callee"
-          },
-          {
-            "info": 12,
-            "length": 4,
-            "sub": {
-              "info": 6,
-              "type": "u8"
-            },
-            "type": "[u8;4]",
-            "name": "selector"
-          },
-          {
-            "info": 11,
-            "sub": {
-              "info": 6,
-              "type": "u8"
-            },
-            "type": "Vec<u8>",
-            "name": "input"
-          },
-          {
-            "info": 6,
-            "type": "u128",
-            "name": "transferred_value"
-          },
-          {
-            "info": 6,
-            "type": "u64",
-            "name": "gas_limit"
-          }
-        ],
-        "type": "{\"callee\":\"AccountId\",\"selector\":\"[u8;4]\",\"input\":\"Vec<u8>\",\"transferred_value\":\"u128\",\"gas_limit\":\"u64\"}"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -350,6 +266,7 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"Transaction\"}}"
   },
   {
@@ -424,15 +341,6 @@
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "displayName": "AccountId",
-        "namespace": "ink_env::types",
-        "info": 6,
-        "type": "AccountId"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -461,6 +369,7 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"AccountId\"}}"
   },
   {
@@ -523,19 +432,6 @@
   },
   {
     "displayName": "Result",
-    "params": [
-      {
-        "info": 10,
-        "sub": [],
-        "type": "()"
-      },
-      {
-        "info": 10,
-        "sub": [],
-        "type": "()"
-      }
-    ],
-    "info": 7,
     "sub": [
       {
         "name": "Ok",
@@ -550,26 +446,11 @@
         "type": "()"
       }
     ],
+    "info": 7,
     "type": "Result<(), ()>"
   },
   {
     "displayName": "Result",
-    "params": [
-      {
-        "info": 11,
-        "sub": {
-          "info": 6,
-          "type": "u8"
-        },
-        "type": "Vec<u8>"
-      },
-      {
-        "info": 10,
-        "sub": [],
-        "type": "()"
-      }
-    ],
-    "info": 7,
     "sub": [
       {
         "name": "Ok",
@@ -587,56 +468,15 @@
         "type": "()"
       }
     ],
+    "info": 7,
     "type": "Result<Vec<u8>, ()>"
   },
   {
     "displayName": "Result",
-    "params": [
-      {
-        "displayName": "Option",
-        "params": [
-          {
-            "info": 11,
-            "sub": {
-              "info": 6,
-              "type": "u8"
-            },
-            "type": "Vec<u8>"
-          }
-        ],
-        "info": 5,
-        "sub": {
-          "info": 11,
-          "sub": {
-            "info": 6,
-            "type": "u8"
-          },
-          "type": "Vec<u8>"
-        },
-        "type": "Option<Vec<u8>>"
-      },
-      {
-        "info": 10,
-        "sub": [],
-        "type": "()"
-      }
-    ],
-    "info": 7,
     "sub": [
       {
         "name": "Ok",
         "displayName": "Option",
-        "params": [
-          {
-            "info": 11,
-            "sub": {
-              "info": 6,
-              "type": "u8"
-            },
-            "type": "Vec<u8>"
-          }
-        ],
-        "info": 5,
         "sub": {
           "info": 11,
           "sub": {
@@ -645,6 +485,7 @@
           },
           "type": "Vec<u8>"
         },
+        "info": 5,
         "type": "Option<Vec<u8>>"
       },
       {
@@ -654,21 +495,11 @@
         "type": "()"
       }
     ],
+    "info": 7,
     "type": "Result<Option<Vec<u8>>, ()>"
   },
   {
     "displayName": "Option",
-    "params": [
-      {
-        "info": 11,
-        "sub": {
-          "info": 6,
-          "type": "u8"
-        },
-        "type": "Vec<u8>"
-      }
-    ],
-    "info": 5,
     "sub": {
       "info": 11,
       "sub": {
@@ -677,6 +508,7 @@
       },
       "type": "Vec<u8>"
     },
+    "info": 5,
     "type": "Option<Vec<u8>>"
   }
-]
+]

packages/api-contract/test/compare/user_enumExample.test.json

@@ -0,0 +1,422 @@
+[
+  {
+    "info": 6,
+    "type": "i32"
+  },
+  {
+    "info": 6,
+    "type": "u32"
+  },
+  {
+    "info": 6,
+    "type": "u8"
+  },
+  {
+    "displayName": "Variant",
+    "namespace": "enum_example::enum_example",
+    "info": 3,
+    "sub": [
+      {
+        "info": 10,
+        "sub": [],
+        "name": "None",
+        "type": "()"
+      },
+      {
+        "displayName": "Weekday",
+        "namespace": "enum_example::enum_example",
+        "info": 3,
+        "sub": [
+          {
+            "ext": {
+              "discriminant": 0
+            },
+            "info": 6,
+            "name": "Monday",
+            "type": "Null"
+          },
+          {
+            "ext": {
+              "discriminant": 1
+            },
+            "info": 6,
+            "name": "Tuesday",
+            "type": "Null"
+          },
+          {
+            "ext": {
+              "discriminant": 2
+            },
+            "info": 6,
+            "name": "Wednesday",
+            "type": "Null"
+          },
+          {
+            "ext": {
+              "discriminant": 3
+            },
+            "info": 6,
+            "name": "Thursday",
+            "type": "Null"
+          },
+          {
+            "ext": {
+              "discriminant": 4
+            },
+            "info": 6,
+            "name": "Friday",
+            "type": "Null"
+          },
+          {
+            "ext": {
+              "discriminant": 5
+            },
+            "info": 6,
+            "name": "Saturday",
+            "type": "Null"
+          },
+          {
+            "ext": {
+              "discriminant": 6
+            },
+            "info": 6,
+            "name": "Sunday",
+            "type": "Null"
+          }
+        ],
+        "type": "{\"_enum\":[\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\",\"Sunday\"]}",
+        "name": "Weekday"
+      },
+      {
+        "displayName": "TupleMaybeSigned",
+        "namespace": "enum_example::enum_example",
+        "info": 3,
+        "sub": [
+          {
+            "info": 6,
+            "type": "i32",
+            "name": "Signed"
+          },
+          {
+            "info": 6,
+            "type": "u32",
+            "name": "Unsigned"
+          }
+        ],
+        "type": "{\"_enum\":{\"Signed\":\"i32\",\"Unsigned\":\"u32\"}}",
+        "name": "TupleMaybeSigned"
+      },
+      {
+        "displayName": "NamedMaybeSigned",
+        "namespace": "enum_example::enum_example",
+        "info": 3,
+        "sub": [
+          {
+            "info": 9,
+            "sub": [
+              {
+                "info": 6,
+                "type": "i32",
+                "name": "value"
+              }
+            ],
+            "name": "Signed",
+            "type": "{\"value\":\"i32\"}"
+          },
+          {
+            "info": 9,
+            "sub": [
+              {
+                "info": 6,
+                "type": "u32",
+                "name": "value"
+              }
+            ],
+            "name": "Unsigned",
+            "type": "{\"value\":\"u32\"}"
+          }
+        ],
+        "type": "{\"_enum\":{\"Signed\":\"{\\\"value\\\":\\\"i32\\\"}\",\"Unsigned\":\"{\\\"value\\\":\\\"u32\\\"}\"}}",
+        "name": "NamedMaybeSigned"
+      },
+      {
+        "displayName": "Color",
+        "namespace": "enum_example::enum_example",
+        "info": 3,
+        "sub": [
+          {
+            "info": 10,
+            "sub": [],
+            "name": "Red",
+            "type": "()"
+          },
+          {
+            "info": 10,
+            "sub": [],
+            "name": "Blue",
+            "type": "()"
+          },
+          {
+            "info": 10,
+            "sub": [],
+            "name": "Green",
+            "type": "()"
+          },
+          {
+            "info": 10,
+            "sub": [],
+            "name": "Yellow",
+            "type": "()"
+          },
+          {
+            "info": 9,
+            "sub": [
+              {
+                "info": 6,
+                "type": "u8",
+                "name": "r"
+              },
+              {
+                "info": 6,
+                "type": "u8",
+                "name": "g"
+              },
+              {
+                "info": 6,
+                "type": "u8",
+                "name": "b"
+              }
+            ],
+            "name": "Rgb",
+            "type": "{\"r\":\"u8\",\"g\":\"u8\",\"b\":\"u8\"}"
+          },
+          {
+            "info": 9,
+            "sub": [
+              {
+                "info": 6,
+                "type": "u8",
+                "name": "r"
+              },
+              {
+                "info": 6,
+                "type": "u8",
+                "name": "g"
+              },
+              {
+                "info": 6,
+                "type": "u8",
+                "name": "b"
+              },
+              {
+                "info": 6,
+                "type": "u8",
+                "name": "a"
+              }
+            ],
+            "name": "Rgba",
+            "type": "{\"r\":\"u8\",\"g\":\"u8\",\"b\":\"u8\",\"a\":\"u8\"}"
+          }
+        ],
+        "type": "{\"_enum\":{\"Red\":\"()\",\"Blue\":\"()\",\"Green\":\"()\",\"Yellow\":\"()\",\"Rgb\":\"{\\\"r\\\":\\\"u8\\\",\\\"g\\\":\\\"u8\\\",\\\"b\\\":\\\"u8\\\"}\",\"Rgba\":\"{\\\"r\\\":\\\"u8\\\",\\\"g\\\":\\\"u8\\\",\\\"b\\\":\\\"u8\\\",\\\"a\\\":\\\"u8\\\"}\"}}",
+        "name": "Color"
+      }
+    ],
+    "type": "{\"_enum\":{\"None\":\"()\",\"Weekday\":\"Weekday\",\"TupleMaybeSigned\":\"TupleMaybeSigned\",\"NamedMaybeSigned\":\"NamedMaybeSigned\",\"Color\":\"Color\"}}"
+  },
+  {
+    "displayName": "Weekday",
+    "namespace": "enum_example::enum_example",
+    "info": 3,
+    "sub": [
+      {
+        "ext": {
+          "discriminant": 0
+        },
+        "info": 6,
+        "name": "Monday",
+        "type": "Null"
+      },
+      {
+        "ext": {
+          "discriminant": 1
+        },
+        "info": 6,
+        "name": "Tuesday",
+        "type": "Null"
+      },
+      {
+        "ext": {
+          "discriminant": 2
+        },
+        "info": 6,
+        "name": "Wednesday",
+        "type": "Null"
+      },
+      {
+        "ext": {
+          "discriminant": 3
+        },
+        "info": 6,
+        "name": "Thursday",
+        "type": "Null"
+      },
+      {
+        "ext": {
+          "discriminant": 4
+        },
+        "info": 6,
+        "name": "Friday",
+        "type": "Null"
+      },
+      {
+        "ext": {
+          "discriminant": 5
+        },
+        "info": 6,
+        "name": "Saturday",
+        "type": "Null"
+      },
+      {
+        "ext": {
+          "discriminant": 6
+        },
+        "info": 6,
+        "name": "Sunday",
+        "type": "Null"
+      }
+    ],
+    "type": "{\"_enum\":[\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\",\"Sunday\"]}"
+  },
+  {
+    "displayName": "TupleMaybeSigned",
+    "namespace": "enum_example::enum_example",
+    "info": 3,
+    "sub": [
+      {
+        "info": 6,
+        "type": "i32",
+        "name": "Signed"
+      },
+      {
+        "info": 6,
+        "type": "u32",
+        "name": "Unsigned"
+      }
+    ],
+    "type": "{\"_enum\":{\"Signed\":\"i32\",\"Unsigned\":\"u32\"}}"
+  },
+  {
+    "displayName": "NamedMaybeSigned",
+    "namespace": "enum_example::enum_example",
+    "info": 3,
+    "sub": [
+      {
+        "info": 9,
+        "sub": [
+          {
+            "info": 6,
+            "type": "i32",
+            "name": "value"
+          }
+        ],
+        "name": "Signed",
+        "type": "{\"value\":\"i32\"}"
+      },
+      {
+        "info": 9,
+        "sub": [
+          {
+            "info": 6,
+            "type": "u32",
+            "name": "value"
+          }
+        ],
+        "name": "Unsigned",
+        "type": "{\"value\":\"u32\"}"
+      }
+    ],
+    "type": "{\"_enum\":{\"Signed\":\"{\\\"value\\\":\\\"i32\\\"}\",\"Unsigned\":\"{\\\"value\\\":\\\"u32\\\"}\"}}"
+  },
+  {
+    "displayName": "Color",
+    "namespace": "enum_example::enum_example",
+    "info": 3,
+    "sub": [
+      {
+        "info": 10,
+        "sub": [],
+        "name": "Red",
+        "type": "()"
+      },
+      {
+        "info": 10,
+        "sub": [],
+        "name": "Blue",
+        "type": "()"
+      },
+      {
+        "info": 10,
+        "sub": [],
+        "name": "Green",
+        "type": "()"
+      },
+      {
+        "info": 10,
+        "sub": [],
+        "name": "Yellow",
+        "type": "()"
+      },
+      {
+        "info": 9,
+        "sub": [
+          {
+            "info": 6,
+            "type": "u8",
+            "name": "r"
+          },
+          {
+            "info": 6,
+            "type": "u8",
+            "name": "g"
+          },
+          {
+            "info": 6,
+            "type": "u8",
+            "name": "b"
+          }
+        ],
+        "name": "Rgb",
+        "type": "{\"r\":\"u8\",\"g\":\"u8\",\"b\":\"u8\"}"
+      },
+      {
+        "info": 9,
+        "sub": [
+          {
+            "info": 6,
+            "type": "u8",
+            "name": "r"
+          },
+          {
+            "info": 6,
+            "type": "u8",
+            "name": "g"
+          },
+          {
+            "info": 6,
+            "type": "u8",
+            "name": "b"
+          },
+          {
+            "info": 6,
+            "type": "u8",
+            "name": "a"
+          }
+        ],
+        "name": "Rgba",
+        "type": "{\"r\":\"u8\",\"g\":\"u8\",\"b\":\"u8\",\"a\":\"u8\"}"
+      }
+    ],
+    "type": "{\"_enum\":{\"Red\":\"()\",\"Blue\":\"()\",\"Green\":\"()\",\"Yellow\":\"()\",\"Rgb\":\"{\\\"r\\\":\\\"u8\\\",\\\"g\\\":\\\"u8\\\",\\\"b\\\":\\\"u8\\\"}\",\"Rgba\":\"{\\\"r\\\":\\\"u8\\\",\\\"g\\\":\\\"u8\\\",\\\"b\\\":\\\"u8\\\",\\\"a\\\":\\\"u8\\\"}\"}}"
+  }
+]

packages/api-contract/test/compare/user_withString.test.json

@@ -33,15 +33,6 @@
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "displayName": "AccountId",
-        "namespace": "ink_env::types",
-        "info": 6,
-        "type": "AccountId"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -70,6 +61,7 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"AccountId\"}}"
   },
   {
@@ -112,13 +104,6 @@
   {
     "displayName": "ValueEntry",
     "namespace": "ink_storage::collections::hashmap",
-    "params": [
-      {
-        "info": 6,
-        "type": "u128"
-      }
-    ],
-    "info": 9,
     "sub": [
       {
         "info": 6,
@@ -131,32 +116,12 @@
         "name": "key_index"
       }
     ],
+    "info": 9,
     "type": "{\"value\":\"u128\",\"key_index\":\"u32\"}"
   },
   {
     "displayName": "Entry",
     "namespace": "ink_storage::collections::stash",
-    "params": [
-      {
-        "info": 10,
-        "sub": [
-          {
-            "displayName": "AccountId",
-            "namespace": "ink_env::types",
-            "info": 6,
-            "type": "AccountId"
-          },
-          {
-            "displayName": "AccountId",
-            "namespace": "ink_env::types",
-            "info": 6,
-            "type": "AccountId"
-          }
-        ],
-        "type": "(AccountId, AccountId)"
-      }
-    ],
-    "info": 3,
     "sub": [
       {
         "displayName": "VacantEntry",
@@ -197,6 +162,7 @@
         "name": "Occupied"
       }
     ],
+    "info": 3,
     "type": "{\"_enum\":{\"Vacant\":\"VacantEntry\",\"Occupied\":\"(AccountId, AccountId)\"}}"
   },
   {
@@ -227,21 +193,13 @@
   },
   {
     "displayName": "Option",
-    "params": [
-      {
-        "displayName": "AccountId",
-        "namespace": "ink_env::types",
-        "info": 6,
-        "type": "AccountId"
-      }
-    ],
-    "info": 5,
     "sub": {
       "displayName": "AccountId",
       "namespace": "ink_env::types",
       "info": 6,
       "type": "AccountId"
     },
+    "info": 5,
     "type": "Option<AccountId>"
   }
-]
+]

packages/api-contract/test/contracts/index.ts

@@ -1,6 +1,21 @@
 // Copyright 2017-2020 @polkadot/api-contract authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-export * from './ink';
-export * from './solang';
-export * from './user';
+import * as ink from './ink';
+import * as solang from './solang';
+import * as user from './user';
+
+const all: Record<string, any> = {};
+
+function addExport (type: string, abis: Record<string, any>): void {
+  Object.keys(abis).forEach((key): void => {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    all[`${type}_${key}`] = abis[key];
+  });
+}
+
+addExport('ink', ink);
+addExport('solang', solang);
+addExport('user', user);
+
+export default all;

packages/api-contract/test/contracts/ink/flipper.contract.json

@@ -0,0 +1,107 @@
+{
+  "metadataVersion": "0.1.0",
+  "source": {
+    "hash": "0x98086d5ccadd437459b812682380250f51a3034272cd1108e499acc0cafe9f42",
+    "language": "ink! 3.0.0-rc2",
+    "compiler": "rustc 1.49.0-nightly",
+    "wasm": "0x0061736d01000000012c0860027f7f0060037f7f7f0060017f017f60017f006000017f60037f7f7f017f60047f7f7f7f0060017f017e02880106057365616c30107365616c5f6765745f73746f726167650005057365616c30107365616c5f7365745f73746f726167650001057365616c30167365616c5f76616c75655f7472616e736665727265640000057365616c300a7365616c5f696e7075740000057365616c300b7365616c5f72657475726e000103656e76066d656d6f72790201021003121102020002000100070303060402040503010608017f01418080040b071102066465706c6f7900100463616c6c00120a8e1111c90101017f230041406a22012400200141206a200041186a290300370300200141186a200041106a290300370300200141106a200041086a2903003703002001420037032820012000290300370308200141086a1006200141808001360234200141a4800436023020014180800136023841a48004200141386a10002100200141306a20012802381007024002400240024020000e0401000002000b000b20012001290330370338200141386a100841ff017122004102470d01000b000b200141406b240020004100470b6001037e200029032021012000420137032020002001200029030022027c22013703002000200029030822032001200254ad7c22013703082000200029031022022001200354ad7c2201370310200020002903182001200254ad7c37031820000b4901037f230041106b22022400200028020421032000410036020420002802002104200041a48004360200200241086a200120042003100f20002002290308370200200241106a24000b4201027f230041106b22012400200141086a2000100b20012d0009210020012d00082102200141106a240041024101410220004101461b410020001b20024101711b0b8f0101017f230041406a22022400200241206a200141186a290300370300200241186a200141106a290300370300200241106a200141086a2903003703002002420037032820022001290300370308200241086a1006200241386a41808001360200200241a48004360234200241003602302002200241306a2000100a200228020020022802041001200241406b24000b9d0101037f230041106b22032400200141086a220428020021052004410036020020012802042104200141a48004360204200320023a000f2003410120042005100f024020032802044101460440200328020020032d000f3a000020014100360208200141a480043602042005450d0120012005417f6a3602082001200441016a3602042000410136020420002004360200200341106a24000f0b000b000b4801027f230041106b22022400200241003a000f024020012002410f6a4101101345044020022d000f21010c010b410121030b200020013a0001200020033a0000200241106a24000b890101027f230041106b22012400200142003c000c200142003e0208027f0340200241044604402001280208210241000c020b20012000100b20012d0000410171450440200141086a20026a20012d00013a00002001200241016a22023a000c0c010b0b200241ff01710440200141003a000c0b4100210241010b200141106a2400ad2002ad420886840b2201017f230041106b220124002001200036020c2001410c6a2802002d0000100e000b4601017f230041206b22012400200141186a41808001360200200141a4800436021420014100360210200141086a200141106a2000100a41002001280208200128020c1004000b2300410020014d0440200320014f044020002001360204200020023602000f0b000b000b15004100101141ff0171410274418080046a2802000bd80502057f017e230041306b220124000240027f024002402000044020014180800136020c200141a48004360208200141086a10142001200129030837031041012103200141106a100c2206a722054101710440410121020c030b200642ffffffffff1f832206422088a721002006421888a721042006421088a72102200541087641ff01712205411e470440200541c00147200041f3014772200241ff017141960147720d0241002102200441ff017141a501460d030c020b200041d60047200241ff017141dc0047720d014100210241002103200441ff017141a401470d010c020b20014180800136020c200141a48004360208200141086a101420012001290308370310410321020240200141106a100c2206a722044101710d00200642ffffffffff1f832206422088a721002006421888a721032006421088a7210202400240200441087641ff0171220441ea00470440200441d101472000412b4772200241ff017141830147720d02200341ff017141d100460d010c020b200041e20147200241ff0171413747720d0141022102200341ff01714112470d010c020b41032102200141106a100841ff017122004102460d01200041004721020c010b410321020b4106200241034622030d021a4106200220031b22024102460440200141286a4200370300200141206a4200370300200141186a4200370300200142003703104100200141106a100941080c030b200141286a4200370300200141206a4200370300200141186a4200370300200142003703102002410171200141106a100941080c020b41012102410121030b410620020d001a2003450d01200141286a4200370300200141206a4200370300200141186a420037030020014200370310200141106a1005410173200141106a100941080b200141306a24000f0b200141286a4200370300200141206a4200370300200141186a4200370300200142003703102001200141106a10053a0008200141086a100d000ba90102027f027e230041206b22002400200041808001360204200041a4800436020020004180800136021041a48004200041106a100220002000280210100720002000290300370308200041186a2201420037030020004200370310027f4101200041086a200041106a411010130d001a200129030021022000290310210341000b200220038450457245044041011011200041206a240041ff0171410274418080046a2802000f0b000b45000240200028020420024f047f2001200028020020021015200028020422012002490d012000200120026b3602042000200028020020026a36020041000541010b0f0b000b3301017f230041106b220124002001200028020436020c20002802002001410c6a10032000200128020c1007200141106a24000b2c01017f037f2002200346047f200005200020036a200120036a2d00003a0000200341016a21030c010b0b1a0b0b250100418080040b1d0100000002000000030000000400000005000000060000000700000008"
+  },
+  "contract": {
+    "name": "flipper",
+    "version": "3.0.0-rc2",
+    "authors": [
+      "Parity Technologies <admin@parity.io>"
+    ]
+  },
+  "spec": {
+    "constructors": [
+      {
+        "args": [
+          {
+            "name": "init_value",
+            "type": {
+              "displayName": [
+                "bool"
+              ],
+              "type": 1
+            }
+          }
+        ],
+        "docs": [
+          " Creates a new flipper smart contract initialized with the given value."
+        ],
+        "name": [
+          "new"
+        ],
+        "selector": "0xd183512b"
+      },
+      {
+        "args": [],
+        "docs": [
+          " Creates a new flipper smart contract initialized to `false`."
+        ],
+        "name": [
+          "default"
+        ],
+        "selector": "0x6a3712e2"
+      }
+    ],
+    "docs": [],
+    "events": [],
+    "messages": [
+      {
+        "args": [],
+        "docs": [
+          " Flips the current value of the Flipper's bool."
+        ],
+        "mutates": true,
+        "name": [
+          "flip"
+        ],
+        "payable": false,
+        "returnType": null,
+        "selector": "0xc096a5f3"
+      },
+      {
+        "args": [],
+        "docs": [
+          " Returns the current value of the Flipper's bool."
+        ],
+        "mutates": false,
+        "name": [
+          "get"
+        ],
+        "payable": false,
+        "returnType": {
+          "displayName": [
+            "bool"
+          ],
+          "type": 1
+        },
+        "selector": "0x1e5ca456"
+      }
+    ]
+  },
+  "storage": {
+    "struct": {
+      "fields": [
+        {
+          "layout": {
+            "cell": {
+              "key": "0x0000000000000000000000000000000000000000000000000000000000000000",
+              "ty": 1
+            }
+          },
+          "name": "value"
+        }
+      ]
+    }
+  },
+  "types": [
+    {
+      "def": {
+        "primitive": "bool"
+      }
+    }
+  ]
+}

packages/api-contract/test/contracts/user/enumExample.json

@@ -0,0 +1,528 @@
+{
+  "metadataVersion": "0.1.0",
+  "source": {
+    "hash": "0x1a37c380fe02fe3b670480dff1393b0401788955315d092e39fcc06047f1413c",
+    "language": "ink! 3.0.0-rc2",
+    "compiler": "rustc 1.49.0-nightly"
+  },
+  "contract": {
+    "name": "enum_example",
+    "version": "0.1.0",
+    "authors": [
+      "[your_name] <[your_email]>"
+    ]
+  },
+  "spec": {
+    "constructors": [
+      {
+        "args": [],
+        "docs": [],
+        "name": [
+          "new"
+        ],
+        "selector": "0xd183512b"
+      }
+    ],
+    "docs": [],
+    "events": [],
+    "messages": [
+      {
+        "args": [
+          {
+            "name": "variant",
+            "type": {
+              "displayName": [
+                "Variant"
+              ],
+              "type": 4
+            }
+          }
+        ],
+        "docs": [],
+        "mutates": true,
+        "name": [
+          "set_variant"
+        ],
+        "payable": false,
+        "returnType": null,
+        "selector": "0x4fa6b9cf"
+      },
+      {
+        "args": [],
+        "docs": [],
+        "mutates": false,
+        "name": [
+          "get_variant"
+        ],
+        "payable": false,
+        "returnType": {
+          "displayName": [
+            "Variant"
+          ],
+          "type": 4
+        },
+        "selector": "0x1d5962d1"
+      }
+    ]
+  },
+  "storage": {
+    "struct": {
+      "fields": [
+        {
+          "layout": {
+            "enum": {
+              "dispatchKey": "0x0000000000000000000000000000000000000000000000000000000000000000",
+              "variants": {
+                "0": {
+                  "fields": []
+                },
+                "1": {
+                  "fields": [
+                    {
+                      "layout": {
+                        "enum": {
+                          "dispatchKey": "0x0100000000000000000000000000000000000000000000000000000000000000",
+                          "variants": {
+                            "0": {
+                              "fields": []
+                            },
+                            "1": {
+                              "fields": []
+                            },
+                            "2": {
+                              "fields": []
+                            },
+                            "3": {
+                              "fields": []
+                            },
+                            "4": {
+                              "fields": []
+                            },
+                            "5": {
+                              "fields": []
+                            },
+                            "6": {
+                              "fields": []
+                            }
+                          }
+                        }
+                      },
+                      "name": null
+                    }
+                  ]
+                },
+                "2": {
+                  "fields": [
+                    {
+                      "layout": {
+                        "enum": {
+                          "dispatchKey": "0x0100000000000000000000000000000000000000000000000000000000000000",
+                          "variants": {
+                            "0": {
+                              "fields": [
+                                {
+                                  "layout": {
+                                    "cell": {
+                                      "key": "0x0200000000000000000000000000000000000000000000000000000000000000",
+                                      "ty": 1
+                                    }
+                                  },
+                                  "name": null
+                                }
+                              ]
+                            },
+                            "1": {
+                              "fields": [
+                                {
+                                  "layout": {
+                                    "cell": {
+                                      "key": "0x0200000000000000000000000000000000000000000000000000000000000000",
+                                      "ty": 2
+                                    }
+                                  },
+                                  "name": null
+                                }
+                              ]
+                            }
+                          }
+                        }
+                      },
+                      "name": null
+                    }
+                  ]
+                },
+                "3": {
+                  "fields": [
+                    {
+                      "layout": {
+                        "enum": {
+                          "dispatchKey": "0x0100000000000000000000000000000000000000000000000000000000000000",
+                          "variants": {
+                            "0": {
+                              "fields": [
+                                {
+                                  "layout": {
+                                    "cell": {
+                                      "key": "0x0200000000000000000000000000000000000000000000000000000000000000",
+                                      "ty": 1
+                                    }
+                                  },
+                                  "name": "value"
+                                }
+                              ]
+                            },
+                            "1": {
+                              "fields": [
+                                {
+                                  "layout": {
+                                    "cell": {
+                                      "key": "0x0200000000000000000000000000000000000000000000000000000000000000",
+                                      "ty": 2
+                                    }
+                                  },
+                                  "name": "value"
+                                }
+                              ]
+                            }
+                          }
+                        }
+                      },
+                      "name": null
+                    }
+                  ]
+                },
+                "4": {
+                  "fields": [
+                    {
+                      "layout": {
+                        "enum": {
+                          "dispatchKey": "0x0100000000000000000000000000000000000000000000000000000000000000",
+                          "variants": {
+                            "0": {
+                              "fields": []
+                            },
+                            "1": {
+                              "fields": []
+                            },
+                            "2": {
+                              "fields": []
+                            },
+                            "3": {
+                              "fields": []
+                            },
+                            "4": {
+                              "fields": [
+                                {
+                                  "layout": {
+                                    "cell": {
+                                      "key": "0x0200000000000000000000000000000000000000000000000000000000000000",
+                                      "ty": 3
+                                    }
+                                  },
+                                  "name": "r"
+                                },
+                                {
+                                  "layout": {
+                                    "cell": {
+                                      "key": "0x0300000000000000000000000000000000000000000000000000000000000000",
+                                      "ty": 3
+                                    }
+                                  },
+                                  "name": "g"
+                                },
+                                {
+                                  "layout": {
+                                    "cell": {
+                                      "key": "0x0400000000000000000000000000000000000000000000000000000000000000",
+                                      "ty": 3
+                                    }
+                                  },
+                                  "name": "b"
+                                }
+                              ]
+                            },
+                            "5": {
+                              "fields": [
+                                {
+                                  "layout": {
+                                    "cell": {
+                                      "key": "0x0200000000000000000000000000000000000000000000000000000000000000",
+                                      "ty": 3
+                                    }
+                                  },
+                                  "name": "r"
+                                },
+                                {
+                                  "layout": {
+                                    "cell": {
+                                      "key": "0x0300000000000000000000000000000000000000000000000000000000000000",
+                                      "ty": 3
+                                    }
+                                  },
+                                  "name": "g"
+                                },
+                                {
+                                  "layout": {
+                                    "cell": {
+                                      "key": "0x0400000000000000000000000000000000000000000000000000000000000000",
+                                      "ty": 3
+                                    }
+                                  },
+                                  "name": "b"
+                                },
+                                {
+                                  "layout": {
+                                    "cell": {
+                                      "key": "0x0500000000000000000000000000000000000000000000000000000000000000",
+                                      "ty": 3
+                                    }
+                                  },
+                                  "name": "a"
+                                }
+                              ]
+                            }
+                          }
+                        }
+                      },
+                      "name": null
+                    }
+                  ]
+                }
+              }
+            }
+          },
+          "name": "last"
+        }
+      ]
+    }
+  },
+  "types": [
+    {
+      "def": {
+        "primitive": "i32"
+      }
+    },
+    {
+      "def": {
+        "primitive": "u32"
+      }
+    },
+    {
+      "def": {
+        "primitive": "u8"
+      }
+    },
+    {
+      "def": {
+        "variant": {
+          "variants": [
+            {
+              "name": "None"
+            },
+            {
+              "fields": [
+                {
+                  "type": 5
+                }
+              ],
+              "name": "Weekday"
+            },
+            {
+              "fields": [
+                {
+                  "type": 6
+                }
+              ],
+              "name": "TupleMaybeSigned"
+            },
+            {
+              "fields": [
+                {
+                  "type": 7
+                }
+              ],
+              "name": "NamedMaybeSigned"
+            },
+            {
+              "fields": [
+                {
+                  "type": 8
+                }
+              ],
+              "name": "Color"
+            }
+          ]
+        }
+      },
+      "path": [
+        "enum_example",
+        "enum_example",
+        "Variant"
+      ]
+    },
+    {
+      "def": {
+        "variant": {
+          "variants": [
+            {
+              "discriminant": 0,
+              "name": "Monday"
+            },
+            {
+              "discriminant": 1,
+              "name": "Tuesday"
+            },
+            {
+              "discriminant": 2,
+              "name": "Wednesday"
+            },
+            {
+              "discriminant": 3,
+              "name": "Thursday"
+            },
+            {
+              "discriminant": 4,
+              "name": "Friday"
+            },
+            {
+              "discriminant": 5,
+              "name": "Saturday"
+            },
+            {
+              "discriminant": 6,
+              "name": "Sunday"
+            }
+          ]
+        }
+      },
+      "path": [
+        "enum_example",
+        "enum_example",
+        "Weekday"
+      ]
+    },
+    {
+      "def": {
+        "variant": {
+          "variants": [
+            {
+              "fields": [
+                {
+                  "type": 1
+                }
+              ],
+              "name": "Signed"
+            },
+            {
+              "fields": [
+                {
+                  "type": 2
+                }
+              ],
+              "name": "Unsigned"
+            }
+          ]
+        }
+      },
+      "path": [
+        "enum_example",
+        "enum_example",
+        "TupleMaybeSigned"
+      ]
+    },
+    {
+      "def": {
+        "variant": {
+          "variants": [
+            {
+              "fields": [
+                {
+                  "name": "value",
+                  "type": 1
+                }
+              ],
+              "name": "Signed"
+            },
+            {
+              "fields": [
+                {
+                  "name": "value",
+                  "type": 2
+                }
+              ],
+              "name": "Unsigned"
+            }
+          ]
+        }
+      },
+      "path": [
+        "enum_example",
+        "enum_example",
+        "NamedMaybeSigned"
+      ]
+    },
+    {
+      "def": {
+        "variant": {
+          "variants": [
+            {
+              "name": "Red"
+            },
+            {
+              "name": "Blue"
+            },
+            {
+              "name": "Green"
+            },
+            {
+              "name": "Yellow"
+            },
+            {
+              "fields": [
+                {
+                  "name": "r",
+                  "type": 3
+                },
+                {
+                  "name": "g",
+                  "type": 3
+                },
+                {
+                  "name": "b",
+                  "type": 3
+                }
+              ],
+              "name": "Rgb"
+            },
+            {
+              "fields": [
+                {
+                  "name": "r",
+                  "type": 3
+                },
+                {
+                  "name": "g",
+                  "type": 3
+                },
+                {
+                  "name": "b",
+                  "type": 3
+                },
+                {
+                  "name": "a",
+                  "type": 3
+                }
+              ],
+              "name": "Rgba"
+            }
+          ]
+        }
+      },
+      "path": [
+        "enum_example",
+        "enum_example",
+        "Color"
+      ]
+    }
+  ]
+}

packages/api-contract/test/contracts/user/index.ts

@@ -2,4 +2,5 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export { default as assetTransfer } from './assetTransfer.json';
+export { default as enumExample } from './enumExample.json';
 export { default as withString } from './withString.json';

packages/api-derive/package.json

@@ -1,44 +1,34 @@
 {
   "name": "@polkadot/api-derive",
-  "version": "2.5.1",
+  "version": "2.9.1",
   "description": "Common functions used across Polkadot, derived from RPC calls and storage queries.",
   "main": "index.js",
+  "sideEffects": false,
   "keywords": [
     "Polkadot",
     "Promise",
     "RxJs"
   ],
   "author": "Jaco Greeff <jacogr@gmail.com>",
-  "maintainers": [
-    "Jaco Greeff <jacogr@gmail.com>"
-  ],
+  "maintainers": [],
   "contributors": [],
   "license": "Apache-2.0",
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/polkadot-js/api.git"
-  },
-  "bugs": {
-    "url": "https://github.com/polkadot-js/api/issues"
-  },
+  "repository": "github:polkadot-js/api",
+  "bugs": "https://github.com/polkadot-js/api/issues",
   "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-derive#readme",
   "dependencies": {
-    "@babel/runtime": "^7.12.1",
-    "@polkadot/api": "^2.5.1",
-    "@polkadot/rpc-core": "^2.5.1",
-    "@polkadot/rpc-provider": "^2.5.1",
-    "@polkadot/types": "^2.5.1",
-    "@polkadot/util": "^3.7.1",
-    "@polkadot/util-crypto": "^3.7.1",
-    "bn.js": "^5.1.3",
+    "@babel/runtime": "^7.12.5",
+    "@polkadot/api": "2.9.1",
+    "@polkadot/rpc-core": "2.9.1",
+    "@polkadot/types": "2.9.1",
+    "@polkadot/util": "^4.2.1",
+    "@polkadot/util-crypto": "^4.2.1",
+    "bn.js": "^4.11.9",
     "memoizee": "^0.4.14",
     "rxjs": "^6.6.3"
   },
   "devDependencies": {
-    "@polkadot/keyring": "^3.7.1"
+    "@polkadot/keyring": "^4.2.1",
+    "@polkadot/rpc-provider": "2.9.1"
   }
 }

packages/api-derive/src/accounts/accountId.ts

@@ -16,7 +16,7 @@ function retrieve (api: ApiInterfaceRx, address: Address | AccountId | AccountIn
     ? address
     : decodeAddress((address || '').toString());
 
-  if (decoded.length === 32) {
+  if (decoded.length > 8) {
     return of(api.registry.createType('AccountId', decoded));
   }
 

packages/api-derive/src/accounts/idAndIndex.ts

@@ -12,14 +12,14 @@ import { decodeAddress } from '@polkadot/util-crypto';
 
 import { memo } from '../util';
 
-function retrieve (api: ApiInterfaceRx, address: Address | AccountId | AccountIndex | string | null | undefined): Observable<AccountIdAndIndex> {
+function retrieve (api: ApiInterfaceRx, address: Address | AccountId | AccountIndex | Uint8Array | string | null | undefined): Observable<AccountIdAndIndex> {
   try {
     // yes, this can fail, don't care too much, catch will catch it
     const decoded = isU8a(address)
       ? address
       : decodeAddress((address || '').toString());
 
-    if (decoded.length === 32) {
+    if (decoded.length > 8) {
       const accountId = api.registry.createType('AccountId', decoded);
 
       return api.derive.accounts.idToIndex(accountId).pipe(
@@ -39,7 +39,7 @@ function retrieve (api: ApiInterfaceRx, address: Address | AccountId | AccountIn
 
 /**
  * @name idAndIndex
- * @param {(Address | AccountId | AccountIndex | string | null)} address - An accounts address in various formats.
+ * @param {(Address | AccountId | AccountIndex | Uint8Array | string | null)} address - An accounts address in various formats.
  * @description  An array containing the [[AccountId]] and [[AccountIndex]] as optional values.
  * @example
  * <BR>
@@ -50,7 +50,7 @@ function retrieve (api: ApiInterfaceRx, address: Address | AccountId | AccountIn
  * });
  * ```
  */
-export function idAndIndex (instanceId: string, api: ApiInterfaceRx): (address?: Address | AccountId | AccountIndex | string | null) => Observable<AccountIdAndIndex> {
-  return memo(instanceId, (address?: Address | AccountId | AccountIndex | string | null): Observable<AccountIdAndIndex> =>
+export function idAndIndex (instanceId: string, api: ApiInterfaceRx): (address?: Address | AccountId | AccountIndex | Uint8Array | string | null) => Observable<AccountIdAndIndex> {
+  return memo(instanceId, (address?: Address | AccountId | AccountIndex | Uint8Array | string | null): Observable<AccountIdAndIndex> =>
     retrieve(api, address));
 }

packages/api-derive/src/accounts/identity.ts

@@ -0,0 +1,126 @@
+// Copyright 2017-2020 @polkadot/api-derive authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { ApiInterfaceRx } from '@polkadot/api/types';
+import { AccountId, IdentityInfoAdditional, Registration } from '@polkadot/types/interfaces';
+import { ITuple } from '@polkadot/types/types';
+import { DeriveAccountRegistration, DeriveHasIdentity } from '../types';
+
+import { Observable, combineLatest, of } from 'rxjs';
+import { map, switchMap } from 'rxjs/operators';
+import { Data, Option } from '@polkadot/types';
+import { u8aToString } from '@polkadot/util';
+
+import { memo } from '../util';
+
+const UNDEF_HEX = { toHex: () => undefined };
+
+function dataAsString (data: Data): string | undefined {
+  return data.isRaw
+    ? u8aToString(data.asRaw.toU8a(true))
+    : data.isNone
+      ? undefined
+      : data.toHex();
+}
+
+function extractOther (additional: IdentityInfoAdditional[]): Record<string, string> {
+  return additional.reduce((other: Record<string, string>, [_key, _value]): Record<string, string> => {
+    const key = dataAsString(_key);
+    const value = dataAsString(_value);
+
+    if (key && value) {
+      other[key] = value;
+    }
+
+    return other;
+  }, {});
+}
+
+function extractIdentity (identityOfOpt?: Option<Registration>, superOf?: [AccountId, Data]): DeriveAccountRegistration {
+  if (!identityOfOpt?.isSome) {
+    return { judgements: [] };
+  }
+
+  const { info, judgements } = identityOfOpt.unwrap();
+  const topDisplay = dataAsString(info.display);
+
+  return {
+    display: (superOf && dataAsString(superOf[1])) || topDisplay,
+    displayParent: superOf && topDisplay,
+    email: dataAsString(info.email),
+    image: dataAsString(info.image),
+    judgements,
+    legal: dataAsString(info.legal),
+    other: extractOther(info.additional),
+    parent: superOf && superOf[0],
+    pgp: info.pgpFingerprint.unwrapOr(UNDEF_HEX).toHex(),
+    riot: dataAsString(info.riot),
+    twitter: dataAsString(info.twitter),
+    web: dataAsString(info.web)
+  };
+}
+
+function getParent (api: ApiInterfaceRx, identityOfOpt: Option<Registration> | undefined, superOfOpt: Option<ITuple<[AccountId, Data]>> | undefined): Observable<[Option<Registration> | undefined, [AccountId, Data] | undefined]> {
+  if (identityOfOpt?.isSome) {
+    // this identity has something set
+    return of([identityOfOpt, undefined]);
+  } else if (superOfOpt?.isSome) {
+    const superOf = superOfOpt.unwrap();
+
+    // we have a super
+    return combineLatest([
+      api.query.identity.identityOf<Option<Registration>>(superOf[0]),
+      of(superOf)
+    ]);
+  }
+
+  // nothing of value returned
+  return of([undefined, undefined]);
+}
+
+export function _identityBase (instanceId: string, api: ApiInterfaceRx): (accountId?: AccountId | Uint8Array | string) => Observable<[Option<Registration> | undefined, Option<ITuple<[AccountId, Data]>> | undefined]> {
+  return memo(instanceId, (accountId?: AccountId | Uint8Array | string): Observable<[Option<Registration> | undefined, Option<ITuple<[AccountId, Data]>> | undefined]> =>
+    accountId && api.query.identity?.identityOf
+      ? api.queryMulti<[Option<Registration>, Option<ITuple<[AccountId, Data]>>]>([
+        [api.query.identity.identityOf, accountId],
+        [api.query.identity.superOf, accountId]
+      ])
+      : of([undefined, undefined])
+  );
+}
+
+/**
+ * @name identity
+ * @description Returns identity info for an account
+ */
+export function identity (instanceId: string, api: ApiInterfaceRx): (accountId?: AccountId | Uint8Array | string) => Observable<DeriveAccountRegistration> {
+  return memo(instanceId, (accountId?: AccountId | Uint8Array | string): Observable<DeriveAccountRegistration> =>
+    api.derive.accounts._identityBase(accountId).pipe(
+      switchMap(([identityOfOpt, superOfOpt]) => getParent(api, identityOfOpt, superOfOpt)),
+      map(([identityOfOpt, superOf]) => extractIdentity(identityOfOpt, superOf))
+    )
+  );
+}
+
+export function hasIdentity (instanceId: string, api: ApiInterfaceRx): (accountId: AccountId | Uint8Array | string) => Observable<DeriveHasIdentity> {
+  return memo(instanceId, (accountId: AccountId | Uint8Array | string): Observable<DeriveHasIdentity> =>
+    api.derive.accounts._identityBase(accountId).pipe(
+      map(([identityOfOpt, superOfOpt]: [Option<Registration> | undefined, Option<ITuple<[AccountId, Data]>> | undefined]): DeriveHasIdentity => {
+        const parentId = superOfOpt && superOfOpt.isSome
+          ? superOfOpt.unwrap()[0].toString()
+          : null;
+        const hasIdentity = !!parentId || !!(identityOfOpt && identityOfOpt.isSome);
+
+        return { hasIdentity, parentId };
+      })
+    )
+  );
+}
+
+export function hasIdentityMulti (instanceId: string, api: ApiInterfaceRx): (accountIds: (AccountId | Uint8Array | string)[]) => Observable<DeriveHasIdentity[]> {
+  return memo(instanceId, (accountIds: (AccountId | Uint8Array | string)[]): Observable<DeriveHasIdentity[]> =>
+    combineLatest(
+      accountIds.map((accountId) => api.derive.accounts.hasIdentity(accountId))
+    )
+  );
+}

packages/api-derive/src/accounts/index.ts

@@ -5,6 +5,7 @@ export * from './accountId';
 export * from './flags';
 export * from './idAndIndex';
 export * from './idToIndex';
+export * from './identity';
 export * from './indexToId';
 export * from './indexes';
 export * from './info';

packages/api-derive/src/accounts/info.ts

@@ -2,27 +2,17 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { ApiInterfaceRx } from '@polkadot/api/types';
-import { AccountId, AccountIndex, Address, Balance, IdentityInfoAdditional, Registration } from '@polkadot/types/interfaces';
+import { AccountId, AccountIndex, Address, Balance } from '@polkadot/types/interfaces';
 import { ITuple } from '@polkadot/types/types';
 import { DeriveAccountInfo, DeriveAccountRegistration } from '../types';
 
 import { Observable, combineLatest, of } from 'rxjs';
 import { map, switchMap } from 'rxjs/operators';
-import { Bytes, Data, Option, u32 } from '@polkadot/types';
+import { Bytes, Option, u32 } from '@polkadot/types';
 import { u8aToString } from '@polkadot/util';
 
 import { memo } from '../util';
 
-const UNDEF_HEX = { toHex: () => undefined };
-
-function dataAsString (data: Data): string | undefined {
-  return data.isRaw
-    ? u8aToString(data.asRaw.toU8a(true))
-    : data.isNone
-      ? undefined
-      : data.toHex();
-}
-
 function retrieveNick (api: ApiInterfaceRx, accountId?: AccountId): Observable<string | undefined> {
   return ((
     accountId && api.query.nicks?.nameOf
@@ -37,86 +27,17 @@ function retrieveNick (api: ApiInterfaceRx, accountId?: AccountId): Observable<s
   );
 }
 
-function extractOther (additional: IdentityInfoAdditional[]): Record<string, string> {
-  return additional.reduce((other: Record<string, string>, [_key, _value]): Record<string, string> => {
-    const key = dataAsString(_key);
-    const value = dataAsString(_value);
-
-    if (key && value) {
-      other[key] = value;
-    }
-
-    return other;
-  }, {});
-}
-
-function extractIdentity (identityOfOpt?: Option<Registration>, superOf?: [AccountId, Data]): DeriveAccountRegistration {
-  if (!identityOfOpt?.isSome) {
-    return { judgements: [] };
-  }
-
-  const { info, judgements } = identityOfOpt.unwrap();
-  const topDisplay = dataAsString(info.display);
-
-  return {
-    display: (superOf && dataAsString(superOf[1])) || topDisplay,
-    displayParent: superOf && topDisplay,
-    email: dataAsString(info.email),
-    image: dataAsString(info.image),
-    judgements,
-    legal: dataAsString(info.legal),
-    other: extractOther(info.additional),
-    parent: superOf && superOf[0],
-    pgp: info.pgpFingerprint.unwrapOr(UNDEF_HEX).toHex(),
-    riot: dataAsString(info.riot),
-    twitter: dataAsString(info.twitter),
-    web: dataAsString(info.web)
-  };
-}
-
-function retrieveIdentity (api: ApiInterfaceRx, accountId?: AccountId): Observable<DeriveAccountRegistration> {
-  return ((
-    accountId && api.query.identity?.identityOf
-      ? api.queryMulti([
-        [api.query.identity.identityOf, accountId],
-        [api.query.identity.superOf, accountId]
-      ])
-      : of([undefined, undefined])
-  ) as Observable<[Option<Registration> | undefined, Option<ITuple<[AccountId, Data]>> | undefined]>).pipe(
-    switchMap(([identityOfOpt, superOfOpt]): Observable<[Option<Registration> | undefined, [AccountId, Data] | undefined]> => {
-      if (identityOfOpt?.isSome) {
-        // this identity has something set
-        return of([identityOfOpt, undefined]);
-      } else if (superOfOpt?.isSome) {
-        const superOf = superOfOpt.unwrap();
-
-        // we have a super
-        return combineLatest([
-          api.query.identity.identityOf<Option<Registration>>(superOf[0]),
-          of(superOf)
-        ]);
-      }
-
-      // nothing of value returned
-      return of([undefined, undefined]);
-    }),
-    map(([identityOfOpt, superOf]): DeriveAccountRegistration =>
-      extractIdentity(identityOfOpt, superOf)
-    )
-  );
-}
-
 /**
  * @name info
  * @description Returns aux. info with regards to an account, current that includes the accountId, accountIndex and nickname
  */
-export function info (instanceId: string, api: ApiInterfaceRx): (address?: AccountIndex | AccountId | Address | string | null) => Observable<DeriveAccountInfo> {
-  return memo(instanceId, (address?: AccountIndex | AccountId | Address | string | null): Observable<DeriveAccountInfo> =>
+export function info (instanceId: string, api: ApiInterfaceRx): (address?: AccountIndex | AccountId | Address | Uint8Array | string | null) => Observable<DeriveAccountInfo> {
+  return memo(instanceId, (address?: AccountIndex | AccountId | Address | Uint8Array | string | null): Observable<DeriveAccountInfo> =>
     api.derive.accounts.idAndIndex(address).pipe(
       switchMap(([accountId, accountIndex]): Observable<[Partial<DeriveAccountInfo>, DeriveAccountRegistration, string?]> =>
         combineLatest([
           of({ accountId, accountIndex }),
-          retrieveIdentity(api, accountId),
+          api.derive.accounts.identity(accountId),
           retrieveNick(api, accountId)
         ])
       ),

packages/api-derive/src/accounts/types.ts

@@ -35,3 +35,8 @@ export interface DeriveAccountInfo {
   identity: DeriveAccountRegistration;
   nickname?: string;
 }
+
+export interface DeriveHasIdentity {
+  hasIdentity: boolean;
+  parentId: string | null;
+}

packages/api-derive/src/chain/getBlock.ts

@@ -17,12 +17,12 @@ import { memo } from '../util';
  * <BR>
  *
  * ```javascript
- * const { author, number } = await api.derive.chain.getHeader('0x123...456');
+ * const { author, block } = await api.derive.chain.getBlock('0x123...456');
  *
- * console.log(`block #${number} was authored by ${author}`);
+ * console.log(`block #${block.header.number} was authored by ${author}`);
  * ```
  */
-export function getHeader (instanceId: string, api: ApiInterfaceRx): (hash: Uint8Array | string) => Observable<SignedBlockExtended | undefined> {
+export function getBlock (instanceId: string, api: ApiInterfaceRx): (hash: Uint8Array | string) => Observable<SignedBlockExtended | undefined> {
   return memo(instanceId, (hash: Uint8Array | string): Observable<SignedBlockExtended | undefined> =>
     combineLatest([
       api.rpc.chain.getBlock(hash),
@@ -35,7 +35,7 @@ export function getHeader (instanceId: string, api: ApiInterfaceRx): (hash: Uint
       ),
       catchError((): Observable<undefined> =>
         // where rpc.chain.getHeader throws, we will land here - it can happen that
-        // we supplied an invalid hash. (Due to defaults, storeage will have an
+        // we supplied an invalid hash. (Due to defaults, storage will have an
         // empty value, so only the RPC is affected). So return undefined
         of()
       )

packages/api-derive/src/chain/index.ts

@@ -5,5 +5,6 @@ export * from './bestNumber';
 export * from './bestNumberFinalized';
 export * from './bestNumberLag';
 export * from './getHeader';
+export * from './getBlock';
 export * from './subscribeNewBlocks';
 export * from './subscribeNewHeads';

packages/api-derive/src/collective/proposals.ts

@@ -6,18 +6,18 @@ import { Hash, Proposal, Votes } from '@polkadot/types/interfaces';
 import { DeriveCollectiveProposal } from '../types';
 
 import { Observable, combineLatest, of } from 'rxjs';
-import { map, switchMap } from 'rxjs/operators';
+import { catchError, map, switchMap } from 'rxjs/operators';
 import { Option } from '@polkadot/types';
 import { isFunction } from '@polkadot/util';
 
 import { memo } from '../util';
 
-type Result = [(Hash | Uint8Array | string)[], Option<Proposal>[], Option<Votes>[]];
+type Result = [(Hash | Uint8Array | string)[], (Option<Proposal> | null)[], Option<Votes>[]];
 
 function parse (api: ApiInterfaceRx, [hashes, proposals, votes]: Result): DeriveCollectiveProposal[] {
   return proposals
     .map((proposalOpt, index): DeriveCollectiveProposal | null =>
-      proposalOpt.isSome
+      proposalOpt && proposalOpt.isSome
         ? {
           hash: api.registry.createType('Hash', hashes[index]),
           proposal: proposalOpt.unwrap(),
@@ -33,7 +33,12 @@ function _proposalsFrom (instanceId: string, api: ApiInterfaceRx, section: 'coun
     (isFunction(api.query[section]?.proposals) && hashes.length
       ? combineLatest<Result>([
         of(hashes),
-        api.query[section].proposalOf.multi<Option<Proposal>>(hashes),
+        combineLatest(hashes.map((hash) =>
+          // this should simply be api.query[section].proposalOf.multi<Option<Proposal>>(hashes),
+          // however we have had cases on Edgeware where the indices have moved around after an
+          // upgrade, which results in invalid on-chain data
+          api.query[section].proposalOf(hash).pipe(catchError(() => of(null)))
+        )),
         api.query[section].voting.multi<Option<Votes>>(hashes)
       ])
       : of([[], [], []] as Result)

packages/api-derive/src/index.spec.ts

@@ -6,9 +6,9 @@
 /* eslint-disable @typescript-eslint/restrict-template-expressions */
 
 import { Observable, from } from 'rxjs';
-import ApiRx from '@polkadot/api/rx/Api';
-import MockProvider from '@polkadot/rpc-provider/mock';
-import { TypeRegistry } from '@polkadot/types';
+import { ApiRx } from '@polkadot/api/rx';
+import { MockProvider } from '@polkadot/rpc-provider/mock';
+import { TypeRegistry } from '@polkadot/types/create';
 
 import { ExactDerive } from '.';
 

packages/api-derive/src/index.ts

@@ -92,7 +92,7 @@ function injectFunctions<AllSections> (instanceId: string, api: ApiInterfaceRx,
 // FIXME The return type of this function should be {...ExactDerive, ...DeriveCustom}
 // For now we just drop the custom derive typings
 /** @internal */
-export default function decorateDerive (instanceId: string, api: ApiInterfaceRx, custom: DeriveCustom = {}): ExactDerive {
+export function decorateDerive (instanceId: string, api: ApiInterfaceRx, custom: DeriveCustom = {}): ExactDerive {
   return {
     ...injectFunctions(instanceId, api, derive),
     ...injectFunctions(instanceId, api, custom)

packages/api-derive/src/staking/electedInfo.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { ApiInterfaceRx } from '@polkadot/api/types';
+import { AccountId } from '@polkadot/types/interfaces';
 import { DeriveStakingElected } from '../types';
 
 import { Observable } from 'rxjs';
@@ -9,14 +10,19 @@ import { map, switchMap } from 'rxjs/operators';
 
 import { memo } from '../util';
 
+function combineAccounts (nextElected: AccountId[], validators: AccountId[]): AccountId[] {
+  return [...nextElected].concat(...validators.filter((v) => !nextElected.find((n) => n.eq(v))));
+}
+
 export function electedInfo (instanceId: string, api: ApiInterfaceRx): () => Observable<DeriveStakingElected> {
   return memo(instanceId, (): Observable<DeriveStakingElected> =>
     api.derive.staking.validators().pipe(
-      switchMap(({ nextElected }): Observable<DeriveStakingElected> =>
-        api.derive.staking.queryMulti(nextElected).pipe(
+      switchMap(({ nextElected, validators }): Observable<DeriveStakingElected> =>
+        api.derive.staking.queryMulti(combineAccounts(nextElected, validators)).pipe(
           map((info): DeriveStakingElected => ({
             info,
-            nextElected
+            nextElected,
+            validators
           }))
         )
       )

packages/api-derive/src/staking/types.ts

@@ -120,8 +120,9 @@ export interface DeriveStakingQuery extends DeriveStakingStash {
 }
 
 export interface DeriveStakingElected {
-  nextElected: AccountId[];
   info: DeriveStakingQuery[];
+  nextElected: AccountId[];
+  validators: AccountId[];
 }
 
 export interface DeriveStakingWaiting {

packages/api-derive/src/staking/validators.ts

@@ -30,7 +30,6 @@ export function validators (instanceId: string, api: ApiInterfaceRx): () => Obse
   return memo(instanceId, (): Observable<DeriveStakingValidators> =>
     // Sadly the node-template is (for some obscure reason) not comprehensive, so while the derive works
     // in all actual real-world deployed chains, it does create some confusion for limited template chains
-    // NOTE: Not doing multi queries here, since we have validators as a single in the derived newHead
     combineLatest([
       api.query.session
         ? api.query.session.validators()

packages/api-derive/src/type/HeaderExtended.ts

@@ -17,7 +17,7 @@ const _Header = Struct.with(runtimeTypes.types.Header as any) as Constructor<Hea
  * @description
  * A [[Block]] header with an additional `author` field that indicates the block author
  */
-export default class HeaderExtended extends _Header {
+export class HeaderExtended extends _Header {
   readonly #author?: AccountId;
 
   constructor (registry: Registry, header?: Header, sessionValidators?: AccountId[]) {

packages/api-derive/src/type/SignedBlockExtended.ts

@@ -17,7 +17,7 @@ const _SignedBlock = Struct.with(runtimeTypes.types.SignedBlock as any) as Const
  * @description
  * A [[Block]] header with an additional `author` field that indicates the block author
  */
-export default class BlockExtended extends _SignedBlock {
+export class SignedBlockExtended extends _SignedBlock {
   readonly #author?: AccountId;
 
   constructor (registry: Registry, block?: SignedBlock, sessionValidators?: AccountId[]) {

packages/api-derive/src/type/index.ts

@@ -1,5 +1,5 @@
 // Copyright 2017-2020 @polkadot/api-derive authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-export { default as HeaderExtended } from './HeaderExtended';
-export { default as SignedBlockExtended } from './SignedBlockExtended';
+export { HeaderExtended } from './HeaderExtended';
+export { SignedBlockExtended } from './SignedBlockExtended';

packages/api-derive/src/util/approvalFlagToBools.spec.ts

@@ -3,7 +3,7 @@
 
 import { ApprovalFlag } from '@polkadot/types/interfaces';
 
-import { TypeRegistry } from '@polkadot/types';
+import { TypeRegistry } from '@polkadot/types/create';
 
 import { approvalFlagsToBools } from './approvalFlagsToBools';
 

packages/api-derive/src/util/index.ts

@@ -1,11 +1,9 @@
 // Copyright 2017-2020 @polkadot/api-derive authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import { drr } from '@polkadot/rpc-core/rxjs';
+export { drr } from '@polkadot/rpc-core/util';
 
 export * from './approvalFlagsToBools';
 export * from './cache';
 export * from './cacheImpl';
 export * from './memo';
-
-export { drr };

packages/api-derive/src/util/memo.ts

@@ -3,8 +3,7 @@
 
 import createMemo from 'memoizee';
 import { Observable, Observer, TeardownLogic } from 'rxjs';
-import { drr } from '@polkadot/rpc-core/rxjs';
-import normalizer from '@polkadot/rpc-core/normalizer';
+import { drr, normalizer } from '@polkadot/rpc-core/util';
 
 type ObsFn <T> = (...params: any[]) => Observable<T>;
 

packages/api/package.json

@@ -1,46 +1,33 @@
 {
   "name": "@polkadot/api",
-  "version": "2.5.1",
+  "version": "2.9.1",
   "description": "Promise and RxJS wrappers around the Polkadot JS RPC",
   "main": "index.js",
+  "sideEffects": false,
   "keywords": [
     "Polkadot",
     "RxJs"
   ],
   "author": "Jaco Greeff <jacogr@gmail.com>",
-  "maintainers": [
-    "Jaco Greeff <jacogr@gmail.com>"
-  ],
+  "maintainers": [],
   "contributors": [],
   "license": "Apache-2.0",
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/polkadot-js/api.git"
-  },
-  "bugs": {
-    "url": "https://github.com/polkadot-js/api/issues"
-  },
+  "repository": "github:polkadot-js/api",
+  "bugs": "https://github.com/polkadot-js/api/issues",
   "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme",
   "dependencies": {
-    "@babel/runtime": "^7.12.1",
-    "@polkadot/api-derive": "^2.5.1",
-    "@polkadot/keyring": "^3.7.1",
-    "@polkadot/metadata": "^2.5.1",
-    "@polkadot/rpc-core": "^2.5.1",
-    "@polkadot/rpc-provider": "^2.5.1",
-    "@polkadot/types": "^2.5.1",
-    "@polkadot/types-known": "^2.5.1",
-    "@polkadot/util": "^3.7.1",
-    "@polkadot/util-crypto": "^3.7.1",
-    "bn.js": "^5.1.3",
+    "@babel/runtime": "^7.12.5",
+    "@polkadot/api-derive": "2.9.1",
+    "@polkadot/keyring": "^4.2.1",
+    "@polkadot/metadata": "2.9.1",
+    "@polkadot/rpc-core": "2.9.1",
+    "@polkadot/rpc-provider": "2.9.1",
+    "@polkadot/types": "2.9.1",
+    "@polkadot/types-known": "2.9.1",
+    "@polkadot/util": "^4.2.1",
+    "@polkadot/util-crypto": "^4.2.1",
+    "bn.js": "^4.11.9",
     "eventemitter3": "^4.0.7",
     "rxjs": "^6.6.3"
-  },
-  "devDependencies": {
-    "@polkadot/keyring": "^3.7.1"
   }
 }

packages/api/src/augment/consts.ts

@@ -1,14 +1,13 @@
 // Auto-generated via `yarn polkadot-types-from-chain`, do not edit
 /* eslint-disable */
 
-import { Codec } from '@polkadot/types/types';
-import { Vec } from '@polkadot/types/codec';
-import { u16, u32, u64 } from '@polkadot/types/primitive';
-import { Balance, BalanceOf, BlockNumber, LockIdentifier, ModuleId, Moment, Perbill, Percent, Permill, RuntimeDbWeight, Weight } from '@polkadot/types/interfaces/runtime';
-import { SessionIndex } from '@polkadot/types/interfaces/session';
-import { EraIndex } from '@polkadot/types/interfaces/staking';
-import { WeightToFeeCoefficient } from '@polkadot/types/interfaces/support';
-import { ApiTypes } from '@polkadot/api/types';
+import type { Vec, u16, u32, u64 } from '@polkadot/types';
+import type { Codec } from '@polkadot/types/types';
+import type { Balance, BalanceOf, BlockNumber, LockIdentifier, ModuleId, Moment, Perbill, Percent, Permill, RuntimeDbWeight, Weight } from '@polkadot/types/interfaces/runtime';
+import type { SessionIndex } from '@polkadot/types/interfaces/session';
+import type { EraIndex } from '@polkadot/types/interfaces/staking';
+import type { WeightToFeeCoefficient } from '@polkadot/types/interfaces/support';
+import type { ApiTypes } from '@polkadot/api/types';
 
 declare module '@polkadot/api/types/consts' {
   export interface AugmentedConsts<ApiType> {
@@ -134,17 +133,6 @@ declare module '@polkadot/api/types/consts' {
       termDuration: BlockNumber & AugmentedConst<ApiType>;
       votingBond: BalanceOf & AugmentedConst<ApiType>;
     };
-    finalityTracker: {
-      [key: string]: Codec;
-      /**
-       * The delay after which point things become suspicious. Default is 1000.
-       **/
-      reportLatency: BlockNumber & AugmentedConst<ApiType>;
-      /**
-       * The number of recent samples to keep from this chain. Default is 101.
-       **/
-      windowSize: BlockNumber & AugmentedConst<ApiType>;
-    };
     identity: {
       [key: string]: Codec;
       /**

packages/api/src/augment/query.ts

@@ -1,34 +1,33 @@
 // Auto-generated via `yarn polkadot-types-from-chain`, do not edit
 /* eslint-disable */
 
-import { AnyNumber, ITuple, Observable } from '@polkadot/types/types';
-import { Option, U8aFixed, Vec } from '@polkadot/types/codec';
-import { Bytes, Data, bool, u32, u64 } from '@polkadot/types/primitive';
-import { UncleEntryItem } from '@polkadot/types/interfaces/authorship';
-import { BabeAuthorityWeight, MaybeRandomness, NextConfigDescriptor, Randomness } from '@polkadot/types/interfaces/babe';
-import { AccountData, BalanceLock } from '@polkadot/types/interfaces/balances';
-import { ProposalIndex, Votes } from '@polkadot/types/interfaces/collective';
-import { AuthorityId } from '@polkadot/types/interfaces/consensus';
-import { CodeHash, ContractInfo, PrefabWasmModule, Schedule } from '@polkadot/types/interfaces/contracts';
-import { PreimageStatus, PropIndex, Proposal, ReferendumIndex, ReferendumInfo, Voting } from '@polkadot/types/interfaces/democracy';
-import { VoteThreshold } from '@polkadot/types/interfaces/elections';
-import { SetId, StoredPendingChange, StoredState } from '@polkadot/types/interfaces/grandpa';
-import { RegistrarInfo, Registration } from '@polkadot/types/interfaces/identity';
-import { AuthIndex } from '@polkadot/types/interfaces/imOnline';
-import { DeferredOffenceOf, Kind, OffenceDetails, OpaqueTimeSlot, ReportIdOf } from '@polkadot/types/interfaces/offences';
-import { ProxyAnnouncement, ProxyDefinition } from '@polkadot/types/interfaces/proxy';
-import { ActiveRecovery, RecoveryConfig } from '@polkadot/types/interfaces/recovery';
-import { AccountId, AccountIndex, Balance, BalanceOf, BlockNumber, ExtrinsicsWeight, Hash, KeyTypeId, Moment, OpaqueCall, Perbill, Releases, ValidatorId } from '@polkadot/types/interfaces/runtime';
-import { Scheduled, TaskAddress } from '@polkadot/types/interfaces/scheduler';
-import { Keys, SessionIndex } from '@polkadot/types/interfaces/session';
-import { Bid, BidKind, SocietyVote, StrikeCount, VouchingStatus } from '@polkadot/types/interfaces/society';
-import { ActiveEraInfo, ElectionResult, ElectionScore, ElectionStatus, EraIndex, EraRewardPoints, Exposure, Forcing, Nominations, RewardDestination, SlashingSpans, SpanIndex, SpanRecord, StakingLedger, UnappliedSlash, ValidatorPrefs } from '@polkadot/types/interfaces/staking';
-import { AccountInfo, DigestOf, EventIndex, EventRecord, LastRuntimeUpgradeInfo, Phase } from '@polkadot/types/interfaces/system';
-import { Bounty, BountyIndex, OpenTip, TreasuryProposal } from '@polkadot/types/interfaces/treasury';
-import { Multiplier } from '@polkadot/types/interfaces/txpayment';
-import { Multisig } from '@polkadot/types/interfaces/utility';
-import { VestingInfo } from '@polkadot/types/interfaces/vesting';
-import { ApiTypes } from '@polkadot/api/types';
+import type { Bytes, Data, Option, U8aFixed, Vec, bool, u32, u64 } from '@polkadot/types';
+import type { AnyNumber, ITuple, Observable } from '@polkadot/types/types';
+import type { UncleEntryItem } from '@polkadot/types/interfaces/authorship';
+import type { BabeAuthorityWeight, MaybeRandomness, NextConfigDescriptor, Randomness } from '@polkadot/types/interfaces/babe';
+import type { AccountData, BalanceLock } from '@polkadot/types/interfaces/balances';
+import type { ProposalIndex, Votes } from '@polkadot/types/interfaces/collective';
+import type { AuthorityId } from '@polkadot/types/interfaces/consensus';
+import type { CodeHash, ContractInfo, PrefabWasmModule, Schedule } from '@polkadot/types/interfaces/contracts';
+import type { PreimageStatus, PropIndex, Proposal, ReferendumIndex, ReferendumInfo, Voting } from '@polkadot/types/interfaces/democracy';
+import type { VoteThreshold } from '@polkadot/types/interfaces/elections';
+import type { SetId, StoredPendingChange, StoredState } from '@polkadot/types/interfaces/grandpa';
+import type { RegistrarInfo, Registration } from '@polkadot/types/interfaces/identity';
+import type { AuthIndex } from '@polkadot/types/interfaces/imOnline';
+import type { DeferredOffenceOf, Kind, OffenceDetails, OpaqueTimeSlot, ReportIdOf } from '@polkadot/types/interfaces/offences';
+import type { ProxyAnnouncement, ProxyDefinition } from '@polkadot/types/interfaces/proxy';
+import type { ActiveRecovery, RecoveryConfig } from '@polkadot/types/interfaces/recovery';
+import type { AccountId, AccountIndex, Balance, BalanceOf, BlockNumber, ExtrinsicsWeight, Hash, KeyTypeId, Moment, OpaqueCall, Perbill, Releases, ValidatorId } from '@polkadot/types/interfaces/runtime';
+import type { Scheduled, TaskAddress } from '@polkadot/types/interfaces/scheduler';
+import type { Keys, SessionIndex } from '@polkadot/types/interfaces/session';
+import type { Bid, BidKind, SocietyVote, StrikeCount, VouchingStatus } from '@polkadot/types/interfaces/society';
+import type { ActiveEraInfo, ElectionResult, ElectionScore, ElectionStatus, EraIndex, EraRewardPoints, Exposure, Forcing, Nominations, RewardDestination, SlashingSpans, SpanIndex, SpanRecord, StakingLedger, UnappliedSlash, ValidatorPrefs } from '@polkadot/types/interfaces/staking';
+import type { AccountInfo, DigestOf, EventIndex, EventRecord, LastRuntimeUpgradeInfo, Phase } from '@polkadot/types/interfaces/system';
+import type { Bounty, BountyIndex, OpenTip, TreasuryProposal } from '@polkadot/types/interfaces/treasury';
+import type { Multiplier } from '@polkadot/types/interfaces/txpayment';
+import type { Multisig } from '@polkadot/types/interfaces/utility';
+import type { VestingInfo } from '@polkadot/types/interfaces/vesting';
+import type { ApiTypes } from '@polkadot/api/types';
 
 declare module '@polkadot/api/types/storage' {
   export interface AugmentedQueries<ApiType> {
@@ -53,6 +52,12 @@ declare module '@polkadot/api/types/storage' {
        * Current epoch authorities.
        **/
       authorities: AugmentedQuery<ApiType, () => Observable<Vec<ITuple<[AuthorityId, BabeAuthorityWeight]>>>> & QueryableStorageEntry<ApiType>;
+      /**
+       * Temporary value (cleared at block finalization) that includes the VRF output generated
+       * at this block. This field should always be populated during block processing unless
+       * secondary plain slots are enabled (which don't contain a VRF output).
+       **/
+      authorVrfRandomness: AugmentedQuery<ApiType, () => Observable<MaybeRandomness>> & QueryableStorageEntry<ApiType>;
       /**
        * Current slot number.
        **/

packages/api/src/augment/rpc.ts

@@ -1,25 +1,24 @@
 // Auto-generated via `yarn polkadot-types-from-chain`, do not edit
 /* eslint-disable */
 
-import { AnyNumber, Codec, IExtrinsic, Observable } from '@polkadot/types/types';
-import { HashMap, Json, Option, Vec } from '@polkadot/types/codec';
-import { Bytes, Null, StorageKey, Text, bool, u32, u64 } from '@polkadot/types/primitive';
-import { Metadata } from '@polkadot/types';
-import { ExtrinsicOrHash, ExtrinsicStatus } from '@polkadot/types/interfaces/author';
-import { EpochAuthorship } from '@polkadot/types/interfaces/babe';
-import { BlockHash } from '@polkadot/types/interfaces/chain';
-import { PrefixedStorageKey } from '@polkadot/types/interfaces/childstate';
-import { AuthorityId } from '@polkadot/types/interfaces/consensus';
-import { ContractCallRequest, ContractExecResult } from '@polkadot/types/interfaces/contracts';
-import { CreatedBlock } from '@polkadot/types/interfaces/engine';
-import { Extrinsic } from '@polkadot/types/interfaces/extrinsics';
-import { EncodedFinalityProofs, JustificationNotification, ReportedRoundStates } from '@polkadot/types/interfaces/grandpa';
-import { StorageKind } from '@polkadot/types/interfaces/offchain';
-import { RuntimeDispatchInfo } from '@polkadot/types/interfaces/payment';
-import { RpcMethods } from '@polkadot/types/interfaces/rpc';
-import { AccountId, BlockNumber, H256, Hash, Header, Index, Justification, KeyValue, SignedBlock, StorageData } from '@polkadot/types/interfaces/runtime';
-import { ReadProof, RuntimeVersion } from '@polkadot/types/interfaces/state';
-import { ApplyExtrinsicResult, ChainProperties, ChainType, Health, NetworkState, NodeRole, PeerInfo, SyncState } from '@polkadot/types/interfaces/system';
+import type { Metadata } from '@polkadot/metadata';
+import type { Bytes, HashMap, Json, Null, Option, StorageKey, Text, Vec, bool, u32, u64 } from '@polkadot/types';
+import type { AnyNumber, Codec, IExtrinsic, Observable } from '@polkadot/types/types';
+import type { ExtrinsicOrHash, ExtrinsicStatus } from '@polkadot/types/interfaces/author';
+import type { EpochAuthorship } from '@polkadot/types/interfaces/babe';
+import type { BlockHash } from '@polkadot/types/interfaces/chain';
+import type { PrefixedStorageKey } from '@polkadot/types/interfaces/childstate';
+import type { AuthorityId } from '@polkadot/types/interfaces/consensus';
+import type { ContractCallRequest, ContractExecResult } from '@polkadot/types/interfaces/contracts';
+import type { CreatedBlock } from '@polkadot/types/interfaces/engine';
+import type { Extrinsic } from '@polkadot/types/interfaces/extrinsics';
+import type { EncodedFinalityProofs, JustificationNotification, ReportedRoundStates } from '@polkadot/types/interfaces/grandpa';
+import type { StorageKind } from '@polkadot/types/interfaces/offchain';
+import type { RuntimeDispatchInfo } from '@polkadot/types/interfaces/payment';
+import type { RpcMethods } from '@polkadot/types/interfaces/rpc';
+import type { AccountId, BlockNumber, H256, Hash, Header, Index, Justification, KeyValue, SignedBlock, StorageData } from '@polkadot/types/interfaces/runtime';
+import type { ReadProof, RuntimeVersion } from '@polkadot/types/interfaces/state';
+import type { ApplyExtrinsicResult, ChainProperties, ChainType, Health, NetworkState, NodeRole, PeerInfo, SyncState } from '@polkadot/types/interfaces/system';
 
 declare module '@polkadot/rpc-core/types.jsonrpc' {
   export interface RpcInterface {

packages/api/src/augment/tx.ts

@@ -1,29 +1,28 @@
 // Auto-generated via `yarn polkadot-types-from-chain`, do not edit
 /* eslint-disable */
 
-import { AnyNumber, ITuple } from '@polkadot/types/types';
-import { Compact, Option, U8aFixed, Vec } from '@polkadot/types/codec';
-import { Bytes, Data, bool, u16, u32, u64 } from '@polkadot/types/primitive';
-import { BabeEquivocationProof } from '@polkadot/types/interfaces/babe';
-import { MemberCount, ProposalIndex } from '@polkadot/types/interfaces/collective';
-import { CodeHash, Gas, Schedule } from '@polkadot/types/interfaces/contracts';
-import { AccountVote, Conviction, PropIndex, Proposal, ReferendumIndex } from '@polkadot/types/interfaces/democracy';
-import { DefunctVoter, Renouncing } from '@polkadot/types/interfaces/elections';
-import { Extrinsic, Signature } from '@polkadot/types/interfaces/extrinsics';
-import { GrandpaEquivocationProof, KeyOwnerProof } from '@polkadot/types/interfaces/grandpa';
-import { IdentityFields, IdentityInfo, IdentityJudgement, RegistrarIndex } from '@polkadot/types/interfaces/identity';
-import { Heartbeat } from '@polkadot/types/interfaces/imOnline';
-import { ProxyType } from '@polkadot/types/interfaces/proxy';
-import { AccountId, AccountIndex, Address, Balance, BalanceOf, BlockNumber, Call, CallHashOf, ChangesTrieConfiguration, Hash, Header, KeyValue, LookupSource, Moment, OpaqueCall, Perbill, Percent, Weight } from '@polkadot/types/interfaces/runtime';
-import { Period, Priority } from '@polkadot/types/interfaces/scheduler';
-import { Keys } from '@polkadot/types/interfaces/session';
-import { SocietyJudgement } from '@polkadot/types/interfaces/society';
-import { CompactAssignments, ElectionScore, ElectionSize, EraIndex, RewardDestination, ValidatorIndex, ValidatorPrefs } from '@polkadot/types/interfaces/staking';
-import { Key } from '@polkadot/types/interfaces/system';
-import { BountyIndex } from '@polkadot/types/interfaces/treasury';
-import { Timepoint } from '@polkadot/types/interfaces/utility';
-import { VestingInfo } from '@polkadot/types/interfaces/vesting';
-import { ApiTypes, SubmittableExtrinsic } from '@polkadot/api/types';
+import type { Bytes, Compact, Data, Option, U8aFixed, Vec, bool, u16, u32, u64 } from '@polkadot/types';
+import type { AnyNumber, ITuple } from '@polkadot/types/types';
+import type { BabeEquivocationProof } from '@polkadot/types/interfaces/babe';
+import type { MemberCount, ProposalIndex } from '@polkadot/types/interfaces/collective';
+import type { CodeHash, Gas, Schedule } from '@polkadot/types/interfaces/contracts';
+import type { AccountVote, Conviction, PropIndex, Proposal, ReferendumIndex } from '@polkadot/types/interfaces/democracy';
+import type { DefunctVoter, Renouncing } from '@polkadot/types/interfaces/elections';
+import type { Extrinsic, Signature } from '@polkadot/types/interfaces/extrinsics';
+import type { GrandpaEquivocationProof, KeyOwnerProof } from '@polkadot/types/interfaces/grandpa';
+import type { IdentityFields, IdentityInfo, IdentityJudgement, RegistrarIndex } from '@polkadot/types/interfaces/identity';
+import type { Heartbeat } from '@polkadot/types/interfaces/imOnline';
+import type { ProxyType } from '@polkadot/types/interfaces/proxy';
+import type { AccountId, AccountIndex, Address, Balance, BalanceOf, BlockNumber, Call, CallHashOf, ChangesTrieConfiguration, Hash, Header, KeyValue, LookupSource, Moment, OpaqueCall, Perbill, Percent, Weight } from '@polkadot/types/interfaces/runtime';
+import type { Period, Priority } from '@polkadot/types/interfaces/scheduler';
+import type { Keys } from '@polkadot/types/interfaces/session';
+import type { SocietyJudgement } from '@polkadot/types/interfaces/society';
+import type { CompactAssignments, ElectionScore, ElectionSize, EraIndex, RewardDestination, ValidatorIndex, ValidatorPrefs } from '@polkadot/types/interfaces/staking';
+import type { Key } from '@polkadot/types/interfaces/system';
+import type { BountyIndex } from '@polkadot/types/interfaces/treasury';
+import type { Timepoint } from '@polkadot/types/interfaces/utility';
+import type { VestingInfo } from '@polkadot/types/interfaces/vesting';
+import type { ApiTypes, SubmittableExtrinsic } from '@polkadot/api/types';
 
 declare module '@polkadot/api/types/submittable' {
   export interface AugmentedSubmittables<ApiType> {
@@ -175,7 +174,7 @@ declare module '@polkadot/api/types/submittable' {
        * 
        * The schedule must have a greater version than the stored schedule.
        **/
-      updateSchedule: AugmentedSubmittable<(schedule: Schedule | { version?: any; instructionWeights?: any; hostFnWeights?: any; enablePrintln?: any; maxEventTopics?: any; maxStackHeight?: any; maxMemoryPages?: any; maxTableSize?: any; maxSubjectLen?: any; maxCodeSize?: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>>;
+      updateSchedule: AugmentedSubmittable<(schedule: Schedule | { version?: any; enablePrintln?: any; limits?: any; instructionWeights?: any; hostFnWeights?: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>>;
     };
     council: {
       [key: string]: SubmittableExtrinsicFunction<ApiType>;
@@ -805,14 +804,6 @@ declare module '@polkadot/api/types/submittable' {
        **/
       vote: AugmentedSubmittable<(votes: Vec<AccountId> | (AccountId | string | Uint8Array)[], value: Compact<BalanceOf> | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>>;
     };
-    finalityTracker: {
-      [key: string]: SubmittableExtrinsicFunction<ApiType>;
-      /**
-       * Hint that the author of this block thinks the best finalized
-       * block is the given number.
-       **/
-      finalHint: AugmentedSubmittable<(hint: Compact<BlockNumber> | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>>;
-    };
     grandpa: {
       [key: string]: SubmittableExtrinsicFunction<ApiType>;
       /**
@@ -3047,9 +3038,9 @@ declare module '@polkadot/api/types/submittable' {
        * The dispatch origin for this call must be `Inherent`.
        * 
        * # <weight>
-       * - `O(T)` where `T` complexity of `on_timestamp_set`
+       * - `O(1)` (Note that implementations of `OnTimestampSet` must also be `O(1)`)
        * - 1 storage read and 1 storage mutation (codec `O(1)`). (because of `DidUpdate::take` in `on_finalize`)
-       * - 1 event handler `on_timestamp_set` `O(T)`.
+       * - 1 event handler `on_timestamp_set`. Must be `O(1)`.
        * # </weight>
        **/
       set: AugmentedSubmittable<(now: Compact<Moment> | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>>;
@@ -3351,9 +3342,7 @@ declare module '@polkadot/api/types/submittable' {
        * bypassing `frame_system::Trait::BaseCallFilter`).
        * 
        * # <weight>
-       * - Base weight: 14.39 + .987 * c µs
-       * - Plus the sum of the weights of the `calls`.
-       * - Plus one additional event. (repeat read/write)
+       * - Complexity: O(C) where C is the number of calls to be batched.
        * # </weight>
        * 
        * This will return `Ok` in all circumstances. To determine the success of the batch, an
@@ -3363,6 +3352,22 @@ declare module '@polkadot/api/types/submittable' {
        * event is deposited.
        **/
       batch: AugmentedSubmittable<(calls: Vec<Call> | (Call | { callIndex?: any; args?: any } | string | Uint8Array)[]) => SubmittableExtrinsic<ApiType>>;
+      /**
+       * Send a batch of dispatch calls and atomically execute them.
+       * The whole transaction will rollback and fail if any of the calls failed.
+       * 
+       * May be called from any origin.
+       * 
+       * - `calls`: The calls to be dispatched from the same origin.
+       * 
+       * If origin is root then call are dispatch without checking origin filter. (This includes
+       * bypassing `frame_system::Trait::BaseCallFilter`).
+       * 
+       * # <weight>
+       * - Complexity: O(C) where C is the number of calls to be batched.
+       * # </weight>
+       **/
+      batchAll: AugmentedSubmittable<(calls: Vec<Call> | (Call | { callIndex?: any; args?: any } | string | Uint8Array)[]) => SubmittableExtrinsic<ApiType>>;
     };
     vesting: {
       [key: string]: SubmittableExtrinsicFunction<ApiType>;

packages/api/src/base/Decorate.ts

@@ -4,6 +4,7 @@
 import { Constants, DecoratedMeta } from '@polkadot/metadata/decorate/types';
 import { RpcInterface } from '@polkadot/rpc-core/types';
 import { Call, Hash, RuntimeVersion } from '@polkadot/types/interfaces';
+import { StorageEntry } from '@polkadot/types/primitive/types';
 import { AnyFunction, CallFunction, Codec, CodecArg as Arg, InterfaceTypes, Registry, RegistryTypes } from '@polkadot/types/types';
 import { SubmittableExtrinsic } from '../submittable/types';
 import { ApiInterfaceRx, ApiOptions, ApiTypes, DecorateMethod, DecoratedRpc, DecoratedRpcSection, PaginationOptions, QueryableConsts, QueryableModuleStorage, QueryableStorage, QueryableStorageEntry, QueryableStorageMulti, QueryableStorageMultiArg, SubmittableExtrinsicFunction, SubmittableExtrinsics, SubmittableModuleExtrinsics } from '../types';
@@ -11,21 +12,22 @@ import { ApiInterfaceRx, ApiOptions, ApiTypes, DecorateMethod, DecoratedRpc, Dec
 import BN from 'bn.js';
 import { BehaviorSubject, Observable, combineLatest, of } from 'rxjs';
 import { map, switchMap, take, tap, toArray } from 'rxjs/operators';
-import decorateDerive, { ExactDerive } from '@polkadot/api-derive';
+import { ExactDerive, decorateDerive } from '@polkadot/api-derive';
 import { memo } from '@polkadot/api-derive/util';
-import { expandMetadata } from '@polkadot/metadata';
-import RpcCore from '@polkadot/rpc-core';
+import { Metadata, expandMetadata } from '@polkadot/metadata';
+import { RpcCore } from '@polkadot/rpc-core';
 import { WsProvider } from '@polkadot/rpc-provider';
-import { Metadata, Option, Raw, Text, TypeRegistry, u64 } from '@polkadot/types';
+import { Option, Raw, StorageKey, Text, u64 } from '@polkadot/types';
 import { DEFAULT_VERSION as EXTRINSIC_DEFAULT_VERSION } from '@polkadot/types/extrinsic/constants';
-import StorageKey, { StorageEntry, unwrapStorageType } from '@polkadot/types/primitive/StorageKey';
+import { TypeRegistry } from '@polkadot/types/create';
+import { unwrapStorageType } from '@polkadot/types/primitive/StorageKey';
 import { assert, compactStripLength, logger, u8aToHex } from '@polkadot/util';
 
 import { createSubmittable } from '../submittable';
-import augmentObject from '../util/augmentObject';
+import { augmentObject } from '../util/augmentObject';
 import { decorateSections, DeriveAllSections } from '../util/decorate';
 import { extractStorageArgs } from '../util/validate';
-import Events from './Events';
+import { Events } from './Events';
 
 interface MetaDecoration {
   callIndex?: Uint8Array;
@@ -42,7 +44,7 @@ const l = logger('api/init');
 
 let instanceCounter = 0;
 
-export default abstract class Decorate<ApiType extends ApiTypes> extends Events {
+export abstract class Decorate<ApiType extends ApiTypes> extends Events {
   readonly #instanceId: string;
 
   #registry: Registry;
@@ -466,10 +468,10 @@ export default abstract class Decorate<ApiType extends ApiTypes> extends Events
   private _retrieveMapEntries (entry: StorageEntry, at: Hash | Uint8Array | string | null, arg?: Arg): Observable<[StorageKey, Codec][]> {
     const query = this._rpcCore.state.queryStorageAt
       ? at
-        ? (keyset: StorageKey[]) => this._rpcCore.state.queryStorageAt<Codec[]>(keyset, at)
-        : (keyset: StorageKey[]) => this._rpcCore.state.queryStorageAt<Codec[]>(keyset)
+        ? (keyset: StorageKey[]) => this._rpcCore.state.queryStorageAt(keyset, at)
+        : (keyset: StorageKey[]) => this._rpcCore.state.queryStorageAt(keyset)
       // this is horrible, but need older support (which now doesn't work with at)
-      : (keyset: StorageKey[]) => this._rpcCore.state.subscribeStorage<Codec[]>(keyset).pipe(take(1));
+      : (keyset: StorageKey[]) => this._rpcCore.state.subscribeStorage(keyset).pipe(take(1));
 
     return this._retrieveMapKeys(entry, at, arg).pipe(
       switchMap((keys) =>

packages/api/src/base/Events.ts

@@ -5,7 +5,7 @@ import { ApiInterfaceEvents } from '../types';
 
 import EventEmitter from 'eventemitter3';
 
-export default class Events {
+export class Events {
   #eventemitter = new EventEmitter();
 
   protected emit (type: ApiInterfaceEvents, ...args: any[]): boolean {

packages/api/src/base/Getters.ts

@@ -5,10 +5,11 @@ import { RpcInterface } from '@polkadot/rpc-core/types';
 import { Hash, RuntimeVersion } from '@polkadot/types/interfaces';
 import { ApiInterfaceRx, ApiTypes, DecoratedRpc, QueryableConsts, QueryableStorage, QueryableStorageMulti, SubmittableExtrinsics } from '../types';
 
-import { Metadata, Text } from '@polkadot/types';
+import { Metadata } from '@polkadot/metadata';
+import { Text } from '@polkadot/types';
 import { assertReturn } from '@polkadot/util';
 
-import Init from './Init';
+import { Init } from './Init';
 
 interface PkgJson {
   name: string;
@@ -29,7 +30,7 @@ function assertResult<T> (value: T | undefined): T {
   return assertReturn(value, 'Api needs to be initialized before using, listen on \'ready\'');
 }
 
-export default abstract class Getters<ApiType extends ApiTypes> extends Init<ApiType> {
+export abstract class Getters<ApiType extends ApiTypes> extends Init<ApiType> {
   /**
    * @description Contains the parameter types (constants) of all modules.
    *

packages/api/src/base/Init.ts

@@ -9,20 +9,22 @@ import { VersionedRegistry } from './types';
 import BN from 'bn.js';
 import { Observable, Subscription, of } from 'rxjs';
 import { map, switchMap } from 'rxjs/operators';
-import { Metadata, Text, TypeRegistry } from '@polkadot/types';
+import { Metadata } from '@polkadot/metadata';
+import { Text } from '@polkadot/types';
+import { TypeRegistry } from '@polkadot/types/create';
 import { LATEST_EXTRINSIC_VERSION } from '@polkadot/types/extrinsic/Extrinsic';
 import { getSpecAlias, getSpecTypes, getUpgradeVersion } from '@polkadot/types-known';
 import { BN_ZERO, assert, logger, u8aEq, u8aToU8a } from '@polkadot/util';
 import { cryptoWaitReady } from '@polkadot/util-crypto';
 
-import Decorate from './Decorate';
+import { Decorate } from './Decorate';
 
 const KEEPALIVE_INTERVAL = 15000;
 const DEFAULT_BLOCKNUMBER = { unwrap: () => BN_ZERO };
 
 const l = logger('api/init');
 
-export default abstract class Init<ApiType extends ApiTypes> extends Decorate<ApiType> {
+export abstract class Init<ApiType extends ApiTypes> extends Decorate<ApiType> {
   #healthTimer: NodeJS.Timeout | null = null;
 
   #registries: VersionedRegistry[] = [];
@@ -317,6 +319,7 @@ export default abstract class Init<ApiType extends ApiTypes> extends Decorate<Ap
       const error = new Error(`FATAL: Unable to initialize the API: ${(_error as Error).message}`);
 
       l.error(error);
+      l.error(_error);
 
       this.emit('error', error);
     }

packages/api/src/base/index.ts

@@ -6,7 +6,7 @@ import { ApiOptions, ApiTypes, DecorateMethod, Signer } from '../types';
 
 import { assert, isString, u8aToHex, u8aToU8a } from '@polkadot/util';
 
-import Getters from './Getters';
+import { Getters } from './Getters';
 
 interface KeyringSigner {
   sign (message: Uint8Array): Uint8Array;
@@ -16,7 +16,7 @@ interface SignerRawOptions {
   signer?: Signer;
 }
 
-export default abstract class ApiBase<ApiType extends ApiTypes> extends Getters<ApiType> {
+export abstract class ApiBase<ApiType extends ApiTypes> extends Getters<ApiType> {
   /**
    * @description Create an instance of the class
    *

packages/api/src/base/types.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { Constants } from '@polkadot/metadata/decorate/types';
-import { Metadata } from '@polkadot/types';
+import { Metadata } from '@polkadot/metadata';
 import { Registry } from '@polkadot/types/types';
 
 import BN from 'bn.js';

packages/api/src/checkTypes.manual.ts

@@ -8,8 +8,8 @@ import { IExtrinsic, IMethod } from '@polkadot/types/types';
 
 import { ApiPromise } from '@polkadot/api';
 import { HeaderExtended } from '@polkadot/api-derive';
-import testKeyring, { TestKeyringMap } from '@polkadot/keyring/testingPairs';
-import { createTypeUnsafe, TypeRegistry } from '@polkadot/types';
+import { TestKeyringMap, createTestPairs } from '@polkadot/keyring/testingPairs';
+import { createTypeUnsafe, TypeRegistry } from '@polkadot/types/create';
 
 import { SubmittableResult } from './';
 
@@ -34,7 +34,7 @@ async function derive (api: ApiPromise): Promise<void> {
   console.log('fees', fees);
 }
 
-async function query (api: ApiPromise, keyring: TestKeyringMap): Promise<void> {
+async function query (api: ApiPromise, pairs: TestKeyringMap): Promise<void> {
   const intentions = await api.query.staking.bonded();
 
   console.log('intentions:', intentions);
@@ -47,7 +47,7 @@ async function query (api: ApiPromise, keyring: TestKeyringMap): Promise<void> {
   const oldBal = await api.query.balances.totalIssuance.at('abcd');
   // It's hard to correctly type .multi. Expected: `Balance[]`, actual: Codec[].
   // In the meantime, we can case with `<Balance>` (this is not available on recent chains)
-  const multi = await api.query.balances.freeBalance.multi<Balance>([keyring.alice.address, keyring.bob.address]);
+  const multi = await api.query.balances.freeBalance.multi<Balance>([pairs.alice.address, pairs.bob.address]);
 
   console.log('query types:', bar, bal, bal2, override, oldBal, multi);
 
@@ -63,15 +63,15 @@ async function query (api: ApiPromise, keyring: TestKeyringMap): Promise<void> {
 
   // check multi , Promise result
   const multiRes = await api.queryMulti([
-    [api.query.system.account, keyring.eve.address],
+    [api.query.system.account, pairs.eve.address],
     // older chains only
-    [api.query.system.accountNonce, keyring.eve.address]
+    [api.query.system.accountNonce, pairs.eve.address]
   ]);
 
   console.log(multiRes);
 }
 
-async function queryExtra (api: ApiPromise, keyring: TestKeyringMap): Promise<void> {
+async function queryExtra (api: ApiPromise, pairs: TestKeyringMap): Promise<void> {
   // events destructing
   await api.query.system.events((records): void => {
     records.forEach(({ event, phase }): void => {
@@ -96,7 +96,7 @@ async function queryExtra (api: ApiPromise, keyring: TestKeyringMap): Promise<vo
   await api.query.staking.nominatorSlashInEra.entries(123); // should take a param
 
   // check range
-  await api.query.balances.freeBalance.range<Balance>(['0x1234'], keyring.bob.address);
+  await api.query.balances.freeBalance.range<Balance>(['0x1234'], pairs.bob.address);
 
   // check range types
   const entries = await api.query.system.events.range(['0x12345', '0x7890']);
@@ -139,33 +139,33 @@ function types (api: ApiPromise): void {
   console.log(balance, gas, compact, gasUnsafe, overriddenUnsafe, api.createType('AccountData'));
 }
 
-async function tx (api: ApiPromise, keyring: TestKeyringMap): Promise<void> {
+async function tx (api: ApiPromise, pairs: TestKeyringMap): Promise<void> {
   // transfer, also allows for BigInt inputs here
-  const transfer = api.tx.balances.transfer(keyring.bob.address, 123456789n);
+  const transfer = api.tx.balances.transfer(pairs.bob.address, 123456789n);
 
   console.log('transfer casted', transfer as IMethod, transfer as IExtrinsic);
 
   // simple "return the hash" variant
-  console.log('hash:', (await transfer.signAndSend(keyring.alice)).toHex());
+  console.log('hash:', (await transfer.signAndSend(pairs.alice)).toHex());
 
   // passing options, but waiting for hash
-  const nonce = await api.query.system.accountNonce<Index>(keyring.alice.address);
+  const nonce = await api.query.system.accountNonce<Index>(pairs.alice.address);
 
   (await api.tx.balances
-    .transfer(keyring.bob.address, 12345)
-    .signAndSend(keyring.alice, { nonce })
+    .transfer(pairs.bob.address, 12345)
+    .signAndSend(pairs.alice, { nonce })
   ).toHex();
 
   // just with the callback
   await api.tx.balances
-    .transfer(keyring.bob.address, 12345)
-    .signAndSend(keyring.alice, ({ status }: SubmittableResult) => console.log(status.type));
+    .transfer(pairs.bob.address, 12345)
+    .signAndSend(pairs.alice, ({ status }: SubmittableResult) => console.log(status.type));
 
   // with options and the callback
-  const nonce2 = await api.query.system.accountNonce(keyring.alice.address);
+  const nonce2 = await api.query.system.accountNonce(pairs.alice.address);
   const unsub2 = await api.tx.balances
-    .transfer(keyring.bob.address, 12345)
-    .signAndSend(keyring.alice, { nonce: nonce2 }, ({ status }: SubmittableResult): void => {
+    .transfer(pairs.bob.address, 12345)
+    .signAndSend(pairs.alice, { nonce: nonce2 }, ({ status }: SubmittableResult): void => {
       console.log('transfer status:', status.type);
 
       unsub2();
@@ -178,22 +178,22 @@ async function tx (api: ApiPromise, keyring: TestKeyringMap): Promise<void> {
   await second.signAndSend('123', (result) => console.log(result));
 
   // it handles enum inputs correctly
-  await api.tx.democracy.proxyVote(123, { Split: { nay: 456, yay: 123 } }).signAndSend(keyring.alice);
+  await api.tx.democracy.proxyVote(123, { Split: { nay: 456, yay: 123 } }).signAndSend(pairs.alice);
 }
 
 async function main (): Promise<void> {
   const api = await ApiPromise.create();
-  const keyring = testKeyring();
+  const pairs = createTestPairs();
 
   // eslint-disable-next-line @typescript-eslint/no-floating-promises
   Promise.all([
     consts(api),
     derive(api),
-    query(api, keyring),
-    queryExtra(api, keyring),
+    query(api, pairs),
+    queryExtra(api, pairs),
     rpc(api),
     types(api),
-    tx(api, keyring)
+    tx(api, pairs)
   ]);
 }
 

packages/api/src/detectPackage.ts

@@ -0,0 +1,8 @@
+// Copyright 2017-2020 @polkadot/api authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { detectPackage } from '@polkadot/util';
+
+// FIXME This really should be `import(...).then(...)`, but need to check rejections
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+detectPackage(require('./package.json'), typeof __dirname !== 'undefined' && __dirname);

packages/api/src/index.ts

@@ -1,15 +1,12 @@
 // Copyright 2017-2020 @polkadot/api authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import { detectPackage } from '@polkadot/util';
-
-// FIXME This really should be `import(...).then(...)`, but need to check rejections
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-detectPackage(require('./package.json'), typeof __dirname !== 'undefined' && __dirname);
+import './detectPackage';
 
 export { Keyring } from '@polkadot/keyring';
-export { default as WsProvider } from '@polkadot/rpc-provider/ws';
+export { WsProvider } from '@polkadot/rpc-provider/ws';
 
-export { default as ApiPromise } from './promise';
-export { default as ApiRx } from './rx';
-export * from './submittable';
+export { ApiPromise } from './promise';
+export { ApiRx } from './rx';
+
+export { SubmittableResult } from './submittable';

packages/api/src/promise/Api.ts

@@ -1,304 +0,0 @@
-// Copyright 2017-2020 @polkadot/api authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Callback, Codec } from '@polkadot/types/types';
-import { ApiOptions, DecorateFn, DecorateMethodOptions, ObsInnerType, StorageEntryPromiseOverloads, UnsubscribePromise, VoidFn } from '../types';
-
-import { EMPTY, Observable, Subscription } from 'rxjs';
-import { catchError, tap } from 'rxjs/operators';
-import { isFunction, assert } from '@polkadot/util';
-
-import ApiBase from '../base';
-import Combinator, { CombinatorCallback, CombinatorFunction } from './Combinator';
-
-interface Tracker<T> {
-  reject: (value: Error) => Observable<never>;
-  resolve: (value: T) => void;
-}
-
-// extract the arguments and callback params from a value array possibly containing a callback
-function extractArgs (args: unknown[], needsCallback: boolean): [unknown[], Callback<Codec> | undefined] {
-  let callback: Callback<Codec> | undefined;
-  const actualArgs = args.slice();
-
-  // If the last arg is a function, we pop it, put it into callback.
-  // actualArgs will then hold the actual arguments to be passed to `method`
-  if (args.length && isFunction(args[args.length - 1])) {
-    callback = actualArgs.pop() as Callback<Codec>;
-  }
-
-  // When we need a subscription, ensure that a valid callback is actually passed
-  assert(!needsCallback || isFunction(callback), 'Expected a callback to be passed with subscriptions');
-
-  return [actualArgs, callback];
-}
-
-// a Promise completion tracker, wrapping an isComplete variable that ensures the promise only resolves once
-function promiseTracker<T> (resolve: (value: T) => void, reject: (value: Error) => void): Tracker<T> {
-  let isCompleted = false;
-
-  return {
-    reject: (error: Error): Observable<never> => {
-      if (!isCompleted) {
-        isCompleted = true;
-
-        reject(error);
-      }
-
-      return EMPTY;
-    },
-    resolve: (value: T): void => {
-      if (!isCompleted) {
-        isCompleted = true;
-
-        resolve(value);
-      }
-    }
-  };
-}
-
-// Decorate a call for a single-shot result - retrieve and then immediate unsubscribe
-function decorateCall<Method extends DecorateFn<ObsInnerType<ReturnType<Method>>>> (method: Method, actualArgs: unknown[]): Promise<ObsInnerType<ReturnType<Method>>> {
-  return new Promise((resolve, reject): void => {
-    // single result tracker - either reject with Error or resolve with Codec result
-    const tracker = promiseTracker(resolve, reject);
-
-    // encoding errors reject immediately, any result unsubscribes and resolves
-    const subscription: Subscription = method(...actualArgs).pipe(
-      catchError((error) => tracker.reject(error))
-    ).subscribe((result): void => {
-      tracker.resolve(result);
-      setTimeout(() => subscription.unsubscribe(), 0);
-    });
-  });
-}
-
-// Decorate a subscription where we have a result callback specified
-function decorateSubscribe<Method extends DecorateFn<ObsInnerType<ReturnType<Method>>>> (method: Method, actualArgs: unknown[], resultCb: Callback<Codec>): UnsubscribePromise {
-  return new Promise<VoidFn>((resolve, reject): void => {
-    // either reject with error or resolve with unsubscribe callback
-    const tracker = promiseTracker(resolve, reject);
-
-    // errors reject immediately, the first result resolves with an unsubscribe promise, all results via callback
-    const subscription: Subscription = method(...actualArgs).pipe(
-      catchError((error) => tracker.reject(error)),
-      tap(() => tracker.resolve(() => subscription.unsubscribe()))
-    ).subscribe((result): void => {
-      // queue result (back of queue to clear current)
-      setTimeout(() => resultCb(result) as void, 0);
-    });
-  });
-}
-
-/**
- * @description Decorate method for ApiPromise, where the results are converted to the Promise equivalent
- */
-export function decorateMethod<Method extends DecorateFn<ObsInnerType<ReturnType<Method>>>> (method: Method, options?: DecorateMethodOptions): StorageEntryPromiseOverloads {
-  const needsCallback = options && options.methodName && options.methodName.includes('subscribe');
-
-  return function (...args: unknown[]): Promise<ObsInnerType<ReturnType<Method>>> | UnsubscribePromise {
-    const [actualArgs, resultCb] = extractArgs(args, !!needsCallback);
-
-    return resultCb
-      ? decorateSubscribe(method, actualArgs, resultCb)
-      : decorateCall((options?.overrideNoSub as Method) || method, actualArgs);
-  } as StorageEntryPromiseOverloads;
-}
-
-/**
- * # @polkadot/api/promise
- *
- * ## Overview
- *
- * @name ApiPromise
- * @description
- * ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Polkadot network. As a full Promise-based, all interface calls return Promises, including the static `.create(...)`. Subscription calls utilise `(value) => {}` callbacks to pass through the latest values.
- *
- * The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Polkadot (and Substrate) clients.
- *
- * @see [[ApiRx]]
- *
- * ## Usage
- *
- * Making rpc calls -
- * <BR>
- *
- * ```javascript
- * import ApiPromise from '@polkadot/api/promise';
- *
- * // initialise via static create
- * const api = await ApiPromise.create();
- *
- * // make a subscription to the network head
- * api.rpc.chain.subscribeNewHeads((header) => {
- *   console.log(`Chain is at #${header.number}`);
- * });
- * ```
- * <BR>
- *
- * Subscribing to chain state -
- * <BR>
- *
- * ```javascript
- * import { ApiPromise, WsProvider } from '@polkadot/api';
- *
- * // initialise a provider with a specific endpoint
- * const provider = new WsProvider('wss://example.com:9944')
- *
- * // initialise via isReady & new with specific provider
- * const api = await new ApiPromise({ provider }).isReady;
- *
- * // retrieve the block target time
- * const blockPeriod = await api.query.timestamp.blockPeriod().toNumber();
- * let last = 0;
- *
- * // subscribe to the current block timestamp, updates automatically (callback provided)
- * api.query.timestamp.now((timestamp) => {
- *   const elapsed = last
- *     ? `, ${timestamp.toNumber() - last}s since last`
- *     : '';
- *
- *   last = timestamp.toNumber();
- *   console.log(`timestamp ${timestamp}${elapsed} (${blockPeriod}s target)`);
- * });
- * ```
- * <BR>
- *
- * Submitting a transaction -
- * <BR>
- *
- * ```javascript
- * import ApiPromise from '@polkadot/api/promise';
- *
- * ApiPromise.create().then((api) => {
- *   const [nonce] = await api.query.system.account(keyring.alice.address);
- *
- *   api.tx.balances
- *     // create transfer
- *     transfer(keyring.bob.address, 12345)
- *     // sign the transcation
- *     .sign(keyring.alice, { nonce })
- *     // send the transaction (optional status callback)
- *     .send((status) => {
- *       console.log(`current status ${status.type}`);
- *     })
- *     // retrieve the submitted extrinsic hash
- *     .then((hash) => {
- *       console.log(`submitted with hash ${hash}`);
- *     });
- * });
- * ```
- */
-export default class ApiPromise extends ApiBase<'promise'> {
-  #isReadyPromise: Promise<ApiPromise>;
-  #isReadyOrErrorPromise: Promise<ApiPromise>;
-
-  /**
-   * @description Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
-   * @param options options that is passed to the class contructor. Can be either [[ApiOptions]] or a
-   * provider (see the constructor arguments)
-   * @example
-   * <BR>
-   *
-   * ```javascript
-   * import Api from '@polkadot/api/promise';
-   *
-   * Api.create().then(async (api) => {
-   *   const timestamp = await api.query.timestamp.now();
-   *
-   *   console.log(`lastest block timestamp ${timestamp}`);
-   * });
-   * ```
-   */
-  public static create (options?: ApiOptions): Promise<ApiPromise> {
-    return new ApiPromise(options).isReady;
-  }
-
-  /**
-   * @description Creates an instance of the ApiPromise class
-   * @param options Options to create an instance. This can be either [[ApiOptions]] or
-   * an [[WsProvider]].
-   * @example
-   * <BR>
-   *
-   * ```javascript
-   * import Api from '@polkadot/api/promise';
-   *
-   * new Api().isReady.then((api) => {
-   *   api.rpc.subscribeNewHeads((header) => {
-   *     console.log(`new block #${header.number.toNumber()}`);
-   *   });
-   * });
-   * ```
-   */
-  constructor (options?: ApiOptions) {
-    super(options, 'promise', decorateMethod);
-
-    this.#isReadyPromise = new Promise((resolve): void => {
-      super.once('ready', (): void => {
-        resolve(this);
-      });
-    });
-
-    this.#isReadyOrErrorPromise = new Promise((resolve, reject): void => {
-      super.once('ready', (): void => {
-        resolve(this);
-      });
-      super.once('error', (e): void => {
-        reject(e);
-      });
-    });
-  }
-
-  /**
-   * @description Promise that resolves the first time we are connected and loaded
-   */
-  public get isReady (): Promise<ApiPromise> {
-    return this.#isReadyPromise;
-  }
-
-  /**
-   * @description Promise that resolves if we can connect, or reject if there is an error
-   */
-  public get isReadyOrError (): Promise<ApiPromise> {
-    return this.#isReadyOrErrorPromise;
-  }
-
-  /**
-   * @description Returns a clone of this ApiPromise instance (new underlying provider connection)
-   */
-  public clone (): ApiPromise {
-    return new ApiPromise({
-      ...this._options,
-      source: this
-    });
-  }
-
-  /**
-   * @description Creates a combinator that can be used to combine the latest results from multiple subscriptions
-   * @param fns An array of function to combine, each in the form of `(cb: (value: void)) => void`
-   * @param callback A callback that will return an Array of all the values this combinator has been applied to
-   * @example
-   * <BR>
-   *
-   * ```javascript
-   * const address = '5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7';
-   *
-   * // combines values from balance & nonce as it updates
-   * api.combineLatest([
-   *   api.rpc.chain.subscribeNewHeads,
-   *   (cb) => api.query.system.account(address, cb)
-   * ], ([head, [balance, nonce]]) => {
-   *   console.log(`#${head.number}: You have ${balance.free} units, with ${nonce} transactions sent`);
-   * });
-   * ```
-   */
-  // eslint-disable-next-line @typescript-eslint/require-await
-  public async combineLatest <T extends any[] = any[]> (fns: (CombinatorFunction | [CombinatorFunction, ...any[]])[], callback: CombinatorCallback<T>): UnsubscribePromise {
-    const combinator = new Combinator(fns, callback);
-
-    return (): void => {
-      combinator.unsubscribe();
-    };
-  }
-}

packages/api/src/promise/Combinator.ts

@@ -12,7 +12,7 @@ export interface CombinatorFunction {
   (cb: Callback<any>): UnsubscribePromise;
 }
 
-export default class Combinator<T extends any[] = any[]> {
+export class Combinator<T extends any[] = any[]> {
   #allHasFired = false;
 
   #callback: CombinatorCallback<T>;

packages/api/src/promise/Combinators.spec.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { UnsubscribePromise } from '../types';
-import Combinator from './Combinator';
+import { Combinator } from './Combinator';
 
 describe('Combinator', (): void => {
   let fns: ((value: any) => void)[] = [];

packages/api/src/promise/index.spec.ts

@@ -3,20 +3,20 @@
 
 import { ApiOptions, SubmittableExtrinsic } from '../types';
 
-import createPair from '@polkadot/keyring/pair';
-import testKeyring from '@polkadot/keyring/testing';
-import Mock from '@polkadot/rpc-provider/mock/index';
-import { TypeRegistry } from '@polkadot/types';
+import { createPair } from '@polkadot/keyring/pair';
+import { createTestKeyring } from '@polkadot/keyring/testing';
+import { MockProvider } from '@polkadot/rpc-provider/mock';
+import { TypeRegistry } from '@polkadot/types/create';
 import { hexToU8a } from '@polkadot/util';
 
 import { SingleAccountSigner } from '../../test/util';
-import ApiPromise from './Api';
+import { ApiPromise } from '.';
 
 const TRANSFER_SIG = '0x7a10e5ed9a14284eca7bea53f81631981dddda5a3d2dee973b136475947264801465726e4829ae3994d9058df638d959d4e043c7f1924299546790dda1dea20a';
 
 describe('ApiPromise', (): void => {
   const registry = new TypeRegistry();
-  const keyring = testKeyring({ type: 'ed25519' });
+  const keyring = createTestKeyring({ type: 'ed25519' });
   const aliceEd = keyring.addPair(
     // eslint-disable-next-line @typescript-eslint/unbound-method
     createPair({ toSS58: keyring.encodeAddress, type: 'ed25519' }, {
@@ -24,7 +24,7 @@ describe('ApiPromise', (): void => {
       secretKey: hexToU8a('0xabf8e5bdbe30c65656c0a3cbd181ff8a56294a69dfedd27982aace4a7690911588dc3417d5058ec4b4503e0c12ea1a0a89be200fe98922423d4334014fa6b0ee')
     })
   );
-  let provider: Mock;
+  let provider: MockProvider;
 
   async function createTransfer (): Promise<{ api: ApiPromise; transfer: SubmittableExtrinsic<'promise'> }> {
     provider.subscriptions.state_subscribeStorage.lastValue = {
@@ -45,7 +45,7 @@ describe('ApiPromise', (): void => {
 
   beforeEach((): void => {
     jest.setTimeout(3000000);
-    provider = new Mock(registry);
+    provider = new MockProvider(registry);
   });
 
   describe('initialization', (): void => {

packages/api/src/promise/index.ts

@@ -1,7 +1,304 @@
 // Copyright 2017-2020 @polkadot/api authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import ApiPromise, { decorateMethod } from './Api';
+import { Callback, Codec } from '@polkadot/types/types';
+import { ApiOptions, DecorateFn, DecorateMethodOptions, ObsInnerType, StorageEntryPromiseOverloads, UnsubscribePromise, VoidFn } from '../types';
 
-export default ApiPromise;
-export { decorateMethod };
+import { EMPTY, Observable, Subscription } from 'rxjs';
+import { catchError, tap } from 'rxjs/operators';
+import { isFunction, assert } from '@polkadot/util';
+
+import { ApiBase } from '../base';
+import { Combinator, CombinatorCallback, CombinatorFunction } from './Combinator';
+
+interface Tracker<T> {
+  reject: (value: Error) => Observable<never>;
+  resolve: (value: T) => void;
+}
+
+// extract the arguments and callback params from a value array possibly containing a callback
+function extractArgs (args: unknown[], needsCallback: boolean): [unknown[], Callback<Codec> | undefined] {
+  let callback: Callback<Codec> | undefined;
+  const actualArgs = args.slice();
+
+  // If the last arg is a function, we pop it, put it into callback.
+  // actualArgs will then hold the actual arguments to be passed to `method`
+  if (args.length && isFunction(args[args.length - 1])) {
+    callback = actualArgs.pop() as Callback<Codec>;
+  }
+
+  // When we need a subscription, ensure that a valid callback is actually passed
+  assert(!needsCallback || isFunction(callback), 'Expected a callback to be passed with subscriptions');
+
+  return [actualArgs, callback];
+}
+
+// a Promise completion tracker, wrapping an isComplete variable that ensures the promise only resolves once
+function promiseTracker<T> (resolve: (value: T) => void, reject: (value: Error) => void): Tracker<T> {
+  let isCompleted = false;
+
+  return {
+    reject: (error: Error): Observable<never> => {
+      if (!isCompleted) {
+        isCompleted = true;
+
+        reject(error);
+      }
+
+      return EMPTY;
+    },
+    resolve: (value: T): void => {
+      if (!isCompleted) {
+        isCompleted = true;
+
+        resolve(value);
+      }
+    }
+  };
+}
+
+// Decorate a call for a single-shot result - retrieve and then immediate unsubscribe
+function decorateCall<Method extends DecorateFn<ObsInnerType<ReturnType<Method>>>> (method: Method, actualArgs: unknown[]): Promise<ObsInnerType<ReturnType<Method>>> {
+  return new Promise((resolve, reject): void => {
+    // single result tracker - either reject with Error or resolve with Codec result
+    const tracker = promiseTracker(resolve, reject);
+
+    // encoding errors reject immediately, any result unsubscribes and resolves
+    const subscription: Subscription = method(...actualArgs).pipe(
+      catchError((error) => tracker.reject(error))
+    ).subscribe((result): void => {
+      tracker.resolve(result);
+      setTimeout(() => subscription.unsubscribe(), 0);
+    });
+  });
+}
+
+// Decorate a subscription where we have a result callback specified
+function decorateSubscribe<Method extends DecorateFn<ObsInnerType<ReturnType<Method>>>> (method: Method, actualArgs: unknown[], resultCb: Callback<Codec>): UnsubscribePromise {
+  return new Promise<VoidFn>((resolve, reject): void => {
+    // either reject with error or resolve with unsubscribe callback
+    const tracker = promiseTracker(resolve, reject);
+
+    // errors reject immediately, the first result resolves with an unsubscribe promise, all results via callback
+    const subscription: Subscription = method(...actualArgs).pipe(
+      catchError((error) => tracker.reject(error)),
+      tap(() => tracker.resolve(() => subscription.unsubscribe()))
+    ).subscribe((result): void => {
+      // queue result (back of queue to clear current)
+      setTimeout(() => resultCb(result) as void, 0);
+    });
+  });
+}
+
+/**
+ * @description Decorate method for ApiPromise, where the results are converted to the Promise equivalent
+ */
+export function decorateMethod<Method extends DecorateFn<ObsInnerType<ReturnType<Method>>>> (method: Method, options?: DecorateMethodOptions): StorageEntryPromiseOverloads {
+  const needsCallback = options && options.methodName && options.methodName.includes('subscribe');
+
+  return function (...args: unknown[]): Promise<ObsInnerType<ReturnType<Method>>> | UnsubscribePromise {
+    const [actualArgs, resultCb] = extractArgs(args, !!needsCallback);
+
+    return resultCb
+      ? decorateSubscribe(method, actualArgs, resultCb)
+      : decorateCall((options?.overrideNoSub as Method) || method, actualArgs);
+  } as StorageEntryPromiseOverloads;
+}
+
+/**
+ * # @polkadot/api/promise
+ *
+ * ## Overview
+ *
+ * @name ApiPromise
+ * @description
+ * ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Polkadot network. As a full Promise-based, all interface calls return Promises, including the static `.create(...)`. Subscription calls utilise `(value) => {}` callbacks to pass through the latest values.
+ *
+ * The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Polkadot (and Substrate) clients.
+ *
+ * @see [[ApiRx]]
+ *
+ * ## Usage
+ *
+ * Making rpc calls -
+ * <BR>
+ *
+ * ```javascript
+ * import ApiPromise from '@polkadot/api/promise';
+ *
+ * // initialise via static create
+ * const api = await ApiPromise.create();
+ *
+ * // make a subscription to the network head
+ * api.rpc.chain.subscribeNewHeads((header) => {
+ *   console.log(`Chain is at #${header.number}`);
+ * });
+ * ```
+ * <BR>
+ *
+ * Subscribing to chain state -
+ * <BR>
+ *
+ * ```javascript
+ * import { ApiPromise, WsProvider } from '@polkadot/api';
+ *
+ * // initialise a provider with a specific endpoint
+ * const provider = new WsProvider('wss://example.com:9944')
+ *
+ * // initialise via isReady & new with specific provider
+ * const api = await new ApiPromise({ provider }).isReady;
+ *
+ * // retrieve the block target time
+ * const blockPeriod = await api.query.timestamp.blockPeriod().toNumber();
+ * let last = 0;
+ *
+ * // subscribe to the current block timestamp, updates automatically (callback provided)
+ * api.query.timestamp.now((timestamp) => {
+ *   const elapsed = last
+ *     ? `, ${timestamp.toNumber() - last}s since last`
+ *     : '';
+ *
+ *   last = timestamp.toNumber();
+ *   console.log(`timestamp ${timestamp}${elapsed} (${blockPeriod}s target)`);
+ * });
+ * ```
+ * <BR>
+ *
+ * Submitting a transaction -
+ * <BR>
+ *
+ * ```javascript
+ * import ApiPromise from '@polkadot/api/promise';
+ *
+ * ApiPromise.create().then((api) => {
+ *   const [nonce] = await api.query.system.account(keyring.alice.address);
+ *
+ *   api.tx.balances
+ *     // create transfer
+ *     transfer(keyring.bob.address, 12345)
+ *     // sign the transcation
+ *     .sign(keyring.alice, { nonce })
+ *     // send the transaction (optional status callback)
+ *     .send((status) => {
+ *       console.log(`current status ${status.type}`);
+ *     })
+ *     // retrieve the submitted extrinsic hash
+ *     .then((hash) => {
+ *       console.log(`submitted with hash ${hash}`);
+ *     });
+ * });
+ * ```
+ */
+export class ApiPromise extends ApiBase<'promise'> {
+  #isReadyPromise: Promise<ApiPromise>;
+  #isReadyOrErrorPromise: Promise<ApiPromise>;
+
+  /**
+   * @description Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
+   * @param options options that is passed to the class contructor. Can be either [[ApiOptions]] or a
+   * provider (see the constructor arguments)
+   * @example
+   * <BR>
+   *
+   * ```javascript
+   * import Api from '@polkadot/api/promise';
+   *
+   * Api.create().then(async (api) => {
+   *   const timestamp = await api.query.timestamp.now();
+   *
+   *   console.log(`lastest block timestamp ${timestamp}`);
+   * });
+   * ```
+   */
+  public static create (options?: ApiOptions): Promise<ApiPromise> {
+    return new ApiPromise(options).isReady;
+  }
+
+  /**
+   * @description Creates an instance of the ApiPromise class
+   * @param options Options to create an instance. This can be either [[ApiOptions]] or
+   * an [[WsProvider]].
+   * @example
+   * <BR>
+   *
+   * ```javascript
+   * import Api from '@polkadot/api/promise';
+   *
+   * new Api().isReady.then((api) => {
+   *   api.rpc.subscribeNewHeads((header) => {
+   *     console.log(`new block #${header.number.toNumber()}`);
+   *   });
+   * });
+   * ```
+   */
+  constructor (options?: ApiOptions) {
+    super(options, 'promise', decorateMethod);
+
+    this.#isReadyPromise = new Promise((resolve): void => {
+      super.once('ready', (): void => {
+        resolve(this);
+      });
+    });
+
+    this.#isReadyOrErrorPromise = new Promise((resolve, reject): void => {
+      super.once('ready', (): void => {
+        resolve(this);
+      });
+      super.once('error', (e): void => {
+        reject(e);
+      });
+    });
+  }
+
+  /**
+   * @description Promise that resolves the first time we are connected and loaded
+   */
+  public get isReady (): Promise<ApiPromise> {
+    return this.#isReadyPromise;
+  }
+
+  /**
+   * @description Promise that resolves if we can connect, or reject if there is an error
+   */
+  public get isReadyOrError (): Promise<ApiPromise> {
+    return this.#isReadyOrErrorPromise;
+  }
+
+  /**
+   * @description Returns a clone of this ApiPromise instance (new underlying provider connection)
+   */
+  public clone (): ApiPromise {
+    return new ApiPromise({
+      ...this._options,
+      source: this
+    });
+  }
+
+  /**
+   * @description Creates a combinator that can be used to combine the latest results from multiple subscriptions
+   * @param fns An array of function to combine, each in the form of `(cb: (value: void)) => void`
+   * @param callback A callback that will return an Array of all the values this combinator has been applied to
+   * @example
+   * <BR>
+   *
+   * ```javascript
+   * const address = '5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7';
+   *
+   * // combines values from balance & nonce as it updates
+   * api.combineLatest([
+   *   api.rpc.chain.subscribeNewHeads,
+   *   (cb) => api.query.system.account(address, cb)
+   * ], ([head, [balance, nonce]]) => {
+   *   console.log(`#${head.number}: You have ${balance.free} units, with ${nonce} transactions sent`);
+   * });
+   * ```
+   */
+  // eslint-disable-next-line @typescript-eslint/require-await
+  public async combineLatest <T extends any[] = any[]> (fns: (CombinatorFunction | [CombinatorFunction, ...any[]])[], callback: CombinatorCallback<T>): UnsubscribePromise {
+    const combinator = new Combinator(fns, callback);
+
+    return (): void => {
+      combinator.unsubscribe();
+    };
+  }
+}

packages/api/src/rx/Api.ts

@@ -1,191 +0,0 @@
-// Copyright 2017-2020 @polkadot/api authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Codec } from '@polkadot/types/types';
-import { ApiOptions, DecorateFn } from '../types';
-
-import { from, Observable } from 'rxjs';
-
-import ApiBase from '../base';
-
-export function decorateMethod <Method extends DecorateFn<Codec>> (method: Method): Method {
-  return method;
-}
-
-/**
- * # @polkadot/api/rx
- *
- *  ## Overview
- *
- * @name ApiRx
- *
- * @description
- * ApiRx is a powerful RxJS Observable wrapper around the RPC and interfaces on the Polkadot network. As a full Observable API, all interface calls return RxJS Observables, including the static `.create(...)`. In the same fashion and subscription-based methods return long-running Observables that update with the latest values.
- *
- * The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Polkadot (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding `.subscribe` and `.pipe` on Observables will unlock full-scale use thereof.
- *
- * @see [[ApiPromise]]
- *
- * ## Usage
- *
- * Making rpc calls -
- * <BR>
- *
- * ```javascript
- * import ApiRx from '@polkadot/api/rx';
- *
- * // initialize via Promise & static create
- * const api = await ApiRx.create().toPromise();
- *
- * // make a call to retrieve the current network head
- * api.rpc.chain.subscribeNewHeads().subscribe((header) => {
- *   console.log(`Chain is at #${header.number}`);
- * });
- * ```
- * <BR>
- *
- * Subscribing to chain state -
- * <BR>
- *
- * ```javascript
- * import { combineLatest } from 'rxjs';
- * import { pairwise, switchMap } from 'rxjs/operators';
- * import { ApiRx, WsProvider } from '@polkadot/api';
- *
- *
- * // initialize a provider with a specific endpoint
- * const provider = new WsProvider('wss://example.com:9944')
- *
- * // initialize via isReady & new with specific provider
- * new ApiRx({ provider })
- *   .isReady
- *   .pipe(
- *     switchMap((api) =>
- *       combineLatest([
- *         api.query.timestamp.blockPeriod(),
- *         api.query.timestamp.now().pipe(pairwise())
- *       ])
- *     )
- *   )
- *   .subscribe(([blockPeriod, timestamp]) => {
- *      const elapsed = timestamp[1].toNumber() - timestamp[0].toNumber();
- *      console.log(`timestamp ${timestamp[1]} \nelapsed ${elapsed} \n(${blockPeriod}s target)`);
- *   });
- * ```
- * <BR>
- *
- * Submitting a transaction -
- * <BR>
- *
- * ```javascript
- * import { first, switchMap } from 'rxjs/operators';
- * import ApiRx from '@polkadot/api/rx';
- *
- * // import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
- * import testingPairs from '@polkadot/keyring/testingPairs';
- * const keyring = testingPairs();
- *
- * // get api via Promise
- * const api = await ApiRx.create().toPromise();
- *
- * // retrieve nonce for the account
- * api.query.system
- *   .account(keyring.alice.address)
- *   .pipe(
- *      first(),
- *      // pipe nonce into transfer
- *      switchMap(([nonce]) =>
- *        api.tx.balances
- *          // create transfer
- *          .transfer(keyring.bob.address, 12345)
- *          // sign the transaction
- *          .sign(keyring.alice, { nonce })
- *          // send the transaction
- *          .send()
- *      )
- *   )
- *   // subscribe to overall result
- *   .subscribe(({ status }) => {
- *     if (status.isInBlock) {
- *       console.log('Completed at block hash', status.asFinalized.toHex());
- *     }
- *   });
- * ```
- */
-export default class ApiRx extends ApiBase<'rxjs'> {
-  #isReadyRx: Observable<ApiRx>;
-
-  /**
-   * @description Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
-   * @param options options that is passed to the class constructor. Can be either [[ApiOptions]] or [[WsProvider]]
-   * @example
-   * <BR>
-   *
-   * ```javascript
-   * import { switchMap } from 'rxjs/operators';
-   * import Api from '@polkadot/api/rx';
-   *
-   * Api.create()
-   *   .pipe(
-   *     switchMap((api) =>
-   *       api.rpc.chain.subscribeNewHeads()
-   *   ))
-   *   .subscribe((header) => {
-   *     console.log(`new block #${header.number.toNumber()}`);
-   *   });
-   * ```
-   */
-  public static create (options?: ApiOptions): Observable<ApiRx> {
-    return new ApiRx(options).isReady;
-  }
-
-  /**
-   * @description Create an instance of the ApiRx class
-   * @param options Options to create an instance. Can be either [[ApiOptions]] or [[WsProvider]]
-   * @example
-   * <BR>
-   *
-   * ```javascript
-   * import { switchMap } from 'rxjs/operators';
-   * import Api from '@polkadot/api/rx';
-   *
-   * new Api().isReady
-   *   .pipe(
-   *     switchMap((api) =>
-   *       api.rpc.chain.subscribeNewHeads()
-   *   ))
-   *   .subscribe((header) => {
-   *     console.log(`new block #${header.number.toNumber()}`);
-   *   });
-   * ```
-   */
-  constructor (options?: ApiOptions) {
-    super(options, 'rxjs', decorateMethod);
-
-    this.#isReadyRx = from<Promise<ApiRx>>(
-      // You can create an observable from an event, however my mind groks this form better
-      new Promise((resolve): void => {
-        super.on('ready', (): void => {
-          resolve(this);
-        });
-      })
-    );
-  }
-
-  /**
-   * @description Observable that returns the first time we are connected and loaded
-   */
-  public get isReady (): Observable<ApiRx> {
-    return this.#isReadyRx;
-  }
-
-  /**
-   * @description Returns a clone of this ApiRx instance (new underlying provider connection)
-   */
-  public clone (): ApiRx {
-    return new ApiRx({
-      ...this._options,
-      source: this
-    });
-  }
-}

packages/api/src/rx/index.spec.ts

@@ -5,21 +5,21 @@ import { SubmittableExtrinsic } from '../submittable/types';
 
 import { Observable } from 'rxjs';
 import { map, switchMap } from 'rxjs/operators';
-import testingPairs from '@polkadot/keyring/testingPairs';
-import Mock from '@polkadot/rpc-provider/mock/index';
-import { TypeRegistry } from '@polkadot/types';
+import { createTestPairs } from '@polkadot/keyring/testingPairs';
+import { MockProvider } from '@polkadot/rpc-provider/mock';
+import { TypeRegistry } from '@polkadot/types/create';
 
 import { SingleAccountSigner } from '../../test/util';
-import ApiRx from './Api';
+import { ApiRx } from '.';
 
 describe('ApiRx', (): void => {
   const registry = new TypeRegistry();
-  const keyring = testingPairs({ type: 'ed25519' });
-  let provider: Mock;
+  const keyring = createTestPairs({ type: 'ed25519' });
+  let provider: MockProvider;
 
   beforeEach((): void => {
     jest.setTimeout(3000000);
-    provider = new Mock(registry);
+    provider = new MockProvider(registry);
   });
 
   describe('decorator.signAsync', (): void => {

packages/api/src/rx/index.ts

@@ -1,7 +1,191 @@
 // Copyright 2017-2020 @polkadot/api authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import ApiRx, { decorateMethod } from './Api';
+import { Codec } from '@polkadot/types/types';
+import { ApiOptions, DecorateFn } from '../types';
 
-export default ApiRx;
-export { decorateMethod };
+import { from, Observable } from 'rxjs';
+
+import { ApiBase } from '../base';
+
+export function decorateMethod <Method extends DecorateFn<Codec>> (method: Method): Method {
+  return method;
+}
+
+/**
+ * # @polkadot/api/rx
+ *
+ *  ## Overview
+ *
+ * @name ApiRx
+ *
+ * @description
+ * ApiRx is a powerful RxJS Observable wrapper around the RPC and interfaces on the Polkadot network. As a full Observable API, all interface calls return RxJS Observables, including the static `.create(...)`. In the same fashion and subscription-based methods return long-running Observables that update with the latest values.
+ *
+ * The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Polkadot (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding `.subscribe` and `.pipe` on Observables will unlock full-scale use thereof.
+ *
+ * @see [[ApiPromise]]
+ *
+ * ## Usage
+ *
+ * Making rpc calls -
+ * <BR>
+ *
+ * ```javascript
+ * import ApiRx from '@polkadot/api/rx';
+ *
+ * // initialize via Promise & static create
+ * const api = await ApiRx.create().toPromise();
+ *
+ * // make a call to retrieve the current network head
+ * api.rpc.chain.subscribeNewHeads().subscribe((header) => {
+ *   console.log(`Chain is at #${header.number}`);
+ * });
+ * ```
+ * <BR>
+ *
+ * Subscribing to chain state -
+ * <BR>
+ *
+ * ```javascript
+ * import { combineLatest } from 'rxjs';
+ * import { pairwise, switchMap } from 'rxjs/operators';
+ * import { ApiRx, WsProvider } from '@polkadot/api';
+ *
+ *
+ * // initialize a provider with a specific endpoint
+ * const provider = new WsProvider('wss://example.com:9944')
+ *
+ * // initialize via isReady & new with specific provider
+ * new ApiRx({ provider })
+ *   .isReady
+ *   .pipe(
+ *     switchMap((api) =>
+ *       combineLatest([
+ *         api.query.timestamp.blockPeriod(),
+ *         api.query.timestamp.now().pipe(pairwise())
+ *       ])
+ *     )
+ *   )
+ *   .subscribe(([blockPeriod, timestamp]) => {
+ *      const elapsed = timestamp[1].toNumber() - timestamp[0].toNumber();
+ *      console.log(`timestamp ${timestamp[1]} \nelapsed ${elapsed} \n(${blockPeriod}s target)`);
+ *   });
+ * ```
+ * <BR>
+ *
+ * Submitting a transaction -
+ * <BR>
+ *
+ * ```javascript
+ * import { first, switchMap } from 'rxjs/operators';
+ * import ApiRx from '@polkadot/api/rx';
+ *
+ * // import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
+ * import testingPairs from '@polkadot/keyring/testingPairs';
+ * const keyring = testingPairs();
+ *
+ * // get api via Promise
+ * const api = await ApiRx.create().toPromise();
+ *
+ * // retrieve nonce for the account
+ * api.query.system
+ *   .account(keyring.alice.address)
+ *   .pipe(
+ *      first(),
+ *      // pipe nonce into transfer
+ *      switchMap(([nonce]) =>
+ *        api.tx.balances
+ *          // create transfer
+ *          .transfer(keyring.bob.address, 12345)
+ *          // sign the transaction
+ *          .sign(keyring.alice, { nonce })
+ *          // send the transaction
+ *          .send()
+ *      )
+ *   )
+ *   // subscribe to overall result
+ *   .subscribe(({ status }) => {
+ *     if (status.isInBlock) {
+ *       console.log('Completed at block hash', status.asFinalized.toHex());
+ *     }
+ *   });
+ * ```
+ */
+export class ApiRx extends ApiBase<'rxjs'> {
+  #isReadyRx: Observable<ApiRx>;
+
+  /**
+   * @description Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
+   * @param options options that is passed to the class constructor. Can be either [[ApiOptions]] or [[WsProvider]]
+   * @example
+   * <BR>
+   *
+   * ```javascript
+   * import { switchMap } from 'rxjs/operators';
+   * import Api from '@polkadot/api/rx';
+   *
+   * Api.create()
+   *   .pipe(
+   *     switchMap((api) =>
+   *       api.rpc.chain.subscribeNewHeads()
+   *   ))
+   *   .subscribe((header) => {
+   *     console.log(`new block #${header.number.toNumber()}`);
+   *   });
+   * ```
+   */
+  public static create (options?: ApiOptions): Observable<ApiRx> {
+    return new ApiRx(options).isReady;
+  }
+
+  /**
+   * @description Create an instance of the ApiRx class
+   * @param options Options to create an instance. Can be either [[ApiOptions]] or [[WsProvider]]
+   * @example
+   * <BR>
+   *
+   * ```javascript
+   * import { switchMap } from 'rxjs/operators';
+   * import Api from '@polkadot/api/rx';
+   *
+   * new Api().isReady
+   *   .pipe(
+   *     switchMap((api) =>
+   *       api.rpc.chain.subscribeNewHeads()
+   *   ))
+   *   .subscribe((header) => {
+   *     console.log(`new block #${header.number.toNumber()}`);
+   *   });
+   * ```
+   */
+  constructor (options?: ApiOptions) {
+    super(options, 'rxjs', decorateMethod);
+
+    this.#isReadyRx = from<Promise<ApiRx>>(
+      // You can create an observable from an event, however my mind groks this form better
+      new Promise((resolve): void => {
+        super.on('ready', (): void => {
+          resolve(this);
+        });
+      })
+    );
+  }
+
+  /**
+   * @description Observable that returns the first time we are connected and loaded
+   */
+  public get isReady (): Observable<ApiRx> {
+    return this.#isReadyRx;
+  }
+
+  /**
+   * @description Returns a clone of this ApiRx instance (new underlying provider connection)
+   */
+  public clone (): ApiRx {
+    return new ApiRx({
+      ...this._options,
+      source: this
+    });
+  }
+}

packages/api/src/submittable/Result.ts

@@ -27,7 +27,7 @@ function extractInfo (events: EventRecord[] = []): DispatchInfo | undefined {
   )[0];
 }
 
-export default class SubmittableResult implements ISubmittableResult {
+export class SubmittableResult implements ISubmittableResult {
   public readonly dispatchError?: DispatchError;
 
   public readonly dispatchInfo?: DispatchInfo;

packages/api/src/submittable/createClass.ts

@@ -13,8 +13,8 @@ import { first, map, mapTo, mergeMap, switchMap, tap } from 'rxjs/operators';
 import { assert, isBn, isFunction, isNumber, isString, isU8a } from '@polkadot/util';
 
 import { filterEvents, isKeyringPair } from '../util';
-import ApiBase from '../base';
-import SubmittableResult from './Result';
+import { ApiBase } from '../base';
+import { SubmittableResult } from './Result';
 
 interface SubmittableOptions<ApiType extends ApiTypes> {
   api: ApiInterfaceRx;
@@ -24,7 +24,7 @@ interface SubmittableOptions<ApiType extends ApiTypes> {
 
 const identity = <T> (input: T): T => input;
 
-export default function createClass <ApiType extends ApiTypes> ({ api, apiType, decorateMethod }: SubmittableOptions<ApiType>): Constructor<SubmittableExtrinsic<ApiType>> {
+export function createClass <ApiType extends ApiTypes> ({ api, apiType, decorateMethod }: SubmittableOptions<ApiType>): Constructor<SubmittableExtrinsic<ApiType>> {
   // an instance of the base extrinsic for us to extend
   const ExtrinsicBase = api.registry.createClass('Extrinsic');
 

packages/api/src/submittable/createSubmittable.ts

@@ -5,12 +5,12 @@ import { Call, Extrinsic } from '@polkadot/types/interfaces';
 import { ApiInterfaceRx, ApiTypes } from '../types';
 import { SubmittableExtrinsic } from './types';
 
-import ApiBase from '../base';
-import createClass from './createClass';
+import { ApiBase } from '../base';
+import { createClass } from './createClass';
 
 type Creator<ApiType extends ApiTypes> = (extrinsic: Call | Uint8Array | string) => SubmittableExtrinsic<ApiType>;
 
-export default function createSubmittable<ApiType extends ApiTypes> (apiType: ApiTypes, api: ApiInterfaceRx, decorateMethod: ApiBase<ApiType>['_decorateMethod']): Creator<ApiType> {
+export function createSubmittable<ApiType extends ApiTypes> (apiType: ApiTypes, api: ApiInterfaceRx, decorateMethod: ApiBase<ApiType>['_decorateMethod']): Creator<ApiType> {
   const Submittable = createClass<ApiType>({ api, apiType, decorateMethod });
 
   return (extrinsic: Call | Extrinsic | Uint8Array | string): SubmittableExtrinsic<ApiType> =>

packages/api/src/submittable/index.ts

@@ -1,5 +1,5 @@
 // Copyright 2017-2020 @polkadot/api authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-export { default as createSubmittable } from './createSubmittable';
-export { default as SubmittableResult } from './Result';
+export { createSubmittable } from './createSubmittable';
+export { SubmittableResult } from './Result';

packages/api/src/types/index.ts

@@ -8,19 +8,19 @@ import type BN from 'bn.js';
 import { DeriveCustom, ExactDerive } from '@polkadot/api-derive';
 import { RpcInterface } from '@polkadot/rpc-core/types';
 import { ProviderInterface, ProviderInterfaceEmitted } from '@polkadot/rpc-provider/types';
-import { Metadata } from '@polkadot/types';
+import { Metadata } from '@polkadot/metadata';
 import { Hash, RuntimeVersion } from '@polkadot/types/interfaces';
 import { DefinitionRpc, DefinitionRpcSub, Signer, SignatureOptions, Registry, RegisteredTypes } from '@polkadot/types/types';
 
 import { DeriveAllSections } from '../util/decorate';
-import ApiBase from '../base';
+import { ApiBase } from '../base';
 import { QueryableConsts } from './consts';
 import { DecoratedRpc } from './rpc';
 import { QueryableStorage, QueryableStorageMulti } from './storage';
 import { SubmittableExtrinsics } from './submittable';
 
 export { Signer, SignerResult } from '@polkadot/types/types';
-export { default as ApiBase } from '../base';
+export { ApiBase } from '../base';
 export * from '../submittable/types';
 export * from './base';
 export * from './consts';

packages/api/src/types/storage.ts

@@ -1,11 +1,12 @@
 // Copyright 2017-2020 @polkadot/api authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import { Observable } from 'rxjs';
-import { u64 } from '@polkadot/types';
 import { Hash } from '@polkadot/types/interfaces';
 import { AnyFunction, Callback, Codec, CodecArg } from '@polkadot/types/types';
-import StorageKey, { StorageEntry } from '@polkadot/types/primitive/StorageKey';
+import { StorageEntry } from '@polkadot/types/primitive/types';
+
+import { Observable } from 'rxjs';
+import { StorageKey, u64 } from '@polkadot/types';
 
 import { ApiTypes, MethodResult, ObsInnerType, PaginationOptions, PromiseOrObs, UnsubscribePromise } from './base';
 

packages/api/src/util/augmentObject.spec.ts

@@ -1,7 +1,7 @@
 // Copyright 2017-2020 @polkadot/api authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import augmentObject from './augmentObject';
+import { augmentObject } from './augmentObject';
 
 describe('augmentObject', (): void => {
   let spy: any;

packages/api/src/util/augmentObject.ts

@@ -73,7 +73,7 @@ function extractMethods (src: Record<string, Record<string, any>>, dst: Record<s
  * already available, but rather just adds new missing ites into the result object.
  * @internal
  */
-export default function augmentObject (prefix: string | null, src: Record<string, Record<string, unknown>>, dst: Record<string, Record<string, unknown>>, fromEmpty = false): Record<string, Record<string, any>> {
+export function augmentObject (prefix: string | null, src: Record<string, Record<string, unknown>>, dst: Record<string, Record<string, unknown>>, fromEmpty = false): Record<string, Record<string, any>> {
   if (fromEmpty) {
     Object.keys(dst).forEach((key): void => {
       delete dst[key];