Commit Graph
57 Commits
Author SHA1 Message Date
Jaco 66ab71b29e Bump metadata (#5595) 2023-04-15 13:08:25 +03:00
Jaco 1bee72587f Bump TS (#5368) 2022-12-08 08:20:17 +02:00
Jaco b4e477a8c1 Remove all README links (#4685) 2022-03-24 20:09:16 +02:00
Chevdor 4c01dfd0ab Fix metadata package link (#3458) 2021-04-29 13:55:23 +02:00
Nikos Kontakis aee8ac6b0a Update README.md (#3175)
Minor url link fixes (documentation portal and JSON-RPC methods link)
2021-02-15 07:37:11 +01:00
Jaco Greeff 65b4d5bb43 Update README.md 2020-11-18 13:27:12 +01:00
Jaco Greeff a28ce768bd Update examples link 2020-10-06 14:40:11 +02:00
Rocco Musolino e055438c59 remove broken link (#2671) 2020-10-02 13:26:21 +02:00
Daniel Maricic 8b492021af Fixed typo in README (#2402) 2020-07-01 13:39:07 +02:00
Jaco Greeff ad2b1abdc9 Move @polakdot/jsonrpc -> packages/jsonrpc (#1874)
* Move @polakdot/jsonrpc -> packages/jsonrpc

* Update links
2020-02-16 17:41:45 +01:00
Jaco Greeff db9dcbdad5 Fix moved link for rpc methods (#1403) 2019-09-17 19:17:21 +02:00
Jaco Greeff 2fabf00a2a Maintainability indicator 2019-08-12 09:09:43 +02:00
Jaco Greeff d1be4ea780 Cleanup README 2019-08-11 08:10:01 +02:00
Jaco Greeff 3e371abaed Update README.md 2019-08-10 15:16:35 +02:00
Jaco Greeff b595428372 Lazily create registry types (also solves resolution order) (#1291)
* Lazily create registry types (also solves resolution order)

* Typo in comment

* Alphabetical definitions (ordering detected)

* Make fallback & SessionKeys work as expected

* Cleanup registration, user-types takes priority

* typo

* Api constructors only take options

* Cleanup typos

* Don't create classes while validating metadata

* Adjust badges... well, waiting for CI, so...

* typo
2019-08-10 14:24:04 +02:00
Jaco Greeff 40cf70f415 Add polkadot attestations types (#1286)
* Add polkadot attestations types

* Config updates (misc, non-related)
2019-08-10 00:45:37 +02:00
Jaco Greeff 60148f2864 Bump deps (#1283)
* Bump deps

* jest --runInBand
2019-08-09 15:49:57 +02:00
a45e313c84 Upgrade guide (to current) (#1194)
* Upgrade guide (to current)

* ClassOf

* JSON example

* s/srml/interfaces/

* Typos

* Update UPGRADING.md

Co-Authored-By: Amaury Martiny <amaury.martiny@protonmail.com>

* Add copy-to-apps script

* Properly extend exstended derive types

* Round out UPGRADING

* Version in CHANGELOG

* Typos

* Update UPGRADING.md

* Update CHANGELOG

* Bump common

* 0.90.0-beta.0

* Cleanups

* Split 0.82 & 0.90

* Update UPGRADING.md

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Update UPGRADING.md

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Update UPGRADING.md

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Update UPGRADING.md

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Update UPGRADING.md

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Update UPGRADING.md

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Update UPGRADING.md

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Update UPGRADING.md

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Update UPGRADING.md

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Update CHANGELOG.md

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Update CHANGELOG.md

Co-Authored-By: Thibaut Sardan <33178835+Tbaut@users.noreply.github.com>

* Typo

* findFunction -> api.findCall
2019-07-29 09:48:06 +02:00
Axel Chalon 9abbaab991 Pull parameter_types! from metadata (#1066)
* @polkadot/{extrinsics,storage} moved to @polkadot/metadata

* Fix previous commit

* Fix previous commit

* Expose parameter types using api.consts

* Grumbles; update v6 static metadata; add UncleEntryItem (fix #1067)

* Update api.query.* to api.consts.* where changed

* Update tests and stray api.query.staking.sessionsPerEra

* Grumbles

* Grumbles

* Revert updates to api-derive (taken care of by #1068)

* Grumbles; fix UncleEntryItem

* Rename "@polkadot/metadata" => "@polkadot/api-metadata"

* Skip derive test

* Grumbles

* Grumbles

* Grumbles

* Cleanup merge, ensure metadata is latest

* Move api-metadata to actual api-metadata folder

* README api-metadata description (& folder link)

* Remove stray type-extrinsics package.json
2019-07-09 08:54:28 +02:00
Amaury Martiny fe16c09f01 refactor: Remove rpc-rx (#1037)
* Remove rpc-rx

* Make some stuff work

* Fix tests

* Update Base

* Change some stuff

* Remove rpc-rx mentions

* Add correct tests

* Make cache work

* Fix little bugs

* Rename to spec

* Fix lint

* Fix little bugs

* Add comment

* Add correct test

* Update header

* Add test

* Add comments

* Indentation
2019-06-20 11:06:13 +02:00
Chevdor 5ab55969b3 Remove useless ascii art :) (#862) 2019-04-30 10:54:14 +02:00
Jaco Greeff 5445314d95 Bump deps (#861)
* Bump deps

* Align with published common

* Fix rxjs to 6.4.0 (false deprecations on 6.5.1)
2019-04-29 13:47:55 +02:00
Stefanie Doll c085d01d00 Add short description to all types on overview page (#849)
* Smaller typos/ wording

* Grammar An - A

* Add short description to each type on overview page WIP

* Removed 'Derived types' section because HeaderExtended was the only derived method left

* Commit current state

* Description completed

* Removed empty row placeholder

* Fixed Typo in LockPeriods

* Spell out Little Endian

* Fixed accidentaly removed space character
2019-04-23 13:07:56 +02:00
Jaco Greeff b313614935 Pull in vuepress foir docs (as opposed to gitbook) (#742)
* Pull in latest @polkadot/dev, cleanup existing *.html

* Cleanups (old gitbook interfaces)

* Bump, WIP

* Ready for testing

* Update examples

* Include source

* Cleanup links

* Adjust links

* Add typedoc exclusions

* Default classes from class files

* Adjust imports

* Adjust config

* Re-add types split

* Update links to substrate interfaces

* Anchors for metadata

* Adjust links

* Restore HTML (to be deleted on CI)

* Bump deps

* Re-gen yarn.lock

* Remove a in links

* Adjust interfaces
2019-02-26 15:21:39 +01:00
Jaco Greeff dfac7a4a5f Simple README change, trigger bump 2019-01-16 10:53:49 +01:00
Jaco Greeff 7393710951 Update README.md 2019-01-11 23:37:52 +01:00
Jaco Greeff ed1ad05c5f Bump yarn version in README 2019-01-11 08:13:01 +01:00
Jaco Greeff f65563478e Update README.md 2019-01-09 17:56:10 +01:00
Jaco Greeff 887a0d3ccc Add link to api-derive in README (#556) 2019-01-09 11:37:04 +01:00
Jaco Greeff fced67f23d Migrate to travis-ci.com, bump deps (#441) 2018-12-05 16:02:00 +01:00
Jaco Greeff 93d83b1dc5 Remove api-observable from README (#422) 2018-11-29 12:37:27 +01:00
Jaco Greeff 4805f9cb36 Update LICENSE and README (#408)
* Update LICENSE and README

* Bump
2018-11-21 13:37:27 +01:00
Jaco Greeff c0e95865d0 Trigger build 2018-10-24 18:26:46 +02:00
Luke Schoen b2c512fc8c fix: Change Readme contents to reflect implementation (#287)
* fix: Change Readme contents to reflect implementation

* Update README.md
2018-10-15 23:15:19 +02:00
Luke Schoen 3e20e7b10d docs: Fixes #275. Update Readme package names and links (#286)
* docs: Fixes #275. Update Readme package names and links

* Update README.md
2018-10-14 09:32:51 +02:00
chriswmercer 67f625b096 little readme tweak (#279)
I think it reads a bit better like this. 

"As such, after cloning, its dependencies _should_ be..."

as opposed to

"As such, after cloning dependencies _should_ be"
2018-10-13 16:31:25 +02: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
Luke Schoen 522eae643d fix: Fixes #168 by adding development instructions and tutorial link (#205)
* fix: Fixes #168 by adding development instructions and tutorial link

* fix: Change to just using yarn run build
2018-10-04 22:11:01 +02:00
Jaco Greeff 782bb8063c Pull in observable API from UI (#175)
* Pull in observable api...

* Progress changing stuff...

* votingBalance

* Update resul types

* Expose toBn on Moment

* Rework... WIP

* ... More type cleanups

* Linting passes

* BN helpers for UInt

* Update api-observable

* Add api-observable package.json

* Allow Struct/Tuple to create from hex string

* Future-proof Length with bitLength (u64/u128 compant encoding PR out)

* Make Compact number encoding shareable

* Split Api into functional sections

* Cleanup types

* Additional per-use comments

* Remove params/primitives from README

* api-format  -> api-codec

* Whitespace.
2018-10-01 11:22:15 +02:00
Jaco Greeff f5b0e23e4b Use & build gitbook from @polkadot/dev (#157) 2018-09-17 14:29:34 +02:00
Jaco Greeff 18afe85b59 README links 2018-08-11 11:20:21 +02:00
Jaco Greeff 3556117be0 Bump 2018-08-07 18:12:51 +02:00
Jaco Greeff 861155f9ef Use jsonrpc definitions from @polkadot/jsonrpc (#91)
* Drop api-jsonrpc in favour of @polkadot/jsonrpc

* Change converters

* Address issues after conversion
2018-05-18 10:08:08 +02:00
Jaco Greeff 92c7c2cc1f Move Rx API wrapper into api (#87)
* Move Rx API wrapper into api

* Bump
2018-05-07 12:01:09 +02:00
Jaco Greeff 19dfccb9d6 Bump. 2018-04-20 16:35:41 +02:00
Jaco Greeff ff5d14fe0f Cleanups (#56) 2018-03-15 18:11:45 +01:00
Jaco Greeff 31cb487c49 Update badges (#42) 2017-12-16 11:46:16 +01:00
Jaco Greeff 53e7f06b03 Add polyfill for WebSocket (node) (#31) 2017-12-03 15:37:56 +01:00
Jaco Greeff dfe4a62e70 Update to dev 12 (#28) 2017-12-01 20:57:16 +01:00
Jaco Greeff d8b3a94138 Fix README link (#24) 2017-11-30 20:31:18 +01:00