1056 lines
32 KiB
Markdown
1056 lines
32 KiB
Markdown
|
|
|
|
# Hierarchy
|
|
|
|
↳ [ApiCombined](_combined_.apicombined.md)
|
|
|
|
**↳ Api**
|
|
|
|
# Constructors
|
|
|
|
<a id="constructor"></a>
|
|
|
|
## constructor
|
|
|
|
⊕ **new Api**(api: *`RxApiInterface`*): [Api](_index_.api.md)
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
|
|
|
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L32)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| api | `RxApiInterface` |
|
|
|
|
**Returns:** [Api](_index_.api.md)
|
|
|
|
___
|
|
|
|
# Properties
|
|
|
|
<a id="_api"></a>
|
|
|
|
## `<Protected>` _api
|
|
|
|
**● _api**: *`RxApiInterface`*
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[_api](_base_.apibase.md#_api)*
|
|
|
|
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L28)*
|
|
|
|
___
|
|
<a id="_genesishash"></a>
|
|
|
|
## `<Protected>` _genesisHash
|
|
|
|
**● _genesisHash**: *`Hash`*
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[_genesisHash](_base_.apibase.md#_genesishash)*
|
|
|
|
*Defined in [Base.ts:29](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L29)*
|
|
|
|
___
|
|
<a id="whenready"></a>
|
|
|
|
## whenReady
|
|
|
|
**● whenReady**: *`Observable`<`boolean`>*
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)*
|
|
|
|
*Defined in [Base.ts:32](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L32)*
|
|
|
|
___
|
|
<a id="extrinsics"></a>
|
|
|
|
## `<Static>` extrinsics
|
|
|
|
**● extrinsics**: *`Extrinsics`* = extrinsicsStatic
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)*
|
|
|
|
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L40)*
|
|
|
|
___
|
|
<a id="storage"></a>
|
|
|
|
## `<Static>` storage
|
|
|
|
**● storage**: *`Storage`* = storageStatic
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)*
|
|
|
|
*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L41)*
|
|
|
|
___
|
|
|
|
# Accessors
|
|
|
|
<a id="genesishash"></a>
|
|
|
|
## genesisHash
|
|
|
|
getgenesisHash(): `Hash`
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
|
|
|
|
*Defined in [Base.ts:78](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L78)*
|
|
|
|
**Returns:** `Hash`
|
|
|
|
___
|
|
|
|
# Methods
|
|
|
|
<a id="accountnonce"></a>
|
|
|
|
## accountNonce
|
|
|
|
▸ **accountNonce**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)*
|
|
|
|
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L19)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`< `Index` | `undefined`>
|
|
|
|
___
|
|
<a id="balancefree"></a>
|
|
|
|
## balanceFree
|
|
|
|
▸ **balanceFree**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)*
|
|
|
|
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L23)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`< `Balance` | `undefined`>
|
|
|
|
___
|
|
<a id="balancereserved"></a>
|
|
|
|
## balanceReserved
|
|
|
|
▸ **balanceReserved**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)*
|
|
|
|
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L27)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`< `Balance` | `undefined`>
|
|
|
|
___
|
|
<a id="bestnumber"></a>
|
|
|
|
## bestNumber
|
|
|
|
▸ **bestNumber**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
|
|
|
|
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Calls.ts#L13)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="blocknow"></a>
|
|
|
|
## blockNow
|
|
|
|
▸ **blockNow**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)*
|
|
|
|
*Defined in [Queries.ts:35](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L35)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="blockperiod"></a>
|
|
|
|
## blockPeriod
|
|
|
|
▸ **blockPeriod**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)*
|
|
|
|
*Defined in [Queries.ts:31](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L31)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="chain"></a>
|
|
|
|
## chain
|
|
|
|
▸ **chain**(): `Observable`< `Text` | `undefined`>
|
|
|
|
*Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)*
|
|
|
|
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Calls.ts#L25)*
|
|
|
|
**Returns:** `Observable`< `Text` | `undefined`>
|
|
|
|
___
|
|
<a id="combine"></a>
|
|
|
|
## `<Protected>` combine
|
|
|
|
▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`>
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)*
|
|
|
|
*Defined in [Base.ts:71](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L71)*
|
|
|
|
**Type parameters:**
|
|
|
|
#### T
|
|
#### R
|
|
**Parameters:**
|
|
|
|
| Param | Type | Default value |
|
|
| ------ | ------ | ------ |
|
|
| observables | `Array`<`Observable`<`any`>> | - |
|
|
| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn |
|
|
|
|
**Returns:** `Observable`<`T`>
|
|
|
|
___
|
|
<a id="democracylaunchperiod"></a>
|
|
|
|
## democracyLaunchPeriod
|
|
|
|
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
|
|
|
|
*Defined in [Queries.ts:39](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L39)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="democracynexttally"></a>
|
|
|
|
## democracyNextTally
|
|
|
|
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
|
|
|
|
*Defined in [Queries.ts:43](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L43)*
|
|
|
|
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
|
|
|
___
|
|
<a id="democracyreferendumvoters"></a>
|
|
|
|
## democracyReferendumVoters
|
|
|
|
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)*
|
|
|
|
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L42)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| referendumId | `ReferendumIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>>
|
|
|
|
___
|
|
<a id="democracyvotersbalancesof"></a>
|
|
|
|
## democracyVotersBalancesOf
|
|
|
|
▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Balance`>>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)*
|
|
|
|
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L87)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| referendumId | `ReferendumIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`<`Array`<`Balance`>>
|
|
|
|
___
|
|
<a id="democracyvotersvotesof"></a>
|
|
|
|
## democracyVotersVotesOf
|
|
|
|
▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Bool`>>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)*
|
|
|
|
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L103)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| referendumId | `ReferendumIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`<`Array`<`Bool`>>
|
|
|
|
___
|
|
<a id="democracyvotingperiod"></a>
|
|
|
|
## democracyVotingPeriod
|
|
|
|
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
|
|
|
|
*Defined in [Queries.ts:111](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L111)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="erablocklength"></a>
|
|
|
|
## eraBlockLength
|
|
|
|
▸ **eraBlockLength**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)*
|
|
|
|
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L114)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="erablockprogress"></a>
|
|
|
|
## eraBlockProgress
|
|
|
|
▸ **eraBlockProgress**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)*
|
|
|
|
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L129)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="erablockremaining"></a>
|
|
|
|
## eraBlockRemaining
|
|
|
|
▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)*
|
|
|
|
*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L151)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="eralastlengthchange"></a>
|
|
|
|
## eraLastLengthChange
|
|
|
|
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
|
|
|
|
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L136)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="fees"></a>
|
|
|
|
## fees
|
|
|
|
▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
|
|
|
|
*Defined in [Queries.ts:115](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L115)*
|
|
|
|
**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
|
|
|
|
___
|
|
<a id="getblock"></a>
|
|
|
|
## getBlock
|
|
|
|
▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` | `undefined`>
|
|
|
|
*Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)*
|
|
|
|
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Calls.ts#L29)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| hash | `Uint8Array` |
|
|
|
|
**Returns:** `Observable`< `SignedBlock` | `undefined`>
|
|
|
|
___
|
|
<a id="isconnected"></a>
|
|
|
|
## isConnected
|
|
|
|
▸ **isConnected**(): `Observable`<`boolean`>
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
|
|
|
|
*Defined in [Base.ts:82](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L82)*
|
|
|
|
**Returns:** `Observable`<`boolean`>
|
|
|
|
___
|
|
<a id="newhead"></a>
|
|
|
|
## newHead
|
|
|
|
▸ **newHead**(): `Observable`< `Header` | `undefined`>
|
|
|
|
*Inherited from [ApiCalls](_calls_.apicalls.md).[newHead](_calls_.apicalls.md#newhead)*
|
|
|
|
*Defined in [Calls.ts:33](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Calls.ts#L33)*
|
|
|
|
**Returns:** `Observable`< `Header` | `undefined`>
|
|
|
|
___
|
|
<a id="proposaldeposits"></a>
|
|
|
|
## proposalDeposits
|
|
|
|
▸ **proposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)*
|
|
|
|
*Defined in [Queries.ts:47](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L47)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| proposalId | `PropIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`>
|
|
|
|
___
|
|
<a id="publicproposalcount"></a>
|
|
|
|
## publicProposalCount
|
|
|
|
▸ **publicProposalCount**(): `Observable`<`number`>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[publicProposalCount](_combined_.apicombined.md#publicproposalcount)*
|
|
|
|
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L20)*
|
|
|
|
**Returns:** `Observable`<`number`>
|
|
|
|
___
|
|
<a id="publicproposals"></a>
|
|
|
|
## publicProposals
|
|
|
|
▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)*
|
|
|
|
*Defined in [Queries.ts:60](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L60)*
|
|
|
|
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
|
|
|
___
|
|
<a id="rawcall"></a>
|
|
|
|
## rawCall
|
|
|
|
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
|
|
|
|
*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L86)*
|
|
|
|
**Type parameters:**
|
|
|
|
#### T
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| __namedParameters | `object` |
|
|
| `Rest` params | `Array`<`any`> |
|
|
|
|
**Returns:** `Observable`<`T`>
|
|
|
|
___
|
|
<a id="rawstorage"></a>
|
|
|
|
## rawStorage
|
|
|
|
▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` | `undefined`>
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
|
|
|
|
*Defined in [Base.ts:98](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L98)*
|
|
|
|
**Type parameters:**
|
|
|
|
#### T
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| key | `StorageFunction` |
|
|
| `Rest` params | `Array`<`any`> |
|
|
|
|
**Returns:** `Observable`< `T` | `undefined`>
|
|
|
|
___
|
|
<a id="rawstoragemulti"></a>
|
|
|
|
## rawStorageMulti
|
|
|
|
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`>
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
|
|
|
|
*Defined in [Base.ts:110](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Base.ts#L110)*
|
|
|
|
**Type parameters:**
|
|
|
|
#### T : `[]`
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| `Rest` keys | `Array`< [`StorageFunction`] | [`StorageFunction`, `any`]> |
|
|
|
|
**Returns:** `Observable`<`T`>
|
|
|
|
___
|
|
<a id="referendumcount"></a>
|
|
|
|
## referendumCount
|
|
|
|
▸ **referendumCount**(): `Observable`< `ReferendumIndex` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)*
|
|
|
|
*Defined in [Queries.ts:79](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L79)*
|
|
|
|
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
|
|
|
___
|
|
<a id="referenduminfo"></a>
|
|
|
|
## referendumInfo
|
|
|
|
▸ **referendumInfo**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)*
|
|
|
|
*Defined in [Queries.ts:83](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L83)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| referendumId | `ReferendumIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`>
|
|
|
|
___
|
|
<a id="referendumvote"></a>
|
|
|
|
## referendumVote
|
|
|
|
▸ **referendumVote**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`< `Bool` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)*
|
|
|
|
*Defined in [Queries.ts:96](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L96)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| index | `ReferendumIndex` | `BN` | `number`|
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`< `Bool` | `undefined`>
|
|
|
|
___
|
|
<a id="referendumvoters"></a>
|
|
|
|
## referendumVoters
|
|
|
|
▸ **referendumVoters**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)*
|
|
|
|
*Defined in [Queries.ts:100](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L100)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| index | `ReferendumIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`<`Array`<`AccountId`>>
|
|
|
|
___
|
|
<a id="referendumvotes"></a>
|
|
|
|
## referendumVotes
|
|
|
|
▸ **referendumVotes**(index: * `ReferendumIndex` | `BN` | `number`*, addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`boolean`>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumVotes](_combined_.apicombined.md#referendumvotes)*
|
|
|
|
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L79)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| index | `ReferendumIndex` | `BN` | `number`|
|
|
| addresses | `Array`< `AccountId` | `string`> |
|
|
|
|
**Returns:** `Observable`<`boolean`>
|
|
|
|
___
|
|
<a id="referendums"></a>
|
|
|
|
## referendums
|
|
|
|
▸ **referendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendums](_combined_.apicombined.md#referendums)*
|
|
|
|
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L58)*
|
|
|
|
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
|
|
|
___
|
|
<a id="referendumsinfo"></a>
|
|
|
|
## referendumsInfo
|
|
|
|
▸ **referendumsInfo**(referendumIds: *`Array`< `ReferendumIndex` | `BN` | `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[referendumsInfo](_combined_.apicombined.md#referendumsinfo)*
|
|
|
|
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L30)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| referendumIds | `Array`< `ReferendumIndex` | `BN` | `number`> |
|
|
|
|
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
|
|
|
___
|
|
<a id="sessionblockprogress"></a>
|
|
|
|
## sessionBlockProgress
|
|
|
|
▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)*
|
|
|
|
*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L166)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionblockremaining"></a>
|
|
|
|
## sessionBlockRemaining
|
|
|
|
▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)*
|
|
|
|
*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L185)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionbrokenvalue"></a>
|
|
|
|
## sessionBrokenValue
|
|
|
|
▸ **sessionBrokenValue**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)*
|
|
|
|
*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L200)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="sessioncurrentindex"></a>
|
|
|
|
## sessionCurrentIndex
|
|
|
|
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
|
|
|
|
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L148)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="sessioncurrentstart"></a>
|
|
|
|
## sessionCurrentStart
|
|
|
|
▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
|
|
|
|
*Defined in [Queries.ts:152](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L152)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionlastlengthchange"></a>
|
|
|
|
## sessionLastLengthChange
|
|
|
|
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
|
|
|
|
*Defined in [Queries.ts:156](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L156)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionlength"></a>
|
|
|
|
## sessionLength
|
|
|
|
▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
|
|
|
|
*Defined in [Queries.ts:160](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L160)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionreward"></a>
|
|
|
|
## sessionReward
|
|
|
|
▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
|
|
|
|
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L140)*
|
|
|
|
**Returns:** `Observable`< `Perbill` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionrewardcurrent"></a>
|
|
|
|
## sessionRewardCurrent
|
|
|
|
▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
|
|
|
|
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L144)*
|
|
|
|
**Returns:** `Observable`< `Balance` | `undefined`>
|
|
|
|
___
|
|
<a id="sessiontimeexpected"></a>
|
|
|
|
## sessionTimeExpected
|
|
|
|
▸ **sessionTimeExpected**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)*
|
|
|
|
*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L219)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="sessiontimeremaining"></a>
|
|
|
|
## sessionTimeRemaining
|
|
|
|
▸ **sessionTimeRemaining**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)*
|
|
|
|
*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L234)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionvalidators"></a>
|
|
|
|
## sessionValidators
|
|
|
|
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
|
|
|
|
*Defined in [Queries.ts:168](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L168)*
|
|
|
|
**Returns:** `Observable`<`Array`<`AccountId`>>
|
|
|
|
___
|
|
<a id="sessionsperera"></a>
|
|
|
|
## sessionsPerEra
|
|
|
|
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
|
|
|
|
*Defined in [Queries.ts:164](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L164)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="stakingintentions"></a>
|
|
|
|
## stakingIntentions
|
|
|
|
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
|
|
|
|
*Defined in [Queries.ts:179](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L179)*
|
|
|
|
**Returns:** `Observable`<`Array`<`AccountId`>>
|
|
|
|
___
|
|
<a id="stakingnominating"></a>
|
|
|
|
## stakingNominating
|
|
|
|
▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
|
|
|
|
*Defined in [Queries.ts:201](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L201)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`< `AccountId` | `undefined`>
|
|
|
|
___
|
|
<a id="stakingnominatorsfor"></a>
|
|
|
|
## stakingNominatorsFor
|
|
|
|
▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
|
|
|
|
*Defined in [Queries.ts:190](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L190)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`<`Array`<`AccountId`>>
|
|
|
|
___
|
|
<a id="submitextrinsic"></a>
|
|
|
|
## submitExtrinsic
|
|
|
|
▸ **submitExtrinsic**(extrinsic: *`UncheckedMortalExtrinsic`*): `Observable`< `Hash` | `undefined`>
|
|
|
|
*Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)*
|
|
|
|
*Defined in [Calls.ts:47](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Calls.ts#L47)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| extrinsic | `UncheckedMortalExtrinsic` |
|
|
|
|
**Returns:** `Observable`< `Hash` | `undefined`>
|
|
|
|
___
|
|
<a id="systemname"></a>
|
|
|
|
## systemName
|
|
|
|
▸ **systemName**(): `Observable`< `Text` | `undefined`>
|
|
|
|
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)*
|
|
|
|
*Defined in [Calls.ts:39](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Calls.ts#L39)*
|
|
|
|
**Returns:** `Observable`< `Text` | `undefined`>
|
|
|
|
___
|
|
<a id="systemversion"></a>
|
|
|
|
## systemVersion
|
|
|
|
▸ **systemVersion**(): `Observable`< `Text` | `undefined`>
|
|
|
|
*Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)*
|
|
|
|
*Defined in [Calls.ts:43](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Calls.ts#L43)*
|
|
|
|
**Returns:** `Observable`< `Text` | `undefined`>
|
|
|
|
___
|
|
<a id="validatingbalance"></a>
|
|
|
|
## validatingBalance
|
|
|
|
▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)*
|
|
|
|
*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L249)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
|
|
|
|
___
|
|
<a id="validatingbalances"></a>
|
|
|
|
## validatingBalances
|
|
|
|
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)*
|
|
|
|
*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L274)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| `Rest` addresses | `Array`< `AccountId` | `string`> |
|
|
|
|
**Returns:** `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)>
|
|
|
|
___
|
|
<a id="validatorcount"></a>
|
|
|
|
## validatorCount
|
|
|
|
▸ **validatorCount**(): `Observable`< `u32` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
|
|
|
|
*Defined in [Queries.ts:205](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Queries.ts#L205)*
|
|
|
|
**Returns:** `Observable`< `u32` | `undefined`>
|
|
|
|
___
|
|
<a id="votingbalance"></a>
|
|
|
|
## votingBalance
|
|
|
|
▸ **votingBalance**(_address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)*
|
|
|
|
*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L288)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| _address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
|
|
|
|
___
|
|
<a id="votingbalances"></a>
|
|
|
|
## votingBalances
|
|
|
|
▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)*
|
|
|
|
*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L322)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| `Rest` addresses | `Array`< `AccountId` | `string`> |
|
|
|
|
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]>
|
|
|
|
___
|
|
<a id="votingbalancesnominatorsfor"></a>
|
|
|
|
## votingBalancesNominatorsFor
|
|
|
|
▸ **votingBalancesNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`any`>
|
|
|
|
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)*
|
|
|
|
*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/522eae6/packages/api-observable/src/Combined.ts#L311)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`<`any`>
|
|
|
|
___
|
|
|