⊕ new ApiPromise(options?: ApiOptions | ProviderInterface): ApiPromise
Overrides ApiBase.constructor
-Defined in promise/index.ts:128
+Defined in promise/index.ts:128
description: Creates an instance of the ApiPromise class
example:
import Api from '@polkadot/api/promise';
@@ -2247,7 +2247,7 @@
derive
getderive(): Derive<CodecResult, SubscriptionResult>
-Defined in Base.ts:180
+Defined in Base.ts:180
description: Derived results that are injected into the API, allowing for combinations of various query results.
example:
api.derive.chain.bestNumber((number) => {
@@ -2260,7 +2260,7 @@
genesisHash
getgenesisHash(): Hash
Inherited from ApiBase.genesisHash
-Defined in Base.ts:123
+Defined in Base.ts:123
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
@@ -2268,14 +2268,14 @@
hasSubscriptions
gethasSubscriptions(): boolean
Inherited from ApiBase.hasSubscriptions
-Defined in Base.ts:132
+Defined in Base.ts:132
description: true when subscriptions are supported
Returns: boolean
isReady
getisReady(): Promise<ApiPromise>
-Defined in promise/index.ts:163
+Defined in promise/index.ts:163
description: Promise that returns the first time we are connected and loaded
Returns: Promise<ApiPromise>
@@ -2283,7 +2283,7 @@
query
getquery(): QueryableStorage<CodecResult, SubscriptionResult>
-Defined in Base.ts:200
+Defined in Base.ts:200
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.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:
@@ -2297,7 +2297,7 @@
rpc
getrpc(): DecoratedRpc<CodecResult, SubscriptionResult>
-Defined in Base.ts:220
+Defined in Base.ts:220
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.
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:
@@ -2311,7 +2311,7 @@
runtimeMetadata
getruntimeMetadata(): Metadata
Inherited from ApiBase.runtimeMetadata
-Defined in Base.ts:139
+Defined in Base.ts:139
description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
Returns: Metadata
@@ -2319,7 +2319,7 @@
runtimeVersion
getruntimeVersion(): RuntimeVersion
Inherited from ApiBase.runtimeVersion
-Defined in Base.ts:148
+Defined in Base.ts:148
description: Contains the version information for the current runtime.
Returns: RuntimeVersion
@@ -2327,7 +2327,7 @@
tx
gettx(): SubmittableExtrinsics<CodecResult, SubscriptionResult>
-Defined in Base.ts:238
+Defined in Base.ts:238
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
@@ -2342,7 +2342,7 @@
type
gettype(): ApiType
-Defined in Base.ts:157
+Defined in Base.ts:157
description: The type of this API instance, either 'rxjs' or 'promise'
Returns: ApiType
@@ -2350,14 +2350,14 @@
clone
▸ clone(): ApiPromise
-Defined in promise/index.ts:170
+Defined in promise/index.ts:170
description: Returns a clone of this ApiPromise instance (new underlying provider connection)
Returns: ApiPromise
combineLatest
▸ combineLatest(fns: Array<CombinatorFunction | [CombinatorFunction, Array]>, callback: CombinatorCallback): SubscriptionResult
-Defined in promise/index.ts:197
+Defined in promise/index.ts:197
description: Creates a combinator that can be used to combine the latest results from multiple subscriptions
example:
const address = '5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7';
@@ -2401,7 +2401,7 @@
▸ disconnect(): void
Implementation of ApiPromiseInterface.disconnect
Inherited from ApiBase.disconnect
-Defined in Base.ts:247
+Defined in Base.ts:247
description: Disconnect from the underlying provider, halting all comms
Returns: void
@@ -2409,7 +2409,7 @@
on
▸ on(type: ApiInterface$Events, handler: function): this
-Defined in Base.ts:270
+Defined in Base.ts:270
description: Attach an eventemitter handler to listen to a specific event
example:
api.on('connected', () => {
@@ -2448,7 +2448,7 @@
once
▸ once(type: ApiInterface$Events, handler: function): this
-Defined in Base.ts:295
+Defined in Base.ts:295
description: Attach an one-time eventemitter handler to listen to a specific event
example:
api.once('connected', () => {
@@ -2488,7 +2488,7 @@
▸ registerTypes(types?: RegistryTypes): void
Implementation of ApiPromiseInterface.registerTypes
Inherited from ApiBase.registerTypes
-Defined in Base.ts:304
+Defined in Base.ts:304
description: Register additional user-defined of chain-specific types in the type registry
Parameters:
@@ -2512,7 +2512,7 @@
▸ setSigner(signer: Signer): void
Implementation of ApiPromiseInterface.setSigner
Inherited from ApiBase.setSigner
-Defined in Base.ts:164
+Defined in Base.ts:164
description: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
Parameters:
@@ -2534,7 +2534,7 @@
<Static> create
▸ create(options?: ApiOptions | ProviderInterface): Promise<ApiPromise>
-Defined in promise/index.ts:126
+Defined in promise/index.ts:126
description: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
example:
import Api from '@polkadot/api/promise';
@@ -2610,7 +2610,7 @@
diff --git a/docs/api/classes/_promise_index_.apipromise.md b/docs/api/classes/_promise_index_.apipromise.md
index 7821106a06..de4c05f96c 100644
--- a/docs/api/classes/_promise_index_.apipromise.md
+++ b/docs/api/classes/_promise_index_.apipromise.md
@@ -107,7 +107,7 @@ ApiPromise.create().then((api) => {
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
-*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/index.ts#L128)*
+*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/index.ts#L128)*
*__description__*: Creates an instance of the ApiPromise class
@@ -143,7 +143,7 @@ getderive(): [Derive](../interfaces/_types_.derive.md)<[CodecResult](), [Subscri
*Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)*
-*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L180)*
+*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L180)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -166,7 +166,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
-*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L123)*
+*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L123)*
*__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.
@@ -181,7 +181,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
-*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L132)*
+*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L132)*
*__description__*: `true` when subscriptions are supported
@@ -194,7 +194,7 @@ ___
getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
-*Defined in [promise/index.ts:163](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/index.ts#L163)*
+*Defined in [promise/index.ts:163](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/index.ts#L163)*
*__description__*: Promise that returns the first time we are connected and loaded
@@ -209,7 +209,7 @@ getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[Codec
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
-*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L200)*
+*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L200)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -234,7 +234,7 @@ getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[CodecResult](),
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
-*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L220)*
+*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L220)*
*__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.
@@ -259,7 +259,7 @@ getruntimeMetadata(): `Metadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
-*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L139)*
+*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L139)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -274,7 +274,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
-*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L148)*
+*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L148)*
*__description__*: Contains the version information for the current runtime.
@@ -289,7 +289,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
-*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L238)*
+*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L238)*
*__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.
@@ -314,7 +314,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype)
*Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)*
-*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L157)*
+*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L157)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -330,7 +330,7 @@ ___
▸ **clone**(): [ApiPromise](_promise_index_.apipromise.md)
-*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/index.ts#L170)*
+*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/index.ts#L170)*
*__description__*: Returns a clone of this ApiPromise instance (new underlying provider connection)
@@ -343,7 +343,7 @@ ___
▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) \| [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [SubscriptionResult]()
-*Defined in [promise/index.ts:197](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/index.ts#L197)*
+*Defined in [promise/index.ts:197](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/index.ts#L197)*
*__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions
@@ -382,7 +382,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)*
-*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L247)*
+*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L247)*
*__description__*: Disconnect from the underlying provider, halting all comms
@@ -397,7 +397,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
-*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L270)*
+*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L270)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -431,7 +431,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)*
-*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L295)*
+*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L295)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -467,7 +467,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)*
-*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L304)*
+*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L304)*
*__description__*: Register additional user-defined of chain-specific types in the type registry
@@ -490,7 +490,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)*
-*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L164)*
+*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L164)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
@@ -509,7 +509,7 @@ ___
▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)>
-*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/index.ts#L126)*
+*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/index.ts#L126)*
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
diff --git a/docs/api/classes/_rx_index_.apirx.html b/docs/api/classes/_rx_index_.apirx.html
index 035b5bada3..ce08757d7e 100644
--- a/docs/api/classes/_rx_index_.apirx.html
+++ b/docs/api/classes/_rx_index_.apirx.html
@@ -2225,7 +2225,7 @@
constructor
⊕ new ApiRx(provider?: ApiOptions | ProviderInterface): ApiRx
Overrides ApiBase.constructor
-Defined in rx/index.ts:142
+Defined in rx/index.ts:142
description: Create an instance of the ApiRx class
example:
import { switchMap } from 'rxjs/operators';
@@ -2263,7 +2263,7 @@
derive
getderive(): Derive<RxResult, RxResult>
-Defined in Base.ts:180
+Defined in Base.ts:180
description: Derived results that are injected into the API, allowing for combinations of various query results.
example:
api.derive.chain.bestNumber((number) => {
@@ -2276,7 +2276,7 @@
genesisHash
getgenesisHash(): Hash
Inherited from ApiBase.genesisHash
-Defined in Base.ts:123
+Defined in Base.ts:123
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
@@ -2284,21 +2284,21 @@
hasSubscriptions
gethasSubscriptions(): boolean
Inherited from ApiBase.hasSubscriptions
-Defined in Base.ts:132
+Defined in Base.ts:132
description: true when subscriptions are supported
Returns: boolean
isConnected
getisConnected(): Observable<boolean>
-Defined in rx/index.ts:182
+Defined in rx/index.ts:182
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:189
+Defined in rx/index.ts:189
description: Observable that returns the first time we are connected and loaded
Returns: Observable<ApiRx>
@@ -2306,7 +2306,7 @@
query
getquery(): QueryableStorage<RxResult, RxResult>
-Defined in Base.ts:200
+Defined in Base.ts:200
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.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:
@@ -2320,7 +2320,7 @@
rpc
getrpc(): DecoratedRpc<RxResult, RxResult>
-Defined in Base.ts:220
+Defined in Base.ts:220
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.
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:
@@ -2334,7 +2334,7 @@
runtimeMetadata
getruntimeMetadata(): Metadata
Inherited from ApiBase.runtimeMetadata
-Defined in Base.ts:139
+Defined in Base.ts:139
description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
Returns: Metadata
@@ -2342,7 +2342,7 @@
runtimeVersion
getruntimeVersion(): RuntimeVersion
Inherited from ApiBase.runtimeVersion
-Defined in Base.ts:148
+Defined in Base.ts:148
description: Contains the version information for the current runtime.
Returns: RuntimeVersion
@@ -2350,7 +2350,7 @@
tx
gettx(): SubmittableExtrinsics<RxResult, RxResult>
-Defined in Base.ts:238
+Defined in Base.ts:238
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
@@ -2365,7 +2365,7 @@
type
gettype(): ApiType
-Defined in Base.ts:157
+Defined in Base.ts:157
description: The type of this API instance, either 'rxjs' or 'promise'
Returns: ApiType
@@ -2373,7 +2373,7 @@
clone
▸ clone(): ApiRx
-Defined in rx/index.ts:196
+Defined in rx/index.ts:196
description: Returns a clone of this ApiRx instance (new underlying provider connection)
Returns: ApiRx
@@ -2382,7 +2382,7 @@
▸ disconnect(): void
Implementation of ApiRxInterface.disconnect
Inherited from ApiBase.disconnect
-Defined in Base.ts:247
+Defined in Base.ts:247
description: Disconnect from the underlying provider, halting all comms
Returns: void
@@ -2390,7 +2390,7 @@
on
▸ on(type: ApiInterface$Events, handler: function): this
-Defined in Base.ts:270
+Defined in Base.ts:270
description: Attach an eventemitter handler to listen to a specific event
example:
api.on('connected', () => {
@@ -2429,7 +2429,7 @@
once
▸ once(type: ApiInterface$Events, handler: function): this
-Defined in Base.ts:295
+Defined in Base.ts:295
description: Attach an one-time eventemitter handler to listen to a specific event
example:
api.once('connected', () => {
@@ -2469,7 +2469,7 @@
▸ registerTypes(types?: RegistryTypes): void
Implementation of ApiRxInterface.registerTypes
Inherited from ApiBase.registerTypes
-Defined in Base.ts:304
+Defined in Base.ts:304
description: Register additional user-defined of chain-specific types in the type registry
Parameters:
@@ -2493,7 +2493,7 @@
▸ setSigner(signer: Signer): void
Implementation of ApiRxInterface.setSigner
Inherited from ApiBase.setSigner
-Defined in Base.ts:164
+Defined in Base.ts:164
description: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
Parameters:
@@ -2515,7 +2515,7 @@
<Static> create
▸ create(options?: ApiOptions | ProviderInterface): Observable<ApiRx>
-Defined in rx/index.ts:140
+Defined in rx/index.ts:140
description: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
example:
import { switchMap } from 'rxjs/operators';
@@ -2593,7 +2593,7 @@
diff --git a/docs/api/classes/_rx_index_.apirx.md b/docs/api/classes/_rx_index_.apirx.md
index f0affdc586..a55fefc1ff 100644
--- a/docs/api/classes/_rx_index_.apirx.md
+++ b/docs/api/classes/_rx_index_.apirx.md
@@ -121,7 +121,7 @@ api.query.system
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
-*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/rx/index.ts#L142)*
+*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/rx/index.ts#L142)*
*__description__*: Create an instance of the ApiRx class
@@ -161,7 +161,7 @@ getderive(): [Derive](../interfaces/_types_.derive.md)<[RxResult](../modules/_rx
*Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)*
-*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L180)*
+*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L180)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -184,7 +184,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
-*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L123)*
+*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L123)*
*__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.
@@ -199,7 +199,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
-*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L132)*
+*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L132)*
*__description__*: `true` when subscriptions are supported
@@ -212,7 +212,7 @@ ___
getisConnected(): `Observable`<`boolean`>
-*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/rx/index.ts#L182)*
+*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/rx/index.ts#L182)*
*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
@@ -225,7 +225,7 @@ ___
getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)>
-*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/rx/index.ts#L189)*
+*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/rx/index.ts#L189)*
*__description__*: Observable that returns the first time we are connected and loaded
@@ -240,7 +240,7 @@ getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[RxRes
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
-*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L200)*
+*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L200)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -265,7 +265,7 @@ getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[RxResult](../mo
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
-*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L220)*
+*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L220)*
*__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.
@@ -290,7 +290,7 @@ getruntimeMetadata(): `Metadata`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
-*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L139)*
+*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L139)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -305,7 +305,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
-*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L148)*
+*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L148)*
*__description__*: Contains the version information for the current runtime.
@@ -320,7 +320,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
-*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L238)*
+*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L238)*
*__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.
@@ -345,7 +345,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype)
*Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)*
-*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L157)*
+*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L157)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -361,7 +361,7 @@ ___
▸ **clone**(): [ApiRx](_rx_index_.apirx.md)
-*Defined in [rx/index.ts:196](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/rx/index.ts#L196)*
+*Defined in [rx/index.ts:196](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/rx/index.ts#L196)*
*__description__*: Returns a clone of this ApiRx instance (new underlying provider connection)
@@ -378,7 +378,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)*
-*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L247)*
+*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L247)*
*__description__*: Disconnect from the underlying provider, halting all comms
@@ -393,7 +393,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
-*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L270)*
+*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L270)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -427,7 +427,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)*
-*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L295)*
+*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L295)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -463,7 +463,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)*
-*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L304)*
+*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L304)*
*__description__*: Register additional user-defined of chain-specific types in the type registry
@@ -486,7 +486,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)*
-*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L164)*
+*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L164)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
@@ -505,7 +505,7 @@ ___
▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)>
-*Defined in [rx/index.ts:140](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/rx/index.ts#L140)*
+*Defined in [rx/index.ts:140](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/rx/index.ts#L140)*
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
diff --git a/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md
index 55c824d723..247e14ba55 100644
--- a/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md
+++ b/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md
@@ -27,7 +27,7 @@
*Overrides Extrinsic.__constructor*
-*Defined in [SubmittableExtrinsic.ts:62](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/SubmittableExtrinsic.ts#L62)*
+*Defined in [SubmittableExtrinsic.ts:62](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/SubmittableExtrinsic.ts#L62)*
**Parameters:**
@@ -77,7 +77,7 @@ getType(): `E`
*Inherited from Struct.Type*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L145)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the Type description to sthe structure
@@ -92,7 +92,7 @@ getargs(): `Array`<`Codec`>
*Inherited from Extrinsic.args*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L76)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L76)*
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
@@ -107,7 +107,7 @@ getcallIndex(): `Uint8Array`
*Inherited from Extrinsic.callIndex*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L83)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L83)*
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
@@ -122,7 +122,7 @@ getdata(): `Uint8Array`
*Inherited from Extrinsic.data*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L90)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L90)*
*__description__*: The actual data for the Method
@@ -139,7 +139,7 @@ getencodedLength(): `number`
*Overrides Struct.encodedLength*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/29c83a0/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/b846152/packages/types/src/Extrinsic.ts#L97)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -154,7 +154,7 @@ gethash(): `Hash`
*Inherited from Extrinsic.hash*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L106)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L106)*
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
@@ -169,7 +169,7 @@ getisSigned(): `boolean`
*Inherited from Extrinsic.isSigned*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L115)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L115)*
*__description__*: `true` id the extrinsic is signed
@@ -184,7 +184,7 @@ getlength(): `number`
*Inherited from Extrinsic.length*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L122)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L122)*
*__description__*: The length of the encoded value
@@ -199,7 +199,7 @@ getmeta(): `FunctionMetadata`
*Inherited from Extrinsic.meta*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L129)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L129)*
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
@@ -214,7 +214,7 @@ getmethod(): `Method`
*Inherited from Extrinsic.method*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L136)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L136)*
*__description__*: The \[\[Method\]\] this extrinsic wraps
@@ -229,7 +229,7 @@ getsignature(): `ExtrinsicSignature`
*Inherited from Extrinsic.signature*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L143)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L143)*
*__description__*: The \[\[ExtrinsicSignature\]\]
@@ -262,7 +262,7 @@ ___
*Inherited from Extrinsic.addSignature*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L150)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L150)*
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
@@ -333,7 +333,7 @@ ___
*Inherited from Struct.eq*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:161](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L161)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:161](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L161)*
*__description__*: Compares the value of the input to see if there is a match
@@ -376,7 +376,7 @@ ___
*Overrides Map.get*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:169](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L169)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:169](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L169)*
*__description__*: Returns a specific names entry in the structure
@@ -397,7 +397,7 @@ ___
*Inherited from Struct.getAtIndex*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L176)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L176)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -452,11 +452,11 @@ ___
▸ **send**(statusCb: *`function`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`>
-*Defined in [SubmittableExtrinsic.ts:135](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/SubmittableExtrinsic.ts#L135)*
+*Defined in [SubmittableExtrinsic.ts:135](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/SubmittableExtrinsic.ts#L135)*
**Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`>
-*Defined in [SubmittableExtrinsic.ts:136](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/SubmittableExtrinsic.ts#L136)*
+*Defined in [SubmittableExtrinsic.ts:136](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/SubmittableExtrinsic.ts#L136)*
**Parameters:**
@@ -495,7 +495,7 @@ ___
*Overrides Extrinsic.sign*
-*Defined in [SubmittableExtrinsic.ts:153](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/SubmittableExtrinsic.ts#L153)*
+*Defined in [SubmittableExtrinsic.ts:153](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/SubmittableExtrinsic.ts#L153)*
**Parameters:**
@@ -515,7 +515,7 @@ ___
▸ **signAndSend**(account: *`KeyringPair` \| `string` \| `AccountId` \| `Address`*, statusCb: *`StatusCb`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`>
-*Defined in [SubmittableExtrinsic.ts:165](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/SubmittableExtrinsic.ts#L165)*
+*Defined in [SubmittableExtrinsic.ts:165](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/SubmittableExtrinsic.ts#L165)*
**Parameters:**
@@ -526,7 +526,7 @@ ___
**Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`>
-*Defined in [SubmittableExtrinsic.ts:166](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/SubmittableExtrinsic.ts#L166)*
+*Defined in [SubmittableExtrinsic.ts:166](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/SubmittableExtrinsic.ts#L166)*
**Parameters:**
@@ -546,7 +546,7 @@ ___
*Inherited from Struct.toArray*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:183](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L183)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:183](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L183)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -563,7 +563,7 @@ ___
*Overrides Struct.toHex*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L168)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L168)*
*__description__*: Returns a hex string representation of the value
@@ -580,7 +580,7 @@ ___
*Overrides Struct.toJSON*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L175)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L175)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -595,7 +595,7 @@ ___
*Inherited from Struct.toString*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:211](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L211)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:211](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L211)*
*__description__*: Returns the string representation of the value
@@ -612,7 +612,7 @@ ___
*Overrides Struct.toU8a*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L183)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L183)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -648,7 +648,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Extrinsic.ts#L44)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Extrinsic.ts#L44)*
**Parameters:**
@@ -667,7 +667,7 @@ ___
*Inherited from Struct.with*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L125)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L125)*
**Type parameters:**
diff --git a/docs/api/classes/_submittableextrinsic_.submittableresult.md b/docs/api/classes/_submittableextrinsic_.submittableresult.md
index 24accd0a2d..b02ea9397a 100644
--- a/docs/api/classes/_submittableextrinsic_.submittableresult.md
+++ b/docs/api/classes/_submittableextrinsic_.submittableresult.md
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
-*Defined in [SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/SubmittableExtrinsic.ts#L28)*
+*Defined in [SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/SubmittableExtrinsic.ts#L28)*
**Parameters:**
@@ -72,7 +72,7 @@ getType(): `E`
*Inherited from Struct.Type*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L145)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the Type description to sthe structure
@@ -87,7 +87,7 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L152)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L152)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -100,7 +100,7 @@ ___
getevents(): `Array`<`EventRecord`>
-*Defined in [SubmittableExtrinsic.ts:40](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/SubmittableExtrinsic.ts#L40)*
+*Defined in [SubmittableExtrinsic.ts:40](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/SubmittableExtrinsic.ts#L40)*
*__description__*: the contained events
@@ -113,7 +113,7 @@ ___
getstatus(): `ExtrinsicStatus`
-*Defined in [SubmittableExtrinsic.ts:47](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/SubmittableExtrinsic.ts#L47)*
+*Defined in [SubmittableExtrinsic.ts:47](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/SubmittableExtrinsic.ts#L47)*
*__description__*: the status
@@ -126,7 +126,7 @@ ___
gettype(): `string`
-*Defined in [SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/SubmittableExtrinsic.ts#L54)*
+*Defined in [SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/SubmittableExtrinsic.ts#L54)*
*__description__*: the type
@@ -206,7 +206,7 @@ ___
*Inherited from Struct.eq*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:161](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L161)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:161](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L161)*
*__description__*: Compares the value of the input to see if there is a match
@@ -249,7 +249,7 @@ ___
*Overrides Map.get*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:169](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L169)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:169](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L169)*
*__description__*: Returns a specific names entry in the structure
@@ -270,7 +270,7 @@ ___
*Inherited from Struct.getAtIndex*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L176)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L176)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -345,7 +345,7 @@ ___
*Inherited from Struct.toArray*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:183](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L183)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:183](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L183)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -360,7 +360,7 @@ ___
*Inherited from Struct.toHex*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:190](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L190)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:190](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L190)*
*__description__*: Returns a hex string representation of the value
@@ -375,7 +375,7 @@ ___
*Inherited from Struct.toJSON*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:197](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L197)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:197](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L197)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -390,7 +390,7 @@ ___
*Inherited from Struct.toString*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:211](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L211)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:211](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L211)*
*__description__*: Returns the string representation of the value
@@ -405,7 +405,7 @@ ___
*Inherited from Struct.toU8a*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:219](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L219)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:219](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L219)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -441,7 +441,7 @@ ___
*Inherited from Struct.with*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/codec/Struct.ts#L125)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/codec/Struct.ts#L125)*
**Type parameters:**
diff --git a/docs/api/index.html b/docs/api/index.html
index 1fd1d2594e..38dd797b49 100644
--- a/docs/api/index.html
+++ b/docs/api/index.html
@@ -2256,7 +2256,7 @@
diff --git a/docs/api/interfaces/_promise_types_.apipromiseinterface.md b/docs/api/interfaces/_promise_types_.apipromiseinterface.md
index a09e02fb7e..2f51778c1d 100644
--- a/docs/api/interfaces/_promise_types_.apipromiseinterface.md
+++ b/docs/api/interfaces/_promise_types_.apipromiseinterface.md
@@ -24,7 +24,7 @@
*Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)*
-*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L72)*
+*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L72)*
*__description__*: Create an instance of the class
@@ -59,7 +59,7 @@ ___
**● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>*
-*Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/types.ts#L16)*
+*Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/types.ts#L16)*
___
@@ -73,7 +73,7 @@ getderive(): [Derive](_types_.derive.md)<[CodecResult](../modules/_promise_types
*Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)*
-*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L180)*
+*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L180)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -96,7 +96,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)*
-*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L123)*
+*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L123)*
*__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.
@@ -111,7 +111,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)*
-*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L132)*
+*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L132)*
*__description__*: `true` when subscriptions are supported
@@ -126,7 +126,7 @@ getquery(): [QueryableStorage](_types_.queryablestorage.md)<[CodecResult](../mod
*Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)*
-*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L200)*
+*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L200)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -151,7 +151,7 @@ getrpc(): [DecoratedRpc](_types_.decoratedrpc.md)<[CodecResult](../modules/_prom
*Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)*
-*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L220)*
+*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L220)*
*__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.
@@ -176,7 +176,7 @@ getruntimeMetadata(): `Metadata`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)*
-*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L139)*
+*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L139)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -191,7 +191,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)*
-*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L148)*
+*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L148)*
*__description__*: Contains the version information for the current runtime.
@@ -206,7 +206,7 @@ gettx(): [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[CodecResult]
*Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)*
-*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L238)*
+*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L238)*
*__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.
@@ -231,7 +231,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype)
*Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)*
-*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L157)*
+*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L157)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -249,7 +249,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)*
-*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L247)*
+*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L247)*
*__description__*: Disconnect from the underlying provider, halting all comms
@@ -264,7 +264,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)*
-*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L270)*
+*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L270)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -298,7 +298,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)*
-*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L295)*
+*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L295)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -332,7 +332,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[registerTypes](../classes/_base_.apibase.md#registertypes)*
-*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L304)*
+*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L304)*
*__description__*: Register additional user-defined of chain-specific types in the type registry
@@ -353,7 +353,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)*
-*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L164)*
+*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L164)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
diff --git a/docs/api/interfaces/_rx_types_.apirxinterface.md b/docs/api/interfaces/_rx_types_.apirxinterface.md
index 3bf138c198..cdac49b874 100644
--- a/docs/api/interfaces/_rx_types_.apirxinterface.md
+++ b/docs/api/interfaces/_rx_types_.apirxinterface.md
@@ -24,7 +24,7 @@
*Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)*
-*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L72)*
+*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L72)*
*__description__*: Create an instance of the class
@@ -59,7 +59,7 @@ ___
**● isConnected**: *`Observable`<`boolean`>*
-*Defined in [rx/types.ts:13](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/rx/types.ts#L13)*
+*Defined in [rx/types.ts:13](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/rx/types.ts#L13)*
___
@@ -68,7 +68,7 @@ ___
**● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>*
-*Defined in [rx/types.ts:14](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/rx/types.ts#L14)*
+*Defined in [rx/types.ts:14](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/rx/types.ts#L14)*
___
@@ -82,7 +82,7 @@ getderive(): [Derive](_types_.derive.md)<[RxResult](../modules/_rx_types_.md#rxr
*Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)*
-*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L180)*
+*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L180)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -105,7 +105,7 @@ getgenesisHash(): `Hash`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)*
-*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L123)*
+*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L123)*
*__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.
@@ -120,7 +120,7 @@ gethasSubscriptions(): `boolean`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)*
-*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L132)*
+*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L132)*
*__description__*: `true` when subscriptions are supported
@@ -135,7 +135,7 @@ getquery(): [QueryableStorage](_types_.queryablestorage.md)<[RxResult](../module
*Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)*
-*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L200)*
+*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L200)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -160,7 +160,7 @@ getrpc(): [DecoratedRpc](_types_.decoratedrpc.md)<[RxResult](../modules/_rx_type
*Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)*
-*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L220)*
+*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L220)*
*__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.
@@ -185,7 +185,7 @@ getruntimeMetadata(): `Metadata`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)*
-*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L139)*
+*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L139)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -200,7 +200,7 @@ getruntimeVersion(): `RuntimeVersion`
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)*
-*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L148)*
+*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L148)*
*__description__*: Contains the version information for the current runtime.
@@ -215,7 +215,7 @@ gettx(): [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[RxResult](..
*Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)*
-*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L238)*
+*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L238)*
*__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.
@@ -240,7 +240,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype)
*Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)*
-*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L157)*
+*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L157)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -258,7 +258,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)*
-*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L247)*
+*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L247)*
*__description__*: Disconnect from the underlying provider, halting all comms
@@ -273,7 +273,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)*
-*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L270)*
+*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L270)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -307,7 +307,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)*
-*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L295)*
+*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L295)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -341,7 +341,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[registerTypes](../classes/_base_.apibase.md#registertypes)*
-*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L304)*
+*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L304)*
*__description__*: Register additional user-defined of chain-specific types in the type registry
@@ -362,7 +362,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)*
-*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/Base.ts#L164)*
+*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/Base.ts#L164)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
diff --git a/docs/api/interfaces/_types_.apibaseinterface.md b/docs/api/interfaces/_types_.apibaseinterface.md
index 71fa416eb0..19fc76427a 100644
--- a/docs/api/interfaces/_types_.apibaseinterface.md
+++ b/docs/api/interfaces/_types_.apibaseinterface.md
@@ -25,7 +25,7 @@
**● on**: *`function`*
-*Defined in [types.ts:153](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L153)*
+*Defined in [types.ts:158](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L158)*
#### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
@@ -46,7 +46,7 @@ ___
**● once**: *`function`*
-*Defined in [types.ts:154](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L154)*
+*Defined in [types.ts:159](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L159)*
#### Type declaration
▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
@@ -67,7 +67,7 @@ ___
**● type**: *[ApiType](../modules/_types_.md#apitype)*
-*Defined in [types.ts:151](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L151)*
+*Defined in [types.ts:156](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L156)*
___
diff --git a/docs/api/interfaces/_types_.apiinterface_decorated.md b/docs/api/interfaces/_types_.apiinterface_decorated.md
index c1a5dadf38..6dac13bd0b 100644
--- a/docs/api/interfaces/_types_.apiinterface_decorated.md
+++ b/docs/api/interfaces/_types_.apiinterface_decorated.md
@@ -15,7 +15,7 @@
**● derive**: *[Derive](_types_.derive.md)<`CodecResult`, `SubscriptionResult`>*
-*Defined in [types.ts:137](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L137)*
+*Defined in [types.ts:142](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L142)*
___
@@ -24,7 +24,7 @@ ___
**● genesisHash**: *`Hash`*
-*Defined in [types.ts:133](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L133)*
+*Defined in [types.ts:138](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L138)*
___
@@ -33,7 +33,7 @@ ___
**● hasSubscriptions**: *`boolean`*
-*Defined in [types.ts:134](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L134)*
+*Defined in [types.ts:139](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L139)*
___
@@ -42,7 +42,7 @@ ___
**● query**: *[QueryableStorage](_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`>*
-*Defined in [types.ts:138](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L138)*
+*Defined in [types.ts:143](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L143)*
___
@@ -51,7 +51,7 @@ ___
**● rpc**: *[DecoratedRpc](_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`>*
-*Defined in [types.ts:139](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L139)*
+*Defined in [types.ts:144](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L144)*
___
@@ -60,7 +60,7 @@ ___
**● runtimeMetadata**: *`Metadata`*
-*Defined in [types.ts:135](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L135)*
+*Defined in [types.ts:140](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L140)*
___
@@ -69,7 +69,7 @@ ___
**● runtimeVersion**: *`RuntimeVersion`*
-*Defined in [types.ts:136](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L136)*
+*Defined in [types.ts:141](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L141)*
___
@@ -78,7 +78,7 @@ ___
**● signer**: *[Signer](_types_.signer.md)*
-*Defined in [types.ts:141](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L141)*
+*Defined in [types.ts:146](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L146)*
___
@@ -87,7 +87,7 @@ ___
**● tx**: *[SubmittableExtrinsics](_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`>*
-*Defined in [types.ts:140](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L140)*
+*Defined in [types.ts:145](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L145)*
___
diff --git a/docs/api/interfaces/_types_.apioptions.md b/docs/api/interfaces/_types_.apioptions.md
index eff1fbc1a8..9ea2c110eb 100644
--- a/docs/api/interfaces/_types_.apioptions.md
+++ b/docs/api/interfaces/_types_.apioptions.md
@@ -6,13 +6,24 @@
# Properties
+
+
+## `` derives
+
+**● derives**: *`DeriveCustom`*
+
+*Defined in [types.ts:116](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L116)*
+
+*__description__*: Add custom derives to be injected
+
+___
## `` provider
**● provider**: *`ProviderInterface`*
-*Defined in [types.ts:116](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L116)*
+*Defined in [types.ts:121](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L121)*
*__description__*: Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. `ws://127.0.0.1:9944`
@@ -23,7 +34,7 @@ ___
**● signer**: *[Signer](_types_.signer.md)*
-*Defined in [types.ts:120](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L120)*
+*Defined in [types.ts:125](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L125)*
*__description__*: An external signer which will be used to sign extrinsic when account passed in is not KeyringPair
@@ -34,7 +45,7 @@ ___
**● source**: *[ApiBase](../classes/_base_.apibase.md)<`any`, `any`>*
-*Defined in [types.ts:124](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L124)*
+*Defined in [types.ts:129](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L129)*
*__description__*: The source object to use for runtime information (only used when cloning)
@@ -45,7 +56,7 @@ ___
**● types**: *`RegistryTypes`*
-*Defined in [types.ts:129](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L129)*
+*Defined in [types.ts:134](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L134)*
*__description__*: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime.
diff --git a/docs/api/interfaces/_types_.decoratedrpc.md b/docs/api/interfaces/_types_.decoratedrpc.md
index c09bc45765..e7cb3e34ca 100644
--- a/docs/api/interfaces/_types_.decoratedrpc.md
+++ b/docs/api/interfaces/_types_.decoratedrpc.md
@@ -15,7 +15,7 @@
**● author**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
-*Defined in [types.ts:33](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L33)*
+*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L34)*
___
@@ -24,7 +24,7 @@ ___
**● chain**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
-*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L34)*
+*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L35)*
___
@@ -33,7 +33,7 @@ ___
**● state**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
-*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L35)*
+*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L36)*
___
@@ -42,7 +42,7 @@ ___
**● system**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
-*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L36)*
+*Defined in [types.ts:37](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L37)*
___
diff --git a/docs/api/interfaces/_types_.decoratedrpc_method.md b/docs/api/interfaces/_types_.decoratedrpc_method.md
index 81da051099..9af6b627ab 100644
--- a/docs/api/interfaces/_types_.decoratedrpc_method.md
+++ b/docs/api/interfaces/_types_.decoratedrpc_method.md
@@ -14,7 +14,7 @@
▸ **__call**(arg1?: *`CodecArg`*, arg2?: *`CodecArg`*, arg3?: *`CodecArg`*): `CodecResult`
-*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L22)*
+*Defined in [types.ts:23](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L23)*
**Parameters:**
@@ -24,7 +24,7 @@
**Returns:** `SubscriptionResult`
-*Defined in [types.ts:23](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L23)*
+*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L24)*
**Parameters:**
@@ -35,7 +35,7 @@
**Returns:** `SubscriptionResult`
-*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L24)*
+*Defined in [types.ts:25](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L25)*
**Parameters:**
diff --git a/docs/api/interfaces/_types_.derivemethodbase.md b/docs/api/interfaces/_types_.derivemethodbase.md
index 00f00b0a62..0c70914283 100644
--- a/docs/api/interfaces/_types_.derivemethodbase.md
+++ b/docs/api/interfaces/_types_.derivemethodbase.md
@@ -10,7 +10,7 @@
# Callable
▸ **__call**(...params: *`Array`<`CodecArg`>*): `CodecResult`
-*Defined in [types.ts:87](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L87)*
+*Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L88)*
**Parameters:**
diff --git a/docs/api/interfaces/_types_.queryablestoragefunctionbase.md b/docs/api/interfaces/_types_.queryablestoragefunctionbase.md
index a14aa56c64..776ea9f1a7 100644
--- a/docs/api/interfaces/_types_.queryablestoragefunctionbase.md
+++ b/docs/api/interfaces/_types_.queryablestoragefunctionbase.md
@@ -14,7 +14,7 @@
▸ **__call**(arg?: *`any`*): `Uint8Array`
-*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L49)*
+*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L50)*
**Parameters:**
@@ -24,7 +24,7 @@
**Returns:** `CodecResult`
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/StorageKey.ts#L12)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/StorageKey.ts#L12)*
**Parameters:**
@@ -42,7 +42,7 @@
**● at**: *`function`*
-*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L51)*
+*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L52)*
#### Type declaration
▸(hash: *`Hash` \| `Uint8Array` \| `string`*, arg?: *`CodecArg`*): `CodecResult`
@@ -63,7 +63,7 @@ ___
**● hash**: *`function`*
-*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L52)*
+*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L53)*
#### Type declaration
▸(arg?: *`CodecArg`*): [HashResult](../modules/_types_.md#hashresult)<`CodecResult`, `SubscriptionResult`>
@@ -83,7 +83,7 @@ ___
**● key**: *`function`*
-*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L53)*
+*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L54)*
#### Type declaration
▸(arg?: *`CodecArg`*): `string`
@@ -105,7 +105,7 @@ ___
*Inherited from StorageFunction.meta*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/StorageKey.ts#L14)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/StorageKey.ts#L14)*
___
@@ -116,7 +116,7 @@ ___
*Inherited from StorageFunction.method*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/StorageKey.ts#L15)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/StorageKey.ts#L15)*
___
@@ -127,7 +127,7 @@ ___
*Inherited from StorageFunction.section*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/StorageKey.ts#L16)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/StorageKey.ts#L16)*
___
@@ -136,7 +136,7 @@ ___
**● size**: *`function`*
-*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L54)*
+*Defined in [types.ts:55](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L55)*
#### Type declaration
▸(arg?: *`CodecArg`*): [U64Result](../modules/_types_.md#u64result)<`CodecResult`, `SubscriptionResult`>
@@ -158,7 +158,7 @@ ___
*Inherited from StorageFunction.toJSON*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/StorageKey.ts#L17)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/StorageKey.ts#L17)*
#### Type declaration
▸(): `any`
diff --git a/docs/api/interfaces/_types_.signer.md b/docs/api/interfaces/_types_.signer.md
index 853ea23d10..0651df4854 100644
--- a/docs/api/interfaces/_types_.signer.md
+++ b/docs/api/interfaces/_types_.signer.md
@@ -12,7 +12,7 @@
**● update**: *`undefined` \| `function`*
-*Defined in [types.ts:166](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L166)*
+*Defined in [types.ts:171](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L171)*
*__description__*: Receives an update for the extrinsic signed by a `signer.sign`
@@ -26,7 +26,7 @@ ___
▸ **sign**(extrinsic: *`Extrinsic`*, address: *`string`*, options: *`SignatureOptions`*): `Promise`<`number`>
-*Defined in [types.ts:161](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L161)*
+*Defined in [types.ts:166](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L166)*
*__description__*: Signs an extrinsic, returning an id (>0) that can be used to retrieve updates
diff --git a/docs/api/interfaces/_types_.submittableextrinsicfunction.md b/docs/api/interfaces/_types_.submittableextrinsicfunction.md
index bf8f37b2b7..7d5013a344 100644
--- a/docs/api/interfaces/_types_.submittableextrinsicfunction.md
+++ b/docs/api/interfaces/_types_.submittableextrinsicfunction.md
@@ -14,7 +14,7 @@
▸ **__call**(...args: *`any`[]*): `Method`
-*Defined in [types.ts:75](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L75)*
+*Defined in [types.ts:76](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L76)*
**Parameters:**
@@ -24,7 +24,7 @@
**Returns:** [SubmittableExtrinsic](../classes/_submittableextrinsic_.submittableextrinsic.md)<`CodecResult`, `SubscriptionResult`>
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Method.ts#L28)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Method.ts#L28)*
**Parameters:**
@@ -44,7 +44,7 @@
*Inherited from MethodFunction.callIndex*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Method.ts#L30)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Method.ts#L30)*
___
@@ -55,7 +55,7 @@ ___
*Inherited from MethodFunction.meta*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Method.ts#L31)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Method.ts#L31)*
___
@@ -66,7 +66,7 @@ ___
*Inherited from MethodFunction.method*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Method.ts#L32)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Method.ts#L32)*
___
@@ -77,7 +77,7 @@ ___
*Inherited from MethodFunction.section*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Method.ts#L33)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Method.ts#L33)*
___
@@ -88,7 +88,7 @@ ___
*Inherited from MethodFunction.toJSON*
-*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/29c83a0/packages/types/src/Method.ts#L34)*
+*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/b846152/packages/types/src/Method.ts#L34)*
#### Type declaration
▸(): `any`
diff --git a/docs/api/modules/_checktypes_manual_.md b/docs/api/modules/_checktypes_manual_.md
index 983e6ee20c..8f3e22472d 100644
--- a/docs/api/modules/_checktypes_manual_.md
+++ b/docs/api/modules/_checktypes_manual_.md
@@ -8,7 +8,7 @@
▸ **test**(): `Promise`<`void`>
-*Defined in [checkTypes.manual.ts:11](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/checkTypes.manual.ts#L11)*
+*Defined in [checkTypes.manual.ts:11](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/checkTypes.manual.ts#L11)*
**Returns:** `Promise`<`void`>
diff --git a/docs/api/modules/_promise_combinator_.md b/docs/api/modules/_promise_combinator_.md
index 3f2da9ded8..98601e22bf 100644
--- a/docs/api/modules/_promise_combinator_.md
+++ b/docs/api/modules/_promise_combinator_.md
@@ -21,7 +21,7 @@
**Ƭ CombinatorCallback**: *`function`*
-*Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/Combinator.ts#L9)*
+*Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/Combinator.ts#L9)*
#### Type declaration
▸(value: *`Array`<`any`>*): `any`
@@ -41,7 +41,7 @@ ___
**Ƭ CombinatorFunction**: *`function`*
-*Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/Combinator.ts#L10)*
+*Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/Combinator.ts#L10)*
#### Type declaration
▸(cb: *`function`*): [SubscriptionResult]()
diff --git a/docs/api/modules/_promise_types_.md b/docs/api/modules/_promise_types_.md
index e5edb8e36c..cfc7a64dfc 100644
--- a/docs/api/modules/_promise_types_.md
+++ b/docs/api/modules/_promise_types_.md
@@ -24,7 +24,7 @@
**Ƭ CodecResult**: *`Promise`<`Codec`>*
-*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/types.ts#L13)*
+*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/types.ts#L13)*
___
@@ -33,7 +33,7 @@ ___
**Ƭ QueryableStorageFunction**: *[QueryableStorageFunctionBase](../interfaces/_types_.queryablestoragefunctionbase.md)<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>*
-*Defined in [promise/types.ts:19](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/types.ts#L19)*
+*Defined in [promise/types.ts:19](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/types.ts#L19)*
___
@@ -42,7 +42,7 @@ ___
**Ƭ SubmittableExtrinsic**: *`SubmittableExtrinsicBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>*
-*Defined in [promise/types.ts:20](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/types.ts#L20)*
+*Defined in [promise/types.ts:20](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/types.ts#L20)*
___
@@ -51,7 +51,7 @@ ___
**Ƭ SubmittableExtrinsicFunction**: *`SubmittableExtrinsicFunctionBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>*
-*Defined in [promise/types.ts:21](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/types.ts#L21)*
+*Defined in [promise/types.ts:21](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/types.ts#L21)*
___
@@ -60,7 +60,7 @@ ___
**Ƭ SubscriptionResult**: *`Promise`<`function`>*
-*Defined in [promise/types.ts:11](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/promise/types.ts#L11)*
+*Defined in [promise/types.ts:11](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/promise/types.ts#L11)*
___
diff --git a/docs/api/modules/_rx_types_.md b/docs/api/modules/_rx_types_.md
index a81d2d3bc9..20370b1cc6 100644
--- a/docs/api/modules/_rx_types_.md
+++ b/docs/api/modules/_rx_types_.md
@@ -20,7 +20,7 @@
**Ƭ RxResult**: *`Observable`<`Codec`>*
-*Defined in [rx/types.ts:10](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/rx/types.ts#L10)*
+*Defined in [rx/types.ts:10](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/rx/types.ts#L10)*
___
diff --git a/docs/api/modules/_types_.md b/docs/api/modules/_types_.md
index 1fc83ebb38..b5fbe1ccd5 100644
--- a/docs/api/modules/_types_.md
+++ b/docs/api/modules/_types_.md
@@ -43,7 +43,7 @@
**Ƭ ApiInterface$Events**: *`RpcRxInterface$Events` \| "ready"*
-*Defined in [types.ts:146](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L146)*
+*Defined in [types.ts:151](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L151)*
___
@@ -52,7 +52,7 @@ ___
**Ƭ ApiInterface$Rx**: *[ApiInterface$Decorated](../interfaces/_types_.apiinterface_decorated.md)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>*
-*Defined in [types.ts:144](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L144)*
+*Defined in [types.ts:149](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L149)*
___
@@ -61,7 +61,7 @@ ___
**Ƭ ApiType**: *"promise" \| "rxjs"*
-*Defined in [types.ts:148](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L148)*
+*Defined in [types.ts:153](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L153)*
___
@@ -70,7 +70,7 @@ ___
**Ƭ DeriveMethod**: *`DeriveMethod<CodecResult, SubscriptionResult>`*
-*Defined in [types.ts:98](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L98)*
+*Defined in [types.ts:99](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L99)*
___
@@ -79,7 +79,7 @@ ___
**Ƭ HashResult**: *`HashResult<CodecResult, SubscriptionResult>`*
-*Defined in [types.ts:39](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L39)*
+*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L40)*
___
@@ -88,7 +88,7 @@ ___
**Ƭ OnCallDefinition**: *`function`*
-*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L17)*
+*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L18)*
#### Type declaration
▸(method: *[OnCallFunction](_types_.md#oncallfunction)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>*, params?: *`Array`<`CodecArg`>*, callback?: *`CodecCallback`*, needsCallback?: *`undefined` \| `false` \| `true`*): `CodecResult` \| `SubscriptionResult`
@@ -111,7 +111,7 @@ ___
**Ƭ OnCallFunction**: *`function`*
-*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L19)*
+*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L20)*
#### Type declaration
▸(...params: *`Array`<`CodecArg`>*): `CodecResult` \| `SubscriptionResult`
@@ -131,7 +131,7 @@ ___
**Ƭ QueryableStorageFunction**: *`QueryableStorageFunction<CodecResult, SubscriptionResult>`*
-*Defined in [types.ts:62](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L62)*
+*Defined in [types.ts:63](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L63)*
___
@@ -140,7 +140,7 @@ ___
**Ƭ U64Result**: *`U64Result<CodecResult, SubscriptionResult>`*
-*Defined in [types.ts:44](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/types.ts#L44)*
+*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/types.ts#L45)*
___
diff --git a/docs/api/modules/_util_filterevents_.md b/docs/api/modules/_util_filterevents_.md
index 39118563f0..0e4aec59cf 100644
--- a/docs/api/modules/_util_filterevents_.md
+++ b/docs/api/modules/_util_filterevents_.md
@@ -8,7 +8,7 @@
▸ **filterEvents**(extHash: *`Hash`*, __namedParameters: *`object`*, allEvents: *`Array`<`EventRecord`>*): `Array`<`EventRecord`> \| `undefined`
-*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/29c83a0/packages/api/src/util/filterEvents.ts#L9)*
+*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/b846152/packages/api/src/util/filterEvents.ts#L9)*
**Parameters:**
diff --git a/docs/examples/promise/01_simple_connect/index.html b/docs/examples/promise/01_simple_connect/index.html
index 7bc99b3a1b..a8ebea064e 100644
--- a/docs/examples/promise/01_simple_connect/index.html
+++ b/docs/examples/promise/01_simple_connect/index.html
@@ -2204,7 +2204,7 @@
diff --git a/docs/examples/promise/02_listen_to_blocks/index.html b/docs/examples/promise/02_listen_to_blocks/index.html
index 4e99ab58e5..4faea64117 100644
--- a/docs/examples/promise/02_listen_to_blocks/index.html
+++ b/docs/examples/promise/02_listen_to_blocks/index.html
@@ -2202,7 +2202,7 @@
diff --git a/docs/examples/promise/03_listen_to_balance_change/index.html b/docs/examples/promise/03_listen_to_balance_change/index.html
index 84e5a882cf..45b073945a 100644
--- a/docs/examples/promise/03_listen_to_balance_change/index.html
+++ b/docs/examples/promise/03_listen_to_balance_change/index.html
@@ -2214,7 +2214,7 @@
diff --git a/docs/examples/promise/04_unsubscribe/index.html b/docs/examples/promise/04_unsubscribe/index.html
index ff64d18ccd..a543cffdd7 100644
--- a/docs/examples/promise/04_unsubscribe/index.html
+++ b/docs/examples/promise/04_unsubscribe/index.html
@@ -2205,7 +2205,7 @@
diff --git a/docs/examples/promise/05_read_storage/index.html b/docs/examples/promise/05_read_storage/index.html
index 650675f318..9b67363daf 100644
--- a/docs/examples/promise/05_read_storage/index.html
+++ b/docs/examples/promise/05_read_storage/index.html
@@ -2219,7 +2219,7 @@
diff --git a/docs/examples/promise/06_make_transfer/index.html b/docs/examples/promise/06_make_transfer/index.html
index 7b0f44d3f0..ce2da81964 100644
--- a/docs/examples/promise/06_make_transfer/index.html
+++ b/docs/examples/promise/06_make_transfer/index.html
@@ -2212,7 +2212,7 @@
diff --git a/docs/examples/promise/08_system_events/index.html b/docs/examples/promise/08_system_events/index.html
index 7616d29613..8df0507306 100644
--- a/docs/examples/promise/08_system_events/index.html
+++ b/docs/examples/promise/08_system_events/index.html
@@ -2215,7 +2215,7 @@
diff --git a/docs/examples/promise/09_transfer_events/index.html b/docs/examples/promise/09_transfer_events/index.html
index d4f1f2dd4a..abad8d9554 100644
--- a/docs/examples/promise/09_transfer_events/index.html
+++ b/docs/examples/promise/09_transfer_events/index.html
@@ -2236,7 +2236,7 @@
diff --git a/docs/examples/promise/10_upgrade_chain/index.html b/docs/examples/promise/10_upgrade_chain/index.html
index 47b3510565..37fe60197f 100644
--- a/docs/examples/promise/10_upgrade_chain/index.html
+++ b/docs/examples/promise/10_upgrade_chain/index.html
@@ -2238,7 +2238,7 @@
diff --git a/docs/examples/promise/index.html b/docs/examples/promise/index.html
index 27b2e8964c..01c81bdaab 100644
--- a/docs/examples/promise/index.html
+++ b/docs/examples/promise/index.html
@@ -2193,7 +2193,7 @@
diff --git a/docs/examples/rx/01_simple_connect/index.html b/docs/examples/rx/01_simple_connect/index.html
index 58a2eb5f03..2c45b1d0b4 100644
--- a/docs/examples/rx/01_simple_connect/index.html
+++ b/docs/examples/rx/01_simple_connect/index.html
@@ -2207,7 +2207,7 @@
diff --git a/docs/examples/rx/02_listen_to_blocks/index.html b/docs/examples/rx/02_listen_to_blocks/index.html
index 8da0179238..c627826a20 100644
--- a/docs/examples/rx/02_listen_to_blocks/index.html
+++ b/docs/examples/rx/02_listen_to_blocks/index.html
@@ -2202,7 +2202,7 @@
diff --git a/docs/examples/rx/03_listen_to_balance_change/index.html b/docs/examples/rx/03_listen_to_balance_change/index.html
index 94873206f1..c716458018 100644
--- a/docs/examples/rx/03_listen_to_balance_change/index.html
+++ b/docs/examples/rx/03_listen_to_balance_change/index.html
@@ -2219,7 +2219,7 @@
diff --git a/docs/examples/rx/04_unsubscribe/index.html b/docs/examples/rx/04_unsubscribe/index.html
index 364c7b29ae..aab89075c6 100644
--- a/docs/examples/rx/04_unsubscribe/index.html
+++ b/docs/examples/rx/04_unsubscribe/index.html
@@ -2207,7 +2207,7 @@
diff --git a/docs/examples/rx/05_read_storage/index.html b/docs/examples/rx/05_read_storage/index.html
index a9b3600822..4b22d1444a 100644
--- a/docs/examples/rx/05_read_storage/index.html
+++ b/docs/examples/rx/05_read_storage/index.html
@@ -2232,7 +2232,7 @@
diff --git a/docs/examples/rx/06_make_transfer/index.html b/docs/examples/rx/06_make_transfer/index.html
index 565cddb3a8..1abe502f83 100644
--- a/docs/examples/rx/06_make_transfer/index.html
+++ b/docs/examples/rx/06_make_transfer/index.html
@@ -2216,7 +2216,7 @@
diff --git a/docs/examples/rx/08_system_events/index.html b/docs/examples/rx/08_system_events/index.html
index 5c9bbf55ef..3fcba7add2 100644
--- a/docs/examples/rx/08_system_events/index.html
+++ b/docs/examples/rx/08_system_events/index.html
@@ -2218,7 +2218,7 @@
diff --git a/docs/examples/rx/09_transfer_events/index.html b/docs/examples/rx/09_transfer_events/index.html
index b949041d52..d2e2b1fca6 100644
--- a/docs/examples/rx/09_transfer_events/index.html
+++ b/docs/examples/rx/09_transfer_events/index.html
@@ -2235,7 +2235,7 @@
diff --git a/docs/examples/rx/10_upgrade_chain/index.html b/docs/examples/rx/10_upgrade_chain/index.html
index 88f398f907..2015437e6c 100644
--- a/docs/examples/rx/10_upgrade_chain/index.html
+++ b/docs/examples/rx/10_upgrade_chain/index.html
@@ -2240,7 +2240,7 @@
diff --git a/docs/examples/rx/index.html b/docs/examples/rx/index.html
index 50b45e775d..cbc2004406 100644
--- a/docs/examples/rx/index.html
+++ b/docs/examples/rx/index.html
@@ -2193,7 +2193,7 @@
diff --git a/docs/index.html b/docs/index.html
index edaeaaa609..b22fc764f5 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -2186,7 +2186,7 @@
diff --git a/docs/rpc-core/classes/_index_.rpc.md b/docs/rpc-core/classes/_index_.rpc.md
index 4e68070a89..f6bb8b980e 100644
--- a/docs/rpc-core/classes/_index_.rpc.md
+++ b/docs/rpc-core/classes/_index_.rpc.md
@@ -38,7 +38,7 @@ const api = new Api(provider);
⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md)
-*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/index.ts#L45)*
+*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/index.ts#L45)*
*__constructor__*: Default constructor for the Api Object
@@ -60,7 +60,7 @@ ___
**● _provider**: *`ProviderInterface`*
-*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/index.ts#L41)*
+*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/index.ts#L41)*
___
@@ -71,7 +71,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)*
-*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/index.ts#L42)*
+*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/index.ts#L42)*
___
@@ -82,7 +82,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)*
-*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/index.ts#L43)*
+*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/index.ts#L43)*
___
@@ -93,7 +93,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)*
-*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/index.ts#L44)*
+*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/index.ts#L44)*
___
@@ -104,7 +104,7 @@ ___
*Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)*
-*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/index.ts#L45)*
+*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/index.ts#L45)*
___
@@ -116,7 +116,7 @@ ___
▸ **disconnect**(): `void`
-*Defined in [index.ts:89](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/index.ts#L89)*
+*Defined in [index.ts:89](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/index.ts#L89)*
*__description__*: Manually disconnect from the attached provider
@@ -129,7 +129,7 @@ ___
▸ **signature**(__namedParameters: *`object`*): `string`
-*Defined in [index.ts:78](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/index.ts#L78)*
+*Defined in [index.ts:78](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/index.ts#L78)*
*__name__*: signature
diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface.md b/docs/rpc-core/interfaces/_types_.rpcinterface.md
index 3c745949d4..59b0487a37 100644
--- a/docs/rpc-core/interfaces/_types_.rpcinterface.md
+++ b/docs/rpc-core/interfaces/_types_.rpcinterface.md
@@ -16,7 +16,7 @@
**● author**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
-*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/types.ts#L17)*
+*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/types.ts#L17)*
___
@@ -25,7 +25,7 @@ ___
**● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
-*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/types.ts#L18)*
+*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/types.ts#L18)*
___
@@ -34,7 +34,7 @@ ___
**● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
-*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/types.ts#L19)*
+*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/types.ts#L19)*
___
@@ -43,7 +43,7 @@ ___
**● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)*
-*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/types.ts#L20)*
+*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/types.ts#L20)*
___
diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface_method.md b/docs/rpc-core/interfaces/_types_.rpcinterface_method.md
index 20764d70f6..7ac74674a7 100644
--- a/docs/rpc-core/interfaces/_types_.rpcinterface_method.md
+++ b/docs/rpc-core/interfaces/_types_.rpcinterface_method.md
@@ -7,7 +7,7 @@
# Callable
▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`>
-*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/types.ts#L5)*
+*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/types.ts#L5)*
**Parameters:**
@@ -25,7 +25,7 @@
**● subscription**: *`string`*
-*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/types.ts#L8)*
+*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/types.ts#L8)*
___
@@ -34,7 +34,7 @@ ___
**● unsubscribe**: *`function`*
-*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/types.ts#L9)*
+*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/types.ts#L9)*
#### Type declaration
▸(id: *`number`*): `Promise`<`any`>
diff --git a/docs/rpc-core/modules/_types_.md b/docs/rpc-core/modules/_types_.md
index 1171b18923..01fb8659b0 100644
--- a/docs/rpc-core/modules/_types_.md
+++ b/docs/rpc-core/modules/_types_.md
@@ -21,7 +21,7 @@
**Ƭ RpcInterface$Section**: *`object`*
-*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-core/src/types.ts#L12)*
+*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-core/src/types.ts#L12)*
#### Type declaration
diff --git a/docs/rpc-provider/classes/_coder_index_.rpccoder.md b/docs/rpc-provider/classes/_coder_index_.rpccoder.md
index aeb51fa3f0..c00e0a70eb 100644
--- a/docs/rpc-provider/classes/_coder_index_.rpccoder.md
+++ b/docs/rpc-provider/classes/_coder_index_.rpccoder.md
@@ -12,7 +12,7 @@
▸ **decodeResponse**(response: *[JsonRpcResponse](../modules/_types_.md#jsonrpcresponse)*): `any`
-*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/coder/index.ts#L12)*
+*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/coder/index.ts#L12)*
**Parameters:**
@@ -29,7 +29,7 @@ ___
▸ **encodeJson**(method: *`string`*, params: *`any` \| `Array`<`any`>*): `string`
-*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/coder/index.ts#L33)*
+*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/coder/index.ts#L33)*
**Parameters:**
@@ -47,7 +47,7 @@ ___
▸ **encodeObject**(method: *`string`*, params: *`any` \| `Array`<`any`>*): [JsonRpcRequest](../modules/_types_.md#jsonrpcrequest)
-*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/coder/index.ts#L39)*
+*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/coder/index.ts#L39)*
**Parameters:**
@@ -65,7 +65,7 @@ ___
▸ **getId**(): `number`
-*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/coder/index.ts#L48)*
+*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/coder/index.ts#L48)*
**Returns:** `number`
diff --git a/docs/rpc-provider/classes/_http_index_.httpprovider.html b/docs/rpc-provider/classes/_http_index_.httpprovider.html
index 54397d12f9..adc7d5e940 100644
--- a/docs/rpc-provider/classes/_http_index_.httpprovider.html
+++ b/docs/rpc-provider/classes/_http_index_.httpprovider.html
@@ -2156,7 +2156,7 @@
constructor
⊕ new HttpProvider(endpoint?: string): HttpProvider
-Defined in http/index.ts:40
+Defined in http/index.ts:40
Parameters:
@@ -2182,7 +2182,7 @@
hasSubscriptions
gethasSubscriptions(): boolean
-Defined in http/index.ts:55
+Defined in http/index.ts:55
summary: true when this provider supports subscriptions
Returns: boolean
@@ -2191,7 +2191,7 @@
clone
▸ clone(): HttpProvider
Implementation of ProviderInterface.clone
-Defined in http/index.ts:62
+Defined in http/index.ts:62
description: Returns a clone of the object
Returns: HttpProvider
@@ -2199,7 +2199,7 @@
disconnect
▸ disconnect(): void
Implementation of ProviderInterface.disconnect
-Defined in http/index.ts:69
+Defined in http/index.ts:69
description: Manually disconnect from the connection
Returns: void
@@ -2207,7 +2207,7 @@
isConnected
▸ isConnected(): boolean
Implementation of ProviderInterface.isConnected
-Defined in http/index.ts:77
+Defined in http/index.ts:77
summary: Whether the node is connected or not.
Returns: boolean
true if connected
@@ -2216,7 +2216,7 @@ true if connected
on
▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void
Implementation of ProviderInterface.on
-Defined in http/index.ts:85
+Defined in http/index.ts:85
summary: Events are not supported with the HttpProvider, see WsProvider.
description: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.
Parameters:
@@ -2244,7 +2244,7 @@ true if connected
send
▸ send(method: string, params: Array<any>): Promise<any>
Implementation of ProviderInterface.send
-Defined in http/index.ts:92
+Defined in http/index.ts:92
summary: Send HTTP POST Request with Body to configured HTTP Endpoint.
Parameters:
@@ -2271,7 +2271,7 @@ true if connected
subscribe
▸ subscribe(types: string, method: string, params: Array<any>, cb: ProviderInterface$Callback): Promise<number>
Implementation of ProviderInterface.subscribe
-Defined in http/index.ts:114
+Defined in http/index.ts:114
summary: Subscriptions are not supported with the HttpProvider, see WsProvider.
Parameters:
@@ -2306,7 +2306,7 @@ true if connected
unsubscribe
▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>
Implementation of ProviderInterface.unsubscribe
-Defined in http/index.ts:123
+Defined in http/index.ts:123
summary: Subscriptions are not supported with the HttpProvider, see WsProvider.
Parameters:
@@ -2376,7 +2376,7 @@ true if connected
diff --git a/docs/rpc-provider/classes/_http_index_.httpprovider.md b/docs/rpc-provider/classes/_http_index_.httpprovider.md
index 8d2c2741bd..7a84b01e2d 100644
--- a/docs/rpc-provider/classes/_http_index_.httpprovider.md
+++ b/docs/rpc-provider/classes/_http_index_.httpprovider.md
@@ -35,7 +35,7 @@ const api = new Api(provider);
⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
-*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/http/index.ts#L40)*
+*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/http/index.ts#L40)*
**Parameters:**
@@ -55,7 +55,7 @@ ___
gethasSubscriptions(): `boolean`
-*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/http/index.ts#L55)*
+*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/http/index.ts#L55)*
*__summary__*: `true` when this provider supports subscriptions
@@ -73,7 +73,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[clone](../interfaces/_types_.providerinterface.md#clone)*
-*Defined in [http/index.ts:62](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/http/index.ts#L62)*
+*Defined in [http/index.ts:62](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/http/index.ts#L62)*
*__description__*: Returns a clone of the object
@@ -88,7 +88,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[disconnect](../interfaces/_types_.providerinterface.md#disconnect)*
-*Defined in [http/index.ts:69](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/http/index.ts#L69)*
+*Defined in [http/index.ts:69](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/http/index.ts#L69)*
*__description__*: Manually disconnect from the connection
@@ -103,7 +103,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
-*Defined in [http/index.ts:77](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/http/index.ts#L77)*
+*Defined in [http/index.ts:77](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/http/index.ts#L77)*
*__summary__*: Whether the node is connected or not.
@@ -119,7 +119,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
-*Defined in [http/index.ts:85](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/http/index.ts#L85)*
+*Defined in [http/index.ts:85](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/http/index.ts#L85)*
*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -143,7 +143,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
-*Defined in [http/index.ts:92](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/http/index.ts#L92)*
+*Defined in [http/index.ts:92](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/http/index.ts#L92)*
*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
@@ -165,7 +165,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)*
-*Defined in [http/index.ts:114](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/http/index.ts#L114)*
+*Defined in [http/index.ts:114](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/http/index.ts#L114)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -189,7 +189,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
-*Defined in [http/index.ts:123](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/http/index.ts#L123)*
+*Defined in [http/index.ts:123](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/http/index.ts#L123)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
diff --git a/docs/rpc-provider/classes/_mock_index_.mock.md b/docs/rpc-provider/classes/_mock_index_.mock.md
index 07ebe6bc97..2b3e25a7ef 100644
--- a/docs/rpc-provider/classes/_mock_index_.mock.md
+++ b/docs/rpc-provider/classes/_mock_index_.mock.md
@@ -20,7 +20,7 @@ A mock provider mainly used for testing.
⊕ **new Mock**(): [Mock](_mock_index_.mock.md)
-*Defined in [mock/index.ts:68](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/mock/index.ts#L68)*
+*Defined in [mock/index.ts:68](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/mock/index.ts#L68)*
**Returns:** [Mock](_mock_index_.mock.md)
@@ -34,7 +34,7 @@ ___
**● isUpdating**: *`boolean`* = true
-*Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/mock/index.ts#L43)*
+*Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/mock/index.ts#L43)*
___
@@ -50,7 +50,7 @@ ___
return subs;
}, ({} as MockState$Subscriptions))
-*Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/mock/index.ts#L57)*
+*Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/mock/index.ts#L57)*
___
@@ -62,7 +62,7 @@ ___
gethasSubscriptions(): `boolean`
-*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/mock/index.ts#L74)*
+*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/mock/index.ts#L74)*
**Returns:** `boolean`
@@ -78,7 +78,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[clone](../interfaces/_types_.providerinterface.md#clone)*
-*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/mock/index.ts#L78)*
+*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/mock/index.ts#L78)*
**Returns:** [Mock](_mock_index_.mock.md)
@@ -91,7 +91,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[disconnect](../interfaces/_types_.providerinterface.md#disconnect)*
-*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/mock/index.ts#L82)*
+*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/mock/index.ts#L82)*
**Returns:** `void`
@@ -104,7 +104,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
-*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/mock/index.ts#L86)*
+*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/mock/index.ts#L86)*
**Returns:** `boolean`
@@ -117,7 +117,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
-*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/mock/index.ts#L90)*
+*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/mock/index.ts#L90)*
**Parameters:**
@@ -137,7 +137,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
-*Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/mock/index.ts#L94)*
+*Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/mock/index.ts#L94)*
**Parameters:**
@@ -155,7 +155,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`>
-*Defined in [mock/index.ts:102](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/mock/index.ts#L102)*
+*Defined in [mock/index.ts:102](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/mock/index.ts#L102)*
**Parameters:**
@@ -176,7 +176,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
-*Defined in [mock/index.ts:122](https://github.com/polkadot-js/api/blob/29c83a0/packages/rpc-provider/src/mock/index.ts#L122)*
+*Defined in [mock/index.ts:122](https://github.com/polkadot-js/api/blob/b846152/packages/rpc-provider/src/mock/index.ts#L122)*
**Parameters:**
diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.html b/docs/rpc-provider/classes/_ws_index_.wsprovider.html
index 5a478a9424..838f78dddf 100644
--- a/docs/rpc-provider/classes/_ws_index_.wsprovider.html
+++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.html
@@ -2156,7 +2156,7 @@
constructor
⊕ new WsProvider(endpoint?: string, autoConnect?: boolean): WsProvider
-Defined in ws/index.ts:75
+Defined in ws/index.ts:75
Parameters:
@@ -2188,7 +2188,7 @@
hasSubscriptions
gethasSubscriptions(): boolean
-Defined in ws/index.ts:101
+Defined in ws/index.ts:101
summary: true when this provider supports subscriptions
Returns: boolean
@@ -2196,14 +2196,14 @@
clone
▸ clone(): WsProvider
-Defined in ws/index.ts:108
+Defined in ws/index.ts:108
description: Returns a clone of the object
Returns: WsProvider
connect
▸ connect(): void
-Defined in ws/index.ts:117
+Defined in ws/index.ts:117
summary: Manually connect
description: The WsProvider connects automatically by default, however if you decided otherwise, you may connect manually using this method.
Returns: void
@@ -2211,14 +2211,14 @@
disconnect
▸ disconnect(): void
-Defined in ws/index.ts:133
+Defined in ws/index.ts:133
description: Manually disconnect from the connection, clearing autoconnect logic
Returns: void
isConnected
▸ isConnected(): boolean
-Defined in ws/index.ts:150
+Defined in ws/index.ts:150
summary: Whether the node is connected or not.
Returns: boolean
true if connected
@@ -2226,7 +2226,7 @@ true if connected
on
▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void
-Defined in ws/index.ts:159
+Defined in ws/index.ts:159
summary: Listens on events after having subscribed using the subscribe function.
Parameters:
@@ -2255,7 +2255,7 @@ true if connected
send
▸ send(method: string, params: Array<any>, subscription?: SubscriptionHandler): Promise<any>
-Defined in ws/index.ts:169
+Defined in ws/index.ts:169
summary: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
Parameters:
@@ -2289,7 +2289,7 @@ true if connected
subscribe
▸ subscribe(type: string, method: string, params: Array<any>, callback: ProviderInterface$Callback): Promise<number>
-Defined in ws/index.ts:223
+Defined in ws/index.ts:223
name: subscribe
summary: Allows subscribing to a specific event.
example:
@@ -2340,7 +2340,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
unsubscribe
▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>
-Defined in ws/index.ts:232
+Defined in ws/index.ts:232
summary: Allows unsubscribing to subscriptions made with subscribe.
Parameters: