api/docs/api-observable/classes/_index_.api.md

Hierarchy

↳ ApiCombined

↳ Api

Constructors

constructor

⊕ new Api(api: RpcRxInterface): Api

Inherited from ApiBase.constructor

Defined in Base.ts:33

Parameters:

Name	Type
api	RpcRxInterface

Returns: Api

---

Properties

whenReady

● whenReady: Observable<boolean>

Inherited from ApiBase.whenReady

Defined in Base.ts:33

---

<Static> extrinsics

● extrinsics: Extrinsics = extrinsicsStatic

Inherited from ApiBase.extrinsics

Defined in Base.ts:41

---

<Static> storage

● storage: Storage = storageStatic

Inherited from ApiBase.storage

Defined in Base.ts:42

---

Accessors

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

Defined in Base.ts:87

Returns: Hash

---

Methods

accountIdAndIndex

▸ accountIdAndIndex(address?: * AccountId | AccountIndex | string | null*): Observable<[AccountId | undefined, AccountIndex | undefined]>

Inherited from ApiCombined.accountIdAndIndex

Defined in Combined.ts:79

Parameters:

Name	Type
Optional address	AccountId | AccountIndex | string | null

Returns: Observable<[AccountId | undefined, AccountIndex | undefined]>

---

accountIdFromIndex

▸ accountIdFromIndex(_accountIndex: * AccountIndex | string*): Observable< AccountId | undefined>

Inherited from ApiCombined.accountIdFromIndex

Defined in Combined.ts:53

Parameters:

Name	Type
_accountIndex	AccountIndex | string

Returns: Observable< AccountId | undefined>

---

accountIndexFromId

▸ accountIndexFromId(accountId: * AccountId | string*): Observable< AccountIndex | undefined>

Inherited from ApiCombined.accountIndexFromId

Defined in Combined.ts:68

Parameters:

Name	Type
accountId	AccountId | string

Returns: Observable< AccountIndex | undefined>

---

accountIndexes

▸ accountIndexes(): Observable<object>

Inherited from ApiCombined.accountIndexes

Defined in Combined.ts:23

Returns: Observable<object>

---

accountNonce

▸ accountNonce(address: * AccountId | string*): Observable< Index | undefined>

Inherited from ApiQueries.accountNonce

Defined in Queries.ts:19

Parameters:

Name	Type
address	AccountId | string

Returns: Observable< Index | undefined>

---

balanceFree

▸ balanceFree(address: * AccountId | string*): Observable< Balance | undefined>

Inherited from ApiQueries.balanceFree

Defined in Queries.ts:23

Parameters:

Name	Type
address	AccountId | string

Returns: Observable< Balance | undefined>

---

balanceReserved

▸ balanceReserved(address: * AccountId | string*): Observable< Balance | undefined>

Inherited from ApiQueries.balanceReserved

Defined in Queries.ts:27

Parameters:

Name	Type
address	AccountId | string

Returns: Observable< Balance | undefined>

---

bestNumber

▸ bestNumber(): Observable< BlockNumber | undefined>

Inherited from ApiCalls.bestNumber

Defined in Calls.ts:13

Returns: Observable< BlockNumber | undefined>

---

blockNow

▸ blockNow(): Observable< Moment | undefined>

Inherited from ApiQueries.blockNow

Defined in Queries.ts:35

Returns: Observable< Moment | undefined>

---

blockPeriod

▸ blockPeriod(): Observable< Moment | undefined>

Inherited from ApiQueries.blockPeriod

Defined in Queries.ts:31

Returns: Observable< Moment | undefined>

---

chain

▸ chain(): Observable< Text | undefined>

Inherited from ApiCalls.chain

Defined in Calls.ts:25

Returns: Observable< Text | undefined>

---

chainProperties

▸ chainProperties(): Observable<ChainProperties>

Inherited from ApiCalls.chainProperties

Defined in Calls.ts:29

Returns: Observable<ChainProperties>

---

democracyLaunchPeriod

