[CI Skip] 0.32.11
This commit is contained in:
+1
-1
@@ -426,7 +426,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"GLOSSARY.md","mtime":"2018-11-29T10:22:33.111Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"GLOSSARY.md","mtime":"2018-11-29T11:14:34.659Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -600,7 +600,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Events (runtime)","level":"2.4","depth":1,"next":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]}]},"previous":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"METHODS_EVENTS.md","mtime":"2018-11-29T10:24:48.576Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Events (runtime)","level":"2.4","depth":1,"next":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]}]},"previous":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"METHODS_EVENTS.md","mtime":"2018-11-29T11:16:47.425Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -546,7 +546,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"next":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"previous":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"METHODS_EXTRINSICS.md","mtime":"2018-11-29T10:24:48.576Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"next":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"previous":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"METHODS_EXTRINSICS.md","mtime":"2018-11-29T11:16:47.425Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -556,7 +556,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"RPC","level":"2.1","depth":1,"next":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"previous":{"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":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"METHODS_RPC.md","mtime":"2018-11-29T10:24:48.576Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"RPC","level":"2.1","depth":1,"next":{"title":"Chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"previous":{"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":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"METHODS_RPC.md","mtime":"2018-11-29T11:16:47.425Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -887,7 +887,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Chain state (runtime)","level":"2.2","depth":1,"next":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"previous":{"title":"RPC","level":"2.1","depth":1,"path":"METHODS_RPC.md","ref":"METHODS_RPC.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"METHODS_STORAGE.md","mtime":"2018-11-29T10:24:48.604Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Chain state (runtime)","level":"2.2","depth":1,"next":{"title":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"previous":{"title":"RPC","level":"2.1","depth":1,"path":"METHODS_RPC.md","ref":"METHODS_RPC.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"METHODS_STORAGE.md","mtime":"2018-11-29T11:16:47.453Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -12,3 +12,4 @@
|
||||
* [RxReferendum](classes/_classes_.rxreferendum.md)
|
||||
* ["index"](modules/_index_.md)
|
||||
* [Api](classes/_index_.api.md)
|
||||
* ["types"](modules/_types_.md)
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
|
||||
⊕ **new ApiBase**(api: *`RpcRxInterface`*): [ApiBase](_base_.apibase.md)
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
**● whenReady**: *`Observable`<`boolean`>*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="extrinsics"></a>
|
||||
@@ -43,7 +43,7 @@ ___
|
||||
|
||||
**● extrinsics**: *`Extrinsics`* = extrinsicsStatic
|
||||
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L41)*
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="storage"></a>
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
**● storage**: *`Storage`* = storageStatic
|
||||
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L42)*
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L42)*
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
getgenesisHash(): `Hash`
|
||||
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L87)*
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L87)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -78,7 +78,7 @@ ___
|
||||
|
||||
▸ **isConnected**(): `Observable`<`boolean`>
|
||||
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L91)*
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L91)*
|
||||
|
||||
**Returns:** `Observable`<`boolean`>
|
||||
|
||||
@@ -89,7 +89,7 @@ ___
|
||||
|
||||
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L95)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -110,7 +110,7 @@ ___
|
||||
|
||||
▸ **rawStorage**<`T`>(key: * `Uint8Array` | `StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` | `undefined`>
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -131,7 +131,7 @@ ___
|
||||
|
||||
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< `Uint8Array` | [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`>
|
||||
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L123)*
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L123)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="extrinsics"></a>
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
|
||||
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L41)*
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="storage"></a>
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
|
||||
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L42)*
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L42)*
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L87)*
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L87)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -92,7 +92,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
|
||||
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L19)*
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -111,7 +111,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
|
||||
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L23)*
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L23)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
|
||||
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L27)*
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -147,7 +147,7 @@ ___
|
||||
|
||||
▸ **bestNumber**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L13)*
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L13)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -160,7 +160,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
|
||||
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L35)*
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L35)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -173,7 +173,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
|
||||
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L31)*
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L31)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -184,7 +184,7 @@ ___
|
||||
|
||||
▸ **chain**(): `Observable`< `Text` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L25)*
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L25)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -197,7 +197,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
|
||||
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L39)*
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L39)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -210,7 +210,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
|
||||
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L43)*
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L43)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -223,7 +223,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
|
||||
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L126)*
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L126)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -236,7 +236,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L151)*
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L151)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -245,13 +245,13 @@ ___
|
||||
|
||||
## fees
|
||||
|
||||
▸ **fees**(): `Observable`<`RxFees`>
|
||||
▸ **fees**(): `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
|
||||
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L130)*
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L130)*
|
||||
|
||||
**Returns:** `Observable`<`RxFees`>
|
||||
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
___
|
||||
<a id="getaccountenumset"></a>
|
||||
@@ -262,7 +262,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L47)*
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -279,7 +279,7 @@ ___
|
||||
|
||||
▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L29)*
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L29)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -298,7 +298,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
|
||||
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L91)*
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L91)*
|
||||
|
||||
**Returns:** `Observable`<`boolean`>
|
||||
|
||||
@@ -311,7 +311,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L58)*
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L58)*
|
||||
|
||||
**Returns:** `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
@@ -324,7 +324,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
|
||||
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L62)*
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L62)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -343,7 +343,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
|
||||
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L75)*
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L75)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
||||
|
||||
@@ -356,7 +356,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L95)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -379,7 +379,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -402,7 +402,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
|
||||
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L123)*
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L123)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -424,7 +424,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
|
||||
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L94)*
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L94)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -437,7 +437,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
|
||||
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L98)*
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L98)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -456,7 +456,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
|
||||
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L111)*
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L111)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -476,7 +476,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
|
||||
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L115)*
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L115)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -495,7 +495,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
|
||||
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L163)*
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L163)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -508,7 +508,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
|
||||
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L167)*
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L167)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -521,7 +521,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L171)*
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L171)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -534,7 +534,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
|
||||
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L175)*
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L175)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -547,7 +547,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
|
||||
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L155)*
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L155)*
|
||||
|
||||
**Returns:** `Observable`< `Perbill` | `undefined`>
|
||||
|
||||
@@ -560,7 +560,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
|
||||
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L159)*
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L159)*
|
||||
|
||||
**Returns:** `Observable`< `Balance` | `undefined`>
|
||||
|
||||
@@ -573,7 +573,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
|
||||
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L183)*
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L183)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -586,7 +586,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
|
||||
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L179)*
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L179)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -599,7 +599,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
|
||||
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L194)*
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L194)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -612,7 +612,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
|
||||
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L216)*
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L216)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -631,7 +631,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
|
||||
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L205)*
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L205)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -648,7 +648,7 @@ ___
|
||||
|
||||
▸ **submitAndWatchExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `ExtrinsicStatus` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L51)*
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L51)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -665,7 +665,7 @@ ___
|
||||
|
||||
▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L47)*
|
||||
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -682,7 +682,7 @@ ___
|
||||
|
||||
▸ **subscribeNewHead**(): `Observable`< `Header` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L33)*
|
||||
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L33)*
|
||||
|
||||
**Returns:** `Observable`< `Header` | `undefined`>
|
||||
|
||||
@@ -695,7 +695,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
|
||||
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L220)*
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L220)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`EventRecord`>>
|
||||
|
||||
@@ -706,7 +706,7 @@ ___
|
||||
|
||||
▸ **systemName**(): `Observable`< `Text` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L39)*
|
||||
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L39)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -717,7 +717,7 @@ ___
|
||||
|
||||
▸ **systemVersion**(): `Observable`< `Text` | `undefined`>
|
||||
|
||||
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L43)*
|
||||
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L43)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -730,7 +730,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
|
||||
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L231)*
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L231)*
|
||||
|
||||
**Returns:** `Observable`< `u32` | `undefined`>
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
*Overrides Struct.__constructor*
|
||||
|
||||
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L12)*
|
||||
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -72,7 +72,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L118)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L118)*
|
||||
|
||||
**Returns:** `E`
|
||||
|
||||
@@ -83,7 +83,7 @@ ___
|
||||
|
||||
getaddress(): `AccountId`
|
||||
|
||||
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L21)*
|
||||
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L21)*
|
||||
|
||||
**Returns:** `AccountId`
|
||||
|
||||
@@ -96,7 +96,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L122)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L122)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
getid(): `PropIndex`
|
||||
|
||||
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L25)*
|
||||
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L25)*
|
||||
|
||||
**Returns:** `PropIndex`
|
||||
|
||||
@@ -118,7 +118,7 @@ ___
|
||||
|
||||
getproposal(): `Proposal`
|
||||
|
||||
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L29)*
|
||||
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L29)*
|
||||
|
||||
**Returns:** `Proposal`
|
||||
|
||||
@@ -235,7 +235,7 @@ ___
|
||||
|
||||
*Inherited from Struct.getAtIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L128)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L128)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -308,7 +308,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L132)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L132)*
|
||||
|
||||
**Returns:** `Array`<`Codec`>
|
||||
|
||||
@@ -321,7 +321,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L136)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L136)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -334,7 +334,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L140)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L140)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -347,7 +347,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L151)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L151)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -360,7 +360,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L155)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L155)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -394,7 +394,7 @@ ___
|
||||
|
||||
*Inherited from Struct.with*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L108)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
*Overrides Struct.__constructor*
|
||||
|
||||
*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L36)*
|
||||
*Defined in [classes.ts:36](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L36)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -72,7 +72,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L118)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L118)*
|
||||
|
||||
**Returns:** `E`
|
||||
|
||||
@@ -83,7 +83,7 @@ ___
|
||||
|
||||
getaddresses(): `Vector`<`AccountId`>
|
||||
|
||||
*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L44)*
|
||||
*Defined in [classes.ts:44](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L44)*
|
||||
|
||||
**Returns:** `Vector`<`AccountId`>
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
getbalance(): `Balance`
|
||||
|
||||
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L48)*
|
||||
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L48)*
|
||||
|
||||
**Returns:** `Balance`
|
||||
|
||||
@@ -107,7 +107,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L122)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L122)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -224,7 +224,7 @@ ___
|
||||
|
||||
*Inherited from Struct.getAtIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L128)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L128)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -297,7 +297,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L132)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L132)*
|
||||
|
||||
**Returns:** `Array`<`Codec`>
|
||||
|
||||
@@ -310,7 +310,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L136)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L136)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -323,7 +323,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L140)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L140)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -336,7 +336,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L151)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L151)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -349,7 +349,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L155)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L155)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -383,7 +383,7 @@ ___
|
||||
|
||||
*Inherited from Struct.with*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L108)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
*Overrides Struct.__constructor*
|
||||
|
||||
*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L55)*
|
||||
*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L55)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -73,7 +73,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L118)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L118)*
|
||||
|
||||
**Returns:** `E`
|
||||
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
getblockNumber(): `BlockNumber`
|
||||
|
||||
*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L65)*
|
||||
*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L65)*
|
||||
|
||||
**Returns:** `BlockNumber`
|
||||
|
||||
@@ -97,7 +97,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L122)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L122)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
getid(): `ReferendumIndex`
|
||||
|
||||
*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L69)*
|
||||
*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L69)*
|
||||
|
||||
**Returns:** `ReferendumIndex`
|
||||
|
||||
@@ -119,7 +119,7 @@ ___
|
||||
|
||||
getproposal(): `Proposal`
|
||||
|
||||
*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L73)*
|
||||
*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L73)*
|
||||
|
||||
**Returns:** `Proposal`
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
getvoteThreshold(): `VoteThreshold`
|
||||
|
||||
*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/classes.ts#L77)*
|
||||
*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/classes.ts#L77)*
|
||||
|
||||
**Returns:** `VoteThreshold`
|
||||
|
||||
@@ -247,7 +247,7 @@ ___
|
||||
|
||||
*Inherited from Struct.getAtIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L128)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L128)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -320,7 +320,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L132)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L132)*
|
||||
|
||||
**Returns:** `Array`<`Codec`>
|
||||
|
||||
@@ -333,7 +333,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L136)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L136)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -346,7 +346,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L140)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L140)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -359,7 +359,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L151)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L151)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -372,7 +372,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L155)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L155)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -406,7 +406,7 @@ ___
|
||||
|
||||
*Inherited from Struct.with*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L108)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="extrinsics"></a>
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
|
||||
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L41)*
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="storage"></a>
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
|
||||
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L42)*
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L42)*
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L87)*
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L87)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
▸ **accountIdAndIndex**(address?: * `AccountId` | `AccountIndex` | `string` | `null`*): `Observable`<[`AccountId` | `undefined`, `AccountIndex` | `undefined`]>
|
||||
|
||||
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L79)*
|
||||
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L79)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
▸ **accountIdFromIndex**(_accountIndex: * `AccountIndex` | `string`*): `Observable`< `AccountId` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L53)*
|
||||
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L53)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -124,7 +124,7 @@ ___
|
||||
|
||||
▸ **accountIndexFromId**(accountId: * `AccountId` | `string`*): `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L68)*
|
||||
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L68)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -141,7 +141,7 @@ ___
|
||||
|
||||
▸ **accountIndexes**(): `Observable`<`object`>
|
||||
|
||||
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L23)*
|
||||
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L23)*
|
||||
|
||||
**Returns:** `Observable`<`object`>
|
||||
|
||||
@@ -154,7 +154,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
|
||||
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L19)*
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -173,7 +173,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
|
||||
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L23)*
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L23)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -192,7 +192,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
|
||||
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L27)*
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -211,7 +211,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
|
||||
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L13)*
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L13)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -224,7 +224,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
|
||||
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L35)*
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L35)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -237,7 +237,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
|
||||
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L31)*
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L31)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -250,7 +250,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)*
|
||||
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L25)*
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L25)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -263,7 +263,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
|
||||
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L39)*
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L39)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -276,7 +276,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
|
||||
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L43)*
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L43)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -285,9 +285,9 @@ ___
|
||||
|
||||
## democracyReferendumVoters
|
||||
|
||||
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`RxReferendumVote`>>
|
||||
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_.md#rxreferendumvote)>>
|
||||
|
||||
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L137)*
|
||||
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L137)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -295,7 +295,7 @@ ___
|
||||
| ------ | ------ |
|
||||
| referendumId | `ReferendumIndex` | `BN` | `number`|
|
||||
|
||||
**Returns:** `Observable`<`Array`<`RxReferendumVote`>>
|
||||
**Returns:** `Observable`<`Array`<[RxReferendumVote](../modules/_types_.md#rxreferendumvote)>>
|
||||
|
||||
___
|
||||
<a id="democracyvotersbalancesof"></a>
|
||||
@@ -304,7 +304,7 @@ ___
|
||||
|
||||
▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Balance`>>
|
||||
|
||||
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L182)*
|
||||
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L182)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -321,7 +321,7 @@ ___
|
||||
|
||||
▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Bool`>>
|
||||
|
||||
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L198)*
|
||||
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L198)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -340,7 +340,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
|
||||
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L126)*
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L126)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -351,7 +351,7 @@ ___
|
||||
|
||||
▸ **eraBlockLength**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L209)*
|
||||
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L209)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -362,7 +362,7 @@ ___
|
||||
|
||||
▸ **eraBlockProgress**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L224)*
|
||||
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L224)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -373,7 +373,7 @@ ___
|
||||
|
||||
▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L247)*
|
||||
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L247)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -386,7 +386,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L151)*
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L151)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -395,13 +395,13 @@ ___
|
||||
|
||||
## fees
|
||||
|
||||
▸ **fees**(): `Observable`<`RxFees`>
|
||||
▸ **fees**(): `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
|
||||
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L130)*
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L130)*
|
||||
|
||||
**Returns:** `Observable`<`RxFees`>
|
||||
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
___
|
||||
<a id="getaccountenumset"></a>
|
||||
@@ -412,7 +412,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L47)*
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -431,7 +431,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)*
|
||||
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L29)*
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L29)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -450,7 +450,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
|
||||
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L91)*
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L91)*
|
||||
|
||||
**Returns:** `Observable`<`boolean`>
|
||||
|
||||
@@ -463,7 +463,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L58)*
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L58)*
|
||||
|
||||
**Returns:** `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
@@ -476,7 +476,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
|
||||
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L62)*
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L62)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -493,7 +493,7 @@ ___
|
||||
|
||||
▸ **publicProposalCount**(): `Observable`<`number`>
|
||||
|
||||
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L115)*
|
||||
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L115)*
|
||||
|
||||
**Returns:** `Observable`<`number`>
|
||||
|
||||
@@ -506,7 +506,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
|
||||
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L75)*
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L75)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
||||
|
||||
@@ -519,7 +519,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L95)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -542,7 +542,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -565,7 +565,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
|
||||
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L123)*
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L123)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -587,7 +587,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
|
||||
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L94)*
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L94)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -600,7 +600,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
|
||||
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L98)*
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L98)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -619,7 +619,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
|
||||
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L111)*
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L111)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -639,7 +639,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
|
||||
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L115)*
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L115)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -656,7 +656,7 @@ ___
|
||||
|
||||
▸ **referendumVotes**(index: * `ReferendumIndex` | `BN` | `number`*, addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`boolean`>
|
||||
|
||||
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L174)*
|
||||
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L174)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -674,7 +674,7 @@ ___
|
||||
|
||||
▸ **referendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
||||
|
||||
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L153)*
|
||||
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L153)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
||||
|
||||
@@ -685,7 +685,7 @@ ___
|
||||
|
||||
▸ **referendumsInfo**(referendumIds: *`Array`< `ReferendumIndex` | `BN` | `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
||||
|
||||
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L125)*
|
||||
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L125)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -702,7 +702,7 @@ ___
|
||||
|
||||
▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L262)*
|
||||
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L262)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -713,7 +713,7 @@ ___
|
||||
|
||||
▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L282)*
|
||||
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L282)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -724,7 +724,7 @@ ___
|
||||
|
||||
▸ **sessionBrokenValue**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L297)*
|
||||
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L297)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -737,7 +737,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
|
||||
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L163)*
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L163)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -750,7 +750,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
|
||||
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L167)*
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L167)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -763,7 +763,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L171)*
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L171)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -776,7 +776,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
|
||||
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L175)*
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L175)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -789,7 +789,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
|
||||
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L155)*
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L155)*
|
||||
|
||||
**Returns:** `Observable`< `Perbill` | `undefined`>
|
||||
|
||||
@@ -802,7 +802,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
|
||||
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L159)*
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L159)*
|
||||
|
||||
**Returns:** `Observable`< `Balance` | `undefined`>
|
||||
|
||||
@@ -813,7 +813,7 @@ ___
|
||||
|
||||
▸ **sessionTimeExpected**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L316)*
|
||||
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L316)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -824,7 +824,7 @@ ___
|
||||
|
||||
▸ **sessionTimeRemaining**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L331)*
|
||||
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L331)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -837,7 +837,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
|
||||
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L183)*
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L183)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -850,7 +850,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
|
||||
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L179)*
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L179)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -863,7 +863,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
|
||||
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L194)*
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L194)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -876,7 +876,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
|
||||
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L216)*
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L216)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -895,7 +895,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
|
||||
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L205)*
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L205)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -914,7 +914,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)*
|
||||
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L51)*
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L51)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -933,7 +933,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
|
||||
|
||||
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L47)*
|
||||
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -952,7 +952,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)*
|
||||
|
||||
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L33)*
|
||||
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L33)*
|
||||
|
||||
**Returns:** `Observable`< `Header` | `undefined`>
|
||||
|
||||
@@ -965,7 +965,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
|
||||
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L220)*
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L220)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`EventRecord`>>
|
||||
|
||||
@@ -978,7 +978,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
|
||||
|
||||
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L39)*
|
||||
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L39)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -991,7 +991,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
|
||||
|
||||
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L43)*
|
||||
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L43)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -1000,9 +1000,9 @@ ___
|
||||
|
||||
## validatingBalance
|
||||
|
||||
▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<`RxBalance`>
|
||||
▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
|
||||
|
||||
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L346)*
|
||||
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L346)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1010,16 +1010,16 @@ ___
|
||||
| ------ | ------ |
|
||||
| address | `AccountId` | `string`|
|
||||
|
||||
**Returns:** `Observable`<`RxBalance`>
|
||||
**Returns:** `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
|
||||
|
||||
___
|
||||
<a id="validatingbalances"></a>
|
||||
|
||||
## validatingBalances
|
||||
|
||||
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`RxBalanceMap`>
|
||||
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalanceMap](../modules/_types_.md#rxbalancemap)>
|
||||
|
||||
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L371)*
|
||||
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L371)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1027,7 +1027,7 @@ ___
|
||||
| ------ | ------ |
|
||||
| `Rest` addresses | `Array`< `AccountId` | `string`> |
|
||||
|
||||
**Returns:** `Observable`<`RxBalanceMap`>
|
||||
**Returns:** `Observable`<[RxBalanceMap](../modules/_types_.md#rxbalancemap)>
|
||||
|
||||
___
|
||||
<a id="validatorcount"></a>
|
||||
@@ -1038,7 +1038,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
|
||||
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L231)*
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L231)*
|
||||
|
||||
**Returns:** `Observable`< `u32` | `undefined`>
|
||||
|
||||
@@ -1047,9 +1047,9 @@ ___
|
||||
|
||||
## votingBalance
|
||||
|
||||
▸ **votingBalance**(address: * `AccountIndex` | `AccountId` | `string`*): `Observable`<`RxBalance`>
|
||||
▸ **votingBalance**(address: * `AccountIndex` | `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
|
||||
|
||||
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L385)*
|
||||
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L385)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1057,16 +1057,16 @@ ___
|
||||
| ------ | ------ |
|
||||
| address | `AccountIndex` | `AccountId` | `string`|
|
||||
|
||||
**Returns:** `Observable`<`RxBalance`>
|
||||
**Returns:** `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
|
||||
|
||||
___
|
||||
<a id="votingbalances"></a>
|
||||
|
||||
## votingBalances
|
||||
|
||||
▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`RxBalance`[]>
|
||||
▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)[]>
|
||||
|
||||
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L425)*
|
||||
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L425)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1074,7 +1074,7 @@ ___
|
||||
| ------ | ------ |
|
||||
| `Rest` addresses | `Array`< `AccountId` | `string`> |
|
||||
|
||||
**Returns:** `Observable`<`RxBalance`[]>
|
||||
**Returns:** `Observable`<[RxBalance](../modules/_types_.md#rxbalance)[]>
|
||||
|
||||
___
|
||||
<a id="votingbalancesnominatorsfor"></a>
|
||||
@@ -1083,7 +1083,7 @@ ___
|
||||
|
||||
▸ **votingBalancesNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`any`>
|
||||
|
||||
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L414)*
|
||||
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L414)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -38,7 +38,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="extrinsics"></a>
|
||||
@@ -49,7 +49,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
|
||||
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L41)*
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="storage"></a>
|
||||
@@ -60,7 +60,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
|
||||
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L42)*
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L42)*
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L87)*
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L87)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdAndIndex](_combined_.apicombined.md#accountidandindex)*
|
||||
|
||||
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L79)*
|
||||
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L79)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -109,7 +109,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdFromIndex](_combined_.apicombined.md#accountidfromindex)*
|
||||
|
||||
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L53)*
|
||||
*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L53)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexFromId](_combined_.apicombined.md#accountindexfromid)*
|
||||
|
||||
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L68)*
|
||||
*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L68)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -147,7 +147,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexes](_combined_.apicombined.md#accountindexes)*
|
||||
|
||||
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L23)*
|
||||
*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L23)*
|
||||
|
||||
**Returns:** `Observable`<`object`>
|
||||
|
||||
@@ -160,7 +160,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
|
||||
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L19)*
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -179,7 +179,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
|
||||
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L23)*
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L23)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -198,7 +198,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
|
||||
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L27)*
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -217,7 +217,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
|
||||
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L13)*
|
||||
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L13)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -230,7 +230,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
|
||||
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L35)*
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L35)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -243,7 +243,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
|
||||
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L31)*
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L31)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -256,7 +256,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)*
|
||||
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L25)*
|
||||
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L25)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -269,7 +269,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
|
||||
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L39)*
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L39)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -282,7 +282,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
|
||||
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L43)*
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L43)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -291,11 +291,11 @@ ___
|
||||
|
||||
## democracyReferendumVoters
|
||||
|
||||
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`RxReferendumVote`>>
|
||||
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_.md#rxreferendumvote)>>
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)*
|
||||
|
||||
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L137)*
|
||||
*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L137)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -303,7 +303,7 @@ ___
|
||||
| ------ | ------ |
|
||||
| referendumId | `ReferendumIndex` | `BN` | `number`|
|
||||
|
||||
**Returns:** `Observable`<`Array`<`RxReferendumVote`>>
|
||||
**Returns:** `Observable`<`Array`<[RxReferendumVote](../modules/_types_.md#rxreferendumvote)>>
|
||||
|
||||
___
|
||||
<a id="democracyvotersbalancesof"></a>
|
||||
@@ -314,7 +314,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)*
|
||||
|
||||
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L182)*
|
||||
*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L182)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -333,7 +333,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)*
|
||||
|
||||
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L198)*
|
||||
*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L198)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -352,7 +352,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
|
||||
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L126)*
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L126)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -365,7 +365,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)*
|
||||
|
||||
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L209)*
|
||||
*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L209)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -378,7 +378,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)*
|
||||
|
||||
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L224)*
|
||||
*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L224)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -391,7 +391,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)*
|
||||
|
||||
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L247)*
|
||||
*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L247)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -404,7 +404,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L151)*
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L151)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -413,13 +413,13 @@ ___
|
||||
|
||||
## fees
|
||||
|
||||
▸ **fees**(): `Observable`<`RxFees`>
|
||||
▸ **fees**(): `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
|
||||
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L130)*
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L130)*
|
||||
|
||||
**Returns:** `Observable`<`RxFees`>
|
||||
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
___
|
||||
<a id="getaccountenumset"></a>
|
||||
@@ -430,7 +430,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L47)*
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -449,7 +449,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)*
|
||||
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L29)*
|
||||
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L29)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -468,7 +468,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
|
||||
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L91)*
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L91)*
|
||||
|
||||
**Returns:** `Observable`<`boolean`>
|
||||
|
||||
@@ -481,7 +481,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)*
|
||||
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L58)*
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L58)*
|
||||
|
||||
**Returns:** `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
@@ -494,7 +494,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
|
||||
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L62)*
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L62)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -513,7 +513,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[publicProposalCount](_combined_.apicombined.md#publicproposalcount)*
|
||||
|
||||
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L115)*
|
||||
*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L115)*
|
||||
|
||||
**Returns:** `Observable`<`number`>
|
||||
|
||||
@@ -526,7 +526,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
|
||||
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L75)*
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L75)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
||||
|
||||
@@ -539,7 +539,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L95)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -562,7 +562,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -585,7 +585,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
|
||||
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L123)*
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L123)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -607,7 +607,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
|
||||
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L94)*
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L94)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -620,7 +620,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
|
||||
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L98)*
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L98)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -639,7 +639,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
|
||||
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L111)*
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L111)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -659,7 +659,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
|
||||
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L115)*
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L115)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -678,7 +678,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumVotes](_combined_.apicombined.md#referendumvotes)*
|
||||
|
||||
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L174)*
|
||||
*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L174)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -698,7 +698,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendums](_combined_.apicombined.md#referendums)*
|
||||
|
||||
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L153)*
|
||||
*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L153)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
||||
|
||||
@@ -711,7 +711,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumsInfo](_combined_.apicombined.md#referendumsinfo)*
|
||||
|
||||
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L125)*
|
||||
*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L125)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -730,7 +730,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)*
|
||||
|
||||
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L262)*
|
||||
*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L262)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -743,7 +743,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)*
|
||||
|
||||
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L282)*
|
||||
*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L282)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -756,7 +756,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)*
|
||||
|
||||
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L297)*
|
||||
*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L297)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -769,7 +769,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
|
||||
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L163)*
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L163)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -782,7 +782,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
|
||||
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L167)*
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L167)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -795,7 +795,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
|
||||
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L171)*
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L171)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -808,7 +808,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
|
||||
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L175)*
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L175)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -821,7 +821,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
|
||||
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L155)*
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L155)*
|
||||
|
||||
**Returns:** `Observable`< `Perbill` | `undefined`>
|
||||
|
||||
@@ -834,7 +834,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
|
||||
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L159)*
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L159)*
|
||||
|
||||
**Returns:** `Observable`< `Balance` | `undefined`>
|
||||
|
||||
@@ -847,7 +847,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)*
|
||||
|
||||
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L316)*
|
||||
*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L316)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -860,7 +860,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)*
|
||||
|
||||
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L331)*
|
||||
*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L331)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -873,7 +873,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
|
||||
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L183)*
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L183)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -886,7 +886,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
|
||||
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L179)*
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L179)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -899,7 +899,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
|
||||
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L194)*
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L194)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -912,7 +912,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
|
||||
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L216)*
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L216)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -931,7 +931,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
|
||||
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L205)*
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L205)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -950,7 +950,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)*
|
||||
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L51)*
|
||||
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L51)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -969,7 +969,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
|
||||
|
||||
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L47)*
|
||||
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -988,7 +988,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)*
|
||||
|
||||
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L33)*
|
||||
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L33)*
|
||||
|
||||
**Returns:** `Observable`< `Header` | `undefined`>
|
||||
|
||||
@@ -1001,7 +1001,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)*
|
||||
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L220)*
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L220)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`EventRecord`>>
|
||||
|
||||
@@ -1014,7 +1014,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
|
||||
|
||||
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L39)*
|
||||
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L39)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -1027,7 +1027,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
|
||||
|
||||
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Calls.ts#L43)*
|
||||
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Calls.ts#L43)*
|
||||
|
||||
**Returns:** `Observable`< `Text` | `undefined`>
|
||||
|
||||
@@ -1036,11 +1036,11 @@ ___
|
||||
|
||||
## validatingBalance
|
||||
|
||||
▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<`RxBalance`>
|
||||
▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)*
|
||||
|
||||
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L346)*
|
||||
*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L346)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1048,18 +1048,18 @@ ___
|
||||
| ------ | ------ |
|
||||
| address | `AccountId` | `string`|
|
||||
|
||||
**Returns:** `Observable`<`RxBalance`>
|
||||
**Returns:** `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
|
||||
|
||||
___
|
||||
<a id="validatingbalances"></a>
|
||||
|
||||
## validatingBalances
|
||||
|
||||
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`RxBalanceMap`>
|
||||
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalanceMap](../modules/_types_.md#rxbalancemap)>
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)*
|
||||
|
||||
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L371)*
|
||||
*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L371)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1067,7 +1067,7 @@ ___
|
||||
| ------ | ------ |
|
||||
| `Rest` addresses | `Array`< `AccountId` | `string`> |
|
||||
|
||||
**Returns:** `Observable`<`RxBalanceMap`>
|
||||
**Returns:** `Observable`<[RxBalanceMap](../modules/_types_.md#rxbalancemap)>
|
||||
|
||||
___
|
||||
<a id="validatorcount"></a>
|
||||
@@ -1078,7 +1078,7 @@ ___
|
||||
|
||||
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
|
||||
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L231)*
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L231)*
|
||||
|
||||
**Returns:** `Observable`< `u32` | `undefined`>
|
||||
|
||||
@@ -1087,11 +1087,11 @@ ___
|
||||
|
||||
## votingBalance
|
||||
|
||||
▸ **votingBalance**(address: * `AccountIndex` | `AccountId` | `string`*): `Observable`<`RxBalance`>
|
||||
▸ **votingBalance**(address: * `AccountIndex` | `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)*
|
||||
|
||||
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L385)*
|
||||
*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L385)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1099,18 +1099,18 @@ ___
|
||||
| ------ | ------ |
|
||||
| address | `AccountIndex` | `AccountId` | `string`|
|
||||
|
||||
**Returns:** `Observable`<`RxBalance`>
|
||||
**Returns:** `Observable`<[RxBalance](../modules/_types_.md#rxbalance)>
|
||||
|
||||
___
|
||||
<a id="votingbalances"></a>
|
||||
|
||||
## votingBalances
|
||||
|
||||
▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`RxBalance`[]>
|
||||
▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)[]>
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)*
|
||||
|
||||
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L425)*
|
||||
*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L425)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1118,7 +1118,7 @@ ___
|
||||
| ------ | ------ |
|
||||
| `Rest` addresses | `Array`< `AccountId` | `string`> |
|
||||
|
||||
**Returns:** `Observable`<`RxBalance`[]>
|
||||
**Returns:** `Observable`<[RxBalance](../modules/_types_.md#rxbalance)[]>
|
||||
|
||||
___
|
||||
<a id="votingbalancesnominatorsfor"></a>
|
||||
@@ -1129,7 +1129,7 @@ ___
|
||||
|
||||
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)*
|
||||
|
||||
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Combined.ts#L414)*
|
||||
*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Combined.ts#L414)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
|
||||
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L33)*
|
||||
*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L33)*
|
||||
|
||||
___
|
||||
<a id="extrinsics"></a>
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
|
||||
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L41)*
|
||||
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="storage"></a>
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
|
||||
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L42)*
|
||||
*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L42)*
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L87)*
|
||||
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L87)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
▸ **accountNonce**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L19)*
|
||||
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
▸ **balanceFree**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L23)*
|
||||
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L23)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -124,7 +124,7 @@ ___
|
||||
|
||||
▸ **balanceReserved**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L27)*
|
||||
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -141,7 +141,7 @@ ___
|
||||
|
||||
▸ **blockNow**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L35)*
|
||||
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L35)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -152,7 +152,7 @@ ___
|
||||
|
||||
▸ **blockPeriod**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L31)*
|
||||
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L31)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -163,7 +163,7 @@ ___
|
||||
|
||||
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L39)*
|
||||
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L39)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -174,7 +174,7 @@ ___
|
||||
|
||||
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L43)*
|
||||
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L43)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -185,7 +185,7 @@ ___
|
||||
|
||||
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L126)*
|
||||
*Defined in [Queries.ts:126](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L126)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -196,7 +196,7 @@ ___
|
||||
|
||||
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L151)*
|
||||
*Defined in [Queries.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L151)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -205,11 +205,11 @@ ___
|
||||
|
||||
## fees
|
||||
|
||||
▸ **fees**(): `Observable`<`RxFees`>
|
||||
▸ **fees**(): `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L130)*
|
||||
*Defined in [Queries.ts:130](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L130)*
|
||||
|
||||
**Returns:** `Observable`<`RxFees`>
|
||||
**Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)>
|
||||
|
||||
___
|
||||
<a id="getaccountenumset"></a>
|
||||
@@ -218,7 +218,7 @@ ___
|
||||
|
||||
▸ **getAccountEnumSet**(index: * `AccountIndex` | `BN` | `number`*): `Observable`< `Array`<`AccountId`> | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L47)*
|
||||
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -237,7 +237,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
|
||||
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L91)*
|
||||
*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L91)*
|
||||
|
||||
**Returns:** `Observable`<`boolean`>
|
||||
|
||||
@@ -248,7 +248,7 @@ ___
|
||||
|
||||
▸ **nextAccountEnumSet**(): `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L58)*
|
||||
*Defined in [Queries.ts:58](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L58)*
|
||||
|
||||
**Returns:** `Observable`< `AccountIndex` | `undefined`>
|
||||
|
||||
@@ -259,7 +259,7 @@ ___
|
||||
|
||||
▸ **proposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L62)*
|
||||
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L62)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -276,7 +276,7 @@ ___
|
||||
|
||||
▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
||||
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L75)*
|
||||
*Defined in [Queries.ts:75](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L75)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
||||
|
||||
@@ -289,7 +289,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
|
||||
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L95)*
|
||||
*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L95)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -312,7 +312,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -335,7 +335,7 @@ ___
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
|
||||
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Base.ts#L123)*
|
||||
*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Base.ts#L123)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
@@ -355,7 +355,7 @@ ___
|
||||
|
||||
▸ **referendumCount**(): `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L94)*
|
||||
*Defined in [Queries.ts:94](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L94)*
|
||||
|
||||
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
||||
|
||||
@@ -366,7 +366,7 @@ ___
|
||||
|
||||
▸ **referendumInfo**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L98)*
|
||||
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L98)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -383,7 +383,7 @@ ___
|
||||
|
||||
▸ **referendumVote**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`< `Bool` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L111)*
|
||||
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L111)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -401,7 +401,7 @@ ___
|
||||
|
||||
▸ **referendumVoters**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L115)*
|
||||
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L115)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -418,7 +418,7 @@ ___
|
||||
|
||||
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L163)*
|
||||
*Defined in [Queries.ts:163](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L163)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -429,7 +429,7 @@ ___
|
||||
|
||||
▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L167)*
|
||||
*Defined in [Queries.ts:167](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L167)*
|
||||
|
||||
**Returns:** `Observable`< `Moment` | `undefined`>
|
||||
|
||||
@@ -440,7 +440,7 @@ ___
|
||||
|
||||
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L171)*
|
||||
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L171)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -451,7 +451,7 @@ ___
|
||||
|
||||
▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L175)*
|
||||
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L175)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -462,7 +462,7 @@ ___
|
||||
|
||||
▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L155)*
|
||||
*Defined in [Queries.ts:155](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L155)*
|
||||
|
||||
**Returns:** `Observable`< `Perbill` | `undefined`>
|
||||
|
||||
@@ -473,7 +473,7 @@ ___
|
||||
|
||||
▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L159)*
|
||||
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L159)*
|
||||
|
||||
**Returns:** `Observable`< `Balance` | `undefined`>
|
||||
|
||||
@@ -484,7 +484,7 @@ ___
|
||||
|
||||
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L183)*
|
||||
*Defined in [Queries.ts:183](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L183)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -495,7 +495,7 @@ ___
|
||||
|
||||
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L179)*
|
||||
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L179)*
|
||||
|
||||
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
||||
|
||||
@@ -506,7 +506,7 @@ ___
|
||||
|
||||
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L194)*
|
||||
*Defined in [Queries.ts:194](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L194)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
@@ -517,7 +517,7 @@ ___
|
||||
|
||||
▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L216)*
|
||||
*Defined in [Queries.ts:216](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L216)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -534,7 +534,7 @@ ___
|
||||
|
||||
▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>>
|
||||
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L205)*
|
||||
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L205)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -551,7 +551,7 @@ ___
|
||||
|
||||
▸ **systemEvents**(): `Observable`<`Array`<`EventRecord`>>
|
||||
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L220)*
|
||||
*Defined in [Queries.ts:220](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L220)*
|
||||
|
||||
**Returns:** `Observable`<`Array`<`EventRecord`>>
|
||||
|
||||
@@ -562,7 +562,7 @@ ___
|
||||
|
||||
▸ **validatorCount**(): `Observable`< `u32` | `undefined`>
|
||||
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/379e82a/packages/api-observable/src/Queries.ts#L231)*
|
||||
*Defined in [Queries.ts:231](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/Queries.ts#L231)*
|
||||
|
||||
**Returns:** `Observable`< `u32` | `undefined`>
|
||||
|
||||
|
||||
@@ -0,0 +1,61 @@
|
||||
|
||||
|
||||
# Type aliases
|
||||
|
||||
<a id="apifunctions"></a>
|
||||
|
||||
## ApiFunctions
|
||||
|
||||
**Ƭ ApiFunctions**: * `keyof ApiBase` | `keyof ApiCalls` | `keyof ApiCombined` | `keyof ApiQueries`
|
||||
*
|
||||
|
||||
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/types.ts#L12)*
|
||||
|
||||
___
|
||||
<a id="rxbalance"></a>
|
||||
|
||||
## RxBalance
|
||||
|
||||
**Ƭ RxBalance**: *`object`*
|
||||
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/types.ts#L14)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
<a id="rxbalancemap"></a>
|
||||
|
||||
## RxBalanceMap
|
||||
|
||||
**Ƭ RxBalanceMap**: *`object`*
|
||||
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/types.ts#L38)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
[index: `string`]: [RxBalance](_types_.md#rxbalance)
|
||||
|
||||
___
|
||||
<a id="rxfees"></a>
|
||||
|
||||
## RxFees
|
||||
|
||||
**Ƭ RxFees**: *`object`*
|
||||
|
||||
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/types.ts#L24)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
<a id="rxreferendumvote"></a>
|
||||
|
||||
## RxReferendumVote
|
||||
|
||||
**Ƭ RxReferendumVote**: *`object`*
|
||||
|
||||
*Defined in [types.ts:32](https://github.com/polkadot-js/api/blob/9092250/packages/api-observable/src/types.ts#L32)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
|
||||
@@ -9,7 +9,25 @@
|
||||
* ["promise/SubmittableExtrinsic.spec"](modules/_promise_submittableextrinsic_spec_.md)
|
||||
* ["promise/index"](modules/_promise_index_.md)
|
||||
* [ApiPromise](classes/_promise_index_.apipromise.md)
|
||||
* ["promise/types"](modules/_promise_types_.md)
|
||||
* [ApiPromiseInterface](interfaces/_promise_types_.apipromiseinterface.md)
|
||||
* [QueryableModuleStorage](interfaces/_promise_types_.queryablemodulestorage.md)
|
||||
* [QueryableStorage](interfaces/_promise_types_.queryablestorage.md)
|
||||
* [QueryableStorageFunction](interfaces/_promise_types_.queryablestoragefunction.md)
|
||||
* [SubmittableExtrinsicFunction](interfaces/_promise_types_.submittableextrinsicfunction.md)
|
||||
* [SubmittableExtrinsics](interfaces/_promise_types_.submittableextrinsics.md)
|
||||
* [SubmittableModuleExtrinsics](interfaces/_promise_types_.submittablemoduleextrinsics.md)
|
||||
* ["rx/SubmittableExtrinsic"](modules/_rx_submittableextrinsic_.md)
|
||||
* [SubmittableExtrinsic](classes/_rx_submittableextrinsic_.submittableextrinsic.md)
|
||||
* ["rx/index"](modules/_rx_index_.md)
|
||||
* [ApiRx](classes/_rx_index_.apirx.md)
|
||||
* ["rx/types"](modules/_rx_types_.md)
|
||||
* [ApiRxInterface](interfaces/_rx_types_.apirxinterface.md)
|
||||
* [QueryableModuleStorage](interfaces/_rx_types_.queryablemodulestorage.md)
|
||||
* [QueryableStorage](interfaces/_rx_types_.queryablestorage.md)
|
||||
* [QueryableStorageFunction](interfaces/_rx_types_.queryablestoragefunction.md)
|
||||
* [SubmittableExtrinsicFunction](interfaces/_rx_types_.submittableextrinsicfunction.md)
|
||||
* [SubmittableExtrinsics](interfaces/_rx_types_.submittableextrinsics.md)
|
||||
* [SubmittableModuleExtrinsics](interfaces/_rx_types_.submittablemoduleextrinsics.md)
|
||||
* ["types"](modules/_types_.md)
|
||||
* [ApiBaseInterface](interfaces/_types_.apibaseinterface.md)
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
|
||||
# Implements
|
||||
|
||||
* `ApiBaseInterface`<`R`, `S`, `E`>
|
||||
* [ApiBaseInterface](../interfaces/_types_.apibaseinterface.md)<`R`, `S`, `E`>
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
⊕ **new ApiBase**(wsProvider?: *`WsProvider`*): [ApiBase](_base_.apibase.md)
|
||||
|
||||
*Defined in [Base.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L39)*
|
||||
*Defined in [Base.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L39)*
|
||||
|
||||
*__description__*: Create an instance of the class
|
||||
|
||||
@@ -58,7 +58,7 @@ ___
|
||||
|
||||
getgenesisHash(): `Hash`
|
||||
|
||||
*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L70)*
|
||||
*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L70)*
|
||||
|
||||
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
|
||||
|
||||
@@ -71,7 +71,7 @@ ___
|
||||
|
||||
getquery(): `S`
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L108)*
|
||||
|
||||
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
getrpc(): `R`
|
||||
|
||||
*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L128)*
|
||||
*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L128)*
|
||||
|
||||
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
|
||||
|
||||
@@ -117,7 +117,7 @@ ___
|
||||
|
||||
getruntimeMetadata(): `RuntimeMetadata`
|
||||
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L79)*
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L79)*
|
||||
|
||||
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
getruntimeVersion(): `RuntimeVersion`
|
||||
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L88)*
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L88)*
|
||||
|
||||
*__description__*: Contains the version information for the current runtime.
|
||||
|
||||
@@ -143,7 +143,7 @@ ___
|
||||
|
||||
gettx(): `E`
|
||||
|
||||
*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L147)*
|
||||
*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L147)*
|
||||
|
||||
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -168,9 +168,9 @@ ___
|
||||
|
||||
## on
|
||||
|
||||
▸ **on**(type: *`ApiInterface$Events`*, handler: *`function`*): `void`
|
||||
▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
|
||||
|
||||
*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L172)*
|
||||
*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L172)*
|
||||
|
||||
*__description__*: Attach an eventemitter handler to listen to a specific event
|
||||
|
||||
@@ -190,7 +190,7 @@ api.on('disconnected', () => {
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| type | `ApiInterface$Events` | The type of event to listen to. Available events are \`connected\`, \`disconnected\` and \`ready\` |
|
||||
| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\` and \`ready\` |
|
||||
| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. |
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
⊕ **new Combinator**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md)
|
||||
|
||||
*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/Combinator.ts#L14)*
|
||||
*Defined in [promise/Combinator.ts:14](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/Combinator.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -457,19 +457,19 @@
|
||||
<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
|
||||
</span></pre></div></div></code></pre>
|
||||
<h1 id="hierarchy">Hierarchy</h1>
|
||||
<p> <a href="_base_.apibase.md">ApiBase</a><<code>Rpc</code>, <code>QueryableStorage</code>, <code>SubmittableExtrinsics</code>></p>
|
||||
<p> <a href="_base_.apibase.md">ApiBase</a><<code>Rpc</code>, <a href="../interfaces/_promise_types_.queryablestorage.md">QueryableStorage</a>, <a href="../interfaces/_promise_types_.submittableextrinsics.md">SubmittableExtrinsics</a>></p>
|
||||
<p><strong>↳ ApiPromise</strong></p>
|
||||
<h1 id="implements">Implements</h1>
|
||||
<ul>
|
||||
<li><code>ApiBaseInterface</code><<code>Rpc</code>, <code>QueryableStorage</code>, <code>SubmittableExtrinsics</code>></li>
|
||||
<li><code>ApiPromiseInterface</code></li>
|
||||
<li><a href="../interfaces/_types_.apibaseinterface.md">ApiBaseInterface</a><<code>Rpc</code>, <a href="../interfaces/_promise_types_.queryablestorage.md">QueryableStorage</a>, <a href="../interfaces/_promise_types_.submittableextrinsics.md">SubmittableExtrinsics</a>></li>
|
||||
<li><a href="../interfaces/_promise_types_.apipromiseinterface.md">ApiPromiseInterface</a></li>
|
||||
</ul>
|
||||
<h1 id="constructors">Constructors</h1>
|
||||
<p><a id="constructor"></a></p>
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new ApiPromise</strong>(wsProvider?: <em><code>WsProvider</code></em>): <a href="_promise_index_.apipromise.html">ApiPromise</a></p>
|
||||
<p><em>Overrides <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/index.ts#L128" target="_blank">promise/index.ts:128</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/index.ts#L128" target="_blank">promise/index.ts:128</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Creates an instance of the ApiPromise class</p>
|
||||
<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> <span class="sunlight-ident">Api</span> <span class="sunlight-ident">from</span> <span class="sunlight-string">'@polkadot/api/promise'</span><span class="sunlight-punctuation">;</span>
|
||||
@@ -504,22 +504,22 @@
|
||||
<h2 id="genesishash">genesisHash</h2>
|
||||
<p>getgenesisHash(): <code>Hash</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#genesishash">genesisHash</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L70" target="_blank">Base.ts:70</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L70" target="_blank">Base.ts:70</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.</p>
|
||||
<p><strong>Returns:</strong> <code>Hash</code></p>
|
||||
<hr>
|
||||
<p><a id="isready"></a></p>
|
||||
<h2 id="isready">isReady</h2>
|
||||
<p>getisReady(): <code>Promise</code><<a href="_promise_index_.apipromise.html">ApiPromise</a>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/index.ts#L161" target="_blank">promise/index.ts:161</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/index.ts#L161" target="_blank">promise/index.ts:161</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Promise that returns the first time we are connected and loaded</p>
|
||||
<p><strong>Returns:</strong> <code>Promise</code><<a href="_promise_index_.apipromise.html">ApiPromise</a>></p>
|
||||
<hr>
|
||||
<p><a id="query"></a></p>
|
||||
<h2 id="query">query</h2>
|
||||
<p>getquery(): <code>QueryableStorage</code></p>
|
||||
<p>getquery(): <a href="../interfaces/_promise_types_.queryablestorage.md">QueryableStorage</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#query">query</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L108" target="_blank">Base.ts:108</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L108" target="_blank">Base.ts:108</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.</p>
|
||||
<p>All calls inside the namespace, is denoted by <code>section</code>.<code>method</code> and may take an optional query parameter. As an example, <code>api.query.timestamp.now()</code> (current block timestamp) does not take parameters, while <code>api.query.system.accountNonce(<accountId>)</code> (retrieving the associated nonce for an account), takes the <code>AccountId</code> as a parameter.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -527,13 +527,13 @@
|
||||
  <span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">'new balance'</span><span class="sunlight-punctuation">,</span> <span class="sunlight-ident">balance</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
|
||||
<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
|
||||
</span></pre></div></div></code></pre>
|
||||
<p><strong>Returns:</strong> <code>QueryableStorage</code></p>
|
||||
<p><strong>Returns:</strong> <a href="../interfaces/_promise_types_.queryablestorage.md">QueryableStorage</a></p>
|
||||
<hr>
|
||||
<p><a id="rpc"></a></p>
|
||||
<h2 id="rpc">rpc</h2>
|
||||
<p>getrpc(): <code>Rpc</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#rpc">rpc</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L128" target="_blank">Base.ts:128</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L128" target="_blank">Base.ts:128</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic <code>api.query</code> and <code>api.tx</code> sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.</p>
|
||||
<p>RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -547,7 +547,7 @@
|
||||
<h2 id="runtimemetadata">runtimeMetadata</h2>
|
||||
<p>getruntimeMetadata(): <code>RuntimeMetadata</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimemetadata">runtimeMetadata</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.</p>
|
||||
<p><strong>Returns:</strong> <code>RuntimeMetadata</code></p>
|
||||
<hr>
|
||||
@@ -555,15 +555,15 @@
|
||||
<h2 id="runtimeversion">runtimeVersion</h2>
|
||||
<p>getruntimeVersion(): <code>RuntimeVersion</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimeversion">runtimeVersion</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p>
|
||||
<p><strong>Returns:</strong> <code>RuntimeVersion</code></p>
|
||||
<hr>
|
||||
<p><a id="tx"></a></p>
|
||||
<h2 id="tx">tx</h2>
|
||||
<p>gettx(): <code>SubmittableExtrinsics</code></p>
|
||||
<p>gettx(): <a href="../interfaces/_promise_types_.submittableextrinsics.md">SubmittableExtrinsics</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#tx">tx</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L147" target="_blank">Base.ts:147</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L147" target="_blank">Base.ts:147</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.</p>
|
||||
<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-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">tx</span><span class="sunlight-operator">.</span><span class="sunlight-ident">balances</span>
|
||||
@@ -573,13 +573,13 @@
|
||||
    <span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">'tx status'</span><span class="sunlight-punctuation">,</span> <span class="sunlight-ident">status</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
|
||||
  <span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
|
||||
</span></pre></div></div></code></pre>
|
||||
<p><strong>Returns:</strong> <code>SubmittableExtrinsics</code></p>
|
||||
<p><strong>Returns:</strong> <a href="../interfaces/_promise_types_.submittableextrinsics.md">SubmittableExtrinsics</a></p>
|
||||
<hr>
|
||||
<h1 id="methods">Methods</h1>
|
||||
<p><a id="combinelatest"></a></p>
|
||||
<h2 id="combinelatest">combineLatest</h2>
|
||||
<p>▸ <strong>combineLatest</strong>(fns: <em><code>Array</code><<a href="../modules/_promise_combinator_.md#combinatorfunction">CombinatorFunction</a>></em>, callback: <em><a href="../modules/_promise_combinator_.md#combinatorcallback">CombinatorCallback</a></em>): <a href="_promise_combinator_.combinator.md">Combinator</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/index.ts#L189" target="_blank">promise/index.ts:189</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/index.ts#L189" target="_blank">promise/index.ts:189</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Creates a combinator that can be used to combine the latest results from multiple subscriptions</p>
|
||||
<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">const</span> <span class="sunlight-ident">address</span> <span class="sunlight-operator">=</span> <span class="sunlight-string">'5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7'</span><span class="sunlight-punctuation">;</span>
|
||||
@@ -619,9 +619,9 @@
|
||||
<hr>
|
||||
<p><a id="on"></a></p>
|
||||
<h2 id="on">on</h2>
|
||||
<p>▸ <strong>on</strong>(type: <em><code>ApiInterface$Events</code></em>, handler: <em><code>function</code></em>): <code>void</code></p>
|
||||
<p>▸ <strong>on</strong>(type: <em><a href="../modules/_types_.md#apiinterface_events">ApiInterface$Events</a></em>, handler: <em><code>function</code></em>): <code>void</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#on">on</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L172" target="_blank">Base.ts:172</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L172" target="_blank">Base.ts:172</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Attach an eventemitter handler to listen to a specific event</p>
|
||||
<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-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">on</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">'disconnected'</span><span class="sunlight-punctuation">,</span> <span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span> <span class="sunlight-operator">=</span><span class="sunlight-operator">></span> <span class="sunlight-punctuation">{</span>
|
||||
@@ -644,7 +644,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td><code>ApiInterface$Events</code></td>
|
||||
<td><a href="../modules/_types_.md#apiinterface_events">ApiInterface$Events</a></td>
|
||||
<td>The type of event to listen to. Available events are `connected`, `disconnected` and `ready`</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -659,7 +659,7 @@
|
||||
<p><a id="create"></a></p>
|
||||
<h2 id="static-create"><code><Static></code> create</h2>
|
||||
<p>▸ <strong>create</strong>(wsProvider?: <em><code>WsProvider</code></em>): <code>Promise</code><<a href="_promise_index_.apipromise.html">ApiPromise</a>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/index.ts#L126" target="_blank">promise/index.ts:126</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/index.ts#L126" target="_blank">promise/index.ts:126</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.</p>
|
||||
<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> <span class="sunlight-ident">Api</span> <span class="sunlight-ident">from</span> <span class="sunlight-string">'@polkadot/api/promise'</span><span class="sunlight-punctuation">;</span>
|
||||
@@ -732,7 +732,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"1.2.1","depth":2,"next":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"previous":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"api/classes/_promise_index_.apipromise.md","mtime":"2018-11-29T10:24:55.064Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"1.2.1","depth":2,"next":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"previous":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"api/classes/_promise_index_.apipromise.md","mtime":"2018-11-29T11:16:54.149Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -87,14 +87,14 @@ ApiPromise.create().then((api) => {
|
||||
|
||||
# Hierarchy
|
||||
|
||||
[ApiBase](_base_.apibase.md)<`Rpc`, `QueryableStorage`, `SubmittableExtrinsics`>
|
||||
[ApiBase](_base_.apibase.md)<`Rpc`, [QueryableStorage](../interfaces/_promise_types_.queryablestorage.md), [SubmittableExtrinsics](../interfaces/_promise_types_.submittableextrinsics.md)>
|
||||
|
||||
**↳ ApiPromise**
|
||||
|
||||
# Implements
|
||||
|
||||
* `ApiBaseInterface`<`Rpc`, `QueryableStorage`, `SubmittableExtrinsics`>
|
||||
* `ApiPromiseInterface`
|
||||
* [ApiBaseInterface](../interfaces/_types_.apibaseinterface.md)<`Rpc`, [QueryableStorage](../interfaces/_promise_types_.queryablestorage.md), [SubmittableExtrinsics](../interfaces/_promise_types_.submittableextrinsics.md)>
|
||||
* [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -106,7 +106,7 @@ ApiPromise.create().then((api) => {
|
||||
|
||||
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/index.ts#L128)*
|
||||
*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/index.ts#L128)*
|
||||
|
||||
*__description__*: Creates an instance of the ApiPromise class
|
||||
|
||||
@@ -142,7 +142,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L70)*
|
||||
*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L70)*
|
||||
|
||||
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
|
||||
|
||||
@@ -155,7 +155,7 @@ ___
|
||||
|
||||
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
|
||||
|
||||
*Defined in [promise/index.ts:161](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/index.ts#L161)*
|
||||
*Defined in [promise/index.ts:161](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/index.ts#L161)*
|
||||
|
||||
*__description__*: Promise that returns the first time we are connected and loaded
|
||||
|
||||
@@ -166,11 +166,11 @@ ___
|
||||
|
||||
## query
|
||||
|
||||
getquery(): `QueryableStorage`
|
||||
getquery(): [QueryableStorage](../interfaces/_promise_types_.queryablestorage.md)
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L108)*
|
||||
|
||||
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -184,7 +184,7 @@ api.query.balances.freeBalance(<accountId>, (balance) => {
|
||||
});
|
||||
```
|
||||
|
||||
**Returns:** `QueryableStorage`
|
||||
**Returns:** [QueryableStorage](../interfaces/_promise_types_.queryablestorage.md)
|
||||
|
||||
___
|
||||
<a id="rpc"></a>
|
||||
@@ -195,7 +195,7 @@ getrpc(): `Rpc`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
|
||||
|
||||
*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L128)*
|
||||
*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L128)*
|
||||
|
||||
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
|
||||
|
||||
@@ -220,7 +220,7 @@ getruntimeMetadata(): `RuntimeMetadata`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
|
||||
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L79)*
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L79)*
|
||||
|
||||
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
|
||||
|
||||
@@ -235,7 +235,7 @@ getruntimeVersion(): `RuntimeVersion`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
|
||||
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L88)*
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L88)*
|
||||
|
||||
*__description__*: Contains the version information for the current runtime.
|
||||
|
||||
@@ -246,11 +246,11 @@ ___
|
||||
|
||||
## tx
|
||||
|
||||
gettx(): `SubmittableExtrinsics`
|
||||
gettx(): [SubmittableExtrinsics](../interfaces/_promise_types_.submittableextrinsics.md)
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
|
||||
|
||||
*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L147)*
|
||||
*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L147)*
|
||||
|
||||
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -265,7 +265,7 @@ api.tx.balances
|
||||
});
|
||||
```
|
||||
|
||||
**Returns:** `SubmittableExtrinsics`
|
||||
**Returns:** [SubmittableExtrinsics](../interfaces/_promise_types_.submittableextrinsics.md)
|
||||
|
||||
___
|
||||
|
||||
@@ -277,7 +277,7 @@ ___
|
||||
|
||||
▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md)
|
||||
|
||||
*Defined in [promise/index.ts:189](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/index.ts#L189)*
|
||||
*Defined in [promise/index.ts:189](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/index.ts#L189)*
|
||||
|
||||
*__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions
|
||||
|
||||
@@ -310,11 +310,11 @@ ___
|
||||
|
||||
## on
|
||||
|
||||
▸ **on**(type: *`ApiInterface$Events`*, handler: *`function`*): `void`
|
||||
▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
|
||||
|
||||
*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L172)*
|
||||
*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L172)*
|
||||
|
||||
*__description__*: Attach an eventemitter handler to listen to a specific event
|
||||
|
||||
@@ -334,7 +334,7 @@ api.on('disconnected', () => {
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| type | `ApiInterface$Events` | The type of event to listen to. Available events are \`connected\`, \`disconnected\` and \`ready\` |
|
||||
| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\` and \`ready\` |
|
||||
| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. |
|
||||
|
||||
**Returns:** `void`
|
||||
@@ -346,7 +346,7 @@ ___
|
||||
|
||||
▸ **create**(wsProvider?: *`WsProvider`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
|
||||
|
||||
*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/index.ts#L126)*
|
||||
*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/index.ts#L126)*
|
||||
|
||||
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
|
||||
|
||||
|
||||
@@ -21,17 +21,17 @@
|
||||
|
||||
## constructor
|
||||
|
||||
⊕ **new SubmittableExtrinsic**(api: *`ApiPromiseInterface`*, extrinsic: *`Extrinsic`*): [SubmittableExtrinsic](_promise_submittableextrinsic_.submittableextrinsic.md)
|
||||
⊕ **new SubmittableExtrinsic**(api: *[ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md)*, extrinsic: *`Extrinsic`*): [SubmittableExtrinsic](_promise_submittableextrinsic_.submittableextrinsic.md)
|
||||
|
||||
*Overrides Extrinsic.__constructor*
|
||||
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiPromiseInterface` |
|
||||
| api | [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md) |
|
||||
| extrinsic | `Extrinsic` |
|
||||
|
||||
**Returns:** [SubmittableExtrinsic](_promise_submittableextrinsic_.submittableextrinsic.md)
|
||||
@@ -73,7 +73,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L118)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L118)*
|
||||
|
||||
**Returns:** `E`
|
||||
|
||||
@@ -86,7 +86,7 @@ getargs(): `Array`<`Codec`>
|
||||
|
||||
*Inherited from Extrinsic.args*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:65](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L65)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:65](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L65)*
|
||||
|
||||
**Returns:** `Array`<`Codec`>
|
||||
|
||||
@@ -99,7 +99,7 @@ getcallIndex(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.callIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L70)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L70)*
|
||||
|
||||
**Returns:** `Uint8Array`
|
||||
|
||||
@@ -112,7 +112,7 @@ getdata(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.data*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:74](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L74)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:74](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L74)*
|
||||
|
||||
**Returns:** `Uint8Array`
|
||||
|
||||
@@ -127,7 +127,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Overrides Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L105)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L105)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -140,7 +140,7 @@ gethash(): `Hash`
|
||||
|
||||
*Inherited from Extrinsic.hash*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L79)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L79)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -153,7 +153,7 @@ getisSigned(): `boolean`
|
||||
|
||||
*Inherited from Extrinsic.isSigned*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L85)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L85)*
|
||||
|
||||
**Returns:** `boolean`
|
||||
|
||||
@@ -166,7 +166,7 @@ getlength(): `number`
|
||||
|
||||
*Inherited from Extrinsic.length*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:89](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L89)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:89](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L89)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -179,7 +179,7 @@ getmeta(): `FunctionMetadata`
|
||||
|
||||
*Inherited from Extrinsic.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L93)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L93)*
|
||||
|
||||
**Returns:** `FunctionMetadata`
|
||||
|
||||
@@ -192,7 +192,7 @@ getmethod(): `Method`
|
||||
|
||||
*Inherited from Extrinsic.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L97)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L97)*
|
||||
|
||||
**Returns:** `Method`
|
||||
|
||||
@@ -205,7 +205,7 @@ getsignature(): `ExtrinsicSignature`
|
||||
|
||||
*Inherited from Extrinsic.signature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L101)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L101)*
|
||||
|
||||
**Returns:** `ExtrinsicSignature`
|
||||
|
||||
@@ -236,7 +236,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.addSignature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:111](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L111)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:111](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L111)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -344,7 +344,7 @@ ___
|
||||
|
||||
*Inherited from Struct.getAtIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L128)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L128)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -395,7 +395,7 @@ ___
|
||||
|
||||
▸ **send**(statusCb?: * `undefined` | `function`*): `Promise`<`Hash`>
|
||||
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -434,7 +434,7 @@ ___
|
||||
|
||||
*Overrides Extrinsic.sign*
|
||||
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
|
||||
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -455,7 +455,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L132)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L132)*
|
||||
|
||||
**Returns:** `Array`<`Codec`>
|
||||
|
||||
@@ -470,7 +470,7 @@ ___
|
||||
|
||||
*Overrides Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L131)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L131)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -485,7 +485,7 @@ ___
|
||||
|
||||
*Overrides Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:135](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L135)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:135](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L135)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -498,7 +498,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L151)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L151)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -513,7 +513,7 @@ ___
|
||||
|
||||
*Overrides Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:123](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L123)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:123](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L123)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -547,7 +547,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.decodeExtrinsic*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L42)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L42)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -566,7 +566,7 @@ ___
|
||||
|
||||
*Inherited from Struct.with*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L108)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
@@ -468,19 +468,19 @@
|
||||
  <span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
