import Api from '@polkadot/api/promise' ;
@@ -495,14 +491,14 @@
genesisHash
getgenesisHash(): Hash
Inherited from ApiBase .genesisHash
-Defined in Base.ts:71
+Defined in Base.ts:71
description
Returns: Hash
isReady
getisReady(): Promise<ApiPromise >
-Defined in promise/index.ts:160
+Defined in promise/index.ts:160
description
Returns: Promise<ApiPromise >
query
getquery(): QueryableStorage
Inherited from ApiBase .query
-Defined in Base.ts:111
+Defined in Base.ts:111
description
All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.
example
@@ -526,7 +522,7 @@
rpc
getrpc(): Rpc
Inherited from ApiBase .rpc
-Defined in Base.ts:133
+Defined in Base.ts:133
description api.query 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
@@ -542,7 +538,7 @@
getruntimeMetadata(): RuntimeMetadata
Inherited from ApiBase .runtimeMetadata
-Defined in Base.ts:80
+Defined in Base.ts:80
description
Returns: RuntimeMetadata
runtimeVersion
getruntimeVersion(): RuntimeVersion
Inherited from ApiBase .runtimeVersion
-Defined in Base.ts:89
+Defined in Base.ts:89
description
Returns: RuntimeVersion
tx
gettx(): SubmittableExtrinsics
Inherited from ApiBase .tx
-Defined in Base.ts:153
+Defined in Base.ts:153
description
example
api . tx . balances
@@ -576,7 +572,7 @@
on
▸ on (type: ApiInterface$Eventsfunctionvoid
Inherited from ApiBase .on
-Defined in Base.ts:178
+Defined in Base.ts:178
description
example
* api . on ( 'disconnected' , ( ) = > {
@@ -614,7 +610,7 @@
<Static> create▸ create (wsProvider?: WsProviderPromise<ApiPromise >
-Defined in promise/index.ts:125
+Defined in promise/index.ts:125
description
example
import Api from '@polkadot/api/promise' ;
@@ -687,7 +683,7 @@
@@ -698,6 +694,10 @@
+
+
+
+
diff --git a/docs/api/classes/_promise_index_.apipromise.md b/docs/api/classes/_promise_index_.apipromise.md
index ed5681e3c6..d7e685aacd 100644
--- a/docs/api/classes/_promise_index_.apipromise.md
+++ b/docs/api/classes/_promise_index_.apipromise.md
@@ -104,7 +104,7 @@ ApiPromise.create().then((api) => {
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
-*Defined in [promise/index.ts:127](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/promise/index.ts#L127)*
+*Defined in [promise/index.ts:127](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/promise/index.ts#L127)*
*__description__*: Creates an instance of the ApiPromise class
@@ -139,7 +139,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
-*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L71)*
+*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L71)*
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
@@ -152,7 +152,7 @@ ___
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
-*Defined in [promise/index.ts:160](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/promise/index.ts#L160)*
+*Defined in [promise/index.ts:160](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/promise/index.ts#L160)*
*__description__*: Promise that returns the first time we are connected and loaded
@@ -167,7 +167,7 @@ getquery(): `QueryableStorage`
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
-*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L111)*
+*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L111)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -193,7 +193,7 @@ getrpc(): `Rpc`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
-*Defined in [Base.ts:133](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L133)*
+*Defined in [Base.ts:133](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L133)*
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
@@ -219,7 +219,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
-*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L80)*
+*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L80)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -234,7 +234,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
-*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L89)*
+*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L89)*
*__description__*: Contains the version information for the current runtime.
@@ -249,7 +249,7 @@ gettx(): `SubmittableExtrinsics`
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
-*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L153)*
+*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L153)*
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
@@ -278,7 +278,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
-*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L178)*
+*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L178)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -309,7 +309,7 @@ ___
▸ **create**(wsProvider?: *`WsProvider`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
-*Defined in [promise/index.ts:125](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/promise/index.ts#L125)*
+*Defined in [promise/index.ts:125](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/promise/index.ts#L125)*
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
diff --git a/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md
index 6c8d9dab2a..f062987134 100644
--- a/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md
+++ b/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md
@@ -21,7 +21,7 @@
*Overrides Extrinsic.__constructor*
-*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
+*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -265,7 +265,7 @@ ___
▸ **send**(statusCb?: * `undefined` | `function`*): `Promise`<`Hash`>
-*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
+*Defined in [promise/SubmittableExtrinsic.ts:20](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/promise/SubmittableExtrinsic.ts#L20)*
**Parameters:**
@@ -284,7 +284,7 @@ ___
*Overrides Extrinsic.sign*
-*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
+*Defined in [promise/SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/promise/SubmittableExtrinsic.ts#L28)*
**Parameters:**
@@ -305,7 +305,7 @@ ___
*Inherited from Extrinsic.toHex*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:142](https://github.com/polkadot-js/api/blob/67f625b/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/68f5ac2/packages/types/src/Extrinsic.ts#L142)*
**Returns:** `string`
@@ -320,7 +320,7 @@ ___
*Overrides Struct.toJSON*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:146](https://github.com/polkadot-js/api/blob/67f625b/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/68f5ac2/packages/types/src/Extrinsic.ts#L146)*
**Returns:** `any`
@@ -335,7 +335,7 @@ ___
*Overrides Base.toString*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:175](https://github.com/polkadot-js/api/blob/67f625b/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/68f5ac2/packages/types/src/codec/Struct.ts#L175)*
**Returns:** `string`
@@ -350,7 +350,7 @@ ___
*Overrides Struct.toU8a*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/67f625b/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/68f5ac2/packages/types/src/Extrinsic.ts#L131)*
**Parameters:**
@@ -369,7 +369,7 @@ ___
*Inherited from Struct.values*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/67f625b/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/68f5ac2/packages/types/src/codec/Struct.ts#L184)*
**Returns:** `Array`<`Base`>
@@ -382,7 +382,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:45](https://github.com/polkadot-js/api/blob/67f625b/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/68f5ac2/packages/types/src/Extrinsic.ts#L45)*
**Parameters:**
@@ -401,7 +401,7 @@ ___
*Inherited from Struct.decodeStruct*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:48](https://github.com/polkadot-js/api/blob/67f625b/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/68f5ac2/packages/types/src/codec/Struct.ts#L48)*
**Type parameters:**
@@ -426,7 +426,7 @@ ___
*Inherited from Struct.with*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:98](https://github.com/polkadot-js/api/blob/67f625b/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/68f5ac2/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
diff --git a/docs/api/classes/_rx_index_.apirx.html b/docs/api/classes/_rx_index_.apirx.html
index 358de04e9a..6ecec3cb99 100644
--- a/docs/api/classes/_rx_index_.apirx.html
+++ b/docs/api/classes/_rx_index_.apirx.html
@@ -18,6 +18,10 @@
+
+
+
+
@@ -39,15 +43,7 @@
-
-
-
-
-
-
-
-
-
+
@@ -471,7 +467,7 @@
constructor
⊕ new ApiRx (wsProvider?: WsProviderApiRx
Overrides ApiBase .constructor
-
Defined in rx/index.ts:143
+
Defined in rx/index.ts:143
description
example
import Api from '@polkadot/api/rx' ;
@@ -506,21 +502,21 @@
genesisHash
getgenesisHash(): Hash
Inherited from ApiBase .genesisHash
-Defined in Base.ts:71
+Defined in Base.ts:71
description
Returns: Hash
isConnected
getisConnected(): Observable<boolean>
-Defined in rx/index.ts:179
+Defined in rx/index.ts:179
description
Returns: Observable<boolean>
isReady
getisReady(): Observable<ApiRx >
-Defined in rx/index.ts:186
+Defined in rx/index.ts:186
description
Returns: Observable<ApiRx >
query
getquery(): QueryableStorage
Inherited from ApiBase .query
-Defined in Base.ts:111
+Defined in Base.ts:111
description
All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.
example
@@ -544,7 +540,7 @@
rpc
getrpc(): RpcRx
Inherited from ApiBase .rpc
-Defined in Base.ts:133
+Defined in Base.ts:133
description api.query 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
@@ -560,7 +556,7 @@
getruntimeMetadata(): RuntimeMetadata
Inherited from ApiBase .runtimeMetadata
-Defined in Base.ts:80
+Defined in Base.ts:80
description
Returns: RuntimeMetadata
runtimeVersion
getruntimeVersion(): RuntimeVersion
Inherited from ApiBase .runtimeVersion
-Defined in Base.ts:89
+Defined in Base.ts:89
description
Returns: RuntimeVersion
tx
gettx(): SubmittableExtrinsics
Inherited from ApiBase .tx
-Defined in Base.ts:153
+Defined in Base.ts:153
description
example
api . tx . balances
@@ -594,7 +590,7 @@
on
▸ on (type: ApiInterface$Eventsfunctionvoid
Inherited from ApiBase .on
-Defined in Base.ts:178
+Defined in Base.ts:178
description
example
* api . on ( 'disconnected' , ( ) = > {
@@ -632,7 +628,7 @@
<Static> create▸ create (wsProvider?: WsProviderObservable<ApiRx >
-Defined in rx/index.ts:141
+Defined in rx/index.ts:141
description
example
import Api from '@polkadot/api/rx' ;
@@ -705,7 +701,7 @@
@@ -716,6 +712,10 @@
+
+
+
+
diff --git a/docs/api/classes/_rx_index_.apirx.md b/docs/api/classes/_rx_index_.apirx.md
index ccc4022fb0..2c0f18bf73 100644
--- a/docs/api/classes/_rx_index_.apirx.md
+++ b/docs/api/classes/_rx_index_.apirx.md
@@ -115,7 +115,7 @@ api.query.system
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
-*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/rx/index.ts#L143)*
+*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/rx/index.ts#L143)*
*__description__*: Create an instance of the ApiRx class
@@ -150,7 +150,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
-*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L71)*
+*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L71)*
*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
@@ -163,7 +163,7 @@ ___
getisConnected(): `Observable`<`boolean`>
-*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/rx/index.ts#L179)*
+*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/rx/index.ts#L179)*
*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
@@ -176,7 +176,7 @@ ___
getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)>
-*Defined in [rx/index.ts:186](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/rx/index.ts#L186)*
+*Defined in [rx/index.ts:186](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/rx/index.ts#L186)*
*__description__*: Observable that returns the first time we are connected and loaded
@@ -191,7 +191,7 @@ getquery(): `QueryableStorage`
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
-*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L111)*
+*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L111)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -217,7 +217,7 @@ getrpc(): `RpcRx`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
-*Defined in [Base.ts:133](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L133)*
+*Defined in [Base.ts:133](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L133)*
*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
@@ -243,7 +243,7 @@ getruntimeMetadata(): `RuntimeMetadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
-*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L80)*
+*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L80)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -258,7 +258,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
-*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L89)*
+*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L89)*
*__description__*: Contains the version information for the current runtime.
@@ -273,7 +273,7 @@ gettx(): `SubmittableExtrinsics`
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
-*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L153)*
+*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L153)*
*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
@@ -302,7 +302,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
-*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/Base.ts#L178)*
+*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/Base.ts#L178)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -333,7 +333,7 @@ ___
▸ **create**(wsProvider?: *`WsProvider`*): `Observable`<[ApiRx](_rx_index_.apirx.md)>
-*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/rx/index.ts#L141)*
+*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/rx/index.ts#L141)*
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
diff --git a/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md
index 815750bd4e..1b49d4b3b4 100644
--- a/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md
+++ b/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md
@@ -21,7 +21,7 @@
*Overrides Extrinsic.__constructor*
-*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
+*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/packages/types/src/codec/Struct.ts#L163)*
**Returns:** `Array`<`string`>
@@ -265,7 +265,7 @@ ___
▸ **send**(): `Observable`<`ExtrinsicStatus`>
-*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
+*Defined in [rx/SubmittableExtrinsic.ts:21](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/rx/SubmittableExtrinsic.ts#L21)*
**Returns:** `Observable`<`ExtrinsicStatus`>
@@ -278,7 +278,7 @@ ___
*Overrides Extrinsic.sign*
-*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/67f625b/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
+*Defined in [rx/SubmittableExtrinsic.ts:25](https://github.com/polkadot-js/api/blob/68f5ac2/packages/api/src/rx/SubmittableExtrinsic.ts#L25)*
**Parameters:**
@@ -299,7 +299,7 @@ ___
*Inherited from Extrinsic.toHex*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:142](https://github.com/polkadot-js/api/blob/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/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/67f625b/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/68f5ac2/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
diff --git a/docs/api/index.html b/docs/api/index.html
index d74823916b..d5e5988d4f 100644
--- a/docs/api/index.html
+++ b/docs/api/index.html
@@ -18,6 +18,10 @@
+
+
+
+
@@ -39,15 +43,7 @@
-
-
-
-
-
-
-
-
-
+
@@ -486,7 +482,7 @@
@@ -463,6 +459,10 @@
+
+
+
+
diff --git a/docs/examples/promise/02_listen_to_blocks/index.html b/docs/examples/promise/02_listen_to_blocks/index.html
index 8c5df8c23a..836a0cd018 100644
--- a/docs/examples/promise/02_listen_to_blocks/index.html
+++ b/docs/examples/promise/02_listen_to_blocks/index.html
@@ -18,6 +18,10 @@
+
+
+
+
@@ -39,15 +43,7 @@
-
-
-
-
-
-
-
-
-
+
@@ -454,7 +450,7 @@
@@ -476,6 +472,10 @@
+
+
+
+
diff --git a/docs/examples/promise/05_read_storage/index.html b/docs/examples/promise/05_read_storage/index.html
index b8e4084464..c6f7f07764 100644
--- a/docs/examples/promise/05_read_storage/index.html
+++ b/docs/examples/promise/05_read_storage/index.html
@@ -18,6 +18,10 @@
+
+
+
+
@@ -39,15 +43,7 @@
-
-
-
-
-
-
-
-
-
+
@@ -464,7 +460,7 @@
@@ -471,6 +467,10 @@
+
+
+
+
diff --git a/docs/examples/promise/index.html b/docs/examples/promise/index.html
index d8ec50b3e0..e8d2cc62d3 100644
--- a/docs/examples/promise/index.html
+++ b/docs/examples/promise/index.html
@@ -18,6 +18,10 @@
+
+
+
+
@@ -39,15 +43,7 @@
-
-
-
-
-
-
-
-
-
+
@@ -442,7 +438,7 @@
constructor
⊕ new HttpProvider (endpoint?: stringHttpProvider
-Defined in http/index.ts:42
+Defined in http/index.ts:42
Parameters:
@@ -431,7 +427,7 @@
isConnected
▸ isConnected (): boolean
-Defined in http/index.ts:59
+Defined in http/index.ts:59
summary
Returns: boolean
true if connected
@@ -439,7 +435,7 @@ true if connected
on
▸ on (type: ProviderInterface$EmittedProviderInterface$EmitCbvoid
-Defined in http/index.ts:67
+Defined in http/index.ts:67
summary WsProvider .
description
Parameters:
@@ -466,7 +462,7 @@ true if connected
send
▸ send (method: stringArray<any>Promise<any>
-Defined in http/index.ts:74
+Defined in http/index.ts:74
summary
Parameters:
@@ -492,7 +488,7 @@ true if connected
subscribe
▸ subscribe (types: stringstringArray<any>ProviderInterface$CallbackPromise<number>
-Defined in http/index.ts:96
+Defined in http/index.ts:96
summary WsProvider .
Parameters:
@@ -526,7 +522,7 @@ true if connected
unsubscribe
▸ unsubscribe (type: stringstringnumberPromise<boolean>
-Defined in http/index.ts:105
+Defined in http/index.ts:105
summary WsProvider .
Parameters:
@@ -596,7 +592,7 @@ true if connected
@@ -607,6 +603,10 @@ true if connected
+
+
+
+
diff --git a/docs/rpc-provider/classes/_http_index_.httpprovider.md b/docs/rpc-provider/classes/_http_index_.httpprovider.md
index 69c95123ed..9327184a30 100644
--- a/docs/rpc-provider/classes/_http_index_.httpprovider.md
+++ b/docs/rpc-provider/classes/_http_index_.httpprovider.md
@@ -33,7 +33,7 @@ const api = new Api(provider);
⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
-*Defined in [http/index.ts:42](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/http/index.ts#L42)*
+*Defined in [http/index.ts:42](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/http/index.ts#L42)*
**Parameters:**
@@ -53,7 +53,7 @@ ___
▸ **isConnected**(): `boolean`
-*Defined in [http/index.ts:59](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/http/index.ts#L59)*
+*Defined in [http/index.ts:59](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/http/index.ts#L59)*
*__summary__*: Whether the node is connected or not.
@@ -67,7 +67,7 @@ ___
▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void`
-*Defined in [http/index.ts:67](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/http/index.ts#L67)*
+*Defined in [http/index.ts:67](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/http/index.ts#L67)*
*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -89,7 +89,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
-*Defined in [http/index.ts:74](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/http/index.ts#L74)*
+*Defined in [http/index.ts:74](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/http/index.ts#L74)*
*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
@@ -109,7 +109,7 @@ ___
▸ **subscribe**(types: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *`ProviderInterface$Callback`*): `Promise`<`number`>
-*Defined in [http/index.ts:96](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/http/index.ts#L96)*
+*Defined in [http/index.ts:96](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/http/index.ts#L96)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -131,7 +131,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
-*Defined in [http/index.ts:105](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/http/index.ts#L105)*
+*Defined in [http/index.ts:105](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/http/index.ts#L105)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.html b/docs/rpc-provider/classes/_ws_index_.wsprovider.html
index 7923e9a1eb..389fe28e04 100644
--- a/docs/rpc-provider/classes/_ws_index_.wsprovider.html
+++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.html
@@ -18,6 +18,10 @@
+
constructor
⊕ new WsProvider (endpoint?: stringbooleanWsProvider
-Defined in ws/index.ts:79
+Defined in ws/index.ts:79
Parameters:
@@ -437,7 +433,7 @@
connect
▸ connect (): void
-Defined in ws/index.ts:109
+Defined in ws/index.ts:109
summary
description WsProvider connects automatically by default, however if you decided otherwise, you may connect manually using this method.
Returns: void
@@ -445,7 +441,7 @@
isConnected
▸ isConnected (): boolean
-Defined in ws/index.ts:126
+Defined in ws/index.ts:126
summary
Returns: boolean
true if connected
@@ -453,7 +449,7 @@ true if connected
on
▸ on (type: ProviderInterface$EmittedProviderInterface$EmitCbvoid
-Defined in ws/index.ts:135
+Defined in ws/index.ts:135
summary subscribe function.
Parameters:
@@ -482,7 +478,7 @@ true if connected
send
▸ send (method: stringArray<any>SubscriptionHandlerPromise<any>
-Defined in ws/index.ts:142
+Defined in ws/index.ts:142
summary
Parameters:
@@ -512,7 +508,7 @@ true if connected
subscribe
▸ subscribe (type: stringstringArray<any>ProviderInterface$CallbackPromise<number>
-Defined in ws/index.ts:198
+Defined in ws/index.ts:198
name
summary
example
@@ -563,7 +559,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
unsubscribe
▸ unsubscribe (type: stringstringnumberPromise<boolean>
-Defined in ws/index.ts:207
+Defined in ws/index.ts:207
summary subscribe .
Parameters:
@@ -633,7 +629,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
@@ -644,6 +640,10 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
+
+
+
+
diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.md b/docs/rpc-provider/classes/_ws_index_.wsprovider.md
index b4c389c670..6087dd86e0 100644
--- a/docs/rpc-provider/classes/_ws_index_.wsprovider.md
+++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.md
@@ -33,7 +33,7 @@ const api = new Api(provider);
⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
-*Defined in [ws/index.ts:79](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/ws/index.ts#L79)*
+*Defined in [ws/index.ts:79](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/ws/index.ts#L79)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
▸ **connect**(): `void`
-*Defined in [ws/index.ts:109](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/ws/index.ts#L109)*
+*Defined in [ws/index.ts:109](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/ws/index.ts#L109)*
*__summary__*: Manually connect
@@ -69,7 +69,7 @@ ___
▸ **isConnected**(): `boolean`
-*Defined in [ws/index.ts:126](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/ws/index.ts#L126)*
+*Defined in [ws/index.ts:126](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/ws/index.ts#L126)*
*__summary__*: Whether the node is connected or not.
@@ -83,7 +83,7 @@ ___
▸ **on**(type: *`ProviderInterface$Emitted`*, sub: *`ProviderInterface$EmitCb`*): `void`
-*Defined in [ws/index.ts:135](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/ws/index.ts#L135)*
+*Defined in [ws/index.ts:135](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/ws/index.ts#L135)*
*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
@@ -103,7 +103,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
-*Defined in [ws/index.ts:142](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/ws/index.ts#L142)*
+*Defined in [ws/index.ts:142](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/ws/index.ts#L142)*
*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
@@ -124,7 +124,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *`ProviderInterface$Callback`*): `Promise`<`number`>
-*Defined in [ws/index.ts:198](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/ws/index.ts#L198)*
+*Defined in [ws/index.ts:198](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/ws/index.ts#L198)*
*__name__*: subscribe
@@ -161,7 +161,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
-*Defined in [ws/index.ts:207](https://github.com/polkadot-js/api/blob/67f625b/packages/rpc-provider/src/ws/index.ts#L207)*
+*Defined in [ws/index.ts:207](https://github.com/polkadot-js/api/blob/68f5ac2/packages/rpc-provider/src/ws/index.ts#L207)*
*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
diff --git a/docs/rpc-provider/index.html b/docs/rpc-provider/index.html
index 1f72b79b66..4af9c90dca 100644
--- a/docs/rpc-provider/index.html
+++ b/docs/rpc-provider/index.html
@@ -18,6 +18,10 @@
+ ",
diff --git a/packages/type-jsonrpc/package.json b/packages/type-jsonrpc/package.json
index 0aeb0341f5..4e9c34c805 100644
--- a/packages/type-jsonrpc/package.json
+++ b/packages/type-jsonrpc/package.json
@@ -1,6 +1,6 @@
{
"name": "@polkadot/jsonrpc",
- "version": "0.31.29",
+ "version": "0.31.30",
"description": "Method definitions for the Polkadot RPC layer",
"main": "index.js",
"engines": {
diff --git a/packages/type-storage/package.json b/packages/type-storage/package.json
index fc3646bcbe..f0792ec5c0 100644
--- a/packages/type-storage/package.json
+++ b/packages/type-storage/package.json
@@ -1,6 +1,6 @@
{
"name": "@polkadot/storage",
- "version": "0.31.29",
+ "version": "0.31.30",
"description": "Generic wrapper wrapper around state storage",
"main": "index.js",
"engines": {
@@ -31,7 +31,7 @@
"dependencies": {
"@babel/runtime": "^7.0.0",
"@polkadot/keyring": "^0.31.1",
- "@polkadot/types": "^0.31.29",
+ "@polkadot/types": "^0.31.30",
"@polkadot/util": "^0.31.1",
"@polkadot/util-crypto": "^0.31.1"
}
diff --git a/packages/types/package.json b/packages/types/package.json
index 41ae76bc22..cceb7b8e10 100644
--- a/packages/types/package.json
+++ b/packages/types/package.json
@@ -1,6 +1,6 @@
{
"name": "@polkadot/types",
- "version": "0.31.29",
+ "version": "0.31.30",
"description": "Implementation of the Parity codec",
"main": "index.js",
"keywords": [
diff --git a/yarn.lock b/yarn.lock
index 9623bddd58..f2501cef98 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -3920,6 +3920,10 @@ gitbook-plugin-include-codeblock@^3.2.2:
meow "^4.0.0"
winston-color "^1.0.0"
+gitbook-plugin-insert-logo-link@^1.0.1:
+ version "1.0.1"
+ resolved "https://registry.yarnpkg.com/gitbook-plugin-insert-logo-link/-/gitbook-plugin-insert-logo-link-1.0.1.tgz#de84eb475f308fbca18a40bdc180c62ec2db4bc2"
+
gitbook-plugin-mermaid-gb3@^2.1.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/gitbook-plugin-mermaid-gb3/-/gitbook-plugin-mermaid-gb3-2.1.0.tgz#f2efc846021e527295d5fb723093e5db25f796a0"
')
+ }
+ gitbook.events.bind('start', function (e, config) {
+ src = config['insert-logo-link']['src']
+ url = config['insert-logo-link']['url']
+ })
+
+ gitbook.events.bind("page.change", function() {
+ insertLogo(src, url)
+ })
+})
diff --git a/docs/index.html b/docs/index.html
index 6551e138ab..c13610dac9 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -18,6 +18,10 @@
+
+
+
+
@@ -39,15 +43,7 @@
-
-
-
-
-
-
-
-
-
+
@@ -465,7 +461,7 @@