WIP: Sd 569 docs add and fix apirx examples (#600)

* Docs: Fixed keyring examples

* Docs: Added Rx examples

* [Docs] Added timeout to showcase unsubscribe method in ApiPromise

* [Docs] Added timeout to showcase unsubscribe method in ApiPromise

* [Docs] Added comments to read_storage example

* [Docs] Renamed "transfer_dots' to a more generic 'make_transfer' since it's not only DOT's

* [Docs] ApiRx examples for simple_connect, listen_to_blocks (incl. unsubscribe), listen_to_balance_change and read_storage

* [Docs] changed back keyring import syntax to require

* [Docs] Removed provider from read storage example

* [Docs] ApiRx "make transfer" example

* [Docs] ApiRx "system events" example

* [Docs] ApiRx "transfer events" example

* [Docs] Removed unused utility functions import

* [Docs] ApiRx 'upgrade chain' example

* [Docs] removed generated html files

* [Docs] Ficed wrong Readme of listen to blocks example

* [Docs added missing import]

* [Docs] Removed unsubscribe() example from 'listen to blocks'

* [Docs] Added Unsubscribe example for ApiPromise and ApiRx

* [Docs] Added links to summary

* [Docs] Removed duplicate info/comment from 04_unsubscribe

* [Docs] Fixed wording

* [Docs] Log actual transaction status in "make_transfer"

* [Docs] Changed author name

* [Docs] Log actual transaction status in "make_transfer"

* [Docs] changed headline of make_transfer example README's

* [Docs] changed status.value to status.asFinalised

* [Docs] Removed auto-generated html

* [Docs] Changed all occurances of status.value.toHex() to status.asFinalised.toHex()

* [Docs] Remove call to nonce observable from signAndSend examples

* [Docs] Use RxJs' zip() operator instead of 'await Promise.all()'

* [Docs] Remove call to nonce observable from 'upgrade_chain' example

* [Docs] Changed author

* [Docs] Changed wording of balance change example

* [Docs] smaller code-review fixes

* [Docs] Fix Rx read_storage example

* [Docs] use pairwise together with startWith in the Rx balance_change example

* [Docs] Wording & little less code

* [Docs] Added whitespace

* [Docs] Use switchMap instead fo subscribe inside subscribe syntax

* [Docs] Fixed import syntax for RxJs examples

* [Docs] removed provider

* [Docs] WIP read storage make-over

* [Docs] update Rx read_storage

* [Docs] Read storage example with piped switchMap()

* [Docs] Turn null into observable

* [Docs] Read storage example added 2nd version using tap()

* [Docs] fixed name typo

* [Docs] removed tap() example

docs/examples/rx/06_make_transfer/README.md

@@ -0,0 +1,5 @@
+# Make a simple transfer
+
+This sample shows how to create a transaction to make a transfer from one an account to another.
+
+[include](index.js)

docs/examples/rx/06_make_transfer/index.js

@@ -0,0 +1,35 @@
+// Import the API, Keyring and some utility functions
+const { ApiPromise } = require('@polkadot/api');
+const { Keyring } = require('@polkadot/keyring');
+const { stringToU8a } = require('@polkadot/util');
+
+const ALICE_SEED = 'Alice'.padEnd(32, ' ');
+const BOB_ADDR = '5Gw3s7q4QLkSWwknsiPtjujPv3XM4Trxi5d4PgKMMk3gfGTE';
+
+async function main () {
+  // Create an instance of the keyring
+  const keyring = new Keyring();
+
+  // Add Alice to our keyring (with the known seed for the account)
+  const alice = keyring.addFromSeed(stringToU8a(ALICE_SEED));
+
+  // Instantiate the API
+  const api = await ApiRx.create().toPromise();
+
+  //  Create a extrinsic, transferring 12345 units to Bob.
+  api.tx.balances
+    // create transfer
+    .transfer(BOB, randomAmount)
+    // Sign and send the transcation
+    .signAndSend(alice)
+    // Subscribe to the status updates of the transfer
+    .subscribe(({ status, type }) => {
+      if (type === 'Finalised') {
+        console.log(`Successful transfer of 12345 from Alice to Bob with hash ${status.asFinalised.toHex()}`);
+      } else {
+        console.log(`Staus of transfer: ${type}`);
+      }
+    });
+}
+
+main().catch(console.error).finally(_ => process.exit());

docs/examples/rx/06_make_transfer/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "06_make_transfer",
+  "version": "0.2.0",
+  "description": "Example showing how to transfer DOTs",
+  "main": "index.js",
+  "author": "Stefie",
+  "license": "MIT",
+  "scripts": {
+    "clean": "rimraf node_modules",
+    "start": "node index.js"
+  },
+  "dependencies": {
+    "@polkadot/api": "^0.38.6"
+  },
+  "devDependencies": {
+    "rimraf": "^2.6.2"
+  }
+}