Merge branch 'master' into ac-post

openethereum · Jan 21, 2019 · aba163e · aba163e
2 parents d431cc8 + 7641688
commit aba163e
Show file tree

Hide file tree

Showing 68 changed files with 301 additions and 302 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,8 +17,9 @@ lib
 # os-generated files
 .DS_Store
 
-# generated gitbook
+# generated docs
 _book
+gh_pages
 
 # npm
 .npmrc
diff --git a/.travis.yml b/.travis.yml
@@ -5,7 +5,7 @@ cache:
 before_install:
   - curl -o- -L https://yarnpkg.com/install.sh | bash # Travis's default version is 1.3.2, we need 1.4.2 for nohoist
   - export PATH=$HOME/.yarn/bin:$PATH
-  - npm install --global coveralls
+  - yarn global add coveralls
 install:
   - yarn install
 language: node_js
@@ -16,11 +16,19 @@ script:
   - yarn test:api
   - yarn test --silent --coverage --coverageReporters=text-lcov | coveralls ; test ${PIPESTATUS[0]} -eq 0
 before_deploy:
-  - npm install --global gitbook-cli lerna
   - echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc 2> /dev/null
+  - yarn global add gitbook-cli
+  - yarn update-docs
 deploy:
-  provider: script
-  skip_cleanup: true
-  script: yarn update-docs --scope=abi,light.js && ./scripts/lerna-publish.sh
-  on:
-    branch: master
+  - provider: script
+    skip_cleanup: true
+    script: ./scripts/lerna-publish.sh
+    on:
+      branch: master
+  - provider: pages
+    github-token: $GH_TOKEN
+    keep-history: true
+    local-dir: gh_pages # The directory to be pushed to gh-pages branch
+    skip-cleanup: true
+    on:
+      branch: master
diff --git a/README.md b/README.md
@@ -17,19 +17,19 @@
 
 This repository is a monorepo that we manage using [Lerna](https://lernajs.io). That means that we publish [several packages](/packages) to npm from the same codebase. If you are a dapp developer, we recommend you start with the following three high-level packages:
 
-| Package                                              | Version                                                                                                                          | Docs                                                                                                  | Description                                                                                        |
-| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
-| [`@parity/light.js`](/packages/light.js)             | [![npm (scoped)](https://img.shields.io/npm/v/@parity/light.js.svg)](https://www.npmjs.com/package/@parity/light.js)             | [![docs](https://img.shields.io/badge/docs-passing-green.svg)](https://parity-js.github.io/light.js/) | A high-level reactive library optimized for light clients.                                         |
-| [`@parity/light.js-react`](/packages/light.js-react) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/light.js-react.svg)](https://www.npmjs.com/package/@parity/light.js-react) | [![README](https://img.shields.io/badge/docs-README-green.svg)](/packages/light.js-react#readme)      | Easily integrate `@parity/light.js` with React.                                                    |
-| [`@parity/api`](/packages/api)                       | [![npm (scoped)](https://img.shields.io/npm/v/@parity/api.svg)](https://www.npmjs.com/package/@parity/api)                       | Coming soon...                                                                                        | Promise-based JSONRPC method wrapper, similar to [`web3.js`](https://github.com/ethereum/web3.js). |
+| Package                                                                                               | Version                                                                                                                          | Docs                                                                                                                                              | Description                                                                                        |
+| ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| [`@parity/light.js`](https://github.com/paritytech/js-libs/tree/master/packages/light.js)             | [![npm (scoped)](https://img.shields.io/npm/v/@parity/light.js.svg)](https://www.npmjs.com/package/@parity/light.js)             | [![docs](https://img.shields.io/badge/docs-passing-green.svg)](https://paritytech.github.io/js-libs/light.js/)                                    | A high-level reactive library optimized for light clients.                                         |
+| [`@parity/light.js-react`](https://github.com/paritytech/js-libs/tree/master/packages/light.js-react) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/light.js-react.svg)](https://www.npmjs.com/package/@parity/light.js-react) | [![README](https://img.shields.io/badge/docs-README-green.svg)](https://github.com/paritytech/js-libs/tree/master/packages/light.js-react#readme) | Easily integrate `@parity/light.js` with React.                                                    |
+| [`@parity/api`](https://github.com/paritytech/js-libs/tree/master/packages/api)                       | [![npm (scoped)](https://img.shields.io/npm/v/@parity/api.svg)](https://www.npmjs.com/package/@parity/api)                       | Coming soon...                                                                                                                                    | Promise-based JSONRPC method wrapper, similar to [`web3.js`](https://github.com/ethereum/web3.js). |
 
 And below are the lower-level packages, used internally, or by advanced users.
 
-| Package                                    | Version                                                                                                                | Docs                                                                                             | Description                                                               |
-| ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
-| [`@parity/abi`](/packages/abi)             | [![npm (scoped)](https://img.shields.io/npm/v/@parity/abi.svg)](https://www.npmjs.com/package/@parity/abi)             | [![docs](https://img.shields.io/badge/docs-passing-green.svg)](https://parity-js.github.io/abi/) | Ethereum ABI encoder and decoder.                                         |
-| [`@parity/contracts`](/packages/contracts) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/contracts.svg)](https://www.npmjs.com/package/@parity/contracts) | [![README](https://img.shields.io/badge/docs-README-green.svg)](/packages/contracts#readme)      | Parity's [contracts](https://github.com/parity-contracts) as ES6 classes. |
-| [`@parity/electron`](/packages/electron)   | [![npm (scoped)](https://img.shields.io/npm/v/@parity/electron.svg)](https://www.npmjs.com/package/@parity/electron)   | [![README](https://img.shields.io/badge/docs-README-green.svg)](/packages/electron#readme)       | Control the Parity Ethereum node from Electron.                           |
+| Package                                                                                     | Version                                                                                                                | Docs                                                                                                                                         | Description                                                               |
+| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| [`@parity/abi`](https://github.com/paritytech/js-libs/tree/master/packages/abi)             | [![npm (scoped)](https://img.shields.io/npm/v/@parity/abi.svg)](https://www.npmjs.com/package/@parity/abi)             | [![docs](https://img.shields.io/badge/docs-passing-green.svg)](https://paritytech.github.io/js-libs/abi/)                                    | Ethereum ABI encoder and decoder.                                         |
+| [`@parity/contracts`](https://github.com/paritytech/js-libs/tree/master/packages/contracts) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/contracts.svg)](https://www.npmjs.com/package/@parity/contracts) | [![README](https://img.shields.io/badge/docs-README-green.svg)](https://github.com/paritytech/js-libs/tree/master/packages/contracts#readme) | Parity's [contracts](https://github.com/parity-contracts) as ES6 classes. |
+| [`@parity/electron`](https://github.com/paritytech/js-libs/tree/master/packages/electron)   | [![npm (scoped)](https://img.shields.io/npm/v/@parity/electron.svg)](https://www.npmjs.com/package/@parity/electron)   | [![README](https://img.shields.io/badge/docs-README-green.svg)](https://github.com/paritytech/js-libs/tree/master/packages/electron#readme)  | Control the Parity Ethereum node from Electron.                           |
 
 ### Contributing
 
@@ -58,6 +58,7 @@ yarn build
 1. Fork the repo
 
 2. Clone your fork
+
 ```bash
 git clone https://github.com/<INSERT_YOUR_GITHUB_USERNAME>/js-libs
 ```
@@ -93,7 +94,6 @@ yarn test; yarn lint; yarn build
 
 8. Create a pull request from your fork of the repo to the upstream master branch
 
-
 ## License
 
 All Parity's JavaScript libraries are open-source software [licensed as MIT](/LICENSE).
diff --git a/lerna.json b/lerna.json
@@ -5,5 +5,5 @@
     "packages/*"
   ],
   "useWorkspaces": true,
-  "version": "3.0.27"
+  "version": "3.0.31"
 }
diff --git a/packages/abi/docs/classes/_abi_.abi.md b/packages/abi/docs/classes/_abi_.abi.md
@@ -16,7 +16,7 @@
 
 *Inherited from [Interface](_spec_interface_.interface.md).[constructor](_spec_interface_.interface.md#constructor)*
 
-*Defined in [spec/interface.ts:14](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/spec/interface.ts#L14)*
+*Defined in [spec/interface.ts:14](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/spec/interface.ts#L14)*
 
 **Parameters:**
 
@@ -38,7 +38,7 @@ getconstructors(): ([Constructor](_spec_constructor_.constructor.md) | [Event](_
 
 *Inherited from [Interface](_spec_interface_.interface.md).[constructors](_spec_interface_.interface.md#constructors)*
 
-*Defined in [spec/interface.ts:62](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/spec/interface.ts#L62)*
+*Defined in [spec/interface.ts:62](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/spec/interface.ts#L62)*
 
 **Returns:** ([Constructor](_spec_constructor_.constructor.md) | [Event](_spec_event_event_.event.md) | [Func](_spec_function_.func.md))[]
 
@@ -51,7 +51,7 @@ getevents(): ([Constructor](_spec_constructor_.constructor.md) | [Event](_spec_e
 
 *Inherited from [Interface](_spec_interface_.interface.md).[events](_spec_interface_.interface.md#events)*
 
-*Defined in [spec/interface.ts:66](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/spec/interface.ts#L66)*
+*Defined in [spec/interface.ts:66](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/spec/interface.ts#L66)*
 
 **Returns:** ([Constructor](_spec_constructor_.constructor.md) | [Event](_spec_event_event_.event.md) | [Func](_spec_function_.func.md))[]
 
@@ -64,7 +64,7 @@ getfunctions(): ([Constructor](_spec_constructor_.constructor.md) | [Event](_spe
 
 *Inherited from [Interface](_spec_interface_.interface.md).[functions](_spec_interface_.interface.md#functions)*
 
-*Defined in [spec/interface.ts:70](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/spec/interface.ts#L70)*
+*Defined in [spec/interface.ts:70](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/spec/interface.ts#L70)*
 
 **Returns:** ([Constructor](_spec_constructor_.constructor.md) | [Event](_spec_event_event_.event.md) | [Func](_spec_function_.func.md))[]
 
@@ -77,7 +77,7 @@ getinterface(): ([Constructor](_spec_constructor_.constructor.md) | [Event](_spe
 
 *Inherited from [Interface](_spec_interface_.interface.md).[interface](_spec_interface_.interface.md#interface)*
 
-*Defined in [spec/interface.ts:58](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/spec/interface.ts#L58)*
+*Defined in [spec/interface.ts:58](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/spec/interface.ts#L58)*
 
 **Returns:** ([Constructor](_spec_constructor_.constructor.md) | [Event](_spec_event_event_.event.md) | [Func](_spec_function_.func.md))[]
 
@@ -93,7 +93,7 @@ ___
 
 *Inherited from [Interface](_spec_interface_.interface.md).[encodeTokens](_spec_interface_.interface.md#encodetokens)*
 
-*Defined in [spec/interface.ts:74](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/spec/interface.ts#L74)*
+*Defined in [spec/interface.ts:74](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/spec/interface.ts#L74)*
 
 **Parameters:**
 
@@ -113,7 +113,7 @@ ___
 
 *Inherited from [Interface](_spec_interface_.interface.md).[encodeTokens](_spec_interface_.interface.md#encodetokens-1)*
 
-*Defined in [spec/interface.ts:20](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/spec/interface.ts#L20)*
+*Defined in [spec/interface.ts:20](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/spec/interface.ts#L20)*
 
 **Parameters:**
 
@@ -133,7 +133,7 @@ ___
 
 *Inherited from [Interface](_spec_interface_.interface.md).[parseABI](_spec_interface_.interface.md#parseabi)*
 
-*Defined in [spec/interface.ts:39](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/spec/interface.ts#L39)*
+*Defined in [spec/interface.ts:39](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/spec/interface.ts#L39)*
 
 **Parameters:**
 

diff --git a/packages/abi/docs/classes/_decoder_bytestaken_.bytestaken.md b/packages/abi/docs/classes/_decoder_bytestaken_.bytestaken.md
@@ -12,7 +12,7 @@
 
 ⊕ **new BytesTaken**(bytes: *`number`[]*, newOffset: *`number`*): [BytesTaken](_decoder_bytestaken_.bytestaken.md)
 
-*Defined in [decoder/bytesTaken.ts:8](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/bytesTaken.ts#L8)*
+*Defined in [decoder/bytesTaken.ts:8](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/bytesTaken.ts#L8)*
 
 **Parameters:**
 
@@ -33,7 +33,7 @@ ___
 
 getbytes(): `number`[]
 
-*Defined in [decoder/bytesTaken.ts:15](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/bytesTaken.ts#L15)*
+*Defined in [decoder/bytesTaken.ts:15](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/bytesTaken.ts#L15)*
 
 **Returns:** `number`[]
 
@@ -44,7 +44,7 @@ ___
 
 getnewOffset(): `number`
 
-*Defined in [decoder/bytesTaken.ts:19](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/bytesTaken.ts#L19)*
+*Defined in [decoder/bytesTaken.ts:19](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/bytesTaken.ts#L19)*
 
 **Returns:** `number`
 

diff --git a/packages/abi/docs/classes/_decoder_decoder_.decoder.md b/packages/abi/docs/classes/_decoder_decoder_.decoder.md
@@ -12,7 +12,7 @@
 
 ▸ **decode**(params: *[ParamType](_spec_paramtype_paramtype_.paramtype.md)[] | `undefined`*, data?: *`undefined` | `string`*): [Token](_token_token_.token.md)[]
 
-*Defined in [decoder/decoder.ts:20](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/decoder.ts#L20)*
+*Defined in [decoder/decoder.ts:20](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/decoder.ts#L20)*
 
 **Parameters:**
 
@@ -30,7 +30,7 @@ ___
 
 ▸ **decodeParam**(param: *[ParamType](_spec_paramtype_paramtype_.paramtype.md)*, slices: *[Slices](../modules/_types_.md#slices)*, offset?: *`number`*): [DecodeResult](_decoder_decoderesult_.decoderesult.md)
 
-*Defined in [decoder/decoder.ts:59](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/decoder.ts#L59)*
+*Defined in [decoder/decoder.ts:59](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/decoder.ts#L59)*
 
 **Parameters:**
 
@@ -49,7 +49,7 @@ ___
 
 ▸ **peek**(slices: *[Slices](../modules/_types_.md#slices)*, position: *`number`*): `string`
 
-*Defined in [decoder/decoder.ts:36](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/decoder.ts#L36)*
+*Defined in [decoder/decoder.ts:36](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/decoder.ts#L36)*
 
 **Parameters:**
 
@@ -67,7 +67,7 @@ ___
 
 ▸ **takeBytes**(slices: *[Slices](../modules/_types_.md#slices)*, position: *`number`*, length: *`number`*): [BytesTaken](_decoder_bytestaken_.bytestaken.md)
 
-*Defined in [decoder/decoder.ts:44](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/decoder.ts#L44)*
+*Defined in [decoder/decoder.ts:44](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/decoder.ts#L44)*
 
 **Parameters:**
 

diff --git a/packages/abi/docs/classes/_decoder_decoderesult_.decoderesult.md b/packages/abi/docs/classes/_decoder_decoderesult_.decoderesult.md
@@ -12,7 +12,7 @@
 
 ⊕ **new DecodeResult**(token: *[Token](_token_token_.token.md)*, newOffset: *`number`*): [DecodeResult](_decoder_decoderesult_.decoderesult.md)
 
-*Defined in [decoder/decodeResult.ts:10](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/decodeResult.ts#L10)*
+*Defined in [decoder/decodeResult.ts:10](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/decodeResult.ts#L10)*
 
 **Parameters:**
 
@@ -33,7 +33,7 @@ ___
 
 **● _newOffset**: *`number`*
 
-*Defined in [decoder/decodeResult.ts:10](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/decodeResult.ts#L10)*
+*Defined in [decoder/decodeResult.ts:10](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/decodeResult.ts#L10)*
 
 ___
 <a id="_token"></a>
@@ -42,7 +42,7 @@ ___
 
 **● _token**: *[Token](_token_token_.token.md)*
 
-*Defined in [decoder/decodeResult.ts:9](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/decodeResult.ts#L9)*
+*Defined in [decoder/decodeResult.ts:9](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/decodeResult.ts#L9)*
 
 ___
 
@@ -54,7 +54,7 @@ ___
 
 getnewOffset(): `number`
 
-*Defined in [decoder/decodeResult.ts:21](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/decodeResult.ts#L21)*
+*Defined in [decoder/decodeResult.ts:21](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/decodeResult.ts#L21)*
 
 **Returns:** `number`
 
@@ -65,7 +65,7 @@ ___
 
 gettoken(): [Token](_token_token_.token.md)
 
-*Defined in [decoder/decodeResult.ts:17](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/decoder/decodeResult.ts#L17)*
+*Defined in [decoder/decodeResult.ts:17](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/decoder/decodeResult.ts#L17)*
 
 **Returns:** [Token](_token_token_.token.md)
 

diff --git a/packages/abi/docs/classes/_encoder_encoder_.encoder.md b/packages/abi/docs/classes/_encoder_encoder_.encoder.md
@@ -12,7 +12,7 @@
 
 ▸ **encode**(tokens: *[Token](_token_token_.token.md)[]*): `string`
 
-*Defined in [encoder/encoder.ts:27](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/encoder/encoder.ts#L27)*
+*Defined in [encoder/encoder.ts:27](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/encoder/encoder.ts#L27)*
 
 **Parameters:**
 
@@ -29,7 +29,7 @@ ___
 
 ▸ **encodeToken**(token: *[Token](_token_token_.token.md)*, index?: *`number`*): [Mediate](_encoder_mediate_.mediate.md)
 
-*Defined in [encoder/encoder.ts:47](https://github.com/paritytech/js-libs/blob/fdf36ef/packages/abi/src/encoder/encoder.ts#L47)*
+*Defined in [encoder/encoder.ts:47](https://github.com/paritytech/js-libs/blob/4f9b60d/packages/abi/src/encoder/encoder.ts#L47)*
 
 **Parameters:**