▸ democracyLaunchPeriod(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.democracyLaunchPeriod

Defined in Queries.ts:39

Returns: Observable< BlockNumber | undefined>

---

democracyNextTally

▸ democracyNextTally(): Observable< ReferendumIndex | undefined>

Inherited from ApiQueries.democracyNextTally

Defined in Queries.ts:43

Returns: Observable< ReferendumIndex | undefined>

---

democracyReferendumVoters

▸ democracyReferendumVoters(referendumId: * ReferendumIndex | BN | number*): Observable<Array<RxReferendumVote>>

Inherited from ApiCombined.democracyReferendumVoters

Defined in Combined.ts:137

Parameters:

Name	Type
referendumId	ReferendumIndex | BN | number

Returns: Observable<Array<RxReferendumVote>>

---

democracyVotersBalancesOf

▸ democracyVotersBalancesOf(referendumId: * ReferendumIndex | BN | number*): Observable<Array<Balance>>

Inherited from ApiCombined.democracyVotersBalancesOf

Defined in Combined.ts:182

Parameters:

Name	Type
referendumId	ReferendumIndex | BN | number

Returns: Observable<Array<Balance>>

---

democracyVotersVotesOf

▸ democracyVotersVotesOf(referendumId: * ReferendumIndex | BN | number*): Observable<Array<Bool>>

Inherited from ApiCombined.democracyVotersVotesOf

Defined in Combined.ts:198

Parameters:

Name	Type
referendumId	ReferendumIndex | BN | number

Returns: Observable<Array<Bool>>

---

democracyVotingPeriod

▸ democracyVotingPeriod(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.democracyVotingPeriod

Defined in Queries.ts:126

Returns: Observable< BlockNumber | undefined>

---

eraBlockLength

▸ eraBlockLength(): Observable< BlockNumber | undefined>

Inherited from ApiCombined.eraBlockLength

Defined in Combined.ts:209

Returns: Observable< BlockNumber | undefined>

---

eraBlockProgress

▸ eraBlockProgress(): Observable< BlockNumber | undefined>

Inherited from ApiCombined.eraBlockProgress

Defined in Combined.ts:224

Returns: Observable< BlockNumber | undefined>

---

eraBlockRemaining

▸ eraBlockRemaining(): Observable< BlockNumber | undefined>

Inherited from ApiCombined.eraBlockRemaining

Defined in Combined.ts:247

Returns: Observable< BlockNumber | undefined>

---

eraLastLengthChange

▸ eraLastLengthChange(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.eraLastLengthChange

Defined in Queries.ts:151

Returns: Observable< BlockNumber | undefined>

---

fees

▸ fees(): Observable<RxFees>

Inherited from ApiQueries.fees

Defined in Queries.ts:130

Returns: Observable<RxFees>

---

getAccountEnumSet

▸ getAccountEnumSet(index: * AccountIndex | BN | number*): Observable< Array<AccountId> | undefined>

Inherited from ApiQueries.getAccountEnumSet

Defined in Queries.ts:47

Parameters:

Name	Type
index	AccountIndex | BN | number

Returns: Observable< Array<AccountId> | undefined>

---

getBlock

▸ getBlock(hash: Uint8Array): Observable< SignedBlock | undefined>

Inherited from ApiCalls.getBlock

Defined in Calls.ts:41

Parameters:

Name	Type
hash	Uint8Array

Returns: Observable< SignedBlock | undefined>

---

isConnected

▸ isConnected(): Observable<boolean>

Inherited from ApiBase.isConnected

Defined in Base.ts:91

Returns: Observable<boolean>

---

nextAccountEnumSet

▸ nextAccountEnumSet(): Observable< AccountIndex | undefined>

Inherited from ApiQueries.nextAccountEnumSet

Defined in Queries.ts:58

Returns: Observable< AccountIndex | undefined>

---

proposalDeposits

▸ proposalDeposits(proposalId: * PropIndex | BN | number*): Observable< RxProposalDeposits | undefined>

Inherited from ApiQueries.proposalDeposits

Defined in Queries.ts:62

Parameters:

Name	Type
proposalId	PropIndex | BN | number

Returns: Observable< RxProposalDeposits | undefined>

---

publicProposalCount

▸ publicProposalCount(): Observable<number>

Inherited from ApiCombined.publicProposalCount

Defined in Combined.ts:115

Returns: Observable<number>

---

publicProposals

▸ publicProposals(): Observable<Array<RxProposal>>

Inherited from ApiQueries.publicProposals

Defined in Queries.ts:75

Returns: Observable<Array<RxProposal>>

---

rawCall

▸ rawCall<T>(__namedParameters: object, ...params: Array<any>): Observable<T>

Inherited from ApiBase.rawCall

Defined in Base.ts:95

Type parameters:

T

Parameters:

Name	Type
__namedParameters	object
Rest params	Array<any>

Returns: Observable<T>

---

rawStorage

▸ rawStorage<T>(key: * Uint8Array | StorageFunction*, ...params: Array<any>): Observable< T | undefined>

Inherited from ApiBase.rawStorage

Defined in Base.ts:108

Type parameters:

T

Parameters:

Name	Type
key	Uint8Array | StorageFunction
Rest params	Array<any>

Returns: Observable< T | undefined>

---

rawStorageMulti

▸ rawStorageMulti<T>(...keys: Array< Uint8Array | [StorageFunction] | [StorageFunction, any]>): Observable<T>

Inherited from ApiBase.rawStorageMulti

Defined in Base.ts:123

Type parameters:

T : []

Parameters:

Name	Type
Rest keys	Array< Uint8Array | [StorageFunction] | [StorageFunction, any]>

Returns: Observable<T>

---

referendumCount

▸ referendumCount(): Observable< ReferendumIndex | undefined>

Inherited from ApiQueries.referendumCount

Defined in Queries.ts:94

Returns: Observable< ReferendumIndex | undefined>

---

referendumInfo

▸ referendumInfo(referendumId: * ReferendumIndex | BN | number*): Observable< RxReferendum | undefined>

Inherited from ApiQueries.referendumInfo

Defined in Queries.ts:98

Parameters:

Name	Type
referendumId	ReferendumIndex | BN | number

Returns: Observable< RxReferendum | undefined>

---

referendumVote

▸ referendumVote(index: * ReferendumIndex | BN | number, address: * AccountId | string): Observable< Bool | undefined>

Inherited from ApiQueries.referendumVote

Defined in Queries.ts:111

Parameters:

Name	Type
index	ReferendumIndex | BN | number
address	AccountId | string

Returns: Observable< Bool | undefined>

---

referendumVoters

▸ referendumVoters(index: * ReferendumIndex | BN | number*): Observable<Array<AccountId>>

Inherited from ApiQueries.referendumVoters

Defined in Queries.ts:115

Parameters:

Name	Type
index	ReferendumIndex | BN | number

Returns: Observable<Array<AccountId>>

---

referendumVotes

▸ referendumVotes(index: * ReferendumIndex | BN | number*, addresses: Array< AccountId | string>): Observable<boolean>

Inherited from ApiCombined.referendumVotes

Defined in Combined.ts:174

Parameters:

Name	Type
index	ReferendumIndex | BN | number
addresses	Array< AccountId | string>

Returns: Observable<boolean>

---

referendums

▸ referendums(): Observable<Array<RxReferendum>>

Inherited from ApiCombined.referendums

Defined in Combined.ts:153

Returns: Observable<Array<RxReferendum>>

---

referendumsInfo

▸ referendumsInfo(referendumIds: Array< ReferendumIndex | BN | number>): Observable<Array<RxReferendum>>

Inherited from ApiCombined.referendumsInfo

Defined in Combined.ts:125

Parameters:

Name	Type
referendumIds	Array< ReferendumIndex | BN | number>

Returns: Observable<Array<RxReferendum>>

---

sessionBlockProgress

▸ sessionBlockProgress(): Observable< BlockNumber | undefined>

Inherited from ApiCombined.sessionBlockProgress

Defined in Combined.ts:262

Returns: Observable< BlockNumber | undefined>

---

sessionBlockRemaining

▸ sessionBlockRemaining(): Observable< BlockNumber | undefined>

Inherited from ApiCombined.sessionBlockRemaining

Defined in Combined.ts:282

Returns: Observable< BlockNumber | undefined>

---

sessionBrokenValue

▸ sessionBrokenValue(): Observable< Moment | undefined>

Inherited from ApiCombined.sessionBrokenValue

Defined in Combined.ts:297

Returns: Observable< Moment | undefined>

---

sessionCurrentIndex

▸ sessionCurrentIndex(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.sessionCurrentIndex

Defined in Queries.ts:163

Returns: Observable< BlockNumber | undefined>

---

sessionCurrentStart

▸ sessionCurrentStart(): Observable< Moment | undefined>

Inherited from ApiQueries.sessionCurrentStart

Defined in Queries.ts:167

Returns: Observable< Moment | undefined>

---

sessionLastLengthChange

▸ sessionLastLengthChange(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.sessionLastLengthChange

Defined in Queries.ts:171

Returns: Observable< BlockNumber | undefined>

---

sessionLength

▸ sessionLength(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.sessionLength

Defined in Queries.ts:175

Returns: Observable< BlockNumber | undefined>

---

sessionReward

▸ sessionReward(): Observable< Perbill | undefined>

Inherited from ApiQueries.sessionReward

Defined in Queries.ts:155

Returns: Observable< Perbill | undefined>

---

sessionRewardCurrent

▸ sessionRewardCurrent(): Observable< Balance | undefined>

Inherited from ApiQueries.sessionRewardCurrent

Defined in Queries.ts:159

Returns: Observable< Balance | undefined>

---

sessionTimeExpected

▸ sessionTimeExpected(): Observable< Moment | undefined>

Inherited from ApiCombined.sessionTimeExpected

Defined in Combined.ts:316

Returns: Observable< Moment | undefined>

---

sessionTimeRemaining

▸ sessionTimeRemaining(): Observable< Moment | undefined>

Inherited from ApiCombined.sessionTimeRemaining

Defined in Combined.ts:331

Returns: Observable< Moment | undefined>

---

sessionValidators

▸ sessionValidators(): Observable<Array<AccountId>>

Inherited from ApiQueries.sessionValidators

Defined in Queries.ts:183

Returns: Observable<Array<AccountId>>

---

sessionsPerEra

▸ sessionsPerEra(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.sessionsPerEra

Defined in Queries.ts:179

Returns: Observable< BlockNumber | undefined>

---

stakingIntentions

▸ stakingIntentions(): Observable<Array<AccountId>>

Inherited from ApiQueries.stakingIntentions

Defined in Queries.ts:194

Returns: Observable<Array<AccountId>>

---

stakingNominating

▸ stakingNominating(address: * AccountId | string*): Observable< AccountId | undefined>

Inherited from ApiQueries.stakingNominating

Defined in Queries.ts:216

Parameters:

Name	Type
address	AccountId | string

Returns: Observable< AccountId | undefined>

---

stakingNominatorsFor

▸ stakingNominatorsFor(address: * AccountId | string*): Observable<Array<AccountId>>

Inherited from ApiQueries.stakingNominatorsFor

Defined in Queries.ts:205

Parameters:

Name	Type
address	AccountId | string

Returns: Observable<Array<AccountId>>

---

submitAndWatchExtrinsic

▸ submitAndWatchExtrinsic(extrinsic: Extrinsic): Observable< ExtrinsicStatus | undefined>

Inherited from ApiCalls.submitAndWatchExtrinsic

Defined in Calls.ts:63

Parameters:

Name	Type
extrinsic	Extrinsic

Returns: Observable< ExtrinsicStatus | undefined>

---

submitExtrinsic

▸ submitExtrinsic(extrinsic: Extrinsic): Observable< Hash | undefined>

Inherited from ApiCalls.submitExtrinsic

Defined in Calls.ts:59

Parameters:

Name	Type
extrinsic	Extrinsic

Returns: Observable< Hash | undefined>

---

subscribeNewHead

▸ subscribeNewHead(): Observable< Header | undefined>

Inherited from ApiCalls.subscribeNewHead

Defined in Calls.ts:45

Returns: Observable< Header | undefined>

---

systemEvents

▸ systemEvents(): Observable<Array<EventRecord>>

Inherited from ApiQueries.systemEvents

Defined in Queries.ts:220

Returns: Observable<Array<EventRecord>>

---

systemName

▸ systemName(): Observable< Text | undefined>

Inherited from ApiCalls.systemName

Defined in Calls.ts:51

Returns: Observable< Text | undefined>

---

systemVersion

▸ systemVersion(): Observable< Text | undefined>

Inherited from ApiCalls.systemVersion

Defined in Calls.ts:55

Returns: Observable< Text | undefined>

---

validatingBalance

▸ validatingBalance(address: * AccountId | string*): Observable<RxBalance>

Inherited from ApiCombined.validatingBalance

Defined in Combined.ts:346

Parameters:

Name	Type
address	AccountId | string

Returns: Observable<RxBalance>

---

validatingBalances

▸ validatingBalances(...addresses: Array< AccountId | string>): Observable<RxBalanceMap>

Inherited from ApiCombined.validatingBalances

Defined in Combined.ts:371

Parameters:

Name	Type
Rest addresses	Array< AccountId | string>

Returns: Observable<RxBalanceMap>

---

validatorCount

▸ validatorCount(): Observable< u32 | undefined>

Inherited from ApiQueries.validatorCount

Defined in Queries.ts:231

Returns: Observable< u32 | undefined>

---

votingBalance

▸ votingBalance(address: * AccountIndex | AccountId | string*): Observable<RxBalance>

Inherited from ApiCombined.votingBalance

Defined in Combined.ts:385

Parameters:

Name	Type
address	AccountIndex | AccountId | string

Returns: Observable<RxBalance>

---

votingBalances

▸ votingBalances(...addresses: Array< AccountId | string>): Observable<RxBalance[]>

Inherited from ApiCombined.votingBalances

Defined in Combined.ts:425

Parameters:

Name	Type
Rest addresses	Array< AccountId | string>

Returns: Observable<RxBalance[]>

---

votingBalancesNominatorsFor

▸ votingBalancesNominatorsFor(address: * AccountId | string*): Observable<any>

Inherited from ApiCombined.votingBalancesNominatorsFor

Defined in Combined.ts:414

Parameters:

Name	Type
address	AccountId | string

Returns: Observable<any>

---