Commit Graph
144 Commits
Author SHA1 Message Date
Travis CI 60ed2af2c6 [CI Skip] 0.31.63 2018-10-18 14:37:53 +00:00
Jaco Greeff 1b12c0094b Generate Event metadata docs (#316)
* Generate Event metadata docs

* Update MetadataMd.ts
2018-10-18 16:32:50 +02:00
Travis CI 420f215660 [CI Skip] 0.31.62 2018-10-18 11:50:31 +00:00
Travis CI 01c8cc5e76 [CI Skip] 0.31.61 2018-10-18 11:34:46 +00:00
Jaco Greeff 55ac4626d5 Cleanup imports from @polkadot/util (#315)
* Cleanup imports from @polkadot/util

* Example imports

* Alphabetic imports
2018-10-18 13:30:04 +02:00
Travis CI 8b7b76ead8 [CI Skip] 0.31.60 2018-10-18 09:10:48 +00:00
Jaco Greeff 290123b85f Cleanup util-crypto & keyring imports (#314)
* Cleanup util-crypto & keyring imports

* Adjust util imports for types

* Bump deps
2018-10-18 11:06:02 +02:00
Travis CI ef5e0f6c9c [CI Skip] 0.31.59 2018-10-18 08:28:38 +00:00
Travis CI 90cfd343eb [CI Skip] 0.31.58 2018-10-17 13:44:41 +00:00
Travis CI 9ab3b2796f [CI Skip] 0.31.57 2018-10-17 11:46:15 +00:00
Travis CI 6673272fad [CI Skip] 0.31.56 2018-10-17 10:34:21 +00:00
Travis CI e5b71a3020 [CI Skip] 0.31.55 2018-10-17 09:56:39 +00:00
Travis CI ed66239d33 [CI Skip] 0.31.54 2018-10-17 08:51:08 +00:00
Travis CI 30b1b4fcc8 [CI Skip] 0.31.53 2018-10-17 05:17:35 +00:00
Travis CI f530e1828f [CI Skip] 0.31.52 2018-10-16 10:40:20 +00:00
Travis CI 484ab9401c [CI Skip] 0.31.51 2018-10-16 10:03:29 +00:00
Travis CI cb775c3a1c [CI Skip] 0.31.50 2018-10-16 08:35:49 +00:00
Travis CI 261a2b2092 [CI Skip] 0.31.49 2018-10-16 08:05:14 +00:00
Travis CI a1871012e2 [CI Skip] 0.31.48 2018-10-16 07:31:15 +00:00
Travis CI 5a1492a921 [CI Skip] 0.31.47 2018-10-15 21:52:42 +00:00
Travis CI 3f388a3474 [CI Skip] 0.31.46 2018-10-15 21:40:51 +00:00
Travis CI 7211030a14 [CI Skip] 0.31.45 2018-10-15 21:19:56 +00:00
Travis CI b16d80e1da [CI Skip] 0.31.44 2018-10-15 20:59:02 +00:00
Travis CI 5638a0cd1f [CI Skip] 0.31.43 2018-10-15 19:39:33 +00:00
Travis CI a62c480c9e [CI Skip] 0.31.42 2018-10-15 18:20:13 +00:00
Travis CI 53c1f3f78f [CI Skip] 0.31.41 2018-10-15 14:18:55 +00:00
Travis CI 63007637a1 [CI Skip] 0.31.40 2018-10-15 12:34:01 +00:00
Travis CI b0d70b0435 [CI Skip] 0.31.39 2018-10-15 11:59:10 +00:00
Travis CI 1f2562fb95 [CI Skip] 0.31.38 2018-10-15 11:07:39 +00:00
Travis CI c0d9911637 [CI Skip] 0.31.37 2018-10-15 09:53:20 +00:00
Travis CI d449189b57 [CI Skip] 0.31.36 2018-10-14 07:37:22 +00:00
Travis CI 06be0b09c7 [CI Skip] 0.31.35 2018-10-13 19:58:11 +00:00
Travis CI e4b6e3ef3d [CI Skip] 0.31.34 2018-10-13 19:07:03 +00:00
Travis CI 249fc20742 [CI Skip] 0.31.33 2018-10-13 16:06:28 +00:00
Travis CI 49cbfa8c8b [CI Skip] 0.31.32 2018-10-13 15:55:21 +00:00
Travis CI 3ab383f3ec [CI Skip] 0.31.31 2018-10-13 15:38:10 +00:00
Jaco Greeff 7bc8386806 AccountIndex encoding updates via util/keyring (#281)
* AccountIndex encoding updates via util/keyring

* Proper ss58 AccountIndex decoding from keyring

* Metadata allows both length and non-length prefixed

* Update doc logo size & relative URL
2018-10-13 17:33:40 +02:00
Travis CI 75e800374f [CI Skip] 0.31.30 2018-10-13 14:43:43 +00:00
Luke Schoen 68f5ac27ed docs: Relates to #268. Add Polkadot white logo. Match styles to apps (#277)
* docs: Relates to #268. Add Polkadot white logo. Match styles to apps

* fix: Change logo url for plugin to production link

* fix: Remove Polkadot logo

* feat: Add Polkadot-js logo

* fix: Adjust styles for Polkadot-js logo
2018-10-13 16:38:29 +02:00
Travis CI 57b481f7d4 [CI Skip] 0.31.29 2018-10-13 14:36:12 +00:00
Travis CI 8c639f3214 [CI Skip] 0.31.28 2018-10-13 07:01:00 +00:00
Luke Schoen 85ebacb6de fix: Fix promise examples minor typos in comments and variable name. Capitalise comments (#276) 2018-10-13 08:56:27 +02:00
Travis CI 1dd3cfce88 [CI Skip] 0.31.27 2018-10-12 19:58:51 +00:00
Travis CI 543c2af377 [CI Skip] 0.31.26 2018-10-12 19:20:20 +00:00
Luke Schoen 4748e8c87f docs: Relates to #193. Generate Substrate Interface methods in API docs for RPC, Storage, and Extrinsics from Metadata (#265)
* docs: Relates to #193. Generate Methods in API docs to Substrate Interfaces Extrinsics and Storage from Metadata

* Steps to generate Gitbook:
```
yarn run build:methodsdoc;
yarn run build;
yarn gitbook serve;
```

* Allows generating a docs/METHODS_STORAGE.md and docs/METHODS_EXTRINSICS.md files by running `yarn run build:methodsdoc`
  * Note: The script runs `node packages/types/src/MetadataMdWrapper.js`, which uses Babel.js to transpile the TypeScript file MetadataMd.ts into JavaScript as MetadataMd.js by using the babel-plugin-module-resolver dependency that has been added to package.json. It runs MetadataMd.js, which parses a hard-coded copy of a Metadata response from the Substrate Node, and then generates the two aforementioned Markdown files to be included in the Gitbook.
  * Important Note: DO NOT run `./node_modules/.bin/tsc packages/types/src/MetadataMd.ts; node packages/types/src/MetadataMd.js;`, as doing so may incorrectly transpile other TypeScript files, and will give errors like `TypeError: bn_js_1.default is not a constructor` when you run your unit tests.

* Added links that work when you go to http://localhost:4000/api/ and click the "api" link on the side menu
  * Note: This was achieved by first adding the links in packages/api/README.md (i.e. `[Extrinsics (Substrate Interface)](../METHODS_EXTRINSICS.md)`). Note that the links could also be `METHODS_EXTRINSICS.html` and it would still work. It is VERY important to add links to these Markdown files in docs/SUMMARY.md (i.e. `[Storage](METHODS_STORAGE.md)`), as Gitbook generates HTML files in the same docs/ directory (i.e. it generates docs/METHODS_STORAGE.html) for any links provided in that file, and when you run `yarn run build; yarn gitbook serve` it will put a copy of those HTML files in the _book directory so it can be accessed in the browser.

* Replaces PR #249 and #255 from jg-meta-md from jg-meta-md-luke branches

* feat: Add script to generate decoded JSON file of the Metadata. Remove test.

* Summary:
  * Running `yarn run build:decodedjson` will generate packages/types/src/Metadata.decoded.json from the Metadata in the Metadata.rpc.ts file.

* docs: Manually add RPC Substrate Interface API docs including author, chain, state, system

* docs: Append Storage Substrate methods to Storage Methods. Add consistent styling. Add descriptions

* Add Description at top of Substrate Interface page for RPC, Extrinsics, and Storage in API docs

* Add styling to Substrate Interface page for Extrinsics and Storage, including:
  * ▸ symbol before each method
  * bold method names
  * adding Summary label and only showing the summary label if a summary exists
  * adding a horizonal line between each section of methods

* Fix by adding new line after description when there is one in Extrinscis and Storage

* Manually creating a markdown file containing storage.substrate methods METHODS_STORAGE_SUBSTRATE.md, and then reading from the file and appending it to the bottom of the METHODS_STORAGE.md file that is generated, since the storage.substrate methods are not available from the Metadata.

* Fix by reading and writing to file using UTF8 instead of ASCII so symbols appear correctly

* Updating docs/METHODS_RPC.md and adding a horizontal line before the first section of methods

* docs: Fix Readme file step numbering

* docs: Generate the Substrate Interface Markdown files first when run yarn run build

* refactor: Move babel register config into shared file

* refactor: Use shared function to overcome codeclimate error

* fix: Reword description of RPC methodsto address review comment

* docs: Rename to Runtime Node Interfaces to address review comment

* docs: Rename to Runtime Node Interface in api Readme to address review comment

* docs: Fix minor typos

* docs: Fixes #117 providing Readme ref to jsonrpc docs

* fix: Remove preceding whitespace

* docs: Rename so RPC is not referred to as an interface of the runtime

* docs: Refer to Storage Substrate methods as always available to runtime implementation

* test: Restore the test that was unnecessary deleted

* Move scripts into packages/types/src/scripts

* docs: Add script to generate RPC interface docs

* fix: Fix TSlint error where element had any time due to no index signature

* refactor: Restore code back to normal instead of bowing to codeclimate whims

* refactor: Declare meaningful variables to make more readable

* docs: Show .subscribe when it is isSubscription method
2018-10-12 21:15:01 +02:00
Travis CI b4f309584d [CI Skip] 0.31.25 2018-10-12 16:04:53 +00:00
Travis CI 15ed626e2e [CI Skip] 0.31.24 2018-10-12 15:46:26 +00:00
Travis CI 630b7a037d [CI Skip] 0.31.23 2018-10-12 15:38:19 +00:00
Jaco Greeff 2b5169c232 Bump @polkadot/keyring, change package name (#272) 2018-10-12 17:33:29 +02:00
Travis CI e01b432350 [CI Skip] 0.31.22 2018-10-12 14:50:57 +00:00