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

[CI Skip] 0.31.13

Browse Source
This commit is contained in:
Travis CI
2018-10-11 19:01:37 +00:00
parent 2b88a8f43c
commit eba79f160a
177 changed files with 2392 additions and 5588 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/GLOSSARY.html
+1 -65
View File
@@ -191,70 +191,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="rpc-core/">
<a href="rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="rpc-core/classes/_index_.rpc.html">
<a href="rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="rpc-rx/">
<a href="rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="rpc-rx/classes/_index_.rpcrx.html">
<a href="rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -461,7 +397,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-11T16:48:47.503Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"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-11T18:57:39.201Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
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/e103e98/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L85)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L93)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L119)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L119)*
**Type parameters:**
docs/api-observable/classes/_calls_.apicalls.md
+44 -44
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/e103e98/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L85)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L21)*
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L25)*
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L29)*
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L37)*
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L33)*
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L41)*
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L45)*
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L119)*
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L89)*
**Returns:** `Observable`<`boolean`>
@@ -290,7 +290,7 @@ ___
▸ **newHead**(): `Observable`< `Header` &#124; `undefined`>
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -303,7 +303,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L49)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L49)*
**Parameters:**
@@ -322,7 +322,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L62)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -335,7 +335,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Base.ts#L93)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L93)*
**Type parameters:**
@@ -358,7 +358,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L106)*
**Type parameters:**
@@ -381,7 +381,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Base.ts#L119)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L119)*
**Type parameters:**
@@ -403,7 +403,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L81)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L81)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -416,7 +416,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L85)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L85)*
**Parameters:**
@@ -435,7 +435,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -455,7 +455,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L102)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L102)*
**Parameters:**
@@ -474,7 +474,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L152)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L152)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -487,7 +487,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L156)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L156)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -500,7 +500,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L160)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L160)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -513,7 +513,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L164)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L164)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -526,7 +526,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -539,7 +539,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -552,7 +552,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L172)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L172)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -565,7 +565,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L168)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L168)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -578,7 +578,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L185)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L185)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -591,7 +591,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L211)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L211)*
**Parameters:**
@@ -610,7 +610,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L198)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L198)*
**Parameters:**
@@ -627,7 +627,7 @@ ___
▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` &#124; `undefined`>
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -644,7 +644,7 @@ ___
▸ **systemName**(): `Observable`< `Text` &#124; `undefined`>
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -655,7 +655,7 @@ ___
▸ **systemVersion**(): `Observable`< `Text` &#124; `undefined`>
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -668,7 +668,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L215)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L9)*
*Defined in [classes.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L18)*
*Defined in [classes.ts:18](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L22)*
*Defined in [classes.ts:22](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L26)*
*Defined in [classes.ts:26](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L31)*
*Defined in [classes.ts:31](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L39)*
*Defined in [classes.ts:39](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L43)*
*Defined in [classes.ts:43](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L48)*
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L58)*
*Defined in [classes.ts:58](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L62)*
*Defined in [classes.ts:62](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L66)*
*Defined in [classes.ts:66](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/classes.ts#L70)*
*Defined in [classes.ts:70](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/api-observable/classes/_combined_.apicombined.md
+64 -64
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/e103e98/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L85)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L21)*
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L25)*
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L29)*
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L37)*
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L33)*
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L41)*
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L45)*
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L42)*
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L87)*
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L103)*
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L114)*
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L129)*
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L152)*
*Defined in [Combined.ts:152](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L119)*
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L89)*
**Returns:** `Observable`<`boolean`>
@@ -382,7 +382,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[newHead](_calls_.apicalls.md#newhead)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -395,7 +395,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L49)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L49)*
**Parameters:**
@@ -412,7 +412,7 @@ ___
▸ **publicProposalCount**(): `Observable`<`number`>
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L20)*
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L20)*
**Returns:** `Observable`<`number`>
@@ -425,7 +425,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L62)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -438,7 +438,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Base.ts#L93)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L93)*
**Type parameters:**
@@ -461,7 +461,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L106)*
**Type parameters:**
@@ -484,7 +484,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Base.ts#L119)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L119)*
**Type parameters:**
@@ -506,7 +506,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L81)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L81)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -519,7 +519,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L85)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L85)*
**Parameters:**
@@ -538,7 +538,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -558,7 +558,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L102)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L102)*
**Parameters:**
@@ -575,7 +575,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/e103e98/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
@@ -593,7 +593,7 @@ ___
▸ **referendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L58)*
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L58)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
@@ -604,7 +604,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/e103e98/packages/api-observable/src/Combined.ts#L30)*
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L30)*
**Parameters:**
@@ -621,7 +621,7 @@ ___
▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:167](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L167)*
*Defined in [Combined.ts:167](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L167)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -632,7 +632,7 @@ ___
▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:187](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L187)*
*Defined in [Combined.ts:187](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L187)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -643,7 +643,7 @@ ___
▸ **sessionBrokenValue**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:202](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L202)*
*Defined in [Combined.ts:202](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L202)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -656,7 +656,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L152)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L152)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -669,7 +669,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L156)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L156)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -682,7 +682,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L160)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L160)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -695,7 +695,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L164)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L164)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -708,7 +708,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -721,7 +721,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -732,7 +732,7 @@ ___
▸ **sessionTimeExpected**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:221](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L221)*
*Defined in [Combined.ts:221](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L221)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -743,7 +743,7 @@ ___
▸ **sessionTimeRemaining**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:236](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L236)*
*Defined in [Combined.ts:236](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L236)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -756,7 +756,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L172)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L172)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -769,7 +769,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L168)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L168)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -782,7 +782,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L185)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L185)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -795,7 +795,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L211)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L211)*
**Parameters:**
@@ -814,7 +814,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L198)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L198)*
**Parameters:**
@@ -833,7 +833,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -852,7 +852,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -865,7 +865,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -876,7 +876,7 @@ ___
▸ **validatingBalance**(address: * `AccountId` &#124; `string`*): `Observable`<`RxBalance`>
*Defined in [Combined.ts:251](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L251)*
*Defined in [Combined.ts:251](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L251)*
**Parameters:**
@@ -893,7 +893,7 @@ ___
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<`RxBalanceMap`>
*Defined in [Combined.ts:276](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L276)*
*Defined in [Combined.ts:276](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L276)*
**Parameters:**
@@ -912,7 +912,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L215)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L215)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
@@ -923,7 +923,7 @@ ___
▸ **votingBalance**(_address: * `AccountId` &#124; `string`*): `Observable`<`RxBalance`>
*Defined in [Combined.ts:290](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L290)*
*Defined in [Combined.ts:290](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L290)*
**Parameters:**
@@ -940,7 +940,7 @@ ___
▸ **votingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<`RxBalance`[]>
*Defined in [Combined.ts:324](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L324)*
*Defined in [Combined.ts:324](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L324)*
**Parameters:**
@@ -957,7 +957,7 @@ ___
▸ **votingBalancesNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`any`>
*Defined in [Combined.ts:313](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L313)*
*Defined in [Combined.ts:313](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L313)*
**Parameters:**
docs/api-observable/classes/_index_.api.md
+64 -64
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/e103e98/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L85)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L21)*
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L25)*
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L29)*
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L37)*
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L33)*
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L41)*
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L45)*
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L42)*
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L87)*
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L103)*
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L114)*
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L129)*
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Combined.ts#L152)*
*Defined in [Combined.ts:152](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L119)*
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L89)*
**Returns:** `Observable`<`boolean`>
@@ -392,7 +392,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[newHead](_calls_.apicalls.md#newhead)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L33)*
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L33)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -405,7 +405,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L49)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L49)*
**Parameters:**
@@ -424,7 +424,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[publicProposalCount](_combined_.apicombined.md#publicproposalcount)*
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L20)*
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L20)*
**Returns:** `Observable`<`number`>
@@ -437,7 +437,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L62)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -450,7 +450,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Base.ts#L93)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L93)*
**Type parameters:**
@@ -473,7 +473,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L106)*
**Type parameters:**
@@ -496,7 +496,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Base.ts#L119)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Base.ts#L119)*
**Type parameters:**
@@ -518,7 +518,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L81)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L81)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -531,7 +531,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L85)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L85)*
**Parameters:**
@@ -550,7 +550,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L98)*
**Parameters:**
@@ -570,7 +570,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L102)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L102)*
**Parameters:**
@@ -589,7 +589,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumVotes](_combined_.apicombined.md#referendumvotes)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
@@ -609,7 +609,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendums](_combined_.apicombined.md#referendums)*
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L58)*
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L58)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
@@ -622,7 +622,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumsInfo](_combined_.apicombined.md#referendumsinfo)*
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L30)*
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L30)*
**Parameters:**
@@ -641,7 +641,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)*
*Defined in [Combined.ts:167](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L167)*
*Defined in [Combined.ts:167](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L167)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -654,7 +654,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)*
*Defined in [Combined.ts:187](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L187)*
*Defined in [Combined.ts:187](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L187)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -667,7 +667,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)*
*Defined in [Combined.ts:202](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L202)*
*Defined in [Combined.ts:202](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L202)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -680,7 +680,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L152)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L152)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -693,7 +693,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L156)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L156)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -706,7 +706,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L160)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L160)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -719,7 +719,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L164)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L164)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -732,7 +732,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -745,7 +745,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -758,7 +758,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)*
*Defined in [Combined.ts:221](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L221)*
*Defined in [Combined.ts:221](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L221)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -771,7 +771,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)*
*Defined in [Combined.ts:236](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L236)*
*Defined in [Combined.ts:236](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L236)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -784,7 +784,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L172)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L172)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -797,7 +797,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L168)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L168)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -810,7 +810,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L185)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L185)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -823,7 +823,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L211)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L211)*
**Parameters:**
@@ -842,7 +842,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L198)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L198)*
**Parameters:**
@@ -861,7 +861,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L47)*
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L47)*
**Parameters:**
@@ -880,7 +880,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L39)*
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L39)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -893,7 +893,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Calls.ts#L43)*
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Calls.ts#L43)*
**Returns:** `Observable`< `Text` &#124; `undefined`>
@@ -906,7 +906,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)*
*Defined in [Combined.ts:251](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L251)*
*Defined in [Combined.ts:251](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L251)*
**Parameters:**
@@ -925,7 +925,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)*
*Defined in [Combined.ts:276](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L276)*
*Defined in [Combined.ts:276](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L276)*
**Parameters:**
@@ -944,7 +944,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Queries.ts#L215)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L215)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
@@ -957,7 +957,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)*
*Defined in [Combined.ts:290](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L290)*
*Defined in [Combined.ts:290](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L290)*
**Parameters:**
@@ -976,7 +976,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)*
*Defined in [Combined.ts:324](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L324)*
*Defined in [Combined.ts:324](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Combined.ts#L324)*
**Parameters:**
@@ -995,7 +995,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)*
*Defined in [Combined.ts:313](https://github.com/polkadot-js/api/blob/e103e98/packages/api-observable/src/Combined.ts#L313)*
*Defined in [Combined.ts:313](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L32)*
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L41)*
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L85)*
*Defined in [Base.ts:85](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L21)*
*Defined in [Queries.ts:21](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L25)*
*Defined in [Queries.ts:25](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L29)*
*Defined in [Queries.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L37)*
*Defined in [Queries.ts:37](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L33)*
*Defined in [Queries.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L41)*
*Defined in [Queries.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L45)*
*Defined in [Queries.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L115)*
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L119)*
*Defined in [Queries.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L89)*
*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L49)*
*Defined in [Queries.ts:49](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L62)*
*Defined in [Queries.ts:62](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L93)*
*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L106)*
*Defined in [Base.ts:106](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Base.ts#L119)*
*Defined in [Base.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L81)*
*Defined in [Queries.ts:81](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L85)*
*Defined in [Queries.ts:85](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L98)*
*Defined in [Queries.ts:98](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L102)*
*Defined in [Queries.ts:102](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L152)*
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L156)*
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L160)*
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L164)*
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L172)*
*Defined in [Queries.ts:172](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L168)*
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L185)*
*Defined in [Queries.ts:185](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L211)*
*Defined in [Queries.ts:211](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L198)*
*Defined in [Queries.ts:198](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/api-observable/src/Queries.ts#L215)*
*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api-observable/src/Queries.ts#L215)*
**Returns:** `Observable`< `u32` &#124; `undefined`>
docs/api/README.md
+13 -6
View File
@@ -8,17 +8,24 @@ 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
* The above is just a wrapper for `new Api(<optional WsProvider>)`, exposing the `isReady` getter
* `api.rpc.*` provides access to actual RPC calls, be it for queries, submission or retrieving chain information
* `api.st.*` provides access to chain state queries. These are dynamically populated based on what the runtime provides
* `api.tx.*` provides the ability to create transaction, like chain state, this list is populated from a runtime query
* `api.rpc.<section>.<method>` provides access to actual RPC calls, be it for queries, submission or retrieving chain information
* `api.st.<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
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](promise/) All interface calls returns Promises, including the static `.create(...)`. Additionally any subscription method use standard JavaScript `(error, value) => {}` callbacks.
* [ApiRx](rx/) 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 use standard JavaScript `(error, value) => {}` callbacks.
* [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.
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.
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.
Installation & import
---------------------
@@ -26,7 +33,7 @@ Installation & import
Installation -
```
npm install --save @polkadot/api/rx
npm install --save @polkadot/api
```
Subscribing to blocks via Promise-based API -
docs/api/classes/_base_.apibase.md
+30 -14
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/e103e98/packages/api/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L40)*
*__example__*:
```javascript
@@ -41,7 +41,7 @@ new Api().isReady.subscribe((api) => {
| Param | Type | Description |
| ------ | ------ | ------ |
| `Optional` wsProvider | `WsProvider` | An optional WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port |
| `Optional` wsProvider | `WsProvider` | A WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port |
**Returns:** [ApiBase](_base_.apibase.md)
@@ -55,7 +55,7 @@ ___
getgenesisHash(): `Hash`
*Defined in [Base.ts:68](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L68)*
*Defined in [Base.ts:69](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L69)*
*__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.
@@ -68,9 +68,11 @@ ___
getrpc(): `R`
*Defined in [Base.ts:105](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L105)*
*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L109)*
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions.
*__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.st` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
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.
*__example__*:
```javascript
@@ -90,7 +92,7 @@ ___
getruntimeMetadata(): `RuntimeMetadata`
*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L77)*
*Defined in [Base.ts:78](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L78)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -103,7 +105,7 @@ ___
getruntimeVersion(): `RuntimeVersion`
*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L86)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L87)*
*__description__*: Contains the version information for the current runtime.
@@ -116,10 +118,12 @@ ___
getst(): `S`
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L122)*
*Defined in [Base.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L129)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
All calls inside the namespace, is denoted by `section`.`method` and may take an optional query parameter. As an example, `api.st.timestamp.now()` (current block timestamp) does not take parameters, while `api.st.system.accountNonce(<accountId>)` (retrieving the associated nonce for an account), takes the `AccountId` as a parameter.
*__example__*:
```javascript
api.st.balances
@@ -138,7 +142,7 @@ ___
gettx(): `E`
*Defined in [Base.ts:143](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L143)*
*Defined in [Base.ts:151](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L151)*
*__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.
@@ -165,14 +169,26 @@ ___
▸ **on**(type: *`ApiInterface$Events`*, handler: *`function`*): `void`
*Defined in [Base.ts:149](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L149)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L173)*
*__description__*:
*__example&lt;br&gt;__*: ```javascript
* api.on('disconnected', () => {
console.log('API has been connected to the endpoint');
});
api.on('disconnected', () => {
console.log('API has been disconnected from the endpoint');
});
```
**Parameters:**
| Param | Type |
| ------ | ------ |
| type | `ApiInterface$Events` |
| handler | `function` |
| Param | Type | Description |
| ------ | ------ | ------ |
| type | `ApiInterface$Events` | The type of event to listen to. Availble events are \`connected\`, \`disconnected\` and \`ready\` |
| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. |
**Returns:** `void`
docs/api/classes/_promise_index_.apipromise.html
+67 -117
View File
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -428,9 +364,13 @@
<section class="normal markdown-section">
<p><em><strong>description</strong></em>: ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Polkadot network. As a full Promise-based, all interface calls return Promises, including the static <code>.create(...)</code>. Subscription calls utilise standard JavaScript-convention <code>(error, value)</code> callbacks.</p>
<p>The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of athe subscription-based features of Polkadot (and Substrate) clients.</p>
<p><em><strong>example</strong></em>: </p>
<h1 id="polkadotapipromise">@polkadot/api/promise</h1>
<h2 id="overview">Overview</h2>
<p><em><strong>name</strong></em>: ApiPromise</p>
<p><em><strong>description</strong></em>: ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Polkadot network. As a full Promise-based, all interface calls return Promises, including the static <code>.create(...)</code>. Subscription calls utilise standard JavaScript-convention <code>(error, value)</code> callbacks.</p>
<p>The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Polkadot (and Substrate) clients.</p>
<p><em><strong>see</strong></em>: <a href="_rx_index_.apirx.html">ApiRx</a></p>
<h2 id="usage">Usage</h2>
<p>Making rpc calls - </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">ApiPromise</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api/promise&apos;</span><span class="sunlight-punctuation">;</span>
@@ -446,14 +386,17 @@
<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-punctuation">{</span>&#xA0;<span class="sunlight-ident">ApiPromise</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">WsProvider</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider/ws&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-comment">//&#xA0;initialise&#xA0;via&#xA0;isReady&#xA0;&amp;&#xA0;new&#xA0;with&#xA0;specific&#xA0;non-local&#xA0;endpoint</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">api</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-ident">await</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">ApiPromise</span><span class="sunlight-punctuation">(</span><span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;wss://example.com:9944&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">)</span><span class="sunlight-operator">.</span><span class="sunlight-ident">isReady</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-comment">//&#xA0;initialise&#xA0;a&#xA0;provider&#xA0;with&#xA0;a&#xA0;specific&#xA0;endpoint</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;wss://example.com:9944&apos;</span><span class="sunlight-punctuation">)</span>
<span class="sunlight-comment">//&#xA0;initialise&#xA0;via&#xA0;isReady&#xA0;&amp;&#xA0;new&#xA0;with&#xA0;specific&#xA0;provider</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">api</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-ident">await</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">ApiPromise</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span><span class="sunlight-operator">.</span><span class="sunlight-ident">isReady</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-comment">//&#xA0;retrieve&#xA0;the&#xA0;block&#xA0;target&#xA0;time</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">blockPeriod</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-ident">await</span>&#xA0;<span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">st</span><span class="sunlight-operator">.</span><span class="sunlight-ident">timestamp</span><span class="sunlight-operator">.</span><span class="sunlight-ident">blockPeriod</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-operator">.</span><span class="sunlight-ident">toNumber</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-ident">let</span>&#xA0;<span class="sunlight-ident">last</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-number">0</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-comment">//&#xA0;subscribe&#xA0;to&#xA0;the&#xA0;current&#xA0;block&#xA0;timestamp,&#xA0;updates&#xA0;automatically</span>
<span class="sunlight-comment">//&#xA0;subscribe&#xA0;to&#xA0;the&#xA0;current&#xA0;block&#xA0;timestamp,&#xA0;updates&#xA0;automatically&#xA0;(callback&#xA0;provided)</span>
<span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">st</span><span class="sunlight-operator">.</span><span class="sunlight-ident">timestamp</span><span class="sunlight-operator">.</span><span class="sunlight-ident">now</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">timestamp</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">elapsed</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-ident">last</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-operator">?</span>&#xA0;<span class="sunlight-punctuation">`</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">timestamp</span><span class="sunlight-operator">.</span><span class="sunlight-ident">toNumber</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">-</span>&#xA0;<span class="sunlight-ident">last</span><span class="sunlight-punctuation">}</span><span class="sunlight-ident">s</span>&#xA0;<span class="sunlight-ident">since</span>&#xA0;<span class="sunlight-ident">last</span><span class="sunlight-punctuation">`</span>
@@ -495,7 +438,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/e103e98/packages/api/src/promise/index.ts#L113" target="_blank">promise/index.ts:113</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/promise/index.ts#L121" target="_blank">promise/index.ts:121</a></em></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>
@@ -518,7 +461,7 @@
<tr>
<td><code>Optional</code> wsProvider</td>
<td><code>WsProvider</code></td>
<td>An optional WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port</td>
<td>WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port, i.e. `ws://127.0.0.1:9944`</td>
</tr>
</tbody>
</table>
@@ -529,14 +472,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/e103e98/packages/api/src/Base.ts#L68" target="_blank">Base.ts:68</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L69" target="_blank">Base.ts:69</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/e103e98/packages/api/src/promise/index.ts#L143" target="_blank">promise/index.ts:143</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/promise/index.ts#L151" target="_blank">promise/index.ts:151</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>
@@ -544,8 +487,9 @@
<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/e103e98/packages/api/src/Base.ts#L105" target="_blank">Base.ts:105</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.</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L109" target="_blank">Base.ts:109</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.st</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>
<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">rpc</span><span class="sunlight-operator">.</span><span class="sunlight-ident">chain</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">newHead</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span>
@@ -559,7 +503,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/e103e98/packages/api/src/Base.ts#L77" target="_blank">Base.ts:77</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L78" target="_blank">Base.ts:78</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>
@@ -567,7 +511,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/e103e98/packages/api/src/Base.ts#L86" target="_blank">Base.ts:86</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L87" target="_blank">Base.ts:87</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>
@@ -575,8 +519,9 @@
<h2 id="st">st</h2>
<p>getst(): <code>QueryableStorage</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#st">st</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L122" target="_blank">Base.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L129" target="_blank">Base.ts:129</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.st.timestamp.now()</code> (current block timestamp) does not take parameters, while <code>api.st.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>
<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">st</span><span class="sunlight-operator">.</span><span class="sunlight-ident">balances</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">freeBalance</span><span class="sunlight-punctuation">(</span><span class="sunlight-operator">&lt;</span><span class="sunlight-ident">accountId</span><span class="sunlight-operator">&gt;</span><span class="sunlight-punctuation">)</span>
@@ -590,7 +535,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/e103e98/packages/api/src/Base.ts#L143" target="_blank">Base.ts:143</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L151" target="_blank">Base.ts:151</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>
@@ -608,43 +553,48 @@
<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/e103e98/packages/api/src/Base.ts#L149" target="_blank">Base.ts:149</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td><code>ApiInterface$Events</code></td>
</tr>
<tr>
<td>handler</td>
<td><code>function</code></td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <code>void</code></p>
<hr>
<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/e103e98/packages/api/src/promise/index.ts#L111" target="_blank">promise/index.ts:111</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>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L173" target="_blank">Base.ts:173</a></em></p>
<p><em><strong>description</strong></em>: </p>
<p><em><strong>example&lt;br&gt;</strong></em>: ```javascript</p>
<ul>
<li>api.on(&apos;disconnected&apos;, () =&gt; {
console.log(&apos;API has been connected to the endpoint&apos;);
});</li>
</ul>
<p>api.on(&apos;disconnected&apos;, () =&gt; {
console.log(&apos;API has been disconnected from the endpoint&apos;);
});</p>
<pre><code>
**Parameters:**
<span class="sunlight-ident">Api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">create</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-operator">.</span><span class="sunlight-ident">then</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">async</span>&#xA0;<span class="sunlight-punctuation">(</span><span class="sunlight-ident">api</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">timestamp</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-ident">await</span>&#xA0;<span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">st</span><span class="sunlight-operator">.</span><span class="sunlight-ident">timestamp</span><span class="sunlight-operator">.</span><span class="sunlight-ident">now</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
| Param | Type | Description |
| ------ | ------ | ------ |
| type | `ApiInterface$Events` | The type of event to listen to. Availble events are \`connected\`, \`disconnected\` and \`ready\` |
| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. |
&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">`</span><span class="sunlight-ident">lastest</span>&#xA0;<span class="sunlight-ident">block</span>&#xA0;<span class="sunlight-ident">timestamp</span>&#xA0;<span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">timestamp</span><span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">`</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<p><strong>Parameters:</strong></p>
**Returns:** `void`
___
&lt;a id=&quot;create&quot;&gt;&lt;/a&gt;
## `&lt;Static&gt;` create
&#x25B8; **create**(wsProvider?: *`WsProvider`*): `Promise`&lt;[ApiPromise](_promise_index_.apipromise.md)&gt;
*Defined in [promise/index.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/promise/index.ts#L119)*
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
*__example__*:
```javascript
import Api from &apos;@polkadot/api/promise&apos;;
Api.create().then(async (api) =&gt; {
const timestamp = await api.st.timestamp.now();
console.log(`lastest block timestamp ${timestamp}`);
});
</code></pre><p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
@@ -657,7 +607,7 @@
<tr>
<td><code>Optional</code> wsProvider</td>
<td><code>WsProvider</code></td>
<td>Optional WebSocket provider that is passed to the class contructor</td>
<td>WebSocket provider that is passed to the class contructor</td>
</tr>
</tbody>
</table>
@@ -706,7 +656,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-11T16:50:44.179Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"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-11T18:59:47.025Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api/classes/_promise_index_.apipromise.md
+51 -22
View File
@@ -1,10 +1,20 @@
@polkadot/api/promise
=====================
Overview
--------
*__name__*: ApiPromise
*__description__*: ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Polkadot network. As a full Promise-based, all interface calls return Promises, including the static `.create(...)`. Subscription calls utilise standard JavaScript-convention `(error, value)` callbacks.
The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of athe subscription-based features of Polkadot (and Substrate) clients.
The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Polkadot (and Substrate) clients.
*__example__*:
*__see__*: [ApiRx](_rx_index_.apirx.md)
Usage
-----
Making rpc calls -
@@ -27,14 +37,17 @@ Subscribing to chain state -
import { ApiPromise } from '@polkadot/api';
import WsProvider from '@polkadot/rpc-provider/ws';
// initialise via isReady & new with specific non-local endpoint
const api = await new ApiPromise(new WsProvider('wss://example.com:9944')).isReady;
// initialise a provider with a specific endpoint
const provider = new WsProvider('wss://example.com:9944')
// initialise via isReady & new with specific provider
const api = await new ApiPromise(provider).isReady;
// retrieve the block target time
const blockPeriod = await api.st.timestamp.blockPeriod().toNumber();
let last = 0;
// subscribe to the current block timestamp, updates automatically
// subscribe to the current block timestamp, updates automatically (callback provided)
api.st.timestamp.now((error, timestamp) => {
const elapsed = last
? `, ${timestamp.toNumber() - last}s since last`
@@ -89,7 +102,7 @@ ApiPromise.create().then((api) => {
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [promise/index.ts:113](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/promise/index.ts#L113)*
*Defined in [promise/index.ts:121](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/promise/index.ts#L121)*
*__example__*:
```javascript
@@ -106,7 +119,7 @@ new Api().isReady.then((api) => {
| Param | Type | Description |
| ------ | ------ | ------ |
| `Optional` wsProvider | `WsProvider` | An optional WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port |
| `Optional` wsProvider | `WsProvider` | WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port, i.e. \`ws://127.0.0.1:9944\` |
**Returns:** [ApiPromise](_promise_index_.apipromise.md)
@@ -122,7 +135,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:68](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L68)*
*Defined in [Base.ts:69](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L69)*
*__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.
@@ -135,7 +148,7 @@ ___
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:143](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/promise/index.ts#L143)*
*Defined in [promise/index.ts:151](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/promise/index.ts#L151)*
*__description__*: Promise that returns the first time we are connected and loaded
@@ -150,9 +163,11 @@ getrpc(): `Rpc`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:105](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L105)*
*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L109)*
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions.
*__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.st` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
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.
*__example__*:
```javascript
@@ -174,7 +189,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L77)*
*Defined in [Base.ts:78](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L78)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -189,7 +204,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L86)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L87)*
*__description__*: Contains the version information for the current runtime.
@@ -204,10 +219,12 @@ getst(): `QueryableStorage`
*Inherited from [ApiBase](_base_.apibase.md).[st](_base_.apibase.md#st)*
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L122)*
*Defined in [Base.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L129)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
All calls inside the namespace, is denoted by `section`.`method` and may take an optional query parameter. As an example, `api.st.timestamp.now()` (current block timestamp) does not take parameters, while `api.st.system.accountNonce(<accountId>)` (retrieving the associated nonce for an account), takes the `AccountId` as a parameter.
*__example__*:
```javascript
api.st.balances
@@ -228,7 +245,7 @@ gettx(): `SubmittableExtrinsics`
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:143](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L143)*
*Defined in [Base.ts:151](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L151)*
*__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.
@@ -257,14 +274,26 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:149](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L149)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L173)*
*__description__*:
*__example&lt;br&gt;__*: ```javascript
* api.on('disconnected', () => {
console.log('API has been connected to the endpoint');
});
api.on('disconnected', () => {
console.log('API has been disconnected from the endpoint');
});
```
**Parameters:**
| Param | Type |
| ------ | ------ |
| type | `ApiInterface$Events` |
| handler | `function` |
| Param | Type | Description |
| ------ | ------ | ------ |
| type | `ApiInterface$Events` | The type of event to listen to. Availble events are \`connected\`, \`disconnected\` and \`ready\` |
| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. |
**Returns:** `void`
@@ -275,7 +304,7 @@ ___
▸ **create**(wsProvider?: *`WsProvider`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
*Defined in [promise/index.ts:111](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/promise/index.ts#L111)*
*Defined in [promise/index.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/promise/index.ts#L119)*
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
@@ -294,7 +323,7 @@ Api.create().then(async (api) => {
| Param | Type | Description |
| ------ | ------ | ------ |
| `Optional` wsProvider | `WsProvider` | Optional WebSocket provider that is passed to the class contructor |
| `Optional` wsProvider | `WsProvider` | WebSocket provider that is passed to the class contructor |
**Returns:** `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
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/e103e98/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -265,7 +265,7 @@ ___
▸ **send**(): `Promise`<`Hash`>
*Defined in [promise/SubmittableExtrinsic.ts:22](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/promise/SubmittableExtrinsic.ts#L22)*
*Defined in [promise/SubmittableExtrinsic.ts:22](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/promise/SubmittableExtrinsic.ts#L22)*
**Returns:** `Promise`<`Hash`>
@@ -278,7 +278,7 @@ ___
*Overrides Extrinsic.sign*
*Defined in [promise/SubmittableExtrinsic.ts:26](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/promise/SubmittableExtrinsic.ts#L26)*
*Defined in [promise/SubmittableExtrinsic.ts:26](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/promise/SubmittableExtrinsic.ts#L26)*
**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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/api/classes/_rx_index_.apirx.html
+71 -120
View File
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -428,9 +364,13 @@
<section class="normal markdown-section">
<p><em><strong>description</strong></em>: ApiRx is a powerfull RxJS Observable wrapper around the RPC and interfaces on the Polkadot network. As a full Observable API, 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.</p>
<h1 id="polkadotapirx">@polkadot/api/rx</h1>
<h2 id="overview">Overview</h2>
<p><em><strong>name</strong></em>: ApiRx</p>
<p><em><strong>description</strong></em>: ApiRx is a powerfull RxJS Observable wrapper around the RPC and interfaces on the Polkadot network. As a full Observable API, 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.</p>
<p>The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Polkadot (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding <code>.subscribe</code> and <code>.pipe</code> on Observables will unlock full-scale use thereof.</p>
<p><em><strong>example</strong></em>: </p>
<p><em><strong>see</strong></em>: <a href="_promise_index_.apipromise.html">ApiPromise</a></p>
<h2 id="usage">Usage</h2>
<p>Making rpc calls - </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">ApiRx</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api/rx&apos;</span><span class="sunlight-punctuation">;</span>
@@ -443,14 +383,18 @@
<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<p>Subscribing to chain state - </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-punctuation">{</span>&#xA0;<span class="sunlight-ident">ApiRx</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">WsProvider</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider/ws&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-punctuation">{</span>&#xA0;<span class="sunlight-ident">combineLatest</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;rxjs&apos;</span><span class="sunlight-punctuation">;</span>
<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-punctuation">{</span>&#xA0;<span class="sunlight-ident">combineLatest</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;rxjs&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-punctuation">{</span>&#xA0;<span class="sunlight-ident">ApiRx</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-punctuation">{</span>&#xA0;<span class="sunlight-ident">WsProvider</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-comment">//&#xA0;last&#xA0;block&#xA0;timestamp</span>
<span class="sunlight-ident">let</span>&#xA0;<span class="sunlight-ident">last</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-number">0</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-comment">//&#xA0;initialise&#xA0;via&#xA0;isReady&#xA0;&amp;&#xA0;new&#xA0;with&#xA0;specific&#xA0;non-local&#xA0;endpoint</span>
<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">ApiRx</span><span class="sunlight-punctuation">(</span><span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;wss://example.com:9944&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">)</span>
<span class="sunlight-comment">//&#xA0;initialise&#xA0;a&#xA0;provider&#xA0;with&#xA0;a&#xA0;specific&#xA0;endpoint</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;wss://example.com:9944&apos;</span><span class="sunlight-punctuation">)</span>
<span class="sunlight-comment">//&#xA0;initialise&#xA0;via&#xA0;isReady&#xA0;&amp;&#xA0;new&#xA0;with&#xA0;specific&#xA0;provider</span>
<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">ApiRx</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">isReady</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">pipe</span><span class="sunlight-punctuation">(</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">switchMap</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">api</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>
@@ -507,7 +451,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/e103e98/packages/api/src/rx/index.ts#L130" target="_blank">rx/index.ts:130</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/rx/index.ts#L139" target="_blank">rx/index.ts:139</a></em></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>
@@ -530,7 +474,7 @@
<tr>
<td><code>Optional</code> wsProvider</td>
<td><code>WsProvider</code></td>
<td>An optional WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port</td>
<td>A WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port, i.e. `ws://127.0.0.1:9944`</td>
</tr>
</tbody>
</table>
@@ -541,21 +485,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/e103e98/packages/api/src/Base.ts#L68" target="_blank">Base.ts:68</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L69" target="_blank">Base.ts:69</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/e103e98/packages/api/src/rx/index.ts#L163" target="_blank">rx/index.ts:163</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/rx/index.ts#L172" target="_blank">rx/index.ts:172</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/e103e98/packages/api/src/rx/index.ts#L170" target="_blank">rx/index.ts:170</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/rx/index.ts#L179" target="_blank">rx/index.ts:179</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>
@@ -563,8 +507,9 @@
<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/e103e98/packages/api/src/Base.ts#L105" target="_blank">Base.ts:105</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.</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L109" target="_blank">Base.ts:109</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.st</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>
<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">rpc</span><span class="sunlight-operator">.</span><span class="sunlight-ident">chain</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">newHead</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span>
@@ -578,7 +523,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/e103e98/packages/api/src/Base.ts#L77" target="_blank">Base.ts:77</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L78" target="_blank">Base.ts:78</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>
@@ -586,7 +531,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/e103e98/packages/api/src/Base.ts#L86" target="_blank">Base.ts:86</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L87" target="_blank">Base.ts:87</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>
@@ -594,8 +539,9 @@
<h2 id="st">st</h2>
<p>getst(): <code>QueryableStorage</code></p>
<p><em>Inherited from <a href="_base_.apibase.md">ApiBase</a>.<a href="_base_.apibase.md#st">st</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L122" target="_blank">Base.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L129" target="_blank">Base.ts:129</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.st.timestamp.now()</code> (current block timestamp) does not take parameters, while <code>api.st.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>
<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">st</span><span class="sunlight-operator">.</span><span class="sunlight-ident">balances</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">freeBalance</span><span class="sunlight-punctuation">(</span><span class="sunlight-operator">&lt;</span><span class="sunlight-ident">accountId</span><span class="sunlight-operator">&gt;</span><span class="sunlight-punctuation">)</span>
@@ -609,7 +555,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/e103e98/packages/api/src/Base.ts#L143" target="_blank">Base.ts:143</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L151" target="_blank">Base.ts:151</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>
@@ -627,43 +573,48 @@
<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/e103e98/packages/api/src/Base.ts#L149" target="_blank">Base.ts:149</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td><code>ApiInterface$Events</code></td>
</tr>
<tr>
<td>handler</td>
<td><code>function</code></td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <code>void</code></p>
<hr>
<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/e103e98/packages/api/src/rx/index.ts#L128" target="_blank">rx/index.ts:128</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>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L173" target="_blank">Base.ts:173</a></em></p>
<p><em><strong>description</strong></em>: </p>
<p><em><strong>example&lt;br&gt;</strong></em>: ```javascript</p>
<ul>
<li>api.on(&apos;disconnected&apos;, () =&gt; {
console.log(&apos;API has been connected to the endpoint&apos;);
});</li>
</ul>
<p>api.on(&apos;disconnected&apos;, () =&gt; {
console.log(&apos;API has been disconnected from the endpoint&apos;);
});</p>
<pre><code>
**Parameters:**
<span class="sunlight-ident">Api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">create</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-operator">.</span><span class="sunlight-ident">subscribe</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">api</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;<span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">st</span><span class="sunlight-operator">.</span><span class="sunlight-ident">timestamp</span><span class="sunlight-operator">.</span><span class="sunlight-ident">now</span><span class="sunlight-operator">.</span><span class="sunlight-ident">subscribe</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">timestamp</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">`</span><span class="sunlight-ident">lastest</span>&#xA0;<span class="sunlight-ident">block</span>&#xA0;<span class="sunlight-ident">timestamp</span>&#xA0;<span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">timestamp</span><span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">`</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<p><strong>Parameters:</strong></p>
| Param | Type | Description |
| ------ | ------ | ------ |
| type | `ApiInterface$Events` | The type of event to listen to. Availble events are \`connected\`, \`disconnected\` and \`ready\` |
| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. |
**Returns:** `void`
___
&lt;a id=&quot;create&quot;&gt;&lt;/a&gt;
## `&lt;Static&gt;` create
&#x25B8; **create**(wsProvider?: *`WsProvider`*): `Observable`&lt;[ApiRx](_rx_index_.apirx.md)&gt;
*Defined in [rx/index.ts:137](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/rx/index.ts#L137)*
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
*__example__*:
```javascript
import Api from &apos;@polkadot/api/rx&apos;;
Api.create().subscribe((api) =&gt; {
api.st.timestamp.now.subscribe((timestamp) =&gt; {
console.log(`lastest block timestamp ${timestamp}`);
});
});
</code></pre><p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
@@ -676,7 +627,7 @@
<tr>
<td><code>Optional</code> wsProvider</td>
<td><code>WsProvider</code></td>
<td>Optional WebSocket provider that is passed to the class contructor</td>
<td>WebSocket provider that is passed to the class contructor</td>
</tr>
</tbody>
</table>
@@ -725,7 +676,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-11T16:50:44.279Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"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-11T18:59:47.133Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api/classes/_rx_index_.apirx.md
+53 -23
View File
@@ -1,10 +1,20 @@
@polkadot/api/rx
================
Overview
--------
*__name__*: ApiRx
*__description__*: ApiRx is a powerfull RxJS Observable wrapper around the RPC and interfaces on the Polkadot network. As a full Observable API, 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.
The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Polkadot (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding `.subscribe` and `.pipe` on Observables will unlock full-scale use thereof.
*__example__*:
*__see__*: [ApiPromise](_promise_index_.apipromise.md)
Usage
-----
Making rpc calls -
@@ -24,14 +34,18 @@ api.rpc.chain.newHead().subscribe((header) => {
Subscribing to chain state -
```javascript
import { ApiRx } from '@polkadot/api';
import WsProvider from '@polkadot/rpc-provider/ws';
import { combineLatest } from 'rxjs';
import { ApiRx } from '@polkadot/api';
import { WsProvider } from '@polkadot/rpc-provider';
// last block timestamp
let last = 0;
// initialise via isReady & new with specific non-local endpoint
new ApiRx(new WsProvider('wss://example.com:9944'))
// initialise a provider with a specific endpoint
const provider = new WsProvider('wss://example.com:9944')
// initialise via isReady & new with specific provider
new ApiRx(provider)
.isReady
.pipe(
switchMap((api) =>
@@ -101,7 +115,7 @@ api.st.system
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [rx/index.ts:130](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/rx/index.ts#L130)*
*Defined in [rx/index.ts:139](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/rx/index.ts#L139)*
*__example__*:
```javascript
@@ -118,7 +132,7 @@ new Api().isReady.subscribe((api) => {
| Param | Type | Description |
| ------ | ------ | ------ |
| `Optional` wsProvider | `WsProvider` | An optional WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port |
| `Optional` wsProvider | `WsProvider` | A WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port, i.e. \`ws://127.0.0.1:9944\` |
**Returns:** [ApiRx](_rx_index_.apirx.md)
@@ -134,7 +148,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:68](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L68)*
*Defined in [Base.ts:69](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L69)*
*__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.
@@ -147,7 +161,7 @@ ___
getisConnected(): `Observable`<`boolean`>
*Defined in [rx/index.ts:163](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/rx/index.ts#L163)*
*Defined in [rx/index.ts:172](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/rx/index.ts#L172)*
*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
@@ -160,7 +174,7 @@ ___
getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:170](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/rx/index.ts#L170)*
*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/rx/index.ts#L179)*
*__description__*: Observable that returns the first time we are connected and loaded
@@ -175,9 +189,11 @@ getrpc(): `RpcRx`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:105](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L105)*
*Defined in [Base.ts:109](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L109)*
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions.
*__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.st` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
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.
*__example__*:
```javascript
@@ -199,7 +215,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L77)*
*Defined in [Base.ts:78](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L78)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -214,7 +230,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L86)*
*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L87)*
*__description__*: Contains the version information for the current runtime.
@@ -229,10 +245,12 @@ getst(): `QueryableStorage`
*Inherited from [ApiBase](_base_.apibase.md).[st](_base_.apibase.md#st)*
*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L122)*
*Defined in [Base.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L129)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
All calls inside the namespace, is denoted by `section`.`method` and may take an optional query parameter. As an example, `api.st.timestamp.now()` (current block timestamp) does not take parameters, while `api.st.system.accountNonce(<accountId>)` (retrieving the associated nonce for an account), takes the `AccountId` as a parameter.
*__example__*:
```javascript
api.st.balances
@@ -253,7 +271,7 @@ gettx(): `SubmittableExtrinsics`
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:143](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L143)*
*Defined in [Base.ts:151](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L151)*
*__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.
@@ -282,14 +300,26 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:149](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/Base.ts#L149)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/Base.ts#L173)*
*__description__*:
*__example&lt;br&gt;__*: ```javascript
* api.on('disconnected', () => {
console.log('API has been connected to the endpoint');
});
api.on('disconnected', () => {
console.log('API has been disconnected from the endpoint');
});
```
**Parameters:**
| Param | Type |
| ------ | ------ |
| type | `ApiInterface$Events` |
| handler | `function` |
| Param | Type | Description |
| ------ | ------ | ------ |
| type | `ApiInterface$Events` | The type of event to listen to. Availble events are \`connected\`, \`disconnected\` and \`ready\` |
| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. |
**Returns:** `void`
@@ -300,7 +330,7 @@ ___
▸ **create**(wsProvider?: *`WsProvider`*): `Observable`<[ApiRx](_rx_index_.apirx.md)>
*Defined in [rx/index.ts:128](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/rx/index.ts#L128)*
*Defined in [rx/index.ts:137](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/rx/index.ts#L137)*
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
@@ -319,7 +349,7 @@ Api.create().subscribe((api) => {
| Param | Type | Description |
| ------ | ------ | ------ |
| `Optional` wsProvider | `WsProvider` | Optional WebSocket provider that is passed to the class contructor |
| `Optional` wsProvider | `WsProvider` | WebSocket provider that is passed to the class contructor |
**Returns:** `Observable`<[ApiRx](_rx_index_.apirx.md)>
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/e103e98/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -265,7 +265,7 @@ ___
▸ **send**(): `Observable`<`any`>
*Defined in [rx/SubmittableExtrinsic.ts:22](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/rx/SubmittableExtrinsic.ts#L22)*
*Defined in [rx/SubmittableExtrinsic.ts:22](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/rx/SubmittableExtrinsic.ts#L22)*
**Returns:** `Observable`<`any`>
@@ -278,7 +278,7 @@ ___
*Overrides Extrinsic.sign*
*Defined in [rx/SubmittableExtrinsic.ts:26](https://github.com/polkadot-js/api/blob/e103e98/packages/api/src/rx/SubmittableExtrinsic.ts#L26)*
*Defined in [rx/SubmittableExtrinsic.ts:26](https://github.com/polkadot-js/api/blob/2b88a8f/packages/api/src/rx/SubmittableExtrinsic.ts#L26)*
**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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/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/e103e98/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/2b88a8f/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/api/index.html
+10 -71
View File
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../rpc-core/">
<a href="../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../rpc-core/classes/_index_.rpc.html">
<a href="../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../rpc-rx/">
<a href="../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../rpc-rx/classes/_index_.rpcrx.html">
<a href="../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -434,19 +370,22 @@
<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>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.*</code> provides access to actual RPC calls, be it for queries, submission or retrieving chain information</li>
<li><code>api.st.*</code> provides access to chain state queries. These are dynamically populated based on what the runtime provides</li>
<li><code>api.tx.*</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</li>
<li><code>api.st.&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>
</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="promise">ApiPromise</a> All interface calls returns Promises, including the static <code>.create(...)</code>. Additionally any subscription method use standard JavaScript <code>(error, value) =&gt; {}</code> callbacks.</li>
<li><a href="rx">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 use standard JavaScript <code>(error, value) =&gt; {}</code> callbacks.</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>
</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>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>
<pre><code>npm install --save @polkadot/api/rx
<pre><code>npm install --save @polkadot/api
</code></pre><p>Subscribing to blocks via Promise-based API -</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-punctuation">{</span>&#xA0;<span class="sunlight-ident">ApiPromise</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api&apos;</span><span class="sunlight-punctuation">;</span>
@@ -518,7 +457,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-11T16:50:43.936Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"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-11T18:59:46.709Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/examples-rpc/01_simple_connect/index.html
+1 -65
View File
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -490,7 +426,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-rpc/02_listen_to_blocks/README.md","ref":"examples-rpc/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"RPC","level":"2.1","depth":1,"path":"examples-rpc/README.md","ref":"examples-rpc/README.md","articles":[{"title":"Simple connect","level":"2.1.1","depth":2,"path":"examples-rpc/01_simple_connect/README.md","ref":"examples-rpc/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"2.1.2","depth":2,"path":"examples-rpc/02_listen_to_blocks/README.md","ref":"examples-rpc/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"2.1.3","depth":2,"path":"examples-rpc/03_listen_to_balance_change/README.md","ref":"examples-rpc/03_listen_to_balance_change/README.md","articles":[]},{"title":"Generate Accounts","level":"2.1.4","depth":2,"path":"examples-rpc/04_generate_account/README.md","ref":"examples-rpc/04_generate_account/README.md","articles":[]},{"title":"Read Storage","level":"2.1.5","depth":2,"path":"examples-rpc/05_read_storage/README.md","ref":"examples-rpc/05_read_storage/README.md","articles":[]},{"title":"Craft Extrinsic","level":"2.1.6","depth":2,"path":"examples-rpc/06_craft_extrinsic/README.md","ref":"examples-rpc/06_craft_extrinsic/README.md","articles":[]},{"title":"Transfer DOTs","level":"2.1.7","depth":2,"path":"examples-rpc/07_transfer_dots/README.md","ref":"examples-rpc/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-rpc/01_simple_connect/README.md","mtime":"2018-10-11T16:48:47.507Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"basePath":"../..","book":{"language":""}});
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-rpc/02_listen_to_blocks/README.md","ref":"examples-rpc/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"RPC","level":"2.1","depth":1,"path":"examples-rpc/README.md","ref":"examples-rpc/README.md","articles":[{"title":"Simple connect","level":"2.1.1","depth":2,"path":"examples-rpc/01_simple_connect/README.md","ref":"examples-rpc/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"2.1.2","depth":2,"path":"examples-rpc/02_listen_to_blocks/README.md","ref":"examples-rpc/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"2.1.3","depth":2,"path":"examples-rpc/03_listen_to_balance_change/README.md","ref":"examples-rpc/03_listen_to_balance_change/README.md","articles":[]},{"title":"Generate Accounts","level":"2.1.4","depth":2,"path":"examples-rpc/04_generate_account/README.md","ref":"examples-rpc/04_generate_account/README.md","articles":[]},{"title":"Read Storage","level":"2.1.5","depth":2,"path":"examples-rpc/05_read_storage/README.md","ref":"examples-rpc/05_read_storage/README.md","articles":[]},{"title":"Craft Extrinsic","level":"2.1.6","depth":2,"path":"examples-rpc/06_craft_extrinsic/README.md","ref":"examples-rpc/06_craft_extrinsic/README.md","articles":[]},{"title":"Transfer DOTs","level":"2.1.7","depth":2,"path":"examples-rpc/07_transfer_dots/README.md","ref":"examples-rpc/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-rpc/01_simple_connect/README.md","mtime":"2018-10-11T18:57:39.205Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples-rpc/02_listen_to_blocks/index.html
+1 -65
View File
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -497,7 +433,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-rpc/03_listen_to_balance_change/README.md","ref":"examples-rpc/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"2.1.1","depth":2,"path":"examples-rpc/01_simple_connect/README.md","ref":"examples-rpc/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-rpc/02_listen_to_blocks/README.md","mtime":"2018-10-11T16:48:47.507Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"basePath":"../..","book":{"language":""}});
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-rpc/03_listen_to_balance_change/README.md","ref":"examples-rpc/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"2.1.1","depth":2,"path":"examples-rpc/01_simple_connect/README.md","ref":"examples-rpc/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-rpc/02_listen_to_blocks/README.md","mtime":"2018-10-11T18:57:39.205Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples-rpc/03_listen_to_balance_change/index.html
+1 -65
View File
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -492,7 +428,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":"Generate Accounts","level":"2.1.4","depth":2,"path":"examples-rpc/04_generate_account/README.md","ref":"examples-rpc/04_generate_account/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"2.1.2","depth":2,"path":"examples-rpc/02_listen_to_blocks/README.md","ref":"examples-rpc/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-rpc/03_listen_to_balance_change/README.md","mtime":"2018-10-11T16:48:47.507Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"2.1.3","depth":2,"next":{"title":"Generate Accounts","level":"2.1.4","depth":2,"path":"examples-rpc/04_generate_account/README.md","ref":"examples-rpc/04_generate_account/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"2.1.2","depth":2,"path":"examples-rpc/02_listen_to_blocks/README.md","ref":"examples-rpc/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-rpc/03_listen_to_balance_change/README.md","mtime":"2018-10-11T18:57:39.205Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples-rpc/04_generate_account/index.html
+1 -65
View File
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -506,7 +442,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Generate Accounts","level":"2.1.4","depth":2,"next":{"title":"Read Storage","level":"2.1.5","depth":2,"path":"examples-rpc/05_read_storage/README.md","ref":"examples-rpc/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"2.1.3","depth":2,"path":"examples-rpc/03_listen_to_balance_change/README.md","ref":"examples-rpc/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-rpc/04_generate_account/README.md","mtime":"2018-10-11T16:48:47.507Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Generate Accounts","level":"2.1.4","depth":2,"next":{"title":"Read Storage","level":"2.1.5","depth":2,"path":"examples-rpc/05_read_storage/README.md","ref":"examples-rpc/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"2.1.3","depth":2,"path":"examples-rpc/03_listen_to_balance_change/README.md","ref":"examples-rpc/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-rpc/04_generate_account/README.md","mtime":"2018-10-11T18:57:39.205Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples-rpc/05_read_storage/index.html
+1 -65
View File
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -506,7 +442,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Read Storage","level":"2.1.5","depth":2,"next":{"title":"Craft Extrinsic","level":"2.1.6","depth":2,"path":"examples-rpc/06_craft_extrinsic/README.md","ref":"examples-rpc/06_craft_extrinsic/README.md","articles":[]},"previous":{"title":"Generate Accounts","level":"2.1.4","depth":2,"path":"examples-rpc/04_generate_account/README.md","ref":"examples-rpc/04_generate_account/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-rpc/05_read_storage/README.md","mtime":"2018-10-11T16:48:47.507Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Read Storage","level":"2.1.5","depth":2,"next":{"title":"Craft Extrinsic","level":"2.1.6","depth":2,"path":"examples-rpc/06_craft_extrinsic/README.md","ref":"examples-rpc/06_craft_extrinsic/README.md","articles":[]},"previous":{"title":"Generate Accounts","level":"2.1.4","depth":2,"path":"examples-rpc/04_generate_account/README.md","ref":"examples-rpc/04_generate_account/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-rpc/05_read_storage/README.md","mtime":"2018-10-11T18:57:39.205Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples-rpc/06_craft_extrinsic/index.html
+1 -65
View File
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -530,7 +466,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Craft Extrinsic","level":"2.1.6","depth":2,"next":{"title":"Transfer DOTs","level":"2.1.7","depth":2,"path":"examples-rpc/07_transfer_dots/README.md","ref":"examples-rpc/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Read Storage","level":"2.1.5","depth":2,"path":"examples-rpc/05_read_storage/README.md","ref":"examples-rpc/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-rpc/06_craft_extrinsic/README.md","mtime":"2018-10-11T16:48:47.507Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Craft Extrinsic","level":"2.1.6","depth":2,"next":{"title":"Transfer DOTs","level":"2.1.7","depth":2,"path":"examples-rpc/07_transfer_dots/README.md","ref":"examples-rpc/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Read Storage","level":"2.1.5","depth":2,"path":"examples-rpc/05_read_storage/README.md","ref":"examples-rpc/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-rpc/06_craft_extrinsic/README.md","mtime":"2018-10-11T18:57:39.205Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples-rpc/07_transfer_dots/index.html
+1 -65
View File
@@ -193,70 +193,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -510,7 +446,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Transfer DOTs","level":"2.1.7","depth":2,"previous":{"title":"Craft Extrinsic","level":"2.1.6","depth":2,"path":"examples-rpc/06_craft_extrinsic/README.md","ref":"examples-rpc/06_craft_extrinsic/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-rpc/07_transfer_dots/README.md","mtime":"2018-10-11T16:48:47.507Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Transfer DOTs","level":"2.1.7","depth":2,"previous":{"title":"Craft Extrinsic","level":"2.1.6","depth":2,"path":"examples-rpc/06_craft_extrinsic/README.md","ref":"examples-rpc/06_craft_extrinsic/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-rpc/07_transfer_dots/README.md","mtime":"2018-10-11T18:57:39.205Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples-rpc/index.html
+3 -67
View File
@@ -68,7 +68,7 @@
<link rel="next" href="01_simple_connect/" />
<link rel="prev" href="../rpc-rx/classes/_index_.rpcrx.html" />
<link rel="prev" href="../rpc-provider/classes/_ws_index_.wsprovider.html" />
</head>
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../rpc-core/">
<a href="../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../rpc-core/classes/_index_.rpc.html">
<a href="../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../rpc-rx/">
<a href="../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../rpc-rx/classes/_index_.rpcrx.html">
<a href="../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -470,7 +406,7 @@
<a href="../rpc-rx/classes/_index_.rpcrx.html" class="navigation navigation-prev " aria-label="Previous page: RpcRx">
<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>
@@ -486,7 +422,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"RPC","level":"2.1","depth":1,"next":{"title":"Simple connect","level":"2.1.1","depth":2,"path":"examples-rpc/01_simple_connect/README.md","ref":"examples-rpc/01_simple_connect/README.md","articles":[]},"previous":{"title":"RpcRx","level":"1.5.1","depth":2,"path":"rpc-rx/classes/_index_.rpcrx.md","ref":"rpc-rx/classes/_index_.rpcrx.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-rpc/README.md","mtime":"2018-10-11T16:48:47.507Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"RPC","level":"2.1","depth":1,"next":{"title":"Simple connect","level":"2.1.1","depth":2,"path":"examples-rpc/01_simple_connect/README.md","ref":"examples-rpc/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-rpc/README.md","mtime":"2018-10-11T18:57:39.205Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/index.html
+1 -73
View File
@@ -193,70 +193,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="rpc-core/">
<a href="rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="rpc-core/classes/_index_.rpc.html">
<a href="rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="rpc-rx/">
<a href="rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="rpc-rx/classes/_index_.rpcrx.html">
<a href="rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -440,14 +376,6 @@
<li><a href="rpc-provider/classes/_ws_index_.wsprovider.html">WsProvider</a></li>
</ul>
</li>
<li><a href="rpc-core/">rpc-core</a><ul>
<li><a href="rpc-core/classes/_index_.rpc.html">Rpc</a></li>
</ul>
</li>
<li><a href="rpc-rx/">rpc-rx</a><ul>
<li><a href="rpc-rx/classes/_index_.rpcrx.html">RpcRx</a></li>
</ul>
</li>
</ul>
<h2 id="examples">Examples</h2>
<ul>
@@ -513,7 +441,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-11T16:48:47.503Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"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-11T18:57:39.201Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/rpc-core/SUMMARY.md
-1
View File
@@ -1,3 +1,2 @@
* [&quot;defaults&quot;](modules/_defaults_.md)
* [&quot;index&quot;](modules/_index_.md)
* [Rpc](classes/_index_.rpc.md)
docs/rpc-core/classes/_index_.rpc.html
-622
View File
@@ -1,622 +0,0 @@
<!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="../../rpc-rx/" />
<link rel="prev" href="../" />
</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="chapter " data-level="1.4" data-path="../">
<a href="../">
rpc-core
</a>
<ul class="articles">
<li class="chapter active" data-level="1.4.1" data-path="_index_.rpc.html">
<a href="_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
</ul>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../../examples-rpc/">
<a href="../../examples-rpc/">
RPC
</a>
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../../examples-rpc/01_simple_connect/">
<a href="../../examples-rpc/01_simple_connect/">
Simple connect
</a>
</li>
<li class="chapter " data-level="2.1.2" data-path="../../examples-rpc/02_listen_to_blocks/">
<a href="../../examples-rpc/02_listen_to_blocks/">
Listen to blocks
</a>
</li>
<li class="chapter " data-level="2.1.3" data-path="../../examples-rpc/03_listen_to_balance_change/">
<a href="../../examples-rpc/03_listen_to_balance_change/">
Listen to balance change
</a>
</li>
<li class="chapter " data-level="2.1.4" data-path="../../examples-rpc/04_generate_account/">
<a href="../../examples-rpc/04_generate_account/">
Generate Accounts
</a>
</li>
<li class="chapter " data-level="2.1.5" data-path="../../examples-rpc/05_read_storage/">
<a href="../../examples-rpc/05_read_storage/">
Read Storage
</a>
</li>
<li class="chapter " data-level="2.1.6" data-path="../../examples-rpc/06_craft_extrinsic/">
<a href="../../examples-rpc/06_craft_extrinsic/">
Craft Extrinsic
</a>
</li>
<li class="chapter " data-level="2.1.7" data-path="../../examples-rpc/07_transfer_dots/">
<a href="../../examples-rpc/07_transfer_dots/">
Transfer DOTs
</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">
<p><em><strong>name</strong></em>: Rpc</p>
<p><em><strong>summary</strong></em>: The API may use a HTTP or WebSockets provider.</p>
<p><em><strong>description</strong></em>: It allows for querying a Polkadot Client Node. WebSockets provider is recommended since HTTP provider only supports basic querying.</p>
<div class="mermaid">
graph LR;
A[Api] --&gt; |WebSockets| B[WsProvider];
B --&gt; |endpoint| C[ws://127.0.0.1:9944]
</div>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-core&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">WsProvider</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider/ws&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;ws://127.0.0.1:9944&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">api</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">Api</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<h1 id="hierarchy">Hierarchy</h1>
<p><strong>Rpc</strong></p>
<h1 id="implements">Implements</h1>
<ul>
<li><code>RpcInterface</code></li>
</ul>
<h1 id="constructors">Constructors</h1>
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Rpc</strong>(provider?: <em><code>ProviderInterface</code></em>): <a href="_index_.rpc.html">Rpc</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L47" target="_blank">index.ts:47</a></em></p>
<p><em><strong>constructor</strong></em>: Default constructor for the Api Object</p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Default value</code> provider</td>
<td><code>ProviderInterface</code></td>
<td>new WsProvider(defaults.WS_URL)</td>
<td>An API provider using HTTP or WebSocket</td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <a href="_index_.rpc.html">Rpc</a></p>
<hr>
<h1 id="properties">Properties</h1>
<p><a id="_provider"></a></p>
<h2 id="provider">_provider</h2>
<p><strong>&#x25CF; _provider</strong>: <em><code>ProviderInterface</code></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L43" target="_blank">index.ts:43</a></em></p>
<hr>
<p><a id="author"></a></p>
<h2 id="author">author</h2>
<p><strong>&#x25CF; author</strong>: <em><code>RpcInterface$Section</code></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L44" target="_blank">index.ts:44</a></em></p>
<hr>
<p><a id="chain"></a></p>
<h2 id="chain">chain</h2>
<p><strong>&#x25CF; chain</strong>: <em><code>RpcInterface$Section</code></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L45" target="_blank">index.ts:45</a></em></p>
<hr>
<p><a id="state"></a></p>
<h2 id="state">state</h2>
<p><strong>&#x25CF; state</strong>: <em><code>RpcInterface$Section</code></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L46" target="_blank">index.ts:46</a></em></p>
<hr>
<p><a id="system"></a></p>
<h2 id="system">system</h2>
<p><strong>&#x25CF; system</strong>: <em><code>RpcInterface$Section</code></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L47" target="_blank">index.ts:47</a></em></p>
<hr>
<h1 id="methods">Methods</h1>
<p><a id="signature"></a></p>
<h2 id="static-signature"><code>&lt;Static&gt;</code> signature</h2>
<p>&#x25B8; <strong>signature</strong>(__namedParameters: <em><code>object</code></em>): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L80" target="_blank">index.ts:80</a></em></p>
<p><em><strong>name</strong></em>: signature</p>
<p><em><strong>summary</strong></em>: Returns a string representation of the method with inputs and outputs.</p>
<p><em><strong>description</strong></em>: Formats the name, inputs and outputs into a human-readable string. This contains the input parameter names input types and output type.</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-core&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-ident">Api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">signature</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">{</span>&#xA0;<span class="sunlight-ident">name</span><span class="sunlight-operator">:</span>&#xA0;<span class="sunlight-string">&apos;test_method&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">params</span><span class="sunlight-operator">:</span>&#xA0;<span class="sunlight-punctuation">[</span>&#xA0;<span class="sunlight-punctuation">{</span>&#xA0;<span class="sunlight-ident">name</span><span class="sunlight-operator">:</span>&#xA0;<span class="sunlight-string">&apos;dest&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">type</span><span class="sunlight-operator">:</span>&#xA0;<span class="sunlight-string">&apos;Address&apos;</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-punctuation">]</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">type</span><span class="sunlight-operator">:</span>&#xA0;<span class="sunlight-string">&apos;Address&apos;</span>&#xA0;<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>&#xA0;<span class="sunlight-comment">//&#xA0;=&gt;&#xA0;test_method&#xA0;(dest:&#xA0;Address):&#xA0;Address</span>
</span></pre></div></div></code></pre>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>__namedParameters</td>
<td><code>object</code></td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <code>string</code></p>
<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="../" class="navigation navigation-prev " aria-label="Previous page: rpc-core">
<i class="fa fa-angle-left"></i>
</a>
<a href="../../rpc-rx/" class="navigation navigation-next " aria-label="Next page: rpc-rx">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Rpc","level":"1.4.1","depth":2,"next":{"title":"rpc-rx","level":"1.5","depth":1,"path":"rpc-rx/README.md","ref":"rpc-rx/README.md","articles":[{"title":"RpcRx","level":"1.5.1","depth":2,"path":"rpc-rx/classes/_index_.rpcrx.md","ref":"rpc-rx/classes/_index_.rpcrx.md","articles":[]}]},"previous":{"title":"rpc-core","level":"1.4","depth":1,"path":"rpc-core/README.md","ref":"rpc-core/README.md","articles":[{"title":"Rpc","level":"1.4.1","depth":2,"path":"rpc-core/classes/_index_.rpc.md","ref":"rpc-core/classes/_index_.rpc.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-core/classes/_index_.rpc.md","mtime":"2018-10-11T16:51:00.132Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"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/rpc-core/classes/_index_.rpc.md
+8 -8
View File
@@ -37,7 +37,7 @@ const api = new Api(provider);
⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md)
*Defined in [index.ts:47](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L47)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-core/src/index.ts#L45)*
*__constructor__*: Default constructor for the Api Object
@@ -45,7 +45,7 @@ const api = new Api(provider);
| Param | Type | Default value | Description |
| ------ | ------ | ------ | ------ |
| `Default value` provider | `ProviderInterface` | new WsProvider(defaults.WS_URL) | An API provider using HTTP or WebSocket |
| `Default value` provider | `ProviderInterface` | new WsProvider() | An API provider using HTTP or WebSocket |
**Returns:** [Rpc](_index_.rpc.md)
@@ -59,7 +59,7 @@ ___
**● _provider**: *`ProviderInterface`*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L43)*
*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-core/src/index.ts#L41)*
___
<a id="author"></a>
@@ -68,7 +68,7 @@ ___
**● author**: *`RpcInterface$Section`*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L44)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-core/src/index.ts#L42)*
___
<a id="chain"></a>
@@ -77,7 +77,7 @@ ___
**● chain**: *`RpcInterface$Section`*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L45)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-core/src/index.ts#L43)*
___
<a id="state"></a>
@@ -86,7 +86,7 @@ ___
**● state**: *`RpcInterface$Section`*
*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L46)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-core/src/index.ts#L44)*
___
<a id="system"></a>
@@ -95,7 +95,7 @@ ___
**● system**: *`RpcInterface$Section`*
*Defined in [index.ts:47](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L47)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-core/src/index.ts#L45)*
___
@@ -107,7 +107,7 @@ ___
▸ **signature**(__namedParameters: *`object`*): `string`
*Defined in [index.ts:80](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-core/src/index.ts#L80)*
*Defined in [index.ts:78](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-core/src/index.ts#L78)*
*__name__*: signature
docs/rpc-core/index.html
-570
View File
@@ -1,570 +0,0 @@
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>rpc-core · 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="classes/_index_.rpc.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="chapter active" data-level="1.4" data-path="./">
<a href="./">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="classes/_index_.rpc.html">
<a href="classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../rpc-rx/">
<a href="../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../rpc-rx/classes/_index_.rpcrx.html">
<a href="../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
</ul>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../examples-rpc/">
<a href="../examples-rpc/">
RPC
</a>
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../examples-rpc/01_simple_connect/">
<a href="../examples-rpc/01_simple_connect/">
Simple connect
</a>
</li>
<li class="chapter " data-level="2.1.2" data-path="../examples-rpc/02_listen_to_blocks/">
<a href="../examples-rpc/02_listen_to_blocks/">
Listen to blocks
</a>
</li>
<li class="chapter " data-level="2.1.3" data-path="../examples-rpc/03_listen_to_balance_change/">
<a href="../examples-rpc/03_listen_to_balance_change/">
Listen to balance change
</a>
</li>
<li class="chapter " data-level="2.1.4" data-path="../examples-rpc/04_generate_account/">
<a href="../examples-rpc/04_generate_account/">
Generate Accounts
</a>
</li>
<li class="chapter " data-level="2.1.5" data-path="../examples-rpc/05_read_storage/">
<a href="../examples-rpc/05_read_storage/">
Read Storage
</a>
</li>
<li class="chapter " data-level="2.1.6" data-path="../examples-rpc/06_craft_extrinsic/">
<a href="../examples-rpc/06_craft_extrinsic/">
Craft Extrinsic
</a>
</li>
<li class="chapter " data-level="2.1.7" data-path="../examples-rpc/07_transfer_dots/">
<a href="../examples-rpc/07_transfer_dots/">
Transfer DOTs
</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-core</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">
<h1 id="polkadotrpc-core">@polkadot/rpc-core</h1>
<p>This library provides a clean wrapper around all the methods exposed by a Polkadot network client.</p>
<h2 id="usage">Usage</h2>
<p>Installation -</p>
<pre><code>yarn add @polkadot/rpc-core
</code></pre><p>Initialisation -</p>
<pre><code class="lang-js"><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">Rpc</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-core&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">WsProvider</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider/ws&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;http://127.0.0.1:9944&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">api</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">Rpc</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<p>Retrieving the block header object for a given block header hash (a 0x-prefixed hex string with length of 64) -</p>
<pre><code class="lang-js"><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">chain</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">getHeader</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;0x1234567890&apos;</span><span class="sunlight-punctuation">)</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">then</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">header</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">header</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">)</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-keyword">catch</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<p>Retrieving the best block number, parent hash, state root hash, extrinsics root hash, and digest (once-off) -</p>
<pre><code class="lang-js"><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">chain</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">getHead</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">then</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">headerHash</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-keyword">return</span>&#xA0;<span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">chain</span><span class="sunlight-operator">.</span><span class="sunlight-ident">getHeader</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">headerHash</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">then</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">header</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">`</span><span class="sunlight-ident">best</span>&#xA0;<span class="sunlight-punctuation">#</span><span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">header</span><span class="sunlight-operator">.</span><span class="sunlight-ident">blockNumber</span><span class="sunlight-operator">.</span><span class="sunlight-ident">toString</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">`</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">`</span><span class="sunlight-ident">parentHash</span><span class="sunlight-operator">:</span>&#xA0;<span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">header</span><span class="sunlight-operator">.</span><span class="sunlight-ident">parentHash</span><span class="sunlight-operator">.</span><span class="sunlight-ident">toString</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">`</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">`</span><span class="sunlight-ident">stateRoot</span><span class="sunlight-operator">:</span>&#xA0;<span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">header</span><span class="sunlight-operator">.</span><span class="sunlight-ident">stateRoot</span><span class="sunlight-operator">.</span><span class="sunlight-ident">toString</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">`</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">`</span><span class="sunlight-ident">extrinsicsRoot</span><span class="sunlight-operator">:</span>&#xA0;<span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">header</span><span class="sunlight-operator">.</span><span class="sunlight-ident">extrinsicsRoot</span><span class="sunlight-operator">.</span><span class="sunlight-ident">toString</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">`</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">`</span><span class="sunlight-ident">digest</span><span class="sunlight-operator">:</span>&#xA0;<span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">header</span><span class="sunlight-operator">.</span><span class="sunlight-ident">digest</span><span class="sunlight-operator">.</span><span class="sunlight-ident">toString</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">`</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-keyword">catch</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;error:&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">error</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<p>Retrieving best header via subscription -</p>
<pre><code class="lang-js"><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">chain</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">newHead</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">header</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-keyword">if</span>&#xA0;<span class="sunlight-punctuation">(</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;error:&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">error</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-punctuation">}</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">`</span><span class="sunlight-ident">best</span>&#xA0;<span class="sunlight-punctuation">#</span><span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">header</span><span class="sunlight-operator">.</span><span class="sunlight-ident">blockNumber</span><span class="sunlight-operator">.</span><span class="sunlight-ident">toString</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">`</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">then</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">subscriptionId</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">`</span><span class="sunlight-ident">subscriptionId</span><span class="sunlight-operator">:</span>&#xA0;<span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">subscriptionId</span><span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">`</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-comment">//&#xA0;id&#xA0;for&#xA0;the&#xA0;subscription,&#xA0;can&#xA0;unsubscribe&#xA0;via</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-comment">//&#xA0;api.chain.newHead.unsubscribe(subscriptionId);</span>
&#xA0;&#xA0;<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-keyword">catch</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;error&#xA0;subscribing:&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">error</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
</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="classes/_index_.rpc.html" class="navigation navigation-next " aria-label="Next page: Rpc">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"rpc-core","level":"1.4","depth":1,"next":{"title":"Rpc","level":"1.4.1","depth":2,"path":"rpc-core/classes/_index_.rpc.md","ref":"rpc-core/classes/_index_.rpc.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":"rpc-core/README.md","mtime":"2018-10-11T16:51:00.004Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"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/rpc-provider/README.md
+25 -5
View File
@@ -2,7 +2,14 @@
@polkadot/rpc-provider
======================
Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. 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. API interfaces building on top these providers can support various transports with the same underlying interfaces.
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.
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.
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.
Usage
-----
@@ -13,14 +20,27 @@ Installation -
yarn add @polkadot/rpc-provider
```
Initialisation -
WebSocket Initialisation -
```js
```javascript
import WsProvider from '@polkadot/rpc-provider/ws';
const provider = new WsProvider('http://127.0.0.1:9944');
// this is the actual default endpoint
const provider = new WsProvider('ws://127.0.0.1:9944');
const version = await provider.send('client_version', []);
console.log('clientVersion', version);
console.log('client version', version);
```
HTTP Initialisation -
```javascript
import { HttpProvider } from '@polkadot/rpc-provider';
// this is the actual default endpoint
const provider = new HttpProvider('http://127.0.0.1:9933');
const version = await provider.send('chain_getBlockHash', []);
console.log('latest block Hash', hash);
```
docs/rpc-provider/SUMMARY.md
+1
View File
@@ -2,6 +2,7 @@
* [&quot;coder/json/encodeJson&quot;](modules/_coder_json_encodejson_.md)
* [&quot;coder/json/encodeObject&quot;](modules/_coder_json_encodeobject_.md)
* [&quot;coder/json/index&quot;](modules/_coder_json_index_.md)
* [&quot;defaults&quot;](modules/_defaults_.md)
* [&quot;http/index&quot;](modules/_http_index_.md)
* [HttpProvider](classes/_http_index_.httpprovider.md)
* [&quot;http/polyfill&quot;](modules/_http_polyfill_.md)
docs/rpc-provider/classes/_http_index_.httpprovider.html
+15 -76
View File
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -428,15 +364,16 @@
<section class="normal markdown-section">
<p><em><strong>name</strong></em>: HttpProvider</p>
<h1 id="polkadotrpc-providerhttps">@polkadot/rpc-provider/https</h1>
<p><em><strong>name</strong></em>: HttpProvider</p>
<p><em><strong>summary</strong></em>: The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port.</p>
<p><em><strong>description</strong></em>: It does not support subscriptions so you won&apos;t be able to listen to events such as new blocks or balance changes. It is usually preferrable using the <a href="_ws_index_.wsprovider.html">WsProvider</a>.</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">Rpc</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-core&apos;</span><span class="sunlight-punctuation">;</span>
<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>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">HttpProvider</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider/http&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">HttpProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;http://127.0.0.1:9933&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">api</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">Rpc</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">api</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">Api</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<p><em><strong>see</strong></em>: <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
<h1 id="hierarchy">Hierarchy</h1>
@@ -448,21 +385,23 @@
<h1 id="constructors">Constructors</h1>
<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/e103e98/packages/rpc-provider/src/http/index.ts#L40" target="_blank">http/index.ts:40</a></em></p>
<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/2b88a8f/packages/rpc-provider/src/http/index.ts#L43" target="_blank">http/index.ts:43</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>endpoint</td>
<td><code>Default value</code> endpoint</td>
<td><code>string</code></td>
<td>defaults.HTTP_URL</td>
<td>The endpoint url starting with http://</td>
</tr>
</tbody>
@@ -473,7 +412,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/e103e98/packages/rpc-provider/src/http/index.ts#L57" target="_blank">http/index.ts:57</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/http/index.ts#L60" target="_blank">http/index.ts:60</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>
@@ -481,7 +420,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/e103e98/packages/rpc-provider/src/http/index.ts#L65" target="_blank">http/index.ts:65</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/http/index.ts#L68" target="_blank">http/index.ts:68</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>
@@ -508,7 +447,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/e103e98/packages/rpc-provider/src/http/index.ts#L72" target="_blank">http/index.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/http/index.ts#L75" target="_blank">http/index.ts:75</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>
@@ -534,7 +473,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/e103e98/packages/rpc-provider/src/http/index.ts#L94" target="_blank">http/index.ts:94</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/http/index.ts#L97" target="_blank">http/index.ts:97</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>
@@ -568,7 +507,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/e103e98/packages/rpc-provider/src/http/index.ts#L103" target="_blank">http/index.ts:103</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/http/index.ts#L106" target="_blank">http/index.ts:106</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>
@@ -638,7 +577,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-11T16:51:08.021Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"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-11T19:00:13.361Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/classes/_http_index_.httpprovider.md
+14 -12
View File
@@ -1,5 +1,7 @@
@polkadot/rpc-provider/https
============================
*__name__*: HttpProvider
*__summary__*: The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port.
@@ -8,11 +10,11 @@
*__example__*:
```javascript
import Rpc from '@polkadot/rpc-core';
import Api from '@polkadot/api/promise';
import HttpProvider from '@polkadot/rpc-provider/http';
const provider = new HttpProvider('http://127.0.0.1:9933');
const api = new Rpc(provider);
const api = new Api(provider);
```
*__see__*: [WsProvider](_ws_index_.wsprovider.md)
@@ -31,15 +33,15 @@ const api = new Rpc(provider);
## constructor
⊕ **new HttpProvider**(endpoint: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/http/index.ts#L40)*
*Defined in [http/index.ts:43](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/http/index.ts#L43)*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| endpoint | `string` | The endpoint url starting with http:// |
| Param | Type | Default value | Description |
| ------ | ------ | ------ | ------ |
| `Default value` endpoint | `string` | defaults.HTTP_URL | The endpoint url starting with http:// |
**Returns:** [HttpProvider](_http_index_.httpprovider.md)
@@ -53,7 +55,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [http/index.ts:57](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/http/index.ts#L57)*
*Defined in [http/index.ts:60](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/http/index.ts#L60)*
*__summary__*: Whether the node is connected or not.
@@ -67,7 +69,7 @@ ___
▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void`
*Defined in [http/index.ts:65](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/http/index.ts#L65)*
*Defined in [http/index.ts:68](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/http/index.ts#L68)*
*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -89,7 +91,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [http/index.ts:72](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/http/index.ts#L72)*
*Defined in [http/index.ts:75](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/http/index.ts#L75)*
*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
@@ -109,7 +111,7 @@ ___
▸ **subscribe**(types: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *`ProviderInterface$Callback`*): `Promise`<`number`>
*Defined in [http/index.ts:94](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/http/index.ts#L94)*
*Defined in [http/index.ts:97](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/http/index.ts#L97)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -131,7 +133,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [http/index.ts:103](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/http/index.ts#L103)*
*Defined in [http/index.ts:106](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/http/index.ts#L106)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
docs/rpc-provider/classes/_ws_index_.wsprovider.html
+17 -80
View File
@@ -65,7 +65,7 @@
<link rel="shortcut icon" href="../../gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="../../rpc-core/" />
<link rel="next" href="../../examples-rpc/" />
<link rel="prev" href="_http_index_.httpprovider.html" />
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../../rpc-rx/">
<a href="../../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../../rpc-rx/classes/_index_.rpcrx.html">
<a href="../../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -428,15 +364,16 @@
<section class="normal markdown-section">
<p><em><strong>name</strong></em>: WsProvider</p>
<h1 id="polkadotrpc-providerws">@polkadot/rpc-provider/ws</h1>
<p><em><strong>name</strong></em>: WsProvider</p>
<p><em><strong>summary</strong></em>: The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port.</p>
<p><em><strong>description</strong></em>: Unlike the <a href="_http_index_.httpprovider.html">HttpProvider</a>, it does support subscriptions and allows listening to events such as new blocks or balance changes.</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">Rpc</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-core&apos;</span><span class="sunlight-punctuation">;</span>
<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>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">WsProvider</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider/ws&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;ws://127.0.0.1:9944&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">api</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">Rpc</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">api</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">Api</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<p><em><strong>see</strong></em>: <a href="_http_index_.httpprovider.html">HttpProvider</a></p>
<h1 id="hierarchy">Hierarchy</h1>
@@ -448,8 +385,8 @@
<h1 id="constructors">Constructors</h1>
<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/e103e98/packages/rpc-provider/src/ws/index.ts#L74" target="_blank">ws/index.ts:74</a></em></p>
<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/2b88a8f/packages/rpc-provider/src/ws/index.ts#L77" target="_blank">ws/index.ts:77</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -462,9 +399,9 @@
</thead>
<tbody>
<tr>
<td>endpoint</td>
<td><code>Default value</code> endpoint</td>
<td><code>string</code></td>
<td>-</td>
<td>defaults.WS_URL</td>
<td>The endpoint url. Usually `ws://ip:9944` or `wss://ip:9944`</td>
</tr>
<tr>
@@ -481,7 +418,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/e103e98/packages/rpc-provider/src/ws/index.ts#L104" target="_blank">ws/index.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L107" target="_blank">ws/index.ts:107</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>
@@ -489,7 +426,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/e103e98/packages/rpc-provider/src/ws/index.ts#L121" target="_blank">ws/index.ts:121</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L124" target="_blank">ws/index.ts:124</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>
@@ -497,7 +434,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/e103e98/packages/rpc-provider/src/ws/index.ts#L130" target="_blank">ws/index.ts:130</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L133" target="_blank">ws/index.ts:133</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>
@@ -526,7 +463,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/e103e98/packages/rpc-provider/src/ws/index.ts#L137" target="_blank">ws/index.ts:137</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L140" target="_blank">ws/index.ts:140</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>
@@ -556,7 +493,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/e103e98/packages/rpc-provider/src/ws/index.ts#L193" target="_blank">ws/index.ts:193</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L196" target="_blank">ws/index.ts:196</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>
@@ -607,7 +544,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/e103e98/packages/rpc-provider/src/ws/index.ts#L202" target="_blank">ws/index.ts:202</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L205" target="_blank">ws/index.ts:205</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>
@@ -666,7 +603,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
</a>
<a href="../../rpc-core/" class="navigation navigation-next " aria-label="Next page: rpc-core">
<a href="../../examples-rpc/" class="navigation navigation-next " aria-label="Next page: RPC">
<i class="fa fa-angle-right"></i>
</a>
@@ -677,7 +614,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"rpc-core","level":"1.4","depth":1,"path":"rpc-core/README.md","ref":"rpc-core/README.md","articles":[{"title":"Rpc","level":"1.4.1","depth":2,"path":"rpc-core/classes/_index_.rpc.md","ref":"rpc-core/classes/_index_.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-11T16:51:08.089Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"RPC","level":"2.1","depth":1,"path":"examples-rpc/README.md","ref":"examples-rpc/README.md","articles":[{"title":"Simple connect","level":"2.1.1","depth":2,"path":"examples-rpc/01_simple_connect/README.md","ref":"examples-rpc/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"2.1.2","depth":2,"path":"examples-rpc/02_listen_to_blocks/README.md","ref":"examples-rpc/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"2.1.3","depth":2,"path":"examples-rpc/03_listen_to_balance_change/README.md","ref":"examples-rpc/03_listen_to_balance_change/README.md","articles":[]},{"title":"Generate Accounts","level":"2.1.4","depth":2,"path":"examples-rpc/04_generate_account/README.md","ref":"examples-rpc/04_generate_account/README.md","articles":[]},{"title":"Read Storage","level":"2.1.5","depth":2,"path":"examples-rpc/05_read_storage/README.md","ref":"examples-rpc/05_read_storage/README.md","articles":[]},{"title":"Craft Extrinsic","level":"2.1.6","depth":2,"path":"examples-rpc/06_craft_extrinsic/README.md","ref":"examples-rpc/06_craft_extrinsic/README.md","articles":[]},{"title":"Transfer DOTs","level":"2.1.7","depth":2,"path":"examples-rpc/07_transfer_dots/README.md","ref":"examples-rpc/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-11T19:00:13.433Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/classes/_ws_index_.wsprovider.md
+13 -11
View File
@@ -1,5 +1,7 @@
@polkadot/rpc-provider/ws
=========================
*__name__*: WsProvider
*__summary__*: The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port.
@@ -8,11 +10,11 @@
*__example__*:
```javascript
import Rpc from '@polkadot/rpc-core';
import Api from '@polkadot/api/promise';
import WsProvider from '@polkadot/rpc-provider/ws';
const provider = new WsProvider('ws://127.0.0.1:9944');
const api = new Rpc(provider);
const api = new Api(provider);
```
*__see__*: [HttpProvider](_http_index_.httpprovider.md)
@@ -31,15 +33,15 @@ const api = new Rpc(provider);
## constructor
⊕ **new WsProvider**(endpoint: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
*Defined in [ws/index.ts:74](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/ws/index.ts#L74)*
*Defined in [ws/index.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L77)*
**Parameters:**
| Param | Type | Default value | Description |
| ------ | ------ | ------ | ------ |
| endpoint | `string` | - | The endpoint url. Usually \`ws://ip:9944\` or \`wss://ip:9944\` |
| `Default value` endpoint | `string` | defaults.WS_URL | The endpoint url. Usually \`ws://ip:9944\` or \`wss://ip:9944\` |
| `Default value` autoConnect | `boolean` | true | Whether to connect automatically or not. |
**Returns:** [WsProvider](_ws_index_.wsprovider.md)
@@ -54,7 +56,7 @@ ___
▸ **connect**(): `void`
*Defined in [ws/index.ts:104](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/ws/index.ts#L104)*
*Defined in [ws/index.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L107)*
*__summary__*: Manually connect
@@ -69,7 +71,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [ws/index.ts:121](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/ws/index.ts#L121)*
*Defined in [ws/index.ts:124](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L124)*
*__summary__*: Whether the node is connected or not.
@@ -83,7 +85,7 @@ ___
▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void`
*Defined in [ws/index.ts:130](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/ws/index.ts#L130)*
*Defined in [ws/index.ts:133](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L133)*
*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
@@ -103,7 +105,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
*Defined in [ws/index.ts:137](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/ws/index.ts#L137)*
*Defined in [ws/index.ts:140](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L140)*
*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
@@ -124,7 +126,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *`ProviderInterface$Callback`*): `Promise`<`number`>
*Defined in [ws/index.ts:193](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/ws/index.ts#L193)*
*Defined in [ws/index.ts:196](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L196)*
*__name__*: subscribe
@@ -161,7 +163,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [ws/index.ts:202](https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-provider/src/ws/index.ts#L202)*
*Defined in [ws/index.ts:205](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/ws/index.ts#L205)*
*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
docs/rpc-provider/index.html
+19 -70
View File
@@ -195,70 +195,6 @@
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../rpc-core/">
<a href="../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../rpc-core/classes/_index_.rpc.html">
<a href="../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../rpc-rx/">
<a href="../rpc-rx/">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../rpc-rx/classes/_index_.rpcrx.html">
<a href="../rpc-rx/classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
@@ -429,17 +365,30 @@
<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. 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. API interfaces building on top these providers can support various transports with the same underlying interfaces.</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 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>
<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>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>
<pre><code>yarn add @polkadot/rpc-provider
</code></pre><p>Initialisation -</p>
<pre><code class="lang-js"><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">WsProvider</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider/ws&apos;</span><span class="sunlight-punctuation">;</span>
</code></pre><p>WebSocket Initialisation -</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">WsProvider</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider/ws&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;http://127.0.0.1:9944&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-comment">//&#xA0;this&#xA0;is&#xA0;the&#xA0;actual&#xA0;default&#xA0;endpoint</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;ws://127.0.0.1:9944&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">version</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-ident">await</span>&#xA0;<span class="sunlight-ident">provider</span><span class="sunlight-operator">.</span><span class="sunlight-ident">send</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;client_version&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-punctuation">[</span><span class="sunlight-punctuation">]</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;clientVersion&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">version</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;client&#xA0;version&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">version</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<p>HTTP Initialisation -</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-punctuation">{</span>&#xA0;<span class="sunlight-ident">HttpProvider</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-comment">//&#xA0;this&#xA0;is&#xA0;the&#xA0;actual&#xA0;default&#xA0;endpoint</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">HttpProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;http://127.0.0.1:9933&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">version</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-ident">await</span>&#xA0;<span class="sunlight-ident">provider</span><span class="sunlight-operator">.</span><span class="sunlight-ident">send</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;chain_getBlockHash&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-punctuation">[</span><span class="sunlight-punctuation">]</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;latest&#xA0;block&#xA0;Hash&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">hash</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
@@ -484,7 +433,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-11T16:51:07.869Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"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-11T19:00:13.197Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T19:01:29.429Z"},"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/e103e98/packages/rpc-provider/src/coder/json/decodeResponse.ts#L22)*
*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-provider/src/coder/json/encodeJson.ts#L9)*
*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-provider/src/coder/json/encodeObject.ts#L8)*
*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-provider/src/coder/json/index.ts#L12)*
*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/coder/json/index.ts#L12)*
**Returns:** `RpcCoder`
docs/rpc-core/modules/_defaults_.md → docs/rpc-provider/modules/_defaults_.md
View File
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/e103e98/packages/rpc-provider/src/mock/index.ts#L18)*
*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-provider/src/mock/mocks.ts#L63)*
*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-provider/src/mock/on.ts#L8)*
*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-provider/src/mock/send.ts#L7)*
*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-provider/src/mock/state.ts#L38)*
*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-provider/src/mock/subscribe.ts#L7)*
*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-provider/src/mock/unsubscribe.ts#L7)*
*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-provider/src/mock/unsubscribe.ts#L7)*
**Parameters:**
docs/rpc-rx/classes/_index_.rpcrx.html
-608
View File
@@ -1,608 +0,0 @@
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>RpcRx · 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-rpc/" />
<link rel="prev" href="../" />
</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="chapter " data-level="1.4" data-path="../../rpc-core/">
<a href="../../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../../rpc-core/classes/_index_.rpc.html">
<a href="../../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../">
<a href="../">
rpc-rx
</a>
<ul class="articles">
<li class="chapter active" data-level="1.5.1" data-path="_index_.rpcrx.html">
<a href="_index_.rpcrx.html">
RpcRx
</a>
</li>
</ul>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../../examples-rpc/">
<a href="../../examples-rpc/">
RPC
</a>
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../../examples-rpc/01_simple_connect/">
<a href="../../examples-rpc/01_simple_connect/">
Simple connect
</a>
</li>
<li class="chapter " data-level="2.1.2" data-path="../../examples-rpc/02_listen_to_blocks/">
<a href="../../examples-rpc/02_listen_to_blocks/">
Listen to blocks
</a>
</li>
<li class="chapter " data-level="2.1.3" data-path="../../examples-rpc/03_listen_to_balance_change/">
<a href="../../examples-rpc/03_listen_to_balance_change/">
Listen to balance change
</a>
</li>
<li class="chapter " data-level="2.1.4" data-path="../../examples-rpc/04_generate_account/">
<a href="../../examples-rpc/04_generate_account/">
Generate Accounts
</a>
</li>
<li class="chapter " data-level="2.1.5" data-path="../../examples-rpc/05_read_storage/">
<a href="../../examples-rpc/05_read_storage/">
Read Storage
</a>
</li>
<li class="chapter " data-level="2.1.6" data-path="../../examples-rpc/06_craft_extrinsic/">
<a href="../../examples-rpc/06_craft_extrinsic/">
Craft Extrinsic
</a>
</li>
<li class="chapter " data-level="2.1.7" data-path="../../examples-rpc/07_transfer_dots/">
<a href="../../examples-rpc/07_transfer_dots/">
Transfer DOTs
</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="../.." >RpcRx</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">
<p><em><strong>name</strong></em>: RpcRx</p>
<p><em><strong>summary</strong></em>: The RxJS API is a wrapper around the API.</p>
<p><em><strong>description</strong></em>: It allows wrapping API components with observables using RxJS.</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">RpcRx</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-rx&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">WsProvider</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider/ws&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;http://127.0.0.1:9944&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">api</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">RpcRx</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<h1 id="hierarchy">Hierarchy</h1>
<p><strong>RpcRx</strong></p>
<h1 id="implements">Implements</h1>
<ul>
<li><code>object</code></li>
</ul>
<h1 id="constructors">Constructors</h1>
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new RpcRx</strong>(providerOrRpc?: <em> <code>Rpc</code> | <code>ProviderInterface</code></em>): <a href="_index_.rpcrx.html">RpcRx</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-rx/src/index.ts#L45" target="_blank">index.ts:45</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Optional</code> providerOrRpc</td>
<td><code>Rpc</code> | <code>ProviderInterface</code></td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <a href="_index_.rpcrx.html">RpcRx</a></p>
<hr>
<h1 id="properties">Properties</h1>
<p><a id="author"></a></p>
<h2 id="author">author</h2>
<p><strong>&#x25CF; author</strong>: <em><code>RpcRxInterface$Section</code></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-rx/src/index.ts#L42" target="_blank">index.ts:42</a></em></p>
<hr>
<p><a id="chain"></a></p>
<h2 id="chain">chain</h2>
<p><strong>&#x25CF; chain</strong>: <em><code>RpcRxInterface$Section</code></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-rx/src/index.ts#L43" target="_blank">index.ts:43</a></em></p>
<hr>
<p><a id="state"></a></p>
<h2 id="state">state</h2>
<p><strong>&#x25CF; state</strong>: <em><code>RpcRxInterface$Section</code></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-rx/src/index.ts#L44" target="_blank">index.ts:44</a></em></p>
<hr>
<p><a id="system"></a></p>
<h2 id="system">system</h2>
<p><strong>&#x25CF; system</strong>: <em><code>RpcRxInterface$Section</code></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-rx/src/index.ts#L45" target="_blank">index.ts:45</a></em></p>
<hr>
<h1 id="methods">Methods</h1>
<p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>BehaviorSubject</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-rx/src/index.ts#L66" target="_blank">index.ts:66</a></em></p>
<p><strong>Returns:</strong> <code>BehaviorSubject</code>&lt;<code>boolean</code>&gt;</p>
<hr>
<p><a id="on"></a></p>
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><code>RpcRxInterface$Events</code></em>, handler: <em><code>function</code></em>): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/e103e98/packages/rpc-rx/src/index.ts#L70" target="_blank">index.ts:70</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td><code>RpcRxInterface$Events</code></td>
</tr>
<tr>
<td>handler</td>
<td><code>function</code></td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <code>void</code></p>
<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="../" class="navigation navigation-prev " aria-label="Previous page: rpc-rx">
<i class="fa fa-angle-left"></i>
</a>
<a href="../../examples-rpc/" class="navigation navigation-next " aria-label="Next page: RPC">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"RpcRx","level":"1.5.1","depth":2,"next":{"title":"RPC","level":"2.1","depth":1,"path":"examples-rpc/README.md","ref":"examples-rpc/README.md","articles":[{"title":"Simple connect","level":"2.1.1","depth":2,"path":"examples-rpc/01_simple_connect/README.md","ref":"examples-rpc/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"2.1.2","depth":2,"path":"examples-rpc/02_listen_to_blocks/README.md","ref":"examples-rpc/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"2.1.3","depth":2,"path":"examples-rpc/03_listen_to_balance_change/README.md","ref":"examples-rpc/03_listen_to_balance_change/README.md","articles":[]},{"title":"Generate Accounts","level":"2.1.4","depth":2,"path":"examples-rpc/04_generate_account/README.md","ref":"examples-rpc/04_generate_account/README.md","articles":[]},{"title":"Read Storage","level":"2.1.5","depth":2,"path":"examples-rpc/05_read_storage/README.md","ref":"examples-rpc/05_read_storage/README.md","articles":[]},{"title":"Craft Extrinsic","level":"2.1.6","depth":2,"path":"examples-rpc/06_craft_extrinsic/README.md","ref":"examples-rpc/06_craft_extrinsic/README.md","articles":[]},{"title":"Transfer DOTs","level":"2.1.7","depth":2,"path":"examples-rpc/07_transfer_dots/README.md","ref":"examples-rpc/07_transfer_dots/README.md","articles":[]}]},"previous":{"title":"rpc-rx","level":"1.5","depth":1,"path":"rpc-rx/README.md","ref":"rpc-rx/README.md","articles":[{"title":"RpcRx","level":"1.5.1","depth":2,"path":"rpc-rx/classes/_index_.rpcrx.md","ref":"rpc-rx/classes/_index_.rpcrx.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-rx/classes/_index_.rpcrx.md","mtime":"2018-10-11T16:51:15.905Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"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/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/e103e98/packages/rpc-rx/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-rx/src/index.ts#L42)*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-rx/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-rx/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-rx/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-rx/src/index.ts#L66)*
*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/rpc-rx/src/index.ts#L70)*
*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/2b88a8f/packages/rpc-rx/src/index.ts#L70)*
**Parameters:**
docs/rpc-rx/index.html
-519
View File
@@ -1,519 +0,0 @@
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>rpc-rx · 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="classes/_index_.rpcrx.html" />
<link rel="prev" href="../rpc-core/classes/_index_.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="chapter " data-level="1.4" data-path="../rpc-core/">
<a href="../rpc-core/">
rpc-core
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../rpc-core/classes/_index_.rpc.html">
<a href="../rpc-core/classes/_index_.rpc.html">
Rpc
</a>
</li>
</ul>
</li>
<li class="chapter active" data-level="1.5" data-path="./">
<a href="./">
rpc-rx
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="classes/_index_.rpcrx.html">
<a href="classes/_index_.rpcrx.html">
RpcRx
</a>
</li>
</ul>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../examples-rpc/">
<a href="../examples-rpc/">
RPC
</a>
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../examples-rpc/01_simple_connect/">
<a href="../examples-rpc/01_simple_connect/">
Simple connect
</a>
</li>
<li class="chapter " data-level="2.1.2" data-path="../examples-rpc/02_listen_to_blocks/">
<a href="../examples-rpc/02_listen_to_blocks/">
Listen to blocks
</a>
</li>
<li class="chapter " data-level="2.1.3" data-path="../examples-rpc/03_listen_to_balance_change/">
<a href="../examples-rpc/03_listen_to_balance_change/">
Listen to balance change
</a>
</li>
<li class="chapter " data-level="2.1.4" data-path="../examples-rpc/04_generate_account/">
<a href="../examples-rpc/04_generate_account/">
Generate Accounts
</a>
</li>
<li class="chapter " data-level="2.1.5" data-path="../examples-rpc/05_read_storage/">
<a href="../examples-rpc/05_read_storage/">
Read Storage
</a>
</li>
<li class="chapter " data-level="2.1.6" data-path="../examples-rpc/06_craft_extrinsic/">
<a href="../examples-rpc/06_craft_extrinsic/">
Craft Extrinsic
</a>
</li>
<li class="chapter " data-level="2.1.7" data-path="../examples-rpc/07_transfer_dots/">
<a href="../examples-rpc/07_transfer_dots/">
Transfer DOTs
</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-rx</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">
<h1 id="polkadotrpc-rx">@polkadot/rpc-rx</h1>
<p>An RxJs wrapper around the <a href="../rpc-core">@polkadot/rpc-core</a>.</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="../rpc-core/classes/_index_.rpc.html" class="navigation navigation-prev " aria-label="Previous page: Rpc">
<i class="fa fa-angle-left"></i>
</a>
<a href="classes/_index_.rpcrx.html" class="navigation navigation-next " aria-label="Next page: RpcRx">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"rpc-rx","level":"1.5","depth":1,"next":{"title":"RpcRx","level":"1.5.1","depth":2,"path":"rpc-rx/classes/_index_.rpcrx.md","ref":"rpc-rx/classes/_index_.rpcrx.md","articles":[]},"previous":{"title":"Rpc","level":"1.4.1","depth":2,"path":"rpc-core/classes/_index_.rpc.md","ref":"rpc-core/classes/_index_.rpc.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"mermaid-gb3":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-rx/README.md","mtime":"2018-10-11T16:51:15.797Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-11T16:52:14.838Z"},"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/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/e103e98/packages/type-extrinsics/src/fromMetadata.ts#L19)*
*Defined in [fromMetadata.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)*
*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/2b88a8f/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/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/e103e98/packages/type-jsonrpc/src/create/method.ts#L9)*
*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-jsonrpc/src/create/param.ts#L12)*
*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/utils/createFunction.ts#L16)*
*Defined in [utils/createFunction.ts:16](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/utils/createFunction.ts#L17)*
*Defined in [utils/createFunction.ts:17](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/fromMetadata.ts#L20)*
*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/storage.ts#L8)*
*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/storage.ts#L9)*
*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/substrate.ts#L44)*
*Defined in [substrate.ts:44](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/substrate.ts#L49)*
*Defined in [substrate.ts:49](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/substrate.ts#L59)*
*Defined in [substrate.ts:59](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/substrate.ts#L34)*
*Defined in [substrate.ts:34](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/substrate.ts#L54)*
*Defined in [substrate.ts:54](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/substrate.ts#L39)*
*Defined in [substrate.ts:39](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/type-storage/src/utils/createFunction.ts#L30)*
*Defined in [utils/createFunction.ts:30](https://github.com/polkadot-js/api/blob/2b88a8f/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/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/e103e98/packages/types/src/AccountId.ts#L20)*
*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L44)*
*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L50)*
*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L56)*
*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L60)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L32)*
*Defined in [AccountId.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L28)*
*Defined in [AccountId.ts:28](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountIndex.ts#L15)*
*Defined in [AccountIndex.ts:15](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L37)*
*Defined in [codec/U8a.ts:37](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountIndex.ts#L57)*
*Defined in [AccountIndex.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountIndex.ts#L63)*
*Defined in [AccountIndex.ts:63](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountIndex.ts#L71)*
*Defined in [AccountIndex.ts:71](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountIndex.ts#L75)*
*Defined in [AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountIndex.ts#L28)*
*Defined in [AccountIndex.ts:28](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountIndex.ts#L24)*
*Defined in [AccountIndex.ts:24](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountIndex.ts#L41)*
*Defined in [AccountIndex.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Address.ts#L22)*
*Defined in [Address.ts:22](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Address.ts#L54)*
*Defined in [Address.ts:54](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Address.ts#L62)*
*Defined in [Address.ts:62](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Address.ts#L68)*
*Defined in [Address.ts:68](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Address.ts#L76)*
*Defined in [Address.ts:76](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Address.ts#L80)*
*Defined in [Address.ts:80](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Address.ts#L84)*
*Defined in [Address.ts:84](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Address.ts#L29)*
*Defined in [Address.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L20)*
*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L44)*
*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L50)*
*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L56)*
*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L60)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L32)*
*Defined in [AccountId.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/AccountId.ts#L28)*
*Defined in [AccountId.ts:28](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/AccountId.ts#L28)*
**Parameters:**
docs/types/classes/_balance_.balance.md
+22 -22
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/e103e98/packages/types/src/U128.ts#L9)*
*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -128,7 +128,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/e103e98/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -149,7 +149,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/e103e98/packages/types/src/codec/UInt.ts#L67)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L67)*
**Parameters:**
@@ -168,7 +168,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -187,7 +187,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -206,7 +206,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L119)*
**Returns:** `boolean`
@@ -219,7 +219,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L123)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
@@ -238,7 +238,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -257,7 +257,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -276,7 +276,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -295,7 +295,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/e103e98/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -308,7 +308,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/e103e98/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -323,7 +323,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/e103e98/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -336,7 +336,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/e103e98/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -351,7 +351,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/e103e98/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -366,7 +366,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/e103e98/packages/types/src/codec/UInt.ts#L83)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L83)*
**Parameters:**
@@ -385,7 +385,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/e103e98/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bft.ts#L22)*
*Defined in [Bft.ts:22](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bft.ts#L30)*
*Defined in [Bft.ts:30](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bft.ts#L34)*
*Defined in [Bft.ts:34](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L60)*
*Defined in [codec/Tuple.ts:60](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L29)*
*Defined in [codec/Tuple.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L50)*
*Defined in [codec/Tuple.ts:50](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bft.ts#L46)*
*Defined in [Bft.ts:46](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bft.ts#L54)*
*Defined in [Bft.ts:54](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bft.ts#L58)*
*Defined in [Bft.ts:58](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L60)*
*Defined in [codec/Tuple.ts:60](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L29)*
*Defined in [codec/Tuple.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L50)*
*Defined in [codec/Tuple.ts:50](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bft.ts#L69)*
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bft.ts#L80)*
*Defined in [Bft.ts:80](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bft.ts#L84)*
*Defined in [Bft.ts:84](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bft.ts#L88)*
*Defined in [Bft.ts:88](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L118)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L152)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L98)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Block.ts#L20)*
*Defined in [Block.ts:20](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Block.ts#L28)*
*Defined in [Block.ts:28](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Block.ts#L33)*
*Defined in [Block.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Block.ts#L39)*
*Defined in [Block.ts:39](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L118)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L152)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L98)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/types/classes/_blocknumber_.blocknumber.md
+22 -22
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/e103e98/packages/types/src/U64.ts#L9)*
*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -128,7 +128,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/e103e98/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -149,7 +149,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/e103e98/packages/types/src/codec/UInt.ts#L67)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L67)*
**Parameters:**
@@ -168,7 +168,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -187,7 +187,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -206,7 +206,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L119)*
**Returns:** `boolean`
@@ -219,7 +219,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L123)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
@@ -238,7 +238,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -257,7 +257,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -276,7 +276,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -295,7 +295,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/e103e98/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -308,7 +308,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/e103e98/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -323,7 +323,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/e103e98/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -336,7 +336,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/e103e98/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -351,7 +351,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/e103e98/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -366,7 +366,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/e103e98/packages/types/src/codec/UInt.ts#L83)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L83)*
**Parameters:**
@@ -385,7 +385,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/e103e98/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bool.ts#L9)*
*Defined in [Bool.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bool.ts#L25)*
*Defined in [Bool.ts:25](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bool.ts#L29)*
*Defined in [Bool.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bool.ts#L35)*
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bool.ts#L41)*
*Defined in [Bool.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bool.ts#L49)*
*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bool.ts#L45)*
*Defined in [Bool.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bool.ts#L16)*
*Defined in [Bool.ts:16](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bytes.ts#L18)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bytes.ts#L45)*
*Defined in [Bytes.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bytes.ts#L49)*
*Defined in [Bytes.ts:49](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L41)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bytes.ts#L53)*
*Defined in [Bytes.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bytes.ts#L61)*
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Bytes.ts#L23)*
*Defined in [Bytes.ts:23](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
docs/types/classes/_codec_base_.base.md
+8 -8
View File
@@ -38,7 +38,7 @@
⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md)
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Base.ts#L19)*
**Parameters:**
@@ -58,7 +58,7 @@ ___
**● raw**: *`T`*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Base.ts#L19)*
___
@@ -70,7 +70,7 @@ ___
▸ **byteLength**(): `number`
*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Base.ts#L25)*
*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Base.ts#L25)*
**Returns:** `number`
@@ -81,7 +81,7 @@ ___
▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<`T`>
*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Base.ts#L29)*
*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Base.ts#L29)*
**Parameters:**
@@ -98,7 +98,7 @@ ___
▸ **fromU8a**(input: *`Uint8Array`*): [Base](_codec_base_.base.md)<`T`>
*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Base.ts#L33)*
*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Base.ts#L33)*
**Parameters:**
@@ -115,7 +115,7 @@ ___
▸ **toJSON**(): `any`
*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Base.ts#L37)*
*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Base.ts#L37)*
**Returns:** `any`
@@ -126,7 +126,7 @@ ___
▸ **toString**(): `string`
*Defined in [codec/Base.ts:41](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Base.ts#L41)*
*Defined in [codec/Base.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Base.ts#L41)*
**Returns:** `string`
@@ -137,7 +137,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Base.ts#L45)*
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Base.ts#L45)*
**Parameters:**
docs/types/classes/_codec_compact_.compact.md
+24 -24
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/e103e98/packages/types/src/codec/UInt.ts#L31)*
*Defined in [codec/UInt.ts:31](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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:74](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L74)*
*Defined in [codec/Compact.ts:74](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L74)*
**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/e103e98/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -138,7 +138,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/e103e98/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -157,7 +157,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L78)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L78)*
**Parameters:**
@@ -176,7 +176,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -195,7 +195,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -214,7 +214,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L119)*
**Returns:** `boolean`
@@ -227,7 +227,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L123)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
@@ -246,7 +246,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -265,7 +265,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -284,7 +284,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -303,7 +303,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/e103e98/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -316,7 +316,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/e103e98/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -331,7 +331,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/e103e98/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -344,7 +344,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/e103e98/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -359,7 +359,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/e103e98/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -372,7 +372,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L86)*
**Parameters:**
@@ -389,7 +389,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/e103e98/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -409,7 +409,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/e103e98/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -426,7 +426,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:53](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L53)*
*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L53)*
**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/e103e98/packages/types/src/codec/Enum.ts#L21)*
*Defined in [codec/Enum.ts:21](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Enum.ts#L41)*
*Defined in [codec/Enum.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Enum.ts#L45)*
*Defined in [codec/Enum.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Enum.ts#L52)*
*Defined in [codec/Enum.ts:52](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Enum.ts#L59)*
*Defined in [codec/Enum.ts:59](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Enum.ts#L67)*
*Defined in [codec/Enum.ts:67](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Enum.ts#L71)*
*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Enum.ts#L63)*
*Defined in [codec/Enum.ts:63](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Enum.ts#L31)*
*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Enum.ts#L31)*
**Parameters:**
docs/types/classes/_codec_enumtype_.enumtype.md
+11 -11
View File
@@ -22,7 +22,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/EnumType.ts:22](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/EnumType.ts#L22)*
*Defined in [codec/EnumType.ts:22](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/EnumType.ts#L22)*
**Parameters:**
@@ -46,7 +46,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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Base.ts#L19)*
___
@@ -58,7 +58,7 @@ ___
getType(): `string`
*Defined in [codec/EnumType.ts:40](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/EnumType.ts#L40)*
*Defined in [codec/EnumType.ts:40](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/EnumType.ts#L40)*
**Returns:** `string`
@@ -74,7 +74,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/EnumType.ts#L44)*
*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/EnumType.ts#L44)*
**Returns:** `number`
@@ -87,7 +87,7 @@ ___
*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Base.ts#L29)*
*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Base.ts#L29)*
**Parameters:**
@@ -106,7 +106,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/EnumType.ts:48](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/EnumType.ts#L48)*
*Defined in [codec/EnumType.ts:48](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/EnumType.ts#L48)*
**Parameters:**
@@ -123,7 +123,7 @@ ___
▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)<`T`> &#124; `number`*, value?: *`any`*): `void`
*Defined in [codec/EnumType.ts:55](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/EnumType.ts#L55)*
*Defined in [codec/EnumType.ts:55](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/EnumType.ts#L55)*
**Parameters:**
@@ -143,7 +143,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/EnumType.ts:72](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/EnumType.ts#L72)*
*Defined in [codec/EnumType.ts:72](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/EnumType.ts#L72)*
**Returns:** `any`
@@ -154,7 +154,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/EnumType.ts:76](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/EnumType.ts#L76)*
*Defined in [codec/EnumType.ts:76](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/EnumType.ts#L76)*
**Returns:** `number`
@@ -167,7 +167,7 @@ ___
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/EnumType.ts:80](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/EnumType.ts#L80)*
*Defined in [codec/EnumType.ts:80](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/EnumType.ts#L80)*
**Returns:** `string`
@@ -180,7 +180,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/e103e98/packages/types/src/codec/Base.ts#L45)*
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Option.ts#L16)*
*Defined in [codec/Option.ts:16](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Option.ts#L46)*
*Defined in [codec/Option.ts:46](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Option.ts#L50)*
*Defined in [codec/Option.ts:50](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Option.ts#L56)*
*Defined in [codec/Option.ts:56](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Option.ts#L64)*
*Defined in [codec/Option.ts:64](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Option.ts#L74)*
*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Option.ts#L84)*
*Defined in [codec/Option.ts:84](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Option.ts#L105)*
*Defined in [codec/Option.ts:105](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Option.ts#L90)*
*Defined in [codec/Option.ts:90](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Option.ts#L26)*
*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Option.ts#L38)*
*Defined in [codec/Option.ts:38](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L30)*
*Defined in [codec/Struct.ts:30](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L118)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L152)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L98)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L24)*
*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L60)*
*Defined in [codec/Tuple.ts:60](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L29)*
*Defined in [codec/Tuple.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Tuple.ts#L50)*
*Defined in [codec/Tuple.ts:50](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L16)*
*Defined in [codec/U8a.ts:16](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L37)*
*Defined in [codec/U8a.ts:37](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L41)*
*Defined in [codec/U8a.ts:41](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L47)*
*Defined in [codec/U8a.ts:47](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L14)*
*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L36)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L44)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
docs/types/classes/_codec_uint_.uint.md
+22 -22
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/e103e98/packages/types/src/codec/UInt.ts#L31)*
*Defined in [codec/UInt.ts:31](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -132,7 +132,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/e103e98/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -151,7 +151,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/e103e98/packages/types/src/codec/UInt.ts#L67)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L67)*
**Parameters:**
@@ -168,7 +168,7 @@ ___
▸ **gt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
▸ **gte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -202,7 +202,7 @@ ___
▸ **isZero**(): `boolean`
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L119)*
**Returns:** `boolean`
@@ -213,7 +213,7 @@ ___
▸ **lt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L123)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
@@ -230,7 +230,7 @@ ___
▸ **lte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -247,7 +247,7 @@ ___
▸ **mul**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -264,7 +264,7 @@ ___
▸ **sub**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -281,7 +281,7 @@ ___
▸ **toBn**(): `BN`
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -292,7 +292,7 @@ ___
▸ **toHex**(): `string`
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -305,7 +305,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/e103e98/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -316,7 +316,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -329,7 +329,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/e103e98/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -342,7 +342,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/e103e98/packages/types/src/codec/UInt.ts#L83)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L83)*
**Parameters:**
@@ -359,7 +359,7 @@ ___
▸ **decodeUInt**(value: *`AnyNumber`*): `BN`
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
docs/types/classes/_codec_vector_.vector.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/e103e98/packages/types/src/codec/Vector.ts#L19)*
*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Base.ts#L19)*
___
@@ -55,7 +55,7 @@ ___
getType(): `string`
*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Vector.ts#L66)*
*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L66)*
**Returns:** `string`
@@ -66,7 +66,7 @@ ___
getlength(): `number`
*Defined in [codec/Vector.ts:70](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Vector.ts#L70)*
*Defined in [codec/Vector.ts:70](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L70)*
**Returns:** `number`
@@ -82,7 +82,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/e103e98/packages/types/src/codec/Vector.ts#L74)*
*Defined in [codec/Vector.ts:74](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L74)*
**Returns:** `number`
@@ -93,7 +93,7 @@ ___
▸ **filter**(fn: *`function`*): `Array`<`T`>
*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Vector.ts#L80)*
*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L80)*
**Parameters:**
@@ -110,7 +110,7 @@ ___
▸ **find**(fn: *`function`*): `T` &#124; `undefined`
*Defined in [codec/Vector.ts:84](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Vector.ts#L84)*
*Defined in [codec/Vector.ts:84](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L84)*
**Parameters:**
@@ -127,7 +127,7 @@ ___
▸ **forEach**(fn: *`function`*): `any`
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L88)*
**Parameters:**
@@ -146,7 +146,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/e103e98/packages/types/src/codec/Vector.ts#L92)*
*Defined in [codec/Vector.ts:92](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L92)*
**Parameters:**
@@ -165,7 +165,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/e103e98/packages/types/src/codec/Vector.ts#L101)*
*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L101)*
**Parameters:**
@@ -182,7 +182,7 @@ ___
▸ **get**(index: *`number`*): `T`
*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Vector.ts#L107)*
*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L107)*
**Parameters:**
@@ -199,7 +199,7 @@ ___
▸ **map**<`O`>(fn: *`function`*): `Array`<`O`>
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Vector.ts#L111)*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L111)*
**Type parameters:**
@@ -219,7 +219,7 @@ ___
▸ **push**(item: *`T`*): `void`
*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Vector.ts#L115)*
*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L115)*
**Parameters:**
@@ -236,7 +236,7 @@ ___
▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O`
*Defined in [codec/Vector.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Vector.ts#L119)*
*Defined in [codec/Vector.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L119)*
**Type parameters:**
@@ -259,7 +259,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/e103e98/packages/types/src/codec/Vector.ts#L123)*
*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L123)*
**Returns:** `any`
@@ -272,7 +272,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/e103e98/packages/types/src/codec/Vector.ts#L142)*
*Defined in [codec/Vector.ts:142](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L142)*
**Returns:** `string`
@@ -285,7 +285,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/e103e98/packages/types/src/codec/Vector.ts#L129)*
*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L129)*
**Parameters:**
@@ -302,7 +302,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/e103e98/packages/types/src/codec/Vector.ts#L29)*
*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L29)*
**Type parameters:**
@@ -323,7 +323,7 @@ ___
▸ **with**<`O`>(Type: *`object`*): `object`
*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Vector.ts#L58)*
*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Vector.ts#L58)*
**Type parameters:**
docs/types/classes/_compact128_.compact128.md
+24 -24
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/e103e98/packages/types/src/Compact128.ts#L9)*
*Defined in [Compact128.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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:74](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L74)*
*Defined in [codec/Compact.ts:74](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L74)*
**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/e103e98/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -126,7 +126,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/e103e98/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L78)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L78)*
**Parameters:**
@@ -166,7 +166,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L119)*
**Returns:** `boolean`
@@ -217,7 +217,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L123)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
@@ -236,7 +236,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -255,7 +255,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -274,7 +274,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -293,7 +293,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/e103e98/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -306,7 +306,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/e103e98/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -321,7 +321,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/e103e98/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -334,7 +334,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/e103e98/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -349,7 +349,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/e103e98/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -364,7 +364,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L86)*
**Parameters:**
@@ -383,7 +383,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/e103e98/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -403,7 +403,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/e103e98/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -422,7 +422,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)*
*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L53)*
*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L53)*
**Parameters:**
docs/types/classes/_compact16_.compact16.md
+24 -24
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/e103e98/packages/types/src/Compact16.ts#L9)*
*Defined in [Compact16.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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:74](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L74)*
*Defined in [codec/Compact.ts:74](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L74)*
**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/e103e98/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -126,7 +126,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/e103e98/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L78)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L78)*
**Parameters:**
@@ -166,7 +166,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L119)*
**Returns:** `boolean`
@@ -217,7 +217,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L123)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
@@ -236,7 +236,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -255,7 +255,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -274,7 +274,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -293,7 +293,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/e103e98/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -306,7 +306,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/e103e98/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -321,7 +321,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/e103e98/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -334,7 +334,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/e103e98/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -349,7 +349,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/e103e98/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -364,7 +364,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L86)*
**Parameters:**
@@ -383,7 +383,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/e103e98/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -403,7 +403,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/e103e98/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -422,7 +422,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)*
*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L53)*
*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L53)*
**Parameters:**
docs/types/classes/_compact256_.compact256.md
+24 -24
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/e103e98/packages/types/src/Compact256.ts#L9)*
*Defined in [Compact256.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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:74](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L74)*
*Defined in [codec/Compact.ts:74](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L74)*
**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/e103e98/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -126,7 +126,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/e103e98/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L78)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L78)*
**Parameters:**
@@ -166,7 +166,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L119)*
**Returns:** `boolean`
@@ -217,7 +217,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L123)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
@@ -236,7 +236,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -255,7 +255,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -274,7 +274,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -293,7 +293,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/e103e98/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -306,7 +306,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/e103e98/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -321,7 +321,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/e103e98/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -334,7 +334,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/e103e98/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -349,7 +349,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/e103e98/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -364,7 +364,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L86)*
**Parameters:**
@@ -383,7 +383,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/e103e98/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -403,7 +403,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/e103e98/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -422,7 +422,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)*
*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L53)*
*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L53)*
**Parameters:**
docs/types/classes/_compact32_.compact32.md
+24 -24
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/e103e98/packages/types/src/Compact32.ts#L9)*
*Defined in [Compact32.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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:74](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L74)*
*Defined in [codec/Compact.ts:74](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L74)*
**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/e103e98/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -126,7 +126,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/e103e98/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L78)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L78)*
**Parameters:**
@@ -166,7 +166,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L119)*
**Returns:** `boolean`
@@ -217,7 +217,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L123)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
@@ -236,7 +236,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -255,7 +255,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -274,7 +274,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -293,7 +293,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/e103e98/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -306,7 +306,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/e103e98/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -321,7 +321,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/e103e98/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -334,7 +334,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/e103e98/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -349,7 +349,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/e103e98/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -364,7 +364,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L86)*
**Parameters:**
@@ -383,7 +383,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/e103e98/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -403,7 +403,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/e103e98/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -422,7 +422,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)*
*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L53)*
*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L53)*
**Parameters:**
docs/types/classes/_compact64_.compact64.md
+24 -24
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/e103e98/packages/types/src/Compact64.ts#L9)*
*Defined in [Compact64.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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:74](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L74)*
*Defined in [codec/Compact.ts:74](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L74)*
**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/e103e98/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -126,7 +126,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/e103e98/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -147,7 +147,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L78)*
*Defined in [codec/Compact.ts:78](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L78)*
**Parameters:**
@@ -166,7 +166,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L119)*
**Returns:** `boolean`
@@ -217,7 +217,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L123)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
@@ -236,7 +236,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -255,7 +255,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -274,7 +274,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -293,7 +293,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/e103e98/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -306,7 +306,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/e103e98/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -321,7 +321,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/e103e98/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -334,7 +334,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/e103e98/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -349,7 +349,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/e103e98/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -364,7 +364,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L86)*
**Parameters:**
@@ -383,7 +383,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/e103e98/packages/types/src/codec/Compact.ts#L36)*
*Defined in [codec/Compact.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L36)*
**Parameters:**
@@ -403,7 +403,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/e103e98/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
@@ -422,7 +422,7 @@ ___
*Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)*
*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/Compact.ts#L53)*
*Defined in [codec/Compact.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Compact.ts#L53)*
**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/e103e98/packages/types/src/Extrinsic.ts#L37)*
*Defined in [Extrinsic.ts:37](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L70)*
*Defined in [Extrinsic.ts:70](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L74)*
*Defined in [Extrinsic.ts:74](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L79)*
*Defined in [Extrinsic.ts:79](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L85)*
*Defined in [Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L89)*
*Defined in [Extrinsic.ts:89](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L93)*
*Defined in [Extrinsic.ts:93](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L97)*
*Defined in [Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L101)*
*Defined in [Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L105)*
*Defined in [Extrinsic.ts:105](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L111)*
*Defined in [Extrinsic.ts:111](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L117)*
*Defined in [Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L125)*
*Defined in [Extrinsic.ts:125](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L142)*
*Defined in [Extrinsic.ts:142](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L146)*
*Defined in [Extrinsic.ts:146](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L131)*
*Defined in [Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/Extrinsic.ts#L45)*
*Defined in [Extrinsic.ts:45](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L98)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicEra.ts#L11)*
*Defined in [ExtrinsicEra.ts:11](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L36)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L44)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L19)*
*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L66)*
*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L70)*
*Defined in [codec/Vector.ts:70](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L74)*
*Defined in [codec/Vector.ts:74](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L80)*
*Defined in [codec/Vector.ts:80](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L84)*
*Defined in [codec/Vector.ts:84](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L92)*
*Defined in [codec/Vector.ts:92](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L101)*
*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L107)*
*Defined in [codec/Vector.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L111)*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L115)*
*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L119)*
*Defined in [codec/Vector.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L123)*
*Defined in [codec/Vector.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L142)*
*Defined in [codec/Vector.ts:142](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L129)*
*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L29)*
*Defined in [codec/Vector.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Vector.ts#L58)*
*Defined in [codec/Vector.ts:58](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L37)*
*Defined in [ExtrinsicSignature.ts:37](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L77)*
*Defined in [ExtrinsicSignature.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L73)*
*Defined in [ExtrinsicSignature.ts:73](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L81)*
*Defined in [ExtrinsicSignature.ts:81](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L85)*
*Defined in [ExtrinsicSignature.ts:85](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L89)*
*Defined in [ExtrinsicSignature.ts:89](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L93)*
*Defined in [ExtrinsicSignature.ts:93](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L105)*
*Defined in [ExtrinsicSignature.ts:105](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L64)*
*Defined in [ExtrinsicSignature.ts:64](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L118)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L124)*
*Defined in [ExtrinsicSignature.ts:124](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L152)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L137)*
*Defined in [ExtrinsicSignature.ts:137](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/ExtrinsicSignature.ts#L47)*
*Defined in [ExtrinsicSignature.ts:47](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L98)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
docs/types/classes/_gas_.gas.md
+22 -22
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/e103e98/packages/types/src/U64.ts#L9)*
*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L101)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L57)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L107)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/UInt.ts#L113)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L113)*
**Parameters:**
@@ -128,7 +128,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/e103e98/packages/types/src/codec/UInt.ts#L61)*
*Defined in [codec/UInt.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L61)*
**Parameters:**
@@ -149,7 +149,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/e103e98/packages/types/src/codec/UInt.ts#L67)*
*Defined in [codec/UInt.ts:67](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L67)*
**Parameters:**
@@ -168,7 +168,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L135)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
@@ -187,7 +187,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L141)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
@@ -206,7 +206,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L119)*
*Defined in [codec/UInt.ts:119](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L119)*
**Returns:** `boolean`
@@ -219,7 +219,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L123)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
@@ -238,7 +238,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L129)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
@@ -257,7 +257,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L147)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
@@ -276,7 +276,7 @@ ___
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/codec/UInt.ts#L153)*
*Defined in [codec/UInt.ts:153](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L153)*
**Parameters:**
@@ -295,7 +295,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/e103e98/packages/types/src/codec/UInt.ts#L91)*
*Defined in [codec/UInt.ts:91](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L91)*
**Returns:** `BN`
@@ -308,7 +308,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/e103e98/packages/types/src/codec/UInt.ts#L73)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `string`
@@ -323,7 +323,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/e103e98/packages/types/src/codec/UInt.ts#L77)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L77)*
**Returns:** `any`
@@ -336,7 +336,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/e103e98/packages/types/src/codec/UInt.ts#L95)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L95)*
**Returns:** `number`
@@ -351,7 +351,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/e103e98/packages/types/src/codec/UInt.ts#L87)*
*Defined in [codec/UInt.ts:87](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L87)*
**Returns:** `string`
@@ -366,7 +366,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/e103e98/packages/types/src/codec/UInt.ts#L83)*
*Defined in [codec/UInt.ts:83](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L83)*
**Parameters:**
@@ -385,7 +385,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/e103e98/packages/types/src/codec/UInt.ts#L42)*
*Defined in [codec/UInt.ts:42](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/UInt.ts#L42)*
**Parameters:**
docs/types/classes/_h256_.h256.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/e103e98/packages/types/src/H256.ts#L11)*
*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L36)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L44)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
docs/types/classes/_h512_.h512.md
+11 -11
View File
@@ -18,7 +18,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/H512.ts#L10)*
*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/H512.ts#L10)*
**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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L36)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L44)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
docs/types/classes/_hash_.hash.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/e103e98/packages/types/src/H256.ts#L11)*
*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L33)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L32)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L36)*
*Defined in [codec/U8aFixed.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8aFixed.ts#L44)*
*Defined in [codec/U8aFixed.ts:44](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L57)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L65)*
*Defined in [codec/U8a.ts:65](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L61)*
*Defined in [codec/U8a.ts:61](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/U8a.ts#L23)*
*Defined in [codec/U8a.ts:23](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/U8a.ts#L23)*
**Parameters:**
docs/types/classes/_header_.digest.md
+15 -15
View File
@@ -21,7 +21,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Header.ts:29](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/Header.ts#L29)*
*Defined in [Header.ts:29](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/Header.ts#L29)*
**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/e103e98/packages/types/src/codec/Base.ts#L19)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2b88a8f/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/e103e98/packages/types/src/codec/Struct.ts#L108)*
*Defined in [codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L108)*
**Returns:** `E`
@@ -68,7 +68,7 @@ ___
getlogs(): [Vector](_codec_vector_.vector.md)<[Bytes](_bytes_.bytes.md)>
*Defined in [Header.ts:36](https://github.com/polkadot-js/api/blob/e103e98/packages/types/src/Header.ts#L36)*
*Defined in [Header.ts:36](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/Header.ts#L36)*
**Returns:** [Vector](_codec_vector_.vector.md)<[Bytes](_bytes_.bytes.md)>
@@ -86,7 +86,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/e103e98/packages/types/src/codec/Struct.ts#L112)*
*Defined in [codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L112)*
**Returns:** `number`
@@ -101,7 +101,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/e103e98/packages/types/src/codec/Struct.ts#L118)*
*Defined in [codec/Struct.ts:118](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L118)*
**Parameters:**
@@ -122,7 +122,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/e103e98/packages/types/src/codec/Struct.ts#L138)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L138)*
**Parameters:**
@@ -141,7 +141,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/e103e98/packages/types/src/codec/Struct.ts#L148)*
*Defined in [codec/Struct.ts:148](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L148)*
**Parameters:**
@@ -160,7 +160,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/e103e98/packages/types/src/codec/Struct.ts#L163)*
*Defined in [codec/Struct.ts:163](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -175,7 +175,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/e103e98/packages/types/src/codec/Struct.ts#L152)*
*Defined in [codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L152)*
**Returns:** `any`
@@ -190,7 +190,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/e103e98/packages/types/src/codec/Struct.ts#L175)*
*Defined in [codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -205,7 +205,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/e103e98/packages/types/src/codec/Struct.ts#L167)*
*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L167)*
**Parameters:**
@@ -224,7 +224,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/e103e98/packages/types/src/codec/Struct.ts#L184)*
*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
@@ -237,7 +237,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/e103e98/packages/types/src/codec/Struct.ts#L48)*
*Defined in [codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -262,7 +262,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/e103e98/packages/types/src/codec/Struct.ts#L98)*
*Defined in [codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/2b88a8f/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**

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