Luke Schoen
f399bb6fd6
* Move triple backticks onto new line so it doesn't break the code snippet formatting
* Add newline between dependency imports and variable declarations
* Add link to relevant line of Github repo of eventemitter3 instead of the travis build directory
* Add full stop at end of sentence in line before `@example` in .ts files, since I noticed that was the only difference between code snippet in docs that was being rendered correctly and one that was not (if the docs were generated from it). Not sure if this actually makes any difference though, but it doesn't hurt to try. i.e. change `[[unsubscribe]]` to `[[unsubscribe]].`
* Add missing code syntax for `new Ws(defaults.WS_URL)`
* Add missing `*__example__*:`
* Add missing semi-colons throughout code
* Fix typos and some grammar
* Move import of external libraries i.e. `const BN = require('bn.js');` or `const crypto = require('crypto');` before `@polkadot` ones in code
* Change from `e` to `error` in catch blocks for readable documentation
28 lines
725 B
Markdown
28 lines
725 B
Markdown
# Examples
|
|
|
|
For the following examples, you need a local node. It is usually convenient testing with:
|
|
|
|
```
|
|
polkadot --dev
|
|
```
|
|
|
|
Some of the examples use the following accounts:
|
|
|
|
- Alice: `5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ`
|
|
- Bob: `5Gw3s7q4QLkSWwknsiPtjujPv3XM4Trxi5d4PgKMMk3gfGTE`
|
|
|
|
Those accounts are easy to add if you don't have/see them. The seed of Alice's account is `Alice␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣` and the seed of Bob is... well you guess...
|
|
|
|
NOTE: Note the spaces padding Alice's key up to 32 chars.
|
|
|
|
## Install
|
|
|
|
From each folder, run `yarn` to install the required dependencies
|
|
|
|
## Running the examples
|
|
|
|
From each folder, run:
|
|
```
|
|
yarn start
|
|
```
|