|
||||
</span></pre></div></div></code></pre>
|
||||
<h1 id="hierarchy">Hierarchy</h1>
|
||||
<p> <a href="_base_.apibase.md">ApiBase</a><<code>RpcRx</code>, <code>QueryableStorage</code>, <code>SubmittableExtrinsics</code>></p>
|
||||
<p> <a href="_base_.apibase.md">ApiBase</a><<code>RpcRx</code>, <a href="../interfaces/_rx_types_.queryablestorage.md">QueryableStorage</a>, <a href="../interfaces/_rx_types_.submittableextrinsics.md">SubmittableExtrinsics</a>></p>
|
||||
<p><strong>↳ ApiRx</strong></p>
|
||||
<h1 id="implements">Implements</h1>
|
||||
<ul>
|
||||
<li><code>ApiBaseInterface</code><<code>RpcRx</code>, <code>QueryableStorage</code>, <code>SubmittableExtrinsics</code>></li>
|
||||
<li><code>ApiRxInterface</code></li>
|
||||
<li><a href="../interfaces/_types_.apibaseinterface.md">ApiBaseInterface</a><<code>RpcRx</code>, <a href="../interfaces/_rx_types_.queryablestorage.md">QueryableStorage</a>, <a href="../interfaces/_rx_types_.submittableextrinsics.md">SubmittableExtrinsics</a>></li>
|
||||
<li><a href="../interfaces/_rx_types_.apirxinterface.md">ApiRxInterface</a></li>
|
||||
</ul>
|
||||
<h1 id="constructors">Constructors</h1>
|
||||
<p><a id="constructor"></a></p>
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new ApiRx</strong>(wsProvider?: <em><code>WsProvider</code></em>): <a href="_rx_index_.apirx.html">ApiRx</a></p>
|
||||
<p><em>Overrides <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#constructor">constructor</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/rx/index.ts#L143" target="_blank">rx/index.ts:143</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/index.ts#L143" target="_blank">rx/index.ts:143</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Create an instance of the ApiRx class</p>
|
||||
<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> <span class="sunlight-ident">Api</span> <span class="sunlight-ident">from</span> <span class="sunlight-string">'@polkadot/api/rx'</span><span class="sunlight-punctuation">;</span>
|
||||
@@ -515,29 +515,29 @@
|
||||
<h2 id="genesishash">genesisHash</h2>
|
||||
<p>getgenesisHash(): <code>Hash</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#genesishash">genesisHash</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L70" target="_blank">Base.ts:70</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L70" target="_blank">Base.ts:70</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.</p>
|
||||
<p><strong>Returns:</strong> <code>Hash</code></p>
|
||||
<hr>
|
||||
<p><a id="isconnected"></a></p>
|
||||
<h2 id="isconnected">isConnected</h2>
|
||||
<p>getisConnected(): <code>Observable</code><<code>boolean</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/rx/index.ts#L179" target="_blank">rx/index.ts:179</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/index.ts#L179" target="_blank">rx/index.ts:179</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.</p>
|
||||
<p><strong>Returns:</strong> <code>Observable</code><<code>boolean</code>></p>
|
||||
<hr>
|
||||
<p><a id="isready"></a></p>
|
||||
<h2 id="isready">isReady</h2>
|
||||
<p>getisReady(): <code>Observable</code><<a href="_rx_index_.apirx.html">ApiRx</a>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/rx/index.ts#L186" target="_blank">rx/index.ts:186</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/index.ts#L186" target="_blank">rx/index.ts:186</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Observable that returns the first time we are connected and loaded</p>
|
||||
<p><strong>Returns:</strong> <code>Observable</code><<a href="_rx_index_.apirx.html">ApiRx</a>></p>
|
||||
<hr>
|
||||
<p><a id="query"></a></p>
|
||||
<h2 id="query">query</h2>
|
||||
<p>getquery(): <code>QueryableStorage</code></p>
|
||||
<p>getquery(): <a href="../interfaces/_rx_types_.queryablestorage.md">QueryableStorage</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#query">query</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L108" target="_blank">Base.ts:108</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L108" target="_blank">Base.ts:108</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.</p>
|
||||
<p>All calls inside the namespace, is denoted by <code>section</code>.<code>method</code> and may take an optional query parameter. As an example, <code>api.query.timestamp.now()</code> (current block timestamp) does not take parameters, while <code>api.query.system.accountNonce(<accountId>)</code> (retrieving the associated nonce for an account), takes the <code>AccountId</code> as a parameter.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -545,13 +545,13 @@
|
||||
  <span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">'new balance'</span><span class="sunlight-punctuation">,</span> <span class="sunlight-ident">balance</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
