Initial branch with api-types replaced in types (#186)

* Upgraded with latest polkadot version (^2.3.1)

Co-authored-by: Alex Sed <[email protected]>

.eslintrc.js

@@ -75,7 +75,6 @@ module.exports = {
         ],
         "import/no-extraneous-dependencies": "off",
         "import/order": "error",
-        "no-console": "error",
         "no-duplicate-imports": "error",
         // "no-magic-numbers": "error",
         "no-return-await": "error",

README.md

@@ -4,18 +4,6 @@ The CENNZnet JavaScript API library for browsers and Node.js.
 
 ## Quick Start
 
-You must use **yarn** with @cennznet/api and set the following **resolutions** in your package.json, otherwise your install may break due to breaking changes in downstream package versions.
-``` 
-"resolutions": {
-  "@polkadot/types": "1.2.1",
-  "@polkadot/metadata": "1.2.1",
-  "@polkadot/api": "1.2.1",
-  "@polkadot/api-derive": "1.2.1",
-  "@polkadot/rpc-core": "1.2.1",
-  "@polkadot/rpc-provider": "1.2.1",
-  "@polkadot/jsonrpc": "1.2.1",
-}
-``` 
 See the [getting started guide](docs/GET_STARTED.md), [example snippets](docs/examples), or the [wiki](https://github.com/cennznet/cennznet/wiki/Javascript-API-Reference) to get started.
 
 # Components

jest/initApiRx.js

@@ -1,7 +1,7 @@
 import {WsProvider} from '@polkadot/api';
+import { TypeRegistry } from '@cennznet/types';
 import config from '../config';
 import {ApiRx} from '../packages/api/src/ApiRx';
-import { TypeRegistry } from '@cennznet/types';
 
 const initApiRx = async () => {
   const providerUrl = config.wsProvider[`${process.env.TEST_TYPE}`] || 'ws://localhost:9944';

package.json

@@ -19,48 +19,41 @@
     "lint": "eslint . --ext .ts"
   },
   "devDependencies": {
-    "@babel/cli": "^7.0.0",
-    "@babel/core": "^7.7.4",
+    "@babel/cli": "^7.12.1",
+    "@babel/core": "^7.11.6",
     "@babel/helper-skip-transparent-expression-wrappers": "^7.11.0",
     "@babel/helper-validator-identifier": "^7.10.4",
     "@babel/plugin-proposal-numeric-separator": "^7.10.4",
     "@babel/preset-env": "^7.7.6",
     "@babel/runtime-corejs3": "^7.7.6",
     "@polkadot/dev": "0.31.1",
     "@polkadot/ts": "^0.1.86",
-    "@types/jest": "^23.3.10",
-    "@typescript-eslint/eslint-plugin": "^3.10.0",
-    "@typescript-eslint/parser": "^3.10.0",
-    "babel-jest": "^24.9.0",
+    "@types/jest": "^26.0.14",
+    "@typescript-eslint/eslint-plugin": "^4.4.1",
+    "@typescript-eslint/parser": "^4.4.1",
+    "babel-jest": "^26.5.2",
     "babel-plugin-conditional-compile": "^0.0.5",
     "core-js": "^3.4.8",
-    "cz-lerna-changelog": "^2.0.2",
-    "eslint": "^7.7.0",
-    "eslint-plugin-import": "^2.22.0",
+    "eslint": "^7.11.0",
+    "eslint-plugin-import": "^2.22.1",
     "husky": "^1.1.1",
-    "jest": "24.1.0",
-    "jest-environment-node": "^24.0.0",
+    "jest": "^26.5.3",
+    "jest-environment-node": "^26.5.2",
     "lerna": "^3.13.1",
     "prettier": "^1.13.5",
     "pretty-quick": "^1.11.1",
-    "ts-jest": "^24.0.0",
+    "ts-jest": "^26.4.1",
     "ts-node": "^8.0.3",
     "tsconfig-paths": "^3.8.0",
-    "tslint": "^5.14.0",
-    "tslint-microsoft-contrib": "^5.2.1",
-    "typedoc": "^0.14.2",
+    "typedoc": "^0.19.2",
     "typedoc-plugin-monorepo": "https://github.com/ianhe8x/typedoc-plugin-monorepo",
-    "typescript": "^4.0.2"
+    "typescript": "^4.0.3",
+    "cz-lerna-changelog": "^2.0.3",
+    "semantic-release": "^15.14.0"
   },
   "resolutions": {
     "babel-core": "^7.0.0-bridge.0",
-    "typescript": "^3.7.2",
-    "braces": "^2.3.2",
-    "fstream": "^1.0.12",
-    "handlebars": "^4.5.3",
-    "js-yaml": "^3.13.1",
-    "marked": "^0.6.2",
-    "tar": "^4.4.8"
+    "typescript": "^4.0.3"
   },
   "config": {
     "commitizen": {

packages/api/README.md

@@ -2,33 +2,12 @@
 
 The CENNZNet JavaScript SDK for browsers, RN and Node.js.
 
-## Quick Start
-
-You must use **yarn** with @cennznet/api and set the following **resolutions** in your package.json, otherwise your install may break due to breaking changes in downstream package versions.
-
 ## Install
 
 ```
 $> npm i --save @cennznet/api
 ```
 
-At the moment a breaking change in the recent versions of polkadot has prevented us from updating with the recent versions. 
-That's why in package.json there should be a resolution set so we can make sure the right version of polkadot packages are fetched. Therefore you need to have the following lines in your package.json:
-```json
-"dependencies": {
-  "@cennznet/api": "^1.2.1"
-},
-"resolutions": {
-  "@polkadot/types": "1.2.1",
-  "@polkadot/metadata": "1.2.1",
-  "@polkadot/api": "1.2.1",
-  "@polkadot/api-derive": "1.2.1",
-  "@polkadot/rpc-core": "1.2.1",
-  "@polkadot/rpc-provider": "1.2.1",
-  "@polkadot/jsonrpc": "1.2.1",
-}
-``` 
-Please use yarn as package manager to install the above dependecies.
 ## Usage
 
 The cennznet's main network is residing at `wss://cennznet.unfrastructure.io/public/ws`. 
@@ -64,16 +43,14 @@ We suggest passing provider as a string url, sdk will chose Provider Class based
 
 All `api.tx.<section>.<method>(...)` return CennznetExtrinsic, which have
 
-To use doughnut or feeExchange, it is required to pass them as part of SignerOption
+To set fee exchange options on a transaction, it should be included as an additional argument when signing e.g
 
 ```
 const tx = api.tx.genericAsset.transfer(16000, 'some address', 1000000);
 
-tx.signAndSend('sender address', {doughnut, feeExchangeOpt}, callbackFn);
+tx.signAndSend('sender address', {feeExchangeOpt}, callbackFn);
 ```
 
-[see more](https://github.com/cennznet/cennznet/wiki/Javascript-API-Reference#sending-extrinsics-with-doughnut)
-
 ## Dynamic
 
 After connecting to CENNZNet, api will dynamically create queries and transaction methods.

packages/api/package.json

@@ -20,18 +20,14 @@
   },
   "dependencies": {
     "@cennznet/types": "^1.2.1",
-    "@polkadot/api": "^1.1.1",
-    "@polkadot/metadata": "1.1.1",
-    "@polkadot/rpc-core": "^1.1.1",
-    "@polkadot/rpc-provider": "^1.1.1",
-    "@polkadot/types": "^1.1.1",
+    "@polkadot/api": "^2.3.1",
+    "@polkadot/metadata": "^2.3.1",
+    "@polkadot/rpc-core": "^2.3.1",
+    "@polkadot/rpc-provider": "^2.3.1",
+    "@polkadot/types": "^2.3.1",
     "eventemitter3": "^4.0.0"
   },
-  "resolution": {
-    "@polkadot/keyring": "2.3.1"
-  },
   "devDependencies": {
-    "@cennznet/cennznut-wasm": "^0.0.1-dev.0",
     "@types/jest": "^23.3.5",
     "jest": "24.1.0",
     "rimraf": "^2.6.2",

packages/api/src/Api.ts

@@ -1,4 +1,4 @@
-// Copyright 2019 Centrality Investments Limited
+// Copyright 2019-2020 Centrality Investments Limited
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,26 +12,24 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import Types from '@cennznet/types/injects';
+import Types from '@cennznet/types/interfaces/injects';
 import { ApiPromise } from '@polkadot/api';
-import { ApiOptions as ApiOptionsBase } from '@polkadot/api/types';
+import { ApiOptions as ApiOptionsBase, SubmittableExtrinsics } from '@polkadot/api/types';
 
 import derives from './derives';
-import rpc from './rpc';
 import staticMetadata from './staticMetadata';
-import { ApiOptions, Derives, SubmittableExtrinsics } from './types';
+import { ApiOptions, Derives } from './types';
 import { mergeDeriveOptions } from './util/derives';
 import { getProvider } from './util/getProvider';
 import { getTimeout } from './util/getTimeout';
-
-export const DEFAULT_TIMEOUT = 10000;
+import rpc from './rpc';
 
 export class Api extends ApiPromise {
   static async create(options: ApiOptions = {}): Promise<Api> {
     const api = new Api(options);
     return withTimeout(
       new Promise((resolve, reject) => {
-        const rejectError = err => {
+        const rejectError = () => {
           // Disconnect provider if API initialization fails
           api.disconnect();
 
@@ -40,7 +38,7 @@ export class Api extends ApiPromise {
 
         api.isReady.then(res => {
           //  Remove error listener if API initialization success.
-          (api as any)._eventemitter.removeListener('error', rejectError);
+          (api as ApiPromise).off('error', rejectError);
           resolve((res as unknown) as Api);
         }, reject);
 
@@ -67,13 +65,13 @@ export class Api extends ApiPromise {
     options.metadata = Object.assign(staticMetadata, options.metadata);
     options.types = { ...options.types, ...Types };
     options.derives = mergeDeriveOptions(derives, options.derives);
-    options.rpc = { ...(rpc as any), ...options.rpc };
+    options.rpc = { ...rpc, ...options.rpc };
 
     super(options as ApiOptionsBase);
   }
 }
 
-async function withTimeout(promise: Promise<Api>, timeoutMs: number = DEFAULT_TIMEOUT): Promise<Api> {
+async function withTimeout(promise: Promise<Api>, timeoutMs: number): Promise<Api> {
   if (timeoutMs === 0) {
     return promise;
   }

packages/api/src/ApiRx.ts

@@ -1,4 +1,4 @@
-// Copyright 2019 Centrality Investments Limited
+// Copyright 2019-2020 Centrality Investments Limited
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,41 +12,41 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { mergeDeriveOptions } from '@cennznet/api/util/derives';
-import Types from '@cennznet/types/injects';
+import Types from '@cennznet/types/interfaces/injects';
 import { ApiRx as ApiRxBase } from '@polkadot/api';
-import { ApiOptions as ApiOptionsBase } from '@polkadot/api/types';
-import { fromEvent, Observable, race, throwError } from 'rxjs';
-import { switchMap, timeout } from 'rxjs/operators';
+import { ApiOptions as ApiOptionsBase, SubmittableExtrinsics } from '@polkadot/api/types';
+import { Observable } from 'rxjs';
+import { timeout } from 'rxjs/operators';
+import { mergeDeriveOptions } from './util/derives';
 
-import rpc from '@cennznet/api/rpc';
-import { DEFAULT_TIMEOUT } from './Api';
 import derives from './derives';
 import staticMetadata from './staticMetadata';
-import { ApiOptions, Derives, SubmittableExtrinsics } from './types';
+import { ApiOptions, Derives } from './types';
 import { getProvider } from './util/getProvider';
 import { getTimeout } from './util/getTimeout';
+import rpc from './rpc';
 
 export class ApiRx extends ApiRxBase {
   static create(options: ApiOptions = {}): Observable<ApiRx> {
     const apiRx = new ApiRx(options);
 
-    const timeoutMs = getTimeout(options);
+    const observable: Observable<ApiRx> = new Observable(x => {
+      apiRx.on('error', (): void => {
+        x.error(new Error('Connection fail'));
+      });
+      apiRx.on('disconnected', (): void => {
+        x.error(new Error('Disconnected'));
+      });
+      apiRx.on('connected', (): void => {
+        console.info('API has been connected to the endpoint');
+      });
+      apiRx.once('ready', (): void => {
+        x.next(apiRx);
+        x.complete();
+      });
+    });
 
-    const rejectError = fromEvent((apiRx as any)._eventemitter, 'error').pipe(
-      switchMap(err => {
-        // Disconnect provider if API initialization fails
-        apiRx.disconnect();
-
-        return throwError(new Error('Connection fail'));
-      })
-    );
-    const api$ = (apiRx.isReady as unknown) as Observable<ApiRx>;
-    // api$.subscribe(api => api.decorateCennznetExtrinsics());
-
-    return timeoutMs === 0
-      ? race(api$, rejectError)
-      : race(api$.pipe(timeout(timeoutMs || DEFAULT_TIMEOUT)), rejectError);
+    return observable.pipe(timeout(getTimeout(options)));
   }
 
   get tx(): SubmittableExtrinsics<'rxjs'> {
@@ -64,8 +64,8 @@ export class ApiRx extends ApiRxBase {
     }
     options.metadata = Object.assign(staticMetadata, options.metadata);
     options.types = { ...options.types, ...Types };
-    options.derives = mergeDeriveOptions(derives as any, options.derives);
-    options.rpc = { ...(rpc as any), ...options.rpc };
+    options.derives = mergeDeriveOptions(derives, options.derives);
+    options.rpc = { ...rpc, ...options.rpc };
 
     super(options as ApiOptionsBase);
   }