[CI Skip] 0.31.2

This commit is contained in:
Travis CI
2018-10-10 11:21:11 +00:00
parent bba764bd28
commit 8e9243fdd6
178 changed files with 3156 additions and 2108 deletions
+29 -8
View File
@@ -12,11 +12,16 @@
<link rel="stylesheet" href="../../gitbook/style.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-sunlight-highlighter/sunlight.css">
@@ -44,6 +49,9 @@
@@ -371,7 +379,13 @@
<p><em><strong>name</strong></em>: Rpc</p>
<p><em><strong>summary</strong></em>: The API may use a HTTP or WebSockets provider.</p>
<p><em><strong>description</strong></em>: It allows for querying a Polkadot Client Node.</p>
<p><em><strong>description</strong></em>: It allows for querying a Polkadot Client Node. WebSockets provider is recommended since HTTP provider only supports basic querying.</p>
<div class="mermaid">
graph LR;
A[Api] --&gt; |WebSockets| B[WsProvider];
B --&gt; |endpoint| C[ws://127.0.0.1:9944]
</div>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-core&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">WsProvider</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider/ws&apos;</span><span class="sunlight-punctuation">;</span>
@@ -389,7 +403,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Rpc</strong>(provider: <em><code>ProviderInterface</code></em>): <a href="_index_.rpc.html">Rpc</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L37" target="_blank">index.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L45" target="_blank">index.ts:45</a></em></p>
<p><em><strong>constructor</strong></em>: Default constructor for the Api Object</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -414,28 +428,28 @@
<p><a id="author"></a></p>
<h2 id="author">author</h2>
<p><strong>&#x25CF; author</strong>: <em><a href="../modules/_types_d_.md#rpcinterface_section">RpcInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L34" target="_blank">index.ts:34</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L42" target="_blank">index.ts:42</a></em></p>
<hr>
<p><a id="chain"></a></p>
<h2 id="chain">chain</h2>
<p><strong>&#x25CF; chain</strong>: <em><a href="../modules/_types_d_.md#rpcinterface_section">RpcInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L35" target="_blank">index.ts:35</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L43" target="_blank">index.ts:43</a></em></p>
<hr>
<p><a id="state"></a></p>
<h2 id="state">state</h2>
<p><strong>&#x25CF; state</strong>: <em><a href="../modules/_types_d_.md#rpcinterface_section">RpcInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L36" target="_blank">index.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L44" target="_blank">index.ts:44</a></em></p>
<hr>
<p><a id="system"></a></p>
<h2 id="system">system</h2>
<p><strong>&#x25CF; system</strong>: <em><a href="../modules/_types_d_.md#rpcinterface_section">RpcInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L37" target="_blank">index.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L45" target="_blank">index.ts:45</a></em></p>
<hr>
<h1 id="methods">Methods</h1>
<p><a id="signature"></a></p>
<h2 id="static-signature"><code>&lt;Static&gt;</code> signature</h2>
<p>&#x25B8; <strong>signature</strong>(__namedParameters: <em><code>object</code></em>): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L72" target="_blank">index.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L80" target="_blank">index.ts:80</a></em></p>
<p><em><strong>name</strong></em>: signature</p>
<p><em><strong>summary</strong></em>: Returns a string representation of the method with inputs and outputs.</p>
<p><em><strong>description</strong></em>: Formats the name, inputs and outputs into a human-readable string. This contains the input parameter names input types and output type.</p>
@@ -504,16 +518,21 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Rpc","level":"1.2.1","depth":2,"next":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"previous":{"title":"rpc-core","level":"1.2","depth":1,"path":"rpc-core/README.md","ref":"rpc-core/README.md","articles":[{"title":"Rpc","level":"1.2.1","depth":2,"path":"rpc-core/classes/_index_.rpc.md","ref":"rpc-core/classes/_index_.rpc.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-core/classes/_index_.rpc.md","mtime":"2018-10-10T08:04:17.080Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-10T08:05:29.107Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Rpc","level":"1.2.1","depth":2,"next":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"previous":{"title":"rpc-core","level":"1.2","depth":1,"path":"rpc-core/README.md","ref":"rpc-core/README.md","articles":[{"title":"Rpc","level":"1.2.1","depth":2,"path":"rpc-core/classes/_index_.rpc.md","ref":"rpc-core/classes/_index_.rpc.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-core/classes/_index_.rpc.md","mtime":"2018-10-10T11:19:40.342Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-10T11:21:03.075Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
<script src="../../gitbook/gitbook.js"></script>
<script src="../../gitbook/theme.js"></script>
<script src="../../gitbook/gitbook-plugin-mermaid-gb3/book/plugin.js"></script>
<script src="../../gitbook/gitbook-plugin-search/search-engine.js"></script>
@@ -538,6 +557,8 @@
<script src="../../gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.min.js"></script>
</body>
</html>
+13 -7
View File
@@ -4,7 +4,13 @@
*__summary__*: The API may use a HTTP or WebSockets provider.
*__description__*: It allows for querying a Polkadot Client Node.
*__description__*: It allows for querying a Polkadot Client Node. WebSockets provider is recommended since HTTP provider only supports basic querying.
```mermaid
graph LR;
A[Api] --> |WebSockets| B[WsProvider];
B --> |endpoint| C[ws://127.0.0.1:9944]
```
*__example__*:
```javascript
@@ -31,7 +37,7 @@ const api = new Api(provider);
⊕ **new Rpc**(provider: *`ProviderInterface`*): [Rpc](_index_.rpc.md)
*Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L37)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L45)*
*__constructor__*: Default constructor for the Api Object
@@ -53,7 +59,7 @@ ___
**● author**: *[RpcInterface$Section](../modules/_types_d_.md#rpcinterface_section)*
*Defined in [index.ts:34](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L34)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L42)*
___
<a id="chain"></a>
@@ -62,7 +68,7 @@ ___
**● chain**: *[RpcInterface$Section](../modules/_types_d_.md#rpcinterface_section)*
*Defined in [index.ts:35](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L35)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L43)*
___
<a id="state"></a>
@@ -71,7 +77,7 @@ ___
**● state**: *[RpcInterface$Section](../modules/_types_d_.md#rpcinterface_section)*
*Defined in [index.ts:36](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L36)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L44)*
___
<a id="system"></a>
@@ -80,7 +86,7 @@ ___
**● system**: *[RpcInterface$Section](../modules/_types_d_.md#rpcinterface_section)*
*Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L37)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L45)*
___
@@ -92,7 +98,7 @@ ___
▸ **signature**(__namedParameters: *`object`*): `string`
*Defined in [index.ts:72](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L72)*
*Defined in [index.ts:80](https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/index.ts#L80)*
*__name__*: signature
+16 -1
View File
@@ -12,11 +12,16 @@
<link rel="stylesheet" href="../gitbook/style.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-sunlight-highlighter/sunlight.css">
@@ -44,6 +49,9 @@
@@ -461,16 +469,21 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"rpc-core","level":"1.2","depth":1,"next":{"title":"Rpc","level":"1.2.1","depth":2,"path":"rpc-core/classes/_index_.rpc.md","ref":"rpc-core/classes/_index_.rpc.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-core/README.md","mtime":"2018-10-10T08:04:16.944Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-10T08:05:29.107Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"rpc-core","level":"1.2","depth":1,"next":{"title":"Rpc","level":"1.2.1","depth":2,"path":"rpc-core/classes/_index_.rpc.md","ref":"rpc-core/classes/_index_.rpc.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-core/README.md","mtime":"2018-10-10T11:19:40.206Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-10T11:21:03.075Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
<script src="../gitbook/gitbook.js"></script>
<script src="../gitbook/theme.js"></script>
<script src="../gitbook/gitbook-plugin-mermaid-gb3/book/plugin.js"></script>
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
@@ -495,6 +508,8 @@
<script src="../gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.min.js"></script>
</body>
</html>
@@ -7,7 +7,7 @@
# Callable
▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [types.d.ts:7](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/types.d.ts#L7)*
*Defined in [types.d.ts:7](https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/types.d.ts#L7)*
**Parameters:**
@@ -25,7 +25,7 @@
**● subscription**: *`string`*
*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/types.d.ts#L10)*
*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/types.d.ts#L10)*
___
<a id="unsubscribe"></a>
@@ -34,7 +34,7 @@ ___
**● unsubscribe**: *`function`*
*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/types.d.ts#L11)*
*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/types.d.ts#L11)*
#### Type declaration
▸(id: *`number`*): `Promise`<`any`>
+2 -2
View File
@@ -8,7 +8,7 @@
**Ƭ RpcInterface**: *`object`*
*Defined in [types.d.ts:18](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/types.d.ts#L18)*
*Defined in [types.d.ts:18](https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/types.d.ts#L18)*
#### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ RpcInterface$Section**: *`object`*
*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/types.d.ts#L14)*
*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/bba764b/packages/rpc-core/src/types.d.ts#L14)*
#### Type declaration