|
||||
<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
|
||||
</span></pre></div></div></code></pre>
|
||||
<p><strong>Returns:</strong> <code>QueryableStorage</code></p>
|
||||
<p><strong>Returns:</strong> <a href="../interfaces/_rx_types_.queryablestorage.md">QueryableStorage</a></p>
|
||||
<hr>
|
||||
<p><a id="rpc"></a></p>
|
||||
<h2 id="rpc">rpc</h2>
|
||||
<p>getrpc(): <code>RpcRx</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#rpc">rpc</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L128" target="_blank">Base.ts:128</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L128" target="_blank">Base.ts:128</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic <code>api.query</code> and <code>api.tx</code> sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.</p>
|
||||
<p>RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -565,7 +565,7 @@
|
||||
<h2 id="runtimemetadata">runtimeMetadata</h2>
|
||||
<p>getruntimeMetadata(): <code>RuntimeMetadata</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimemetadata">runtimeMetadata</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L79" target="_blank">Base.ts:79</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.</p>
|
||||
<p><strong>Returns:</strong> <code>RuntimeMetadata</code></p>
|
||||
<hr>
|
||||
@@ -573,15 +573,15 @@
|
||||
<h2 id="runtimeversion">runtimeVersion</h2>
|
||||
<p>getruntimeVersion(): <code>RuntimeVersion</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#runtimeversion">runtimeVersion</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L88" target="_blank">Base.ts:88</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains the version information for the current runtime.</p>
|
||||
<p><strong>Returns:</strong> <code>RuntimeVersion</code></p>
|
||||
<hr>
|
||||
<p><a id="tx"></a></p>
|
||||
<h2 id="tx">tx</h2>
|
||||
<p>gettx(): <code>SubmittableExtrinsics</code></p>
|
||||
<p>gettx(): <a href="../interfaces/_rx_types_.submittableextrinsics.md">SubmittableExtrinsics</a></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#tx">tx</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L147" target="_blank">Base.ts:147</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L147" target="_blank">Base.ts:147</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.</p>
|
||||
<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-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">tx</span><span class="sunlight-operator">.</span><span class="sunlight-ident">balances</span>
|
||||
@@ -591,14 +591,14 @@
|
||||
    <span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">'tx status'</span><span class="sunlight-punctuation">,</span> <span class="sunlight-ident">status</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
|
||||
  <span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
