Chore/update readme with resolutions (#184)

* Update APIs readme as well as resolutions from example to include jsonrpc and rpc-provider * Updated readme in the doc examples
cennznet · Oct 1, 2020 · e7cfffc · e7cfffc
1 parent 95b77e1
commit e7cfffc
Show file tree

Hide file tree

Showing 33 changed files with 157 additions and 141 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,20 @@
 
 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

diff --git a/docs/GET_STARTED.md b/docs/GET_STARTED.md
@@ -21,11 +21,13 @@ Therefore you need to have the following lines in your package.json:
   "@cennznet/api": "^1.0.3"
 },
 "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/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",
 }
 ``` 
 The next step for your project is that you import @cennznet/api in your js code. The best way to do that is through a line such as:

diff --git a/docs/examples/promise/01_simple_connect/README.md b/docs/examples/promise/01_simple_connect/README.md
@@ -1,5 +1,5 @@
 # Simple Connect
 
-The following example shows how to instantiate a Plugnet API object and use it to connect to a node using ApiPromise.
+The following example shows how to instantiate a CENNZnet API object and use it to connect to a node using ApiPromise.
 
 <<< @/docs/examples/promise/01_simple_connect/index.js
diff --git a/docs/examples/promise/01_simple_connect/package.json b/docs/examples/promise/01_simple_connect/package.json
@@ -17,7 +17,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/02_listen_to_blocks/package.json b/docs/examples/promise/02_listen_to_blocks/package.json
@@ -17,7 +17,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/03_listen_to_balance_change/README.md b/docs/examples/promise/03_listen_to_balance_change/README.md
@@ -1,5 +1,5 @@
 # Listen to balance changes
 
-This example shows how to instantiate a Polkadot API object and use it to connect to a node and retrieve balance updates.
+This example shows how to instantiate a CENNZnet API object and use it to connect to a node and retrieve balance updates.
 
 <<< @/docs/examples/promise/03_listen_to_balance_change/index.js
diff --git a/docs/examples/promise/03_listen_to_balance_change/package.json b/docs/examples/promise/03_listen_to_balance_change/package.json
@@ -17,7 +17,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/04_listen_to_multiple_balances_change/README.md b/docs/examples/promise/04_listen_to_multiple_balances_change/README.md
@@ -1,5 +1,5 @@
 # Listen to balance changes
 
-This example shows how to instantiate a Polkadot API object and use it to connect to a node and retrieve balance updates.
+This example shows how to instantiate a CENNZnet API object and use it to connect to a node and retrieve balance updates.
 
 <<< @/docs/examples/promise/03_listen_to_balance_change/index.js
diff --git a/docs/examples/promise/04_listen_to_multiple_balances_change/package.json b/docs/examples/promise/04_listen_to_multiple_balances_change/package.json
@@ -17,7 +17,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/05_unsubscribe/package.json b/docs/examples/promise/05_unsubscribe/package.json
@@ -17,7 +17,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/06_make_transfer/package.json b/docs/examples/promise/06_make_transfer/package.json
@@ -18,7 +18,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/07_read_storage/package.json b/docs/examples/promise/07_read_storage/package.json
@@ -17,7 +17,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/08_read_storage_at/package.json b/docs/examples/promise/08_read_storage_at/package.json
@@ -17,7 +17,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/09_make_transfer_with_allowed_block_permissions_only/package.json b/docs/examples/promise/09_make_transfer_with_allowed_block_permissions_only/package.json
@@ -19,7 +19,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/10_system_events/package.json b/docs/examples/promise/10_system_events/package.json
@@ -17,7 +17,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/11_transfer_events/package.json b/docs/examples/promise/11_transfer_events/package.json
@@ -19,7 +19,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/12_upgrade_chain/package.json b/docs/examples/promise/12_upgrade_chain/package.json
@@ -19,7 +19,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/promise/13_chose_fee_asset_to_pay_tx_fee/package.json b/docs/examples/promise/13_chose_fee_asset_to_pay_tx_fee/package.json
@@ -19,7 +19,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/rx/01_simple_connect/README.md b/docs/examples/rx/01_simple_connect/README.md
@@ -1,5 +1,5 @@
 # Simple Connect
 
-The following example shows how to instantiate a Polkadot API object and use it to connect to a node using ApiRx.
+The following example shows how to instantiate a CENNZnet API object and use it to connect to a node using ApiRx.
 
 <<< @/docs/examples/rx/01_simple_connect/index.js
diff --git a/docs/examples/rx/01_simple_connect/package.json b/docs/examples/rx/01_simple_connect/package.json
@@ -18,7 +18,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/rx/02_listen_to_blocks/package.json b/docs/examples/rx/02_listen_to_blocks/package.json
@@ -18,7 +18,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/rx/03_listen_to_balance_change/README.md b/docs/examples/rx/03_listen_to_balance_change/README.md
@@ -1,5 +1,5 @@
 # Listen to balance changes
 
-This example shows how to instantiate a Polkadot API object and use it to connect to a node and retrieve balance updates.
+This example shows how to instantiate a CENNZnet API object and use it to connect to a node and retrieve balance updates.
 
 <<< @/docs/examples/rx/03_listent_to_balance_change/index.js
diff --git a/docs/examples/rx/03_listen_to_balance_change/package.json b/docs/examples/rx/03_listen_to_balance_change/package.json
@@ -18,7 +18,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/rx/04_unsubscribe/package.json b/docs/examples/rx/04_unsubscribe/package.json
@@ -18,7 +18,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/rx/05_read_storage/package.json b/docs/examples/rx/05_read_storage/package.json
@@ -18,7 +18,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/rx/06_make_transfer/README.md b/docs/examples/rx/06_make_transfer/README.md
@@ -1,5 +1,5 @@
 # Make a simple transfer
 
-This sample shows how to create a transaction to make a transfer from one an account to another.
+This sample shows how to create a transaction to make a transfer from one account to another.
 
 <<< @/docs/examples/rx/06_make_transfer/index.js
diff --git a/docs/examples/rx/06_make_transfer/package.json b/docs/examples/rx/06_make_transfer/package.json
@@ -17,7 +17,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/rx/07_system_events/package.json b/docs/examples/rx/07_system_events/package.json
@@ -18,7 +18,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/rx/08_transfer_events/package.json b/docs/examples/rx/08_transfer_events/package.json
@@ -19,7 +19,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/rx/09_upgrade_chain/package.json b/docs/examples/rx/09_upgrade_chain/package.json
@@ -19,7 +19,9 @@
     "@polkadot/metadata": "1.2.1",
     "@polkadot/api": "1.2.1",
     "@polkadot/api-derive": "1.2.1",
-    "@polkadot/rpc-core": "1.2.1"
+    "@polkadot/rpc-core": "1.2.1",
+    "@polkadot/rpc-provider": "1.2.1",
+    "@polkadot/jsonrpc": "1.2.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2"

diff --git a/docs/examples/rx/10_chose_fee_asset_to_pay_tx_fee/package.json b/docs/examples/rx/10_chose_fee_asset_to_pay_tx_fee/package.json
@@ -20,7 +20,9 @@
         "@polkadot/metadata": "1.2.1",
         "@polkadot/api": "1.2.1",
         "@polkadot/api-derive": "1.2.1",
-        "@polkadot/rpc-core": "1.2.1"
+        "@polkadot/rpc-core": "1.2.1",
+        "@polkadot/rpc-provider": "1.2.1",
+        "@polkadot/jsonrpc": "1.2.1"
     },
     "devDependencies": {
         "rimraf": "^3.0.2"