quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[CI Skip] 0.31.26

Browse Source
This commit is contained in:
Travis CI
2018-10-12 19:20:20 +00:00
parent 4748e8c87f
commit 543c2af377
185 changed files with 5574 additions and 2283 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/GLOSSARY.html
+53 -7
View File
@@ -201,11 +201,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="METHODS_RPC.html">
<a href="METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="METHODS_STORAGE.html">
<a href="METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="METHODS_EXTRINSICS.html">
<a href="METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="examples/promise/">
<li class="chapter " data-level="3.1" data-path="examples/promise/">
<a href="examples/promise/">
@@ -219,7 +265,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="examples/promise/01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="examples/promise/01_simple_connect/">
<a href="examples/promise/01_simple_connect/">
@@ -232,7 +278,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="examples/promise/02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="examples/promise/02_listen_to_blocks/">
<a href="examples/promise/02_listen_to_blocks/">
@@ -245,7 +291,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="examples/promise/03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="examples/promise/03_listen_to_balance_change/">
<a href="examples/promise/03_listen_to_balance_change/">
@@ -258,7 +304,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="examples/promise/05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="examples/promise/05_read_storage/">
<a href="examples/promise/05_read_storage/">
@@ -271,7 +317,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="examples/promise/07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="examples/promise/07_transfer_dots/">
<a href="examples/promise/07_transfer_dots/">
@@ -371,7 +417,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-10-12T16:01:07.391Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-10-12T19:16:06.926Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/METHODS_EXTRINSICS.html
+546
View File
@@ -0,0 +1,546 @@
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Extrinsics (runtime) · Polkadot API Book</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-sunlight-highlighter/sunlight.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="examples/promise/" />
<link rel="prev" href="METHODS_STORAGE.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="header">Packages</li>
<li class="chapter " data-level="1.1" data-path="./">
<a href="./">
Introduction
</a>
</li>
<li class="chapter " data-level="1.2" data-path="api/">
<a href="api/">
api
</a>
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="api/classes/_promise_index_.apipromise.html">
<a href="api/classes/_promise_index_.apipromise.html">
ApiPromise
</a>
</li>
<li class="chapter " data-level="1.2.2" data-path="api/classes/_rx_index_.apirx.html">
<a href="api/classes/_rx_index_.apirx.html">
ApiRx
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="rpc-provider/">
<a href="rpc-provider/">
rpc-provider
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="rpc-provider/classes/_http_index_.httpprovider.html">
<a href="rpc-provider/classes/_http_index_.httpprovider.html">
HttpProvider
</a>
</li>
<li class="chapter " data-level="1.3.2" data-path="rpc-provider/classes/_ws_index_.wsprovider.html">
<a href="rpc-provider/classes/_ws_index_.wsprovider.html">
WsProvider
</a>
</li>
</ul>
</li>
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="METHODS_RPC.html">
<a href="METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="METHODS_STORAGE.html">
<a href="METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter active" data-level="2.3" data-path="METHODS_EXTRINSICS.html">
<a href="METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="3.1" data-path="examples/promise/">
<a href="examples/promise/">
ApiPromise
</a>
<ul class="articles">
<li class="chapter " data-level="3.1.1" data-path="examples/promise/01_simple_connect/">
<a href="examples/promise/01_simple_connect/">
Simple connect
</a>
</li>
<li class="chapter " data-level="3.1.2" data-path="examples/promise/02_listen_to_blocks/">
<a href="examples/promise/02_listen_to_blocks/">
Listen to blocks
</a>
</li>
<li class="chapter " data-level="3.1.3" data-path="examples/promise/03_listen_to_balance_change/">
<a href="examples/promise/03_listen_to_balance_change/">
Listen to balance change
</a>
</li>
<li class="chapter " data-level="3.1.4" data-path="examples/promise/05_read_storage/">
<a href="examples/promise/05_read_storage/">
Read chain state
</a>
</li>
<li class="chapter " data-level="3.1.5" data-path="examples/promise/07_transfer_dots/">
<a href="examples/promise/07_transfer_dots/">
Make a transfer
</a>
</li>
</ul>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Extrinsics (runtime)</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h2 id="extrinsics">Extrinsics</h2>
<p><em>The following Extrinsics methods are part of the default Substrate runtime. Since an Extrinsic is a holder of an object that is just an array of bytes to be included, it does not have a return.</em></p>
<hr>
<h3 id="consensus">consensus</h3>
<p>&#x25B8; <strong>reportMisbehavior</strong>(report: <code>MisbehaviorReport</code>)</p>
<p>&#x25B8; <strong>noteOffline</strong>(offline_val_indices: <code>Vec&lt;u32&gt;</code>)</p>
<p>&#x25B8; <strong>remark</strong>(remark: <code>Bytes</code>)</p>
<p>&#x25B8; <strong>setCode</strong>(new: <code>Bytes</code>)</p>
<p>&#x25B8; <strong>setStorage</strong>(items: <code>Vec&lt;KeyValue&gt;</code>)</p>
<hr>
<h3 id="balances">balances</h3>
<p>&#x25B8; <strong>transfer</strong>(dest: <code>Address</code>, value: <code>Balance</code>)</p>
<p>&#x25B8; <strong>setBalance</strong>(who: <code>Address</code>, free: <code>Balance</code>, reserved: <code>Balance</code>)</p>
<hr>
<h3 id="timestamp">timestamp</h3>
<p>&#x25B8; <strong>set</strong>(now: <code>Moment</code>)</p>
<hr>
<h3 id="session">session</h3>
<p>&#x25B8; <strong>setKey</strong>(key: <code>SessionKey</code>)</p>
<p>&#x25B8; <strong>setLength</strong>(new: <code>BlockNumber</code>)</p>
<p>&#x25B8; <strong>forceNewSession</strong>(apply_rewards: <code>bool</code>)</p>
<hr>
<h3 id="staking">staking</h3>
<p>&#x25B8; <strong>stake</strong>()</p>
<p>&#x25B8; <strong>unstake</strong>(intentions_index: <code>u32</code>)</p>
<p>&#x25B8; <strong>nominate</strong>(target: <code>Address</code>)</p>
<p>&#x25B8; <strong>unnominate</strong>(target_index: <code>u32</code>)</p>
<p>&#x25B8; <strong>registerPreferences</strong>(intentions_index: <code>u32</code>, prefs: <code>ValidatorPrefs</code>)</p>
<p>&#x25B8; <strong>setSessionsPerEra</strong>(new: <code>BlockNumber</code>)</p>
<p>&#x25B8; <strong>setBondingDuration</strong>(new: <code>BlockNumber</code>)</p>
<p>&#x25B8; <strong>setValidatorCount</strong>(new: <code>u32</code>)</p>
<p>&#x25B8; <strong>forceNewEra</strong>(apply_rewards: <code>bool</code>)</p>
<p>&#x25B8; <strong>setOfflineSlashGrace</strong>(new: <code>u32</code>)</p>
<hr>
<h3 id="democracy">democracy</h3>
<p>&#x25B8; <strong>propose</strong>(proposal: <code>Proposal</code>, value: <code>Balance</code>)</p>
<p>&#x25B8; <strong>second</strong>(proposal: <code>PropIndex</code>)</p>
<p>&#x25B8; <strong>vote</strong>(ref_index: <code>ReferendumIndex</code>, approve_proposal: <code>bool</code>)</p>
<p>&#x25B8; <strong>startReferendum</strong>(proposal: <code>Proposal</code>, vote_threshold: <code>VoteThreshold</code>)</p>
<p>&#x25B8; <strong>cancelReferendum</strong>(ref_index: <code>ReferendumIndex</code>)</p>
<hr>
<h3 id="council">council</h3>
<p>&#x25B8; <strong>setApprovals</strong>(votes: <code>Vec&lt;bool&gt;</code>, index: <code>VoteIndex</code>)</p>
<p>&#x25B8; <strong>reapInactiveVoter</strong>(reporter_index: <code>u32</code>, who: <code>Address</code>, who_index: <code>u32</code>, assumed_vote_index: <code>VoteIndex</code>)</p>
<p>&#x25B8; <strong>retractVoter</strong>(index: <code>u32</code>)</p>
<p>&#x25B8; <strong>submitCandidacy</strong>(slot: <code>u32</code>)</p>
<p>&#x25B8; <strong>presentWinner</strong>(candidate: <code>Address</code>, total: <code>Balance</code>, index: <code>VoteIndex</code>)</p>
<p>&#x25B8; <strong>setDesiredSeats</strong>(count: <code>u32</code>)</p>
<p>&#x25B8; <strong>removeMember</strong>(who: <code>Address</code>)</p>
<p>&#x25B8; <strong>setPresentationDuration</strong>(count: <code>BlockNumber</code>)</p>
<p>&#x25B8; <strong>setTermDuration</strong>(count: <code>BlockNumber</code>)</p>
<hr>
<h3 id="councilvoting">councilVoting</h3>
<p>&#x25B8; <strong>propose</strong>(proposal: <code>Proposal</code>)</p>
<p>&#x25B8; <strong>vote</strong>(proposal: <code>Hash</code>, approve: <code>bool</code>)</p>
<p>&#x25B8; <strong>veto</strong>(proposal_hash: <code>Hash</code>)</p>
<p>&#x25B8; <strong>setCooloffPeriod</strong>(blocks: <code>BlockNumber</code>)</p>
<p>&#x25B8; <strong>setVotingPeriod</strong>(blocks: <code>BlockNumber</code>)</p>
<hr>
<h3 id="councilmotions">councilMotions</h3>
<p>&#x25B8; <strong>propose</strong>(threshold: <code>u32</code>, proposal: <code>Proposal</code>)</p>
<p>&#x25B8; <strong>vote</strong>(proposal: <code>Hash</code>, index: <code>ProposalIndex</code>, approve: <code>bool</code>)</p>
<hr>
<h3 id="treasury">treasury</h3>
<p>&#x25B8; <strong>proposeSpend</strong>(value: <code>Balance</code>, beneficiary: <code>AccountId</code>)</p>
<p>&#x25B8; <strong>setPot</strong>(new_pot: <code>Balance</code>)</p>
<p>&#x25B8; <strong>configure</strong>(proposal_bond: <code>Permill</code>, proposal_bond_minimum: <code>Balance</code>, spend_period: <code>BlockNumber</code>, burn: <code>Permill</code>)</p>
<p>&#x25B8; <strong>rejectProposal</strong>(roposal_id: <code>ProposalIndex</code>)</p>
<p>&#x25B8; <strong>approveProposal</strong>(proposal_id: <code>ProposalIndex</code>)</p>
<hr>
<h3 id="contract">contract</h3>
<p>&#x25B8; <strong>call</strong>(dest: <code>AccountId</code>, value: <code>Balance</code>, gas_limit: <code>Gas</code>, data: <code>Bytes</code>)</p>
<p>&#x25B8; <strong>create</strong>(value: <code>Balance</code>, gas_limit: <code>Gas</code>, init_code: <code>Bytes</code>, data: <code>Bytes</code>)</p>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="METHODS_STORAGE.html" class="navigation navigation-prev " aria-label="Previous page: Storage chain state (runtime)">
<i class="fa fa-angle-left"></i>
</a>
<a href="examples/promise/" class="navigation navigation-next " aria-label="Next page: ApiPromise">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Extrinsics (runtime)","level":"2.3","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":"Storage chain state (runtime)","level":"2.2","depth":1,"path":"METHODS_STORAGE.md","ref":"METHODS_STORAGE.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_EXTRINSICS.md","mtime":"2018-10-12T19:17:56.501Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-mermaid-gb3/book/plugin.js"></script>
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="gitbook/gitbook-plugin-search/search.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
<script src="gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.min.js"></script>
</body>
</html>
docs/METHODS_EXTRINSICS.md
+133
View File
@@ -0,0 +1,133 @@
## Extrinsics
_The following Extrinsics methods are part of the default Substrate runtime. Since an Extrinsic is a holder of an object that is just an array of bytes to be included, it does not have a return._
___
### consensus
▸ **reportMisbehavior**(report: `MisbehaviorReport`)
▸ **noteOffline**(offline_val_indices: `Vec<u32>`)
▸ **remark**(remark: `Bytes`)
▸ **setCode**(new: `Bytes`)
▸ **setStorage**(items: `Vec<KeyValue>`)
___
### balances
▸ **transfer**(dest: `Address`, value: `Balance`)
▸ **setBalance**(who: `Address`, free: `Balance`, reserved: `Balance`)
___
### timestamp
▸ **set**(now: `Moment`)
___
### session
▸ **setKey**(key: `SessionKey`)
▸ **setLength**(new: `BlockNumber`)
▸ **forceNewSession**(apply_rewards: `bool`)
___
### staking
▸ **stake**()
▸ **unstake**(intentions_index: `u32`)
▸ **nominate**(target: `Address`)
▸ **unnominate**(target_index: `u32`)
▸ **registerPreferences**(intentions_index: `u32`, prefs: `ValidatorPrefs`)
▸ **setSessionsPerEra**(new: `BlockNumber`)
▸ **setBondingDuration**(new: `BlockNumber`)
▸ **setValidatorCount**(new: `u32`)
▸ **forceNewEra**(apply_rewards: `bool`)
▸ **setOfflineSlashGrace**(new: `u32`)
___
### democracy
▸ **propose**(proposal: `Proposal`, value: `Balance`)
▸ **second**(proposal: `PropIndex`)
▸ **vote**(ref_index: `ReferendumIndex`, approve_proposal: `bool`)
▸ **startReferendum**(proposal: `Proposal`, vote_threshold: `VoteThreshold`)
▸ **cancelReferendum**(ref_index: `ReferendumIndex`)
___
### council
▸ **setApprovals**(votes: `Vec<bool>`, index: `VoteIndex`)
▸ **reapInactiveVoter**(reporter_index: `u32`, who: `Address`, who_index: `u32`, assumed_vote_index: `VoteIndex`)
▸ **retractVoter**(index: `u32`)
▸ **submitCandidacy**(slot: `u32`)
▸ **presentWinner**(candidate: `Address`, total: `Balance`, index: `VoteIndex`)
▸ **setDesiredSeats**(count: `u32`)
▸ **removeMember**(who: `Address`)
▸ **setPresentationDuration**(count: `BlockNumber`)
▸ **setTermDuration**(count: `BlockNumber`)
___
### councilVoting
▸ **propose**(proposal: `Proposal`)
▸ **vote**(proposal: `Hash`, approve: `bool`)
▸ **veto**(proposal_hash: `Hash`)
▸ **setCooloffPeriod**(blocks: `BlockNumber`)
▸ **setVotingPeriod**(blocks: `BlockNumber`)
___
### councilMotions
▸ **propose**(threshold: `u32`, proposal: `Proposal`)
▸ **vote**(proposal: `Hash`, index: `ProposalIndex`, approve: `bool`)
___
### treasury
▸ **proposeSpend**(value: `Balance`, beneficiary: `AccountId`)
▸ **setPot**(new_pot: `Balance`)
▸ **configure**(proposal_bond: `Permill`, proposal_bond_minimum: `Balance`, spend_period: `BlockNumber`, burn: `Permill`)
▸ **rejectProposal**(roposal_id: `ProposalIndex`)
▸ **approveProposal**(proposal_id: `ProposalIndex`)
___
### contract
▸ **call**(dest: `AccountId`, value: `Balance`, gas_limit: `Gas`, data: `Bytes`)
▸ **create**(value: `Balance`, gas_limit: `Gas`, init_code: `Bytes`, data: `Bytes`)
docs/METHODS_RPC.html
+579
View File
@@ -0,0 +1,579 @@
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>RPC · Polkadot API Book</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-sunlight-highlighter/sunlight.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="METHODS_STORAGE.html" />
<link rel="prev" href="rpc-provider/classes/_ws_index_.wsprovider.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="header">Packages</li>
<li class="chapter " data-level="1.1" data-path="./">
<a href="./">
Introduction
</a>
</li>
<li class="chapter " data-level="1.2" data-path="api/">
<a href="api/">
api
</a>
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="api/classes/_promise_index_.apipromise.html">
<a href="api/classes/_promise_index_.apipromise.html">
ApiPromise
</a>
</li>
<li class="chapter " data-level="1.2.2" data-path="api/classes/_rx_index_.apirx.html">
<a href="api/classes/_rx_index_.apirx.html">
ApiRx
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="rpc-provider/">
<a href="rpc-provider/">
rpc-provider
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="rpc-provider/classes/_http_index_.httpprovider.html">
<a href="rpc-provider/classes/_http_index_.httpprovider.html">
HttpProvider
</a>
</li>
<li class="chapter " data-level="1.3.2" data-path="rpc-provider/classes/_ws_index_.wsprovider.html">
<a href="rpc-provider/classes/_ws_index_.wsprovider.html">
WsProvider
</a>
</li>
</ul>
</li>
<li class="header">Node Interfaces</li>
<li class="chapter active" data-level="2.1" data-path="METHODS_RPC.html">
<a href="METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="METHODS_STORAGE.html">
<a href="METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="METHODS_EXTRINSICS.html">
<a href="METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="3.1" data-path="examples/promise/">
<a href="examples/promise/">
ApiPromise
</a>
<ul class="articles">
<li class="chapter " data-level="3.1.1" data-path="examples/promise/01_simple_connect/">
<a href="examples/promise/01_simple_connect/">
Simple connect
</a>
</li>
<li class="chapter " data-level="3.1.2" data-path="examples/promise/02_listen_to_blocks/">
<a href="examples/promise/02_listen_to_blocks/">
Listen to blocks
</a>
</li>
<li class="chapter " data-level="3.1.3" data-path="examples/promise/03_listen_to_balance_change/">
<a href="examples/promise/03_listen_to_balance_change/">
Listen to balance change
</a>
</li>
<li class="chapter " data-level="3.1.4" data-path="examples/promise/05_read_storage/">
<a href="examples/promise/05_read_storage/">
Read chain state
</a>
</li>
<li class="chapter " data-level="3.1.5" data-path="examples/promise/07_transfer_dots/">
<a href="examples/promise/07_transfer_dots/">
Make a transfer
</a>
</li>
</ul>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >RPC</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h2 id="json-rpc">JSON-RPC</h2>
<p><em>The following RPC methods are the Remote Calls that are available by default and allow you to interact with the actual node, query, and submit. The RPCs are provided by Substrate itself. The RPCs are never exposed by the runtime.</em></p>
<hr>
<h3 id="author">author</h3>
<p><em>Authoring of network items</em></p>
<p>&#x25B8; <strong>pendingExtrinsics</strong>(): <code>PendingExtrinsics</code></p>
<ul>
<li><strong>summary</strong>: Returns all pending extrinsics, potentially grouped by sender</li>
</ul>
<p>&#x25B8; <strong>submitExtrinsic</strong>(extrinsic: <code>Extrinsic</code>): <code>Hash</code></p>
<ul>
<li><strong>summary</strong>: Submit a fully formatted extrinsic for block inclusion</li>
</ul>
<p>&#x25B8; <strong>submitAndWatchExtrinsic</strong>(extinsic: <code>Extrinsic</code>)<strong>.subscribe</strong>(CALLBACK): <code>ExtrinsicStatus</code></p>
<ul>
<li><strong>summary</strong>: Subscribe and watch an extrinsic until unsubscribed</li>
</ul>
<hr>
<h3 id="chain">chain</h3>
<p><em>Retrieval of chain data</em></p>
<p>&#x25B8; <strong>getBlock</strong>(hash?: <code>Hash</code>): <code>SignedBlock</code></p>
<ul>
<li><strong>summary</strong>: Get header and body of a relay chain block</li>
</ul>
<p>&#x25B8; <strong>getBlockHash</strong>(blockNumber?: <code>BlockNumber</code>): <code>Hash</code></p>
<ul>
<li><strong>summary</strong>: Get the block hash for a specific block</li>
</ul>
<p>&#x25B8; <strong>getHead</strong>(): <code>Hash</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the best headerHash</li>
</ul>
<p>&#x25B8; <strong>getHeader</strong>(hash?: <code>Hash</code>): <code>Header</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the header for a specific block</li>
</ul>
<p>&#x25B8; <strong>getRuntimeVersion</strong>(hash?: <code>Hash</code>): <code>RuntimeVersion</code></p>
<ul>
<li><strong>summary</strong>: Get the runtime version</li>
</ul>
<p>&#x25B8; <strong>subscribeNewHead</strong>()<strong>.subscribe</strong>(CALLBACK): <code>Header</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the best header via subscription</li>
</ul>
<hr>
<h3 id="state">state</h3>
<p><em>Query of state</em></p>
<p>&#x25B8; <strong>call</strong>(method: <code>Text</code>, data: <code>Bytes</code>): <code>Bytes</code></p>
<ul>
<li><strong>summary</strong>: Perform a call to a builtin on the chain</li>
</ul>
<p>&#x25B8; <strong>callAt</strong>(method: <code>Text</code>, data: <code>Bytes</code>, block: <code>Hash</code>): <code>Bytes</code></p>
<ul>
<li><strong>summary</strong>: Perform a call to a builtin on the chain (At block)</li>
</ul>
<p>&#x25B8; <strong>getMetadata</strong>(block?: <code>Hash</code>): <code>Metadata</code></p>
<ul>
<li><strong>summary</strong>: Returns the runtime metadata</li>
</ul>
<p>&#x25B8; <strong>getStorage</strong>(key: <code>StorageKey</code>): <code>StorageData</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the storage for a key</li>
</ul>
<p>&#x25B8; <strong>getStorageAt</strong>(key: <code>Bytes</code>, block: <code>Hash</code>): <code>Bytes</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the storage for a key at a specific block</li>
</ul>
<p>&#x25B8; <strong>getStorageHash</strong>(key: <code>Bytes</code>): <code>Hash</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the storage hash</li>
</ul>
<p>&#x25B8; <strong>getStorageHashAt</strong>(key: <code>Bytes</code>, block: <code>Hash</code>): <code>Hash</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the storage hash at a specific block</li>
</ul>
<p>&#x25B8; <strong>getStorageSize</strong>(key: <code>Bytes</code>): <code>u64</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the storage size</li>
</ul>
<p>&#x25B8; <strong>getStorageSizeAt</strong>(key: <code>Bytes</code>, block: <code>Hash</code>): <code>u64</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the storage size at a specific block</li>
</ul>
<p>&#x25B8; <strong>queryStorage</strong>(keys: <code>Vec&lt;StorageKey&gt;</code>, startBlock: <code>Hash</code>, block?: <code>Hash</code>): <code>Vec&lt;StorageChangeSet&gt;</code></p>
<ul>
<li><strong>summary</strong>: Query historical storage entries (by key) starting from a start block</li>
</ul>
<p>&#x25B8; <strong>subscribeStorage</strong>(keys: <code>Vec&lt;StorageKey&gt;</code>)<strong>.subscribe</strong>(CALLBACK): <code>StorageChangeSet</code></p>
<ul>
<li><strong>summary</strong>: Subscribes to storage changes for the provided keys</li>
</ul>
<hr>
<h3 id="system">system</h3>
<p><em>Methods to retrieve system info</em></p>
<p>&#x25B8; <strong>chain</strong>(): <code>Text</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the chain</li>
</ul>
<p>&#x25B8; <strong>name</strong>(): <code>Text</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the node name</li>
</ul>
<p>&#x25B8; <strong>version</strong>(): <code>Text</code></p>
<ul>
<li><strong>summary</strong>: Retrieves the version of the node</li>
</ul>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="rpc-provider/classes/_ws_index_.wsprovider.html" class="navigation navigation-prev " aria-label="Previous page: WsProvider">
<i class="fa fa-angle-left"></i>
</a>
<a href="METHODS_STORAGE.html" class="navigation navigation-next " aria-label="Next page: Storage chain state (runtime)">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"RPC","level":"2.1","depth":1,"next":{"title":"Storage 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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_RPC.md","mtime":"2018-10-12T19:17:56.501Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-mermaid-gb3/book/plugin.js"></script>
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="gitbook/gitbook-plugin-search/search.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
<script src="gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.min.js"></script>
</body>
</html>
docs/METHODS_RPC.md
+96
View File
@@ -0,0 +1,96 @@
## JSON-RPC
_The following RPC methods are the Remote Calls that are available by default and allow you to interact with the actual node, query, and submit. The RPCs are provided by Substrate itself. The RPCs are never exposed by the runtime._
___
### author
_Authoring of network items_
▸ **pendingExtrinsics**(): `PendingExtrinsics`
- **summary**: Returns all pending extrinsics, potentially grouped by sender
▸ **submitExtrinsic**(extrinsic: `Extrinsic`): `Hash`
- **summary**: Submit a fully formatted extrinsic for block inclusion
▸ **submitAndWatchExtrinsic**(extinsic: `Extrinsic`)**.subscribe**(CALLBACK): `ExtrinsicStatus`
- **summary**: Subscribe and watch an extrinsic until unsubscribed
___
### chain
_Retrieval of chain data_
▸ **getBlock**(hash?: `Hash`): `SignedBlock`
- **summary**: Get header and body of a relay chain block
▸ **getBlockHash**(blockNumber?: `BlockNumber`): `Hash`
- **summary**: Get the block hash for a specific block
▸ **getHead**(): `Hash`
- **summary**: Retrieves the best headerHash
▸ **getHeader**(hash?: `Hash`): `Header`
- **summary**: Retrieves the header for a specific block
▸ **getRuntimeVersion**(hash?: `Hash`): `RuntimeVersion`
- **summary**: Get the runtime version
▸ **subscribeNewHead**()**.subscribe**(CALLBACK): `Header`
- **summary**: Retrieves the best header via subscription
___
### state
_Query of state_
▸ **call**(method: `Text`, data: `Bytes`): `Bytes`
- **summary**: Perform a call to a builtin on the chain
▸ **callAt**(method: `Text`, data: `Bytes`, block: `Hash`): `Bytes`
- **summary**: Perform a call to a builtin on the chain (At block)
▸ **getMetadata**(block?: `Hash`): `Metadata`
- **summary**: Returns the runtime metadata
▸ **getStorage**(key: `StorageKey`): `StorageData`
- **summary**: Retrieves the storage for a key
▸ **getStorageAt**(key: `Bytes`, block: `Hash`): `Bytes`
- **summary**: Retrieves the storage for a key at a specific block
▸ **getStorageHash**(key: `Bytes`): `Hash`
- **summary**: Retrieves the storage hash
▸ **getStorageHashAt**(key: `Bytes`, block: `Hash`): `Hash`
- **summary**: Retrieves the storage hash at a specific block
▸ **getStorageSize**(key: `Bytes`): `u64`
- **summary**: Retrieves the storage size
▸ **getStorageSizeAt**(key: `Bytes`, block: `Hash`): `u64`
- **summary**: Retrieves the storage size at a specific block
▸ **queryStorage**(keys: `Vec<StorageKey>`, startBlock: `Hash`, block?: `Hash`): `Vec<StorageChangeSet>`
- **summary**: Query historical storage entries (by key) starting from a start block
▸ **subscribeStorage**(keys: `Vec<StorageKey>`)**.subscribe**(CALLBACK): `StorageChangeSet`
- **summary**: Subscribes to storage changes for the provided keys
___
### system
_Methods to retrieve system info_
▸ **chain**(): `Text`
- **summary**: Retrieves the chain
▸ **name**(): `Text`
- **summary**: Retrieves the node name
▸ **version**(): `Text`
- **summary**: Retrieves the version of the node
docs/METHODS_STORAGE.html
+887
View File
@@ -0,0 +1,887 @@
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Storage chain state (runtime) · Polkadot API Book</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-sunlight-highlighter/sunlight.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="METHODS_EXTRINSICS.html" />
<link rel="prev" href="METHODS_RPC.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="header">Packages</li>
<li class="chapter " data-level="1.1" data-path="./">
<a href="./">
Introduction
</a>
</li>
<li class="chapter " data-level="1.2" data-path="api/">
<a href="api/">
api
</a>
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="api/classes/_promise_index_.apipromise.html">
<a href="api/classes/_promise_index_.apipromise.html">
ApiPromise
</a>
</li>
<li class="chapter " data-level="1.2.2" data-path="api/classes/_rx_index_.apirx.html">
<a href="api/classes/_rx_index_.apirx.html">
ApiRx
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="rpc-provider/">
<a href="rpc-provider/">
rpc-provider
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="rpc-provider/classes/_http_index_.httpprovider.html">
<a href="rpc-provider/classes/_http_index_.httpprovider.html">
HttpProvider
</a>
</li>
<li class="chapter " data-level="1.3.2" data-path="rpc-provider/classes/_ws_index_.wsprovider.html">
<a href="rpc-provider/classes/_ws_index_.wsprovider.html">
WsProvider
</a>
</li>
</ul>
</li>
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="METHODS_RPC.html">
<a href="METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter active" data-level="2.2" data-path="METHODS_STORAGE.html">
<a href="METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="METHODS_EXTRINSICS.html">
<a href="METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="3.1" data-path="examples/promise/">
<a href="examples/promise/">
ApiPromise
</a>
<ul class="articles">
<li class="chapter " data-level="3.1.1" data-path="examples/promise/01_simple_connect/">
<a href="examples/promise/01_simple_connect/">
Simple connect
</a>
</li>
<li class="chapter " data-level="3.1.2" data-path="examples/promise/02_listen_to_blocks/">
<a href="examples/promise/02_listen_to_blocks/">
Listen to blocks
</a>
</li>
<li class="chapter " data-level="3.1.3" data-path="examples/promise/03_listen_to_balance_change/">
<a href="examples/promise/03_listen_to_balance_change/">
Listen to balance change
</a>
</li>
<li class="chapter " data-level="3.1.4" data-path="examples/promise/05_read_storage/">
<a href="examples/promise/05_read_storage/">
Read chain state
</a>
</li>
<li class="chapter " data-level="3.1.5" data-path="examples/promise/07_transfer_dots/">
<a href="examples/promise/07_transfer_dots/">
Make a transfer
</a>
</li>
</ul>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Storage chain state (runtime)</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h2 id="storage">Storage</h2>
<p><em>The following Storage methods are part of the default Substrate runtime.</em></p>
<hr>
<h3 id="system">system</h3>
<p>&#x25B8; <strong>accountNonce</strong>(<code>AccountId</code>): <code>Index</code></p>
<p>&#x25B8; <strong>extrinsicCount</strong>(): <code>u32</code></p>
<p>&#x25B8; <strong>blockHash</strong>(<code>BlockNumber</code>): <code>Hash</code></p>
<p>&#x25B8; <strong>extrinsicData</strong>(<code>u32</code>): <code>Bytes</code></p>
<p>&#x25B8; <strong>randomSeed</strong>(): <code>Hash</code></p>
<p>&#x25B8; <strong>number</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: The current block number being processed. Set by <code>execute_block</code>.</li>
</ul>
<p>&#x25B8; <strong>parentHash</strong>(): <code>Hash</code></p>
<p>&#x25B8; <strong>extrinsicsRoot</strong>(): <code>Hash</code></p>
<p>&#x25B8; <strong>digest</strong>(): <code>Digest</code></p>
<p>&#x25B8; <strong>events</strong>(): <code>Vec&lt;EventRecord&gt;</code></p>
<hr>
<h3 id="consensus">consensus</h3>
<p>&#x25B8; <strong>originalAuthorities</strong>(): <code>Vec&lt;SessionKey&gt;</code></p>
<hr>
<h3 id="balances">balances</h3>
<p>&#x25B8; <strong>totalIssuance</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: The total amount of stake on the system.</li>
</ul>
<p>&#x25B8; <strong>existentialDeposit</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: The minimum amount allowed to keep an account open.</li>
</ul>
<p>&#x25B8; <strong>reclaimRebate</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: The amount credited to a destination&apos;s account whose index was reclaimed.</li>
</ul>
<p>&#x25B8; <strong>transferFee</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: The fee required to make a transfer.</li>
</ul>
<p>&#x25B8; <strong>creationFee</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: The fee required to create an account. At least as big as ReclaimRebate.</li>
</ul>
<p>&#x25B8; <strong>nextEnumSet</strong>(): <code>AccountIndex</code></p>
<ul>
<li><strong>summary</strong>: The next free enumeration set.</li>
</ul>
<p>&#x25B8; <strong>enumSet</strong>(<code>AccountIndex</code>): <code>Vec&lt;AccountId&gt;</code></p>
<ul>
<li><strong>summary</strong>: The enumeration sets.</li>
</ul>
<p>&#x25B8; <strong>freeBalance</strong>(<code>AccountId</code>): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: The &apos;free&apos; balance of a given account. This is the only balance that matters in terms of most operations on tokens. It is alone used to determine the balance when in the contract execution environment. When this balance falls below the value of <code>ExistentialDeposit</code>, then the &apos;current account&apos; is deleted: specifically <code>FreeBalance</code>. Furthermore, <code>OnFreeBalanceZero</code> callback is invoked, giving a chance to external modules to cleanup data associated with the deleted account. <code>system::AccountNonce</code> is also deleted if <code>ReservedBalance</code> is also zero (it also gets collapsed to zero if it ever becomes less than <code>ExistentialDeposit</code>.</li>
</ul>
<p>&#x25B8; <strong>reservedBalance</strong>(<code>AccountId</code>): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: The amount of the balance of a given account that is externally reserved; this can still get slashed, but gets slashed last of all. This balance is a &apos;reserve&apos; balance that other subsystems use in order to set aside tokens that are still &apos;owned&apos; by the account holder, but which are suspendable. (This is different and wholly unrelated to the <code>Bondage</code> system used in the staking module.) When this balance falls below the value of <code>ExistentialDeposit</code>, then this &apos;reserve account&apos; is deleted: specifically, <code>ReservedBalance</code>. <code>system::AccountNonce</code> is also deleted if <code>FreeBalance</code> is also zero (it also gets collapsed to zero if it ever becomes less than <code>ExistentialDeposit</code>.</li>
</ul>
<p>&#x25B8; <strong>transactionBaseFee</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: The fee to be paid for making a transaction; the base.</li>
</ul>
<p>&#x25B8; <strong>transactionByteFee</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: The fee to be paid for making a transaction; the per-byte portion.</li>
</ul>
<hr>
<h3 id="timestamp">timestamp</h3>
<p>&#x25B8; <strong>now</strong>(): <code>Moment</code></p>
<ul>
<li><strong>summary</strong>: Current time for the current block.</li>
</ul>
<p>&#x25B8; <strong>blockPeriod</strong>(): <code>Moment</code></p>
<ul>
<li><strong>summary</strong>: The minimum (and advised) period between blocks.</li>
</ul>
<p>&#x25B8; <strong>didUpdate</strong>(): <code>bool</code></p>
<ul>
<li><strong>summary</strong>: Did the timestamp get updated in this block?</li>
</ul>
<hr>
<h3 id="session">session</h3>
<p>&#x25B8; <strong>validators</strong>(): <code>Vec&lt;AccountId&gt;</code></p>
<ul>
<li><strong>summary</strong>: The current set of validators.</li>
</ul>
<p>&#x25B8; <strong>sessionLength</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: Current length of the session.</li>
</ul>
<p>&#x25B8; <strong>currentIndex</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: Current index of the session.</li>
</ul>
<p>&#x25B8; <strong>currentStart</strong>(): <code>Moment</code></p>
<ul>
<li><strong>summary</strong>: Timestamp when current session started.</li>
</ul>
<p>&#x25B8; <strong>forcingNewSession</strong>(): <code>bool</code></p>
<ul>
<li><strong>summary</strong>: New session is being forced is this entry exists; in which case, the boolean value is whether the new session should be considered a normal rotation (rewardable) or exceptional (slashable).</li>
</ul>
<p>&#x25B8; <strong>lastLengthChange</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: Block at which the session length last changed.</li>
</ul>
<p>&#x25B8; <strong>nextKeyFor</strong>(<code>AccountId</code>): <code>SessionKey</code></p>
<ul>
<li><strong>summary</strong>: The next key for a given validator.</li>
</ul>
<p>&#x25B8; <strong>nextSessionLength</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: The next session length.</li>
</ul>
<hr>
<h3 id="staking">staking</h3>
<p>&#x25B8; <strong>validatorCount</strong>(): <code>u32</code></p>
<ul>
<li><strong>summary</strong>: The ideal number of staking participants.</li>
</ul>
<p>&#x25B8; <strong>minimumValidatorCount</strong>(): <code>u32</code></p>
<ul>
<li><strong>summary</strong>: Minimum number of staking participants before emergency conditions are imposed.</li>
</ul>
<p>&#x25B8; <strong>sessionsPerEra</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: The length of a staking era in sessions.</li>
</ul>
<p>&#x25B8; <strong>sessionReward</strong>(): <code>Perbill</code></p>
<ul>
<li><strong>summary</strong>: Maximum reward, per validator, that is provided per acceptable session.</li>
</ul>
<p>&#x25B8; <strong>offlineSlash</strong>(): <code>Perbill</code></p>
<ul>
<li><strong>summary</strong>: Slash, per validator that is taken for the first time they are found to be offline.</li>
</ul>
<p>&#x25B8; <strong>offlineSlashGrace</strong>(): <code>u32</code></p>
<ul>
<li><strong>summary</strong>: Number of instances of offline reports before slashing begins for validators.</li>
</ul>
<p>&#x25B8; <strong>bondingDuration</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: The length of the bonding duration in blocks.</li>
</ul>
<p>&#x25B8; <strong>currentEra</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: The current era index.</li>
</ul>
<p>&#x25B8; <strong>validatorPreferences</strong>(<code>AccountId</code>): <code>ValidatorPrefs</code></p>
<ul>
<li><strong>summary</strong>: Preferences that a validator has.</li>
</ul>
<p>&#x25B8; <strong>intentions</strong>(): <code>Vec&lt;AccountId&gt;</code></p>
<ul>
<li><strong>summary</strong>: All the accounts with a desire to stake.</li>
</ul>
<p>&#x25B8; <strong>nominating</strong>(<code>AccountId</code>): <code>AccountId</code></p>
<ul>
<li><strong>summary</strong>: All nominator -&gt; nominee relationships.</li>
</ul>
<p>&#x25B8; <strong>nominatorsFor</strong>(<code>AccountId</code>): <code>Vec&lt;AccountId&gt;</code></p>
<ul>
<li><strong>summary</strong>: Nominators for a particular account.</li>
</ul>
<p>&#x25B8; <strong>currentNominatorsFor</strong>(<code>AccountId</code>): <code>Vec&lt;AccountId&gt;</code></p>
<ul>
<li><strong>summary</strong>: Nominators for a particular account that is in action right now.</li>
</ul>
<p>&#x25B8; <strong>currentSessionReward</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: Maximum reward, per validator, that is provided per acceptable session.</li>
</ul>
<p>&#x25B8; <strong>currentOfflineSlash</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: Slash, per validator that is taken for the first time they are found to be offline.</li>
</ul>
<p>&#x25B8; <strong>nextSessionsPerEra</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: The next value of sessions per era.</li>
</ul>
<p>&#x25B8; <strong>lastEraLengthChange</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: The session index at which the era length last changed.</li>
</ul>
<p>&#x25B8; <strong>stakeRange</strong>(): <code>PairOf</code></p>
<ul>
<li><strong>summary</strong>: The highest and lowest staked validator slashable balances.</li>
</ul>
<p>&#x25B8; <strong>bondage</strong>(<code>AccountId</code>): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: The block at which the <code>who</code>&apos;s funds become entirely liquid.</li>
</ul>
<p>&#x25B8; <strong>slashCount</strong>(<code>AccountId</code>): <code>u32</code></p>
<ul>
<li><strong>summary</strong>: The number of times a given validator has been reported offline. This gets decremented by one each era that passes.</li>
</ul>
<p>&#x25B8; <strong>forcingNewEra</strong>(): <code>()</code></p>
<ul>
<li><strong>summary</strong>: We are forcing a new era.</li>
</ul>
<hr>
<h3 id="democracy">democracy</h3>
<p>&#x25B8; <strong>publicPropCount</strong>(): <code>PropIndex</code></p>
<ul>
<li><strong>summary</strong>: The number of (public) proposals that have been made so far.</li>
</ul>
<p>&#x25B8; <strong>publicProps</strong>(): <code>Vec&lt;(PropIndex, Proposal, AccountId)&gt;</code></p>
<ul>
<li><strong>summary</strong>: The public proposals. Unsorted.</li>
</ul>
<p>&#x25B8; <strong>depositOf</strong>(<code>PropIndex</code>): <code>(Balance, Vec&lt;AccountId&gt;)</code></p>
<ul>
<li><strong>summary</strong>: Those who have locked a deposit.</li>
</ul>
<p>&#x25B8; <strong>launchPeriod</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: How often (in blocks) new public referenda are launched.</li>
</ul>
<p>&#x25B8; <strong>minimumDeposit</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: The minimum amount to be used as a deposit for a public referendum proposal.</li>
</ul>
<p>&#x25B8; <strong>votingPeriod</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: How often (in blocks) to check for new votes.</li>
</ul>
<p>&#x25B8; <strong>referendumCount</strong>(): <code>ReferendumIndex</code></p>
<ul>
<li><strong>summary</strong>: The next free referendum index, aka the number of referendums started so far.</li>
</ul>
<p>&#x25B8; <strong>nextTally</strong>(): <code>ReferendumIndex</code></p>
<ul>
<li><strong>summary</strong>: The next referendum index that should be tallied.</li>
</ul>
<p>&#x25B8; <strong>referendumInfoOf</strong>(<code>ReferendumIndex</code>): <code>(BlockNumber, Proposal, VoteThreshold)</code></p>
<ul>
<li><strong>summary</strong>: Information concerning any given referendum.</li>
</ul>
<p>&#x25B8; <strong>votersFor</strong>(<code>ReferendumIndex</code>): <code>Vec&lt;AccountId&gt;</code></p>
<ul>
<li><strong>summary</strong>: Get the voters for the current proposal.</li>
</ul>
<p>&#x25B8; <strong>voteOf</strong>(<code>(ReferendumIndex, AccountId)</code>): <code>bool</code></p>
<ul>
<li><strong>summary</strong>: Get the vote, if Some, of <code>who</code>.</li>
</ul>
<hr>
<h3 id="council">council</h3>
<p>&#x25B8; <strong>candidacyBond</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: How much should be locked up in order to submit one&apos;s candidacy.</li>
</ul>
<p>&#x25B8; <strong>votingBond</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: How much should be locked up in order to be able to submit votes.</li>
</ul>
<p>&#x25B8; <strong>presentSlashPerVoter</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: The punishment, per voter, if you provide an invalid presentation.</li>
</ul>
<p>&#x25B8; <strong>carryCount</strong>(): <code>u32</code></p>
<ul>
<li><strong>summary</strong>: How many runners-up should have their approvals persist until the next vote.</li>
</ul>
<p>&#x25B8; <strong>presentationDuration</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: How long to give each top candidate to present themselves after the vote ends.</li>
</ul>
<p>&#x25B8; <strong>inactiveGracePeriod</strong>(): <code>VoteIndex</code></p>
<ul>
<li><strong>summary</strong>: How many votes need to go by after a voter&apos;s last vote before they can be reaped if their approvals are moot.</li>
</ul>
<p>&#x25B8; <strong>votingPeriod</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: How often (in blocks) to check for new votes.</li>
</ul>
<p>&#x25B8; <strong>termDuration</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: How long each position is active for.</li>
</ul>
<p>&#x25B8; <strong>desiredSeats</strong>(): <code>u32</code></p>
<ul>
<li><strong>summary</strong>: Number of accounts that should be sitting on the council.</li>
</ul>
<p>&#x25B8; <strong>activeCouncil</strong>(): <code>Vec&lt;(AccountId, BlockNumber)&gt;</code></p>
<ul>
<li><strong>summary</strong>: The current council. When there&apos;s a vote going on, this should still be used for executive matters.</li>
</ul>
<p>&#x25B8; <strong>voteCount</strong>(): <code>VoteIndex</code></p>
<ul>
<li><strong>summary</strong>: The total number of votes that have happened or are in progress.</li>
</ul>
<p>&#x25B8; <strong>approvalsOf</strong>(<code>AccountId</code>): <code>Vec&lt;bool&gt;</code></p>
<ul>
<li><strong>summary</strong>: The last cleared vote index that this voter was last active at.</li>
</ul>
<p>&#x25B8; <strong>registerInfoOf</strong>(<code>AccountId</code>): <code>(VoteIndex, u32)</code></p>
<ul>
<li><strong>summary</strong>: The vote index and list slot that the candidate <code>who</code> was registered or <code>None</code> if they are not currently registered.</li>
</ul>
<p>&#x25B8; <strong>lastActiveOf</strong>(<code>AccountId</code>): <code>VoteIndex</code></p>
<ul>
<li><strong>summary</strong>: The last cleared vote index that this voter was last active at.</li>
</ul>
<p>&#x25B8; <strong>voters</strong>(): <code>Vec&lt;AccountId&gt;</code></p>
<ul>
<li><strong>summary</strong>: The present voter list.</li>
</ul>
<p>&#x25B8; <strong>candidates</strong>(): <code>Vec&lt;AccountId&gt;</code></p>
<ul>
<li><strong>summary</strong>: The present candidate list.</li>
</ul>
<p>&#x25B8; <strong>candidateCount</strong>(): <code>u32</code></p>
<p>&#x25B8; <strong>nextFinalise</strong>(): <code>(BlockNumber, u32, Vec&lt;AccountId&gt;)</code></p>
<ul>
<li><strong>summary</strong>: The accounts holding the seats that will become free on the next tally.</li>
</ul>
<p>&#x25B8; <strong>snapshotedStakes</strong>(): <code>Vec&lt;Balance&gt;</code></p>
<ul>
<li><strong>summary</strong>: The stakes as they were at the point that the vote ended.</li>
</ul>
<p>&#x25B8; <strong>leaderboard</strong>(): <code>Vec&lt;(Balance, AccountId)&gt;</code></p>
<ul>
<li><strong>summary</strong>: Get the leaderboard if we;re in the presentation phase.</li>
</ul>
<hr>
<h3 id="councilvoting">councilVoting</h3>
<p>&#x25B8; <strong>cooloffPeriod</strong>(): <code>BlockNumber</code></p>
<p>&#x25B8; <strong>votingPeriod</strong>(): <code>BlockNumber</code></p>
<p>&#x25B8; <strong>proposals</strong>(): <code>Vec&lt;(BlockNumber, Hash)&gt;</code></p>
<p>&#x25B8; <strong>proposalOf</strong>(<code>Hash</code>): <code>Proposal</code></p>
<p>&#x25B8; <strong>proposalVoters</strong>(<code>Hash</code>): <code>Vec&lt;AccountId&gt;</code></p>
<p>&#x25B8; <strong>councilVoteOf</strong>(<code>(Hash, AccountId)</code>): <code>bool</code></p>
<p>&#x25B8; <strong>vetoedProposal</strong>(<code>Hash</code>): <code>(BlockNumber, Vec&lt;AccountId&gt;)</code></p>
<hr>
<h3 id="councilmotions">councilMotions</h3>
<p>&#x25B8; <strong>proposals</strong>(): <code>Vec&lt;Hash&gt;</code></p>
<ul>
<li><strong>summary</strong>: The (hashes of) the active proposals.</li>
</ul>
<p>&#x25B8; <strong>proposalOf</strong>(<code>Hash</code>): <code>Proposal</code></p>
<ul>
<li><strong>summary</strong>: Actual proposal for a given hash, if it&apos;s current.</li>
</ul>
<p>&#x25B8; <strong>voting</strong>(<code>Hash</code>): <code>(ProposalIndex, u32, Vec&lt;AccountId&gt;, Vec&lt;AccountId&gt;)</code></p>
<ul>
<li><strong>summary</strong>: Votes for a given proposal: (required_yes_votes, yes_voters, no_voters).</li>
</ul>
<p>&#x25B8; <strong>proposalCount</strong>(): <code>u32</code></p>
<ul>
<li><strong>summary</strong>: Proposals so far.</li>
</ul>
<hr>
<h3 id="treasury">treasury</h3>
<p>&#x25B8; <strong>proposalBond</strong>(): <code>Permill</code></p>
<ul>
<li><strong>summary</strong>: Proportion of funds that should be bonded in order to place a proposal. An accepted proposal gets these back. A rejected proposal doesn&apos;t.</li>
</ul>
<p>&#x25B8; <strong>proposalBondMinimum</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: Minimum amount of funds that should be placed in a deposit for making a proposal.</li>
</ul>
<p>&#x25B8; <strong>spendPeriod</strong>(): <code>BlockNumber</code></p>
<ul>
<li><strong>summary</strong>: Period between successive spends.</li>
</ul>
<p>&#x25B8; <strong>burn</strong>(): <code>Permill</code></p>
<ul>
<li><strong>summary</strong>: Percentage of spare funds (if any) that are burnt per spend period.</li>
</ul>
<p>&#x25B8; <strong>pot</strong>(): <code>Balance</code></p>
<ul>
<li><strong>summary</strong>: Total funds available to this module for spending.</li>
</ul>
<p>&#x25B8; <strong>proposalCount</strong>(): <code>ProposalIndex</code></p>
<ul>
<li><strong>summary</strong>: Number of proposals that have been made.</li>
</ul>
<p>&#x25B8; <strong>proposals</strong>(<code>ProposalIndex</code>): <code>Proposal</code></p>
<ul>
<li><strong>summary</strong>: Proposals that have been made.</li>
</ul>
<p>&#x25B8; <strong>approvals</strong>(): <code>Vec&lt;ProposalIndex&gt;</code></p>
<ul>
<li><strong>summary</strong>: Proposal indices that have been approved but not yet awarded.</li>
</ul>
<hr>
<h3 id="substrate">substrate</h3>
<p><em>These are keys that are always available to the runtime implementation</em></p>
<p>&#x25B8; <strong>code</strong>(): <code>Bytes</code></p>
<ul>
<li><strong>summary</strong>: Wasm code of the runtime.</li>
</ul>
<p>&#x25B8; <strong>heapPages</strong>(): <code>u64</code></p>
<ul>
<li><strong>summary</strong>: Number of wasm linear memory pages required for execution of the runtime.</li>
</ul>
<p>&#x25B8; <strong>authorityCount</strong>(): <code>u32</code></p>
<ul>
<li><strong>summary</strong>: Number of authorities.</li>
</ul>
<p>&#x25B8; <strong>authorityPrefix</strong>(): <code>u32</code></p>
<ul>
<li><strong>summary</strong>: Prefix under which authorities are storied.</li>
</ul>
<p>&#x25B8; <strong>extrinsicIndex</strong>(): <code>u32</code></p>
<ul>
<li><strong>summary</strong>: Current extrinsic index (u32) is stored under this key.</li>
</ul>
<p>&#x25B8; <strong>changesTrieConfig</strong>(): <code>u32</code></p>
<ul>
<li><strong>summary</strong>: Changes trie configuration is stored under this key.</li>
</ul>
<hr>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="METHODS_RPC.html" class="navigation navigation-prev " aria-label="Previous page: RPC">
<i class="fa fa-angle-left"></i>
</a>
<a href="METHODS_EXTRINSICS.html" class="navigation navigation-next " aria-label="Next page: Extrinsics (runtime)">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Storage 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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"METHODS_STORAGE.md","mtime":"2018-10-12T19:17:56.569Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-mermaid-gb3/book/plugin.js"></script>
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="gitbook/gitbook-plugin-search/search.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
<script src="gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.min.js"></script>
</body>
</html>
docs/METHODS_STORAGE.md
+355
View File
@@ -0,0 +1,355 @@
## Storage
_The following Storage methods are part of the default Substrate runtime._
___
### system
▸ **accountNonce**(`AccountId`): `Index`
▸ **extrinsicCount**(): `u32`
▸ **blockHash**(`BlockNumber`): `Hash`
▸ **extrinsicData**(`u32`): `Bytes`
▸ **randomSeed**(): `Hash`
▸ **number**(): `BlockNumber`
- **summary**: The current block number being processed. Set by `execute_block`.
▸ **parentHash**(): `Hash`
▸ **extrinsicsRoot**(): `Hash`
▸ **digest**(): `Digest`
▸ **events**(): `Vec<EventRecord>`
___
### consensus
▸ **originalAuthorities**(): `Vec<SessionKey>`
___
### balances
▸ **totalIssuance**(): `Balance`
- **summary**: The total amount of stake on the system.
▸ **existentialDeposit**(): `Balance`
- **summary**: The minimum amount allowed to keep an account open.
▸ **reclaimRebate**(): `Balance`
- **summary**: The amount credited to a destination's account whose index was reclaimed.
▸ **transferFee**(): `Balance`
- **summary**: The fee required to make a transfer.
▸ **creationFee**(): `Balance`
- **summary**: The fee required to create an account. At least as big as ReclaimRebate.
▸ **nextEnumSet**(): `AccountIndex`
- **summary**: The next free enumeration set.
▸ **enumSet**(`AccountIndex`): `Vec<AccountId>`
- **summary**: The enumeration sets.
▸ **freeBalance**(`AccountId`): `Balance`
- **summary**: The 'free' balance of a given account. This is the only balance that matters in terms of most operations on tokens. It is alone used to determine the balance when in the contract execution environment. When this balance falls below the value of `ExistentialDeposit`, then the 'current account' is deleted: specifically `FreeBalance`. Furthermore, `OnFreeBalanceZero` callback is invoked, giving a chance to external modules to cleanup data associated with the deleted account. `system::AccountNonce` is also deleted if `ReservedBalance` is also zero (it also gets collapsed to zero if it ever becomes less than `ExistentialDeposit`.
▸ **reservedBalance**(`AccountId`): `Balance`
- **summary**: The amount of the balance of a given account that is externally reserved; this can still get slashed, but gets slashed last of all. This balance is a 'reserve' balance that other subsystems use in order to set aside tokens that are still 'owned' by the account holder, but which are suspendable. (This is different and wholly unrelated to the `Bondage` system used in the staking module.) When this balance falls below the value of `ExistentialDeposit`, then this 'reserve account' is deleted: specifically, `ReservedBalance`. `system::AccountNonce` is also deleted if `FreeBalance` is also zero (it also gets collapsed to zero if it ever becomes less than `ExistentialDeposit`.
▸ **transactionBaseFee**(): `Balance`
- **summary**: The fee to be paid for making a transaction; the base.
▸ **transactionByteFee**(): `Balance`
- **summary**: The fee to be paid for making a transaction; the per-byte portion.
___
### timestamp
▸ **now**(): `Moment`
- **summary**: Current time for the current block.
▸ **blockPeriod**(): `Moment`
- **summary**: The minimum (and advised) period between blocks.
▸ **didUpdate**(): `bool`
- **summary**: Did the timestamp get updated in this block?
___
### session
▸ **validators**(): `Vec<AccountId>`
- **summary**: The current set of validators.
▸ **sessionLength**(): `BlockNumber`
- **summary**: Current length of the session.
▸ **currentIndex**(): `BlockNumber`
- **summary**: Current index of the session.
▸ **currentStart**(): `Moment`
- **summary**: Timestamp when current session started.
▸ **forcingNewSession**(): `bool`
- **summary**: New session is being forced is this entry exists; in which case, the boolean value is whether the new session should be considered a normal rotation (rewardable) or exceptional (slashable).
▸ **lastLengthChange**(): `BlockNumber`
- **summary**: Block at which the session length last changed.
▸ **nextKeyFor**(`AccountId`): `SessionKey`
- **summary**: The next key for a given validator.
▸ **nextSessionLength**(): `BlockNumber`
- **summary**: The next session length.
___
### staking
▸ **validatorCount**(): `u32`
- **summary**: The ideal number of staking participants.
▸ **minimumValidatorCount**(): `u32`
- **summary**: Minimum number of staking participants before emergency conditions are imposed.
▸ **sessionsPerEra**(): `BlockNumber`
- **summary**: The length of a staking era in sessions.
▸ **sessionReward**(): `Perbill`
- **summary**: Maximum reward, per validator, that is provided per acceptable session.
▸ **offlineSlash**(): `Perbill`
- **summary**: Slash, per validator that is taken for the first time they are found to be offline.
▸ **offlineSlashGrace**(): `u32`
- **summary**: Number of instances of offline reports before slashing begins for validators.
▸ **bondingDuration**(): `BlockNumber`
- **summary**: The length of the bonding duration in blocks.
▸ **currentEra**(): `BlockNumber`
- **summary**: The current era index.
▸ **validatorPreferences**(`AccountId`): `ValidatorPrefs`
- **summary**: Preferences that a validator has.
▸ **intentions**(): `Vec<AccountId>`
- **summary**: All the accounts with a desire to stake.
▸ **nominating**(`AccountId`): `AccountId`
- **summary**: All nominator -> nominee relationships.
▸ **nominatorsFor**(`AccountId`): `Vec<AccountId>`
- **summary**: Nominators for a particular account.
▸ **currentNominatorsFor**(`AccountId`): `Vec<AccountId>`
- **summary**: Nominators for a particular account that is in action right now.
▸ **currentSessionReward**(): `Balance`
- **summary**: Maximum reward, per validator, that is provided per acceptable session.
▸ **currentOfflineSlash**(): `Balance`
- **summary**: Slash, per validator that is taken for the first time they are found to be offline.
▸ **nextSessionsPerEra**(): `BlockNumber`
- **summary**: The next value of sessions per era.
▸ **lastEraLengthChange**(): `BlockNumber`
- **summary**: The session index at which the era length last changed.
▸ **stakeRange**(): `PairOf`
- **summary**: The highest and lowest staked validator slashable balances.
▸ **bondage**(`AccountId`): `BlockNumber`
- **summary**: The block at which the `who`'s funds become entirely liquid.
▸ **slashCount**(`AccountId`): `u32`
- **summary**: The number of times a given validator has been reported offline. This gets decremented by one each era that passes.
▸ **forcingNewEra**(): `()`
- **summary**: We are forcing a new era.
___
### democracy
▸ **publicPropCount**(): `PropIndex`
- **summary**: The number of (public) proposals that have been made so far.
▸ **publicProps**(): `Vec<(PropIndex, Proposal, AccountId)>`
- **summary**: The public proposals. Unsorted.
▸ **depositOf**(`PropIndex`): `(Balance, Vec<AccountId>)`
- **summary**: Those who have locked a deposit.
▸ **launchPeriod**(): `BlockNumber`
- **summary**: How often (in blocks) new public referenda are launched.
▸ **minimumDeposit**(): `Balance`
- **summary**: The minimum amount to be used as a deposit for a public referendum proposal.
▸ **votingPeriod**(): `BlockNumber`
- **summary**: How often (in blocks) to check for new votes.
▸ **referendumCount**(): `ReferendumIndex`
- **summary**: The next free referendum index, aka the number of referendums started so far.
▸ **nextTally**(): `ReferendumIndex`
- **summary**: The next referendum index that should be tallied.
▸ **referendumInfoOf**(`ReferendumIndex`): `(BlockNumber, Proposal, VoteThreshold)`
- **summary**: Information concerning any given referendum.
▸ **votersFor**(`ReferendumIndex`): `Vec<AccountId>`
- **summary**: Get the voters for the current proposal.
▸ **voteOf**(`(ReferendumIndex, AccountId)`): `bool`
- **summary**: Get the vote, if Some, of `who`.
___
### council
▸ **candidacyBond**(): `Balance`
- **summary**: How much should be locked up in order to submit one's candidacy.
▸ **votingBond**(): `Balance`
- **summary**: How much should be locked up in order to be able to submit votes.
▸ **presentSlashPerVoter**(): `Balance`
- **summary**: The punishment, per voter, if you provide an invalid presentation.
▸ **carryCount**(): `u32`
- **summary**: How many runners-up should have their approvals persist until the next vote.
▸ **presentationDuration**(): `BlockNumber`
- **summary**: How long to give each top candidate to present themselves after the vote ends.
▸ **inactiveGracePeriod**(): `VoteIndex`
- **summary**: How many votes need to go by after a voter's last vote before they can be reaped if their approvals are moot.
▸ **votingPeriod**(): `BlockNumber`
- **summary**: How often (in blocks) to check for new votes.
▸ **termDuration**(): `BlockNumber`
- **summary**: How long each position is active for.
▸ **desiredSeats**(): `u32`
- **summary**: Number of accounts that should be sitting on the council.
▸ **activeCouncil**(): `Vec<(AccountId, BlockNumber)>`
- **summary**: The current council. When there's a vote going on, this should still be used for executive matters.
▸ **voteCount**(): `VoteIndex`
- **summary**: The total number of votes that have happened or are in progress.
▸ **approvalsOf**(`AccountId`): `Vec<bool>`
- **summary**: The last cleared vote index that this voter was last active at.
▸ **registerInfoOf**(`AccountId`): `(VoteIndex, u32)`
- **summary**: The vote index and list slot that the candidate `who` was registered or `None` if they are not currently registered.
▸ **lastActiveOf**(`AccountId`): `VoteIndex`
- **summary**: The last cleared vote index that this voter was last active at.
▸ **voters**(): `Vec<AccountId>`
- **summary**: The present voter list.
▸ **candidates**(): `Vec<AccountId>`
- **summary**: The present candidate list.
▸ **candidateCount**(): `u32`
▸ **nextFinalise**(): `(BlockNumber, u32, Vec<AccountId>)`
- **summary**: The accounts holding the seats that will become free on the next tally.
▸ **snapshotedStakes**(): `Vec<Balance>`
- **summary**: The stakes as they were at the point that the vote ended.
▸ **leaderboard**(): `Vec<(Balance, AccountId)>`
- **summary**: Get the leaderboard if we;re in the presentation phase.
___
### councilVoting
▸ **cooloffPeriod**(): `BlockNumber`
▸ **votingPeriod**(): `BlockNumber`
▸ **proposals**(): `Vec<(BlockNumber, Hash)>`
▸ **proposalOf**(`Hash`): `Proposal`
▸ **proposalVoters**(`Hash`): `Vec<AccountId>`
▸ **councilVoteOf**(`(Hash, AccountId)`): `bool`
▸ **vetoedProposal**(`Hash`): `(BlockNumber, Vec<AccountId>)`
___
### councilMotions
▸ **proposals**(): `Vec<Hash>`
- **summary**: The (hashes of) the active proposals.
▸ **proposalOf**(`Hash`): `Proposal`
- **summary**: Actual proposal for a given hash, if it's current.
▸ **voting**(`Hash`): `(ProposalIndex, u32, Vec<AccountId>, Vec<AccountId>)`
- **summary**: Votes for a given proposal: (required_yes_votes, yes_voters, no_voters).
▸ **proposalCount**(): `u32`
- **summary**: Proposals so far.
___
### treasury
▸ **proposalBond**(): `Permill`
- **summary**: Proportion of funds that should be bonded in order to place a proposal. An accepted proposal gets these back. A rejected proposal doesn't.
▸ **proposalBondMinimum**(): `Balance`
- **summary**: Minimum amount of funds that should be placed in a deposit for making a proposal.
▸ **spendPeriod**(): `BlockNumber`
- **summary**: Period between successive spends.
▸ **burn**(): `Permill`
- **summary**: Percentage of spare funds (if any) that are burnt per spend period.
▸ **pot**(): `Balance`
- **summary**: Total funds available to this module for spending.
▸ **proposalCount**(): `ProposalIndex`
- **summary**: Number of proposals that have been made.
▸ **proposals**(`ProposalIndex`): `Proposal`
- **summary**: Proposals that have been made.
▸ **approvals**(): `Vec<ProposalIndex>`
- **summary**: Proposal indices that have been approved but not yet awarded.
---
### substrate
_These are keys that are always available to the runtime implementation_
▸ **code**(): `Bytes`
- **summary**: Wasm code of the runtime.
▸ **heapPages**(): `u64`
- **summary**: Number of wasm linear memory pages required for execution of the runtime.
▸ **authorityCount**(): `u32`
- **summary**: Number of authorities.
▸ **authorityPrefix**(): `u32`
- **summary**: Prefix under which authorities are storied.
▸ **extrinsicIndex**(): `u32`
- **summary**: Current extrinsic index (u32) is stored under this key.
▸ **changesTrieConfig**(): `u32`
- **summary**: Changes trie configuration is stored under this key.
---
docs/api-observable/classes/_base_.apibase.md
+9 -9
View File
@@ -14,7 +14,7 @@
⊕ **new ApiBase**(api: *`RpcRxInterface`*): [ApiBase](_base_.apibase.md)
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L32)*
**Parameters:**
@@ -34,7 +34,7 @@ ___
**● whenReady**: *`Observable`<`boolean`>*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L32)*
___
<a id="extrinsics"></a>
@@ -43,7 +43,7 @@ ___
**● extrinsics**: *`Extrinsics`* = extrinsicsStatic
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L40)*
___
<a id="storage"></a>
@@ -52,7 +52,7 @@ ___
**● storage**: *`Storage`* = storageStatic
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L41)*
___
@@ -64,7 +64,7 @@ ___
getgenesisHash(): `Hash`
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L85)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L85)*
**Returns:** `Hash`
@@ -78,7 +78,7 @@ ___
▸ **isConnected**(): `Observable`<`boolean`>
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L89)*
**Returns:** `Observable`<`boolean`>
@@ -89,7 +89,7 @@ ___
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L93)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L93)*
**Type parameters:**
@@ -110,7 +110,7 @@ ___
▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` &#124; `undefined`>
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L106)*
**Type parameters:**
@@ -131,7 +131,7 @@ ___
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]>*): `Observable`<`T`>
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L119)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L119)*
**Type parameters:**
docs/api-observable/classes/_calls_.apicalls.md
+45 -45
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L32)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L32)*
___
<a id="extrinsics"></a>
@@ -51,7 +51,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L40)*
___
<a id="storage"></a>
@@ -62,7 +62,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L41)*
___
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L85)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L85)*
**Returns:** `Hash`
@@ -92,7 +92,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L21)*
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L21)*
**Parameters:**
@@ -111,7 +111,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L25)*
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L25)*
**Parameters:**
@@ -130,7 +130,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L29)*
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L29)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
▸ **bestNumber**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -160,7 +160,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L37)*
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L37)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -173,7 +173,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L33)*
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L33)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -184,7 +184,7 @@ ___
▸ **chain**(): `Observable`< `Text` &#124; `undefined`>
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L25)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -197,7 +197,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L41)*
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L41)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -210,7 +210,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L45)*
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L45)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -223,7 +223,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L115)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -236,7 +236,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -249,7 +249,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L119)*
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L119)*
**Returns:** `Observable`<`RxFees`>
@@ -260,7 +260,7 @@ ___
▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` &#124; `undefined`>
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L29)*
**Parameters:**
@@ -279,7 +279,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L89)*
**Returns:** `Observable`<`boolean`>
@@ -292,7 +292,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L49)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L49)*
**Parameters:**
@@ -311,7 +311,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L62)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -324,7 +324,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L93)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L93)*
**Type parameters:**
@@ -347,7 +347,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L106)*
**Type parameters:**
@@ -370,7 +370,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L119)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L119)*
**Type parameters:**
@@ -392,7 +392,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L81)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L81)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -405,7 +405,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L85)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L85)*
**Parameters:**
@@ -424,7 +424,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -444,7 +444,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L102)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L102)*
**Parameters:**
@@ -463,7 +463,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L152)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L152)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -476,7 +476,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L156)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L156)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -489,7 +489,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L160)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L160)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -502,7 +502,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L164)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L164)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -515,7 +515,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -528,7 +528,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -541,7 +541,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L172)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L172)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -554,7 +554,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L168)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L168)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -567,7 +567,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L185)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L185)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -580,7 +580,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L211)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L211)*
**Parameters:**
@@ -599,7 +599,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L198)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L198)*
**Parameters:**
@@ -616,7 +616,7 @@ ___
▸ **submitAndWatchExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `ExtrinsicStatus` &#124; `undefined`>
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L51)*
**Parameters:**
@@ -633,7 +633,7 @@ ___
▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` &#124; `undefined`>
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -650,7 +650,7 @@ ___
▸ **subscribeNewHead**(): `Observable`< `Header` &#124; `undefined`>
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -661,7 +661,7 @@ ___
▸ **systemName**(): `Observable`< `Text` &#124; `undefined`>
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -672,7 +672,7 @@ ___
▸ **systemVersion**(): `Observable`< `Text` &#124; `undefined`>
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -685,7 +685,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L215)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L215)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
docs/api-observable/classes/_classes_.rxproposal.md
+17 -17
View File
@@ -21,7 +21,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L9)*
*Defined in [classes.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L9)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
*Inherited from Base.raw*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -57,7 +57,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -68,7 +68,7 @@ ___
getaddress(): `AccountId`
*Defined in [classes.ts:18](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L18)*
*Defined in [classes.ts:18](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L18)*
**Returns:** `AccountId`
@@ -79,7 +79,7 @@ ___
getid(): `PropIndex`
*Defined in [classes.ts:22](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L22)*
*Defined in [classes.ts:22](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L22)*
**Returns:** `PropIndex`
@@ -90,7 +90,7 @@ ___
getproposal(): `Proposal`
*Defined in [classes.ts:26](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L26)*
*Defined in [classes.ts:26](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L26)*
**Returns:** `Proposal`
@@ -108,7 +108,7 @@ ___
*Overrides Base.byteLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L112)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L112)*
**Returns:** `number`
@@ -123,7 +123,7 @@ ___
*Overrides Base.fromJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/codec/Struct.ts#L118)*
**Parameters:**
@@ -144,7 +144,7 @@ ___
*Overrides Base.fromU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L138)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L138)*
**Parameters:**
@@ -163,7 +163,7 @@ ___
*Inherited from Struct.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -182,7 +182,7 @@ ___
*Inherited from Struct.keys*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -197,7 +197,7 @@ ___
*Overrides Base.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L152)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L152)*
**Returns:** `any`
@@ -212,7 +212,7 @@ ___
*Overrides Base.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -227,7 +227,7 @@ ___
*Overrides Base.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L167)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L167)*
**Parameters:**
@@ -246,7 +246,7 @@ ___
*Inherited from Struct.values*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<`Base`>
@@ -259,7 +259,7 @@ ___
*Inherited from Struct.decodeStruct*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -284,7 +284,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L98)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/api-observable/classes/_classes_.rxproposaldeposits.md
+16 -16
View File
@@ -21,7 +21,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:31](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L31)*
*Defined in [classes.ts:31](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L31)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
*Inherited from Base.raw*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -57,7 +57,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -68,7 +68,7 @@ ___
getaddresses(): `Vector`<`AccountId`>
*Defined in [classes.ts:39](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L39)*
*Defined in [classes.ts:39](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L39)*
**Returns:** `Vector`<`AccountId`>
@@ -79,7 +79,7 @@ ___
getbalance(): `Balance`
*Defined in [classes.ts:43](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L43)*
*Defined in [classes.ts:43](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L43)*
**Returns:** `Balance`
@@ -97,7 +97,7 @@ ___
*Overrides Base.byteLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L112)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L112)*
**Returns:** `number`
@@ -112,7 +112,7 @@ ___
*Overrides Base.fromJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/codec/Struct.ts#L118)*
**Parameters:**
@@ -133,7 +133,7 @@ ___
*Overrides Base.fromU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L138)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L138)*
**Parameters:**
@@ -152,7 +152,7 @@ ___
*Inherited from Struct.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -171,7 +171,7 @@ ___
*Inherited from Struct.keys*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -186,7 +186,7 @@ ___
*Overrides Base.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L152)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L152)*
**Returns:** `any`
@@ -201,7 +201,7 @@ ___
*Overrides Base.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -216,7 +216,7 @@ ___
*Overrides Base.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L167)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L167)*
**Parameters:**
@@ -235,7 +235,7 @@ ___
*Inherited from Struct.values*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<`Base`>
@@ -248,7 +248,7 @@ ___
*Inherited from Struct.decodeStruct*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -273,7 +273,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L98)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/api-observable/classes/_classes_.rxreferendum.md
+18 -18
View File
@@ -21,7 +21,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L48)*
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L48)*
**Parameters:**
@@ -44,7 +44,7 @@ ___
*Inherited from Base.raw*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -58,7 +58,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -69,7 +69,7 @@ ___
getblockNumber(): `BlockNumber`
*Defined in [classes.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L58)*
*Defined in [classes.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L58)*
**Returns:** `BlockNumber`
@@ -80,7 +80,7 @@ ___
getid(): `ReferendumIndex`
*Defined in [classes.ts:62](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L62)*
*Defined in [classes.ts:62](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L62)*
**Returns:** `ReferendumIndex`
@@ -91,7 +91,7 @@ ___
getproposal(): `Proposal`
*Defined in [classes.ts:66](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L66)*
*Defined in [classes.ts:66](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L66)*
**Returns:** `Proposal`
@@ -102,7 +102,7 @@ ___
getvoteThreshold(): `VoteThreshold`
*Defined in [classes.ts:70](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/classes.ts#L70)*
*Defined in [classes.ts:70](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/classes.ts#L70)*
**Returns:** `VoteThreshold`
@@ -120,7 +120,7 @@ ___
*Overrides Base.byteLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L112)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L112)*
**Returns:** `number`
@@ -135,7 +135,7 @@ ___
*Overrides Base.fromJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/codec/Struct.ts#L118)*
**Parameters:**
@@ -156,7 +156,7 @@ ___
*Overrides Base.fromU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L138)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L138)*
**Parameters:**
@@ -175,7 +175,7 @@ ___
*Inherited from Struct.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -194,7 +194,7 @@ ___
*Inherited from Struct.keys*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -209,7 +209,7 @@ ___
*Overrides Base.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L152)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L152)*
**Returns:** `any`
@@ -224,7 +224,7 @@ ___
*Overrides Base.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -239,7 +239,7 @@ ___
*Overrides Base.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L167)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L167)*
**Parameters:**
@@ -258,7 +258,7 @@ ___
*Inherited from Struct.values*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<`Base`>
@@ -271,7 +271,7 @@ ___
*Inherited from Struct.decodeStruct*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -296,7 +296,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L98)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/api-observable/classes/_combined_.apicombined.md
+65 -65
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L32)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L32)*
___
<a id="extrinsics"></a>
@@ -51,7 +51,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L40)*
___
<a id="storage"></a>
@@ -62,7 +62,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L41)*
___
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L85)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L85)*
**Returns:** `Hash`
@@ -92,7 +92,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L21)*
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L21)*
**Parameters:**
@@ -111,7 +111,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L25)*
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L25)*
**Parameters:**
@@ -130,7 +130,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L29)*
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L29)*
**Parameters:**
@@ -149,7 +149,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -162,7 +162,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L37)*
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L37)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -175,7 +175,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L33)*
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L33)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -188,7 +188,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L25)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -201,7 +201,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L41)*
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L41)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -214,7 +214,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L45)*
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L45)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -225,7 +225,7 @@ ___
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`RxReferendumVote`>>
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L42)*
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L42)*
**Parameters:**
@@ -242,7 +242,7 @@ ___
▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Balance`>>
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L87)*
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L87)*
**Parameters:**
@@ -259,7 +259,7 @@ ___
▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Bool`>>
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L103)*
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L103)*
**Parameters:**
@@ -278,7 +278,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L115)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -289,7 +289,7 @@ ___
▸ **eraBlockLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L114)*
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L114)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -300,7 +300,7 @@ ___
▸ **eraBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L129)*
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L129)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -311,7 +311,7 @@ ___
▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L152)*
*Defined in [Combined.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L152)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -324,7 +324,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -337,7 +337,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L119)*
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L119)*
**Returns:** `Observable`<`RxFees`>
@@ -350,7 +350,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L29)*
**Parameters:**
@@ -369,7 +369,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L89)*
**Returns:** `Observable`<`boolean`>
@@ -382,7 +382,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L49)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L49)*
**Parameters:**
@@ -399,7 +399,7 @@ ___
▸ **publicProposalCount**(): `Observable`<`number`>
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L20)*
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L20)*
**Returns:** `Observable`<`number`>
@@ -412,7 +412,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L62)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -425,7 +425,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L93)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L93)*
**Type parameters:**
@@ -448,7 +448,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L106)*
**Type parameters:**
@@ -471,7 +471,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L119)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L119)*
**Type parameters:**
@@ -493,7 +493,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L81)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L81)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -506,7 +506,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L85)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L85)*
**Parameters:**
@@ -525,7 +525,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -545,7 +545,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L102)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L102)*
**Parameters:**
@@ -562,7 +562,7 @@ ___
▸ **referendumVotes**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<`boolean`>
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
@@ -580,7 +580,7 @@ ___
▸ **referendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L58)*
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L58)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
@@ -591,7 +591,7 @@ ___
▸ **referendumsInfo**(referendumIds: *`Array`< `ReferendumIndex` &#124; `BN` &#124; `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L30)*
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L30)*
**Parameters:**
@@ -608,7 +608,7 @@ ___
▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:167](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L167)*
*Defined in [Combined.ts:167](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L167)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -619,7 +619,7 @@ ___
▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:187](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L187)*
*Defined in [Combined.ts:187](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L187)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -630,7 +630,7 @@ ___
▸ **sessionBrokenValue**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:202](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L202)*
*Defined in [Combined.ts:202](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L202)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -643,7 +643,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L152)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L152)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -656,7 +656,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L156)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L156)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -669,7 +669,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L160)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L160)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -682,7 +682,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L164)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L164)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -695,7 +695,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -708,7 +708,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -719,7 +719,7 @@ ___
▸ **sessionTimeExpected**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:221](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L221)*
*Defined in [Combined.ts:221](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L221)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -730,7 +730,7 @@ ___
▸ **sessionTimeRemaining**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:236](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L236)*
*Defined in [Combined.ts:236](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L236)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -743,7 +743,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L172)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L172)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -756,7 +756,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L168)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L168)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -769,7 +769,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L185)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L185)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -782,7 +782,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L211)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L211)*
**Parameters:**
@@ -801,7 +801,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L198)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L198)*
**Parameters:**
@@ -820,7 +820,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L51)*
**Parameters:**
@@ -839,7 +839,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -858,7 +858,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -871,7 +871,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -884,7 +884,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -895,7 +895,7 @@ ___
▸ **validatingBalance**(address: * `AccountId` &#124; `string`*): `Observable`<`RxBalance`>
*Defined in [Combined.ts:251](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L251)*
*Defined in [Combined.ts:251](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L251)*
**Parameters:**
@@ -912,7 +912,7 @@ ___
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<`RxBalanceMap`>
*Defined in [Combined.ts:276](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L276)*
*Defined in [Combined.ts:276](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L276)*
**Parameters:**
@@ -931,7 +931,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L215)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L215)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
@@ -942,7 +942,7 @@ ___
▸ **votingBalance**(_address: * `AccountId` &#124; `string`*): `Observable`<`RxBalance`>
*Defined in [Combined.ts:290](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L290)*
*Defined in [Combined.ts:290](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L290)*
**Parameters:**
@@ -959,7 +959,7 @@ ___
▸ **votingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<`RxBalance`[]>
*Defined in [Combined.ts:324](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L324)*
*Defined in [Combined.ts:324](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L324)*
**Parameters:**
@@ -976,7 +976,7 @@ ___
▸ **votingBalancesNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`any`>
*Defined in [Combined.ts:313](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L313)*
*Defined in [Combined.ts:313](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L313)*
**Parameters:**
docs/api-observable/classes/_index_.api.md
+65 -65
View File
@@ -16,7 +16,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L32)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L32)*
___
<a id="extrinsics"></a>
@@ -49,7 +49,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L40)*
___
<a id="storage"></a>
@@ -60,7 +60,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L41)*
___
@@ -74,7 +74,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L85)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L85)*
**Returns:** `Hash`
@@ -90,7 +90,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L21)*
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L21)*
**Parameters:**
@@ -109,7 +109,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L25)*
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L25)*
**Parameters:**
@@ -128,7 +128,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L29)*
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L29)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -160,7 +160,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L37)*
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L37)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -173,7 +173,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L33)*
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L33)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -186,7 +186,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L25)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -199,7 +199,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L41)*
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L41)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -212,7 +212,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L45)*
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L45)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -225,7 +225,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)*
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L42)*
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L42)*
**Parameters:**
@@ -244,7 +244,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)*
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L87)*
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L87)*
**Parameters:**
@@ -263,7 +263,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)*
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L103)*
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L103)*
**Parameters:**
@@ -282,7 +282,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L115)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -295,7 +295,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)*
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L114)*
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L114)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -308,7 +308,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)*
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L129)*
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L129)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -321,7 +321,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)*
*Defined in [Combined.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L152)*
*Defined in [Combined.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L152)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -334,7 +334,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -347,7 +347,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L119)*
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L119)*
**Returns:** `Observable`<`RxFees`>
@@ -360,7 +360,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L29)*
**Parameters:**
@@ -379,7 +379,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L89)*
**Returns:** `Observable`<`boolean`>
@@ -392,7 +392,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L49)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L49)*
**Parameters:**
@@ -411,7 +411,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[publicProposalCount](_combined_.apicombined.md#publicproposalcount)*
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L20)*
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L20)*
**Returns:** `Observable`<`number`>
@@ -424,7 +424,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L62)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -437,7 +437,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L93)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L93)*
**Type parameters:**
@@ -460,7 +460,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L106)*
**Type parameters:**
@@ -483,7 +483,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L119)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L119)*
**Type parameters:**
@@ -505,7 +505,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L81)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L81)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -518,7 +518,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L85)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L85)*
**Parameters:**
@@ -537,7 +537,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -557,7 +557,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L102)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L102)*
**Parameters:**
@@ -576,7 +576,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumVotes](_combined_.apicombined.md#referendumvotes)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
@@ -596,7 +596,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendums](_combined_.apicombined.md#referendums)*
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L58)*
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L58)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
@@ -609,7 +609,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumsInfo](_combined_.apicombined.md#referendumsinfo)*
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L30)*
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L30)*
**Parameters:**
@@ -628,7 +628,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)*
*Defined in [Combined.ts:167](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L167)*
*Defined in [Combined.ts:167](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L167)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -641,7 +641,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)*
*Defined in [Combined.ts:187](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L187)*
*Defined in [Combined.ts:187](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L187)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -654,7 +654,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)*
*Defined in [Combined.ts:202](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L202)*
*Defined in [Combined.ts:202](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L202)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -667,7 +667,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L152)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L152)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -680,7 +680,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L156)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L156)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -693,7 +693,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L160)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L160)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -706,7 +706,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L164)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L164)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -719,7 +719,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -732,7 +732,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -745,7 +745,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)*
*Defined in [Combined.ts:221](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L221)*
*Defined in [Combined.ts:221](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L221)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -758,7 +758,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)*
*Defined in [Combined.ts:236](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L236)*
*Defined in [Combined.ts:236](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L236)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -771,7 +771,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L172)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L172)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -784,7 +784,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L168)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L168)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -797,7 +797,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L185)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L185)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -810,7 +810,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L211)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L211)*
**Parameters:**
@@ -829,7 +829,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L198)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L198)*
**Parameters:**
@@ -848,7 +848,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L51)*
*Defined in [Calls.ts:51](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L51)*
**Parameters:**
@@ -867,7 +867,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -886,7 +886,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -899,7 +899,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -912,7 +912,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -925,7 +925,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)*
*Defined in [Combined.ts:251](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L251)*
*Defined in [Combined.ts:251](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L251)*
**Parameters:**
@@ -944,7 +944,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)*
*Defined in [Combined.ts:276](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L276)*
*Defined in [Combined.ts:276](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L276)*
**Parameters:**
@@ -963,7 +963,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L215)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L215)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
@@ -976,7 +976,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)*
*Defined in [Combined.ts:290](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L290)*
*Defined in [Combined.ts:290](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L290)*
**Parameters:**
@@ -995,7 +995,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)*
*Defined in [Combined.ts:324](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L324)*
*Defined in [Combined.ts:324](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L324)*
**Parameters:**
@@ -1014,7 +1014,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)*
*Defined in [Combined.ts:313](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Combined.ts#L313)*
*Defined in [Combined.ts:313](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Combined.ts#L313)*
**Parameters:**
docs/api-observable/classes/_queries_.apiqueries.md
+37 -37
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L32)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L32)*
___
<a id="extrinsics"></a>
@@ -51,7 +51,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L40)*
___
<a id="storage"></a>
@@ -62,7 +62,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L41)*
___
@@ -76,7 +76,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L85)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L85)*
**Returns:** `Hash`
@@ -90,7 +90,7 @@ ___
▸ **accountNonce**(address: * `AccountId` &#124; `string`*): `Observable`< `Index` &#124; `undefined`>
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L21)*
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L21)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
▸ **balanceFree**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L25)*
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L25)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
▸ **balanceReserved**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L29)*
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L29)*
**Parameters:**
@@ -141,7 +141,7 @@ ___
▸ **blockNow**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L37)*
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L37)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -152,7 +152,7 @@ ___
▸ **blockPeriod**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L33)*
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L33)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -163,7 +163,7 @@ ___
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L41)*
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L41)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -174,7 +174,7 @@ ___
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L45)*
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L45)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -185,7 +185,7 @@ ___
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L115)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -196,7 +196,7 @@ ___
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -207,7 +207,7 @@ ___
▸ **fees**(): `Observable`<`RxFees`>
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L119)*
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L119)*
**Returns:** `Observable`<`RxFees`>
@@ -220,7 +220,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L89)*
**Returns:** `Observable`<`boolean`>
@@ -231,7 +231,7 @@ ___
▸ **proposalDeposits**(proposalId: * `PropIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L49)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L49)*
**Parameters:**
@@ -248,7 +248,7 @@ ___
▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L62)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -261,7 +261,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L93)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L93)*
**Type parameters:**
@@ -284,7 +284,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L106)*
**Type parameters:**
@@ -307,7 +307,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Base.ts#L119)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Base.ts#L119)*
**Type parameters:**
@@ -327,7 +327,7 @@ ___
▸ **referendumCount**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L81)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L81)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -338,7 +338,7 @@ ___
▸ **referendumInfo**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L85)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L85)*
**Parameters:**
@@ -355,7 +355,7 @@ ___
▸ **referendumVote**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, address: * `AccountId` &#124; `string`*): `Observable`< `Bool` &#124; `undefined`>
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -373,7 +373,7 @@ ___
▸ **referendumVoters**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L102)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L102)*
**Parameters:**
@@ -390,7 +390,7 @@ ___
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L152)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L152)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -401,7 +401,7 @@ ___
▸ **sessionCurrentStart**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L156)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L156)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -412,7 +412,7 @@ ___
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L160)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L160)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -423,7 +423,7 @@ ___
▸ **sessionLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L164)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L164)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -434,7 +434,7 @@ ___
▸ **sessionReward**(): `Observable`< `Perbill` &#124; `undefined`>
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -445,7 +445,7 @@ ___
▸ **sessionRewardCurrent**(): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -456,7 +456,7 @@ ___
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L172)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L172)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -467,7 +467,7 @@ ___
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L168)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L168)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -478,7 +478,7 @@ ___
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L185)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L185)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -489,7 +489,7 @@ ___
▸ **stakingNominating**(address: * `AccountId` &#124; `string`*): `Observable`< `AccountId` &#124; `undefined`>
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L211)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L211)*
**Parameters:**
@@ -506,7 +506,7 @@ ___
▸ **stakingNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L198)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L198)*
**Parameters:**
@@ -523,7 +523,7 @@ ___
▸ **validatorCount**(): `Observable`< `u32` &#124; `undefined`>
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api-observable/src/Queries.ts#L215)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/4748e8c/packages/api-observable/src/Queries.ts#L215)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
docs/api/README.md
+8 -5
View File
@@ -6,24 +6,27 @@ The Polkadot-JS API provides easy-to-use wrappers around JSONRPC calls that flow
The API wrappers provide a standard interface for use -
* A static `.create(<optional WsProvider>)` that returns an API istance when connected, decorated and ready-to use
* A static `.create(<optional WsProvider>)` that returns an API instance when connected, decorated and ready-to use
* The above is just a wrapper for `new Api(<optional WsProvider>)`, exposing the `isReady` getter
* `api.rpc.<section>.<method>` provides access to actual RPC calls, be it for queries, submission or retrieving chain information
* [RPC (node interface)](../METHODS_RPC.md)
* `api.query.<section>.<method>` provides access to chain state queries. These are dynamically populated based on what the runtime provides
* `api.tx.<section>.<method>` provides the ability to create transaction, like chain state, this list is populated from a runtime query
* [Storage chain state (runtime node interface)](../METHODS_STORAGE.md)
* `api.tx.<section>.<method>` provides the ability to create a transaction, like chain state, this list is populated from a runtime query
* [Extrinsics (runtime node interface)](../METHODS_EXTRINSICS.md)
API Selection
-------------
There are two flavours of the API provided, one allowing a standard interface via JavaScript Promises and the second provides an Observable wrapper using [RxJS](https://github.com/ReactiveX/rxjs). Depending on your use-case and familiarity, you can choose either (or even both) for your application.
* [ApiPromise](classes/_promise_index_.apipromise.md) All interface calls returns Promises, including the static `.create(...)`. Additionally any subscription method use `(value) => {}` callbacks, returning the value as the subscription is updated.
* [ApiRx](classes/_rx_index_.apirx.md) All interface calls return RxJS Observables, including the static `.create(...)`. In the same fashion and subscription-based methods return long-running Observables that update with the latest values.
* [ApiPromise](classes/_promise_index_.apipromise.md) All interface calls returns Promises, including the static `.create(...)`. Additionally any subscription method uses `(value) => {}` callbacks, returning the value as the subscription is updated.
* [ApiRx](classes/_rx_index_.apirx.md) All interface calls return RxJS Observables, including the static `.create(...)`. In the same fashion subscription-based methods return long-running Observables that update with the latest values.
Dynamic by default
------------------
Subtrate (on which Polkadot is built) used on-chain on-chain WASM runtimes, allowing for upgradability. Each runtime defining the actual chain extrinsics (submitted transactions and block intrinsics) as well as available entries in the chain state. Due to this, the API endpoints for queries and transactions are dynamically populated from the running chain.
Substrate (upon which Polkadot is built) uses on-chain WASM runtimes, allowing for upgradability. Each runtime defining the actual chain extrinsics (submitted transactions and block intrinsics) as well as available entries in the chain state. Due to this, the API endpoints for queries and transactions are dynamically populated from the running chain.
Due to this dynamic nature, this API departs from traditional APIs which only has fixed endpoints, driving use by what is available by the runtime. As a start, this generic nature has a learning curve, although the provided documentation, examples and linked documentation tries to make that experience as seamless as possible.
docs/api/classes/_base_.apibase.md
+8 -8
View File
@@ -24,7 +24,7 @@
⊕ **new ApiBase**(wsProvider?: *`WsProvider`*): [ApiBase](_base_.apibase.md)
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L40)*
*__description__*: Create an instance of the class
@@ -57,7 +57,7 @@ ___
getgenesisHash(): `Hash`
*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L71)*
*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L71)*
*__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.
@@ -70,7 +70,7 @@ ___
getquery(): `S`
*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L111)*
*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L111)*
*__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:133](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L133)*
*Defined in [Base.ts:133](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L133)*
*__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.
@@ -118,7 +118,7 @@ ___
getruntimeMetadata(): `RuntimeMetadata`
*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L80)*
*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L80)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -131,7 +131,7 @@ ___
getruntimeVersion(): `RuntimeVersion`
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L89)*
*__description__*: Contains the version information for the current runtime.
@@ -144,7 +144,7 @@ ___
gettx(): `E`
*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L153)*
*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L153)*
*__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.
@@ -171,7 +171,7 @@ ___
▸ **on**(type: *`ApiInterface$Events`*, handler: *`function`*): `void`
*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L178)*
*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L178)*
*__description__*: Attach an eventemitter handler to listen to a specific event
docs/api/classes/_promise_index_.apipromise.html
+63 -17
View File
@@ -205,11 +205,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../METHODS_RPC.html">
<a href="../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../METHODS_STORAGE.html">
<a href="../../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../METHODS_EXTRINSICS.html">
<a href="../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../../examples/promise/">
<li class="chapter " data-level="3.1" data-path="../../examples/promise/">
<a href="../../examples/promise/">
@@ -223,7 +269,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../../examples/promise/01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="../../examples/promise/01_simple_connect/">
<a href="../../examples/promise/01_simple_connect/">
@@ -236,7 +282,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="../../examples/promise/02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="../../examples/promise/02_listen_to_blocks/">
<a href="../../examples/promise/02_listen_to_blocks/">
@@ -249,7 +295,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="../../examples/promise/03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="../../examples/promise/03_listen_to_balance_change/">
<a href="../../examples/promise/03_listen_to_balance_change/">
@@ -262,7 +308,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="../../examples/promise/05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="../../examples/promise/05_read_storage/">
<a href="../../examples/promise/05_read_storage/">
@@ -275,7 +321,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="../../examples/promise/07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="../../examples/promise/07_transfer_dots/">
<a href="../../examples/promise/07_transfer_dots/">
@@ -414,7 +460,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <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/64e3ca6/packages/api/src/promise/index.ts#L127" target="_blank">promise/index.ts:127</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/promise/index.ts#L127" target="_blank">promise/index.ts:127</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>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api/promise&apos;</span><span class="sunlight-punctuation">;</span>
@@ -449,14 +495,14 @@
<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/64e3ca6/packages/api/src/Base.ts#L71" target="_blank">Base.ts:71</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L71" target="_blank">Base.ts:71</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>&lt;<a href="_promise_index_.apipromise.html">ApiPromise</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/promise/index.ts#L160" target="_blank">promise/index.ts:160</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/promise/index.ts#L160" target="_blank">promise/index.ts:160</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>&lt;<a href="_promise_index_.apipromise.html">ApiPromise</a>&gt;</p>
<hr>
@@ -464,7 +510,7 @@
<h2 id="query">query</h2>
<p>getquery(): <code>QueryableStorage</code></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/64e3ca6/packages/api/src/Base.ts#L111" target="_blank">Base.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L111" target="_blank">Base.ts:111</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(&lt;accountId&gt;)</code> (retrieving the associated nonce for an account), takes the <code>AccountId</code> as a parameter.</p>
<p><em><strong>example</strong></em>: </p>
@@ -480,7 +526,7 @@
<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/64e3ca6/packages/api/src/Base.ts#L133" target="_blank">Base.ts:133</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L133" target="_blank">Base.ts:133</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>
@@ -496,7 +542,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/64e3ca6/packages/api/src/Base.ts#L80" target="_blank">Base.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L80" target="_blank">Base.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics &amp; storage, but is useful for current runtime inspection.</p>
<p><strong>Returns:</strong> <code>RuntimeMetadata</code></p>
<hr>
@@ -504,7 +550,7 @@
<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/64e3ca6/packages/api/src/Base.ts#L89" target="_blank">Base.ts:89</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L89" target="_blank">Base.ts:89</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>
@@ -512,7 +558,7 @@
<h2 id="tx">tx</h2>
<p>gettx(): <code>SubmittableExtrinsics</code></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/64e3ca6/packages/api/src/Base.ts#L153" target="_blank">Base.ts:153</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L153" target="_blank">Base.ts:153</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>
@@ -530,7 +576,7 @@
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><code>ApiInterface$Events</code></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/64e3ca6/packages/api/src/Base.ts#L178" target="_blank">Base.ts:178</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L178" target="_blank">Base.ts:178</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-operator">*</span>&#xA0;<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">&apos;disconnected&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
@@ -568,7 +614,7 @@
<p><a id="create"></a></p>
<h2 id="static-create"><code>&lt;Static&gt;</code> create</h2>
<p>&#x25B8; <strong>create</strong>(wsProvider?: <em><code>WsProvider</code></em>): <code>Promise</code>&lt;<a href="_promise_index_.apipromise.html">ApiPromise</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/promise/index.ts#L125" target="_blank">promise/index.ts:125</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/promise/index.ts#L125" target="_blank">promise/index.ts:125</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>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api/promise&apos;</span><span class="sunlight-punctuation">;</span>
@@ -641,7 +687,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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_promise_index_.apipromise.md","mtime":"2018-10-12T16:03:12.362Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_promise_index_.apipromise.md","mtime":"2018-10-12T19:18:26.114Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api/classes/_promise_index_.apipromise.md
+10 -10
View File
@@ -104,7 +104,7 @@ ApiPromise.create().then((api) => {
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [promise/index.ts:127](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/promise/index.ts#L127)*
*Defined in [promise/index.ts:127](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/promise/index.ts#L127)*
*__description__*: Creates an instance of the ApiPromise class
@@ -139,7 +139,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L71)*
*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L71)*
*__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.
@@ -152,7 +152,7 @@ ___
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:160](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/promise/index.ts#L160)*
*Defined in [promise/index.ts:160](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/promise/index.ts#L160)*
*__description__*: Promise that returns the first time we are connected and loaded
@@ -167,7 +167,7 @@ getquery(): `QueryableStorage`
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L111)*
*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L111)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -193,7 +193,7 @@ getrpc(): `Rpc`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:133](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L133)*
*Defined in [Base.ts:133](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L133)*
*__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.
@@ -219,7 +219,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L80)*
*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L80)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -234,7 +234,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L89)*
*__description__*: Contains the version information for the current runtime.
@@ -249,7 +249,7 @@ gettx(): `SubmittableExtrinsics`
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L153)*
*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L153)*
*__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.
@@ -278,7 +278,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L178)*
*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L178)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -309,7 +309,7 @@ ___
▸ **create**(wsProvider?: *`WsProvider`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/promise/index.ts#L125)*
*Defined in [promise/index.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/promise/index.ts#L125)*
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md
+26 -26
View File
@@ -21,7 +21,7 @@
*Overrides Extrinsic.__constructor*
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
**Parameters:**
@@ -44,7 +44,7 @@ ___
*Inherited from Base.raw*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -58,7 +58,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -71,7 +71,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L70)*
**Returns:** `Uint8Array`
@@ -84,7 +84,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L74)*
**Returns:** `Uint8Array`
@@ -97,7 +97,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L79)*
**Returns:** `Hash`
@@ -110,7 +110,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L85)*
**Returns:** `boolean`
@@ -123,7 +123,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L89)*
**Returns:** `number`
@@ -136,7 +136,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L93)*
**Returns:** `FunctionMetadata`
@@ -149,7 +149,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L97)*
**Returns:** `Method`
@@ -162,7 +162,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L101)*
**Returns:** `ExtrinsicSignature`
@@ -180,7 +180,7 @@ ___
*Overrides Struct.byteLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L105)*
**Returns:** `number`
@@ -195,7 +195,7 @@ ___
*Overrides Struct.fromJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:111](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L111)*
**Parameters:**
@@ -216,7 +216,7 @@ ___
*Overrides Struct.fromU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L117)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L117)*
**Parameters:**
@@ -235,7 +235,7 @@ ___
*Inherited from Struct.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -254,7 +254,7 @@ ___
*Inherited from Struct.keys*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -265,7 +265,7 @@ ___
▸ **send**(statusCb?: * `undefined` &#124; `function`*): `Promise`<`Hash`>
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
**Parameters:**
@@ -284,7 +284,7 @@ ___
*Overrides Extrinsic.sign*
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
**Parameters:**
@@ -305,7 +305,7 @@ ___
*Inherited from Extrinsic.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:142](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L142)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:142](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L142)*
**Returns:** `string`
@@ -320,7 +320,7 @@ ___
*Overrides Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:146](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L146)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:146](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L146)*
**Returns:** `any`
@@ -335,7 +335,7 @@ ___
*Overrides Base.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -350,7 +350,7 @@ ___
*Overrides Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L131)*
**Parameters:**
@@ -369,7 +369,7 @@ ___
*Inherited from Struct.values*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<`Base`>
@@ -382,7 +382,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L45)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L45)*
**Parameters:**
@@ -401,7 +401,7 @@ ___
*Inherited from Struct.decodeStruct*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -426,7 +426,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L98)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/api/classes/_rx_index_.apirx.html
+64 -18
View File
@@ -205,11 +205,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../METHODS_RPC.html">
<a href="../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../METHODS_STORAGE.html">
<a href="../../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../METHODS_EXTRINSICS.html">
<a href="../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../../examples/promise/">
<li class="chapter " data-level="3.1" data-path="../../examples/promise/">
<a href="../../examples/promise/">
@@ -223,7 +269,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../../examples/promise/01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="../../examples/promise/01_simple_connect/">
<a href="../../examples/promise/01_simple_connect/">
@@ -236,7 +282,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="../../examples/promise/02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="../../examples/promise/02_listen_to_blocks/">
<a href="../../examples/promise/02_listen_to_blocks/">
@@ -249,7 +295,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="../../examples/promise/03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="../../examples/promise/03_listen_to_balance_change/">
<a href="../../examples/promise/03_listen_to_balance_change/">
@@ -262,7 +308,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="../../examples/promise/05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="../../examples/promise/05_read_storage/">
<a href="../../examples/promise/05_read_storage/">
@@ -275,7 +321,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="../../examples/promise/07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="../../examples/promise/07_transfer_dots/">
<a href="../../examples/promise/07_transfer_dots/">
@@ -425,7 +471,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <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/64e3ca6/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/4748e8c/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>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api/rx&apos;</span><span class="sunlight-punctuation">;</span>
@@ -460,21 +506,21 @@
<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/64e3ca6/packages/api/src/Base.ts#L71" target="_blank">Base.ts:71</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L71" target="_blank">Base.ts:71</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>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/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>&lt;<code>boolean</code>&gt;</p>
<hr>
<p><a id="isready"></a></p>
<h2 id="isready">isReady</h2>
<p>getisReady(): <code>Observable</code>&lt;<a href="_rx_index_.apirx.html">ApiRx</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/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>&lt;<a href="_rx_index_.apirx.html">ApiRx</a>&gt;</p>
<hr>
@@ -482,7 +528,7 @@
<h2 id="query">query</h2>
<p>getquery(): <code>QueryableStorage</code></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/64e3ca6/packages/api/src/Base.ts#L111" target="_blank">Base.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L111" target="_blank">Base.ts:111</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(&lt;accountId&gt;)</code> (retrieving the associated nonce for an account), takes the <code>AccountId</code> as a parameter.</p>
<p><em><strong>example</strong></em>: </p>
@@ -498,7 +544,7 @@
<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/64e3ca6/packages/api/src/Base.ts#L133" target="_blank">Base.ts:133</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L133" target="_blank">Base.ts:133</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>
@@ -514,7 +560,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/64e3ca6/packages/api/src/Base.ts#L80" target="_blank">Base.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L80" target="_blank">Base.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics &amp; storage, but is useful for current runtime inspection.</p>
<p><strong>Returns:</strong> <code>RuntimeMetadata</code></p>
<hr>
@@ -522,7 +568,7 @@
<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/64e3ca6/packages/api/src/Base.ts#L89" target="_blank">Base.ts:89</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L89" target="_blank">Base.ts:89</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>
@@ -530,7 +576,7 @@
<h2 id="tx">tx</h2>
<p>gettx(): <code>SubmittableExtrinsics</code></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/64e3ca6/packages/api/src/Base.ts#L153" target="_blank">Base.ts:153</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L153" target="_blank">Base.ts:153</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>
@@ -548,7 +594,7 @@
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><code>ApiInterface$Events</code></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/64e3ca6/packages/api/src/Base.ts#L178" target="_blank">Base.ts:178</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L178" target="_blank">Base.ts:178</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-operator">*</span>&#xA0;<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">&apos;disconnected&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
@@ -586,7 +632,7 @@
<p><a id="create"></a></p>
<h2 id="static-create"><code>&lt;Static&gt;</code> create</h2>
<p>&#x25B8; <strong>create</strong>(wsProvider?: <em><code>WsProvider</code></em>): <code>Observable</code>&lt;<a href="_rx_index_.apirx.html">ApiRx</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/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>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api/rx&apos;</span><span class="sunlight-punctuation">;</span>
@@ -659,7 +705,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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_rx_index_.apirx.md","mtime":"2018-10-12T16:03:12.510Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_rx_index_.apirx.md","mtime":"2018-10-12T19:18:26.230Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api/classes/_rx_index_.apirx.md
+11 -11
View File
@@ -115,7 +115,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/64e3ca6/packages/api/src/rx/index.ts#L143)*
*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/rx/index.ts#L143)*
*__description__*: Create an instance of the ApiRx class
@@ -150,7 +150,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L71)*
*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L71)*
*__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.
@@ -163,7 +163,7 @@ ___
getisConnected(): `Observable`<`boolean`>
*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/rx/index.ts#L179)*
*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/4748e8c/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.
@@ -176,7 +176,7 @@ ___
getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:186](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/rx/index.ts#L186)*
*Defined in [rx/index.ts:186](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/rx/index.ts#L186)*
*__description__*: Observable that returns the first time we are connected and loaded
@@ -191,7 +191,7 @@ getquery(): `QueryableStorage`
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L111)*
*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L111)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -217,7 +217,7 @@ getrpc(): `RpcRx`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:133](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L133)*
*Defined in [Base.ts:133](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L133)*
*__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.
@@ -243,7 +243,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L80)*
*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L80)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -258,7 +258,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L89)*
*__description__*: Contains the version information for the current runtime.
@@ -273,7 +273,7 @@ gettx(): `SubmittableExtrinsics`
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L153)*
*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L153)*
*__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.
@@ -302,7 +302,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/Base.ts#L178)*
*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/Base.ts#L178)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -333,7 +333,7 @@ ___
▸ **create**(wsProvider?: *`WsProvider`*): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/rx/index.ts#L141)*
*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/rx/index.ts#L141)*
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md
+26 -26
View File
@@ -21,7 +21,7 @@
*Overrides Extrinsic.__constructor*
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
**Parameters:**
@@ -44,7 +44,7 @@ ___
*Inherited from Base.raw*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -58,7 +58,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -71,7 +71,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L70)*
**Returns:** `Uint8Array`
@@ -84,7 +84,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L74)*
**Returns:** `Uint8Array`
@@ -97,7 +97,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L79)*
**Returns:** `Hash`
@@ -110,7 +110,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L85)*
**Returns:** `boolean`
@@ -123,7 +123,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L89)*
**Returns:** `number`
@@ -136,7 +136,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L93)*
**Returns:** `FunctionMetadata`
@@ -149,7 +149,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L97)*
**Returns:** `Method`
@@ -162,7 +162,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/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L101)*
**Returns:** `ExtrinsicSignature`
@@ -180,7 +180,7 @@ ___
*Overrides Struct.byteLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L105)*
**Returns:** `number`
@@ -195,7 +195,7 @@ ___
*Overrides Struct.fromJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:111](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L111)*
**Parameters:**
@@ -216,7 +216,7 @@ ___
*Overrides Struct.fromU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L117)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L117)*
**Parameters:**
@@ -235,7 +235,7 @@ ___
*Inherited from Struct.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -254,7 +254,7 @@ ___
*Inherited from Struct.keys*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -265,7 +265,7 @@ ___
▸ **send**(): `Observable`<`ExtrinsicStatus`>
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
**Returns:** `Observable`<`ExtrinsicStatus`>
@@ -278,7 +278,7 @@ ___
*Overrides Extrinsic.sign*
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/64e3ca6/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/4748e8c/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
**Parameters:**
@@ -299,7 +299,7 @@ ___
*Inherited from Extrinsic.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:142](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L142)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:142](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L142)*
**Returns:** `string`
@@ -314,7 +314,7 @@ ___
*Overrides Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:146](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L146)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:146](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L146)*
**Returns:** `any`
@@ -329,7 +329,7 @@ ___
*Overrides Base.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -344,7 +344,7 @@ ___
*Overrides Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/64e3ca6/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/4748e8c/packages/types/src/Extrinsic.ts#L131)*
**Parameters:**
@@ -363,7 +363,7 @@ ___
*Inherited from Struct.values*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<`Base`>
@@ -376,7 +376,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L45)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L45)*
**Parameters:**
@@ -395,7 +395,7 @@ ___
*Inherited from Struct.decodeStruct*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -420,7 +420,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L98)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/api/index.html
+69 -14
View File
@@ -205,11 +205,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../METHODS_RPC.html">
<a href="../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../METHODS_STORAGE.html">
<a href="../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../METHODS_EXTRINSICS.html">
<a href="../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../examples/promise/">
<li class="chapter " data-level="3.1" data-path="../examples/promise/">
<a href="../examples/promise/">
@@ -223,7 +269,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../examples/promise/01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="../examples/promise/01_simple_connect/">
<a href="../examples/promise/01_simple_connect/">
@@ -236,7 +282,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="../examples/promise/02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="../examples/promise/02_listen_to_blocks/">
<a href="../examples/promise/02_listen_to_blocks/">
@@ -249,7 +295,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="../examples/promise/03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="../examples/promise/03_listen_to_balance_change/">
<a href="../examples/promise/03_listen_to_balance_change/">
@@ -262,7 +308,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="../examples/promise/05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="../examples/promise/05_read_storage/">
<a href="../examples/promise/05_read_storage/">
@@ -275,7 +321,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="../examples/promise/07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="../examples/promise/07_transfer_dots/">
<a href="../examples/promise/07_transfer_dots/">
@@ -342,20 +388,29 @@
<p>The Polkadot-JS API provides easy-to-use wrappers around JSONRPC calls that flow from an application to a node. It handles all the encoding and decoding or parameters, provides access to RPC functions and allows for the query of chain state and the submission of transactions.</p>
<p>The API wrappers provide a standard interface for use -</p>
<ul>
<li>A static <code>.create(&lt;optional WsProvider&gt;)</code> that returns an API istance when connected, decorated and ready-to use</li>
<li>A static <code>.create(&lt;optional WsProvider&gt;)</code> that returns an API instance when connected, decorated and ready-to use</li>
<li>The above is just a wrapper for <code>new Api(&lt;optional WsProvider&gt;)</code>, exposing the <code>isReady</code> getter</li>
<li><code>api.rpc.&lt;section&gt;.&lt;method&gt;</code> provides access to actual RPC calls, be it for queries, submission or retrieving chain information</li>
<li><code>api.query.&lt;section&gt;.&lt;method&gt;</code> provides access to chain state queries. These are dynamically populated based on what the runtime provides</li>
<li><code>api.tx.&lt;section&gt;.&lt;method&gt;</code> provides the ability to create transaction, like chain state, this list is populated from a runtime query</li>
<li><code>api.rpc.&lt;section&gt;.&lt;method&gt;</code> provides access to actual RPC calls, be it for queries, submission or retrieving chain information<ul>
<li><a href="../METHODS_RPC.html">RPC (node interface)</a></li>
</ul>
</li>
<li><code>api.query.&lt;section&gt;.&lt;method&gt;</code> provides access to chain state queries. These are dynamically populated based on what the runtime provides<ul>
<li><a href="../METHODS_STORAGE.html">Storage chain state (runtime node interface)</a></li>
</ul>
</li>
<li><code>api.tx.&lt;section&gt;.&lt;method&gt;</code> provides the ability to create a transaction, like chain state, this list is populated from a runtime query<ul>
<li><a href="../METHODS_EXTRINSICS.html">Extrinsics (runtime node interface)</a></li>
</ul>
</li>
</ul>
<h2 id="api-selection">API Selection</h2>
<p>There are two flavours of the API provided, one allowing a standard interface via JavaScript Promises and the second provides an Observable wrapper using <a href="https://github.com/ReactiveX/rxjs" target="_blank">RxJS</a>. Depending on your use-case and familiarity, you can choose either (or even both) for your application.</p>
<ul>
<li><a href="classes/_promise_index_.apipromise.html">ApiPromise</a> All interface calls returns Promises, including the static <code>.create(...)</code>. Additionally any subscription method use <code>(value) =&gt; {}</code> callbacks, returning the value as the subscription is updated.</li>
<li><a href="classes/_rx_index_.apirx.html">ApiRx</a> All interface calls return RxJS Observables, including the static <code>.create(...)</code>. In the same fashion and subscription-based methods return long-running Observables that update with the latest values.</li>
<li><a href="classes/_promise_index_.apipromise.html">ApiPromise</a> All interface calls returns Promises, including the static <code>.create(...)</code>. Additionally any subscription method uses <code>(value) =&gt; {}</code> callbacks, returning the value as the subscription is updated.</li>
<li><a href="classes/_rx_index_.apirx.html">ApiRx</a> All interface calls return RxJS Observables, including the static <code>.create(...)</code>. In the same fashion subscription-based methods return long-running Observables that update with the latest values.</li>
</ul>
<h2 id="dynamic-by-default">Dynamic by default</h2>
<p>Subtrate (on which Polkadot is built) used on-chain on-chain WASM runtimes, allowing for upgradability. Each runtime defining the actual chain extrinsics (submitted transactions and block intrinsics) as well as available entries in the chain state. Due to this, the API endpoints for queries and transactions are dynamically populated from the running chain.</p>
<p>Substrate (upon which Polkadot is built) uses on-chain WASM runtimes, allowing for upgradability. Each runtime defining the actual chain extrinsics (submitted transactions and block intrinsics) as well as available entries in the chain state. Due to this, the API endpoints for queries and transactions are dynamically populated from the running chain.</p>
<p>Due to this dynamic nature, this API departs from traditional APIs which only has fixed endpoints, driving use by what is available by the runtime. As a start, this generic nature has a learning curve, although the provided documentation, examples and linked documentation tries to make that experience as seamless as possible.</p>
<h2 id="installation--import">Installation &amp; import</h2>
<p>Installation -</p>
@@ -431,7 +486,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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/README.md","mtime":"2018-10-12T16:03:12.062Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/README.md","mtime":"2018-10-12T19:18:25.802Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/01_simple_connect/index.html
+53 -7
View File
@@ -205,11 +205,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../../METHODS_RPC.html">
<a href="../../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../../METHODS_STORAGE.html">
<a href="../../../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../../METHODS_EXTRINSICS.html">
<a href="../../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../">
<li class="chapter " data-level="3.1" data-path="../">
<a href="../">
@@ -223,7 +269,7 @@
<ul class="articles">
<li class="chapter active" data-level="2.1.1" data-path="./">
<li class="chapter active" data-level="3.1.1" data-path="./">
<a href="./">
@@ -236,7 +282,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="../02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="../02_listen_to_blocks/">
<a href="../02_listen_to_blocks/">
@@ -249,7 +295,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="../03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="../03_listen_to_balance_change/">
<a href="../03_listen_to_balance_change/">
@@ -262,7 +308,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="../05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="../05_read_storage/">
<a href="../05_read_storage/">
@@ -275,7 +321,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="../07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="../07_transfer_dots/">
<a href="../07_transfer_dots/">
@@ -406,7 +452,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"2.1.1","depth":2,"next":{"title":"Listen to blocks","level":"2.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":"2.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"2.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":"2.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":"2.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":"2.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":"2.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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/01_simple_connect/README.md","mtime":"2018-10-12T16:01:07.399Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/01_simple_connect/README.md","mtime":"2018-10-12T19:16:06.930Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/02_listen_to_blocks/index.html
+53 -7
View File
@@ -205,11 +205,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../../METHODS_RPC.html">
<a href="../../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../../METHODS_STORAGE.html">
<a href="../../../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../../METHODS_EXTRINSICS.html">
<a href="../../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../">
<li class="chapter " data-level="3.1" data-path="../">
<a href="../">
@@ -223,7 +269,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="../01_simple_connect/">
<a href="../01_simple_connect/">
@@ -236,7 +282,7 @@
</li>
<li class="chapter active" data-level="2.1.2" data-path="./">
<li class="chapter active" data-level="3.1.2" data-path="./">
<a href="./">
@@ -249,7 +295,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="../03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="../03_listen_to_balance_change/">
<a href="../03_listen_to_balance_change/">
@@ -262,7 +308,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="../05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="../05_read_storage/">
<a href="../05_read_storage/">
@@ -275,7 +321,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="../07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="../07_transfer_dots/">
<a href="../07_transfer_dots/">
@@ -408,7 +454,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"2.1.2","depth":2,"next":{"title":"Listen to balance change","level":"2.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":"2.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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/02_listen_to_blocks/README.md","mtime":"2018-10-12T16:01:07.399Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/02_listen_to_blocks/README.md","mtime":"2018-10-12T19:16:06.934Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/03_listen_to_balance_change/index.html
+53 -7
View File
@@ -205,11 +205,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../../METHODS_RPC.html">
<a href="../../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../../METHODS_STORAGE.html">
<a href="../../../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../../METHODS_EXTRINSICS.html">
<a href="../../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../">
<li class="chapter " data-level="3.1" data-path="../">
<a href="../">
@@ -223,7 +269,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="../01_simple_connect/">
<a href="../01_simple_connect/">
@@ -236,7 +282,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="../02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="../02_listen_to_blocks/">
<a href="../02_listen_to_blocks/">
@@ -249,7 +295,7 @@
</li>
<li class="chapter active" data-level="2.1.3" data-path="./">
<li class="chapter active" data-level="3.1.3" data-path="./">
<a href="./">
@@ -262,7 +308,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="../05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="../05_read_storage/">
<a href="../05_read_storage/">
@@ -275,7 +321,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="../07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="../07_transfer_dots/">
<a href="../07_transfer_dots/">
@@ -419,7 +465,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"2.1.3","depth":2,"next":{"title":"Read chain state","level":"2.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":"2.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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/03_listen_to_balance_change/README.md","mtime":"2018-10-12T16:01:07.399Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/03_listen_to_balance_change/README.md","mtime":"2018-10-12T19:16:06.934Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/05_read_storage/index.html
+53 -7
View File
@@ -205,11 +205,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../../METHODS_RPC.html">
<a href="../../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../../METHODS_STORAGE.html">
<a href="../../../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../../METHODS_EXTRINSICS.html">
<a href="../../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../">
<li class="chapter " data-level="3.1" data-path="../">
<a href="../">
@@ -223,7 +269,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="../01_simple_connect/">
<a href="../01_simple_connect/">
@@ -236,7 +282,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="../02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="../02_listen_to_blocks/">
<a href="../02_listen_to_blocks/">
@@ -249,7 +295,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="../03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="../03_listen_to_balance_change/">
<a href="../03_listen_to_balance_change/">
@@ -262,7 +308,7 @@
</li>
<li class="chapter active" data-level="2.1.4" data-path="./">
<li class="chapter active" data-level="3.1.4" data-path="./">
<a href="./">
@@ -275,7 +321,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="../07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="../07_transfer_dots/">
<a href="../07_transfer_dots/">
@@ -418,7 +464,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Read chain state","level":"2.1.4","depth":2,"next":{"title":"Make a transfer","level":"2.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":"2.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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/05_read_storage/README.md","mtime":"2018-10-12T16:01:07.399Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/05_read_storage/README.md","mtime":"2018-10-12T19:16:06.934Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/07_transfer_dots/index.html
+53 -7
View File
@@ -203,11 +203,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../../METHODS_RPC.html">
<a href="../../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../../METHODS_STORAGE.html">
<a href="../../../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../../METHODS_EXTRINSICS.html">
<a href="../../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../">
<li class="chapter " data-level="3.1" data-path="../">
<a href="../">
@@ -221,7 +267,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="../01_simple_connect/">
<a href="../01_simple_connect/">
@@ -234,7 +280,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="../02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="../02_listen_to_blocks/">
<a href="../02_listen_to_blocks/">
@@ -247,7 +293,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="../03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="../03_listen_to_balance_change/">
<a href="../03_listen_to_balance_change/">
@@ -260,7 +306,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="../05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="../05_read_storage/">
<a href="../05_read_storage/">
@@ -273,7 +319,7 @@
</li>
<li class="chapter active" data-level="2.1.5" data-path="./">
<li class="chapter active" data-level="3.1.5" data-path="./">
<a href="./">
@@ -414,7 +460,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Make a transfer","level":"2.1.5","depth":2,"previous":{"title":"Read chain state","level":"2.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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/07_transfer_dots/README.md","mtime":"2018-10-12T16:01:07.399Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/07_transfer_dots/README.md","mtime":"2018-10-12T19:16:06.934Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/promise/index.html
+55 -9
View File
@@ -68,7 +68,7 @@
<link rel="next" href="01_simple_connect/" />
<link rel="prev" href="../../rpc-provider/classes/_ws_index_.wsprovider.html" />
<link rel="prev" href="../../METHODS_EXTRINSICS.html" />
</head>
@@ -205,11 +205,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../METHODS_RPC.html">
<a href="../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../METHODS_STORAGE.html">
<a href="../../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../METHODS_EXTRINSICS.html">
<a href="../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter active" data-level="2.1" data-path="./">
<li class="chapter active" data-level="3.1" data-path="./">
<a href="./">
@@ -223,7 +269,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="01_simple_connect/">
<a href="01_simple_connect/">
@@ -236,7 +282,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="02_listen_to_blocks/">
<a href="02_listen_to_blocks/">
@@ -249,7 +295,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="03_listen_to_balance_change/">
<a href="03_listen_to_balance_change/">
@@ -262,7 +308,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="05_read_storage/">
<a href="05_read_storage/">
@@ -275,7 +321,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="07_transfer_dots/">
<a href="07_transfer_dots/">
@@ -380,7 +426,7 @@
<a href="../../rpc-provider/classes/_ws_index_.wsprovider.html" class="navigation navigation-prev " aria-label="Previous page: WsProvider">
<a href="../../METHODS_EXTRINSICS.html" class="navigation navigation-prev " aria-label="Previous page: Extrinsics (runtime)">
<i class="fa fa-angle-left"></i>
</a>
@@ -396,7 +442,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"ApiPromise","level":"2.1","depth":1,"next":{"title":"Simple connect","level":"2.1.1","depth":2,"path":"examples/promise/01_simple_connect/README.md","ref":"examples/promise/01_simple_connect/README.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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/README.md","mtime":"2018-10-12T16:01:07.399Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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":"Extrinsics (runtime)","level":"2.3","depth":1,"path":"METHODS_EXTRINSICS.md","ref":"METHODS_EXTRINSICS.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/promise/README.md","mtime":"2018-10-12T19:16:06.934Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/index.html
+59 -7
View File
@@ -203,11 +203,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="METHODS_RPC.html">
<a href="METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="METHODS_STORAGE.html">
<a href="METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="METHODS_EXTRINSICS.html">
<a href="METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="examples/promise/">
<li class="chapter " data-level="3.1" data-path="examples/promise/">
<a href="examples/promise/">
@@ -221,7 +267,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="examples/promise/01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="examples/promise/01_simple_connect/">
<a href="examples/promise/01_simple_connect/">
@@ -234,7 +280,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="examples/promise/02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="examples/promise/02_listen_to_blocks/">
<a href="examples/promise/02_listen_to_blocks/">
@@ -247,7 +293,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="examples/promise/03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="examples/promise/03_listen_to_balance_change/">
<a href="examples/promise/03_listen_to_balance_change/">
@@ -260,7 +306,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="examples/promise/05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="examples/promise/05_read_storage/">
<a href="examples/promise/05_read_storage/">
@@ -273,7 +319,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="examples/promise/07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="examples/promise/07_transfer_dots/">
<a href="examples/promise/07_transfer_dots/">
@@ -351,6 +397,12 @@
</ul>
</li>
</ul>
<h2 id="node-interfaces">Node Interfaces</h2>
<ul>
<li><a href="METHODS_RPC.html">RPC</a></li>
<li><a href="METHODS_STORAGE.html">Storage chain state (runtime)</a></li>
<li><a href="METHODS_EXTRINSICS.html">Extrinsics (runtime)</a></li>
</ul>
<h2 id="examples">Examples</h2>
<ul>
<li><a href="examples/promise/">ApiPromise</a><ul>
@@ -413,7 +465,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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2018-10-12T16:01:07.391Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2018-10-12T19:16:06.926Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/rpc-core/classes/_index_.rpc.md
+7 -7
View File
@@ -37,7 +37,7 @@ const api = new Api(provider);
⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md)
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-core/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-core/src/index.ts#L45)*
*__constructor__*: Default constructor for the Api Object
@@ -59,7 +59,7 @@ ___
**● _provider**: *`ProviderInterface`*
*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-core/src/index.ts#L41)*
*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-core/src/index.ts#L41)*
___
<a id="author"></a>
@@ -68,7 +68,7 @@ ___
**● author**: *`RpcInterface$Section`*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-core/src/index.ts#L42)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-core/src/index.ts#L42)*
___
<a id="chain"></a>
@@ -77,7 +77,7 @@ ___
**● chain**: *`RpcInterface$Section`*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-core/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-core/src/index.ts#L43)*
___
<a id="state"></a>
@@ -86,7 +86,7 @@ ___
**● state**: *`RpcInterface$Section`*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-core/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-core/src/index.ts#L44)*
___
<a id="system"></a>
@@ -95,7 +95,7 @@ ___
**● system**: *`RpcInterface$Section`*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-core/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-core/src/index.ts#L45)*
___
@@ -107,7 +107,7 @@ ___
▸ **signature**(__namedParameters: *`object`*): `string`
*Defined in [index.ts:78](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-core/src/index.ts#L78)*
*Defined in [index.ts:78](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-core/src/index.ts#L78)*
*__name__*: signature
docs/rpc-provider/README.md
+2 -2
View File
@@ -2,12 +2,12 @@
@polkadot/rpc-provider
======================
Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. It provides an interface to making RPC class and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won't be directly used, rather only passed to a higher-level interface.
Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. It provides an interface to making RPC calls and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won't be directly used, rather only passed to a higher-level interface.
Provider Selection
------------------
There are two flavours of the providers provided, one allowing for using HTTP as a transport machanism, the other using WebSockets. It is generally recommended to use the [WsProvider](classes/_ws_index_.wsprovider.md) since in addition to standard calls, it allows for subscriptions where all changes to state can be pushed from the node to the client.
There are two flavours of the providers provided, one allowing for using HTTP as a transport mechanism, the other using WebSockets. It is generally recommended to use the [WsProvider](classes/_ws_index_.wsprovider.md) since in addition to standard calls, it allows for subscriptions where all changes to state can be pushed from the node to the client.
Both providers are usable (as is the API), in both browser-based and Node.js environments. Polyfills for unsupported functionality are automatically applied based on feature-detection.
docs/rpc-provider/classes/_http_index_.httpprovider.html
+59 -13
View File
@@ -205,11 +205,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../METHODS_RPC.html">
<a href="../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../METHODS_STORAGE.html">
<a href="../../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../METHODS_EXTRINSICS.html">
<a href="../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../../examples/promise/">
<li class="chapter " data-level="3.1" data-path="../../examples/promise/">
<a href="../../examples/promise/">
@@ -223,7 +269,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../../examples/promise/01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="../../examples/promise/01_simple_connect/">
<a href="../../examples/promise/01_simple_connect/">
@@ -236,7 +282,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="../../examples/promise/02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="../../examples/promise/02_listen_to_blocks/">
<a href="../../examples/promise/02_listen_to_blocks/">
@@ -249,7 +295,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="../../examples/promise/03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="../../examples/promise/03_listen_to_balance_change/">
<a href="../../examples/promise/03_listen_to_balance_change/">
@@ -262,7 +308,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="../../examples/promise/05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="../../examples/promise/05_read_storage/">
<a href="../../examples/promise/05_read_storage/">
@@ -275,7 +321,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="../../examples/promise/07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="../../examples/promise/07_transfer_dots/">
<a href="../../examples/promise/07_transfer_dots/">
@@ -359,7 +405,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <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/64e3ca6/packages/rpc-provider/src/http/index.ts#L42" target="_blank">http/index.ts:42</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L42" target="_blank">http/index.ts:42</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -385,7 +431,7 @@
<p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/http/index.ts#L59" target="_blank">http/index.ts:59</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L59" target="_blank">http/index.ts:59</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>
@@ -393,7 +439,7 @@ true if connected</p>
<p><a id="on"></a></p>
<h2 id="on">on</h2>
<p>&#x25B8; <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/64e3ca6/packages/rpc-provider/src/http/index.ts#L67" target="_blank">http/index.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L67" target="_blank">http/index.ts:67</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 &apos;on&apos; emitters. WebSockets should be used instead.</p>
<p><strong>Parameters:</strong></p>
@@ -420,7 +466,7 @@ true if connected</p>
<p><a id="send"></a></p>
<h2 id="send">send</h2>
<p>&#x25B8; <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>): <code>Promise</code>&lt;<code>any</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/http/index.ts#L74" target="_blank">http/index.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L74" target="_blank">http/index.ts:74</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>
@@ -446,7 +492,7 @@ true if connected</p>
<p><a id="subscribe"></a></p>
<h2 id="subscribe">subscribe</h2>
<p>&#x25B8; <strong>subscribe</strong>(types: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, cb: <em><code>ProviderInterface$Callback</code></em>): <code>Promise</code>&lt;<code>number</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/http/index.ts#L96" target="_blank">http/index.ts:96</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L96" target="_blank">http/index.ts:96</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>
@@ -480,7 +526,7 @@ true if connected</p>
<p><a id="unsubscribe"></a></p>
<h2 id="unsubscribe">unsubscribe</h2>
<p>&#x25B8; <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/http/index.ts#L105" target="_blank">http/index.ts:105</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L105" target="_blank">http/index.ts:105</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>
@@ -550,7 +596,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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_http_index_.httpprovider.md","mtime":"2018-10-12T16:03:37.155Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_http_index_.httpprovider.md","mtime":"2018-10-12T19:18:52.806Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/classes/_http_index_.httpprovider.md
+6 -6
View File
@@ -33,7 +33,7 @@ const api = new Api(provider);
⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
*Defined in [http/index.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/http/index.ts#L42)*
*Defined in [http/index.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L42)*
**Parameters:**
@@ -53,7 +53,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [http/index.ts:59](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/http/index.ts#L59)*
*Defined in [http/index.ts:59](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L59)*
*__summary__*: Whether the node is connected or not.
@@ -67,7 +67,7 @@ ___
▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void`
*Defined in [http/index.ts:67](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/http/index.ts#L67)*
*Defined in [http/index.ts:67](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L67)*
*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -89,7 +89,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [http/index.ts:74](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/http/index.ts#L74)*
*Defined in [http/index.ts:74](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L74)*
*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
@@ -109,7 +109,7 @@ ___
▸ **subscribe**(types: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *`ProviderInterface$Callback`*): `Promise`<`number`>
*Defined in [http/index.ts:96](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/http/index.ts#L96)*
*Defined in [http/index.ts:96](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L96)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -131,7 +131,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [http/index.ts:105](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/http/index.ts#L105)*
*Defined in [http/index.ts:105](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/http/index.ts#L105)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
docs/rpc-provider/classes/_ws_index_.wsprovider.html
+62 -16
View File
@@ -65,7 +65,7 @@
<link rel="shortcut icon" href="../../gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="../../examples/promise/" />
<link rel="next" href="../../METHODS_RPC.html" />
<link rel="prev" href="_http_index_.httpprovider.html" />
@@ -205,11 +205,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../METHODS_RPC.html">
<a href="../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../METHODS_STORAGE.html">
<a href="../../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../METHODS_EXTRINSICS.html">
<a href="../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../../examples/promise/">
<li class="chapter " data-level="3.1" data-path="../../examples/promise/">
<a href="../../examples/promise/">
@@ -223,7 +269,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../../examples/promise/01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="../../examples/promise/01_simple_connect/">
<a href="../../examples/promise/01_simple_connect/">
@@ -236,7 +282,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="../../examples/promise/02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="../../examples/promise/02_listen_to_blocks/">
<a href="../../examples/promise/02_listen_to_blocks/">
@@ -249,7 +295,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="../../examples/promise/03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="../../examples/promise/03_listen_to_balance_change/">
<a href="../../examples/promise/03_listen_to_balance_change/">
@@ -262,7 +308,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="../../examples/promise/05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="../../examples/promise/05_read_storage/">
<a href="../../examples/promise/05_read_storage/">
@@ -275,7 +321,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="../../examples/promise/07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="../../examples/promise/07_transfer_dots/">
<a href="../../examples/promise/07_transfer_dots/">
@@ -359,7 +405,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <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/64e3ca6/packages/rpc-provider/src/ws/index.ts#L79" target="_blank">ws/index.ts:79</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L79" target="_blank">ws/index.ts:79</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -391,7 +437,7 @@
<p><a id="connect"></a></p>
<h2 id="connect">connect</h2>
<p>&#x25B8; <strong>connect</strong>(): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L109" target="_blank">ws/index.ts:109</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L109" target="_blank">ws/index.ts:109</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>
@@ -399,7 +445,7 @@
<p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L126" target="_blank">ws/index.ts:126</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L126" target="_blank">ws/index.ts:126</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>
@@ -407,7 +453,7 @@ true if connected</p>
<p><a id="on"></a></p>
<h2 id="on">on</h2>
<p>&#x25B8; <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/64e3ca6/packages/rpc-provider/src/ws/index.ts#L135" target="_blank">ws/index.ts:135</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L135" target="_blank">ws/index.ts:135</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>
@@ -436,7 +482,7 @@ true if connected</p>
<p><a id="send"></a></p>
<h2 id="send">send</h2>
<p>&#x25B8; <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, subscription?: <em><code>SubscriptionHandler</code></em>): <code>Promise</code>&lt;<code>any</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L142" target="_blank">ws/index.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L142" target="_blank">ws/index.ts:142</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>
@@ -466,7 +512,7 @@ true if connected</p>
<p><a id="subscribe"></a></p>
<h2 id="subscribe">subscribe</h2>
<p>&#x25B8; <strong>subscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, callback: <em><code>ProviderInterface$Callback</code></em>): <code>Promise</code>&lt;<code>number</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L198" target="_blank">ws/index.ts:198</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L198" target="_blank">ws/index.ts:198</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>
@@ -517,7 +563,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>&#x25B8; <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L207" target="_blank">ws/index.ts:207</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L207" target="_blank">ws/index.ts:207</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>
@@ -576,7 +622,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
</a>
<a href="../../examples/promise/" class="navigation navigation-next " aria-label="Next page: ApiPromise">
<a href="../../METHODS_RPC.html" class="navigation navigation-next " aria-label="Next page: RPC">
<i class="fa fa-angle-right"></i>
</a>
@@ -587,7 +633,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":"ApiPromise","level":"2.1","depth":1,"path":"examples/promise/README.md","ref":"examples/promise/README.md","articles":[{"title":"Simple connect","level":"2.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":"2.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":"2.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":"2.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":"2.1.5","depth":2,"path":"examples/promise/07_transfer_dots/README.md","ref":"examples/promise/07_transfer_dots/README.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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-10-12T16:03:37.227Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-10-12T19:18:52.878Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/classes/_ws_index_.wsprovider.md
+7 -7
View File
@@ -33,7 +33,7 @@ const api = new Api(provider);
⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
*Defined in [ws/index.ts:79](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L79)*
*Defined in [ws/index.ts:79](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L79)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
▸ **connect**(): `void`
*Defined in [ws/index.ts:109](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L109)*
*Defined in [ws/index.ts:109](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L109)*
*__summary__*: Manually connect
@@ -69,7 +69,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [ws/index.ts:126](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L126)*
*Defined in [ws/index.ts:126](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L126)*
*__summary__*: Whether the node is connected or not.
@@ -83,7 +83,7 @@ ___
▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void`
*Defined in [ws/index.ts:135](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L135)*
*Defined in [ws/index.ts:135](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L135)*
*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
@@ -103,7 +103,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
*Defined in [ws/index.ts:142](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L142)*
*Defined in [ws/index.ts:142](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L142)*
*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
@@ -124,7 +124,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *`ProviderInterface$Callback`*): `Promise`<`number`>
*Defined in [ws/index.ts:198](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L198)*
*Defined in [ws/index.ts:198](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L198)*
*__name__*: subscribe
@@ -161,7 +161,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [ws/index.ts:207](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/ws/index.ts#L207)*
*Defined in [ws/index.ts:207](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/ws/index.ts#L207)*
*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
docs/rpc-provider/index.html
+55 -9
View File
@@ -205,11 +205,57 @@
<li class="header">Node Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../METHODS_RPC.html">
<a href="../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../METHODS_STORAGE.html">
<a href="../METHODS_STORAGE.html">
Storage chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../METHODS_EXTRINSICS.html">
<a href="../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../examples/promise/">
<li class="chapter " data-level="3.1" data-path="../examples/promise/">
<a href="../examples/promise/">
@@ -223,7 +269,7 @@
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../examples/promise/01_simple_connect/">
<li class="chapter " data-level="3.1.1" data-path="../examples/promise/01_simple_connect/">
<a href="../examples/promise/01_simple_connect/">
@@ -236,7 +282,7 @@
</li>
<li class="chapter " data-level="2.1.2" data-path="../examples/promise/02_listen_to_blocks/">
<li class="chapter " data-level="3.1.2" data-path="../examples/promise/02_listen_to_blocks/">
<a href="../examples/promise/02_listen_to_blocks/">
@@ -249,7 +295,7 @@
</li>
<li class="chapter " data-level="2.1.3" data-path="../examples/promise/03_listen_to_balance_change/">
<li class="chapter " data-level="3.1.3" data-path="../examples/promise/03_listen_to_balance_change/">
<a href="../examples/promise/03_listen_to_balance_change/">
@@ -262,7 +308,7 @@
</li>
<li class="chapter " data-level="2.1.4" data-path="../examples/promise/05_read_storage/">
<li class="chapter " data-level="3.1.4" data-path="../examples/promise/05_read_storage/">
<a href="../examples/promise/05_read_storage/">
@@ -275,7 +321,7 @@
</li>
<li class="chapter " data-level="2.1.5" data-path="../examples/promise/07_transfer_dots/">
<li class="chapter " data-level="3.1.5" data-path="../examples/promise/07_transfer_dots/">
<a href="../examples/promise/07_transfer_dots/">
@@ -339,9 +385,9 @@
<section class="normal markdown-section">
<h1 id="polkadotrpc-provider">@polkadot/rpc-provider</h1>
<p>Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. It provides an interface to making RPC class and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won&apos;t be directly used, rather only passed to a higher-level interface.</p>
<p>Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. It provides an interface to making RPC calls and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won&apos;t be directly used, rather only passed to a higher-level interface.</p>
<h2 id="provider-selection">Provider Selection</h2>
<p>There are two flavours of the providers provided, one allowing for using HTTP as a transport machanism, the other using WebSockets. It is generally recommended to use the <a href="classes/_ws_index_.wsprovider.html">WsProvider</a> since in addition to standard calls, it allows for subscriptions where all changes to state can be pushed from the node to the client.</p>
<p>There are two flavours of the providers provided, one allowing for using HTTP as a transport mechanism, the other using WebSockets. It is generally recommended to use the <a href="classes/_ws_index_.wsprovider.html">WsProvider</a> since in addition to standard calls, it allows for subscriptions where all changes to state can be pushed from the node to the client.</p>
<p>Both providers are usable (as is the API), in both browser-based and Node.js environments. Polyfills for unsupported functionality are automatically applied based on feature-detection.</p>
<h2 id="usage">Usage</h2>
<p>Installation -</p>
@@ -407,7 +453,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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/README.md","mtime":"2018-10-12T16:03:37.011Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T16:04:46.181Z"},"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","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/README.md","mtime":"2018-10-12T19:18:52.642Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-12T19:20:11.375Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/modules/_coder_json_decoderesponse_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decodeResponse**(self: *`RpcCoderState`*, response: *`JsonRpcResponse`*): `any`
*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/coder/json/decodeResponse.ts#L22)*
*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/coder/json/decodeResponse.ts#L22)*
**Parameters:**
docs/rpc-provider/modules/_coder_json_encodejson_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encodeJson**(self: *`RpcCoderState`*, method: *`string`*, params: *`Array`<`any`>*): `string`
*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/coder/json/encodeJson.ts#L9)*
*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/coder/json/encodeJson.ts#L9)*
**Parameters:**
docs/rpc-provider/modules/_coder_json_encodeobject_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encodeObject**(self: *`RpcCoderState`*, method: *`string`*, params: *`Array`<`any`>*): `JsonRpcRequest`
*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/coder/json/encodeObject.ts#L8)*
*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/coder/json/encodeObject.ts#L8)*
**Parameters:**
docs/rpc-provider/modules/_coder_json_index_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **rpcCoder**(): `RpcCoder`
*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/coder/json/index.ts#L12)*
*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/coder/json/index.ts#L12)*
**Returns:** `RpcCoder`
docs/rpc-provider/modules/_mock_index_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **mockProvider**(): `ProviderInterface`
*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/mock/index.ts#L18)*
*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/mock/index.ts#L18)*
A mock provider mainly used for testing.
docs/rpc-provider/modules/_mock_mocks_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **mocks**(__namedParameters: *`object`*): `void`
*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/mock/mocks.ts#L63)*
*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/mock/mocks.ts#L63)*
**Parameters:**
docs/rpc-provider/modules/_mock_on_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **on**(self: *`MockState`*, type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void`
*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/mock/on.ts#L8)*
*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/mock/on.ts#L8)*
**Parameters:**
docs/rpc-provider/modules/_mock_send_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **send**(__namedParameters: *`object`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/mock/send.ts#L7)*
*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/mock/send.ts#L7)*
**Parameters:**
docs/rpc-provider/modules/_mock_state_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **state**(): `MockState`
*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/mock/state.ts#L38)*
*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/mock/state.ts#L38)*
**Returns:** `MockState`
docs/rpc-provider/modules/_mock_subscribe_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **subscribe**(self: *`MockState`*, type: *`string`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`number`>
*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/mock/subscribe.ts#L7)*
*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/mock/subscribe.ts#L7)*
**Parameters:**
docs/rpc-provider/modules/_mock_unsubscribe_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **unsubscribe**(self: *`MockState`*, type: *`string`*, name: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-provider/src/mock/unsubscribe.ts#L7)*
*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-provider/src/mock/unsubscribe.ts#L7)*
**Parameters:**
docs/rpc-rx/classes/_index_.rpcrx.md
+7 -7
View File
@@ -31,7 +31,7 @@ const api = new RpcRx(provider);
⊕ **new RpcRx**(providerOrRpc?: * `Rpc` &#124; `ProviderInterface`*): [RpcRx](_index_.rpcrx.md)
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-rx/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-rx/src/index.ts#L45)*
**Parameters:**
@@ -51,7 +51,7 @@ ___
**● author**: *`RpcRxInterface$Section`*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-rx/src/index.ts#L42)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-rx/src/index.ts#L42)*
___
<a id="chain"></a>
@@ -60,7 +60,7 @@ ___
**● chain**: *`RpcRxInterface$Section`*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-rx/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-rx/src/index.ts#L43)*
___
<a id="state"></a>
@@ -69,7 +69,7 @@ ___
**● state**: *`RpcRxInterface$Section`*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-rx/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-rx/src/index.ts#L44)*
___
<a id="system"></a>
@@ -78,7 +78,7 @@ ___
**● system**: *`RpcRxInterface$Section`*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-rx/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-rx/src/index.ts#L45)*
___
@@ -90,7 +90,7 @@ ___
▸ **isConnected**(): `BehaviorSubject`<`boolean`>
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-rx/src/index.ts#L66)*
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-rx/src/index.ts#L66)*
**Returns:** `BehaviorSubject`<`boolean`>
@@ -101,7 +101,7 @@ ___
▸ **on**(type: *`RpcRxInterface$Events`*, handler: *`function`*): `void`
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/64e3ca6/packages/rpc-rx/src/index.ts#L70)*
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/4748e8c/packages/rpc-rx/src/index.ts#L70)*
**Parameters:**
docs/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/type-extrinsics/modules/_frommetadata_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **fromMetadata**(metadata: *`Metadata`*): `Extrinsics`
*Defined in [fromMetadata.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-extrinsics/src/fromMetadata.ts#L19)*
*Defined in [fromMetadata.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-extrinsics/src/fromMetadata.ts#L19)*
Extend a storage object with the storage modules & module functions present in the metadata.
docs/type-extrinsics/modules/_utils_createunchecked_.md
+1 -1
View File
@@ -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/64e3ca6/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)*
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/4748e8c/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.
docs/type-jsonrpc/README.md
+1 -1
View File
@@ -4,7 +4,7 @@
A definition of all the methods exposed in a general Polkadot client application. These are used not only to provide a comprehensive code-generated document of the available methods, but are also used in the API to auto-generate endpoints with the required type-checking.
For a list of currently exposed methods, see the [method documentation](docs/README.md).
For a list of currently exposed methods, see the [method documentation](docs/METHODS_RPC.md).
Usage
-----
docs/type-jsonrpc/modules/_create_method_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): `RpcMethod`
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-jsonrpc/src/create/method.ts#L9)*
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-jsonrpc/src/create/method.ts#L9)*
**Parameters:**
docs/type-jsonrpc/modules/_create_param_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): `RpcParam`
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-jsonrpc/src/create/param.ts#L12)*
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-jsonrpc/src/create/param.ts#L12)*
**Parameters:**
docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md
+2 -2
View File
@@ -13,7 +13,7 @@
**● isUnhashed**: * `undefined` &#124; `false` &#124; `true`
*
*Defined in [utils/createFunction.ts:16](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/utils/createFunction.ts#L16)*
*Defined in [utils/createFunction.ts:16](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/utils/createFunction.ts#L16)*
___
<a id="method"></a>
@@ -23,7 +23,7 @@ ___
**● method**: * `undefined` &#124; `string`
*
*Defined in [utils/createFunction.ts:17](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/utils/createFunction.ts#L17)*
*Defined in [utils/createFunction.ts:17](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/utils/createFunction.ts#L17)*
___
docs/type-storage/modules/_frommetadata_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **fromMetadata**(metadata: *`Metadata`*): `Storage`
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/fromMetadata.ts#L20)*
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/fromMetadata.ts#L20)*
Extend a storage object with the storage modules & module functions present in the metadata.
docs/type-storage/modules/_storage_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**storage**: *`object`*
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/storage.ts#L8)*
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/storage.ts#L8)*
<a id="storage.substrate"></a>
@@ -16,7 +16,7 @@
**● substrate**: *[&quot;substrate&quot;](_substrate_.md)*
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/storage.ts#L9)*
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/storage.ts#L9)*
___
docs/type-storage/modules/_substrate_.md
+6 -6
View File
@@ -11,7 +11,7 @@
type: 'u32'
})
*Defined in [substrate.ts:44](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/substrate.ts#L44)*
*Defined in [substrate.ts:44](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/substrate.ts#L44)*
___
<a id="authorityprefix"></a>
@@ -23,7 +23,7 @@ ___
type: 'u32'
})
*Defined in [substrate.ts:49](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/substrate.ts#L49)*
*Defined in [substrate.ts:49](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/substrate.ts#L49)*
___
<a id="changestrieconfig"></a>
@@ -35,7 +35,7 @@ ___
type: 'u32'
})
*Defined in [substrate.ts:59](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/substrate.ts#L59)*
*Defined in [substrate.ts:59](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/substrate.ts#L59)*
___
<a id="code"></a>
@@ -47,7 +47,7 @@ ___
type: 'Bytes'
})
*Defined in [substrate.ts:34](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/substrate.ts#L34)*
*Defined in [substrate.ts:34](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/substrate.ts#L34)*
___
<a id="extrinsicindex"></a>
@@ -59,7 +59,7 @@ ___
type: 'u32'
})
*Defined in [substrate.ts:54](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/substrate.ts#L54)*
*Defined in [substrate.ts:54](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/substrate.ts#L54)*
___
<a id="heappages"></a>
@@ -71,7 +71,7 @@ ___
type: 'u64'
})
*Defined in [substrate.ts:39](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/substrate.ts#L39)*
*Defined in [substrate.ts:39](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/substrate.ts#L39)*
___
docs/type-storage/modules/_utils_createfunction_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createFunction**(section: *`Text`*, method: *`Text`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction`
*Defined in [utils/createFunction.ts:30](https://github.com/polkadot-js/api/blob/64e3ca6/packages/type-storage/src/utils/createFunction.ts#L30)*
*Defined in [utils/createFunction.ts:30](https://github.com/polkadot-js/api/blob/4748e8c/packages/type-storage/src/utils/createFunction.ts#L30)*
From the schema of a function in the module's storage, generate the function that will return the correct storage key.
docs/types/SUMMARY.md
+2
View File
@@ -175,3 +175,5 @@
* [TypeDefInfo](enums/_codec_createtype_.typedefinfo.md)
* [&quot;codec/index&quot;](modules/_codec_index_.md)
* [&quot;index&quot;](modules/_index_.md)
* [&quot;scripts/MetadataJsonDecode&quot;](modules/_scripts_metadatajsondecode_.md)
* [&quot;scripts/MetadataMd&quot;](modules/_scripts_metadatamd_.md)
docs/types/classes/_accountid_.accountid.md
+13 -13
View File
@@ -18,7 +18,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L20)*
*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L20)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -54,7 +54,7 @@ getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L33)*
**Returns:** `number`
@@ -72,7 +72,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L32)*
**Returns:** `number`
@@ -85,7 +85,7 @@ ___
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)*
*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L44)*
*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L44)*
**Parameters:**
@@ -104,7 +104,7 @@ ___
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)*
*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L50)*
*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L50)*
**Parameters:**
@@ -123,7 +123,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L53)*
**Returns:** `string`
@@ -136,7 +136,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L56)*
*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L56)*
**Returns:** `any`
@@ -149,7 +149,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L60)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L60)*
**Returns:** `string`
@@ -164,7 +164,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L61)*
**Parameters:**
@@ -181,7 +181,7 @@ ___
▸ **decodeAccountId**(value: *`AnyU8a`*): `Uint8Array`
*Defined in [AccountId.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L32)*
*Defined in [AccountId.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L32)*
**Parameters:**
@@ -200,7 +200,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
@@ -217,7 +217,7 @@ ___
▸ **encode**(value: *`Uint8Array`*): `string`
*Defined in [AccountId.ts:28](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L28)*
*Defined in [AccountId.ts:28](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L28)*
**Parameters:**
docs/types/classes/_accountindex_.accountindex.md
+14 -14
View File
@@ -16,7 +16,7 @@
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [AccountIndex.ts:15](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountIndex.ts#L15)*
*Defined in [AccountIndex.ts:15](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountIndex.ts#L15)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -52,7 +52,7 @@ getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L33)*
**Returns:** `number`
@@ -70,7 +70,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/U8a.ts:37](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L37)*
*Defined in [codec/U8a.ts:37](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L37)*
**Returns:** `number`
@@ -83,7 +83,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [AccountIndex.ts:57](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountIndex.ts#L57)*
*Defined in [AccountIndex.ts:57](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountIndex.ts#L57)*
**Parameters:**
@@ -102,7 +102,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [AccountIndex.ts:63](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountIndex.ts#L63)*
*Defined in [AccountIndex.ts:63](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountIndex.ts#L63)*
**Parameters:**
@@ -121,7 +121,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L53)*
**Returns:** `string`
@@ -134,7 +134,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountIndex.ts:71](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountIndex.ts#L71)*
*Defined in [AccountIndex.ts:71](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountIndex.ts#L71)*
**Returns:** `any`
@@ -147,7 +147,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountIndex.ts#L75)*
*Defined in [AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountIndex.ts#L75)*
**Returns:** `string`
@@ -162,7 +162,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L61)*
**Parameters:**
@@ -179,7 +179,7 @@ ___
▸ **decodeAccountIndex**(value: *`AnyU8a`*): `Uint8Array`
*Defined in [AccountIndex.ts:28](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountIndex.ts#L28)*
*Defined in [AccountIndex.ts:28](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountIndex.ts#L28)*
**Parameters:**
@@ -198,7 +198,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
@@ -215,7 +215,7 @@ ___
▸ **encode**(value: *`Uint8Array`*): `string`
*Defined in [AccountIndex.ts:24](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountIndex.ts#L24)*
*Defined in [AccountIndex.ts:24](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountIndex.ts#L24)*
**Parameters:**
@@ -232,7 +232,7 @@ ___
▸ **readLength**(input: *`Uint8Array`*): `number`
*Defined in [AccountIndex.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountIndex.ts#L41)*
*Defined in [AccountIndex.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountIndex.ts#L41)*
**Parameters:**
docs/types/classes/_address_.address.md
+9 -9
View File
@@ -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/64e3ca6/packages/types/src/Address.ts#L22)*
*Defined in [Address.ts:22](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Address.ts#L22)*
**Parameters:**
@@ -39,7 +39,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -53,7 +53,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [Address.ts:54](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Address.ts#L54)*
*Defined in [Address.ts:54](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Address.ts#L54)*
**Returns:** `number`
@@ -66,7 +66,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [Address.ts:62](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Address.ts#L62)*
*Defined in [Address.ts:62](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Address.ts#L62)*
**Parameters:**
@@ -85,7 +85,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [Address.ts:68](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Address.ts#L68)*
*Defined in [Address.ts:68](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Address.ts#L68)*
**Parameters:**
@@ -104,7 +104,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [Address.ts:76](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Address.ts#L76)*
*Defined in [Address.ts:76](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Address.ts#L76)*
**Returns:** `any`
@@ -117,7 +117,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [Address.ts:80](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Address.ts#L80)*
*Defined in [Address.ts:80](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Address.ts#L80)*
**Returns:** `string`
@@ -130,7 +130,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [Address.ts:84](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Address.ts#L84)*
*Defined in [Address.ts:84](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Address.ts#L84)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
▸ **decodeAddress**(value: * [Address](_address_.address.md) &#124; [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md) &#124; `AnyU8a`*): [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md)
*Defined in [Address.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Address.ts#L29)*
*Defined in [Address.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Address.ts#L29)*
**Parameters:**
docs/types/classes/_authorityid_.authorityid.md
+13 -13
View File
@@ -18,7 +18,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L20)*
*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L20)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -54,7 +54,7 @@ getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L33)*
**Returns:** `number`
@@ -72,7 +72,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L32)*
**Returns:** `number`
@@ -87,7 +87,7 @@ ___
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)*
*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L44)*
*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L44)*
**Parameters:**
@@ -108,7 +108,7 @@ ___
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)*
*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L50)*
*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L50)*
**Parameters:**
@@ -127,7 +127,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L53)*
**Returns:** `string`
@@ -142,7 +142,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L56)*
*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L56)*
**Returns:** `any`
@@ -157,7 +157,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L60)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L60)*
**Returns:** `string`
@@ -172,7 +172,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L61)*
**Parameters:**
@@ -191,7 +191,7 @@ ___
*Inherited from [AccountId](_accountid_.accountid.md).[decodeAccountId](_accountid_.accountid.md#decodeaccountid)*
*Defined in [AccountId.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L32)*
*Defined in [AccountId.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L32)*
**Parameters:**
@@ -210,7 +210,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
@@ -229,7 +229,7 @@ ___
*Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)*
*Defined in [AccountId.ts:28](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/AccountId.ts#L28)*
*Defined in [AccountId.ts:28](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/AccountId.ts#L28)*
**Parameters:**
docs/types/classes/_balance_.balance.md
+23 -23
View File
@@ -18,7 +18,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/U128.ts#L9)*
*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/U128.ts#L9)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -54,7 +54,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
@@ -75,7 +75,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L57)*
**Returns:** `number`
@@ -88,7 +88,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -126,7 +126,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L119)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -168,7 +168,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L67)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L67)*
**Parameters:**
@@ -187,7 +187,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -206,7 +206,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -225,7 +225,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L125)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L125)*
**Returns:** `boolean`
@@ -238,7 +238,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -257,7 +257,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -276,7 +276,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -295,7 +295,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L159)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L159)*
**Parameters:**
@@ -314,7 +314,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -327,7 +327,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -342,7 +342,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -355,7 +355,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -370,7 +370,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -385,7 +385,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L83)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L83)*
**Parameters:**
@@ -404,7 +404,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
docs/types/classes/_bft_.bftauthoritysignature.md
+17 -17
View File
@@ -21,7 +21,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:22](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bft.ts#L22)*
*Defined in [Bft.ts:22](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bft.ts#L22)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -57,7 +57,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -68,7 +68,7 @@ ___
getauthorityId(): [AuthorityId](_authorityid_.authorityid.md)
*Defined in [Bft.ts:30](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bft.ts#L30)*
*Defined in [Bft.ts:30](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bft.ts#L30)*
**Returns:** [AuthorityId](_authorityid_.authorityid.md)
@@ -79,7 +79,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:34](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bft.ts#L34)*
*Defined in [Bft.ts:34](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bft.ts#L34)*
**Returns:** [Signature](_signature_.signature.md)
@@ -97,7 +97,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L112)*
**Returns:** `number`
@@ -112,7 +112,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Defined in [codec/Tuple.ts:60](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L60)*
*Defined in [codec/Tuple.ts:60](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L60)*
**Parameters:**
@@ -133,7 +133,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L138)*
**Parameters:**
@@ -152,7 +152,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -171,7 +171,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -186,7 +186,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L72)*
**Returns:** `any`
@@ -201,7 +201,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -216,7 +216,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L167)*
**Parameters:**
@@ -235,7 +235,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
@@ -248,7 +248,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[decodeStruct](_codec_struct_.struct.md#decodestruct)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -273,7 +273,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[decodeTuple](_codec_tuple_.tuple.md#decodetuple)*
*Defined in [codec/Tuple.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L29)*
*Defined in [codec/Tuple.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L29)*
**Type parameters:**
@@ -299,7 +299,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Tuple.ts:50](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L50)*
*Defined in [codec/Tuple.ts:50](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L50)*
**Type parameters:**
docs/types/classes/_bft_.bfthashsignature.md
+17 -17
View File
@@ -21,7 +21,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:46](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bft.ts#L46)*
*Defined in [Bft.ts:46](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bft.ts#L46)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -57,7 +57,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -68,7 +68,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Bft.ts:54](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bft.ts#L54)*
*Defined in [Bft.ts:54](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bft.ts#L54)*
**Returns:** [Hash](_hash_.hash.md)
@@ -79,7 +79,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bft.ts#L58)*
*Defined in [Bft.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bft.ts#L58)*
**Returns:** [Signature](_signature_.signature.md)
@@ -97,7 +97,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L112)*
**Returns:** `number`
@@ -112,7 +112,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Defined in [codec/Tuple.ts:60](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L60)*
*Defined in [codec/Tuple.ts:60](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L60)*
**Parameters:**
@@ -133,7 +133,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L138)*
**Parameters:**
@@ -152,7 +152,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -171,7 +171,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -186,7 +186,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L72)*
**Returns:** `any`
@@ -201,7 +201,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -216,7 +216,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L167)*
**Parameters:**
@@ -235,7 +235,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
@@ -248,7 +248,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[decodeStruct](_codec_struct_.struct.md#decodestruct)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -273,7 +273,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[decodeTuple](_codec_tuple_.tuple.md#decodetuple)*
*Defined in [codec/Tuple.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L29)*
*Defined in [codec/Tuple.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L29)*
**Type parameters:**
@@ -299,7 +299,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Tuple.ts:50](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L50)*
*Defined in [codec/Tuple.ts:50](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L50)*
**Type parameters:**
docs/types/classes/_bft_.justification.md
+17 -17
View File
@@ -21,7 +21,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bft.ts#L69)*
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bft.ts#L69)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -57,7 +57,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -68,7 +68,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Bft.ts:80](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bft.ts#L80)*
*Defined in [Bft.ts:80](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bft.ts#L80)*
**Returns:** [Hash](_hash_.hash.md)
@@ -79,7 +79,7 @@ ___
getround(): [U32](_u32_.u32.md)
*Defined in [Bft.ts:84](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bft.ts#L84)*
*Defined in [Bft.ts:84](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bft.ts#L84)*
**Returns:** [U32](_u32_.u32.md)
@@ -90,7 +90,7 @@ ___
getsignatures(): [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)>
*Defined in [Bft.ts:88](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bft.ts#L88)*
*Defined in [Bft.ts:88](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bft.ts#L88)*
**Returns:** [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)>
@@ -108,7 +108,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L112)*
**Returns:** `number`
@@ -123,7 +123,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L118)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L118)*
**Parameters:**
@@ -144,7 +144,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L138)*
**Parameters:**
@@ -163,7 +163,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -182,7 +182,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -197,7 +197,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L152)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L152)*
**Returns:** `any`
@@ -212,7 +212,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -227,7 +227,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L167)*
**Parameters:**
@@ -246,7 +246,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
@@ -259,7 +259,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[decodeStruct](_codec_struct_.struct.md#decodestruct)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -284,7 +284,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L98)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/types/classes/_block_.block.md
+17 -17
View File
@@ -21,7 +21,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/64e3ca6/packages/types/src/Block.ts#L20)*
*Defined in [Block.ts:20](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Block.ts#L20)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -57,7 +57,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -68,7 +68,7 @@ ___
getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md)
*Defined in [Block.ts:28](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Block.ts#L28)*
*Defined in [Block.ts:28](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Block.ts#L28)*
**Returns:** [Extrinsics](_extrinsics_.extrinsics.md)
@@ -79,7 +79,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Block.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Block.ts#L33)*
*Defined in [Block.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Block.ts#L33)*
**Returns:** [Hash](_hash_.hash.md)
@@ -90,7 +90,7 @@ ___
getheader(): [Header](_header_.header.md)
*Defined in [Block.ts:39](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Block.ts#L39)*
*Defined in [Block.ts:39](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Block.ts#L39)*
**Returns:** [Header](_header_.header.md)
@@ -108,7 +108,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L112)*
**Returns:** `number`
@@ -123,7 +123,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L118)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L118)*
**Parameters:**
@@ -144,7 +144,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L138)*
**Parameters:**
@@ -163,7 +163,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -182,7 +182,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -197,7 +197,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L152)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L152)*
**Returns:** `any`
@@ -212,7 +212,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -227,7 +227,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L167)*
**Parameters:**
@@ -246,7 +246,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
@@ -259,7 +259,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[decodeStruct](_codec_struct_.struct.md#decodestruct)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -284,7 +284,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L98)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/types/classes/_blocknumber_.blocknumber.md
+23 -23
View File
@@ -18,7 +18,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/U64.ts#L9)*
*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/U64.ts#L9)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -54,7 +54,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
@@ -75,7 +75,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L57)*
**Returns:** `number`
@@ -88,7 +88,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -126,7 +126,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L119)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -168,7 +168,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L67)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L67)*
**Parameters:**
@@ -187,7 +187,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -206,7 +206,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -225,7 +225,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L125)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L125)*
**Returns:** `boolean`
@@ -238,7 +238,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -257,7 +257,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -276,7 +276,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -295,7 +295,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L159)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L159)*
**Parameters:**
@@ -314,7 +314,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -327,7 +327,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -342,7 +342,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -355,7 +355,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -370,7 +370,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -385,7 +385,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L83)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L83)*
**Parameters:**
@@ -404,7 +404,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
docs/types/classes/_bool_.bool.md
+9 -9
View File
@@ -16,7 +16,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [Bool.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bool.ts#L9)*
*Defined in [Bool.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bool.ts#L9)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -52,7 +52,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [Bool.ts:25](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bool.ts#L25)*
*Defined in [Bool.ts:25](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bool.ts#L25)*
**Returns:** `number`
@@ -65,7 +65,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [Bool.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bool.ts#L29)*
*Defined in [Bool.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bool.ts#L29)*
**Parameters:**
@@ -84,7 +84,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bool.ts#L35)*
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bool.ts#L35)*
**Parameters:**
@@ -103,7 +103,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [Bool.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bool.ts#L41)*
*Defined in [Bool.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bool.ts#L41)*
**Returns:** `any`
@@ -116,7 +116,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bool.ts#L49)*
*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bool.ts#L49)*
**Returns:** `string`
@@ -129,7 +129,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [Bool.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bool.ts#L45)*
*Defined in [Bool.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bool.ts#L45)*
**Parameters:**
@@ -146,7 +146,7 @@ ___
▸ **decodeBool**(value: *`any`*): `boolean`
*Defined in [Bool.ts:16](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bool.ts#L16)*
*Defined in [Bool.ts:16](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bool.ts#L16)*
**Parameters:**
docs/types/classes/_bytes_.bytes.md
+12 -12
View File
@@ -20,7 +20,7 @@
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bytes.ts#L18)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bytes.ts#L18)*
**Parameters:**
@@ -42,7 +42,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -56,7 +56,7 @@ getlength(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [Bytes.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bytes.ts#L45)*
*Defined in [Bytes.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bytes.ts#L45)*
**Returns:** `number`
@@ -72,7 +72,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [Bytes.ts:49](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bytes.ts#L49)*
*Defined in [Bytes.ts:49](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bytes.ts#L49)*
**Returns:** `number`
@@ -87,7 +87,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L41)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L41)*
**Parameters:**
@@ -106,7 +106,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [Bytes.ts:53](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bytes.ts#L53)*
*Defined in [Bytes.ts:53](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bytes.ts#L53)*
**Parameters:**
@@ -125,7 +125,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L53)*
**Returns:** `string`
@@ -140,7 +140,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `any`
@@ -155,7 +155,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L65)*
**Returns:** `string`
@@ -168,7 +168,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bytes.ts#L61)*
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bytes.ts#L61)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
▸ **decodeBytes**(value: *`AnyU8a`*): `Uint8Array`
*Defined in [Bytes.ts:23](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Bytes.ts#L23)*
*Defined in [Bytes.ts:23](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Bytes.ts#L23)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
docs/types/classes/_codec_base_.base.md
+8 -8
View File
@@ -40,7 +40,7 @@
⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md)
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
**Parameters:**
@@ -60,7 +60,7 @@ ___
**● raw**: *`T`*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -72,7 +72,7 @@ ___
▸ **byteLength**(): `number`
*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L25)*
*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L25)*
**Returns:** `number`
@@ -83,7 +83,7 @@ ___
▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<`T`>
*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L29)*
*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L29)*
**Parameters:**
@@ -100,7 +100,7 @@ ___
▸ **fromU8a**(input: *`Uint8Array`*): [Base](_codec_base_.base.md)<`T`>
*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L33)*
*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L33)*
**Parameters:**
@@ -117,7 +117,7 @@ ___
▸ **toJSON**(): `any`
*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L37)*
*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L37)*
**Returns:** `any`
@@ -128,7 +128,7 @@ ___
▸ **toString**(): `string`
*Defined in [codec/Base.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L41)*
*Defined in [codec/Base.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L41)*
**Returns:** `string`
@@ -139,7 +139,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L45)*
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L45)*
**Parameters:**
docs/types/classes/_codec_compact_.compact.md
+26 -26
View File
@@ -28,7 +28,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/UInt.ts:31](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L31)*
*Defined in [codec/UInt.ts:31](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L31)*
**Parameters:**
@@ -52,7 +52,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -66,7 +66,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
@@ -85,7 +85,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L86)*
**Returns:** `number`
@@ -98,7 +98,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
@@ -117,7 +117,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -136,7 +136,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L119)*
**Parameters:**
@@ -157,7 +157,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -176,7 +176,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L90)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L90)*
**Parameters:**
@@ -195,7 +195,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -214,7 +214,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -233,7 +233,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L125)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L125)*
**Returns:** `boolean`
@@ -246,7 +246,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -265,7 +265,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -284,7 +284,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -303,7 +303,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L159)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L159)*
**Parameters:**
@@ -322,7 +322,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -335,7 +335,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -350,7 +350,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -363,7 +363,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -378,7 +378,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -391,7 +391,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L98)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L98)*
**Parameters:**
@@ -408,7 +408,7 @@ ___
▸ **addLengthPrefix**(u8a: *`Uint8Array`*): `Uint8Array`
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L58)*
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L58)*
Prepend a Uint8Array with its compact length.
@@ -427,7 +427,7 @@ ___
▸ **decodeU8a**(_input: * `Uint8Array` &#124; `string`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): [`number`, `BN`]
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -447,7 +447,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -464,7 +464,7 @@ ___
▸ **encodeU8a**(_value: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*, bitLength: *[UIntBitLength](../modules/_codec_uint_.md#uintbitlength)*): `Uint8Array`
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L65)*
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L65)*
**Parameters:**
docs/types/classes/_codec_enum_.enum.md
+10 -10
View File
@@ -22,7 +22,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Enum.ts:21](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Enum.ts#L21)*
*Defined in [codec/Enum.ts:21](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Enum.ts#L21)*
**Parameters:**
@@ -45,7 +45,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -59,7 +59,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Enum.ts#L41)*
*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Enum.ts#L41)*
**Returns:** `number`
@@ -72,7 +72,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Enum.ts#L45)*
*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Enum.ts#L45)*
**Parameters:**
@@ -91,7 +91,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Enum.ts:52](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Enum.ts#L52)*
*Defined in [codec/Enum.ts:52](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Enum.ts#L52)*
**Parameters:**
@@ -110,7 +110,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Enum.ts:59](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Enum.ts#L59)*
*Defined in [codec/Enum.ts:59](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Enum.ts#L59)*
**Returns:** `any`
@@ -121,7 +121,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/Enum.ts:67](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Enum.ts#L67)*
*Defined in [codec/Enum.ts:67](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Enum.ts#L67)*
**Returns:** `number`
@@ -134,7 +134,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Enum.ts#L71)*
*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Enum.ts#L71)*
**Returns:** `string`
@@ -147,7 +147,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Enum.ts:63](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Enum.ts#L63)*
*Defined in [codec/Enum.ts:63](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Enum.ts#L63)*
**Parameters:**
@@ -164,7 +164,7 @@ ___
▸ **decodeEnum**(value?: * [Enum](_codec_enum_.enum.md) &#124; `number`*): `number`
*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Enum.ts#L31)*
*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Enum.ts#L31)*
**Parameters:**
docs/types/classes/_codec_enumtype_.enumtype.md
+12 -12
View File
@@ -24,7 +24,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/EnumType.ts:24](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L24)*
*Defined in [codec/EnumType.ts:24](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L24)*
**Parameters:**
@@ -48,7 +48,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -60,7 +60,7 @@ ___
gettype(): `string`
*Defined in [codec/EnumType.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L42)*
*Defined in [codec/EnumType.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L42)*
**Returns:** `string`
@@ -71,7 +71,7 @@ ___
getvalue(): [Base](_codec_base_.base.md)<`T`>
*Defined in [codec/EnumType.ts:46](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L46)*
*Defined in [codec/EnumType.ts:46](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L46)*
**Returns:** [Base](_codec_base_.base.md)<`T`>
@@ -87,7 +87,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/EnumType.ts:50](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L50)*
*Defined in [codec/EnumType.ts:50](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L50)*
**Returns:** `number`
@@ -100,7 +100,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/EnumType.ts:54](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L54)*
*Defined in [codec/EnumType.ts:54](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L54)*
**Parameters:**
@@ -119,7 +119,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/EnumType.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L73)*
*Defined in [codec/EnumType.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L73)*
**Parameters:**
@@ -136,7 +136,7 @@ ___
▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)<`T`> &#124; `number`*, value?: *`any`*): `void`
*Defined in [codec/EnumType.ts:80](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L80)*
*Defined in [codec/EnumType.ts:80](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L80)*
**Parameters:**
@@ -156,7 +156,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L97)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L97)*
**Returns:** `any`
@@ -167,7 +167,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L101)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L101)*
**Returns:** `number`
@@ -180,7 +180,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/EnumType.ts:105](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L105)*
*Defined in [codec/EnumType.ts:105](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L105)*
**Returns:** `string`
@@ -193,7 +193,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L45)*
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L45)*
**Parameters:**
docs/types/classes/_codec_option_.option.md
+12 -12
View File
@@ -18,7 +18,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Option.ts:16](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Option.ts#L16)*
*Defined in [codec/Option.ts:16](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Option.ts#L16)*
**Parameters:**
@@ -41,7 +41,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -53,7 +53,7 @@ ___
getisEmpty(): `boolean`
*Defined in [codec/Option.ts:46](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Option.ts#L46)*
*Defined in [codec/Option.ts:46](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Option.ts#L46)*
**Returns:** `boolean`
@@ -64,7 +64,7 @@ ___
getvalue(): `T` &#124; `undefined`
*Defined in [codec/Option.ts:50](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Option.ts#L50)*
*Defined in [codec/Option.ts:50](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Option.ts#L50)*
**Returns:** `T` &#124; `undefined`
@@ -80,7 +80,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Option.ts:56](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Option.ts#L56)*
*Defined in [codec/Option.ts:56](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Option.ts#L56)*
**Returns:** `number`
@@ -93,7 +93,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Option.ts:64](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Option.ts#L64)*
*Defined in [codec/Option.ts:64](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Option.ts#L64)*
**Parameters:**
@@ -112,7 +112,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Option.ts#L74)*
*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Option.ts#L74)*
**Parameters:**
@@ -131,7 +131,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Option.ts:84](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Option.ts#L84)*
*Defined in [codec/Option.ts:84](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Option.ts#L84)*
**Returns:** `any`
@@ -144,7 +144,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Option.ts:105](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Option.ts#L105)*
*Defined in [codec/Option.ts:105](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Option.ts#L105)*
**Returns:** `string`
@@ -157,7 +157,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Option.ts:90](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Option.ts#L90)*
*Defined in [codec/Option.ts:90](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Option.ts#L90)*
**Parameters:**
@@ -174,7 +174,7 @@ ___
▸ **decodeOption**<`O`>(Type: *`object`*, value?: *`any`*): [Base](_codec_base_.base.md)<`O`>
*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Option.ts#L26)*
*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Option.ts#L26)*
**Type parameters:**
@@ -195,7 +195,7 @@ ___
▸ **with**<`O`>(Type: *`object`*): `object`
*Defined in [codec/Option.ts:38](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Option.ts#L38)*
*Defined in [codec/Option.ts:38](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Option.ts#L38)*
**Type parameters:**
docs/types/classes/_codec_struct_.struct.md
+14 -14
View File
@@ -77,7 +77,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Struct.ts:30](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L30)*
*Defined in [codec/Struct.ts:30](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L30)*
**Parameters:**
@@ -101,7 +101,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -113,7 +113,7 @@ ___
getType(): `E`
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -129,7 +129,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L112)*
**Returns:** `number`
@@ -142,7 +142,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L118)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L118)*
**Parameters:**
@@ -161,7 +161,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L138)*
**Parameters:**
@@ -178,7 +178,7 @@ ___
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -195,7 +195,7 @@ ___
▸ **keys**(): `Array`<`string`>
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -208,7 +208,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L152)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L152)*
**Returns:** `any`
@@ -221,7 +221,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -234,7 +234,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L167)*
**Parameters:**
@@ -251,7 +251,7 @@ ___
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
@@ -262,7 +262,7 @@ ___
▸ **decodeStruct**<`S`,`V`,`T`>(Types: *`S`*, value: *`any`*): `T`
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -285,7 +285,7 @@ ___
▸ **with**<`S`>(Types: *`S`*): `object`
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L98)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/types/classes/_codec_tuple_.tuple.md
+15 -15
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L24)*
*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L24)*
**Parameters:**
@@ -53,7 +53,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -67,7 +67,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -85,7 +85,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L112)*
**Returns:** `number`
@@ -98,7 +98,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Defined in [codec/Tuple.ts:60](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L60)*
*Defined in [codec/Tuple.ts:60](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L60)*
**Parameters:**
@@ -119,7 +119,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L138)*
**Parameters:**
@@ -138,7 +138,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -157,7 +157,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -170,7 +170,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L72)*
**Returns:** `any`
@@ -185,7 +185,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -200,7 +200,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L167)*
**Parameters:**
@@ -219,7 +219,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
@@ -232,7 +232,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[decodeStruct](_codec_struct_.struct.md#decodestruct)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -255,7 +255,7 @@ ___
▸ **decodeTuple**<`S`,`V`>(Types: *`S`*, _value: * `V` &#124; `AnyU8a`*): `V`
*Defined in [codec/Tuple.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L29)*
*Defined in [codec/Tuple.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L29)*
**Type parameters:**
@@ -279,7 +279,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Tuple.ts:50](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Tuple.ts#L50)*
*Defined in [codec/Tuple.ts:50](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Tuple.ts#L50)*
**Type parameters:**
docs/types/classes/_codec_u8a_.u8a.md
+11 -11
View File
@@ -22,7 +22,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/U8a.ts:16](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L16)*
*Defined in [codec/U8a.ts:16](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L16)*
**Parameters:**
@@ -44,7 +44,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -56,7 +56,7 @@ ___
getlength(): `number`
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L33)*
**Returns:** `number`
@@ -72,7 +72,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/U8a.ts:37](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L37)*
*Defined in [codec/U8a.ts:37](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L37)*
**Returns:** `number`
@@ -85,7 +85,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L41)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L41)*
**Parameters:**
@@ -104,7 +104,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L47)*
*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L47)*
**Parameters:**
@@ -121,7 +121,7 @@ ___
▸ **toHex**(): `string`
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L53)*
**Returns:** `string`
@@ -134,7 +134,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `any`
@@ -147,7 +147,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L65)*
**Returns:** `string`
@@ -160,7 +160,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L61)*
**Parameters:**
@@ -177,7 +177,7 @@ ___
▸ **decodeU8a**(value: *`any`*): `Uint8Array`
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
docs/types/classes/_codec_u8afixed_.u8afixed.md
+11 -11
View File
@@ -26,7 +26,7 @@
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L14)*
*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L14)*
**Parameters:**
@@ -49,7 +49,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -63,7 +63,7 @@ getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L33)*
**Returns:** `number`
@@ -79,7 +79,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L32)*
**Returns:** `number`
@@ -92,7 +92,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L36)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L36)*
**Parameters:**
@@ -111,7 +111,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L44)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L44)*
**Parameters:**
@@ -130,7 +130,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L53)*
**Returns:** `string`
@@ -145,7 +145,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `any`
@@ -160,7 +160,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L65)*
**Returns:** `string`
@@ -175,7 +175,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L61)*
**Parameters:**
@@ -194,7 +194,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
docs/types/classes/_codec_uint_.uint.md
+23 -23
View File
@@ -30,7 +30,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/UInt.ts:31](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L31)*
*Defined in [codec/UInt.ts:31](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L31)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -66,7 +66,7 @@ ___
▸ **add**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
@@ -85,7 +85,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L57)*
**Returns:** `number`
@@ -96,7 +96,7 @@ ___
▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `number`
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
@@ -113,7 +113,7 @@ ___
▸ **div**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -130,7 +130,7 @@ ___
▸ **eq**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L119)*
**Parameters:**
@@ -149,7 +149,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -168,7 +168,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L67)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L67)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
▸ **gt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -202,7 +202,7 @@ ___
▸ **gte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -219,7 +219,7 @@ ___
▸ **isZero**(): `boolean`
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L125)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L125)*
**Returns:** `boolean`
@@ -230,7 +230,7 @@ ___
▸ **lt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -247,7 +247,7 @@ ___
▸ **lte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -264,7 +264,7 @@ ___
▸ **mul**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -281,7 +281,7 @@ ___
▸ **sub**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L159)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L159)*
**Parameters:**
@@ -298,7 +298,7 @@ ___
▸ **toBn**(): `BN`
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -309,7 +309,7 @@ ___
▸ **toHex**(): `string`
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -322,7 +322,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -333,7 +333,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -346,7 +346,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -359,7 +359,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L83)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L83)*
**Parameters:**
@@ -376,7 +376,7 @@ ___
▸ **decodeUInt**(value: *`AnyNumber`*): `BN`
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
docs/types/classes/_codec_vector_.vector.md
+19 -19
View File
@@ -22,7 +22,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L19)*
*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L19)*
**Parameters:**
@@ -45,7 +45,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -57,7 +57,7 @@ ___
getType(): `string`
*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L66)*
*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L66)*
**Returns:** `string`
@@ -68,7 +68,7 @@ ___
getlength(): `number`
*Defined in [codec/Vector.ts:70](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L70)*
*Defined in [codec/Vector.ts:70](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L70)*
**Returns:** `number`
@@ -84,7 +84,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Vector.ts:74](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L74)*
*Defined in [codec/Vector.ts:74](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L74)*
**Returns:** `number`
@@ -95,7 +95,7 @@ ___
▸ **filter**(fn: *`function`*): `Array`<`T`>
*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L80)*
*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L80)*
**Parameters:**
@@ -112,7 +112,7 @@ ___
▸ **find**(fn: *`function`*): `T` &#124; `undefined`
*Defined in [codec/Vector.ts:84](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L84)*
*Defined in [codec/Vector.ts:84](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L84)*
**Parameters:**
@@ -129,7 +129,7 @@ ___
▸ **forEach**(fn: *`function`*): `any`
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L88)*
**Parameters:**
@@ -148,7 +148,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Vector.ts:92](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L92)*
*Defined in [codec/Vector.ts:92](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L92)*
**Parameters:**
@@ -167,7 +167,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L101)*
*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L101)*
**Parameters:**
@@ -184,7 +184,7 @@ ___
▸ **get**(index: *`number`*): `T`
*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L107)*
*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L107)*
**Parameters:**
@@ -201,7 +201,7 @@ ___
▸ **map**<`O`>(fn: *`function`*): `Array`<`O`>
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L111)*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L111)*
**Type parameters:**
@@ -221,7 +221,7 @@ ___
▸ **push**(item: *`T`*): `void`
*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L115)*
*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L115)*
**Parameters:**
@@ -238,7 +238,7 @@ ___
▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O`
*Defined in [codec/Vector.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L119)*
*Defined in [codec/Vector.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L119)*
**Type parameters:**
@@ -261,7 +261,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L123)*
*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L123)*
**Returns:** `any`
@@ -274,7 +274,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Vector.ts:142](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L142)*
*Defined in [codec/Vector.ts:142](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L142)*
**Returns:** `string`
@@ -287,7 +287,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L129)*
*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L129)*
**Parameters:**
@@ -304,7 +304,7 @@ ___
▸ **decode**<`T`>(Type: *`object`*, value: * `Uint8Array` &#124; `string` &#124; `Array`<`any`>*): `Array`<`T`>
*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L29)*
*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L29)*
**Type parameters:**
@@ -325,7 +325,7 @@ ___
▸ **with**<`O`>(Type: *`object`*): `object`
*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L58)*
*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L58)*
**Type parameters:**
docs/types/classes/_compact128_.compact128.md
+26 -26
View File
@@ -16,7 +16,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [Compact128.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Compact128.ts#L9)*
*Defined in [Compact128.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Compact128.ts#L9)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -52,7 +52,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
@@ -73,7 +73,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L86)*
**Returns:** `number`
@@ -86,7 +86,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
@@ -105,7 +105,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L119)*
**Parameters:**
@@ -145,7 +145,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -166,7 +166,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L90)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L90)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -223,7 +223,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L125)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L125)*
**Returns:** `boolean`
@@ -236,7 +236,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -255,7 +255,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -274,7 +274,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -293,7 +293,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L159)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L159)*
**Parameters:**
@@ -312,7 +312,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -325,7 +325,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -340,7 +340,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -353,7 +353,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -368,7 +368,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -383,7 +383,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L98)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L98)*
**Parameters:**
@@ -402,7 +402,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[addLengthPrefix](_codec_compact_.compact.md#addlengthprefix)*
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L58)*
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L58)*
Prepend a Uint8Array with its compact length.
@@ -423,7 +423,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[decodeU8a](_codec_compact_.compact.md#decodeu8a)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -443,7 +443,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -462,7 +462,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)*
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L65)*
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L65)*
**Parameters:**
docs/types/classes/_compact16_.compact16.md
+26 -26
View File
@@ -16,7 +16,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [Compact16.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Compact16.ts#L9)*
*Defined in [Compact16.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Compact16.ts#L9)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -52,7 +52,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
@@ -73,7 +73,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L86)*
**Returns:** `number`
@@ -86,7 +86,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
@@ -105,7 +105,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L119)*
**Parameters:**
@@ -145,7 +145,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -166,7 +166,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L90)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L90)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -223,7 +223,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L125)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L125)*
**Returns:** `boolean`
@@ -236,7 +236,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -255,7 +255,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -274,7 +274,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -293,7 +293,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L159)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L159)*
**Parameters:**
@@ -312,7 +312,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -325,7 +325,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -340,7 +340,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -353,7 +353,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -368,7 +368,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -383,7 +383,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L98)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L98)*
**Parameters:**
@@ -402,7 +402,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[addLengthPrefix](_codec_compact_.compact.md#addlengthprefix)*
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L58)*
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L58)*
Prepend a Uint8Array with its compact length.
@@ -423,7 +423,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[decodeU8a](_codec_compact_.compact.md#decodeu8a)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -443,7 +443,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -462,7 +462,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)*
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L65)*
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L65)*
**Parameters:**
docs/types/classes/_compact256_.compact256.md
+26 -26
View File
@@ -16,7 +16,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [Compact256.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Compact256.ts#L9)*
*Defined in [Compact256.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Compact256.ts#L9)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -52,7 +52,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
@@ -73,7 +73,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L86)*
**Returns:** `number`
@@ -86,7 +86,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
@@ -105,7 +105,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L119)*
**Parameters:**
@@ -145,7 +145,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -166,7 +166,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L90)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L90)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -223,7 +223,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L125)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L125)*
**Returns:** `boolean`
@@ -236,7 +236,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -255,7 +255,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -274,7 +274,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -293,7 +293,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L159)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L159)*
**Parameters:**
@@ -312,7 +312,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -325,7 +325,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -340,7 +340,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -353,7 +353,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -368,7 +368,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -383,7 +383,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L98)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L98)*
**Parameters:**
@@ -402,7 +402,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[addLengthPrefix](_codec_compact_.compact.md#addlengthprefix)*
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L58)*
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L58)*
Prepend a Uint8Array with its compact length.
@@ -423,7 +423,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[decodeU8a](_codec_compact_.compact.md#decodeu8a)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -443,7 +443,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -462,7 +462,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)*
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L65)*
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L65)*
**Parameters:**
docs/types/classes/_compact32_.compact32.md
+26 -26
View File
@@ -16,7 +16,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [Compact32.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Compact32.ts#L9)*
*Defined in [Compact32.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Compact32.ts#L9)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -52,7 +52,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
@@ -73,7 +73,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L86)*
**Returns:** `number`
@@ -86,7 +86,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
@@ -105,7 +105,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L119)*
**Parameters:**
@@ -145,7 +145,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -166,7 +166,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L90)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L90)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -223,7 +223,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L125)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L125)*
**Returns:** `boolean`
@@ -236,7 +236,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -255,7 +255,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -274,7 +274,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -293,7 +293,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L159)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L159)*
**Parameters:**
@@ -312,7 +312,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -325,7 +325,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -340,7 +340,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -353,7 +353,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -368,7 +368,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -383,7 +383,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L98)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L98)*
**Parameters:**
@@ -402,7 +402,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[addLengthPrefix](_codec_compact_.compact.md#addlengthprefix)*
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L58)*
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L58)*
Prepend a Uint8Array with its compact length.
@@ -423,7 +423,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[decodeU8a](_codec_compact_.compact.md#decodeu8a)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -443,7 +443,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -462,7 +462,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)*
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L65)*
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L65)*
**Parameters:**
docs/types/classes/_compact64_.compact64.md
+26 -26
View File
@@ -16,7 +16,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [Compact64.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Compact64.ts#L9)*
*Defined in [Compact64.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Compact64.ts#L9)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -52,7 +52,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
@@ -73,7 +73,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L86)*
**Returns:** `number`
@@ -86,7 +86,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
@@ -105,7 +105,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L119)*
**Parameters:**
@@ -145,7 +145,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -166,7 +166,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L90)*
*Defined in [codec/Compact.ts:90](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L90)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -223,7 +223,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L125)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L125)*
**Returns:** `boolean`
@@ -236,7 +236,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -255,7 +255,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -274,7 +274,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -293,7 +293,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L159)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L159)*
**Parameters:**
@@ -312,7 +312,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -325,7 +325,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -340,7 +340,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -353,7 +353,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -368,7 +368,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -383,7 +383,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L98)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L98)*
**Parameters:**
@@ -402,7 +402,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[addLengthPrefix](_codec_compact_.compact.md#addlengthprefix)*
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L58)*
*Defined in [codec/Compact.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L58)*
Prepend a Uint8Array with its compact length.
@@ -423,7 +423,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[decodeU8a](_codec_compact_.compact.md#decodeu8a)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -443,7 +443,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -462,7 +462,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)*
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Compact.ts#L65)*
*Defined in [codec/Compact.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Compact.ts#L65)*
**Parameters:**
docs/types/classes/_extrinsic_.extrinsic.md
+25 -25
View File
@@ -30,7 +30,7 @@ Can be:
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Extrinsic.ts:37](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L37)*
*Defined in [Extrinsic.ts:37](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L37)*
**Parameters:**
@@ -52,7 +52,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -66,7 +66,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -77,7 +77,7 @@ ___
getcallIndex(): `Uint8Array`
*Defined in [Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L70)*
*Defined in [Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L70)*
**Returns:** `Uint8Array`
@@ -88,7 +88,7 @@ ___
getdata(): `Uint8Array`
*Defined in [Extrinsic.ts:74](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L74)*
*Defined in [Extrinsic.ts:74](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L74)*
**Returns:** `Uint8Array`
@@ -99,7 +99,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L79)*
*Defined in [Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L79)*
**Returns:** [Hash](_hash_.hash.md)
@@ -110,7 +110,7 @@ ___
getisSigned(): `boolean`
*Defined in [Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L85)*
*Defined in [Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L85)*
**Returns:** `boolean`
@@ -121,7 +121,7 @@ ___
getlength(): `number`
*Defined in [Extrinsic.ts:89](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L89)*
*Defined in [Extrinsic.ts:89](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L89)*
**Returns:** `number`
@@ -132,7 +132,7 @@ ___
getmeta(): [FunctionMetadata](_metadata_.functionmetadata.md)
*Defined in [Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L93)*
*Defined in [Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L93)*
**Returns:** [FunctionMetadata](_metadata_.functionmetadata.md)
@@ -143,7 +143,7 @@ ___
getmethod(): [Method](_method_.method.md)
*Defined in [Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L97)*
*Defined in [Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L97)*
**Returns:** [Method](_method_.method.md)
@@ -154,7 +154,7 @@ ___
getsignature(): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md)
*Defined in [Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L101)*
*Defined in [Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L101)*
**Returns:** [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md)
@@ -170,7 +170,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Defined in [Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L105)*
*Defined in [Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L105)*
**Returns:** `number`
@@ -183,7 +183,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Defined in [Extrinsic.ts:111](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L111)*
*Defined in [Extrinsic.ts:111](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L111)*
**Parameters:**
@@ -202,7 +202,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Defined in [Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L117)*
*Defined in [Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L117)*
**Parameters:**
@@ -221,7 +221,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -240,7 +240,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -251,7 +251,7 @@ ___
▸ **sign**(signerPair: *`KeyringPair`*, nonce: *`AnyNumber`*, blockHash: *`AnyU8a`*): [Extrinsic](_extrinsic_.extrinsic.md)
*Defined in [Extrinsic.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L125)*
*Defined in [Extrinsic.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L125)*
**Parameters:**
@@ -270,7 +270,7 @@ ___
▸ **toHex**(): `string`
*Defined in [Extrinsic.ts:142](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L142)*
*Defined in [Extrinsic.ts:142](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L142)*
**Returns:** `string`
@@ -283,7 +283,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [Extrinsic.ts:146](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L146)*
*Defined in [Extrinsic.ts:146](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L146)*
**Returns:** `any`
@@ -298,7 +298,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -311,7 +311,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L131)*
*Defined in [Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L131)*
**Parameters:**
@@ -330,7 +330,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
@@ -341,7 +341,7 @@ ___
▸ **decodeExtrinsic**(value?: * `ExtrinsicValue` &#124; `AnyU8a`*): `any` &#124; `Uint8Array`
*Defined in [Extrinsic.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Extrinsic.ts#L45)*
*Defined in [Extrinsic.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Extrinsic.ts#L45)*
**Parameters:**
@@ -360,7 +360,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[decodeStruct](_codec_struct_.struct.md#decodestruct)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -385,7 +385,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L98)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/types/classes/_extrinsicera_.extrinsicera.md
+11 -11
View File
@@ -16,7 +16,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [ExtrinsicEra.ts:11](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicEra.ts#L11)*
*Defined in [ExtrinsicEra.ts:11](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicEra.ts#L11)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -52,7 +52,7 @@ getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L33)*
**Returns:** `number`
@@ -70,7 +70,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L32)*
**Returns:** `number`
@@ -85,7 +85,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L36)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L36)*
**Parameters:**
@@ -106,7 +106,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L44)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L44)*
**Parameters:**
@@ -125,7 +125,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L53)*
**Returns:** `string`
@@ -140,7 +140,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `any`
@@ -155,7 +155,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L65)*
**Returns:** `string`
@@ -170,7 +170,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L61)*
**Parameters:**
@@ -189,7 +189,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
docs/types/classes/_extrinsics_.extrinsics.md
+19 -19
View File
@@ -22,7 +22,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L19)*
*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L19)*
**Parameters:**
@@ -45,7 +45,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -59,7 +59,7 @@ getType(): `string`
*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)*
*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L66)*
*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L66)*
**Returns:** `string`
@@ -72,7 +72,7 @@ getlength(): `number`
*Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)*
*Defined in [codec/Vector.ts:70](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L70)*
*Defined in [codec/Vector.ts:70](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L70)*
**Returns:** `number`
@@ -90,7 +90,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Vector.ts:74](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L74)*
*Defined in [codec/Vector.ts:74](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L74)*
**Returns:** `number`
@@ -103,7 +103,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)*
*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L80)*
*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L80)*
**Parameters:**
@@ -122,7 +122,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)*
*Defined in [codec/Vector.ts:84](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L84)*
*Defined in [codec/Vector.ts:84](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L84)*
**Parameters:**
@@ -141,7 +141,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L88)*
**Parameters:**
@@ -162,7 +162,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Vector.ts:92](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L92)*
*Defined in [codec/Vector.ts:92](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L92)*
**Parameters:**
@@ -183,7 +183,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L101)*
*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L101)*
**Parameters:**
@@ -202,7 +202,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)*
*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L107)*
*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L107)*
**Parameters:**
@@ -221,7 +221,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L111)*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L111)*
**Type parameters:**
@@ -243,7 +243,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)*
*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L115)*
*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L115)*
**Parameters:**
@@ -262,7 +262,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)*
*Defined in [codec/Vector.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L119)*
*Defined in [codec/Vector.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L119)*
**Type parameters:**
@@ -287,7 +287,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L123)*
*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L123)*
**Returns:** `any`
@@ -302,7 +302,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Vector.ts:142](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L142)*
*Defined in [codec/Vector.ts:142](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L142)*
**Returns:** `string`
@@ -317,7 +317,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L129)*
*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L129)*
**Parameters:**
@@ -336,7 +336,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[decode](_codec_vector_.vector.md#decode)*
*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L29)*
*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L29)*
**Type parameters:**
@@ -359,7 +359,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)*
*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L58)*
*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L58)*
**Type parameters:**
docs/types/classes/_extrinsicsignature_.extrinsicsignature.md
+22 -22
View File
@@ -21,7 +21,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [ExtrinsicSignature.ts:37](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L37)*
*Defined in [ExtrinsicSignature.ts:37](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L37)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -57,7 +57,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -68,7 +68,7 @@ ___
getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md)
*Defined in [ExtrinsicSignature.ts:77](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L77)*
*Defined in [ExtrinsicSignature.ts:77](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L77)*
**Returns:** [ExtrinsicEra](_extrinsicera_.extrinsicera.md)
@@ -79,7 +79,7 @@ ___
getisSigned(): `boolean`
*Defined in [ExtrinsicSignature.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L73)*
*Defined in [ExtrinsicSignature.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L73)*
**Returns:** `boolean`
@@ -90,7 +90,7 @@ ___
getnonce(): `Nonce`
*Defined in [ExtrinsicSignature.ts:81](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L81)*
*Defined in [ExtrinsicSignature.ts:81](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L81)*
**Returns:** `Nonce`
@@ -101,7 +101,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [ExtrinsicSignature.ts:85](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L85)*
*Defined in [ExtrinsicSignature.ts:85](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L85)*
**Returns:** [Signature](_signature_.signature.md)
@@ -112,7 +112,7 @@ ___
getsigner(): [Address](_address_.address.md)
*Defined in [ExtrinsicSignature.ts:89](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L89)*
*Defined in [ExtrinsicSignature.ts:89](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L89)*
**Returns:** [Address](_address_.address.md)
@@ -123,7 +123,7 @@ ___
getversion(): `number`
*Defined in [ExtrinsicSignature.ts:93](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L93)*
*Defined in [ExtrinsicSignature.ts:93](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L93)*
**Returns:** `number`
@@ -137,7 +137,7 @@ ___
▸ **addSignature**(method: *[Method](_method_.method.md)*, signerPair: *`KeyringPair`*, nonce: *`AnyNumber`*, blockHash: *`AnyU8a`*, era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md)
*Defined in [ExtrinsicSignature.ts:105](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L105)*
*Defined in [ExtrinsicSignature.ts:105](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L105)*
**Parameters:**
@@ -160,7 +160,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Defined in [ExtrinsicSignature.ts:64](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L64)*
*Defined in [ExtrinsicSignature.ts:64](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L64)*
**Returns:** `number`
@@ -175,7 +175,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L118)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L118)*
**Parameters:**
@@ -194,7 +194,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Defined in [ExtrinsicSignature.ts:124](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L124)*
*Defined in [ExtrinsicSignature.ts:124](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L124)*
**Parameters:**
@@ -213,7 +213,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -232,7 +232,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -247,7 +247,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L152)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L152)*
**Returns:** `any`
@@ -262,7 +262,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -275,7 +275,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [ExtrinsicSignature.ts:137](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L137)*
*Defined in [ExtrinsicSignature.ts:137](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L137)*
**Parameters:**
@@ -294,7 +294,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
@@ -305,7 +305,7 @@ ___
▸ **decodeExtrinsicSignature**(value: * [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) &#124; `ExtrinsicSignatureValue` &#124; `AnyU8a` &#124; `undefined`*): `any` &#124; `Uint8Array`
*Defined in [ExtrinsicSignature.ts:47](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicSignature.ts#L47)*
*Defined in [ExtrinsicSignature.ts:47](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicSignature.ts#L47)*
**Parameters:**
@@ -324,7 +324,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[decodeStruct](_codec_struct_.struct.md#decodestruct)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -349,7 +349,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Struct.ts#L98)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/types/classes/_extrinsicstatus_.broadcast.md
+19 -19
View File
@@ -20,7 +20,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L19)*
*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L19)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -57,7 +57,7 @@ getType(): `string`
*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)*
*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L66)*
*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L66)*
**Returns:** `string`
@@ -70,7 +70,7 @@ getlength(): `number`
*Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)*
*Defined in [codec/Vector.ts:70](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L70)*
*Defined in [codec/Vector.ts:70](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L70)*
**Returns:** `number`
@@ -88,7 +88,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Vector.ts:74](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L74)*
*Defined in [codec/Vector.ts:74](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L74)*
**Returns:** `number`
@@ -101,7 +101,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)*
*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L80)*
*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L80)*
**Parameters:**
@@ -120,7 +120,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)*
*Defined in [codec/Vector.ts:84](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L84)*
*Defined in [codec/Vector.ts:84](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L84)*
**Parameters:**
@@ -139,7 +139,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L88)*
**Parameters:**
@@ -160,7 +160,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Vector.ts:92](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L92)*
*Defined in [codec/Vector.ts:92](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L92)*
**Parameters:**
@@ -181,7 +181,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L101)*
*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L101)*
**Parameters:**
@@ -200,7 +200,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)*
*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L107)*
*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L107)*
**Parameters:**
@@ -219,7 +219,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L111)*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L111)*
**Type parameters:**
@@ -241,7 +241,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)*
*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L115)*
*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L115)*
**Parameters:**
@@ -260,7 +260,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)*
*Defined in [codec/Vector.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L119)*
*Defined in [codec/Vector.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L119)*
**Type parameters:**
@@ -285,7 +285,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L123)*
*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L123)*
**Returns:** `any`
@@ -300,7 +300,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Vector.ts:142](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L142)*
*Defined in [codec/Vector.ts:142](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L142)*
**Returns:** `string`
@@ -315,7 +315,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L129)*
*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L129)*
**Parameters:**
@@ -334,7 +334,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[decode](_codec_vector_.vector.md#decode)*
*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L29)*
*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L29)*
**Type parameters:**
@@ -357,7 +357,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)*
*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Vector.ts#L58)*
*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Vector.ts#L58)*
**Type parameters:**
docs/types/classes/_extrinsicstatus_.dropped.md
+8 -8
View File
@@ -18,7 +18,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [Null.ts:8](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Null.ts#L8)*
*Defined in [Null.ts:8](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Null.ts#L8)*
**Returns:** [Dropped](_extrinsicstatus_.dropped.md)
@@ -34,7 +34,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -50,7 +50,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [Null.ts:13](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Null.ts#L13)*
*Defined in [Null.ts:13](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Null.ts#L13)*
**Returns:** `number`
@@ -65,7 +65,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Null.ts#L17)*
*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Null.ts#L17)*
**Parameters:**
@@ -86,7 +86,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [Null.ts:21](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Null.ts#L21)*
*Defined in [Null.ts:21](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Null.ts#L21)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [Null.ts:25](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Null.ts#L25)*
*Defined in [Null.ts:25](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Null.ts#L25)*
**Returns:** `any`
@@ -122,7 +122,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [Null.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Null.ts#L33)*
*Defined in [Null.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Null.ts#L33)*
**Returns:** `string`
@@ -137,7 +137,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [Null.ts:29](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/Null.ts#L29)*
*Defined in [Null.ts:29](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/Null.ts#L29)*
**Parameters:**
docs/types/classes/_extrinsicstatus_.extrinsicstatus.md
+12 -12
View File
@@ -16,7 +16,7 @@
*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)*
*Defined in [ExtrinsicStatus.ts:23](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/ExtrinsicStatus.ts#L23)*
*Defined in [ExtrinsicStatus.ts:23](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/ExtrinsicStatus.ts#L23)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -52,7 +52,7 @@ gettype(): `string`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)*
*Defined in [codec/EnumType.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L42)*
*Defined in [codec/EnumType.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L42)*
**Returns:** `string`
@@ -65,7 +65,7 @@ getvalue(): [Base](_codec_base_.base.md)< [Finalised](_extrinsicstatus_.finalise
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)*
*Defined in [codec/EnumType.ts:46](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L46)*
*Defined in [codec/EnumType.ts:46](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L46)*
**Returns:** [Base](_codec_base_.base.md)< [Finalised](_extrinsicstatus_.finalised.md) &#124; [Usurped](_extrinsicstatus_.usurped.md) &#124; [Broadcast](_extrinsicstatus_.broadcast.md) &#124; [Dropped](_extrinsicstatus_.dropped.md)>
@@ -83,7 +83,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/EnumType.ts:50](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L50)*
*Defined in [codec/EnumType.ts:50](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L50)*
**Returns:** `number`
@@ -98,7 +98,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/EnumType.ts:54](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L54)*
*Defined in [codec/EnumType.ts:54](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L54)*
**Parameters:**
@@ -119,7 +119,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/EnumType.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L73)*
*Defined in [codec/EnumType.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L73)*
**Parameters:**
@@ -138,7 +138,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)*
*Defined in [codec/EnumType.ts:80](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L80)*
*Defined in [codec/EnumType.ts:80](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L80)*
**Parameters:**
@@ -160,7 +160,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L97)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L97)*
**Returns:** `any`
@@ -173,7 +173,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L101)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L101)*
**Returns:** `number`
@@ -188,7 +188,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/EnumType.ts:105](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/EnumType.ts#L105)*
*Defined in [codec/EnumType.ts:105](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/EnumType.ts#L105)*
**Returns:** `string`
@@ -201,7 +201,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L45)*
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L45)*
**Parameters:**
docs/types/classes/_extrinsicstatus_.finalised.md
+11 -11
View File
@@ -18,7 +18,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/H256.ts#L11)*
*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/H256.ts#L11)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -54,7 +54,7 @@ getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L33)*
**Returns:** `number`
@@ -72,7 +72,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L32)*
**Returns:** `number`
@@ -87,7 +87,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L36)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L36)*
**Parameters:**
@@ -108,7 +108,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L44)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L44)*
**Parameters:**
@@ -127,7 +127,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L53)*
**Returns:** `string`
@@ -142,7 +142,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `any`
@@ -157,7 +157,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L65)*
**Returns:** `string`
@@ -172,7 +172,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L61)*
**Parameters:**
@@ -191,7 +191,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
docs/types/classes/_extrinsicstatus_.usurped.md
+11 -11
View File
@@ -18,7 +18,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/H256.ts#L11)*
*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/H256.ts#L11)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -54,7 +54,7 @@ getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L33)*
**Returns:** `number`
@@ -72,7 +72,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L32)*
**Returns:** `number`
@@ -87,7 +87,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L36)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L36)*
**Parameters:**
@@ -108,7 +108,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8aFixed.ts#L44)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8aFixed.ts#L44)*
**Parameters:**
@@ -127,7 +127,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L53)*
**Returns:** `string`
@@ -142,7 +142,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `any`
@@ -157,7 +157,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L65)*
**Returns:** `string`
@@ -172,7 +172,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L61)*
**Parameters:**
@@ -191,7 +191,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[decodeU8a](_codec_u8a_.u8a.md#decodeu8a)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
docs/types/classes/_gas_.gas.md
+23 -23
View File
@@ -18,7 +18,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/U64.ts#L9)*
*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/U64.ts#L9)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/Base.ts#L19)*
___
@@ -54,7 +54,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
@@ -75,7 +75,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L57)*
**Returns:** `number`
@@ -88,7 +88,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -126,7 +126,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[eq](_codec_uint_.uint.md#eq)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L119)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -168,7 +168,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L67)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L67)*
**Parameters:**
@@ -187,7 +187,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -206,7 +206,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -225,7 +225,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L125)*
*Defined in [codec/UInt.ts:125](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L125)*
**Returns:** `boolean`
@@ -238,7 +238,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -257,7 +257,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -276,7 +276,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -295,7 +295,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L159)*
*Defined in [codec/UInt.ts:159](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L159)*
**Parameters:**
@@ -314,7 +314,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -327,7 +327,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -342,7 +342,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -355,7 +355,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -370,7 +370,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -385,7 +385,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L83)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L83)*
**Parameters:**
@@ -404,7 +404,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[decodeUInt](_codec_uint_.uint.md#decodeuint)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/64e3ca6/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/4748e8c/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**

Some files were not shown because too many files have changed in this diff Show More