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

[CI Skip] 0.45.17

Browse Source
This commit is contained in:
Travis CI
2019-02-27 15:39:51 +00:00
parent 255b495f1a
commit 177e5ec519
1441 changed files with 4529 additions and 4872 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/404.html
+2 -2
View File
File diff suppressed because one or more lines are too long
docs/CONTRIBUTING.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/METHODS_EVENTS.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/METHODS_EXTRINSICS.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/METHODS_RPC.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/METHODS_STORAGE.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/SUMMARY.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/SUMMARY.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md
+18 -18
View File
@@ -29,7 +29,7 @@
*Overrides ReferendumInfo.__constructor*
*Defined in [democracy/referendumInfo.ts:20](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/democracy/referendumInfo.ts#L20)*
*Defined in [democracy/referendumInfo.ts:20](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/democracy/referendumInfo.ts#L20)*
**Parameters:**
@@ -77,7 +77,7 @@ ___
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L160)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L160)*
*__description__*: Returns the Type description to sthe structure
@@ -92,7 +92,7 @@ ___
*Inherited from ReferendumInfo.delay*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:58](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/ReferendumInfo.ts#L58)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:58](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/ReferendumInfo.ts#L58)*
*__description__*: The delay (in blocks) to wait after a successful referendum before deploying
@@ -107,7 +107,7 @@ ___
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L167)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L167)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -122,7 +122,7 @@ ___
*Inherited from ReferendumInfo.end*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:37](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/ReferendumInfo.ts#L37)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:37](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/ReferendumInfo.ts#L37)*
*__description__*: When voting on this referendum will end
@@ -135,7 +135,7 @@ ___
**get index**(): `ReferendumIndex`
*Defined in [democracy/referendumInfo.ts:33](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/democracy/referendumInfo.ts#L33)*
*Defined in [democracy/referendumInfo.ts:33](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/democracy/referendumInfo.ts#L33)*
*__description__*: Convenience getter, returns the referendumIndex
@@ -150,7 +150,7 @@ ___
*Inherited from Struct.isEmpty*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/5f98849/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/255b495/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Checks if the value is an empty value
@@ -165,7 +165,7 @@ ___
*Inherited from ReferendumInfo.proposal*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:44](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/ReferendumInfo.ts#L44)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:44](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/ReferendumInfo.ts#L44)*
*__description__*: The proposal being voted on
@@ -180,7 +180,7 @@ ___
*Inherited from ReferendumInfo.threshold*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:51](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/ReferendumInfo.ts#L51)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:51](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/ReferendumInfo.ts#L51)*
*__description__*: The thresholding mechanism to determine whether it passed
@@ -260,7 +260,7 @@ ___
*Inherited from Struct.eq*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/5f98849/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/255b495/packages/types/src/codec/Struct.ts#L176)*
*__description__*: Compares the value of the input to see if there is a match
@@ -303,7 +303,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L184)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L184)*
*__description__*: Returns a specific names entry in the structure
@@ -324,7 +324,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L191)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L191)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -399,7 +399,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L198)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L198)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -414,7 +414,7 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L205)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L205)*
*__description__*: Returns a hex string representation of the value
@@ -429,7 +429,7 @@ ___
*Overrides Struct.toJSON*
*Defined in [democracy/referendumInfo.ts:40](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/democracy/referendumInfo.ts#L40)*
*Defined in [democracy/referendumInfo.ts:40](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/democracy/referendumInfo.ts#L40)*
*__description__*: Creates the JSON representation
@@ -444,7 +444,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L226)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L226)*
*__description__*: Returns the string representation of the value
@@ -459,7 +459,7 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L234)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L234)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -495,7 +495,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/5f98849/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/255b495/packages/types/src/codec/Struct.ts#L125)*
**Type parameters:**
docs/api-derive/index.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_accounts_idandindex_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_accounts_idandindex_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**Ƭ AccountIdAndIndex**: *[`undefined` \| `AccountId`, `undefined` \| `AccountIndex`]*
*Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/accounts/idAndIndex.ts#L16)*
*Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/accounts/idAndIndex.ts#L16)*
___
@@ -20,7 +20,7 @@ ___
▸ **idAndIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/accounts/idAndIndex.ts#L18)*
*Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/accounts/idAndIndex.ts#L18)*
**Parameters:**
docs/api-derive/modules/_accounts_idtoindex_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_accounts_idtoindex_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **idToIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/accounts/idToIndex.ts#L13)*
*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/accounts/idToIndex.ts#L13)*
**Parameters:**
docs/api-derive/modules/_accounts_indexes_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_accounts_indexes_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**Ƭ AccountIndexes**: *`object`*
*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/accounts/indexes.ts#L13)*
*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/accounts/indexes.ts#L13)*
#### Type declaration
@@ -24,7 +24,7 @@ ___
▸ **indexes**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/accounts/indexes.ts#L15)*
*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/accounts/indexes.ts#L15)*
**Parameters:**
docs/api-derive/modules/_accounts_indextoid_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_accounts_indextoid_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **indexToId**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/indexToId.ts:13](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/accounts/indexToId.ts#L13)*
*Defined in [accounts/indexToId.ts:13](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/accounts/indexToId.ts#L13)*
**Parameters:**
docs/api-derive/modules/_balances_fees_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_balances_fees_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **fees**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/balances/fees.ts#L13)*
*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/balances/fees.ts#L13)*
**Parameters:**
docs/api-derive/modules/_balances_validatingbalance_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_balances_validatingbalance_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **validatingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/balances/validatingBalance.ts#L16)*
*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/balances/validatingBalance.ts#L16)*
**Parameters:**
docs/api-derive/modules/_balances_validatingbalances_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_balances_validatingbalances_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **validatingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/balances/validatingBalances.ts#L14)*
*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/balances/validatingBalances.ts#L14)*
**Parameters:**
docs/api-derive/modules/_balances_votingbalance_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_balances_votingbalance_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **votingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/balances/votingBalance.ts#L16)*
*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/balances/votingBalance.ts#L16)*
**Parameters:**
docs/api-derive/modules/_balances_votingbalances_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_balances_votingbalances_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **votingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/balances/votingBalances.ts#L13)*
*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/balances/votingBalances.ts#L13)*
**Parameters:**
docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **votingBalancesNominatorsFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/votingBalancesNominatorsFor.ts:15](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L15)*
*Defined in [balances/votingBalancesNominatorsFor.ts:15](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L15)*
**Parameters:**
docs/api-derive/modules/_chain_bestnumber_.html
+4 -4
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_chain_bestnumber_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **bestNumber**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/chain/bestNumber.ts#L23)*
*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/chain/bestNumber.ts#L23)*
*__description__*: Get the latest block number.
docs/api-derive/modules/_chain_bestnumberfinalised_.html
+4 -4
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_chain_bestnumberfinalised_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **bestNumberFinalised**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)*
*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)*
*__description__*: Get the latest finalised block number. example
docs/api-derive/modules/_chain_bestnumberlag_.html
+4 -4
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_chain_bestnumberlag_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **bestNumberLag**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/chain/bestNumberLag.ts#L25)*
*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/chain/bestNumberLag.ts#L25)*
*__description__*: Calculates the lag between finalised head and best head
docs/api-derive/modules/_chain_getheader_.html
+4 -4
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_chain_getheader_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **getHeader**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/chain/getHeader.ts#L25)*
*Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/chain/getHeader.ts#L25)*
*__description__*: Get the a specific block header and extend it with the author
docs/api-derive/modules/_chain_subscribenewhead_.html
+4 -4
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_chain_subscribenewhead_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**Ƭ HeaderAndValidators**: *[`Header`, `Array`<`AccountId`>]*
*Defined in [chain/subscribeNewHead.ts:12](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/chain/subscribeNewHead.ts#L12)*
*Defined in [chain/subscribeNewHead.ts:12](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/chain/subscribeNewHead.ts#L12)*
___
@@ -20,7 +20,7 @@ ___
▸ **subscribeNewHead**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/subscribeNewHead.ts:25](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/chain/subscribeNewHead.ts#L25)*
*Defined in [chain/subscribeNewHead.ts:25](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/chain/subscribeNewHead.ts#L25)*
*__description__*: Subscribe to block headers and extend it with the author
docs/api-derive/modules/_democracy_referenduminfo_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_democracy_referenduminfo_.md
+1 -1
View File
@@ -20,7 +20,7 @@
▸ **referendumInfo**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/referendumInfo.ts:48](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/democracy/referendumInfo.ts#L48)*
*Defined in [democracy/referendumInfo.ts:48](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/democracy/referendumInfo.ts#L48)*
**Parameters:**
docs/api-derive/modules/_democracy_referenduminfos_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_democracy_referenduminfos_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **referendumInfos**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/democracy/referendumInfos.ts#L13)*
*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/democracy/referendumInfos.ts#L13)*
**Parameters:**
docs/api-derive/modules/_democracy_referendums_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_democracy_referendums_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **referendums**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/referendums.ts:14](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/democracy/referendums.ts#L14)*
*Defined in [democracy/referendums.ts:14](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/democracy/referendums.ts#L14)*
**Parameters:**
docs/api-derive/modules/_democracy_referendumvotesfor_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_democracy_referendumvotesfor_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **referendumVotesFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/referendumVotesFor.ts:16](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/democracy/referendumVotesFor.ts#L16)*
*Defined in [democracy/referendumVotesFor.ts:16](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/democracy/referendumVotesFor.ts#L16)*
**Parameters:**
docs/api-derive/modules/_democracy_votes_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_democracy_votes_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **votes**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/democracy/votes.ts#L12)*
*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/democracy/votes.ts#L12)*
**Parameters:**
docs/api-derive/modules/_session_eralength_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_session_eralength_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **eraLength**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/session/eraLength.ts#L13)*
*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/session/eraLength.ts#L13)*
**Parameters:**
docs/api-derive/modules/_session_eraprogress_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_session_eraprogress_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **eraProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/session/eraProgress.ts#L14)*
*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/session/eraProgress.ts#L14)*
**Parameters:**
docs/api-derive/modules/_session_sessionprogress_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_session_sessionprogress_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **sessionProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/session/sessionProgress.ts#L14)*
*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/session/sessionProgress.ts#L14)*
**Parameters:**
docs/api-derive/modules/_staking_intentionsbalances_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_staking_intentionsbalances_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **intentionsBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [staking/intentionsBalances.ts:17](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/staking/intentionsBalances.ts#L17)*
*Defined in [staking/intentionsBalances.ts:17](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/staking/intentionsBalances.ts#L17)*
Get the balances for all intentions and their nominators
docs/api-derive/modules/_types_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_types_.md
+4 -4
View File
@@ -8,7 +8,7 @@
**Ƭ DerivedBalances**: *`object`*
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/types.ts#L8)*
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/types.ts#L8)*
#### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ DerivedBalancesMap**: *`object`*
*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/types.ts#L26)*
*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/types.ts#L26)*
#### Type declaration
@@ -32,7 +32,7 @@ ___
**Ƭ DerivedFees**: *`object`*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/types.ts#L18)*
#### Type declaration
@@ -43,7 +43,7 @@ ___
**Ƭ DerivedReferendumVote**: *`object`*
*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/types.ts#L30)*
*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/types.ts#L30)*
#### Type declaration
docs/api-derive/modules/_util_cache_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_util_cache_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **cache**(fn: *`Function`*, map?: *`WeakMap`<`object`, `any`>*): `(Anonymous function)`
*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/5f98849/packages/api-derive/src/util/cache.ts#L23)*
*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/util/cache.ts#L23)*
Create memoization for a 2-currified function.
docs/api-derive/modules/_util_drr_.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/SUMMARY.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/classes/_base_.apibase.html
+10 -10
View File
File diff suppressed because one or more lines are too long
docs/api/classes/_base_.apibase.md
+16 -16
View File
@@ -27,7 +27,7 @@
⊕ **new ApiBase**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*, type: *[ApiType](../modules/_types_.md#apitype)*): [ApiBase](_base_.apibase.md)
*Defined in [Base.ts:81](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L81)*
*Defined in [Base.ts:81](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L81)*
*__description__*: Create an instance of the class
@@ -62,7 +62,7 @@ ___
**get derive**(): [Derive](../interfaces/_types_.derive.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L196)*
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L196)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -83,7 +83,7 @@ ___
**get genesisHash**(): `Hash`
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L132)*
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L132)*
*__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.
@@ -96,7 +96,7 @@ ___
**get hasSubscriptions**(): `boolean`
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L141)*
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L141)*
*__description__*: `true` when subscriptions are supported
@@ -109,7 +109,7 @@ ___
**get libraryInfo**(): `string`
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L148)*
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L148)*
*__description__*: The library information name & version (from package.json)
@@ -122,7 +122,7 @@ ___
**get query**(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L216)*
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L216)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -145,7 +145,7 @@ ___
**get rpc**(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L236)*
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L236)*
*__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.
@@ -168,7 +168,7 @@ ___
**get runtimeMetadata**(): `Metadata`
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L155)*
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L155)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -181,7 +181,7 @@ ___
**get runtimeVersion**(): `RuntimeVersion`
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L164)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L164)*
*__description__*: Contains the version information for the current runtime.
@@ -194,7 +194,7 @@ ___
**get tx**(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L254)*
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L254)*
*__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.
@@ -217,7 +217,7 @@ ___
**get type**(): [ApiType](../modules/_types_.md#apitype)
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L173)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L173)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -233,7 +233,7 @@ ___
▸ **disconnect**(): `void`
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L263)*
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L263)*
*__description__*: Disconnect from the underlying provider, halting all comms
@@ -246,7 +246,7 @@ ___
▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L286)*
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L286)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -278,7 +278,7 @@ ___
▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L311)*
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L311)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -310,7 +310,7 @@ ___
▸ **registerTypes**(types?: *`RegistryTypes`*): `void`
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L320)*
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L320)*
*__description__*: Register additional user-defined of chain-specific types in the type registry
@@ -329,7 +329,7 @@ ___
▸ **setSigner**(signer: *[Signer](../interfaces/_types_.signer.md)*): `void`
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L180)*
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L180)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
docs/api/classes/_promise_api_.apipromise.html
+12 -12
View File
File diff suppressed because one or more lines are too long
docs/api/classes/_promise_api_.apipromise.md
+20 -20
View File
@@ -106,7 +106,7 @@ ApiPromise.create().then((api) => {
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [promise/Api.ts:127](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/promise/Api.ts#L127)*
*Defined in [promise/Api.ts:127](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/promise/Api.ts#L127)*
*__description__*: Creates an instance of the ApiPromise class
@@ -142,7 +142,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)*
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L196)*
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L196)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -165,7 +165,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L132)*
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L132)*
*__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.
@@ -180,7 +180,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L141)*
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L141)*
*__description__*: `true` when subscriptions are supported
@@ -193,7 +193,7 @@ ___
**get isReady**(): `Promise`<[ApiPromise](_promise_api_.apipromise.md)>
*Defined in [promise/Api.ts:161](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/promise/Api.ts#L161)*
*Defined in [promise/Api.ts:161](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/promise/Api.ts#L161)*
*__description__*: Promise that returns the first time we are connected and loaded
@@ -208,7 +208,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[libraryInfo](_base_.apibase.md#libraryinfo)*
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L148)*
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L148)*
*__description__*: The library information name & version (from package.json)
@@ -223,7 +223,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L216)*
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L216)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -248,7 +248,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L236)*
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L236)*
*__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.
@@ -273,7 +273,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L155)*
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L155)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -288,7 +288,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L164)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L164)*
*__description__*: Contains the version information for the current runtime.
@@ -303,7 +303,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L254)*
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L254)*
*__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.
@@ -328,7 +328,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L173)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L173)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -344,7 +344,7 @@ ___
▸ **clone**(): [ApiPromise](_promise_api_.apipromise.md)
*Defined in [promise/Api.ts:168](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/promise/Api.ts#L168)*
*Defined in [promise/Api.ts:168](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/promise/Api.ts#L168)*
*__description__*: Returns a clone of this ApiPromise instance (new underlying provider connection)
@@ -357,7 +357,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/Api.ts:195](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/promise/Api.ts#L195)*
*Defined in [promise/Api.ts:195](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/promise/Api.ts#L195)*
*__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions
@@ -396,7 +396,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)*
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L263)*
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L263)*
*__description__*: Disconnect from the underlying provider, halting all comms
@@ -411,7 +411,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L286)*
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L286)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -445,7 +445,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)*
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L311)*
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L311)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -481,7 +481,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)*
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L320)*
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L320)*
*__description__*: Register additional user-defined of chain-specific types in the type registry
@@ -504,7 +504,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)*
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L180)*
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L180)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
@@ -523,7 +523,7 @@ ___
▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Promise`<[ApiPromise](_promise_api_.apipromise.md)>
*Defined in [promise/Api.ts:125](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/promise/Api.ts#L125)*
*Defined in [promise/Api.ts:125](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/promise/Api.ts#L125)*
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
docs/api/classes/_promise_combinator_.combinator.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/classes/_promise_combinator_.combinator.md
+2 -2
View File
@@ -12,7 +12,7 @@
⊕ **new Combinator**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) \| [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md)
*Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/promise/Combinator.ts#L21)*
*Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/promise/Combinator.ts#L21)*
**Parameters:**
@@ -33,7 +33,7 @@ ___
▸ **unsubscribe**(): `void`
*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/promise/Combinator.ts#L67)*
*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/promise/Combinator.ts#L67)*
**Returns:** `void`
docs/api/classes/_rx_api_.apirx.html
+11 -11
View File
File diff suppressed because one or more lines are too long
docs/api/classes/_rx_api_.apirx.md
+20 -20
View File
@@ -120,7 +120,7 @@ api.query.system
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [rx/Api.ts:141](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/rx/Api.ts#L141)*
*Defined in [rx/Api.ts:141](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/rx/Api.ts#L141)*
*__description__*: Create an instance of the ApiRx class
@@ -160,7 +160,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)*
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L196)*
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L196)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -183,7 +183,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L132)*
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L132)*
*__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.
@@ -198,7 +198,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L141)*
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L141)*
*__description__*: `true` when subscriptions are supported
@@ -211,7 +211,7 @@ ___
**get isConnected**(): `Observable`<`boolean`>
*Defined in [rx/Api.ts:181](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/rx/Api.ts#L181)*
*Defined in [rx/Api.ts:181](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/rx/Api.ts#L181)*
*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
@@ -224,7 +224,7 @@ ___
**get isReady**(): `Observable`<[ApiRx](_rx_api_.apirx.md)>
*Defined in [rx/Api.ts:188](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/rx/Api.ts#L188)*
*Defined in [rx/Api.ts:188](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/rx/Api.ts#L188)*
*__description__*: Observable that returns the first time we are connected and loaded
@@ -239,7 +239,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[libraryInfo](_base_.apibase.md#libraryinfo)*
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L148)*
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L148)*
*__description__*: The library information name & version (from package.json)
@@ -254,7 +254,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L216)*
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L216)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -279,7 +279,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L236)*
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L236)*
*__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.
@@ -304,7 +304,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L155)*
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L155)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -319,7 +319,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L164)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L164)*
*__description__*: Contains the version information for the current runtime.
@@ -334,7 +334,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L254)*
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L254)*
*__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.
@@ -359,7 +359,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L173)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L173)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -375,7 +375,7 @@ ___
▸ **clone**(): [ApiRx](_rx_api_.apirx.md)
*Defined in [rx/Api.ts:195](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/rx/Api.ts#L195)*
*Defined in [rx/Api.ts:195](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/rx/Api.ts#L195)*
*__description__*: Returns a clone of this ApiRx instance (new underlying provider connection)
@@ -392,7 +392,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)*
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L263)*
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L263)*
*__description__*: Disconnect from the underlying provider, halting all comms
@@ -407,7 +407,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L286)*
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L286)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -441,7 +441,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)*
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L311)*
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L311)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -477,7 +477,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)*
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L320)*
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L320)*
*__description__*: Register additional user-defined of chain-specific types in the type registry
@@ -500,7 +500,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)*
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L180)*
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L180)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
@@ -519,7 +519,7 @@ ___
▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Observable`<[ApiRx](_rx_api_.apirx.md)>
*Defined in [rx/Api.ts:139](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/rx/Api.ts#L139)*
*Defined in [rx/Api.ts:139](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/rx/Api.ts#L139)*
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
docs/api/classes/_submittableextrinsic_.submittableextrinsic.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/classes/_submittableextrinsic_.submittableextrinsic.md
+29 -29
View File
@@ -27,7 +27,7 @@
*Overrides Extrinsic.__constructor*
*Defined in [SubmittableExtrinsic.ts:62](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/SubmittableExtrinsic.ts#L62)*
*Defined in [SubmittableExtrinsic.ts:62](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/SubmittableExtrinsic.ts#L62)*
**Parameters:**
@@ -77,7 +77,7 @@ ___
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L160)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L160)*
*__description__*: Returns the Type description to sthe structure
@@ -92,7 +92,7 @@ ___
*Inherited from Extrinsic.args*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L76)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L76)*
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
@@ -107,7 +107,7 @@ ___
*Inherited from Extrinsic.callIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L83)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L83)*
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
@@ -122,7 +122,7 @@ ___
*Inherited from Extrinsic.data*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L90)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L90)*
*__description__*: The actual data for the Method
@@ -139,7 +139,7 @@ ___
*Overrides Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L97)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L97)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -154,7 +154,7 @@ ___
*Inherited from Extrinsic.hash*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L106)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L106)*
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
@@ -169,7 +169,7 @@ ___
*Inherited from Struct.isEmpty*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/5f98849/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/255b495/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Checks if the value is an empty value
@@ -184,7 +184,7 @@ ___
*Inherited from Extrinsic.isSigned*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L115)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L115)*
*__description__*: `true` id the extrinsic is signed
@@ -199,7 +199,7 @@ ___
*Inherited from Extrinsic.length*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L122)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L122)*
*__description__*: The length of the encoded value
@@ -214,7 +214,7 @@ ___
*Inherited from Extrinsic.meta*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L129)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L129)*
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
@@ -229,7 +229,7 @@ ___
*Inherited from Extrinsic.method*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L136)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L136)*
*__description__*: The \[\[Method\]\] this extrinsic wraps
@@ -244,7 +244,7 @@ ___
*Inherited from Extrinsic.signature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L143)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L143)*
*__description__*: The \[\[ExtrinsicSignature\]\]
@@ -277,7 +277,7 @@ ___
*Inherited from Extrinsic.addSignature*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L150)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L150)*
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
@@ -348,7 +348,7 @@ ___
*Inherited from Struct.eq*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/5f98849/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/255b495/packages/types/src/codec/Struct.ts#L176)*
*__description__*: Compares the value of the input to see if there is a match
@@ -391,7 +391,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L184)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L184)*
*__description__*: Returns a specific names entry in the structure
@@ -412,7 +412,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L191)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L191)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -467,11 +467,11 @@ ___
▸ **send**(statusCb: *`function`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:135](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/SubmittableExtrinsic.ts#L135)*
*Defined in [SubmittableExtrinsic.ts:135](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/SubmittableExtrinsic.ts#L135)*
**Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:136](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/SubmittableExtrinsic.ts#L136)*
*Defined in [SubmittableExtrinsic.ts:136](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/SubmittableExtrinsic.ts#L136)*
**Parameters:**
@@ -510,7 +510,7 @@ ___
*Overrides Extrinsic.sign*
*Defined in [SubmittableExtrinsic.ts:153](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/SubmittableExtrinsic.ts#L153)*
*Defined in [SubmittableExtrinsic.ts:153](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/SubmittableExtrinsic.ts#L153)*
**Parameters:**
@@ -530,7 +530,7 @@ ___
▸ **signAndSend**(account: *`KeyringPair` \| `string` \| `AccountId` \| `Address`*, statusCb: *`StatusCb`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:165](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/SubmittableExtrinsic.ts#L165)*
*Defined in [SubmittableExtrinsic.ts:165](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/SubmittableExtrinsic.ts#L165)*
**Parameters:**
@@ -541,7 +541,7 @@ ___
**Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:166](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/SubmittableExtrinsic.ts#L166)*
*Defined in [SubmittableExtrinsic.ts:166](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/SubmittableExtrinsic.ts#L166)*
**Parameters:**
@@ -561,7 +561,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L198)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L198)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -578,7 +578,7 @@ ___
*Overrides Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L168)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L168)*
*__description__*: Returns a hex string representation of the value
@@ -595,7 +595,7 @@ ___
*Overrides Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L175)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L175)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -610,7 +610,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L226)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L226)*
*__description__*: Returns the string representation of the value
@@ -627,7 +627,7 @@ ___
*Overrides Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L183)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L183)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -663,7 +663,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/type/Extrinsic.ts#L44)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/Extrinsic.ts#L44)*
**Parameters:**
@@ -682,7 +682,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/5f98849/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/255b495/packages/types/src/codec/Struct.ts#L125)*
**Type parameters:**
docs/api/classes/_submittableextrinsic_.submittableresult.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/classes/_submittableextrinsic_.submittableresult.md
+16 -16
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
*Defined in [SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/SubmittableExtrinsic.ts#L28)*
*Defined in [SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/SubmittableExtrinsic.ts#L28)*
**Parameters:**
@@ -72,7 +72,7 @@ ___
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L160)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L160)*
*__description__*: Returns the Type description to sthe structure
@@ -87,7 +87,7 @@ ___
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L167)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L167)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -100,7 +100,7 @@ ___
**get events**(): `Array`<`EventRecord`>
*Defined in [SubmittableExtrinsic.ts:40](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/SubmittableExtrinsic.ts#L40)*
*Defined in [SubmittableExtrinsic.ts:40](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/SubmittableExtrinsic.ts#L40)*
*__description__*: the contained events
@@ -115,7 +115,7 @@ ___
*Inherited from Struct.isEmpty*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/5f98849/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/255b495/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Checks if the value is an empty value
@@ -128,7 +128,7 @@ ___
**get status**(): `ExtrinsicStatus`
*Defined in [SubmittableExtrinsic.ts:47](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/SubmittableExtrinsic.ts#L47)*
*Defined in [SubmittableExtrinsic.ts:47](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/SubmittableExtrinsic.ts#L47)*
*__description__*: the status
@@ -141,7 +141,7 @@ ___
**get type**(): `string`
*Defined in [SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/SubmittableExtrinsic.ts#L54)*
*Defined in [SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/SubmittableExtrinsic.ts#L54)*
*__description__*: the type
@@ -221,7 +221,7 @@ ___
*Inherited from Struct.eq*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/5f98849/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/255b495/packages/types/src/codec/Struct.ts#L176)*
*__description__*: Compares the value of the input to see if there is a match
@@ -264,7 +264,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L184)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L184)*
*__description__*: Returns a specific names entry in the structure
@@ -285,7 +285,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L191)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L191)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -360,7 +360,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L198)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L198)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -375,7 +375,7 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L205)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L205)*
*__description__*: Returns a hex string representation of the value
@@ -390,7 +390,7 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L212)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L212)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -405,7 +405,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L226)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L226)*
*__description__*: Returns the string representation of the value
@@ -420,7 +420,7 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/5f98849/packages/types/src/codec/Struct.ts#L234)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L234)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -456,7 +456,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/5f98849/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/255b495/packages/types/src/codec/Struct.ts#L125)*
**Type parameters:**
docs/api/index.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_promise_types_.apipromiseinterface.html
+10 -10
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_promise_types_.apipromiseinterface.md
+17 -17
View File
@@ -24,7 +24,7 @@
*Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)*
*Defined in [Base.ts:81](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L81)*
*Defined in [Base.ts:81](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L81)*
*__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/5f98849/packages/api/src/promise/types.ts#L16)*
*Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/promise/types.ts#L16)*
___
@@ -73,7 +73,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)*
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L196)*
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L196)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -96,7 +96,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)*
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L132)*
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L132)*
*__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 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L141)*
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L141)*
*__description__*: `true` when subscriptions are supported
@@ -126,7 +126,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[libraryInfo](../classes/_base_.apibase.md#libraryinfo)*
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L148)*
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L148)*
*__description__*: The library information name & version (from package.json)
@@ -141,7 +141,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)*
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L216)*
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L216)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -166,7 +166,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)*
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L236)*
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L236)*
*__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.
@@ -191,7 +191,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L155)*
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L155)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -206,7 +206,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L164)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L164)*
*__description__*: Contains the version information for the current runtime.
@@ -221,7 +221,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)*
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L254)*
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L254)*
*__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.
@@ -246,7 +246,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L173)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L173)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -264,7 +264,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)*
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L263)*
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L263)*
*__description__*: Disconnect from the underlying provider, halting all comms
@@ -279,7 +279,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)*
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L286)*
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L286)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -313,7 +313,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)*
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L311)*
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L311)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -347,7 +347,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[registerTypes](../classes/_base_.apibase.md#registertypes)*
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L320)*
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L320)*
*__description__*: Register additional user-defined of chain-specific types in the type registry
@@ -368,7 +368,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)*
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L180)*
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L180)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
docs/api/interfaces/_rx_types_.apirxinterface.html
+10 -10
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_rx_types_.apirxinterface.md
+18 -18
View File
@@ -24,7 +24,7 @@
*Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)*
*Defined in [Base.ts:81](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L81)*
*Defined in [Base.ts:81](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L81)*
*__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/5f98849/packages/api/src/rx/types.ts#L13)*
*Defined in [rx/types.ts:13](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/rx/types.ts#L13)*
___
<a id="isready"></a>
@@ -68,7 +68,7 @@ ___
**● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>*
*Defined in [rx/types.ts:14](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/rx/types.ts#L14)*
*Defined in [rx/types.ts:14](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/rx/types.ts#L14)*
___
@@ -82,7 +82,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)*
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L196)*
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L196)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -105,7 +105,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)*
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L132)*
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L132)*
*__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 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L141)*
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L141)*
*__description__*: `true` when subscriptions are supported
@@ -135,7 +135,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[libraryInfo](../classes/_base_.apibase.md#libraryinfo)*
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L148)*
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L148)*
*__description__*: The library information name & version (from package.json)
@@ -150,7 +150,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)*
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L216)*
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L216)*
*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -175,7 +175,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)*
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L236)*
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L236)*
*__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.
@@ -200,7 +200,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L155)*
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L155)*
*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -215,7 +215,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L164)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L164)*
*__description__*: Contains the version information for the current runtime.
@@ -230,7 +230,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)*
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L254)*
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L254)*
*__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.
@@ -255,7 +255,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L173)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L173)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -273,7 +273,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)*
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L263)*
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L263)*
*__description__*: Disconnect from the underlying provider, halting all comms
@@ -288,7 +288,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)*
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L286)*
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L286)*
*__description__*: Attach an eventemitter handler to listen to a specific event
@@ -322,7 +322,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)*
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L311)*
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L311)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -356,7 +356,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[registerTypes](../classes/_base_.apibase.md#registertypes)*
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L320)*
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L320)*
*__description__*: Register additional user-defined of chain-specific types in the type registry
@@ -377,7 +377,7 @@ ___
*Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)*
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/Base.ts#L180)*
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/Base.ts#L180)*
*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
docs/api/interfaces/_types_.apibaseinterface.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_types_.apibaseinterface.md
+3 -3
View File
@@ -25,7 +25,7 @@
**● on**: *`function`*
*Defined in [types.ts:158](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L158)*
*Defined in [types.ts:158](https://github.com/polkadot-js/api/blob/255b495/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:159](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L159)*
*Defined in [types.ts:159](https://github.com/polkadot-js/api/blob/255b495/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:156](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L156)*
*Defined in [types.ts:156](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L156)*
___
docs/api/interfaces/_types_.apiinterface_decorated.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_types_.apiinterface_decorated.md
+9 -9
View File
@@ -15,7 +15,7 @@
**● derive**: *[Derive](_types_.derive.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:142](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L142)*
*Defined in [types.ts:142](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L142)*
___
<a id="genesishash"></a>
@@ -24,7 +24,7 @@ ___
**● genesisHash**: *`Hash`*
*Defined in [types.ts:138](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L138)*
*Defined in [types.ts:138](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L138)*
___
<a id="hassubscriptions"></a>
@@ -33,7 +33,7 @@ ___
**● hasSubscriptions**: *`boolean`*
*Defined in [types.ts:139](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L139)*
*Defined in [types.ts:139](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L139)*
___
<a id="query"></a>
@@ -42,7 +42,7 @@ ___
**● query**: *[QueryableStorage](_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:143](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L143)*
*Defined in [types.ts:143](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L143)*
___
<a id="rpc"></a>
@@ -51,7 +51,7 @@ ___
**● rpc**: *[DecoratedRpc](_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:144](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L144)*
*Defined in [types.ts:144](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L144)*
___
<a id="runtimemetadata"></a>
@@ -60,7 +60,7 @@ ___
**● runtimeMetadata**: *`Metadata`*
*Defined in [types.ts:140](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L140)*
*Defined in [types.ts:140](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L140)*
___
<a id="runtimeversion"></a>
@@ -69,7 +69,7 @@ ___
**● runtimeVersion**: *`RuntimeVersion`*
*Defined in [types.ts:141](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L141)*
*Defined in [types.ts:141](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L141)*
___
<a id="signer"></a>
@@ -78,7 +78,7 @@ ___
**● signer**: *[Signer](_types_.signer.md)*
*Defined in [types.ts:146](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L146)*
*Defined in [types.ts:146](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L146)*
___
<a id="tx"></a>
@@ -87,7 +87,7 @@ ___
**● tx**: *[SubmittableExtrinsics](_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:145](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L145)*
*Defined in [types.ts:145](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L145)*
___
docs/api/interfaces/_types_.apioptions.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_types_.apioptions.md
+5 -5
View File
@@ -12,7 +12,7 @@
**● derives**: *`DeriveCustom`*
*Defined in [types.ts:116](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L116)*
*Defined in [types.ts:116](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L116)*
*__description__*: Add custom derives to be injected
@@ -23,7 +23,7 @@ ___
**● provider**: *`ProviderInterface`*
*Defined in [types.ts:121](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L121)*
*Defined in [types.ts:121](https://github.com/polkadot-js/api/blob/255b495/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`
@@ -34,7 +34,7 @@ ___
**● signer**: *[Signer](_types_.signer.md)*
*Defined in [types.ts:125](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L125)*
*Defined in [types.ts:125](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L125)*
*__description__*: An external signer which will be used to sign extrinsic when account passed in is not KeyringPair
@@ -45,7 +45,7 @@ ___
**● source**: *[ApiBase](../classes/_base_.apibase.md)<`any`, `any`>*
*Defined in [types.ts:129](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L129)*
*Defined in [types.ts:129](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L129)*
*__description__*: The source object to use for runtime information (only used when cloning)
@@ -56,7 +56,7 @@ ___
**● types**: *`RegistryTypes`*
*Defined in [types.ts:134](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L134)*
*Defined in [types.ts:134](https://github.com/polkadot-js/api/blob/255b495/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.
docs/api/interfaces/_types_.decoratedrpc.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_types_.decoratedrpc.md
+4 -4
View File
@@ -15,7 +15,7 @@
**● author**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L34)*
___
<a id="chain"></a>
@@ -24,7 +24,7 @@ ___
**● chain**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L35)*
*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L35)*
___
<a id="state"></a>
@@ -33,7 +33,7 @@ ___
**● state**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L36)*
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L36)*
___
<a id="system"></a>
@@ -42,7 +42,7 @@ ___
**● system**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>*
*Defined in [types.ts:37](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L37)*
*Defined in [types.ts:37](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L37)*
___
docs/api/interfaces/_types_.decoratedrpc_method.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_types_.decoratedrpc_method.md
+3 -3
View File
@@ -14,7 +14,7 @@
▸ **__call**(arg1?: *`CodecArg`*, arg2?: *`CodecArg`*, arg3?: *`CodecArg`*): `CodecResult`
*Defined in [types.ts:23](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L23)*
*Defined in [types.ts:23](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L23)*
**Parameters:**
@@ -24,7 +24,7 @@
**Returns:** `SubscriptionResult`
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L24)*
**Parameters:**
@@ -35,7 +35,7 @@
**Returns:** `SubscriptionResult`
*Defined in [types.ts:25](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L25)*
*Defined in [types.ts:25](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L25)*
**Parameters:**
docs/api/interfaces/_types_.decoratedrpc_section.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_types_.derive.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_types_.derivemethodbase.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_types_.derivemethodbase.md
+1 -1
View File
@@ -10,7 +10,7 @@
# Callable
▸ **__call**(...params: *`Array`<`CodecArg`>*): `CodecResult`
*Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/5f98849/packages/api/src/types.ts#L88)*
*Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/255b495/packages/api/src/types.ts#L88)*
**Parameters:**
docs/api/interfaces/_types_.derivesection.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_types_.queryablemodulestorage.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_types_.queryablestorage.html
+3 -3
View File
File diff suppressed because one or more lines are too long
docs/api/interfaces/_types_.queryablestoragefunctionbase.html
+3 -3
View File
File diff suppressed because one or more lines are too long

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