|
||||
</span></pre></div></div></code></pre>
|
||||
<p><strong>Returns:</strong> <code>SubmittableExtrinsics</code></p>
|
||||
<p><strong>Returns:</strong> <a href="../interfaces/_rx_types_.submittableextrinsics.md">SubmittableExtrinsics</a></p>
|
||||
<hr>
|
||||
<h1 id="methods">Methods</h1>
|
||||
<p><a id="on"></a></p>
|
||||
<h2 id="on">on</h2>
|
||||
<p>▸ <strong>on</strong>(type: <em><code>ApiInterface$Events</code></em>, handler: <em><code>function</code></em>): <code>void</code></p>
|
||||
<p>▸ <strong>on</strong>(type: <em><a href="../modules/_types_.md#apiinterface_events">ApiInterface$Events</a></em>, handler: <em><code>function</code></em>): <code>void</code></p>
|
||||
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#on">on</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L172" target="_blank">Base.ts:172</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L172" target="_blank">Base.ts:172</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Attach an eventemitter handler to listen to a specific event</p>
|
||||
<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-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">on</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">'disconnected'</span><span class="sunlight-punctuation">,</span> <span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span> <span class="sunlight-operator">=</span><span class="sunlight-operator">></span> <span class="sunlight-punctuation">{</span>
|
||||
@@ -621,7 +621,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td><code>ApiInterface$Events</code></td>
|
||||
<td><a href="../modules/_types_.md#apiinterface_events">ApiInterface$Events</a></td>
|
||||
<td>The type of event to listen to. Available events are `connected`, `disconnected` and `ready`</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -636,7 +636,7 @@
|
||||
<p><a id="create"></a></p>
|
||||
<h2 id="static-create"><code><Static></code> create</h2>
|
||||
<p>▸ <strong>create</strong>(wsProvider?: <em><code>WsProvider</code></em>): <code>Observable</code><<a href="_rx_index_.apirx.html">ApiRx</a>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/rx/index.ts#L141" target="_blank">rx/index.ts:141</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/index.ts#L141" target="_blank">rx/index.ts:141</a></em></p>
|
||||
<p><em><strong>description</strong></em>: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.</p>
|
||||
<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> <span class="sunlight-ident">Api</span> <span class="sunlight-ident">from</span> <span class="sunlight-string">'@polkadot/api/rx'</span><span class="sunlight-punctuation">;</span>
|
||||
@@ -709,7 +709,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"1.2.2","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":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"api/classes/_rx_index_.apirx.md","mtime":"2018-11-29T10:24:55.180Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"1.2.2","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":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"api/classes/_rx_index_.apirx.md","mtime":"2018-11-29T11:16:54.305Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -98,14 +98,14 @@ api.query.system
|
||||
|
||||
# Hierarchy
|
||||
|
||||
[ApiBase](_base_.apibase.md)<`RpcRx`, `QueryableStorage`, `SubmittableExtrinsics`>
|
||||
[ApiBase](_base_.apibase.md)<`RpcRx`, [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md), [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics.md)>
|
||||
|
||||
**↳ ApiRx**
|
||||
|
||||
# Implements
|
||||
|
||||
* `ApiBaseInterface`<`RpcRx`, `QueryableStorage`, `SubmittableExtrinsics`>
|
||||
* `ApiRxInterface`
|
||||
* [ApiBaseInterface](../interfaces/_types_.apibaseinterface.md)<`RpcRx`, [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md), [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics.md)>
|
||||
* [ApiRxInterface](../interfaces/_rx_types_.apirxinterface.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -117,7 +117,7 @@ api.query.system
|
||||
|
||||
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
||||
|
||||
*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/rx/index.ts#L143)*
|
||||
*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/index.ts#L143)*
|
||||
|
||||
*__description__*: Create an instance of the ApiRx class
|
||||
|
||||
@@ -153,7 +153,7 @@ getgenesisHash(): `Hash`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
||||
|
||||
*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L70)*
|
||||
*Defined in [Base.ts:70](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L70)*
|
||||
|
||||
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
|
||||
|
||||
@@ -166,7 +166,7 @@ ___
|
||||
|
||||
getisConnected(): `Observable`<`boolean`>
|
||||
|
||||
*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/rx/index.ts#L179)*
|
||||
*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/index.ts#L179)*
|
||||
|
||||
*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
|
||||
|
||||
@@ -179,7 +179,7 @@ ___
|
||||
|
||||
getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)>
|
||||
|
||||
*Defined in [rx/index.ts:186](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/rx/index.ts#L186)*
|
||||
*Defined in [rx/index.ts:186](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/index.ts#L186)*
|
||||
|
||||
*__description__*: Observable that returns the first time we are connected and loaded
|
||||
|
||||
@@ -190,11 +190,11 @@ ___
|
||||
|
||||
## query
|
||||
|
||||
getquery(): `QueryableStorage`
|
||||
getquery(): [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md)
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
|
||||
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L108)*
|
||||
*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L108)*
|
||||
|
||||
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -208,7 +208,7 @@ api.query.balances.freeBalance(<accountId>, (balance) => {
|
||||
});
|
||||
```
|
||||
|
||||
**Returns:** `QueryableStorage`
|
||||
**Returns:** [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md)
|
||||
|
||||
___
|
||||
<a id="rpc"></a>
|
||||
@@ -219,7 +219,7 @@ getrpc(): `RpcRx`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
|
||||
|
||||
*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L128)*
|
||||
*Defined in [Base.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L128)*
|
||||
|
||||
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
|
||||
|
||||
@@ -244,7 +244,7 @@ getruntimeMetadata(): `RuntimeMetadata`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
|
||||
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L79)*
|
||||
*Defined in [Base.ts:79](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L79)*
|
||||
|
||||
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
|
||||
|
||||
@@ -259,7 +259,7 @@ getruntimeVersion(): `RuntimeVersion`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
|
||||
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L88)*
|
||||
*Defined in [Base.ts:88](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L88)*
|
||||
|
||||
*__description__*: Contains the version information for the current runtime.
|
||||
|
||||
@@ -270,11 +270,11 @@ ___
|
||||
|
||||
## tx
|
||||
|
||||
gettx(): `SubmittableExtrinsics`
|
||||
gettx(): [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics.md)
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
|
||||
|
||||
*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L147)*
|
||||
*Defined in [Base.ts:147](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L147)*
|
||||
|
||||
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
|
||||
|
||||
@@ -289,7 +289,7 @@ api.tx.balances
|
||||
});
|
||||
```
|
||||
|
||||
**Returns:** `SubmittableExtrinsics`
|
||||
**Returns:** [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics.md)
|
||||
|
||||
___
|
||||
|
||||
@@ -299,11 +299,11 @@ ___
|
||||
|
||||
## on
|
||||
|
||||
▸ **on**(type: *`ApiInterface$Events`*, handler: *`function`*): `void`
|
||||
▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
|
||||
|
||||
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
|
||||
|
||||
*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/Base.ts#L172)*
|
||||
*Defined in [Base.ts:172](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/Base.ts#L172)*
|
||||
|
||||
*__description__*: Attach an eventemitter handler to listen to a specific event
|
||||
|
||||
@@ -323,7 +323,7 @@ api.on('disconnected', () => {
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| type | `ApiInterface$Events` | The type of event to listen to. Available events are \`connected\`, \`disconnected\` and \`ready\` |
|
||||
| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\` and \`ready\` |
|
||||
| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. |
|
||||
|
||||
**Returns:** `void`
|
||||
@@ -335,7 +335,7 @@ ___
|
||||
|
||||
▸ **create**(wsProvider?: *`WsProvider`*): `Observable`<[ApiRx](_rx_index_.apirx.md)>
|
||||
|
||||
*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/rx/index.ts#L141)*
|
||||
*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/index.ts#L141)*
|
||||
|
||||
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
|
||||
|
||||
|
||||
@@ -21,17 +21,17 @@
|
||||
|
||||
## constructor
|
||||
|
||||
⊕ **new SubmittableExtrinsic**(api: *`ApiRxInterface`*, extrinsic: *`Extrinsic`*): [SubmittableExtrinsic](_rx_submittableextrinsic_.submittableextrinsic.md)
|
||||
⊕ **new SubmittableExtrinsic**(api: *[ApiRxInterface](../interfaces/_rx_types_.apirxinterface.md)*, extrinsic: *`Extrinsic`*): [SubmittableExtrinsic](_rx_submittableextrinsic_.submittableextrinsic.md)
|
||||
|
||||
*Overrides Extrinsic.__constructor*
|
||||
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiRxInterface` |
|
||||
| api | [ApiRxInterface](../interfaces/_rx_types_.apirxinterface.md) |
|
||||
| extrinsic | `Extrinsic` |
|
||||
|
||||
**Returns:** [SubmittableExtrinsic](_rx_submittableextrinsic_.submittableextrinsic.md)
|
||||
@@ -73,7 +73,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from Struct.Type*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L118)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L118)*
|
||||
|
||||
**Returns:** `E`
|
||||
|
||||
@@ -86,7 +86,7 @@ getargs(): `Array`<`Codec`>
|
||||
|
||||
*Inherited from Extrinsic.args*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:65](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L65)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:65](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L65)*
|
||||
|
||||
**Returns:** `Array`<`Codec`>
|
||||
|
||||
@@ -99,7 +99,7 @@ getcallIndex(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.callIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L70)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L70)*
|
||||
|
||||
**Returns:** `Uint8Array`
|
||||
|
||||
@@ -112,7 +112,7 @@ getdata(): `Uint8Array`
|
||||
|
||||
*Inherited from Extrinsic.data*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:74](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L74)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:74](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L74)*
|
||||
|
||||
**Returns:** `Uint8Array`
|
||||
|
||||
@@ -127,7 +127,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Overrides Struct.encodedLength*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L105)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L105)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -140,7 +140,7 @@ gethash(): `Hash`
|
||||
|
||||
*Inherited from Extrinsic.hash*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L79)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L79)*
|
||||
|
||||
**Returns:** `Hash`
|
||||
|
||||
@@ -153,7 +153,7 @@ getisSigned(): `boolean`
|
||||
|
||||
*Inherited from Extrinsic.isSigned*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L85)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L85)*
|
||||
|
||||
**Returns:** `boolean`
|
||||
|
||||
@@ -166,7 +166,7 @@ getlength(): `number`
|
||||
|
||||
*Inherited from Extrinsic.length*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:89](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L89)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:89](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L89)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -179,7 +179,7 @@ getmeta(): `FunctionMetadata`
|
||||
|
||||
*Inherited from Extrinsic.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L93)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L93)*
|
||||
|
||||
**Returns:** `FunctionMetadata`
|
||||
|
||||
@@ -192,7 +192,7 @@ getmethod(): `Method`
|
||||
|
||||
*Inherited from Extrinsic.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L97)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L97)*
|
||||
|
||||
**Returns:** `Method`
|
||||
|
||||
@@ -205,7 +205,7 @@ getsignature(): `ExtrinsicSignature`
|
||||
|
||||
*Inherited from Extrinsic.signature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L101)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L101)*
|
||||
|
||||
**Returns:** `ExtrinsicSignature`
|
||||
|
||||
@@ -236,7 +236,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.addSignature*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:111](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L111)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:111](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L111)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -344,7 +344,7 @@ ___
|
||||
|
||||
*Inherited from Struct.getAtIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L128)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L128)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -395,7 +395,7 @@ ___
|
||||
|
||||
▸ **send**(): `Observable`<`ExtrinsicStatus`>
|
||||
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
|
||||
|
||||
**Returns:** `Observable`<`ExtrinsicStatus`>
|
||||
|
||||
@@ -428,7 +428,7 @@ ___
|
||||
|
||||
*Overrides Extrinsic.sign*
|
||||
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
|
||||
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -449,7 +449,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toArray*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L132)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L132)*
|
||||
|
||||
**Returns:** `Array`<`Codec`>
|
||||
|
||||
@@ -464,7 +464,7 @@ ___
|
||||
|
||||
*Overrides Struct.toHex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L131)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L131)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -479,7 +479,7 @@ ___
|
||||
|
||||
*Overrides Struct.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:135](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L135)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:135](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L135)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -492,7 +492,7 @@ ___
|
||||
|
||||
*Inherited from Struct.toString*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L151)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L151)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -507,7 +507,7 @@ ___
|
||||
|
||||
*Overrides Struct.toU8a*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:123](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L123)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:123](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L123)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -541,7 +541,7 @@ ___
|
||||
|
||||
*Inherited from Extrinsic.decodeExtrinsic*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Extrinsic.ts#L42)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Extrinsic.ts#L42)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -560,7 +560,7 @@ ___
|
||||
|
||||
*Inherited from Struct.with*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L108)*
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
|
||||
+1
-1
@@ -495,7 +495,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"api","level":"1.2","depth":1,"next":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"api/README.md","mtime":"2018-11-29T10:24:54.720Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"api","level":"1.2","depth":1,"next":{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"api/README.md","mtime":"2018-11-29T11:16:53.797Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,113 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
[ApiBaseInterface](_types_.apibaseinterface.md)<`Rpc`, [QueryableStorage](_promise_types_.queryablestorage.md), [SubmittableExtrinsics](_promise_types_.submittableextrinsics.md)>
|
||||
|
||||
**↳ ApiPromiseInterface**
|
||||
|
||||
# Implemented by
|
||||
|
||||
* [ApiPromise](../classes/_promise_index_.apipromise.md)
|
||||
|
||||
# Properties
|
||||
|
||||
<a id="genesishash"></a>
|
||||
|
||||
## genesisHash
|
||||
|
||||
**● genesisHash**: *`Hash`*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)*
|
||||
|
||||
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L12)*
|
||||
|
||||
___
|
||||
<a id="isready"></a>
|
||||
|
||||
## isReady
|
||||
|
||||
**● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>*
|
||||
|
||||
*Defined in [promise/types.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/types.ts#L39)*
|
||||
|
||||
___
|
||||
<a id="on"></a>
|
||||
|
||||
## on
|
||||
|
||||
**● on**: *`function`*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L19)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) |
|
||||
| handler | `function` |
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
___
|
||||
<a id="query"></a>
|
||||
|
||||
## query
|
||||
|
||||
**● query**: *[QueryableStorage](_promise_types_.queryablestorage.md)*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="rpc"></a>
|
||||
|
||||
## rpc
|
||||
|
||||
**● rpc**: *`Rpc`*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
|
||||
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="runtimemetadata"></a>
|
||||
|
||||
## runtimeMetadata
|
||||
|
||||
**● runtimeMetadata**: *`RuntimeMetadata`*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
|
||||
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L13)*
|
||||
|
||||
___
|
||||
<a id="runtimeversion"></a>
|
||||
|
||||
## runtimeVersion
|
||||
|
||||
**● runtimeVersion**: *`RuntimeVersion`*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
|
||||
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="tx"></a>
|
||||
|
||||
## tx
|
||||
|
||||
**● tx**: *[SubmittableExtrinsics](_promise_types_.submittableextrinsics.md)*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L17)*
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**QueryableModuleStorage**
|
||||
|
||||
# Indexable
|
||||
|
||||
\[index: `string`\]: [QueryableStorageFunction](_promise_types_.queryablestoragefunction.md)
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**QueryableStorage**
|
||||
|
||||
# Indexable
|
||||
|
||||
\[index: `string`\]: [QueryableModuleStorage](_promise_types_.queryablemodulestorage.md)
|
||||
@@ -0,0 +1,85 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
`StorageFunction`
|
||||
|
||||
**↳ QueryableStorageFunction**
|
||||
|
||||
# Callable
|
||||
▸ **__call**(arg?: *`any`*): `Promise`< `Codec` | `null` | `undefined`>
|
||||
|
||||
▸ **__call**(arg?: *`any`*): `Uint8Array`
|
||||
|
||||
*Defined in [promise/types.ts:14](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/types.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Optional` arg | `any` |
|
||||
|
||||
**Returns:** `Promise`< `Codec` | `null` | `undefined`>
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/StorageKey.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Optional` arg | `any` |
|
||||
|
||||
**Returns:** `Uint8Array`
|
||||
|
||||
# Properties
|
||||
|
||||
<a id="meta"></a>
|
||||
|
||||
## meta
|
||||
|
||||
**● meta**: *`StorageFunctionMetadata`*
|
||||
|
||||
*Inherited from StorageFunction.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/StorageKey.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="method"></a>
|
||||
|
||||
## method
|
||||
|
||||
**● method**: *`string`*
|
||||
|
||||
*Inherited from StorageFunction.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/StorageKey.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="section"></a>
|
||||
|
||||
## section
|
||||
|
||||
**● section**: *`string`*
|
||||
|
||||
*Inherited from StorageFunction.section*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/StorageKey.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="tojson"></a>
|
||||
|
||||
## toJSON
|
||||
|
||||
**● toJSON**: *`function`*
|
||||
|
||||
*Inherited from StorageFunction.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/StorageKey.ts#L17)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `any`
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,96 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
`ExtrinsicFunction`
|
||||
|
||||
**↳ SubmittableExtrinsicFunction**
|
||||
|
||||
# Callable
|
||||
▸ **__call**(...args: *`any`[]*): [SubmittableExtrinsic](../classes/_promise_submittableextrinsic_.submittableextrinsic.md)
|
||||
|
||||
▸ **__call**(...args: *`any`[]*): `Extrinsic`
|
||||
|
||||
*Defined in [promise/types.ts:26](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/types.ts#L26)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Rest` args | `any`[] |
|
||||
|
||||
**Returns:** [SubmittableExtrinsic](../classes/_promise_submittableextrinsic_.submittableextrinsic.md)
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L34)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Rest` args | `any`[] |
|
||||
|
||||
**Returns:** `Extrinsic`
|
||||
|
||||
# Properties
|
||||
|
||||
<a id="callindex"></a>
|
||||
|
||||
## callIndex
|
||||
|
||||
**● callIndex**: *`Uint8Array`*
|
||||
|
||||
*Inherited from ExtrinsicFunction.callIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L36)*
|
||||
|
||||
___
|
||||
<a id="meta"></a>
|
||||
|
||||
## meta
|
||||
|
||||
**● meta**: *`FunctionMetadata`*
|
||||
|
||||
*Inherited from ExtrinsicFunction.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L37)*
|
||||
|
||||
___
|
||||
<a id="method"></a>
|
||||
|
||||
## method
|
||||
|
||||
**● method**: *`string`*
|
||||
|
||||
*Inherited from ExtrinsicFunction.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L38)*
|
||||
|
||||
___
|
||||
<a id="section"></a>
|
||||
|
||||
## section
|
||||
|
||||
**● section**: *`string`*
|
||||
|
||||
*Inherited from ExtrinsicFunction.section*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L39)*
|
||||
|
||||
___
|
||||
<a id="tojson"></a>
|
||||
|
||||
## toJSON
|
||||
|
||||
**● toJSON**: *`function`*
|
||||
|
||||
*Inherited from ExtrinsicFunction.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L40)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `any`
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**SubmittableExtrinsics**
|
||||
|
||||
# Indexable
|
||||
|
||||
\[index: `string`\]: [SubmittableModuleExtrinsics](_promise_types_.submittablemoduleextrinsics.md)
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**SubmittableModuleExtrinsics**
|
||||
|
||||
# Indexable
|
||||
|
||||
\[index: `string`\]: [SubmittableExtrinsicFunction](_promise_types_.submittableextrinsicfunction.md)
|
||||
@@ -0,0 +1,122 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
[ApiBaseInterface](_types_.apibaseinterface.md)<`RpcRx`, [QueryableStorage](_rx_types_.queryablestorage.md), [SubmittableExtrinsics](_rx_types_.submittableextrinsics.md)>
|
||||
|
||||
**↳ ApiRxInterface**
|
||||
|
||||
# Implemented by
|
||||
|
||||
* [ApiRx](../classes/_rx_index_.apirx.md)
|
||||
|
||||
# Properties
|
||||
|
||||
<a id="genesishash"></a>
|
||||
|
||||
## genesisHash
|
||||
|
||||
**● genesisHash**: *`Hash`*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)*
|
||||
|
||||
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L12)*
|
||||
|
||||
___
|
||||
<a id="isconnected"></a>
|
||||
|
||||
## isConnected
|
||||
|
||||
**● isConnected**: *`Observable`<`boolean`>*
|
||||
|
||||
*Defined in [rx/types.ts:40](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/types.ts#L40)*
|
||||
|
||||
___
|
||||
<a id="isready"></a>
|
||||
|
||||
## isReady
|
||||
|
||||
**● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>*
|
||||
|
||||
*Defined in [rx/types.ts:41](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/types.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="on"></a>
|
||||
|
||||
## on
|
||||
|
||||
**● on**: *`function`*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L19)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) |
|
||||
| handler | `function` |
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
___
|
||||
<a id="query"></a>
|
||||
|
||||
## query
|
||||
|
||||
**● query**: *[QueryableStorage](_rx_types_.queryablestorage.md)*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="rpc"></a>
|
||||
|
||||
## rpc
|
||||
|
||||
**● rpc**: *`RpcRx`*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)*
|
||||
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="runtimemetadata"></a>
|
||||
|
||||
## runtimeMetadata
|
||||
|
||||
**● runtimeMetadata**: *`RuntimeMetadata`*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)*
|
||||
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L13)*
|
||||
|
||||
___
|
||||
<a id="runtimeversion"></a>
|
||||
|
||||
## runtimeVersion
|
||||
|
||||
**● runtimeVersion**: *`RuntimeVersion`*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)*
|
||||
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="tx"></a>
|
||||
|
||||
## tx
|
||||
|
||||
**● tx**: *[SubmittableExtrinsics](_rx_types_.submittableextrinsics.md)*
|
||||
|
||||
*Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L17)*
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**QueryableModuleStorage**
|
||||
|
||||
# Indexable
|
||||
|
||||
\[index: `string`\]: [QueryableStorageFunction](_rx_types_.queryablestoragefunction.md)
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**QueryableStorage**
|
||||
|
||||
# Indexable
|
||||
|
||||
\[index: `string`\]: [QueryableModuleStorage](_rx_types_.queryablemodulestorage.md)
|
||||
@@ -0,0 +1,85 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
`StorageFunction`
|
||||
|
||||
**↳ QueryableStorageFunction**
|
||||
|
||||
# Callable
|
||||
▸ **__call**(arg?: *`any`*): `Observable`< `Codec` | `null` | `undefined`>
|
||||
|
||||
▸ **__call**(arg?: *`any`*): `Uint8Array`
|
||||
|
||||
*Defined in [rx/types.ts:15](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/types.ts#L15)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Optional` arg | `any` |
|
||||
|
||||
**Returns:** `Observable`< `Codec` | `null` | `undefined`>
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/StorageKey.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Optional` arg | `any` |
|
||||
|
||||
**Returns:** `Uint8Array`
|
||||
|
||||
# Properties
|
||||
|
||||
<a id="meta"></a>
|
||||
|
||||
## meta
|
||||
|
||||
**● meta**: *`StorageFunctionMetadata`*
|
||||
|
||||
*Inherited from StorageFunction.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/StorageKey.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="method"></a>
|
||||
|
||||
## method
|
||||
|
||||
**● method**: *`string`*
|
||||
|
||||
*Inherited from StorageFunction.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/StorageKey.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="section"></a>
|
||||
|
||||
## section
|
||||
|
||||
**● section**: *`string`*
|
||||
|
||||
*Inherited from StorageFunction.section*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/StorageKey.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="tojson"></a>
|
||||
|
||||
## toJSON
|
||||
|
||||
**● toJSON**: *`function`*
|
||||
|
||||
*Inherited from StorageFunction.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/StorageKey.ts#L17)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `any`
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,96 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
`ExtrinsicFunction`
|
||||
|
||||
**↳ SubmittableExtrinsicFunction**
|
||||
|
||||
# Callable
|
||||
▸ **__call**(...args: *`any`[]*): [SubmittableExtrinsic](../classes/_rx_submittableextrinsic_.submittableextrinsic.md)
|
||||
|
||||
▸ **__call**(...args: *`any`[]*): `Extrinsic`
|
||||
|
||||
*Defined in [rx/types.ts:27](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/rx/types.ts#L27)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Rest` args | `any`[] |
|
||||
|
||||
**Returns:** [SubmittableExtrinsic](../classes/_rx_submittableextrinsic_.submittableextrinsic.md)
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L34)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Rest` args | `any`[] |
|
||||
|
||||
**Returns:** `Extrinsic`
|
||||
|
||||
# Properties
|
||||
|
||||
<a id="callindex"></a>
|
||||
|
||||
## callIndex
|
||||
|
||||
**● callIndex**: *`Uint8Array`*
|
||||
|
||||
*Inherited from ExtrinsicFunction.callIndex*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:36](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L36)*
|
||||
|
||||
___
|
||||
<a id="meta"></a>
|
||||
|
||||
## meta
|
||||
|
||||
**● meta**: *`FunctionMetadata`*
|
||||
|
||||
*Inherited from ExtrinsicFunction.meta*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:37](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L37)*
|
||||
|
||||
___
|
||||
<a id="method"></a>
|
||||
|
||||
## method
|
||||
|
||||
**● method**: *`string`*
|
||||
|
||||
*Inherited from ExtrinsicFunction.method*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:38](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L38)*
|
||||
|
||||
___
|
||||
<a id="section"></a>
|
||||
|
||||
## section
|
||||
|
||||
**● section**: *`string`*
|
||||
|
||||
*Inherited from ExtrinsicFunction.section*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L39)*
|
||||
|
||||
___
|
||||
<a id="tojson"></a>
|
||||
|
||||
## toJSON
|
||||
|
||||
**● toJSON**: *`function`*
|
||||
|
||||
*Inherited from ExtrinsicFunction.toJSON*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:40](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Method.ts#L40)*
|
||||
|
||||
#### Type declaration
|
||||
▸(): `any`
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**SubmittableExtrinsics**
|
||||
|
||||
# Indexable
|
||||
|
||||
\[index: `string`\]: [SubmittableModuleExtrinsics](_rx_types_.submittablemoduleextrinsics.md)
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**SubmittableModuleExtrinsics**
|
||||
|
||||
# Indexable
|
||||
|
||||
\[index: `string`\]: [SubmittableExtrinsicFunction](_rx_types_.submittableextrinsicfunction.md)
|
||||
@@ -0,0 +1,98 @@
|
||||
|
||||
|
||||
# Type parameters
|
||||
#### R
|
||||
#### S
|
||||
#### E
|
||||
# Hierarchy
|
||||
|
||||
**ApiBaseInterface**
|
||||
|
||||
↳ [ApiPromiseInterface](_promise_types_.apipromiseinterface.md)
|
||||
|
||||
↳ [ApiRxInterface](_rx_types_.apirxinterface.md)
|
||||
|
||||
# Implemented by
|
||||
|
||||
* [ApiBase](../classes/_base_.apibase.md)
|
||||
* [ApiPromise](../classes/_promise_index_.apipromise.md)
|
||||
* [ApiRx](../classes/_rx_index_.apirx.md)
|
||||
|
||||
# Properties
|
||||
|
||||
<a id="genesishash"></a>
|
||||
|
||||
## genesisHash
|
||||
|
||||
**● genesisHash**: *`Hash`*
|
||||
|
||||
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L12)*
|
||||
|
||||
___
|
||||
<a id="on"></a>
|
||||
|
||||
## on
|
||||
|
||||
**● on**: *`function`*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L19)*
|
||||
|
||||
#### Type declaration
|
||||
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void`
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) |
|
||||
| handler | `function` |
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
___
|
||||
<a id="query"></a>
|
||||
|
||||
## query
|
||||
|
||||
**● query**: *`S`*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L15)*
|
||||
|
||||
___
|
||||
<a id="rpc"></a>
|
||||
|
||||
## rpc
|
||||
|
||||
**● rpc**: *`R`*
|
||||
|
||||
*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L16)*
|
||||
|
||||
___
|
||||
<a id="runtimemetadata"></a>
|
||||
|
||||
## runtimeMetadata
|
||||
|
||||
**● runtimeMetadata**: *`RuntimeMetadata`*
|
||||
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L13)*
|
||||
|
||||
___
|
||||
<a id="runtimeversion"></a>
|
||||
|
||||
## runtimeVersion
|
||||
|
||||
**● runtimeVersion**: *`RuntimeVersion`*
|
||||
|
||||
*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="tx"></a>
|
||||
|
||||
## tx
|
||||
|
||||
**● tx**: *`E`*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L17)*
|
||||
|
||||
___
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
**Ƭ CombinatorCallback**: *`function`*
|
||||
|
||||
*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/Combinator.ts#L7)*
|
||||
*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/Combinator.ts#L7)*
|
||||
|
||||
#### Type declaration
|
||||
▸(value: *`Array`<`any`>*): `any`
|
||||
@@ -41,7 +41,7 @@ ___
|
||||
|
||||
**Ƭ CombinatorFunction**: *`function`*
|
||||
|
||||
*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/379e82a/packages/api/src/promise/Combinator.ts#L8)*
|
||||
*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/promise/Combinator.ts#L8)*
|
||||
|
||||
#### Type declaration
|
||||
▸(cb: *`function`*): `any`
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# Index
|
||||
|
||||
### Interfaces
|
||||
|
||||
* [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md)
|
||||
* [QueryableModuleStorage](../interfaces/_promise_types_.queryablemodulestorage.md)
|
||||
* [QueryableStorage](../interfaces/_promise_types_.queryablestorage.md)
|
||||
* [QueryableStorageFunction](../interfaces/_promise_types_.queryablestoragefunction.md)
|
||||
* [SubmittableExtrinsicFunction](../interfaces/_promise_types_.submittableextrinsicfunction.md)
|
||||
* [SubmittableExtrinsics](../interfaces/_promise_types_.submittableextrinsics.md)
|
||||
* [SubmittableModuleExtrinsics](../interfaces/_promise_types_.submittablemoduleextrinsics.md)
|
||||
|
||||
---
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# Index
|
||||
|
||||
### Interfaces
|
||||
|
||||
* [ApiRxInterface](../interfaces/_rx_types_.apirxinterface.md)
|
||||
* [QueryableModuleStorage](../interfaces/_rx_types_.queryablemodulestorage.md)
|
||||
* [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md)
|
||||
* [QueryableStorageFunction](../interfaces/_rx_types_.queryablestoragefunction.md)
|
||||
* [SubmittableExtrinsicFunction](../interfaces/_rx_types_.submittableextrinsicfunction.md)
|
||||
* [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics.md)
|
||||
* [SubmittableModuleExtrinsics](../interfaces/_rx_types_.submittablemoduleextrinsics.md)
|
||||
|
||||
---
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
|
||||
|
||||
# Index
|
||||
|
||||
### Interfaces
|
||||
|
||||
* [ApiBaseInterface](../interfaces/_types_.apibaseinterface.md)
|
||||
|
||||
### Type aliases
|
||||
|
||||
* [ApiInterface$Events](_types_.md#apiinterface_events)
|
||||
|
||||
---
|
||||
|
||||
# Type aliases
|
||||
|
||||
<a id="apiinterface_events"></a>
|
||||
|
||||
## ApiInterface$Events
|
||||
|
||||
**Ƭ ApiInterface$Events**: * `RpcRxInterface$Events` | "ready"
|
||||
*
|
||||
|
||||
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/9092250/packages/api/src/types.ts#L9)*
|
||||
|
||||
___
|
||||
|
||||
@@ -461,7 +461,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"3.1.1","depth":2,"next":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/01_simple_connect/README.md","mtime":"2018-11-29T10:22:33.119Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"3.1.1","depth":2,"next":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"ApiPromise","level":"3.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/01_simple_connect/README.md","mtime":"2018-11-29T11:14:34.663Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -463,7 +463,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"3.1.2","depth":2,"next":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/02_listen_to_blocks/README.md","mtime":"2018-11-29T10:22:33.119Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"3.1.2","depth":2,"next":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/02_listen_to_blocks/README.md","mtime":"2018-11-29T11:14:34.663Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -474,7 +474,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.1.3","depth":2,"next":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/03_listen_to_balance_change/README.md","mtime":"2018-11-29T10:22:33.119Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"3.1.3","depth":2,"next":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"3.1.2","depth":2,"path":"examples/promise/02_listen_to_blocks/README.md","ref":"examples/promise/02_listen_to_blocks/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/03_listen_to_balance_change/README.md","mtime":"2018-11-29T11:14:34.663Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -473,7 +473,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.1.4","depth":2,"next":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/05_read_storage/README.md","mtime":"2018-11-29T10:22:33.119Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"3.1.4","depth":2,"next":{"title":"Make a transfer","level":"3.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"3.1.3","depth":2,"path":"examples/promise/03_listen_to_balance_change/README.md","ref":"examples/promise/03_listen_to_balance_change/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/05_read_storage/README.md","mtime":"2018-11-29T11:14:34.663Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -469,7 +469,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.1.5","depth":2,"previous":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/07_transfer_dots/README.md","mtime":"2018-11-29T10:22:33.119Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"../../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"3.1.5","depth":2,"previous":{"title":"Read chain state","level":"3.1.4","depth":2,"path":"examples/promise/05_read_storage/README.md","ref":"examples/promise/05_read_storage/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/07_transfer_dots/README.md","mtime":"2018-11-29T11:14:34.667Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"../../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -451,7 +451,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"3.1","depth":1,"next":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"previous":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/README.md","mtime":"2018-11-29T10:22:33.119Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"3.1","depth":1,"next":{"title":"Simple connect","level":"3.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.md","articles":[]},"previous":{"title":"Events (runtime)","level":"2.4","depth":1,"path":"METHODS_EVENTS.md","ref":"METHODS_EVENTS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"examples/promise/README.md","mtime":"2018-11-29T11:14:34.667Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
+1
-1
@@ -475,7 +475,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"README.md","mtime":"2018-11-29T10:22:33.111Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":".","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"README.md","mtime":"2018-11-29T11:14:34.659Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":".","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -1,2 +1,5 @@
|
||||
* ["index"](modules/_index_.md)
|
||||
* [Rpc](classes/_index_.rpc.md)
|
||||
* ["types"](modules/_types_.md)
|
||||
* [RpcInterface](interfaces/_types_.rpcinterface.md)
|
||||
* [RpcInterface$Section$Method](interfaces/_types_.rpcinterface_section_method.md)
|
||||
|
||||
@@ -28,7 +28,7 @@ const api = new Api(provider);
|
||||
|
||||
# Implements
|
||||
|
||||
* `RpcInterface`
|
||||
* [RpcInterface](../interfaces/_types_.rpcinterface.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -38,7 +38,7 @@ const api = new Api(provider);
|
||||
|
||||
⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md)
|
||||
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-core/src/index.ts#L44)*
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/index.ts#L44)*
|
||||
|
||||
*__constructor__*: Default constructor for the Api Object
|
||||
|
||||
@@ -60,43 +60,51 @@ ___
|
||||
|
||||
**● _provider**: *`ProviderInterface`*
|
||||
|
||||
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-core/src/index.ts#L40)*
|
||||
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/index.ts#L40)*
|
||||
|
||||
___
|
||||
<a id="author"></a>
|
||||
|
||||
## author
|
||||
|
||||
**● author**: *`RpcInterface$Section`*
|
||||
**● author**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-core/src/index.ts#L41)*
|
||||
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)*
|
||||
|
||||
*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/index.ts#L41)*
|
||||
|
||||
___
|
||||
<a id="chain"></a>
|
||||
|
||||
## chain
|
||||
|
||||
**● chain**: *`RpcInterface$Section`*
|
||||
**● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-core/src/index.ts#L42)*
|
||||
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)*
|
||||
|
||||
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/index.ts#L42)*
|
||||
|
||||
___
|
||||
<a id="state"></a>
|
||||
|
||||
## state
|
||||
|
||||
**● state**: *`RpcInterface$Section`*
|
||||
**● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-core/src/index.ts#L43)*
|
||||
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)*
|
||||
|
||||
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/index.ts#L43)*
|
||||
|
||||
___
|
||||
<a id="system"></a>
|
||||
|
||||
## system
|
||||
|
||||
**● system**: *`RpcInterface$Section`*
|
||||
**● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-core/src/index.ts#L44)*
|
||||
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)*
|
||||
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/index.ts#L44)*
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +116,7 @@ ___
|
||||
|
||||
▸ **signature**(__namedParameters: *`object`*): `string`
|
||||
|
||||
*Defined in [index.ts:77](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-core/src/index.ts#L77)*
|
||||
*Defined in [index.ts:77](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/index.ts#L77)*
|
||||
|
||||
*__name__*: signature
|
||||
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**RpcInterface**
|
||||
|
||||
# Implemented by
|
||||
|
||||
* [Rpc](../classes/_index_.rpc.md)
|
||||
|
||||
# Properties
|
||||
|
||||
<a id="author"></a>
|
||||
|
||||
## author
|
||||
|
||||
**● author**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/types.ts#L17)*
|
||||
|
||||
___
|
||||
<a id="chain"></a>
|
||||
|
||||
## chain
|
||||
|
||||
**● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/types.ts#L18)*
|
||||
|
||||
___
|
||||
<a id="state"></a>
|
||||
|
||||
## state
|
||||
|
||||
**● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/types.ts#L19)*
|
||||
|
||||
___
|
||||
<a id="system"></a>
|
||||
|
||||
## system
|
||||
|
||||
**● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
|
||||
|
||||
*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/types.ts#L20)*
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**RpcInterface$Section$Method**
|
||||
|
||||
# Callable
|
||||
▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`>
|
||||
|
||||
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/types.ts#L5)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Rest` params | `Array`<`any`> |
|
||||
|
||||
**Returns:** `Promise`<`any`>
|
||||
|
||||
# Properties
|
||||
|
||||
<a id="subscription"></a>
|
||||
|
||||
## subscription
|
||||
|
||||
**● subscription**: *`string`*
|
||||
|
||||
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/types.ts#L8)*
|
||||
|
||||
___
|
||||
<a id="unsubscribe"></a>
|
||||
|
||||
## unsubscribe
|
||||
|
||||
**● unsubscribe**: *`function`*
|
||||
|
||||
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/types.ts#L9)*
|
||||
|
||||
#### Type declaration
|
||||
▸(id: *`number`*): `Promise`<`any`>
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| id | `number` |
|
||||
|
||||
**Returns:** `Promise`<`any`>
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
|
||||
|
||||
# Index
|
||||
|
||||
### Interfaces
|
||||
|
||||
* [RpcInterface](../interfaces/_types_.rpcinterface.md)
|
||||
* [RpcInterface$Section$Method](../interfaces/_types_.rpcinterface_section_method.md)
|
||||
|
||||
### Type aliases
|
||||
|
||||
* [RpcInterface$Section](_types_.md#rpcinterface_section)
|
||||
|
||||
---
|
||||
|
||||
# Type aliases
|
||||
|
||||
<a id="rpcinterface_section"></a>
|
||||
|
||||
## RpcInterface$Section
|
||||
|
||||
**Ƭ RpcInterface$Section**: *`object`*
|
||||
|
||||
*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-core/src/types.ts#L12)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
[index: `string`]: [RpcInterface$Section$Method](../interfaces/_types_.rpcinterface_section_method.md)
|
||||
|
||||
___
|
||||
|
||||
@@ -7,13 +7,17 @@
|
||||
* ["http/index"](modules/_http_index_.md)
|
||||
* [HttpProvider](classes/_http_index_.httpprovider.md)
|
||||
* ["http/polyfill"](modules/_http_polyfill_.md)
|
||||
* ["http/types"](modules/_http_types_.md)
|
||||
* ["index"](modules/_index_.md)
|
||||
* ["mock/index"](modules/_mock_index_.md)
|
||||
* [Mock](classes/_mock_index_.mock.md)
|
||||
* ["mock/on.spec"](modules/_mock_on_spec_.md)
|
||||
* ["mock/send.spec"](modules/_mock_send_spec_.md)
|
||||
* ["mock/subscribe.spec"](modules/_mock_subscribe_spec_.md)
|
||||
* ["mock/types"](modules/_mock_types_.md)
|
||||
* ["mock/unsubscribe.spec"](modules/_mock_unsubscribe_spec_.md)
|
||||
* ["types"](modules/_types_.md)
|
||||
* [ProviderInterface](interfaces/_types_.providerinterface.md)
|
||||
* ["ws/index"](modules/_ws_index_.md)
|
||||
* [WsProvider](classes/_ws_index_.wsprovider.md)
|
||||
* ["ws/polyfill"](modules/_ws_polyfill_.md)
|
||||
|
||||
@@ -10,15 +10,15 @@
|
||||
|
||||
## decodeResponse
|
||||
|
||||
▸ **decodeResponse**(response: *`JsonRpcResponse`*): `any`
|
||||
▸ **decodeResponse**(response: *[JsonRpcResponse](../modules/_types_.md#jsonrpcresponse)*): `any`
|
||||
|
||||
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/coder/index.ts#L12)*
|
||||
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/coder/index.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| response | `JsonRpcResponse` |
|
||||
| response | [JsonRpcResponse](../modules/_types_.md#jsonrpcresponse) |
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -29,7 +29,7 @@ ___
|
||||
|
||||
▸ **encodeJson**(method: *`string`*, params: * `any` | `Array`<`any`>*): `string`
|
||||
|
||||
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/coder/index.ts#L33)*
|
||||
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/coder/index.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -45,9 +45,9 @@ ___
|
||||
|
||||
## encodeObject
|
||||
|
||||
▸ **encodeObject**(method: *`string`*, params: * `any` | `Array`<`any`>*): `JsonRpcRequest`
|
||||
▸ **encodeObject**(method: *`string`*, params: * `any` | `Array`<`any`>*): [JsonRpcRequest](../modules/_types_.md#jsonrpcrequest)
|
||||
|
||||
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/coder/index.ts#L39)*
|
||||
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/coder/index.ts#L39)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -56,7 +56,7 @@ ___
|
||||
| method | `string` |
|
||||
| params | `any` | `Array`<`any`>|
|
||||
|
||||
**Returns:** `JsonRpcRequest`
|
||||
**Returns:** [JsonRpcRequest](../modules/_types_.md#jsonrpcrequest)
|
||||
|
||||
___
|
||||
<a id="getid"></a>
|
||||
@@ -65,7 +65,7 @@ ___
|
||||
|
||||
▸ **getId**(): `number`
|
||||
|
||||
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/coder/index.ts#L48)*
|
||||
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/coder/index.ts#L48)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
|
||||
@@ -408,13 +408,13 @@
|
||||
<p><strong>HttpProvider</strong></p>
|
||||
<h1 id="implements">Implements</h1>
|
||||
<ul>
|
||||
<li><code>ProviderInterface</code></li>
|
||||
<li><a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a></li>
|
||||
</ul>
|
||||
<h1 id="constructors">Constructors</h1>
|
||||
<p><a id="constructor"></a></p>
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new HttpProvider</strong>(endpoint?: <em><code>string</code></em>): <a href="_http_index_.httpprovider.html">HttpProvider</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L40" target="_blank">http/index.ts:40</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L40" target="_blank">http/index.ts:40</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -440,15 +440,17 @@
|
||||
<p><a id="isconnected"></a></p>
|
||||
<h2 id="isconnected">isConnected</h2>
|
||||
<p>▸ <strong>isConnected</strong>(): <code>boolean</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L56" target="_blank">http/index.ts:56</a></em></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#isconnected">isConnected</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L56" target="_blank">http/index.ts:56</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code>
|
||||
true if connected</p>
|
||||
<hr>
|
||||
<p><a id="on"></a></p>
|
||||
<h2 id="on">on</h2>
|
||||
<p>▸ <strong>on</strong>(type: <em><code>ProviderInterface$Emitted</code></em>, sub: <em><code>ProviderInterface$EmitCb</code></em>): <code>void</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L64" target="_blank">http/index.ts:64</a></em></p>
|
||||
<p>▸ <strong>on</strong>(type: <em><a href="../modules/_types_.md#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="../modules/_types_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>void</code></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#on">on</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L64" target="_blank">http/index.ts:64</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Events are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
|
||||
<p><em><strong>description</strong></em>: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
@@ -462,11 +464,11 @@ true if connected</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td><code>ProviderInterface$Emitted</code></td>
|
||||
<td><a href="../modules/_types_.md#providerinterface_emitted">ProviderInterface$Emitted</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sub</td>
|
||||
<td><code>ProviderInterface$EmitCb</code></td>
|
||||
<td><a href="../modules/_types_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -475,7 +477,8 @@ true if connected</p>
|
||||
<p><a id="send"></a></p>
|
||||
<h2 id="send">send</h2>
|
||||
<p>▸ <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>): <code>Promise</code><<code>any</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L71" target="_blank">http/index.ts:71</a></em></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#send">send</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L71" target="_blank">http/index.ts:71</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Send HTTP POST Request with Body to configured HTTP Endpoint.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -500,8 +503,9 @@ true if connected</p>
|
||||
<hr>
|
||||
<p><a id="subscribe"></a></p>
|
||||
<h2 id="subscribe">subscribe</h2>
|
||||
<p>▸ <strong>subscribe</strong>(types: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>, cb: <em><code>ProviderInterface$Callback</code></em>): <code>Promise</code><<code>number</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L93" target="_blank">http/index.ts:93</a></em></p>
|
||||
<p>▸ <strong>subscribe</strong>(types: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>, cb: <em><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code><<code>number</code>></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#subscribe">subscribe</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L93" target="_blank">http/index.ts:93</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -526,7 +530,7 @@ true if connected</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cb</td>
|
||||
<td><code>ProviderInterface$Callback</code></td>
|
||||
<td><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -535,7 +539,8 @@ true if connected</p>
|
||||
<p><a id="unsubscribe"></a></p>
|
||||
<h2 id="unsubscribe">unsubscribe</h2>
|
||||
<p>▸ <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code><<code>boolean</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L102" target="_blank">http/index.ts:102</a></em></p>
|
||||
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#unsubscribe">unsubscribe</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L102" target="_blank">http/index.ts:102</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -605,7 +610,7 @@ true if connected</p>
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"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-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":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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-provider/classes/_http_index_.httpprovider.md","mtime":"2018-11-29T10:25:12.124Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"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-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":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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-provider/classes/_http_index_.httpprovider.md","mtime":"2018-11-29T11:17:11.305Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -24,7 +24,7 @@ const api = new Api(provider);
|
||||
|
||||
# Implements
|
||||
|
||||
* `ProviderInterface`
|
||||
* [ProviderInterface](../interfaces/_types_.providerinterface.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -34,7 +34,7 @@ const api = new Api(provider);
|
||||
|
||||
⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
|
||||
|
||||
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L40)*
|
||||
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L40)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -54,7 +54,9 @@ ___
|
||||
|
||||
▸ **isConnected**(): `boolean`
|
||||
|
||||
*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L56)*
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
|
||||
|
||||
*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L56)*
|
||||
|
||||
*__summary__*: Whether the node is connected or not.
|
||||
|
||||
@@ -66,9 +68,11 @@ ___
|
||||
|
||||
## on
|
||||
|
||||
▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void`
|
||||
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
|
||||
|
||||
*Defined in [http/index.ts:64](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L64)*
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
|
||||
|
||||
*Defined in [http/index.ts:64](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L64)*
|
||||
|
||||
*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
|
||||
|
||||
@@ -78,8 +82,8 @@ ___
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| type | `ProviderInterface$Emitted` |
|
||||
| sub | `ProviderInterface$EmitCb` |
|
||||
| type | [ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted) |
|
||||
| sub | [ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb) |
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
@@ -90,7 +94,9 @@ ___
|
||||
|
||||
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
|
||||
|
||||
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L71)*
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
|
||||
|
||||
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L71)*
|
||||
|
||||
*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
|
||||
|
||||
@@ -108,9 +114,11 @@ ___
|
||||
|
||||
## subscribe
|
||||
|
||||
▸ **subscribe**(types: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *`ProviderInterface$Callback`*): `Promise`<`number`>
|
||||
▸ **subscribe**(types: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
|
||||
|
||||
*Defined in [http/index.ts:93](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L93)*
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)*
|
||||
|
||||
*Defined in [http/index.ts:93](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L93)*
|
||||
|
||||
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
|
||||
|
||||
@@ -121,7 +129,7 @@ ___
|
||||
| types | `string` |
|
||||
| method | `string` |
|
||||
| params | `Array`<`any`> |
|
||||
| cb | `ProviderInterface$Callback` |
|
||||
| cb | [ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback) |
|
||||
|
||||
**Returns:** `Promise`<`number`>
|
||||
|
||||
@@ -132,7 +140,9 @@ ___
|
||||
|
||||
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
|
||||
|
||||
*Defined in [http/index.ts:102](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/http/index.ts#L102)*
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
|
||||
|
||||
*Defined in [http/index.ts:102](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/index.ts#L102)*
|
||||
|
||||
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ A mock provider mainly used for testing.
|
||||
|
||||
# Implements
|
||||
|
||||
* `ProviderInterface`
|
||||
* [ProviderInterface](../interfaces/_types_.providerinterface.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -19,7 +19,7 @@ A mock provider mainly used for testing.
|
||||
|
||||
⊕ **new Mock**(): [Mock](_mock_index_.mock.md)
|
||||
|
||||
*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/mock/index.ts#L64)*
|
||||
*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/index.ts#L64)*
|
||||
|
||||
**Returns:** [Mock](_mock_index_.mock.md)
|
||||
|
||||
@@ -33,14 +33,14 @@ ___
|
||||
|
||||
**● isUpdating**: *`boolean`* = true
|
||||
|
||||
*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/mock/index.ts#L42)*
|
||||
*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/index.ts#L42)*
|
||||
|
||||
___
|
||||
<a id="subscriptions"></a>
|
||||
|
||||
## subscriptions
|
||||
|
||||
**● subscriptions**: *`MockState$Subscriptions`* = SUBSCRIPTIONS.reduce((subs, name) => {
|
||||
**● subscriptions**: *[MockState$Subscriptions](../modules/_mock_types_.md#mockstate_subscriptions)* = SUBSCRIPTIONS.reduce((subs, name) => {
|
||||
subs[name] = {
|
||||
callbacks: {},
|
||||
lastValue: null
|
||||
@@ -49,7 +49,7 @@ ___
|
||||
return subs;
|
||||
}, ({} as MockState$Subscriptions))
|
||||
|
||||
*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/mock/index.ts#L53)*
|
||||
*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/index.ts#L53)*
|
||||
|
||||
___
|
||||
|
||||
@@ -61,7 +61,9 @@ ___
|
||||
|
||||
▸ **isConnected**(): `boolean`
|
||||
|
||||
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/mock/index.ts#L70)*
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
|
||||
|
||||
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/index.ts#L70)*
|
||||
|
||||
**Returns:** `boolean`
|
||||
|
||||
@@ -70,16 +72,18 @@ ___
|
||||
|
||||
## on
|
||||
|
||||
▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void`
|
||||
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
|
||||
|
||||
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/mock/index.ts#L74)*
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
|
||||
|
||||
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/index.ts#L74)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| type | `ProviderInterface$Emitted` |
|
||||
| sub | `ProviderInterface$EmitCb` |
|
||||
| type | [ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted) |
|
||||
| sub | [ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb) |
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
@@ -90,7 +94,9 @@ ___
|
||||
|
||||
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
|
||||
|
||||
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/mock/index.ts#L78)*
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
|
||||
|
||||
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/index.ts#L78)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -108,7 +114,7 @@ ___
|
||||
|
||||
▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`>
|
||||
|
||||
*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/mock/index.ts#L86)*
|
||||
*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/index.ts#L86)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -127,7 +133,9 @@ ___
|
||||
|
||||
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
|
||||
|
||||
*Defined in [mock/index.ts:106](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/mock/index.ts#L106)*
|
||||
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
|
||||
|
||||
*Defined in [mock/index.ts:106](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/index.ts#L106)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -414,7 +414,7 @@
|
||||
<p><a id="constructor"></a></p>
|
||||
<h2 id="constructor">constructor</h2>
|
||||
<p>⊕ <strong>new WsProvider</strong>(endpoint?: <em><code>string</code></em>, autoConnect?: <em><code>boolean</code></em>): <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L75" target="_blank">ws/index.ts:75</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L75" target="_blank">ws/index.ts:75</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -446,7 +446,7 @@
|
||||
<p><a id="connect"></a></p>
|
||||
<h2 id="connect">connect</h2>
|
||||
<p>▸ <strong>connect</strong>(): <code>void</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L103" target="_blank">ws/index.ts:103</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L103" target="_blank">ws/index.ts:103</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Manually connect</p>
|
||||
<p><em><strong>description</strong></em>: The <a href="_ws_index_.wsprovider.html">WsProvider</a> connects automatically by default, however if you decided otherwise, you may connect manually using this method.</p>
|
||||
<p><strong>Returns:</strong> <code>void</code></p>
|
||||
@@ -454,15 +454,15 @@
|
||||
<p><a id="isconnected"></a></p>
|
||||
<h2 id="isconnected">isConnected</h2>
|
||||
<p>▸ <strong>isConnected</strong>(): <code>boolean</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L120" target="_blank">ws/index.ts:120</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L120" target="_blank">ws/index.ts:120</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
|
||||
<p><strong>Returns:</strong> <code>boolean</code>
|
||||
true if connected</p>
|
||||
<hr>
|
||||
<p><a id="on"></a></p>
|
||||
<h2 id="on">on</h2>
|
||||
<p>▸ <strong>on</strong>(type: <em><code>ProviderInterface$Emitted</code></em>, sub: <em><code>ProviderInterface$EmitCb</code></em>): <code>void</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L129" target="_blank">ws/index.ts:129</a></em></p>
|
||||
<p>▸ <strong>on</strong>(type: <em><a href="../modules/_types_.md#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="../modules/_types_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>void</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L129" target="_blank">ws/index.ts:129</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Listens on events after having subscribed using the <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a> function.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -476,12 +476,12 @@ true if connected</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td><code>ProviderInterface$Emitted</code></td>
|
||||
<td><a href="../modules/_types_.md#providerinterface_emitted">ProviderInterface$Emitted</a></td>
|
||||
<td>Event</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sub</td>
|
||||
<td><code>ProviderInterface$EmitCb</code></td>
|
||||
<td><a href="../modules/_types_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></td>
|
||||
<td>Callback</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -491,7 +491,7 @@ true if connected</p>
|
||||
<p><a id="send"></a></p>
|
||||
<h2 id="send">send</h2>
|
||||
<p>▸ <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>, subscription?: <em><code>SubscriptionHandler</code></em>): <code>Promise</code><<code>any</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L139" target="_blank">ws/index.ts:139</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L139" target="_blank">ws/index.ts:139</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Send JSON data using WebSockets to configured HTTP Endpoint or queue.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -524,8 +524,8 @@ true if connected</p>
|
||||
<hr>
|
||||
<p><a id="subscribe"></a></p>
|
||||
<h2 id="subscribe">subscribe</h2>
|
||||
<p>▸ <strong>subscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>, callback: <em><code>ProviderInterface$Callback</code></em>): <code>Promise</code><<code>number</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L195" target="_blank">ws/index.ts:195</a></em></p>
|
||||
<p>▸ <strong>subscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>, callback: <em><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code><<code>number</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L195" target="_blank">ws/index.ts:195</a></em></p>
|
||||
<p><em><strong>name</strong></em>: subscribe</p>
|
||||
<p><em><strong>summary</strong></em>: Allows subscribing to a specific event.</p>
|
||||
<p><em><strong>example</strong></em>: </p>
|
||||
@@ -565,7 +565,7 @@ true if connected</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>callback</td>
|
||||
<td><code>ProviderInterface$Callback</code></td>
|
||||
<td><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></td>
|
||||
<td>Callback</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -576,7 +576,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
|
||||
<p><a id="unsubscribe"></a></p>
|
||||
<h2 id="unsubscribe">unsubscribe</h2>
|
||||
<p>▸ <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code><<code>boolean</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L204" target="_blank">ws/index.ts:204</a></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L204" target="_blank">ws/index.ts:204</a></em></p>
|
||||
<p><em><strong>summary</strong></em>: Allows unsubscribing to subscriptions made with <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a>.</p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
@@ -646,7 +646,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"RPC","level":"2.1","depth":1,"path":"METHODS_RPC.md","ref":"METHODS_RPC.md","articles":[]},"previous":{"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":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-11-29T10:25:12.212Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"../..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"RPC","level":"2.1","depth":1,"path":"METHODS_RPC.md","ref":"METHODS_RPC.md","articles":[]},"previous":{"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":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-11-29T11:17:11.401Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"../..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -34,7 +34,7 @@ const api = new Api(provider);
|
||||
|
||||
⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
|
||||
|
||||
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L75)*
|
||||
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L75)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -55,7 +55,7 @@ ___
|
||||
|
||||
▸ **connect**(): `void`
|
||||
|
||||
*Defined in [ws/index.ts:103](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L103)*
|
||||
*Defined in [ws/index.ts:103](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L103)*
|
||||
|
||||
*__summary__*: Manually connect
|
||||
|
||||
@@ -70,7 +70,7 @@ ___
|
||||
|
||||
▸ **isConnected**(): `boolean`
|
||||
|
||||
*Defined in [ws/index.ts:120](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L120)*
|
||||
*Defined in [ws/index.ts:120](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L120)*
|
||||
|
||||
*__summary__*: Whether the node is connected or not.
|
||||
|
||||
@@ -82,9 +82,9 @@ ___
|
||||
|
||||
## on
|
||||
|
||||
▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void`
|
||||
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
|
||||
|
||||
*Defined in [ws/index.ts:129](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L129)*
|
||||
*Defined in [ws/index.ts:129](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L129)*
|
||||
|
||||
*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
|
||||
|
||||
@@ -92,8 +92,8 @@ ___
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| type | `ProviderInterface$Emitted` | Event |
|
||||
| sub | `ProviderInterface$EmitCb` | Callback |
|
||||
| type | [ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted) | Event |
|
||||
| sub | [ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb) | Callback |
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
@@ -104,7 +104,7 @@ ___
|
||||
|
||||
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
|
||||
|
||||
*Defined in [ws/index.ts:139](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L139)*
|
||||
*Defined in [ws/index.ts:139](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L139)*
|
||||
|
||||
*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
|
||||
|
||||
@@ -123,9 +123,9 @@ ___
|
||||
|
||||
## subscribe
|
||||
|
||||
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *`ProviderInterface$Callback`*): `Promise`<`number`>
|
||||
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
|
||||
|
||||
*Defined in [ws/index.ts:195](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L195)*
|
||||
*Defined in [ws/index.ts:195](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L195)*
|
||||
|
||||
*__name__*: subscribe
|
||||
|
||||
@@ -151,7 +151,7 @@ rpc.state.subscribeStorage([[storage.balances.freeBalance, <Address>]], (_, valu
|
||||
| type | `string` | Subscription type |
|
||||
| method | `string` | Subscription method |
|
||||
| params | `Array`<`any`> | Parameters |
|
||||
| callback | `ProviderInterface$Callback` | Callback |
|
||||
| callback | [ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback) | Callback |
|
||||
|
||||
**Returns:** `Promise`<`number`>
|
||||
Promise resolving to the dd of the subscription you can use with [[unsubscribe]].
|
||||
@@ -163,7 +163,7 @@ ___
|
||||
|
||||
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
|
||||
|
||||
*Defined in [ws/index.ts:204](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-provider/src/ws/index.ts#L204)*
|
||||
*Defined in [ws/index.ts:204](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/ws/index.ts#L204)*
|
||||
|
||||
*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
|
||||
|
||||
|
||||
@@ -462,7 +462,7 @@
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"rpc-provider","level":"1.3","depth":1,"next":{"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":[]},"previous":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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-provider/README.md","mtime":"2018-11-29T10:25:11.960Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T10:26:16.157Z"},"basePath":"..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"rpc-provider","level":"1.3","depth":1,"next":{"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":[]},"previous":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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-provider/README.md","mtime":"2018-11-29T11:17:11.133Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T11:18:15.414Z"},"basePath":"..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**ProviderInterface**
|
||||
|
||||
# Implemented by
|
||||
|
||||
* [HttpProvider](../classes/_http_index_.httpprovider.md)
|
||||
* [Mock](../classes/_mock_index_.mock.md)
|
||||
|
||||
# Methods
|
||||
|
||||
<a id="isconnected"></a>
|
||||
|
||||
## isConnected
|
||||
|
||||
▸ **isConnected**(): `boolean`
|
||||
|
||||
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L45)*
|
||||
|
||||
**Returns:** `boolean`
|
||||
|
||||
___
|
||||
<a id="on"></a>
|
||||
|
||||
## on
|
||||
|
||||
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
|
||||
|
||||
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L46)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| type | [ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted) |
|
||||
| sub | [ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb) |
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
___
|
||||
<a id="send"></a>
|
||||
|
||||
## send
|
||||
|
||||
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
|
||||
|
||||
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L47)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| method | `string` |
|
||||
| params | `Array`<`any`> |
|
||||
|
||||
**Returns:** `Promise`<`any`>
|
||||
|
||||
___
|
||||
<a id="subscribe"></a>
|
||||
|
||||
## subscribe
|
||||
|
||||
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
|
||||
|
||||
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L48)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| type | `string` |
|
||||
| method | `string` |
|
||||
| params | `Array`<`any`> |
|
||||
| cb | [ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback) |
|
||||
|
||||
**Returns:** `Promise`<`number`>
|
||||
|
||||
___
|
||||
<a id="unsubscribe"></a>
|
||||
|
||||
## unsubscribe
|
||||
|
||||
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
|
||||
|
||||
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L49)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| type | `string` |
|
||||
| method | `string` |
|
||||
| id | `number` |
|
||||
|
||||
**Returns:** `Promise`<`boolean`>
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
|
||||
|
||||
# Type aliases
|
||||
|
||||
<a id="httpstate"></a>
|
||||
|
||||
## HttpState
|
||||
|
||||
**Ƭ HttpState**: *`object`*
|
||||
|
||||
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/http/types.ts#L9)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,76 @@
|
||||
|
||||
|
||||
# Type aliases
|
||||
|
||||
<a id="mockstate_db"></a>
|
||||
|
||||
## MockState$Db
|
||||
|
||||
**Ƭ MockState$Db**: *`object`*
|
||||
|
||||
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/types.ts#L16)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
[index: `string`]: `Uint8Array`
|
||||
|
||||
___
|
||||
<a id="mockstate_requests"></a>
|
||||
|
||||
## MockState$Requests
|
||||
|
||||
**Ƭ MockState$Requests**: *`object`*
|
||||
|
||||
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/types.ts#L20)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
[index: `string`]: `function`
|
||||
|
||||
▸(db: *[MockState$Db](_mock_types_.md#mockstate_db)*, params: *`Array`<`any`>*): `string`
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| db | [MockState$Db](_mock_types_.md#mockstate_db) |
|
||||
| params | `Array`<`any`> |
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
___
|
||||
<a id="mockstate_subscription_callback"></a>
|
||||
|
||||
## MockState$Subscription$Callback
|
||||
|
||||
**Ƭ MockState$Subscription$Callback**: *`function`*
|
||||
|
||||
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/types.ts#L5)*
|
||||
|
||||
#### Type declaration
|
||||
▸(error: * `Error` | `null`*, value: *`any`*): `void`
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| error | `Error` | `null`|
|
||||
| value | `any` |
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
___
|
||||
<a id="mockstate_subscriptions"></a>
|
||||
|
||||
## MockState$Subscriptions
|
||||
|
||||
**Ƭ MockState$Subscriptions**: *`object`*
|
||||
|
||||
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/mock/types.ts#L7)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
[index: `string`]: `object`
|
||||
|
||||
___
|
||||
|
||||
@@ -0,0 +1,126 @@
|
||||
|
||||
|
||||
# Index
|
||||
|
||||
### Interfaces
|
||||
|
||||
* [ProviderInterface](../interfaces/_types_.providerinterface.md)
|
||||
|
||||
### Type aliases
|
||||
|
||||
* [JsonRpcObject](_types_.md#jsonrpcobject)
|
||||
* [JsonRpcRequest](_types_.md#jsonrpcrequest)
|
||||
* [JsonRpcResponse](_types_.md#jsonrpcresponse)
|
||||
* [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)
|
||||
* [JsonRpcResponseBase$Error](_types_.md#jsonrpcresponsebase_error)
|
||||
* [ProviderInterface$Callback](_types_.md#providerinterface_callback)
|
||||
* [ProviderInterface$EmitCb](_types_.md#providerinterface_emitcb)
|
||||
* [ProviderInterface$Emitted](_types_.md#providerinterface_emitted)
|
||||
|
||||
---
|
||||
|
||||
# Type aliases
|
||||
|
||||
<a id="jsonrpcobject"></a>
|
||||
|
||||
## JsonRpcObject
|
||||
|
||||
**Ƭ JsonRpcObject**: *`object`*
|
||||
|
||||
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L5)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
<a id="jsonrpcrequest"></a>
|
||||
|
||||
## JsonRpcRequest
|
||||
|
||||
**Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_.md#jsonrpcobject) & `object`
|
||||
*
|
||||
|
||||
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L10)*
|
||||
|
||||
___
|
||||
<a id="jsonrpcresponse"></a>
|
||||
|
||||
## JsonRpcResponse
|
||||
|
||||
**Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)
|
||||
*
|
||||
|
||||
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L36)*
|
||||
|
||||
___
|
||||
<a id="jsonrpcresponsebase"></a>
|
||||
|
||||
## JsonRpcResponseBase
|
||||
|
||||
**Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`
|
||||
*
|
||||
|
||||
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L34)*
|
||||
|
||||
___
|
||||
<a id="jsonrpcresponsebase_error"></a>
|
||||
|
||||
## JsonRpcResponseBase$Error
|
||||
|
||||
**Ƭ JsonRpcResponseBase$Error**: *`object`*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L15)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
<a id="providerinterface_callback"></a>
|
||||
|
||||
## ProviderInterface$Callback
|
||||
|
||||
**Ƭ ProviderInterface$Callback**: *`function`*
|
||||
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L38)*
|
||||
|
||||
#### Type declaration
|
||||
▸(result: *`any`*): `void`
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| result | `any` |
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
___
|
||||
<a id="providerinterface_emitcb"></a>
|
||||
|
||||
## ProviderInterface$EmitCb
|
||||
|
||||
**Ƭ ProviderInterface$EmitCb**: *`function`*
|
||||
|
||||
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L42)*
|
||||
|
||||
#### Type declaration
|
||||
▸(value?: *`any`*): `any`
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Optional` value | `any` |
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
___
|
||||
<a id="providerinterface_emitted"></a>
|
||||
|
||||
## ProviderInterface$Emitted
|
||||
|
||||
**Ƭ ProviderInterface$Emitted**: * "connected" | "disconnected"
|
||||
*
|
||||
|
||||
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-provider/src/types.ts#L40)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1,2 +1,3 @@
|
||||
* ["index"](modules/_index_.md)
|
||||
* [RpcRx](classes/_index_.rpcrx.md)
|
||||
* ["types"](modules/_types_.md)
|
||||
|
||||
@@ -32,7 +32,7 @@ const api = new RpcRx(provider);
|
||||
|
||||
⊕ **new RpcRx**(providerOrRpc?: * `Rpc` | `ProviderInterface`*): [RpcRx](_index_.rpcrx.md)
|
||||
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-rx/src/index.ts#L45)*
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-rx/src/index.ts#L45)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -50,36 +50,36 @@ ___
|
||||
|
||||
## author
|
||||
|
||||
**● author**: *`RpcRxInterface$Section`*
|
||||
**● author**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
|
||||
|
||||
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-rx/src/index.ts#L42)*
|
||||
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-rx/src/index.ts#L42)*
|
||||
|
||||
___
|
||||
<a id="chain"></a>
|
||||
|
||||
## chain
|
||||
|
||||
**● chain**: *`RpcRxInterface$Section`*
|
||||
**● chain**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
|
||||
|
||||
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-rx/src/index.ts#L43)*
|
||||
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-rx/src/index.ts#L43)*
|
||||
|
||||
___
|
||||
<a id="state"></a>
|
||||
|
||||
## state
|
||||
|
||||
**● state**: *`RpcRxInterface$Section`*
|
||||
**● state**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
|
||||
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-rx/src/index.ts#L44)*
|
||||
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-rx/src/index.ts#L44)*
|
||||
|
||||
___
|
||||
<a id="system"></a>
|
||||
|
||||
## system
|
||||
|
||||
**● system**: *`RpcRxInterface$Section`*
|
||||
**● system**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)*
|
||||
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-rx/src/index.ts#L45)*
|
||||
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-rx/src/index.ts#L45)*
|
||||
|
||||
___
|
||||
|
||||
@@ -91,7 +91,7 @@ ___
|
||||
|
||||
▸ **isConnected**(): `BehaviorSubject`<`boolean`>
|
||||
|
||||
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-rx/src/index.ts#L66)*
|
||||
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-rx/src/index.ts#L66)*
|
||||
|
||||
**Returns:** `BehaviorSubject`<`boolean`>
|
||||
|
||||
@@ -100,15 +100,15 @@ ___
|
||||
|
||||
## on
|
||||
|
||||
▸ **on**(type: *`RpcRxInterface$Events`*, handler: *`function`*): `void`
|
||||
▸ **on**(type: *[RpcRxInterface$Events](../modules/_types_.md#rpcrxinterface_events)*, handler: *`function`*): `void`
|
||||
|
||||
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/379e82a/packages/rpc-rx/src/index.ts#L70)*
|
||||
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-rx/src/index.ts#L70)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| type | `RpcRxInterface$Events` |
|
||||
| type | [RpcRxInterface$Events](../modules/_types_.md#rpcrxinterface_events) |
|
||||
| handler | `function` |
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
|
||||
|
||||
# Type aliases
|
||||
|
||||
<a id="rpcrxinterface"></a>
|
||||
|
||||
## RpcRxInterface
|
||||
|
||||
**Ƭ RpcRxInterface**: *`object`*
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-rx/src/types.ts#L15)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
<a id="rpcrxinterface_events"></a>
|
||||
|
||||
## RpcRxInterface$Events
|
||||
|
||||
**Ƭ RpcRxInterface$Events**: * "connected" | "disconnected"
|
||||
*
|
||||
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-rx/src/types.ts#L13)*
|
||||
|
||||
___
|
||||
<a id="rpcrxinterface_method"></a>
|
||||
|
||||
## RpcRxInterface$Method
|
||||
|
||||
**Ƭ RpcRxInterface$Method**: *`function`*
|
||||
|
||||
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-rx/src/types.ts#L7)*
|
||||
|
||||
#### Type declaration
|
||||
▸(...params: *`Array`<`any`>*): `Observable`<`any`> | `ReplaySubject`<`any`>
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Rest` params | `Array`<`any`> |
|
||||
|
||||
**Returns:** `Observable`<`any`> | `ReplaySubject`<`any`>
|
||||
|
||||
___
|
||||
<a id="rpcrxinterface_section"></a>
|
||||
|
||||
## RpcRxInterface$Section
|
||||
|
||||
**Ƭ RpcRxInterface$Section**: *`object`*
|
||||
|
||||
*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/9092250/packages/rpc-rx/src/types.ts#L9)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
[index: `string`]: [RpcRxInterface$Method](_types_.md#rpcrxinterface_method)
|
||||
|
||||
___
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **fromMetadata**(metadata: *`Metadata`*): `Extrinsics`
|
||||
|
||||
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/379e82a/packages/type-extrinsics/src/fromMetadata.ts#L21)*
|
||||
*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/9092250/packages/type-extrinsics/src/fromMetadata.ts#L21)*
|
||||
|
||||
Extend a storage object with the storage modules & module functions present in the metadata.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **createDescriptor**(section: *`string`*, method: *`string`*, index: *`number`*, meta: *`FunctionMetadata`*): `ExtrinsicFunction`
|
||||
|
||||
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/379e82a/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)*
|
||||
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/9092250/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)*
|
||||
|
||||
From the metadata of a function in the module's storage, generate the function that will return the an UncheckExtrinsic.
|
||||
|
||||
|
||||
@@ -5,3 +5,4 @@
|
||||
* ["index"](modules/_index_.md)
|
||||
* ["state"](modules/_state_.md)
|
||||
* ["system"](modules/_system_.md)
|
||||
* ["types"](modules/_types_.md)
|
||||
|
||||
@@ -6,9 +6,9 @@
|
||||
|
||||
## createMethod
|
||||
|
||||
▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): `RpcMethod`
|
||||
▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): [RpcMethod](_types_.md#rpcmethod)
|
||||
|
||||
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/379e82a/packages/type-jsonrpc/src/create/method.ts#L9)*
|
||||
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/9092250/packages/type-jsonrpc/src/create/method.ts#L9)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
| method | `string` |
|
||||
| __namedParameters | `object` |
|
||||
|
||||
**Returns:** `RpcMethod`
|
||||
**Returns:** [RpcMethod](_types_.md#rpcmethod)
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -6,9 +6,9 @@
|
||||
|
||||
## createParam
|
||||
|
||||
▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): `RpcParam`
|
||||
▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): [RpcParam](_types_.md#rpcparam)
|
||||
|
||||
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/379e82a/packages/type-jsonrpc/src/create/param.ts#L12)*
|
||||
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/9092250/packages/type-jsonrpc/src/create/param.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
| type | `CodecTypes` | - |
|
||||
| `Default value` __namedParameters | `object` | { isOptional: false } |
|
||||
|
||||
**Returns:** `RpcParam`
|
||||
**Returns:** [RpcParam](_types_.md#rpcparam)
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
|
||||
|
||||
# Type aliases
|
||||
|
||||
<a id="rpcmethod"></a>
|
||||
|
||||
## RpcMethod
|
||||
|
||||
**Ƭ RpcMethod**: *`object`*
|
||||
|
||||
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/9092250/packages/type-jsonrpc/src/types.ts#L24)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
<a id="rpcmethodopt"></a>
|
||||
|
||||
## RpcMethodOpt
|
||||
|
||||
**Ƭ RpcMethodOpt**: *`object`*
|
||||
|
||||
*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/9092250/packages/type-jsonrpc/src/types.ts#L13)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
<a id="rpcparam"></a>
|
||||
|
||||
## RpcParam
|
||||
|
||||
**Ƭ RpcParam**: *`object`*
|
||||
|
||||
*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/9092250/packages/type-jsonrpc/src/types.ts#L7)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
<a id="rpcsection"></a>
|
||||
|
||||
## RpcSection
|
||||
|
||||
**Ƭ RpcSection**: *`object`*
|
||||
|
||||
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/9092250/packages/type-jsonrpc/src/types.ts#L38)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
|
||||
@@ -3,5 +3,8 @@
|
||||
* ["static"](modules/_static_.md)
|
||||
* ["storage"](modules/_storage_.md)
|
||||
* ["substrate"](modules/_substrate_.md)
|
||||
* ["types"](modules/_types_.md)
|
||||
* [ModuleStorage](interfaces/_types_.modulestorage.md)
|
||||
* [Storage](interfaces/_types_.storage.md)
|
||||
* ["utils/createFunction"](modules/_utils_createfunction_.md)
|
||||
* [CreateItemOptions](interfaces/_utils_createfunction_.createitemoptions.md)
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**ModuleStorage**
|
||||
|
||||
# Indexable
|
||||
|
||||
\[key: `string`\]: `StorageFunction`
|
||||
@@ -0,0 +1,23 @@
|
||||
|
||||
|
||||
# Hierarchy
|
||||
|
||||
**Storage**
|
||||
|
||||
# Indexable
|
||||
|
||||
\[key: `string`\]: [ModuleStorage](_types_.modulestorage.md)
|
||||
# Properties
|
||||
|
||||
<a id="substrate"></a>
|
||||
|
||||
## substrate
|
||||
|
||||
**● substrate**: *`object`*
|
||||
|
||||
*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/types.ts#L17)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
___
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
**● isUnhashed**: * `undefined` | `false` | `true`
|
||||
*
|
||||
|
||||
*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/utils/createFunction.ts#L14)*
|
||||
*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/utils/createFunction.ts#L14)*
|
||||
|
||||
___
|
||||
<a id="method"></a>
|
||||
@@ -23,7 +23,7 @@ ___
|
||||
**● method**: * `undefined` | `string`
|
||||
*
|
||||
|
||||
*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/utils/createFunction.ts#L15)*
|
||||
*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/utils/createFunction.ts#L15)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -6,9 +6,9 @@
|
||||
|
||||
## fromMetadata
|
||||
|
||||
▸ **fromMetadata**(metadata: *`Metadata`*): `Storage`
|
||||
▸ **fromMetadata**(metadata: *`Metadata`*): [Storage](../interfaces/_types_.storage.md)
|
||||
|
||||
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/fromMetadata.ts#L20)*
|
||||
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/fromMetadata.ts#L20)*
|
||||
|
||||
Extend a storage object with the storage modules & module functions present in the metadata.
|
||||
|
||||
@@ -18,7 +18,7 @@ Extend a storage object with the storage modules & module functions present in t
|
||||
| ------ | ------ | ------ |
|
||||
| metadata | `Metadata` | The metadata to extend the storage object against. |
|
||||
|
||||
**Returns:** `Storage`
|
||||
**Returns:** [Storage](../interfaces/_types_.storage.md)
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
**storage**: *`object`*
|
||||
|
||||
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/storage.ts#L8)*
|
||||
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/storage.ts#L8)*
|
||||
|
||||
<a id="storage.substrate"></a>
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
|
||||
**● substrate**: *["substrate"](_substrate_.md)*
|
||||
|
||||
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/storage.ts#L9)*
|
||||
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/storage.ts#L9)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
type: 'u32'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/substrate.ts#L45)*
|
||||
*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/substrate.ts#L45)*
|
||||
|
||||
___
|
||||
<a id="authorityprefix"></a>
|
||||
@@ -23,7 +23,7 @@ ___
|
||||
type: 'u32'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/substrate.ts#L50)*
|
||||
*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/substrate.ts#L50)*
|
||||
|
||||
___
|
||||
<a id="changestrieconfig"></a>
|
||||
@@ -35,7 +35,7 @@ ___
|
||||
type: 'u32'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/substrate.ts#L60)*
|
||||
*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/substrate.ts#L60)*
|
||||
|
||||
___
|
||||
<a id="code"></a>
|
||||
@@ -47,7 +47,7 @@ ___
|
||||
type: 'Bytes'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/substrate.ts#L35)*
|
||||
*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/substrate.ts#L35)*
|
||||
|
||||
___
|
||||
<a id="extrinsicindex"></a>
|
||||
@@ -59,7 +59,7 @@ ___
|
||||
type: 'u32'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/substrate.ts#L55)*
|
||||
*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/substrate.ts#L55)*
|
||||
|
||||
___
|
||||
<a id="heappages"></a>
|
||||
@@ -71,7 +71,7 @@ ___
|
||||
type: 'u64'
|
||||
})
|
||||
|
||||
*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/substrate.ts#L40)*
|
||||
*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/substrate.ts#L40)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
|
||||
|
||||
# Index
|
||||
|
||||
### Interfaces
|
||||
|
||||
* [ModuleStorage](../interfaces/_types_.modulestorage.md)
|
||||
* [Storage](../interfaces/_types_.storage.md)
|
||||
|
||||
---
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
|
||||
▸ **createFunction**(section: *`Text`*, method: *`Text`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction`
|
||||
|
||||
*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/379e82a/packages/type-storage/src/utils/createFunction.ts#L28)*
|
||||
*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/9092250/packages/type-storage/src/utils/createFunction.ts#L28)*
|
||||
|
||||
From the schema of a function in the module's storage, generate the function that will return the correct storage key.
|
||||
|
||||
|
||||
@@ -222,3 +222,5 @@
|
||||
* ["index"](modules/_index_.md)
|
||||
* ["scripts/MetadataJsonDecode"](modules/_scripts_metadatajsondecode_.md)
|
||||
* ["scripts/MetadataMd"](modules/_scripts_metadatamd_.md)
|
||||
* ["types"](modules/_types_.md)
|
||||
* [Codec](interfaces/_types_.codec.md)
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
# Implements
|
||||
|
||||
* `Codec`
|
||||
* [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
# Indexable
|
||||
|
||||
@@ -21,17 +21,17 @@
|
||||
|
||||
## constructor
|
||||
|
||||
⊕ **new AccountId**(value?: *`AnyU8a`*): [AccountId](_accountid_.accountid.md)
|
||||
⊕ **new AccountId**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [AccountId](_accountid_.accountid.md)
|
||||
|
||||
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
|
||||
|
||||
*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountId.ts#L15)*
|
||||
*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountId.ts#L15)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type | Default value |
|
||||
| ------ | ------ | ------ |
|
||||
| `Default value` value | `AnyU8a` | new Uint8Array() |
|
||||
| `Default value` value | [AnyU8a](../modules/_types_.md#anyu8a) | new Uint8Array() |
|
||||
|
||||
**Returns:** [AccountId](_accountid_.accountid.md)
|
||||
|
||||
@@ -126,7 +126,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/U8a.ts:28](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L28)*
|
||||
*Defined in [codec/U8a.ts:28](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L28)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -155,7 +155,7 @@ ___
|
||||
|
||||
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
|
||||
|
||||
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8aFixed.ts#L32)*
|
||||
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8aFixed.ts#L32)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -679,7 +679,7 @@ ___
|
||||
|
||||
*Overrides Uint8Array.subarray*
|
||||
|
||||
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L34)*
|
||||
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L34)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -697,9 +697,11 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
|
||||
|
||||
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L38)*
|
||||
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L38)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -710,9 +712,11 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
|
||||
|
||||
*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountId.ts#L39)*
|
||||
*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountId.ts#L39)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -738,9 +742,11 @@ ___
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
|
||||
|
||||
*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountId.ts#L43)*
|
||||
*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountId.ts#L43)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -751,9 +757,11 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
|
||||
|
||||
*Defined in [codec/U8a.ts:46](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L46)*
|
||||
*Defined in [codec/U8a.ts:46](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L46)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -785,7 +793,7 @@ ___
|
||||
|
||||
▸ **encode**(value: *`Uint8Array`*): `string`
|
||||
|
||||
*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountId.ts#L23)*
|
||||
*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountId.ts#L23)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
# Implements
|
||||
|
||||
* `Codec`
|
||||
* [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -16,17 +16,17 @@
|
||||
|
||||
## constructor
|
||||
|
||||
⊕ **new AccountIndex**(value?: *`AnyNumber`*): [AccountIndex](_accountindex_.accountindex.md)
|
||||
⊕ **new AccountIndex**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [AccountIndex](_accountindex_.accountindex.md)
|
||||
|
||||
*Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)*
|
||||
|
||||
*Defined in [AccountIndex.ts:26](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountIndex.ts#L26)*
|
||||
*Defined in [AccountIndex.ts:26](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountIndex.ts#L26)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type | Default value |
|
||||
| ------ | ------ | ------ |
|
||||
| `Default value` value | `AnyNumber` | new BN(0) |
|
||||
| `Default value` value | [AnyNumber](../modules/_types_.md#anynumber) | new BN(0) |
|
||||
|
||||
**Returns:** [AccountIndex](_accountindex_.accountindex.md)
|
||||
|
||||
@@ -42,7 +42,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L53)*
|
||||
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L53)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -180,7 +180,7 @@ ___
|
||||
|
||||
*Overrides BN.bitLength*
|
||||
|
||||
*Defined in [codec/UInt.ts:49](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L49)*
|
||||
*Defined in [codec/UInt.ts:49](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L49)*
|
||||
|
||||
**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength)
|
||||
|
||||
@@ -1513,7 +1513,7 @@ ___
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
|
||||
|
||||
*Defined in [AccountIndex.ts:86](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountIndex.ts#L86)*
|
||||
*Defined in [AccountIndex.ts:86](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountIndex.ts#L86)*
|
||||
|
||||
**Returns:** `BN`
|
||||
|
||||
@@ -1546,9 +1546,11 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
|
||||
|
||||
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountIndex.ts#L92)*
|
||||
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountIndex.ts#L92)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -1559,9 +1561,11 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)*
|
||||
|
||||
*Defined in [AccountIndex.ts:96](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountIndex.ts#L96)*
|
||||
*Defined in [AccountIndex.ts:96](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountIndex.ts#L96)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -1608,9 +1612,11 @@ ___
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Overrides BN.toString*
|
||||
|
||||
*Defined in [AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountIndex.ts#L100)*
|
||||
*Defined in [AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountIndex.ts#L100)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -1642,9 +1648,11 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
|
||||
|
||||
*Defined in [AccountIndex.ts:106](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountIndex.ts#L106)*
|
||||
*Defined in [AccountIndex.ts:106](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountIndex.ts#L106)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1844,7 +1852,7 @@ ___
|
||||
|
||||
▸ **calcLength**(_value: * `BN` | `number`*): `number`
|
||||
|
||||
*Defined in [AccountIndex.ts:49](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountIndex.ts#L49)*
|
||||
*Defined in [AccountIndex.ts:49](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountIndex.ts#L49)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1859,15 +1867,15 @@ ___
|
||||
|
||||
## `<Static>` decodeAccountIndex
|
||||
|
||||
▸ **decodeAccountIndex**(value: *`AnyNumber`*): `BN` | `Uint8Array` | `number` | `string`
|
||||
▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` | `Uint8Array` | `number` | `string`
|
||||
|
||||
*Defined in [AccountIndex.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountIndex.ts#L33)*
|
||||
*Defined in [AccountIndex.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountIndex.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| value | `AnyNumber` |
|
||||
| value | [AnyNumber](../modules/_types_.md#anynumber) |
|
||||
|
||||
**Returns:** `BN` | `Uint8Array` | `number` | `string`
|
||||
|
||||
@@ -1876,17 +1884,17 @@ ___
|
||||
|
||||
## `<Static>` decodeUInt
|
||||
|
||||
▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string`
|
||||
▸ **decodeUInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string`
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
|
||||
|
||||
*Defined in [codec/UInt.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L33)*
|
||||
*Defined in [codec/UInt.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| value | `AnyNumber` |
|
||||
| value | [AnyNumber](../modules/_types_.md#anynumber) |
|
||||
| bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) |
|
||||
|
||||
**Returns:** `string`
|
||||
@@ -1984,7 +1992,7 @@ ___
|
||||
|
||||
▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`]
|
||||
|
||||
*Defined in [AccountIndex.ts:63](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountIndex.ts#L63)*
|
||||
*Defined in [AccountIndex.ts:63](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountIndex.ts#L63)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -2022,7 +2030,7 @@ ___
|
||||
|
||||
▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array`
|
||||
|
||||
*Defined in [AccountIndex.ts:77](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountIndex.ts#L77)*
|
||||
*Defined in [AccountIndex.ts:77](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountIndex.ts#L77)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
|
||||
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
|
||||
|
||||
*Defined in [Address.ts:22](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Address.ts#L22)*
|
||||
*Defined in [Address.ts:22](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Address.ts#L22)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -36,7 +36,7 @@ ___
|
||||
|
||||
getencodedLength(): `number`
|
||||
|
||||
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Address.ts#L67)*
|
||||
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Address.ts#L67)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -47,7 +47,7 @@ ___
|
||||
|
||||
getrawLength(): `number`
|
||||
|
||||
*Defined in [Address.ts:61](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Address.ts#L61)*
|
||||
*Defined in [Address.ts:61](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Address.ts#L61)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -61,7 +61,7 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Defined in [Address.ts:78](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Address.ts#L78)*
|
||||
*Defined in [Address.ts:78](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Address.ts#L78)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Defined in [Address.ts:82](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Address.ts#L82)*
|
||||
*Defined in [Address.ts:82](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Address.ts#L82)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -83,7 +83,7 @@ ___
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
*Defined in [Address.ts:86](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Address.ts#L86)*
|
||||
*Defined in [Address.ts:86](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Address.ts#L86)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Address.ts#L90)*
|
||||
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Address.ts#L90)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -111,7 +111,7 @@ ___
|
||||
|
||||
▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md)
|
||||
|
||||
*Defined in [Address.ts:29](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Address.ts#L29)*
|
||||
*Defined in [Address.ts:29](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Address.ts#L29)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
# Implements
|
||||
|
||||
* `Codec`
|
||||
* [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
# Indexable
|
||||
|
||||
@@ -21,19 +21,19 @@
|
||||
|
||||
## constructor
|
||||
|
||||
⊕ **new AuthorityId**(value?: *`AnyU8a`*): [AuthorityId](_authorityid_.authorityid.md)
|
||||
⊕ **new AuthorityId**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [AuthorityId](_authorityid_.authorityid.md)
|
||||
|
||||
*Inherited from [AccountId](_accountid_.accountid.md).[constructor](_accountid_.accountid.md#constructor)*
|
||||
|
||||
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
|
||||
|
||||
*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountId.ts#L15)*
|
||||
*Defined in [AccountId.ts:15](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountId.ts#L15)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type | Default value |
|
||||
| ------ | ------ | ------ |
|
||||
| `Default value` value | `AnyU8a` | new Uint8Array() |
|
||||
| `Default value` value | [AnyU8a](../modules/_types_.md#anyu8a) | new Uint8Array() |
|
||||
|
||||
**Returns:** [AuthorityId](_authorityid_.authorityid.md)
|
||||
|
||||
@@ -128,7 +128,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/U8a.ts:28](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L28)*
|
||||
*Defined in [codec/U8a.ts:28](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L28)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -157,7 +157,7 @@ ___
|
||||
|
||||
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
|
||||
|
||||
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8aFixed.ts#L32)*
|
||||
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8aFixed.ts#L32)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -681,7 +681,7 @@ ___
|
||||
|
||||
*Overrides Uint8Array.subarray*
|
||||
|
||||
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L34)*
|
||||
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L34)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -699,9 +699,11 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
|
||||
|
||||
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L38)*
|
||||
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L38)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -712,11 +714,13 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Inherited from [AccountId](_accountid_.accountid.md).[toJSON](_accountid_.accountid.md#tojson)*
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
|
||||
|
||||
*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountId.ts#L39)*
|
||||
*Defined in [AccountId.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountId.ts#L39)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -742,11 +746,13 @@ ___
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Inherited from [AccountId](_accountid_.accountid.md).[toString](_accountid_.accountid.md#tostring)*
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
|
||||
|
||||
*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountId.ts#L43)*
|
||||
*Defined in [AccountId.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountId.ts#L43)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -757,9 +763,11 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
|
||||
|
||||
*Defined in [codec/U8a.ts:46](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L46)*
|
||||
*Defined in [codec/U8a.ts:46](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L46)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -793,7 +801,7 @@ ___
|
||||
|
||||
*Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)*
|
||||
|
||||
*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/AccountId.ts#L23)*
|
||||
*Defined in [AccountId.ts:23](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/AccountId.ts#L23)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
# Implements
|
||||
|
||||
* `Codec`
|
||||
* [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -16,19 +16,19 @@
|
||||
|
||||
## constructor
|
||||
|
||||
⊕ **new Balance**(value?: *`AnyNumber`*): [Balance](_balance_.balance.md)
|
||||
⊕ **new Balance**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [Balance](_balance_.balance.md)
|
||||
|
||||
*Inherited from [U128](_u128_.u128.md).[constructor](_u128_.u128.md#constructor)*
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
|
||||
|
||||
*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/U128.ts#L9)*
|
||||
*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/U128.ts#L9)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Optional` value | `AnyNumber` |
|
||||
| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) |
|
||||
|
||||
**Returns:** [Balance](_balance_.balance.md)
|
||||
|
||||
@@ -44,7 +44,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L53)*
|
||||
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L53)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -182,7 +182,7 @@ ___
|
||||
|
||||
*Overrides BN.bitLength*
|
||||
|
||||
*Defined in [codec/UInt.ts:49](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L49)*
|
||||
*Defined in [codec/UInt.ts:49](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L49)*
|
||||
|
||||
**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength)
|
||||
|
||||
@@ -1515,7 +1515,7 @@ ___
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
|
||||
|
||||
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L71)*
|
||||
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L71)*
|
||||
|
||||
**Returns:** `BN`
|
||||
|
||||
@@ -1548,9 +1548,11 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
|
||||
|
||||
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L57)*
|
||||
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L57)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -1561,11 +1563,13 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)*
|
||||
|
||||
*Overrides BN.toJSON*
|
||||
|
||||
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L61)*
|
||||
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L61)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -1655,9 +1659,11 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
|
||||
|
||||
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L67)*
|
||||
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L67)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1855,17 +1861,17 @@ ___
|
||||
|
||||
## `<Static>` decodeUInt
|
||||
|
||||
▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string`
|
||||
▸ **decodeUInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string`
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
|
||||
|
||||
*Defined in [codec/UInt.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L33)*
|
||||
*Defined in [codec/UInt.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| value | `AnyNumber` |
|
||||
| value | [AnyNumber](../modules/_types_.md#anynumber) |
|
||||
| bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) |
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
|
||||
# Type parameters
|
||||
#### S : `ConstructorDef`
|
||||
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
|
||||
#### T : `object`
|
||||
#### V : `object`
|
||||
#### E : `object`
|
||||
@@ -13,7 +13,7 @@
|
||||
|
||||
# Implements
|
||||
|
||||
* `Codec`
|
||||
* [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
|
||||
|
||||
*Defined in [Bft.ts:19](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bft.ts#L19)*
|
||||
*Defined in [Bft.ts:19](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bft.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -72,7 +72,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
|
||||
|
||||
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L118)*
|
||||
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L118)*
|
||||
|
||||
**Returns:** `E`
|
||||
|
||||
@@ -83,7 +83,7 @@ ___
|
||||
|
||||
getauthorityId(): [AuthorityId](_authorityid_.authorityid.md)
|
||||
|
||||
*Defined in [Bft.ts:27](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bft.ts#L27)*
|
||||
*Defined in [Bft.ts:27](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bft.ts#L27)*
|
||||
|
||||
**Returns:** [AuthorityId](_authorityid_.authorityid.md)
|
||||
|
||||
@@ -96,7 +96,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L122)*
|
||||
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L122)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
getsignature(): [Signature](_signature_.signature.md)
|
||||
|
||||
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bft.ts#L31)*
|
||||
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bft.ts#L31)*
|
||||
|
||||
**Returns:** [Signature](_signature_.signature.md)
|
||||
|
||||
@@ -119,7 +119,7 @@ ___
|
||||
|
||||
## __@iterator
|
||||
|
||||
▸ **__@iterator**(): `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
*Inherited from Map.[Symbol.iterator]*
|
||||
|
||||
@@ -127,7 +127,7 @@ ___
|
||||
|
||||
Returns an iterable of entries in the map.
|
||||
|
||||
**Returns:** `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
___
|
||||
<a id="clear"></a>
|
||||
@@ -166,7 +166,7 @@ ___
|
||||
|
||||
## entries
|
||||
|
||||
▸ **entries**(): `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
*Inherited from Map.entries*
|
||||
|
||||
@@ -174,7 +174,7 @@ ___
|
||||
|
||||
Returns an iterable of key, value pairs for every entry in the map.
|
||||
|
||||
**Returns:** `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
___
|
||||
<a id="foreach"></a>
|
||||
@@ -201,7 +201,7 @@ ___
|
||||
|
||||
## get
|
||||
|
||||
▸ **get**(key: *`keyof S`*): `Codec` | `undefined`
|
||||
▸ **get**(key: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) | `undefined`
|
||||
|
||||
*Inherited from Map.get*
|
||||
|
||||
@@ -213,18 +213,18 @@ ___
|
||||
| ------ | ------ |
|
||||
| key | `keyof S` |
|
||||
|
||||
**Returns:** `Codec` | `undefined`
|
||||
**Returns:** [Codec](../interfaces/_types_.codec.md) | `undefined`
|
||||
|
||||
___
|
||||
<a id="getatindex"></a>
|
||||
|
||||
## getAtIndex
|
||||
|
||||
▸ **getAtIndex**(index: *`number`*): `Codec`
|
||||
▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
|
||||
|
||||
*Defined in [codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L128)*
|
||||
*Defined in [codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L128)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -232,7 +232,7 @@ ___
|
||||
| ------ | ------ |
|
||||
| index | `number` |
|
||||
|
||||
**Returns:** `Codec`
|
||||
**Returns:** [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
___
|
||||
<a id="has"></a>
|
||||
@@ -273,7 +273,7 @@ ___
|
||||
|
||||
## set
|
||||
|
||||
▸ **set**(key: *`keyof S`*, value: *`Codec`*): `this`
|
||||
▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this`
|
||||
|
||||
*Inherited from Map.set*
|
||||
|
||||
@@ -284,7 +284,7 @@ ___
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| key | `keyof S` |
|
||||
| value | `Codec` |
|
||||
| value | [Codec](../interfaces/_types_.codec.md) |
|
||||
|
||||
**Returns:** `this`
|
||||
|
||||
@@ -293,13 +293,13 @@ ___
|
||||
|
||||
## toArray
|
||||
|
||||
▸ **toArray**(): `Array`<`Codec`>
|
||||
▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
|
||||
|
||||
*Defined in [codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L132)*
|
||||
*Defined in [codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L132)*
|
||||
|
||||
**Returns:** `Array`<`Codec`>
|
||||
**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
___
|
||||
<a id="tohex"></a>
|
||||
@@ -308,9 +308,11 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
|
||||
|
||||
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L136)*
|
||||
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L136)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -321,11 +323,13 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
|
||||
|
||||
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:27](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Tuple.ts#L27)*
|
||||
*Defined in [codec/Tuple.ts:27](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Tuple.ts#L27)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -336,9 +340,11 @@ ___
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
|
||||
|
||||
*Defined in [codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L151)*
|
||||
*Defined in [codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L151)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -349,9 +355,11 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
|
||||
|
||||
*Defined in [codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L155)*
|
||||
*Defined in [codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L155)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -366,7 +374,7 @@ ___
|
||||
|
||||
## values
|
||||
|
||||
▸ **values**(): `IterableIterator`<`Codec`>
|
||||
▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
*Inherited from Map.values*
|
||||
|
||||
@@ -374,31 +382,31 @@ ___
|
||||
|
||||
Returns an iterable of values in the map
|
||||
|
||||
**Returns:** `IterableIterator`<`Codec`>
|
||||
**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
___
|
||||
<a id="with"></a>
|
||||
|
||||
## `<Static>` with
|
||||
|
||||
▸ **with**<`S`>(Types: *`S`*): `Constructor`<[Tuple](_codec_tuple_.tuple.md)<`S`>>
|
||||
▸ **with**<`S`>(Types: *`S`*): [Constructor](../modules/_types_.md#constructor)<[Tuple](_codec_tuple_.tuple.md)<`S`>>
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
|
||||
|
||||
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:17](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Tuple.ts#L17)*
|
||||
*Defined in [codec/Tuple.ts:17](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Tuple.ts#L17)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
#### S : `ConstructorDef`
|
||||
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| Types | `S` |
|
||||
|
||||
**Returns:** `Constructor`<[Tuple](_codec_tuple_.tuple.md)<`S`>>
|
||||
**Returns:** [Constructor](../modules/_types_.md#constructor)<[Tuple](_codec_tuple_.tuple.md)<`S`>>
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
|
||||
# Type parameters
|
||||
#### S : `ConstructorDef`
|
||||
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
|
||||
#### T : `object`
|
||||
#### V : `object`
|
||||
#### E : `object`
|
||||
@@ -13,7 +13,7 @@
|
||||
|
||||
# Implements
|
||||
|
||||
* `Codec`
|
||||
* [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
|
||||
|
||||
*Defined in [Bft.ts:43](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bft.ts#L43)*
|
||||
*Defined in [Bft.ts:43](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bft.ts#L43)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -72,7 +72,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
|
||||
|
||||
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L118)*
|
||||
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L118)*
|
||||
|
||||
**Returns:** `E`
|
||||
|
||||
@@ -85,7 +85,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L122)*
|
||||
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L122)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
gethash(): [Hash](_hash_.hash.md)
|
||||
|
||||
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bft.ts#L51)*
|
||||
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bft.ts#L51)*
|
||||
|
||||
**Returns:** [Hash](_hash_.hash.md)
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
getsignature(): [Signature](_signature_.signature.md)
|
||||
|
||||
*Defined in [Bft.ts:55](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bft.ts#L55)*
|
||||
*Defined in [Bft.ts:55](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bft.ts#L55)*
|
||||
|
||||
**Returns:** [Signature](_signature_.signature.md)
|
||||
|
||||
@@ -119,7 +119,7 @@ ___
|
||||
|
||||
## __@iterator
|
||||
|
||||
▸ **__@iterator**(): `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
*Inherited from Map.[Symbol.iterator]*
|
||||
|
||||
@@ -127,7 +127,7 @@ ___
|
||||
|
||||
Returns an iterable of entries in the map.
|
||||
|
||||
**Returns:** `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
___
|
||||
<a id="clear"></a>
|
||||
@@ -166,7 +166,7 @@ ___
|
||||
|
||||
## entries
|
||||
|
||||
▸ **entries**(): `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
*Inherited from Map.entries*
|
||||
|
||||
@@ -174,7 +174,7 @@ ___
|
||||
|
||||
Returns an iterable of key, value pairs for every entry in the map.
|
||||
|
||||
**Returns:** `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
___
|
||||
<a id="foreach"></a>
|
||||
@@ -201,7 +201,7 @@ ___
|
||||
|
||||
## get
|
||||
|
||||
▸ **get**(key: *`keyof S`*): `Codec` | `undefined`
|
||||
▸ **get**(key: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) | `undefined`
|
||||
|
||||
*Inherited from Map.get*
|
||||
|
||||
@@ -213,18 +213,18 @@ ___
|
||||
| ------ | ------ |
|
||||
| key | `keyof S` |
|
||||
|
||||
**Returns:** `Codec` | `undefined`
|
||||
**Returns:** [Codec](../interfaces/_types_.codec.md) | `undefined`
|
||||
|
||||
___
|
||||
<a id="getatindex"></a>
|
||||
|
||||
## getAtIndex
|
||||
|
||||
▸ **getAtIndex**(index: *`number`*): `Codec`
|
||||
▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
|
||||
|
||||
*Defined in [codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L128)*
|
||||
*Defined in [codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L128)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -232,7 +232,7 @@ ___
|
||||
| ------ | ------ |
|
||||
| index | `number` |
|
||||
|
||||
**Returns:** `Codec`
|
||||
**Returns:** [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
___
|
||||
<a id="has"></a>
|
||||
@@ -273,7 +273,7 @@ ___
|
||||
|
||||
## set
|
||||
|
||||
▸ **set**(key: *`keyof S`*, value: *`Codec`*): `this`
|
||||
▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this`
|
||||
|
||||
*Inherited from Map.set*
|
||||
|
||||
@@ -284,7 +284,7 @@ ___
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| key | `keyof S` |
|
||||
| value | `Codec` |
|
||||
| value | [Codec](../interfaces/_types_.codec.md) |
|
||||
|
||||
**Returns:** `this`
|
||||
|
||||
@@ -293,13 +293,13 @@ ___
|
||||
|
||||
## toArray
|
||||
|
||||
▸ **toArray**(): `Array`<`Codec`>
|
||||
▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
|
||||
|
||||
*Defined in [codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L132)*
|
||||
*Defined in [codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L132)*
|
||||
|
||||
**Returns:** `Array`<`Codec`>
|
||||
**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
___
|
||||
<a id="tohex"></a>
|
||||
@@ -308,9 +308,11 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
|
||||
|
||||
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L136)*
|
||||
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L136)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -321,11 +323,13 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
|
||||
|
||||
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:27](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Tuple.ts#L27)*
|
||||
*Defined in [codec/Tuple.ts:27](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Tuple.ts#L27)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -336,9 +340,11 @@ ___
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
|
||||
|
||||
*Defined in [codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L151)*
|
||||
*Defined in [codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L151)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -349,9 +355,11 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
|
||||
|
||||
*Defined in [codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L155)*
|
||||
*Defined in [codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L155)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -366,7 +374,7 @@ ___
|
||||
|
||||
## values
|
||||
|
||||
▸ **values**(): `IterableIterator`<`Codec`>
|
||||
▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
*Inherited from Map.values*
|
||||
|
||||
@@ -374,31 +382,31 @@ ___
|
||||
|
||||
Returns an iterable of values in the map
|
||||
|
||||
**Returns:** `IterableIterator`<`Codec`>
|
||||
**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
___
|
||||
<a id="with"></a>
|
||||
|
||||
## `<Static>` with
|
||||
|
||||
▸ **with**<`S`>(Types: *`S`*): `Constructor`<[Tuple](_codec_tuple_.tuple.md)<`S`>>
|
||||
▸ **with**<`S`>(Types: *`S`*): [Constructor](../modules/_types_.md#constructor)<[Tuple](_codec_tuple_.tuple.md)<`S`>>
|
||||
|
||||
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
|
||||
|
||||
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
|
||||
|
||||
*Defined in [codec/Tuple.ts:17](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Tuple.ts#L17)*
|
||||
*Defined in [codec/Tuple.ts:17](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Tuple.ts#L17)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
#### S : `ConstructorDef`
|
||||
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| Types | `S` |
|
||||
|
||||
**Returns:** `Constructor`<[Tuple](_codec_tuple_.tuple.md)<`S`>>
|
||||
**Returns:** [Constructor](../modules/_types_.md#constructor)<[Tuple](_codec_tuple_.tuple.md)<`S`>>
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
|
||||
# Type parameters
|
||||
#### S : `ConstructorDef`
|
||||
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
|
||||
#### T : `object`
|
||||
#### V : `object`
|
||||
#### E : `object`
|
||||
@@ -13,7 +13,7 @@
|
||||
|
||||
# Implements
|
||||
|
||||
* `Codec`
|
||||
* [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
|
||||
|
||||
*Defined in [Block.ts:20](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Block.ts#L20)*
|
||||
*Defined in [Block.ts:20](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Block.ts#L20)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -72,7 +72,7 @@ getType(): `E`
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
|
||||
|
||||
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L118)*
|
||||
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L118)*
|
||||
|
||||
**Returns:** `E`
|
||||
|
||||
@@ -85,7 +85,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L122)*
|
||||
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L122)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md)
|
||||
|
||||
*Defined in [Block.ts:28](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Block.ts#L28)*
|
||||
*Defined in [Block.ts:28](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Block.ts#L28)*
|
||||
|
||||
**Returns:** [Extrinsics](_extrinsics_.extrinsics.md)
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
gethash(): [Hash](_hash_.hash.md)
|
||||
|
||||
*Defined in [Block.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Block.ts#L33)*
|
||||
*Defined in [Block.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Block.ts#L33)*
|
||||
|
||||
**Returns:** [Hash](_hash_.hash.md)
|
||||
|
||||
@@ -118,7 +118,7 @@ ___
|
||||
|
||||
getheader(): [Header](_header_.header.md)
|
||||
|
||||
*Defined in [Block.ts:39](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Block.ts#L39)*
|
||||
*Defined in [Block.ts:39](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Block.ts#L39)*
|
||||
|
||||
**Returns:** [Header](_header_.header.md)
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
## __@iterator
|
||||
|
||||
▸ **__@iterator**(): `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
*Inherited from Map.[Symbol.iterator]*
|
||||
|
||||
@@ -138,7 +138,7 @@ ___
|
||||
|
||||
Returns an iterable of entries in the map.
|
||||
|
||||
**Returns:** `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
___
|
||||
<a id="clear"></a>
|
||||
@@ -177,7 +177,7 @@ ___
|
||||
|
||||
## entries
|
||||
|
||||
▸ **entries**(): `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
*Inherited from Map.entries*
|
||||
|
||||
@@ -185,7 +185,7 @@ ___
|
||||
|
||||
Returns an iterable of key, value pairs for every entry in the map.
|
||||
|
||||
**Returns:** `IterableIterator`<[`keyof S`, `Codec`]>
|
||||
**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]>
|
||||
|
||||
___
|
||||
<a id="foreach"></a>
|
||||
@@ -212,7 +212,7 @@ ___
|
||||
|
||||
## get
|
||||
|
||||
▸ **get**(key: *`keyof S`*): `Codec` | `undefined`
|
||||
▸ **get**(key: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) | `undefined`
|
||||
|
||||
*Inherited from Map.get*
|
||||
|
||||
@@ -224,18 +224,18 @@ ___
|
||||
| ------ | ------ |
|
||||
| key | `keyof S` |
|
||||
|
||||
**Returns:** `Codec` | `undefined`
|
||||
**Returns:** [Codec](../interfaces/_types_.codec.md) | `undefined`
|
||||
|
||||
___
|
||||
<a id="getatindex"></a>
|
||||
|
||||
## getAtIndex
|
||||
|
||||
▸ **getAtIndex**(index: *`number`*): `Codec`
|
||||
▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
|
||||
|
||||
*Defined in [codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L128)*
|
||||
*Defined in [codec/Struct.ts:128](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L128)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -243,7 +243,7 @@ ___
|
||||
| ------ | ------ |
|
||||
| index | `number` |
|
||||
|
||||
**Returns:** `Codec`
|
||||
**Returns:** [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
___
|
||||
<a id="has"></a>
|
||||
@@ -284,7 +284,7 @@ ___
|
||||
|
||||
## set
|
||||
|
||||
▸ **set**(key: *`keyof S`*, value: *`Codec`*): `this`
|
||||
▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this`
|
||||
|
||||
*Inherited from Map.set*
|
||||
|
||||
@@ -295,7 +295,7 @@ ___
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| key | `keyof S` |
|
||||
| value | `Codec` |
|
||||
| value | [Codec](../interfaces/_types_.codec.md) |
|
||||
|
||||
**Returns:** `this`
|
||||
|
||||
@@ -304,13 +304,13 @@ ___
|
||||
|
||||
## toArray
|
||||
|
||||
▸ **toArray**(): `Array`<`Codec`>
|
||||
▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
|
||||
|
||||
*Defined in [codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L132)*
|
||||
*Defined in [codec/Struct.ts:132](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L132)*
|
||||
|
||||
**Returns:** `Array`<`Codec`>
|
||||
**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
___
|
||||
<a id="tohex"></a>
|
||||
@@ -319,9 +319,11 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
|
||||
|
||||
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L136)*
|
||||
*Defined in [codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L136)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -332,9 +334,11 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
|
||||
|
||||
*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L140)*
|
||||
*Defined in [codec/Struct.ts:140](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L140)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -345,9 +349,11 @@ ___
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
|
||||
|
||||
*Defined in [codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L151)*
|
||||
*Defined in [codec/Struct.ts:151](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L151)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -358,9 +364,11 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
|
||||
|
||||
*Defined in [codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L155)*
|
||||
*Defined in [codec/Struct.ts:155](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L155)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -375,7 +383,7 @@ ___
|
||||
|
||||
## values
|
||||
|
||||
▸ **values**(): `IterableIterator`<`Codec`>
|
||||
▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
*Inherited from Map.values*
|
||||
|
||||
@@ -383,29 +391,29 @@ ___
|
||||
|
||||
Returns an iterable of values in the map
|
||||
|
||||
**Returns:** `IterableIterator`<`Codec`>
|
||||
**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)>
|
||||
|
||||
___
|
||||
<a id="with"></a>
|
||||
|
||||
## `<Static>` with
|
||||
|
||||
▸ **with**<`S`>(Types: *`S`*): `Constructor`<[Struct](_codec_struct_.struct.md)<`S`>>
|
||||
▸ **with**<`S`>(Types: *`S`*): [Constructor](../modules/_types_.md#constructor)<[Struct](_codec_struct_.struct.md)<`S`>>
|
||||
|
||||
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
|
||||
|
||||
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Struct.ts#L108)*
|
||||
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Struct.ts#L108)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
#### S : `ConstructorDef`
|
||||
#### S : [ConstructorDef](../modules/_types_.md#constructordef)
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| Types | `S` |
|
||||
|
||||
**Returns:** `Constructor`<[Struct](_codec_struct_.struct.md)<`S`>>
|
||||
**Returns:** [Constructor](../modules/_types_.md#constructor)<[Struct](_codec_struct_.struct.md)<`S`>>
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
# Implements
|
||||
|
||||
* `Codec`
|
||||
* [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -16,19 +16,19 @@
|
||||
|
||||
## constructor
|
||||
|
||||
⊕ **new BlockNumber**(value?: *`AnyNumber`*): [BlockNumber](_blocknumber_.blocknumber.md)
|
||||
⊕ **new BlockNumber**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [BlockNumber](_blocknumber_.blocknumber.md)
|
||||
|
||||
*Inherited from [U64](_u64_.u64.md).[constructor](_u64_.u64.md#constructor)*
|
||||
|
||||
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
|
||||
|
||||
*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/U64.ts#L9)*
|
||||
*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/U64.ts#L9)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Optional` value | `AnyNumber` |
|
||||
| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) |
|
||||
|
||||
**Returns:** [BlockNumber](_blocknumber_.blocknumber.md)
|
||||
|
||||
@@ -44,7 +44,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[encodedLength](_codec_uint_.uint.md#encodedlength)*
|
||||
|
||||
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L53)*
|
||||
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L53)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -182,7 +182,7 @@ ___
|
||||
|
||||
*Overrides BN.bitLength*
|
||||
|
||||
*Defined in [codec/UInt.ts:49](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L49)*
|
||||
*Defined in [codec/UInt.ts:49](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L49)*
|
||||
|
||||
**Returns:** [UIntBitLength](../modules/_codec_uint_.md#uintbitlength)
|
||||
|
||||
@@ -1515,7 +1515,7 @@ ___
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
|
||||
|
||||
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L71)*
|
||||
*Defined in [codec/UInt.ts:71](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L71)*
|
||||
|
||||
**Returns:** `BN`
|
||||
|
||||
@@ -1548,9 +1548,11 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
|
||||
|
||||
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L57)*
|
||||
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L57)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -1561,11 +1563,13 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)*
|
||||
|
||||
*Overrides BN.toJSON*
|
||||
|
||||
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L61)*
|
||||
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L61)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -1655,9 +1659,11 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
|
||||
|
||||
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L67)*
|
||||
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L67)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -1855,17 +1861,17 @@ ___
|
||||
|
||||
## `<Static>` decodeUInt
|
||||
|
||||
▸ **decodeUInt**(value: *`AnyNumber`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string`
|
||||
▸ **decodeUInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `string`
|
||||
|
||||
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
|
||||
|
||||
*Defined in [codec/UInt.ts:33](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/UInt.ts#L33)*
|
||||
*Defined in [codec/UInt.ts:33](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/UInt.ts#L33)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| value | `AnyNumber` |
|
||||
| value | [AnyNumber](../modules/_types_.md#anynumber) |
|
||||
| bitLength | [UIntBitLength](../modules/_codec_uint_.md#uintbitlength) |
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
# Implements
|
||||
|
||||
* `Codec`
|
||||
* [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
# Constructors
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
⊕ **new Bool**(value?: * [Bool](_bool_.bool.md) | `Boolean` | `Uint8Array` | `boolean` | `number`*): [Bool](_bool_.bool.md)
|
||||
|
||||
*Defined in [Bool.ts:9](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bool.ts#L9)*
|
||||
*Defined in [Bool.ts:9](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bool.ts#L9)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -50,7 +50,7 @@ ___
|
||||
|
||||
getencodedLength(): `number`
|
||||
|
||||
*Defined in [Bool.ts:26](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bool.ts#L26)*
|
||||
*Defined in [Bool.ts:26](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bool.ts#L26)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -64,7 +64,9 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Defined in [Bool.ts:34](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bool.ts#L34)*
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Defined in [Bool.ts:34](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bool.ts#L34)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -75,7 +77,9 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Defined in [Bool.ts:30](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bool.ts#L30)*
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Defined in [Bool.ts:30](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bool.ts#L30)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -86,7 +90,9 @@ ___
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bool.ts#L42)*
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bool.ts#L42)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -97,7 +103,9 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Defined in [Bool.ts:38](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bool.ts#L38)*
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
|
||||
|
||||
*Defined in [Bool.ts:38](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bool.ts#L38)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
|
||||
# Implements
|
||||
|
||||
* `Codec`
|
||||
* [Codec](../interfaces/_types_.codec.md)
|
||||
|
||||
# Indexable
|
||||
|
||||
@@ -25,17 +25,17 @@
|
||||
|
||||
## constructor
|
||||
|
||||
⊕ **new Bytes**(value: *`AnyU8a`*): [Bytes](_bytes_.bytes.md)
|
||||
⊕ **new Bytes**(value: *[AnyU8a](../modules/_types_.md#anyu8a)*): [Bytes](_bytes_.bytes.md)
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
|
||||
|
||||
*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bytes.ts#L14)*
|
||||
*Defined in [Bytes.ts:14](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bytes.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| value | `AnyU8a` |
|
||||
| value | [AnyU8a](../modules/_types_.md#anyu8a) |
|
||||
|
||||
**Returns:** [Bytes](_bytes_.bytes.md)
|
||||
|
||||
@@ -130,7 +130,7 @@ getencodedLength(): `number`
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
|
||||
|
||||
*Defined in [Bytes.ts:57](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bytes.ts#L57)*
|
||||
*Defined in [Bytes.ts:57](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bytes.ts#L57)*
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
@@ -670,7 +670,7 @@ ___
|
||||
|
||||
*Overrides Uint8Array.subarray*
|
||||
|
||||
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L34)*
|
||||
*Defined in [codec/U8a.ts:34](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L34)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -688,9 +688,11 @@ ___
|
||||
|
||||
▸ **toHex**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
|
||||
|
||||
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L38)*
|
||||
*Defined in [codec/U8a.ts:38](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L38)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -701,9 +703,11 @@ ___
|
||||
|
||||
▸ **toJSON**(): `any`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
|
||||
|
||||
*Defined in [codec/U8a.ts:42](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L42)*
|
||||
*Defined in [codec/U8a.ts:42](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L42)*
|
||||
|
||||
**Returns:** `any`
|
||||
|
||||
@@ -729,11 +733,13 @@ ___
|
||||
|
||||
▸ **toString**(): `string`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
|
||||
|
||||
*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
|
||||
|
||||
*Overrides Uint8Array.toString*
|
||||
|
||||
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/U8a.ts#L50)*
|
||||
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/U8a.ts#L50)*
|
||||
|
||||
**Returns:** `string`
|
||||
|
||||
@@ -744,9 +750,11 @@ ___
|
||||
|
||||
▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array`
|
||||
|
||||
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
|
||||
|
||||
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
|
||||
|
||||
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/Bytes.ts#L61)*
|
||||
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/Bytes.ts#L61)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ A type extends the Base class, when it holds a value
|
||||
|
||||
⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md)
|
||||
|
||||
*Defined in [codec/Base.ts:9](https://github.com/polkadot-js/api/blob/379e82a/packages/types/src/codec/Base.ts#L9)*
|
||||
*Defined in [codec/Base.ts:9](https://github.com/polkadot-js/api/blob/9092250/packages/types/src/codec/Base.ts#L9)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user