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.
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 (value) => {} callbacks to pass through the latest values.
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.
see: ApiRx
⊕ new ApiPromise(wsProvider?: WsProvider): ApiPromise
Overrides ApiBase.constructor
-Defined in promise/index.ts:125
+Defined in promise/index.ts:125
description: Creates an instance of the ApiPromise class
example:
import Api from '@polkadot/api/promise';
new Api().isReady.then((api) => {
- api.rpc.newHead((error, header) => {
+ api.rpc.newHead((header) => {
console.log(`new block #${header.blockNumber.toNumber()}`);
});
});
@@ -473,14 +473,14 @@
genesisHash
getgenesisHash(): Hash
Inherited from ApiBase.genesisHash
-Defined in Base.ts:71
+Defined in Base.ts:71
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.
Returns: Hash
isReady
getisReady(): Promise<ApiPromise>
-Defined in promise/index.ts:158
+Defined in promise/index.ts:158
description: Promise that returns the first time we are connected and loaded
Returns: Promise<ApiPromise>
@@ -488,7 +488,7 @@
rpc
getrpc(): Rpc
-Defined in Base.ts:111
+Defined in Base.ts:111
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:
@@ -504,7 +504,7 @@
runtimeMetadata
getruntimeMetadata(): RuntimeMetadata
Inherited from ApiBase.runtimeMetadata
-Defined in Base.ts:80
+Defined in Base.ts:80
description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
Returns: RuntimeMetadata
@@ -512,7 +512,7 @@
runtimeVersion
getruntimeVersion(): RuntimeVersion
Inherited from ApiBase.runtimeVersion
-Defined in Base.ts:89
+Defined in Base.ts:89
description: Contains the version information for the current runtime.
Returns: RuntimeVersion
@@ -520,7 +520,7 @@
st
getst(): QueryableStorage
-Defined in Base.ts:131
+Defined in Base.ts:131
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:
@@ -536,7 +536,7 @@
tx
gettx(): SubmittableExtrinsics
-Defined in Base.ts:153
+Defined in Base.ts:153
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.
example:
api.tx.balances
@@ -554,7 +554,7 @@
on
▸ on(type: ApiInterface$Events, handler: function): void
-Defined in Base.ts:178
+Defined in Base.ts:178
description: Attach an eventemitter handler to listen to a specific event
example:
* api.on('disconnected', () => {
@@ -592,7 +592,7 @@
<Static> create
▸ create(wsProvider?: WsProvider): Promise<ApiPromise>
-Defined in promise/index.ts:123
+Defined in promise/index.ts:123
description: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
example:
import Api from '@polkadot/api/promise';
@@ -665,7 +665,7 @@
diff --git a/docs/api/classes/_promise_index_.apipromise.md b/docs/api/classes/_promise_index_.apipromise.md
index 78b0dd0f26..f1e8d37933 100644
--- a/docs/api/classes/_promise_index_.apipromise.md
+++ b/docs/api/classes/_promise_index_.apipromise.md
@@ -7,7 +7,7 @@ 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.
+*__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 `(value) => {}` callbacks to pass through the latest values.
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.
@@ -25,7 +25,7 @@ import ApiPromise from '@polkadot/api/promise';
const api = await ApiPromise.create();
// make a subscription to the network head
-api.rpc.chain.newHead((error, header) => {
+api.rpc.chain.newHead((header) => {
console.log(`Chain is at #${header.blockNumber}`);
});
```
@@ -48,7 +48,7 @@ const blockPeriod = await api.st.timestamp.blockPeriod().toNumber();
let last = 0;
// subscribe to the current block timestamp, updates automatically (callback provided)
-api.st.timestamp.now((error, timestamp) => {
+api.st.timestamp.now((timestamp) => {
const elapsed = last
? `, ${timestamp.toNumber() - last}s since last`
: '';
@@ -102,7 +102,7 @@ ApiPromise.create().then((api) => {
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
-*Defined in [promise/index.ts:125](https://github.com/polkadot-js/api/blob/5975e23/packages/api/src/promise/index.ts#L125)*
+*Defined in [promise/index.ts:125](https://github.com/polkadot-js/api/blob/8fafedc/packages/api/src/promise/index.ts#L125)*
*__description__*: Creates an instance of the ApiPromise class
@@ -111,7 +111,7 @@ ApiPromise.create().then((api) => {
import Api from '@polkadot/api/promise';
new Api().isReady.then((api) => {
- api.rpc.newHead((error, header) => {
+ api.rpc.newHead((header) => {
console.log(`new block #${header.blockNumber.toNumber()}`);
});
});
@@ -137,7 +137,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/5975e23/packages/api/src/Base.ts#L71)*
+*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/8fafedc/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.
@@ -150,7 +150,7 @@ ___
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
-*Defined in [promise/index.ts:158](https://github.com/polkadot-js/api/blob/5975e23/packages/api/src/promise/index.ts#L158)*
+*Defined in [promise/index.ts:158](https://github.com/polkadot-js/api/blob/8fafedc/packages/api/src/promise/index.ts#L158)*
*__description__*: Promise that returns the first time we are connected and loaded
@@ -165,7 +165,7 @@ getrpc(): `Rpc`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
-*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/5975e23/packages/api/src/Base.ts#L111)*
+*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/8fafedc/packages/api/src/Base.ts#L111)*
*__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.
@@ -191,7 +191,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/5975e23/packages/api/src/Base.ts#L80)*
+*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/8fafedc/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.
@@ -206,7 +206,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/5975e23/packages/api/src/Base.ts#L89)*
+*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/8fafedc/packages/api/src/Base.ts#L89)*
*__description__*: Contains the version information for the current runtime.
@@ -221,7 +221,7 @@ getst(): `QueryableStorage`
*Inherited from [ApiBase](_base_.apibase.md).[st](_base_.apibase.md#st)*
-*Defined in [Base.ts:131](https://github.com/polkadot-js/api/blob/5975e23/packages/api/src/Base.ts#L131)*
+*Defined in [Base.ts:131](https://github.com/polkadot-js/api/blob/8fafedc/packages/api/src/Base.ts#L131)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -247,7 +247,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/5975e23/packages/api/src/Base.ts#L153)*
+*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/8fafedc/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.
@@ -276,7 +276,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
-*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/5975e23/packages/api/src/Base.ts#L178)*
+*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/8fafedc/packages/api/src/Base.ts#L178)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -307,7 +307,7 @@ ___
▸ **create**(wsProvider?: *`WsProvider`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
-*Defined in [promise/index.ts:123](https://github.com/polkadot-js/api/blob/5975e23/packages/api/src/promise/index.ts#L123)*
+*Defined in [promise/index.ts:123](https://github.com/polkadot-js/api/blob/8fafedc/packages/api/src/promise/index.ts#L123)*
*__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 e8db039d22..36816c180a 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/5975e23/packages/api/src/promise/SubmittableExtrinsic.ts#L12)*
+*Defined in [promise/SubmittableExtrinsic.ts:12](https://github.com/polkadot-js/api/blob/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/packages/api/src/promise/SubmittableExtrinsic.ts#L22)*
+*Defined in [promise/SubmittableExtrinsic.ts:22](https://github.com/polkadot-js/api/blob/8fafedc/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/5975e23/packages/api/src/promise/SubmittableExtrinsic.ts#L26)*
+*Defined in [promise/SubmittableExtrinsic.ts:26](https://github.com/polkadot-js/api/blob/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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 73f983c5bc..d897d20aa6 100644
--- a/docs/api/classes/_rx_index_.apirx.html
+++ b/docs/api/classes/_rx_index_.apirx.html
@@ -209,12 +209,12 @@
- -
+
-
-
+
- RPC
+ ApiPromise
@@ -223,9 +223,9 @@
- -
+
-
-
+
Simple connect
@@ -236,9 +236,9 @@
- -
+
-
-
+
Listen to blocks
@@ -249,9 +249,9 @@
- -
+
-
-
+
Listen to balance change
@@ -262,9 +262,9 @@
- -
+
-
-
+
Generate Accounts
@@ -275,9 +275,9 @@
- -
+
-
-
+
Read Storage
@@ -288,9 +288,9 @@
- -
+
-
-
+
Craft Extrinsic
@@ -301,9 +301,9 @@
- -
+
-
-
+
Transfer DOTs
@@ -451,7 +451,7 @@
constructor
⊕ new ApiRx(wsProvider?: WsProvider): ApiRx
Overrides ApiBase.constructor
-Defined in rx/index.ts:143
+Defined in rx/index.ts:143
description: Create an instance of the ApiRx class
example:
import Api from '@polkadot/api/rx';
@@ -486,21 +486,21 @@
genesisHash
getgenesisHash(): Hash
Inherited from ApiBase.genesisHash
-Defined in Base.ts:71
+Defined in Base.ts:71
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.
Returns: Hash
isConnected
getisConnected(): Observable<boolean>
-Defined in rx/index.ts:179
+Defined in rx/index.ts:179
description: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
Returns: Observable<boolean>
isReady
getisReady(): Observable<ApiRx>
-Defined in rx/index.ts:186
+Defined in rx/index.ts:186
description: Observable that returns the first time we are connected and loaded
Returns: Observable<ApiRx>
@@ -508,7 +508,7 @@
rpc
getrpc(): RpcRx
-Defined in Base.ts:111
+Defined in Base.ts:111
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:
@@ -524,7 +524,7 @@
runtimeMetadata
getruntimeMetadata(): RuntimeMetadata
Inherited from ApiBase.runtimeMetadata
-Defined in Base.ts:80
+Defined in Base.ts:80
description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
Returns: RuntimeMetadata
@@ -532,7 +532,7 @@
runtimeVersion
getruntimeVersion(): RuntimeVersion
Inherited from ApiBase.runtimeVersion
-Defined in Base.ts:89
+Defined in Base.ts:89
description: Contains the version information for the current runtime.
Returns: RuntimeVersion
@@ -540,7 +540,7 @@
st
getst(): QueryableStorage
-Defined in Base.ts:131
+Defined in Base.ts:131
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:
@@ -556,7 +556,7 @@
tx
gettx(): SubmittableExtrinsics
-Defined in Base.ts:153
+Defined in Base.ts:153
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.
example:
api.tx.balances
@@ -574,7 +574,7 @@
on
▸ on(type: ApiInterface$Events, handler: function): void
-Defined in Base.ts:178
+Defined in Base.ts:178
description: Attach an eventemitter handler to listen to a specific event
example:
* api.on('disconnected', () => {
@@ -612,7 +612,7 @@
<Static> create
▸ create(wsProvider?: WsProvider): Observable<ApiRx>
-Defined in rx/index.ts:141
+Defined in rx/index.ts:141
description: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
example:
import Api from '@polkadot/api/rx';
@@ -685,7 +685,7 @@
diff --git a/docs/api/classes/_rx_index_.apirx.md b/docs/api/classes/_rx_index_.apirx.md
index fd0badd0ce..2f86315c41 100644
--- a/docs/api/classes/_rx_index_.apirx.md
+++ b/docs/api/classes/_rx_index_.apirx.md
@@ -115,7 +115,7 @@ api.st.system
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
-*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/5975e23/packages/api/src/rx/index.ts#L143)*
+*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/8fafedc/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/5975e23/packages/api/src/Base.ts#L71)*
+*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/8fafedc/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/5975e23/packages/api/src/rx/index.ts#L179)*
+*Defined in [rx/index.ts:179](https://github.com/polkadot-js/api/blob/8fafedc/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/5975e23/packages/api/src/rx/index.ts#L186)*
+*Defined in [rx/index.ts:186](https://github.com/polkadot-js/api/blob/8fafedc/packages/api/src/rx/index.ts#L186)*
*__description__*: Observable that returns the first time we are connected and loaded
@@ -191,7 +191,7 @@ getrpc(): `RpcRx`
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
-*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/5975e23/packages/api/src/Base.ts#L111)*
+*Defined in [Base.ts:111](https://github.com/polkadot-js/api/blob/8fafedc/packages/api/src/Base.ts#L111)*
*__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.
@@ -217,7 +217,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/5975e23/packages/api/src/Base.ts#L80)*
+*Defined in [Base.ts:80](https://github.com/polkadot-js/api/blob/8fafedc/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.
@@ -232,7 +232,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/5975e23/packages/api/src/Base.ts#L89)*
+*Defined in [Base.ts:89](https://github.com/polkadot-js/api/blob/8fafedc/packages/api/src/Base.ts#L89)*
*__description__*: Contains the version information for the current runtime.
@@ -247,7 +247,7 @@ getst(): `QueryableStorage`
*Inherited from [ApiBase](_base_.apibase.md).[st](_base_.apibase.md#st)*
-*Defined in [Base.ts:131](https://github.com/polkadot-js/api/blob/5975e23/packages/api/src/Base.ts#L131)*
+*Defined in [Base.ts:131](https://github.com/polkadot-js/api/blob/8fafedc/packages/api/src/Base.ts#L131)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -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/5975e23/packages/api/src/Base.ts#L153)*
+*Defined in [Base.ts:153](https://github.com/polkadot-js/api/blob/8fafedc/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/5975e23/packages/api/src/Base.ts#L178)*
+*Defined in [Base.ts:178](https://github.com/polkadot-js/api/blob/8fafedc/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/5975e23/packages/api/src/rx/index.ts#L141)*
+*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/8fafedc/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 57514c8fa7..6f51915674 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/5975e23/packages/api/src/rx/SubmittableExtrinsic.ts#L13)*
+*Defined in [rx/SubmittableExtrinsic.ts:13](https://github.com/polkadot-js/api/blob/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/packages/api/src/rx/SubmittableExtrinsic.ts#L22)*
+*Defined in [rx/SubmittableExtrinsic.ts:22](https://github.com/polkadot-js/api/blob/8fafedc/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/5975e23/packages/api/src/rx/SubmittableExtrinsic.ts#L26)*
+*Defined in [rx/SubmittableExtrinsic.ts:26](https://github.com/polkadot-js/api/blob/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/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/5975e23/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/8fafedc/packages/types/src/codec/Struct.ts#L98)*
**Type parameters:**
diff --git a/docs/api/index.html b/docs/api/index.html
index 5a7b156100..e74c77fe52 100644
--- a/docs/api/index.html
+++ b/docs/api/index.html
@@ -209,12 +209,12 @@
- -
+
-
-
+
- RPC
+ ApiPromise
@@ -223,9 +223,9 @@
- -
+
-
-
+
Simple connect
@@ -236,9 +236,9 @@
- -
+
-
-
+
Listen to blocks
@@ -249,9 +249,9 @@
- -
+
-
-
+
Listen to balance change
@@ -262,9 +262,9 @@
- -
+
-
-
+
Generate Accounts
@@ -275,9 +275,9 @@
- -
+
-
-
+
Read Storage
@@ -288,9 +288,9 @@
- -
+
-
-
+
Craft Extrinsic
@@ -301,9 +301,9 @@
- -
+
-
-
+
Transfer DOTs
@@ -377,7 +377,7 @@
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. Depending on your use-case and familiarity, you can choose either (or even both) for your application.
-- ApiPromise All interface calls returns Promises, including the static
.create(...). Additionally any subscription method use standard JavaScript (error, value) => {} callbacks.
+- ApiPromise All interface calls returns Promises, including the static
.create(...). Additionally any subscription method use (value) => {} callbacks, returning the value as the subscription is updated.
- ApiRx 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
@@ -393,7 +393,7 @@
const api = await ApiPromise.create();
// make a call to retrieve the current network head
-api.rpc.chain.newHead((error, header) => {
+api.rpc.chain.newHead((header) => {
console.log(`Chain is at #${header.blockNumber}`);
});
@@ -457,7 +457,7 @@
diff --git a/docs/examples/deprecated-rpc/03_listen_to_balance_change/index.html b/docs/examples/deprecated-rpc/03_listen_to_balance_change/index.html
index b8828856bb..f15eed5b3d 100644
--- a/docs/examples/deprecated-rpc/03_listen_to_balance_change/index.html
+++ b/docs/examples/deprecated-rpc/03_listen_to_balance_change/index.html
@@ -13,24 +13,24 @@
-
+
-
+
-
+
-
+
-
+
@@ -61,14 +61,14 @@
-
-
+
+
-
+
@@ -99,9 +99,9 @@
- -
+
-
-
+
Introduction
@@ -112,9 +112,9 @@
- -
+
-
-
+
api
@@ -126,9 +126,9 @@
- -
+
-
-
+
ApiPromise
@@ -139,9 +139,9 @@
- -
+
-
-
+
ApiRx
@@ -157,9 +157,9 @@
- -
+
-
-
+
rpc-provider
@@ -171,9 +171,9 @@
@@ -412,7 +412,7 @@
-
+
@@ -428,46 +428,46 @@
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+