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

[CI Skip] 0.45.15

Browse Source
This commit is contained in:
Travis CI
2019-02-26 15:22:01 +00:00
parent 73a5ea1568
commit 0463f04e2c
1339 changed files with 13997 additions and 782331 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/404.html
+17
View File
File diff suppressed because one or more lines are too long
docs/CONTRIBUTING.html
+25 -773
View File
File diff suppressed because one or more lines are too long
docs/METHODS_EVENTS.html
+27 -3242
View File
File diff suppressed because one or more lines are too long
docs/METHODS_EVENTS.md
+29 -29
View File
@@ -1,4 +1,4 @@
## <a id='top' style='text-decoration: none;'>Events ## Events
Events are emitted for certain operations on the runtime. The following sections describe the events that are part of the default Substrate runtime. Events are emitted for certain operations on the runtime. The following sections describe the events that are part of the default Substrate runtime.
- **[balances](#balances)** - **[balances](#balances)**
@@ -31,9 +31,9 @@ Events are emitted for certain operations on the runtime. The following sections
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='balances'></a>balances
### balances
▸ **NewAccount**(`AccountId`, `Balance`) ▸ **NewAccount**(`AccountId`, `Balance`)
- **summary**: A new account was created. - **summary**: A new account was created.
@@ -45,9 +45,9 @@ ___
- **summary**: Transfer succeeded (from, to, value, fees). - **summary**: Transfer succeeded (from, to, value, fees).
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='contract'></a>contract
### contract
▸ **CodeStored**(`Hash`) ▸ **CodeStored**(`Hash`)
- **summary**: Code with the specified hash has been stored. - **summary**: Code with the specified hash has been stored.
@@ -65,9 +65,9 @@ ___
- **summary**: Transfer happened `from` -> `to` with given `value` as part of a `message-call` or `create`. - **summary**: Transfer happened `from` -> `to` with given `value` as part of a `message-call` or `create`.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='council'></a>council
### council
▸ **BadReaperSlashed**(`AccountId`) ▸ **BadReaperSlashed**(`AccountId`)
- **summary**: slashed reaper - **summary**: slashed reaper
@@ -82,9 +82,9 @@ ___
- **summary**: reaped voter, reaper - **summary**: reaped voter, reaper
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='councilMotions'></a>councilMotions
### councilMotions
▸ **Approved**(`Hash`) ▸ **Approved**(`Hash`)
- **summary**: A motion was approved by the required threshold. - **summary**: A motion was approved by the required threshold.
@@ -102,9 +102,9 @@ ___
- **summary**: A motion (given hash) has been voted on by given account, leaving a tally (yes votes and no votes given as u32s respectively). - **summary**: A motion (given hash) has been voted on by given account, leaving a tally (yes votes and no votes given as u32s respectively).
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='councilVoting'></a>councilVoting
### councilVoting
▸ **TallyCancelation**(`Hash`, `u32`, `u32`, `u32`) ▸ **TallyCancelation**(`Hash`, `u32`, `u32`, `u32`)
- **summary**: A voting tally has happened for a referendum cancellation vote. Last three are yes, no, abstain counts. - **summary**: A voting tally has happened for a referendum cancellation vote. Last three are yes, no, abstain counts.
@@ -113,9 +113,9 @@ ___
- **summary**: A voting tally has happened for a referendum vote. Last three are yes, no, abstain counts. - **summary**: A voting tally has happened for a referendum vote. Last three are yes, no, abstain counts.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='democracy'></a>democracy
### democracy
▸ **Cancelled**(`ReferendumIndex`) ▸ **Cancelled**(`ReferendumIndex`)
@@ -132,41 +132,41 @@ ___
▸ **Tabled**(`PropIndex`, `Balance`, `Vec<AccountId>`) ▸ **Tabled**(`PropIndex`, `Balance`, `Vec<AccountId>`)
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='fees'></a>fees
### fees
▸ **Charged**(`u32`, `Amount`) ▸ **Charged**(`u32`, `Amount`)
- **summary**: Fee charged (extrinsic_index, fee_amount) - **summary**: Fee charged (extrinsic_index, fee_amount)
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='grandpa'></a>grandpa
### grandpa
▸ **NewAuthorities**(`Vec<(SessionKey,u64)>`) ▸ **NewAuthorities**(`Vec<(SessionKey,u64)>`)
- **summary**: New authority set has been applied. - **summary**: New authority set has been applied.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='indices'></a>indices
### indices
▸ **NewAccountIndex**(`AccountId`, `AccountIndex`) ▸ **NewAccountIndex**(`AccountId`, `AccountIndex`)
- **summary**: A new account index was assigned. This event is not triggered when an existing index is reassigned to another `AccountId`. - **summary**: A new account index was assigned. This event is not triggered when an existing index is reassigned to another `AccountId`.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='session'></a>session
### session
▸ **NewSession**(`BlockNumber`) ▸ **NewSession**(`BlockNumber`)
- **summary**: New session has happened. Note that the argument is the session index, not the block number as the type might suggest. - **summary**: New session has happened. Note that the argument is the session index, not the block number as the type might suggest.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='staking'></a>staking
### staking
▸ **OfflineSlash**(`AccountId`, `Balance`) ▸ **OfflineSlash**(`AccountId`, `Balance`)
- **summary**: One validator (and their nominators) has been slashed by the given amount. - **summary**: One validator (and their nominators) has been slashed by the given amount.
@@ -178,9 +178,9 @@ ___
- **summary**: All validators have been rewarded by the given balance. - **summary**: All validators have been rewarded by the given balance.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='sudo'></a>sudo
### sudo
▸ **KeyChanged**(`AccountId`) ▸ **KeyChanged**(`AccountId`)
- **summary**: The sudoer just switched identity; the old key is supplied. - **summary**: The sudoer just switched identity; the old key is supplied.
@@ -189,9 +189,9 @@ ___
- **summary**: A sudo just took place. - **summary**: A sudo just took place.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='system'></a>system
### system
▸ **ExtrinsicFailed**() ▸ **ExtrinsicFailed**()
- **summary**: An extrinsic failed. - **summary**: An extrinsic failed.
@@ -200,9 +200,9 @@ ___
- **summary**: An extrinsic completed successfully. - **summary**: An extrinsic completed successfully.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='treasury'></a>treasury
### treasury
▸ **Awarded**(`ProposalIndex`, `Balance`, `AccountId`) ▸ **Awarded**(`ProposalIndex`, `Balance`, `AccountId`)
- **summary**: Some funds have been allocated. - **summary**: Some funds have been allocated.
docs/METHODS_EXTRINSICS.html
+27 -3288
View File
File diff suppressed because one or more lines are too long
docs/METHODS_EXTRINSICS.md
+27 -27
View File
@@ -1,4 +1,4 @@
## <a id='top' style='text-decoration: none;'>Extrinsics ## Extrinsics
_The following sections contain Extrinsics methods are part of the default Substrate runtime._ _The following sections contain Extrinsics methods are part of the default Substrate runtime._
- **[balances](#balances)** - **[balances](#balances)**
@@ -29,9 +29,9 @@ _The following sections contain Extrinsics methods are part of the default Subst
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='balances'></a>balances
### balances
▸ **setBalance**(who: `Address`, free: `Compact<Balance>`, reserved: `Compact<Balance>`) ▸ **setBalance**(who: `Address`, free: `Compact<Balance>`, reserved: `Compact<Balance>`)
- **summary**: Set the balances of a given account. - **summary**: Set the balances of a given account.
@@ -40,9 +40,9 @@ ___
- **summary**: Transfer some liquid free balance to another staker. - **summary**: Transfer some liquid free balance to another staker.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='consensus'></a>consensus
### consensus
▸ **noteOffline**(offline: `InherentOfflineReport`) ▸ **noteOffline**(offline: `InherentOfflineReport`)
- **summary**: Note the previous block's validator missed their opportunity to propose a block. - **summary**: Note the previous block's validator missed their opportunity to propose a block.
@@ -63,9 +63,9 @@ ___
- **summary**: Set some items of storage. - **summary**: Set some items of storage.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='contract'></a>contract
### contract
▸ **call**(dest: `Address`, value: `Compact<Balance>`, gas_limit: `Compact<Gas>`, data: `Bytes`) ▸ **call**(dest: `Address`, value: `Compact<Balance>`, gas_limit: `Compact<Gas>`, data: `Bytes`)
- **summary**: Make a call to a specified account, optionally transferring some balance. - **summary**: Make a call to a specified account, optionally transferring some balance.
@@ -80,9 +80,9 @@ ___
- **summary**: Updates the schedule for metering contracts. The schedule must have a greater version than the stored schedule. - **summary**: Updates the schedule for metering contracts. The schedule must have a greater version than the stored schedule.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='council'></a>council
### council
▸ **presentWinner**(candidate: `Address`, total: `Compact<BalanceOf>`, index: `Compact<VoteIndex>`) ▸ **presentWinner**(candidate: `Address`, total: `Compact<BalanceOf>`, index: `Compact<VoteIndex>`)
- **summary**: Claim that `signed` is one of the top Self::carry_count() + current_vote().1 candidates. Only works if the `block_number >= current_vote().0` and `< current_vote().0 + presentation_duration()`` `signed` should have at least - **summary**: Claim that `signed` is one of the top Self::carry_count() + current_vote().1 candidates. Only works if the `block_number >= current_vote().0` and `< current_vote().0 + presentation_duration()`` `signed` should have at least
@@ -112,18 +112,18 @@ ___
- **summary**: Submit oneself for candidacy. Account must have enough transferrable funds in it to pay the bond. - **summary**: Submit oneself for candidacy. Account must have enough transferrable funds in it to pay the bond.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='councilMotions'></a>councilMotions
### councilMotions
▸ **propose**(threshold: `Compact<u32>`, proposal: `Proposal`) ▸ **propose**(threshold: `Compact<u32>`, proposal: `Proposal`)
▸ **vote**(proposal: `Hash`, index: `Compact<ProposalIndex>`, approve: `bool`) ▸ **vote**(proposal: `Hash`, index: `Compact<ProposalIndex>`, approve: `bool`)
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='councilVoting'></a>councilVoting
### councilVoting
▸ **propose**(proposal: `Proposal`) ▸ **propose**(proposal: `Proposal`)
@@ -136,9 +136,9 @@ ___
▸ **vote**(proposal: `Hash`, approve: `bool`) ▸ **vote**(proposal: `Hash`, approve: `bool`)
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='democracy'></a>democracy
### democracy
▸ **cancelQueued**(when: `Compact<BlockNumber>`, which: `Compact<u32>`) ▸ **cancelQueued**(when: `Compact<BlockNumber>`, which: `Compact<u32>`)
- **summary**: Cancel a proposal queued for enactment. - **summary**: Cancel a proposal queued for enactment.
@@ -159,17 +159,17 @@ ___
- **summary**: Vote in a referendum. If `vote.is_aye()`, the vote is to enact the proposal; otherwise it is a vote to keep the status quo. - **summary**: Vote in a referendum. If `vote.is_aye()`, the vote is to enact the proposal; otherwise it is a vote to keep the status quo.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='grandpa'></a>grandpa
### grandpa
▸ **reportMisbehavior**(_report: `Bytes`) ▸ **reportMisbehavior**(_report: `Bytes`)
- **summary**: Report some misbehaviour. - **summary**: Report some misbehaviour.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='session'></a>session
### session
▸ **forceNewSession**(apply_rewards: `bool`) ▸ **forceNewSession**(apply_rewards: `bool`)
- **summary**: Forces a new session. - **summary**: Forces a new session.
@@ -181,9 +181,9 @@ ___
- **summary**: Set a new session length. Won't kick in until the next session change (at current length). - **summary**: Set a new session length. Won't kick in until the next session change (at current length).
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='staking'></a>staking
### staking
▸ **forceNewEra**(apply_rewards: `bool`) ▸ **forceNewEra**(apply_rewards: `bool`)
- **summary**: Force there to be a new era. This also forces a new session immediately after. `apply_rewards` should be true for validators to get the session reward. - **summary**: Force there to be a new era. This also forces a new session immediately after. `apply_rewards` should be true for validators to get the session reward.
@@ -218,26 +218,26 @@ ___
- **summary**: Retract the desire to stake for the transactor. Effects will be felt at the beginning of the next era. - **summary**: Retract the desire to stake for the transactor. Effects will be felt at the beginning of the next era.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='sudo'></a>sudo
### sudo
▸ **setKey**(new: `Address`) ▸ **setKey**(new: `Address`)
▸ **sudo**(proposal: `Proposal`) ▸ **sudo**(proposal: `Proposal`)
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='timestamp'></a>timestamp
### timestamp
▸ **set**(now: `Compact<Moment>`) ▸ **set**(now: `Compact<Moment>`)
- **summary**: Set the current time. Extrinsic with this call should be placed at the specific position in the each block (specified by the Trait::TIMESTAMP_SET_POSITION) typically at the start of the each block. This call should be invoked exactly once per block. It will panic at the finalization phase, if this call hasn't been invoked by that time. The timestamp should be greater than the previous one by the amount specified by `block_period`. - **summary**: Set the current time. Extrinsic with this call should be placed at the specific position in the each block (specified by the Trait::TIMESTAMP_SET_POSITION) typically at the start of the each block. This call should be invoked exactly once per block. It will panic at the finalization phase, if this call hasn't been invoked by that time. The timestamp should be greater than the previous one by the amount specified by `block_period`.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='treasury'></a>treasury
### treasury
▸ **approveProposal**(proposal_id: `Compact<ProposalIndex>`) ▸ **approveProposal**(proposal_id: `Compact<ProposalIndex>`)
- **summary**: Approve a proposal. At a later time, the proposal will be allocated to the beneficiary and the original deposit will be returned. - **summary**: Approve a proposal. At a later time, the proposal will be allocated to the beneficiary and the original deposit will be returned.
docs/METHODS_RPC.html
+27 -3149
View File
File diff suppressed because one or more lines are too long
docs/METHODS_RPC.md
+9 -9
View File
@@ -1,4 +1,4 @@
## <a id='top' style='text-decoration: none;'>JSON-RPC ## JSON-RPC
_The following sections contain RPC methods that are Remote Calls available by default and allow you to interact with the actual node, query, and submit. The RPCs are provided by Substrate itself._ _The following sections contain RPC methods that are Remote Calls available by default and allow you to interact with the actual node, query, and submit. The RPCs are provided by Substrate itself._
- **[author](#author)** - **[author](#author)**
@@ -11,9 +11,9 @@ _The following sections contain RPC methods that are Remote Calls available by d
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='author'></a>author
### author
_Authoring of network items_ _Authoring of network items_
@@ -27,9 +27,9 @@ _Authoring of network items_
- **summary**: Submit a fully formatted extrinsic for block inclusion - **summary**: Submit a fully formatted extrinsic for block inclusion
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='chain'></a>chain
### chain
_Retrieval of chain data_ _Retrieval of chain data_
@@ -58,9 +58,9 @@ _Retrieval of chain data_
- **summary**: Retrieves the runtime version via subscription - **summary**: Retrieves the runtime version via subscription
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='state'></a>state
### state
_Query of state_ _Query of state_
@@ -89,9 +89,9 @@ _Query of state_
- **summary**: Subscribes to storage changes for the provided keys - **summary**: Subscribes to storage changes for the provided keys
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='system'></a>system
### system
_Methods to retrieve system info_ _Methods to retrieve system info_
docs/METHODS_STORAGE.html
+27 -3576
View File
File diff suppressed because one or more lines are too long
docs/METHODS_STORAGE.md
+33 -33
View File
@@ -1,4 +1,4 @@
## <a id='top' style='text-decoration: none;'>Storage ## Storage
_The following sections contain Storage methods are part of the default Substrate runtime._ _The following sections contain Storage methods are part of the default Substrate runtime._
- **[balances](#balances)** - **[balances](#balances)**
@@ -37,9 +37,9 @@ _The following sections contain Storage methods are part of the default Substrat
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='balances'></a>balances
### balances
▸ **creationFee**(): `Balance` ▸ **creationFee**(): `Balance`
- **summary**: The fee required to create an account. At least as big as ReclaimRebate. - **summary**: The fee required to create an account. At least as big as ReclaimRebate.
@@ -63,16 +63,16 @@ ___
- **summary**: Information regarding the vesting of a given account. - **summary**: Information regarding the vesting of a given account.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='consensus'></a>consensus
### consensus
▸ **originalAuthorities**(): `Option<Vec<SessionKey>>` ▸ **originalAuthorities**(): `Option<Vec<SessionKey>>`
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='contract'></a>contract
### contract
▸ **blockGasLimit**(): `Gas` ▸ **blockGasLimit**(): `Gas`
- **summary**: The maximum amount of gas that could be expended per block. - **summary**: The maximum amount of gas that could be expended per block.
@@ -108,9 +108,9 @@ ___
- **summary**: A mapping from an original code hash to the original code, untouched by instrumentation. - **summary**: A mapping from an original code hash to the original code, untouched by instrumentation.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='council'></a>council
### council
▸ **activeCouncil**(): `Vec<(AccountId,BlockNumber)>` ▸ **activeCouncil**(): `Vec<(AccountId,BlockNumber)>`
- **summary**: The current council. When there's a vote going on, this should still be used for executive matters. The block number (second element in the tuple) is the block that their position is active until (calculated by the sum of the block number when the council member was elected and their term duration). - **summary**: The current council. When there's a vote going on, this should still be used for executive matters. The block number (second element in the tuple) is the block that their position is active until (calculated by the sum of the block number when the council member was elected and their term duration).
@@ -172,9 +172,9 @@ ___
- **summary**: How often (in blocks) to check for new votes. - **summary**: How often (in blocks) to check for new votes.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='councilMotions'></a>councilMotions
### councilMotions
▸ **proposalCount**(): `u32` ▸ **proposalCount**(): `u32`
- **summary**: Proposals so far. - **summary**: Proposals so far.
@@ -189,9 +189,9 @@ ___
- **summary**: Votes for a given proposal: (required_yes_votes, yes_voters, no_voters). - **summary**: Votes for a given proposal: (required_yes_votes, yes_voters, no_voters).
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='councilVoting'></a>councilVoting
### councilVoting
▸ **cooloffPeriod**(): `BlockNumber` ▸ **cooloffPeriod**(): `BlockNumber`
@@ -211,9 +211,9 @@ ___
▸ **votingPeriod**(): `BlockNumber` ▸ **votingPeriod**(): `BlockNumber`
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='democracy'></a>democracy
### democracy
▸ **bondage**(`AccountId`): `BlockNumber` ▸ **bondage**(`AccountId`): `BlockNumber`
- **summary**: The block at which the `who`'s funds become liquid. - **summary**: The block at which the `who`'s funds become liquid.
@@ -261,9 +261,9 @@ ___
- **summary**: How often (in blocks) to check for new votes. - **summary**: How often (in blocks) to check for new votes.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='fees'></a>fees
### fees
▸ **currentTransactionFee**(`u32`): `AssetOf` ▸ **currentTransactionFee**(`u32`): `AssetOf`
- **summary**: The `extrinsic_index => accumulated_fees` map, containing records to track the overall charged fees for each transaction. All records should be removed at finalise stage. - **summary**: The `extrinsic_index => accumulated_fees` map, containing records to track the overall charged fees for each transaction. All records should be removed at finalise stage.
@@ -275,16 +275,16 @@ ___
- **summary**: The fee to be paid for making a transaction; the per-byte portion. - **summary**: The fee to be paid for making a transaction; the per-byte portion.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='grandpaFinality'></a>grandpaFinality
### grandpaFinality
▸ **pendingChange**(): `Option<StoredPendingChange>` ▸ **pendingChange**(): `Option<StoredPendingChange>`
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='indices'></a>indices
### indices
▸ **enumSet**(`AccountIndex`): `Vec<AccountId>` ▸ **enumSet**(`AccountIndex`): `Vec<AccountId>`
- **summary**: The enumeration sets. - **summary**: The enumeration sets.
@@ -293,9 +293,9 @@ ___
- **summary**: The next free enumeration set. - **summary**: The next free enumeration set.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='session'></a>session
### session
▸ **currentIndex**(): `BlockNumber` ▸ **currentIndex**(): `BlockNumber`
- **summary**: Current index of the session. - **summary**: Current index of the session.
@@ -322,9 +322,9 @@ ___
- **summary**: The current set of validators. - **summary**: The current set of validators.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='staking'></a>staking
### staking
▸ **bondage**(`AccountId`): `BlockNumber` ▸ **bondage**(`AccountId`): `BlockNumber`
- **summary**: The block at which the `who`'s funds become entirely liquid. - **summary**: The block at which the `who`'s funds become entirely liquid.
@@ -396,16 +396,16 @@ ___
- **summary**: Preferences that a validator has. - **summary**: Preferences that a validator has.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='sudo'></a>sudo
### sudo
▸ **key**(): `AccountId` ▸ **key**(): `AccountId`
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='system'></a>system
### system
▸ **accountNonce**(`AccountId`): `Index` ▸ **accountNonce**(`AccountId`): `Index`
@@ -431,9 +431,9 @@ ___
▸ **randomSeed**(): `Hash` ▸ **randomSeed**(): `Hash`
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='timestamp'></a>timestamp
### timestamp
▸ **blockPeriod**(): `Moment` ▸ **blockPeriod**(): `Moment`
- **summary**: The minimum (and advised) period between blocks. - **summary**: The minimum (and advised) period between blocks.
@@ -445,9 +445,9 @@ ___
- **summary**: Current time for the current block. - **summary**: Current time for the current block.
___ ___
<a href='#top' style='float: right; font-size: 1.6rem; font-weight: bold;'>Back To Top</a>
### <a id='treasury'></a>treasury
### treasury
▸ **approvals**(): `Vec<ProposalIndex>` ▸ **approvals**(): `Vec<ProposalIndex>`
- **summary**: Proposal indices that have been approved but not yet awarded. - **summary**: Proposal indices that have been approved but not yet awarded.
docs/SUMMARY.html
+21
View File
File diff suppressed because one or more lines are too long
docs/api-derive/README.md
+5
View File
@@ -4,3 +4,8 @@
Common functions used across Polkadot, derived from RPC calls and storage queries. Common functions used across Polkadot, derived from RPC calls and storage queries.
Classes
-------
[Classes](SUMMARY.md)
docs/api-derive/SUMMARY.html
+21
View File
File diff suppressed because one or more lines are too long
docs/api-derive/SUMMARY.md
-13
View File
@@ -1,10 +1,8 @@
* [&quot;accounts/idAndIndex&quot;](modules/_accounts_idandindex_.md) * [&quot;accounts/idAndIndex&quot;](modules/_accounts_idandindex_.md)
* [&quot;accounts/idToIndex&quot;](modules/_accounts_idtoindex_.md) * [&quot;accounts/idToIndex&quot;](modules/_accounts_idtoindex_.md)
* [&quot;accounts/index&quot;](modules/_accounts_index_.md)
* [&quot;accounts/indexToId&quot;](modules/_accounts_indextoid_.md) * [&quot;accounts/indexToId&quot;](modules/_accounts_indextoid_.md)
* [&quot;accounts/indexes&quot;](modules/_accounts_indexes_.md) * [&quot;accounts/indexes&quot;](modules/_accounts_indexes_.md)
* [&quot;balances/fees&quot;](modules/_balances_fees_.md) * [&quot;balances/fees&quot;](modules/_balances_fees_.md)
* [&quot;balances/index&quot;](modules/_balances_index_.md)
* [&quot;balances/validatingBalance&quot;](modules/_balances_validatingbalance_.md) * [&quot;balances/validatingBalance&quot;](modules/_balances_validatingbalance_.md)
* [&quot;balances/validatingBalances&quot;](modules/_balances_validatingbalances_.md) * [&quot;balances/validatingBalances&quot;](modules/_balances_validatingbalances_.md)
* [&quot;balances/votingBalance&quot;](modules/_balances_votingbalance_.md) * [&quot;balances/votingBalance&quot;](modules/_balances_votingbalance_.md)
@@ -14,28 +12,17 @@
* [&quot;chain/bestNumberFinalised&quot;](modules/_chain_bestnumberfinalised_.md) * [&quot;chain/bestNumberFinalised&quot;](modules/_chain_bestnumberfinalised_.md)
* [&quot;chain/bestNumberLag&quot;](modules/_chain_bestnumberlag_.md) * [&quot;chain/bestNumberLag&quot;](modules/_chain_bestnumberlag_.md)
* [&quot;chain/getHeader&quot;](modules/_chain_getheader_.md) * [&quot;chain/getHeader&quot;](modules/_chain_getheader_.md)
* [&quot;chain/index&quot;](modules/_chain_index_.md)
* [&quot;chain/subscribeNewHead&quot;](modules/_chain_subscribenewhead_.md) * [&quot;chain/subscribeNewHead&quot;](modules/_chain_subscribenewhead_.md)
* [&quot;democracy/index&quot;](modules/_democracy_index_.md)
* [&quot;democracy/referendumInfo&quot;](modules/_democracy_referenduminfo_.md) * [&quot;democracy/referendumInfo&quot;](modules/_democracy_referenduminfo_.md)
* [ReferendumInfoExtended](classes/_democracy_referenduminfo_.referenduminfoextended.md) * [ReferendumInfoExtended](classes/_democracy_referenduminfo_.referenduminfoextended.md)
* [&quot;democracy/referendumInfos&quot;](modules/_democracy_referenduminfos_.md) * [&quot;democracy/referendumInfos&quot;](modules/_democracy_referenduminfos_.md)
* [&quot;democracy/referendumVotesFor&quot;](modules/_democracy_referendumvotesfor_.md) * [&quot;democracy/referendumVotesFor&quot;](modules/_democracy_referendumvotesfor_.md)
* [&quot;democracy/referendums&quot;](modules/_democracy_referendums_.md) * [&quot;democracy/referendums&quot;](modules/_democracy_referendums_.md)
* [&quot;democracy/votes&quot;](modules/_democracy_votes_.md) * [&quot;democracy/votes&quot;](modules/_democracy_votes_.md)
* [&quot;index&quot;](modules/_index_.md)
* [Derive](interfaces/_index_.derive.md)
* [DeriveCustom](interfaces/_index_.derivecustom.md)
* [DeriveCustomMethod](interfaces/_index_.derivecustommethod.md)
* [&quot;index.spec&quot;](modules/_index_spec_.md)
* [&quot;session/eraLength&quot;](modules/_session_eralength_.md) * [&quot;session/eraLength&quot;](modules/_session_eralength_.md)
* [&quot;session/eraProgress&quot;](modules/_session_eraprogress_.md) * [&quot;session/eraProgress&quot;](modules/_session_eraprogress_.md)
* [&quot;session/index&quot;](modules/_session_index_.md)
* [&quot;session/sessionProgress&quot;](modules/_session_sessionprogress_.md) * [&quot;session/sessionProgress&quot;](modules/_session_sessionprogress_.md)
* [&quot;staking/index&quot;](modules/_staking_index_.md)
* [&quot;staking/intentionsBalances&quot;](modules/_staking_intentionsbalances_.md) * [&quot;staking/intentionsBalances&quot;](modules/_staking_intentionsbalances_.md)
* [&quot;types&quot;](modules/_types_.md) * [&quot;types&quot;](modules/_types_.md)
* [&quot;util/cache&quot;](modules/_util_cache_.md) * [&quot;util/cache&quot;](modules/_util_cache_.md)
* [&quot;util/cache.spec&quot;](modules/_util_cache_spec_.md)
* [&quot;util/drr&quot;](modules/_util_drr_.md) * [&quot;util/drr&quot;](modules/_util_drr_.md)
* [&quot;util/drr.spec&quot;](modules/_util_drr_spec_.md)
docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html
+20 -3433
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* *Overrides ReferendumInfo.__constructor*
*Defined in [democracy/referendumInfo.ts:20](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/democracy/referendumInfo.ts#L20)* *Defined in [democracy/referendumInfo.ts:20](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/democracy/referendumInfo.ts#L20)*
**Parameters:** **Parameters:**
@@ -77,7 +77,7 @@ ___
*Inherited from Struct.Type* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L160)*
*__description__*: Returns the Type description to sthe structure *__description__*: Returns the Type description to sthe structure
@@ -92,7 +92,7 @@ ___
*Inherited from ReferendumInfo.delay* *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/0b9484f/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/73a5ea1/packages/types/src/type/ReferendumInfo.ts#L58)*
*__description__*: The delay (in blocks) to wait after a successful referendum before deploying *__description__*: The delay (in blocks) to wait after a successful referendum before deploying
@@ -107,7 +107,7 @@ ___
*Inherited from Struct.encodedLength* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L167)*
*__description__*: The length of the value when encoded as a Uint8Array *__description__*: The length of the value when encoded as a Uint8Array
@@ -122,7 +122,7 @@ ___
*Inherited from ReferendumInfo.end* *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/0b9484f/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/73a5ea1/packages/types/src/type/ReferendumInfo.ts#L37)*
*__description__*: When voting on this referendum will end *__description__*: When voting on this referendum will end
@@ -135,7 +135,7 @@ ___
**get index**(): `ReferendumIndex` **get index**(): `ReferendumIndex`
*Defined in [democracy/referendumInfo.ts:33](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/democracy/referendumInfo.ts#L33)* *Defined in [democracy/referendumInfo.ts:33](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/democracy/referendumInfo.ts#L33)*
*__description__*: Convenience getter, returns the referendumIndex *__description__*: Convenience getter, returns the referendumIndex
@@ -150,7 +150,7 @@ ___
*Inherited from Struct.isEmpty* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Checks if the value is an empty value *__description__*: Checks if the value is an empty value
@@ -165,7 +165,7 @@ ___
*Inherited from ReferendumInfo.proposal* *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/0b9484f/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/73a5ea1/packages/types/src/type/ReferendumInfo.ts#L44)*
*__description__*: The proposal being voted on *__description__*: The proposal being voted on
@@ -180,7 +180,7 @@ ___
*Inherited from ReferendumInfo.threshold* *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/0b9484f/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/73a5ea1/packages/types/src/type/ReferendumInfo.ts#L51)*
*__description__*: The thresholding mechanism to determine whether it passed *__description__*: The thresholding mechanism to determine whether it passed
@@ -260,7 +260,7 @@ ___
*Inherited from Struct.eq* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L176)*
*__description__*: Compares the value of the input to see if there is a match *__description__*: Compares the value of the input to see if there is a match
@@ -303,7 +303,7 @@ ___
*Overrides Map.get* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L184)*
*__description__*: Returns a specific names entry in the structure *__description__*: Returns a specific names entry in the structure
@@ -324,7 +324,7 @@ ___
*Inherited from Struct.getAtIndex* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L191)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) *__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* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L198)*
*__description__*: Converts the Object to an standard JavaScript Array *__description__*: Converts the Object to an standard JavaScript Array
@@ -414,7 +414,7 @@ ___
*Inherited from Struct.toHex* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L205)*
*__description__*: Returns a hex string representation of the value *__description__*: Returns a hex string representation of the value
@@ -429,7 +429,7 @@ ___
*Overrides Struct.toJSON* *Overrides Struct.toJSON*
*Defined in [democracy/referendumInfo.ts:40](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/democracy/referendumInfo.ts#L40)* *Defined in [democracy/referendumInfo.ts:40](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/democracy/referendumInfo.ts#L40)*
*__description__*: Creates the JSON representation *__description__*: Creates the JSON representation
@@ -444,7 +444,7 @@ ___
*Inherited from Struct.toString* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L226)*
*__description__*: Returns the string representation of the value *__description__*: Returns the string representation of the value
@@ -459,7 +459,7 @@ ___
*Inherited from Struct.toU8a* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L234)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -495,7 +495,7 @@ ___
*Inherited from Struct.with* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L125)*
**Type parameters:** **Type parameters:**
docs/api-derive/index.html
+21
View File
File diff suppressed because one or more lines are too long
docs/api-derive/interfaces/_index_.derive.md
-63
View File
@@ -1,63 +0,0 @@
# Hierarchy
**Derive**
# Properties
<a id="accounts"></a>
## accounts
**● accounts**: *`ReturnTypes`<[&quot;accounts/index&quot;](../modules/_accounts_index_.md)>*
*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/index.ts#L38)*
___
<a id="balances"></a>
## balances
**● balances**: *`ReturnTypes`<[&quot;balances/index&quot;](../modules/_balances_index_.md)>*
*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/index.ts#L39)*
___
<a id="chain"></a>
## chain
**● chain**: *`ReturnTypes`<[&quot;chain/index&quot;](../modules/_chain_index_.md)>*
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/index.ts#L40)*
___
<a id="democracy"></a>
## democracy
**● democracy**: *`ReturnTypes`<[&quot;democracy/index&quot;](../modules/_democracy_index_.md)>*
*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/index.ts#L41)*
___
<a id="session"></a>
## session
**● session**: *`ReturnTypes`<[&quot;session/index&quot;](../modules/_session_index_.md)>*
*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/index.ts#L42)*
___
<a id="staking"></a>
## staking
**● staking**: *`ReturnTypes`<[&quot;staking/index&quot;](../modules/_staking_index_.md)>*
*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/index.ts#L43)*
___
docs/api-derive/interfaces/_index_.derivecustom.md
-12
View File
@@ -1,12 +0,0 @@
# Hierarchy
**DeriveCustom**
# Indexable
\[index: `string`\]:&nbsp;`object`
[index: `string`]: [DeriveCustomMethod](_index_.derivecustommethod.md)
docs/api-derive/interfaces/_index_.derivecustommethod.md
-19
View File
@@ -1,19 +0,0 @@
# Hierarchy
**DeriveCustomMethod**
# Callable
▸ **__call**(api: *`ApiInterface$Rx`*): `function`
*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/index.ts#L27)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| api | `ApiInterface$Rx` |
**Returns:** `function`
docs/api-derive/modules/_accounts_idandindex_.html
+21
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`]* **Ƭ AccountIdAndIndex**: *[`undefined` \| `AccountId`, `undefined` \| `AccountIndex`]*
*Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/accounts/idAndIndex.ts#L16)* *Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/accounts/idAndIndex.ts#L16)*
___ ___
@@ -20,7 +20,7 @@ ___
▸ **idAndIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **idAndIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/accounts/idAndIndex.ts#L18)* *Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/accounts/idAndIndex.ts#L18)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_accounts_idtoindex_.html
+21
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)` ▸ **idToIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/accounts/idToIndex.ts#L13)* *Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/accounts/idToIndex.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_accounts_index_.md
-2
View File
@@ -1,2 +0,0 @@
docs/api-derive/modules/_accounts_indexes_.html
+21
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`* **Ƭ AccountIndexes**: *`object`*
*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/accounts/indexes.ts#L13)* *Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/accounts/indexes.ts#L13)*
#### Type declaration #### Type declaration
@@ -24,7 +24,7 @@ ___
▸ **indexes**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **indexes**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/accounts/indexes.ts#L15)* *Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/accounts/indexes.ts#L15)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_accounts_indextoid_.html
+21
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)` ▸ **indexToId**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [accounts/indexToId.ts:13](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/accounts/indexToId.ts#L13)* *Defined in [accounts/indexToId.ts:13](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/accounts/indexToId.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_fees_.html
+21
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)` ▸ **fees**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/balances/fees.ts#L13)* *Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/balances/fees.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_index_.md
-2
View File
@@ -1,2 +0,0 @@
docs/api-derive/modules/_balances_validatingbalance_.html
+21
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)` ▸ **validatingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/balances/validatingBalance.ts#L16)* *Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/balances/validatingBalance.ts#L16)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_validatingbalances_.html
+21
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)` ▸ **validatingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/balances/validatingBalances.ts#L14)* *Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/balances/validatingBalances.ts#L14)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_votingbalance_.html
+21
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)` ▸ **votingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/balances/votingBalance.ts#L16)* *Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/balances/votingBalance.ts#L16)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_votingbalances_.html
+21
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)` ▸ **votingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/balances/votingBalances.ts#L13)* *Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/balances/votingBalances.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.html
+21
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)` ▸ **votingBalancesNominatorsFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [balances/votingBalancesNominatorsFor.ts:15](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L15)* *Defined in [balances/votingBalancesNominatorsFor.ts:15](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L15)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_chain_bestnumber_.html
+24
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)` ▸ **bestNumber**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/chain/bestNumber.ts#L23)* *Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/chain/bestNumber.ts#L23)*
*__description__*: Get the latest block number. *__description__*: Get the latest block number.
docs/api-derive/modules/_chain_bestnumberfinalised_.html
+24
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)` ▸ **bestNumberFinalised**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)* *Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)*
*__description__*: Get the latest finalised block number. example *__description__*: Get the latest finalised block number. example
docs/api-derive/modules/_chain_bestnumberlag_.html
+24
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)` ▸ **bestNumberLag**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/chain/bestNumberLag.ts#L25)* *Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/chain/bestNumberLag.ts#L25)*
*__description__*: Calculates the lag between finalised head and best head *__description__*: Calculates the lag between finalised head and best head
docs/api-derive/modules/_chain_getheader_.html
+24
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)` ▸ **getHeader**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/chain/getHeader.ts#L25)* *Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/chain/getHeader.ts#L25)*
*__description__*: Get the a specific block header and extend it with the author *__description__*: Get the a specific block header and extend it with the author
docs/api-derive/modules/_chain_index_.md
-2
View File
@@ -1,2 +0,0 @@
docs/api-derive/modules/_chain_subscribenewhead_.html
+24
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`>]* **Ƭ HeaderAndValidators**: *[`Header`, `Array`<`AccountId`>]*
*Defined in [chain/subscribeNewHead.ts:12](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/chain/subscribeNewHead.ts#L12)* *Defined in [chain/subscribeNewHead.ts:12](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/chain/subscribeNewHead.ts#L12)*
___ ___
@@ -20,7 +20,7 @@ ___
▸ **subscribeNewHead**(api: *`ApiInterface$Rx`*): `(Anonymous function)` ▸ **subscribeNewHead**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [chain/subscribeNewHead.ts:25](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/chain/subscribeNewHead.ts#L25)* *Defined in [chain/subscribeNewHead.ts:25](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/chain/subscribeNewHead.ts#L25)*
*__description__*: Subscribe to block headers and extend it with the author *__description__*: Subscribe to block headers and extend it with the author
docs/api-derive/modules/_democracy_index_.md
-2
View File
@@ -1,2 +0,0 @@
docs/api-derive/modules/_democracy_referenduminfo_.html
+21
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)` ▸ **referendumInfo**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/referendumInfo.ts:48](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/democracy/referendumInfo.ts#L48)* *Defined in [democracy/referendumInfo.ts:48](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/democracy/referendumInfo.ts#L48)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_democracy_referenduminfos_.html
+21
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)` ▸ **referendumInfos**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/democracy/referendumInfos.ts#L13)* *Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/democracy/referendumInfos.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_democracy_referendums_.html
+21
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)` ▸ **referendums**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/referendums.ts:14](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/democracy/referendums.ts#L14)* *Defined in [democracy/referendums.ts:14](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/democracy/referendums.ts#L14)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_democracy_referendumvotesfor_.html
+21
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)` ▸ **referendumVotesFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/referendumVotesFor.ts:16](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/democracy/referendumVotesFor.ts#L16)* *Defined in [democracy/referendumVotesFor.ts:16](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/democracy/referendumVotesFor.ts#L16)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_democracy_votes_.html
+21
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)` ▸ **votes**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/democracy/votes.ts#L12)* *Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/democracy/votes.ts#L12)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_index_.md
-37
View File
@@ -1,37 +0,0 @@
# Index
### Interfaces
* [Derive](../interfaces/_index_.derive.md)
* [DeriveCustom](../interfaces/_index_.derivecustom.md)
* [DeriveCustomMethod](../interfaces/_index_.derivecustommethod.md)
### Functions
* [decorateDerive](_index_.md#decoratederive)
---
# Functions
<a id="decoratederive"></a>
## decorateDerive
▸ **decorateDerive**(api: *`ApiInterface$Rx`*, custom?: *[DeriveCustom](../interfaces/_index_.derivecustom.md)*): [Derive](../interfaces/_index_.derive.md)
*Defined in [index.ts:65](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/index.ts#L65)*
**Parameters:**
| Name | Type | Default value |
| ------ | ------ | ------ |
| api | `ApiInterface$Rx` | - |
| `Default value` custom | [DeriveCustom](../interfaces/_index_.derivecustom.md) | {} |
**Returns:** [Derive](../interfaces/_index_.derive.md)
___
docs/api-derive/modules/_index_spec_.md
-2
View File
@@ -1,2 +0,0 @@
docs/api-derive/modules/_session_eralength_.html
+21
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)` ▸ **eraLength**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/session/eraLength.ts#L13)* *Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/session/eraLength.ts#L13)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_session_eraprogress_.html
+21
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)` ▸ **eraProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/session/eraProgress.ts#L14)* *Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/session/eraProgress.ts#L14)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_session_index_.md
-2
View File
@@ -1,2 +0,0 @@
docs/api-derive/modules/_session_sessionprogress_.html
+21
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)` ▸ **sessionProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/session/sessionProgress.ts#L14)* *Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/session/sessionProgress.ts#L14)*
**Parameters:** **Parameters:**
docs/api-derive/modules/_staking_index_.md
-2
View File
@@ -1,2 +0,0 @@
docs/api-derive/modules/_staking_intentionsbalances_.html
+21
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)` ▸ **intentionsBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
*Defined in [staking/intentionsBalances.ts:17](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/staking/intentionsBalances.ts#L17)* *Defined in [staking/intentionsBalances.ts:17](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/staking/intentionsBalances.ts#L17)*
Get the balances for all intentions and their nominators Get the balances for all intentions and their nominators
docs/api-derive/modules/_types_.html
+21
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`* **Ƭ DerivedBalances**: *`object`*
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/types.ts#L8)* *Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/types.ts#L8)*
#### Type declaration #### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ DerivedBalancesMap**: *`object`* **Ƭ DerivedBalancesMap**: *`object`*
*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/types.ts#L26)* *Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/types.ts#L26)*
#### Type declaration #### Type declaration
@@ -32,7 +32,7 @@ ___
**Ƭ DerivedFees**: *`object`* **Ƭ DerivedFees**: *`object`*
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/types.ts#L18)* *Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/types.ts#L18)*
#### Type declaration #### Type declaration
@@ -43,7 +43,7 @@ ___
**Ƭ DerivedReferendumVote**: *`object`* **Ƭ DerivedReferendumVote**: *`object`*
*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/types.ts#L30)* *Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/types.ts#L30)*
#### Type declaration #### Type declaration
docs/api-derive/modules/_util_cache_.html
+21
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)` ▸ **cache**(fn: *`Function`*, map?: *`WeakMap`<`object`, `any`>*): `(Anonymous function)`
*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/0b9484f/packages/api-derive/src/util/cache.ts#L23)* *Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api-derive/src/util/cache.ts#L23)*
Create memoization for a 2-currified function. Create memoization for a 2-currified function.
docs/api-derive/modules/_util_cache_spec_.md
-2
View File
@@ -1,2 +0,0 @@
docs/api-derive/modules/_util_drr_.html
+21
View File
File diff suppressed because one or more lines are too long
docs/api-derive/modules/_util_drr_spec_.md
-2
View File
@@ -1,2 +0,0 @@
docs/api/README.md
+8 -2
View File
@@ -20,8 +20,8 @@ API Selection
There are two flavours of the API provided, one allowing a standard interface via JavaScript Promises and the second provides an Observable wrapper using [RxJS](https://github.com/ReactiveX/rxjs). Depending on your use-case and familiarity, you can choose either (or even both) for your application. There are two flavours of the API provided, one allowing a standard interface via JavaScript Promises and the second provides an Observable wrapper using [RxJS](https://github.com/ReactiveX/rxjs). Depending on your use-case and familiarity, you can choose either (or even both) for your application.
* [ApiPromise](classes/_promise_index_.apipromise.md) All interface calls returns Promises, including the static `.create(...)`. Additionally any subscription method uses `(value) => {}` callbacks, returning the value as the subscription is updated. * [ApiPromise](classes/_promise_api_.apipromise.md) All interface calls returns Promises, including the static `.create(...)`. Additionally any subscription method uses `(value) => {}` callbacks, returning the value as the subscription is updated.
* [ApiRx](classes/_rx_index_.apirx.md) All interface calls return RxJS Observables, including the static `.create(...)`. In the same fashion subscription-based methods return long-running Observables that update with the latest values. * [ApiRx](classes/_rx_api_.apirx.md) All interface calls return RxJS Observables, including the static `.create(...)`. In the same fashion subscription-based methods return long-running Observables that update with the latest values.
Dynamic by default Dynamic by default
------------------ ------------------
@@ -98,4 +98,10 @@ Some of the users of the API (let us know if you are missing from the list), inc
* [Polkadot-JS UI](https://github.com/polkadot-js/apps) A user-interface that allows you to make transactions, query the network or participate in actions on the network such as referendums and staking * [Polkadot-JS UI](https://github.com/polkadot-js/apps) A user-interface that allows you to make transactions, query the network or participate in actions on the network such as referendums and staking
* [Polkabot](https://gitlab.com/Polkabot) Polkabot is a Matrix chatbot that keeps an eye on the Polkadot network. You can see Polkabot in action in [https://matrix.to/#/#polkadot-network-status:matrix.org](https://matrix.to/#/#polkadot-network-status:matrix.org) * [Polkabot](https://gitlab.com/Polkabot) Polkabot is a Matrix chatbot that keeps an eye on the Polkadot network. You can see Polkabot in action in [https://matrix.to/#/#polkadot-network-status:matrix.org](https://matrix.to/#/#polkadot-network-status:matrix.org)
* [Polkawallet.io](https://polkawallet.io) and [Polkawallet (Github)](https://github.com/polkawallet-io/polkawallet-RN/) A mobile wallet for the Polkadot network to manage funds and make transactions, available on both Androind and iOS
Classes
-------
[Classes](SUMMARY.md)
docs/api/SUMMARY.html
+21
View File
File diff suppressed because one or more lines are too long
docs/api/SUMMARY.md
+4 -6
View File
@@ -4,16 +4,14 @@
* [SubmittableExtrinsic](classes/_submittableextrinsic_.submittableextrinsic.md) * [SubmittableExtrinsic](classes/_submittableextrinsic_.submittableextrinsic.md)
* [SubmittableResult](classes/_submittableextrinsic_.submittableresult.md) * [SubmittableResult](classes/_submittableextrinsic_.submittableresult.md)
* [&quot;checkTypes.manual&quot;](modules/_checktypes_manual_.md) * [&quot;checkTypes.manual&quot;](modules/_checktypes_manual_.md)
* [&quot;index&quot;](modules/_index_.md) * [&quot;promise/Api&quot;](modules/_promise_api_.md)
* [ApiPromise](classes/_promise_api_.apipromise.md)
* [&quot;promise/Combinator&quot;](modules/_promise_combinator_.md) * [&quot;promise/Combinator&quot;](modules/_promise_combinator_.md)
* [Combinator](classes/_promise_combinator_.combinator.md) * [Combinator](classes/_promise_combinator_.combinator.md)
* [&quot;promise/Combinators.spec&quot;](modules/_promise_combinators_spec_.md)
* [&quot;promise/index&quot;](modules/_promise_index_.md)
* [ApiPromise](classes/_promise_index_.apipromise.md)
* [&quot;promise/types&quot;](modules/_promise_types_.md) * [&quot;promise/types&quot;](modules/_promise_types_.md)
* [ApiPromiseInterface](interfaces/_promise_types_.apipromiseinterface.md) * [ApiPromiseInterface](interfaces/_promise_types_.apipromiseinterface.md)
* [&quot;rx/index&quot;](modules/_rx_index_.md) * [&quot;rx/Api&quot;](modules/_rx_api_.md)
* [ApiRx](classes/_rx_index_.apirx.md) * [ApiRx](classes/_rx_api_.apirx.md)
* [&quot;rx/types&quot;](modules/_rx_types_.md) * [&quot;rx/types&quot;](modules/_rx_types_.md)
* [ApiRxInterface](interfaces/_rx_types_.apirxinterface.md) * [ApiRxInterface](interfaces/_rx_types_.apirxinterface.md)
* [&quot;types&quot;](modules/_types_.md) * [&quot;types&quot;](modules/_types_.md)
docs/api/classes/_base_.apibase.html
+56
View File
File diff suppressed because one or more lines are too long
docs/api/classes/_base_.apibase.md
+18 -18
View File
@@ -11,9 +11,9 @@
↳ [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md) ↳ [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md)
↳ [ApiPromise](_promise_index_.apipromise.md) ↳ [ApiPromise](_promise_api_.apipromise.md)
↳ [ApiRx](_rx_index_.apirx.md) ↳ [ApiRx](_rx_api_.apirx.md)
# Implements # Implements
@@ -27,7 +27,7 @@
⊕ **new ApiBase**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*, type: *[ApiType](../modules/_types_.md#apitype)*): [ApiBase](_base_.apibase.md) ⊕ **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/0b9484f/packages/api/src/Base.ts#L81)* *Defined in [Base.ts:81](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L81)*
*__description__*: Create an instance of the class *__description__*: Create an instance of the class
@@ -62,7 +62,7 @@ ___
**get derive**(): [Derive](../interfaces/_types_.derive.md)<`CodecResult`, `SubscriptionResult`> **get derive**(): [Derive](../interfaces/_types_.derive.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L196)* *Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L196)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. *__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -83,7 +83,7 @@ ___
**get genesisHash**(): `Hash` **get genesisHash**(): `Hash`
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L132)* *Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__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` **get hasSubscriptions**(): `boolean`
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L141)* *Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L141)*
*__description__*: `true` when subscriptions are supported *__description__*: `true` when subscriptions are supported
@@ -109,7 +109,7 @@ ___
**get libraryInfo**(): `string` **get libraryInfo**(): `string`
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L148)* *Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L148)*
*__description__*: The library information name & version (from package.json) *__description__*: The library information name & version (from package.json)
@@ -122,7 +122,7 @@ ___
**get query**(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`> **get query**(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L216)* *Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__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`> **get rpc**(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L236)* *Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__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` **get runtimeMetadata**(): `Metadata`
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L155)* *Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__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` **get runtimeVersion**(): `RuntimeVersion`
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L164)* *Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L164)*
*__description__*: Contains the version information for the current runtime. *__description__*: Contains the version information for the current runtime.
@@ -194,7 +194,7 @@ ___
**get tx**(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`> **get tx**(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`>
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L254)* *Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__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) **get type**(): [ApiType](../modules/_types_.md#apitype)
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L173)* *Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L173)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise' *__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -233,7 +233,7 @@ ___
▸ **disconnect**(): `void` ▸ **disconnect**(): `void`
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L263)* *Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L263)*
*__description__*: Disconnect from the underlying provider, halting all comms *__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` ▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L286)* *Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L286)*
*__description__*: Attach an eventemitter handler to listen to a specific event *__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` ▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this`
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L311)* *Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L311)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event *__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -310,7 +310,7 @@ ___
▸ **registerTypes**(types?: *`RegistryTypes`*): `void` ▸ **registerTypes**(types?: *`RegistryTypes`*): `void`
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L320)* *Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L320)*
*__description__*: Register additional user-defined of chain-specific types in the type registry *__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` ▸ **setSigner**(signer: *[Signer](../interfaces/_types_.signer.md)*): `void`
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L180)* *Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/73a5ea1/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 *__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
+122
View File
File diff suppressed because one or more lines are too long
docs/api/classes/_promise_index_.apipromise.md → docs/api/classes/_promise_api_.apipromise.md
+31 -32
View File
@@ -12,7 +12,7 @@ Overview
The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Polkadot (and Substrate) clients. The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Polkadot (and Substrate) clients.
*__see__*: [ApiRx](_rx_index_.apirx.md) *__see__*: [ApiRx](_rx_api_.apirx.md)
Usage Usage
----- -----
@@ -36,8 +36,7 @@ api.rpc.chain.subscribeNewHead((header) => {
Subscribing to chain state - Subscribing to chain state -
```javascript ```javascript
import { ApiPromise } from '@polkadot/api'; import { ApiPromise, WsProvider } from '@polkadot/api';
import WsProvider from '@polkadot/rpc-provider/ws';
// initialise a provider with a specific endpoint // initialise a provider with a specific endpoint
const provider = new WsProvider('wss://example.com:9944') const provider = new WsProvider('wss://example.com:9944')
@@ -103,11 +102,11 @@ ApiPromise.create().then((api) => {
## constructor ## constructor
⊕ **new ApiPromise**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): [ApiPromise](_promise_index_.apipromise.md) ⊕ **new ApiPromise**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): [ApiPromise](_promise_api_.apipromise.md)
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/promise/index.ts#L128)* *Defined in [promise/Api.ts:127](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/promise/Api.ts#L127)*
*__description__*: Creates an instance of the ApiPromise class *__description__*: Creates an instance of the ApiPromise class
@@ -127,9 +126,9 @@ new Api().isReady.then((api) => {
| Name | Type | Description | | Name | Type | Description |
| ------ | ------ | ------ | | ------ | ------ | ------ |
| `Optional` options | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | Options to create an instance. This can be either [ApiOptions](../interfaces/_types_.apioptions.md) or an \[\[HttpProvider\]\] or \[\[WsProvider\]\]. In the case of \[\[HttpProvider\]\] subscriptions are not supported, only latest values are returned. | | `Optional` options | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | Options to create an instance. This can be either [ApiOptions](../interfaces/_types_.apioptions.md) or an \[\[WsProvider\]\]. |
**Returns:** [ApiPromise](_promise_index_.apipromise.md) **Returns:** [ApiPromise](_promise_api_.apipromise.md)
___ ___
@@ -143,7 +142,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)* *Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)*
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L196)* *Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L196)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. *__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -166,7 +165,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L132)* *Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
@@ -181,7 +180,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* *Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L141)* *Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L141)*
*__description__*: `true` when subscriptions are supported *__description__*: `true` when subscriptions are supported
@@ -192,13 +191,13 @@ ___
## isReady ## isReady
**get isReady**(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> **get isReady**(): `Promise`<[ApiPromise](_promise_api_.apipromise.md)>
*Defined in [promise/index.ts:163](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/promise/index.ts#L163)* *Defined in [promise/Api.ts:161](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/promise/Api.ts#L161)*
*__description__*: Promise that returns the first time we are connected and loaded *__description__*: Promise that returns the first time we are connected and loaded
**Returns:** `Promise`<[ApiPromise](_promise_index_.apipromise.md)> **Returns:** `Promise`<[ApiPromise](_promise_api_.apipromise.md)>
___ ___
<a id="libraryinfo"></a> <a id="libraryinfo"></a>
@@ -209,7 +208,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[libraryInfo](_base_.apibase.md#libraryinfo)* *Inherited from [ApiBase](_base_.apibase.md).[libraryInfo](_base_.apibase.md#libraryinfo)*
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L148)* *Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L148)*
*__description__*: The library information name & version (from package.json) *__description__*: The library information name & version (from package.json)
@@ -224,7 +223,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L216)* *Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -249,7 +248,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L236)* *Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__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.
@@ -274,7 +273,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L155)* *Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -289,7 +288,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L164)* *Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L164)*
*__description__*: Contains the version information for the current runtime. *__description__*: Contains the version information for the current runtime.
@@ -304,7 +303,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L254)* *Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__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.
@@ -329,7 +328,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)* *Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L173)* *Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L173)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise' *__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -343,13 +342,13 @@ ___
## clone ## clone
▸ **clone**(): [ApiPromise](_promise_index_.apipromise.md) ▸ **clone**(): [ApiPromise](_promise_api_.apipromise.md)
*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/promise/index.ts#L170)* *Defined in [promise/Api.ts:168](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/promise/Api.ts#L168)*
*__description__*: Returns a clone of this ApiPromise instance (new underlying provider connection) *__description__*: Returns a clone of this ApiPromise instance (new underlying provider connection)
**Returns:** [ApiPromise](_promise_index_.apipromise.md) **Returns:** [ApiPromise](_promise_api_.apipromise.md)
___ ___
<a id="combinelatest"></a> <a id="combinelatest"></a>
@@ -358,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]() ▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) \| [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [SubscriptionResult]()
*Defined in [promise/index.ts:197](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/promise/index.ts#L197)* *Defined in [promise/Api.ts:195](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/promise/Api.ts#L195)*
*__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions *__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions
@@ -397,7 +396,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)* *Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)*
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L263)* *Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L263)*
*__description__*: Disconnect from the underlying provider, halting all comms *__description__*: Disconnect from the underlying provider, halting all comms
@@ -412,7 +411,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L286)* *Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L286)*
*__description__*: Attach an eventemitter handler to listen to a specific event *__description__*: Attach an eventemitter handler to listen to a specific event
@@ -446,7 +445,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* *Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)*
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L311)* *Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L311)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event *__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -482,7 +481,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)* *Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)*
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L320)* *Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L320)*
*__description__*: Register additional user-defined of chain-specific types in the type registry *__description__*: Register additional user-defined of chain-specific types in the type registry
@@ -505,7 +504,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)* *Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)*
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L180)* *Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/73a5ea1/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 *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
@@ -522,9 +521,9 @@ ___
## `<Static>` create ## `<Static>` create
▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> ▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Promise`<[ApiPromise](_promise_api_.apipromise.md)>
*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/promise/index.ts#L126)* *Defined in [promise/Api.ts:125](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/promise/Api.ts#L125)*
*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance. *__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
@@ -546,7 +545,7 @@ Api.create().then(async (api) => {
| ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ |
| `Default value` options | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | {} | options that is passed to the class contructor. Can be either [ApiOptions](../interfaces/_types_.apioptions.md) or a provider (see the constructor arguments) | | `Default value` options | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | {} | options that is passed to the class contructor. Can be either [ApiOptions](../interfaces/_types_.apioptions.md) or a provider (see the constructor arguments) |
**Returns:** `Promise`<[ApiPromise](_promise_index_.apipromise.md)> **Returns:** `Promise`<[ApiPromise](_promise_api_.apipromise.md)>
___ ___
docs/api/classes/_promise_combinator_.combinator.html
+21
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) ⊕ **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/0b9484f/packages/api/src/promise/Combinator.ts#L21)* *Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/promise/Combinator.ts#L21)*
**Parameters:** **Parameters:**
@@ -33,7 +33,7 @@ ___
▸ **unsubscribe**(): `void` ▸ **unsubscribe**(): `void`
*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/promise/Combinator.ts#L67)* *Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/promise/Combinator.ts#L67)*
**Returns:** `void` **Returns:** `void`
docs/api/classes/_promise_index_.apipromise.html
-3463
View File
File diff suppressed because it is too large Load Diff
docs/api/classes/_rx_api_.apirx.html
+134
View File
File diff suppressed because one or more lines are too long
docs/api/classes/_rx_index_.apirx.md → docs/api/classes/_rx_api_.apirx.md
+30 -31
View File
@@ -12,7 +12,7 @@ Overview
The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Polkadot (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding `.subscribe` and `.pipe` on Observables will unlock full-scale use thereof. The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Polkadot (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding `.subscribe` and `.pipe` on Observables will unlock full-scale use thereof.
*__see__*: [ApiPromise](_promise_index_.apipromise.md) *__see__*: [ApiPromise](_promise_api_.apipromise.md)
Usage Usage
----- -----
@@ -38,8 +38,7 @@ Subscribing to chain state -
```javascript ```javascript
import { combineLatest } from 'rxjs'; import { combineLatest } from 'rxjs';
import { pairwise, switchMap } from 'rxjs/operators'; import { pairwise, switchMap } from 'rxjs/operators';
import { ApiRx } from '@polkadot/api'; import { ApiRx, WsProvider } from '@polkadot/api';
import { WsProvider } from '@polkadot/rpc-provider';
// initialise a provider with a specific endpoint // initialise a provider with a specific endpoint
const provider = new WsProvider('wss://example.com:9944') const provider = new WsProvider('wss://example.com:9944')
@@ -117,11 +116,11 @@ api.query.system
## constructor ## constructor
⊕ **new ApiRx**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): [ApiRx](_rx_index_.apirx.md) ⊕ **new ApiRx**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): [ApiRx](_rx_api_.apirx.md)
*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/rx/index.ts#L142)* *Defined in [rx/Api.ts:141](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/rx/Api.ts#L141)*
*__description__*: Create an instance of the ApiRx class *__description__*: Create an instance of the ApiRx class
@@ -147,7 +146,7 @@ new Api().isReady
| ------ | ------ | | ------ | ------ |
| `Optional` provider | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | | `Optional` provider | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` |
**Returns:** [ApiRx](_rx_index_.apirx.md) **Returns:** [ApiRx](_rx_api_.apirx.md)
___ ___
@@ -161,7 +160,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)* *Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)*
*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L196)* *Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L196)*
*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. *__description__*: Derived results that are injected into the API, allowing for combinations of various query results.
@@ -184,7 +183,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)*
*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L132)* *Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
@@ -199,7 +198,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* *Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)*
*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L141)* *Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L141)*
*__description__*: `true` when subscriptions are supported *__description__*: `true` when subscriptions are supported
@@ -212,7 +211,7 @@ ___
**get isConnected**(): `Observable`<`boolean`> **get isConnected**(): `Observable`<`boolean`>
*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/rx/index.ts#L182)* *Defined in [rx/Api.ts:181](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
@@ -223,13 +222,13 @@ ___
## isReady ## isReady
**get isReady**(): `Observable`<[ApiRx](_rx_index_.apirx.md)> **get isReady**(): `Observable`<[ApiRx](_rx_api_.apirx.md)>
*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/rx/index.ts#L189)* *Defined in [rx/Api.ts:188](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/rx/Api.ts#L188)*
*__description__*: Observable that returns the first time we are connected and loaded *__description__*: Observable that returns the first time we are connected and loaded
**Returns:** `Observable`<[ApiRx](_rx_index_.apirx.md)> **Returns:** `Observable`<[ApiRx](_rx_api_.apirx.md)>
___ ___
<a id="libraryinfo"></a> <a id="libraryinfo"></a>
@@ -240,7 +239,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[libraryInfo](_base_.apibase.md#libraryinfo)* *Inherited from [ApiBase](_base_.apibase.md).[libraryInfo](_base_.apibase.md#libraryinfo)*
*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L148)* *Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L148)*
*__description__*: The library information name & version (from package.json) *__description__*: The library information name & version (from package.json)
@@ -255,7 +254,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)*
*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L216)* *Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
@@ -280,7 +279,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)*
*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L236)* *Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__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.
@@ -305,7 +304,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)*
*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L155)* *Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
@@ -320,7 +319,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)*
*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L164)* *Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L164)*
*__description__*: Contains the version information for the current runtime. *__description__*: Contains the version information for the current runtime.
@@ -335,7 +334,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)*
*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L254)* *Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/73a5ea1/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. *__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.
@@ -360,7 +359,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)* *Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)*
*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L173)* *Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L173)*
*__description__*: The type of this API instance, either 'rxjs' or 'promise' *__description__*: The type of this API instance, either 'rxjs' or 'promise'
@@ -374,13 +373,13 @@ ___
## clone ## clone
▸ **clone**(): [ApiRx](_rx_index_.apirx.md) ▸ **clone**(): [ApiRx](_rx_api_.apirx.md)
*Defined in [rx/index.ts:196](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/rx/index.ts#L196)* *Defined in [rx/Api.ts:195](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/rx/Api.ts#L195)*
*__description__*: Returns a clone of this ApiRx instance (new underlying provider connection) *__description__*: Returns a clone of this ApiRx instance (new underlying provider connection)
**Returns:** [ApiRx](_rx_index_.apirx.md) **Returns:** [ApiRx](_rx_api_.apirx.md)
___ ___
<a id="disconnect"></a> <a id="disconnect"></a>
@@ -393,7 +392,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)* *Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)*
*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L263)* *Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L263)*
*__description__*: Disconnect from the underlying provider, halting all comms *__description__*: Disconnect from the underlying provider, halting all comms
@@ -408,7 +407,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)*
*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L286)* *Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L286)*
*__description__*: Attach an eventemitter handler to listen to a specific event *__description__*: Attach an eventemitter handler to listen to a specific event
@@ -442,7 +441,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* *Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)*
*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L311)* *Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L311)*
*__description__*: Attach an one-time eventemitter handler to listen to a specific event *__description__*: Attach an one-time eventemitter handler to listen to a specific event
@@ -478,7 +477,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)* *Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)*
*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L320)* *Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L320)*
*__description__*: Register additional user-defined of chain-specific types in the type registry *__description__*: Register additional user-defined of chain-specific types in the type registry
@@ -501,7 +500,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)* *Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)*
*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/Base.ts#L180)* *Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/73a5ea1/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 *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
@@ -518,9 +517,9 @@ ___
## `<Static>` create ## `<Static>` create
▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)> ▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Observable`<[ApiRx](_rx_api_.apirx.md)>
*Defined in [rx/index.ts:140](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/rx/index.ts#L140)* *Defined in [rx/Api.ts:139](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/rx/Api.ts#L139)*
*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance. *__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
@@ -546,7 +545,7 @@ Api.create()
| ------ | ------ | ------ | | ------ | ------ | ------ |
| `Optional` options | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | options that is passed to the class contructor. Can be either [ApiOptions](../interfaces/_types_.apioptions.md) or \[\[WsProvider\]\] | | `Optional` options | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | options that is passed to the class contructor. Can be either [ApiOptions](../interfaces/_types_.apioptions.md) or \[\[WsProvider\]\] |
**Returns:** `Observable`<[ApiRx](_rx_index_.apirx.md)> **Returns:** `Observable`<[ApiRx](_rx_api_.apirx.md)>
___ ___
docs/api/classes/_rx_index_.apirx.html
-3446
View File
File diff suppressed because it is too large Load Diff
docs/api/classes/_submittableextrinsic_.submittableextrinsic.html
+21
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* *Overrides Extrinsic.__constructor*
*Defined in [SubmittableExtrinsic.ts:62](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/SubmittableExtrinsic.ts#L62)* *Defined in [SubmittableExtrinsic.ts:62](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/SubmittableExtrinsic.ts#L62)*
**Parameters:** **Parameters:**
@@ -77,7 +77,7 @@ ___
*Inherited from Struct.Type* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L160)*
*__description__*: Returns the Type description to sthe structure *__description__*: Returns the Type description to sthe structure
@@ -92,7 +92,7 @@ ___
*Inherited from Extrinsic.args* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L76)*
*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\] *__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\]
@@ -107,7 +107,7 @@ ___
*Inherited from Extrinsic.callIndex* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L83)*
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method *__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
@@ -122,7 +122,7 @@ ___
*Inherited from Extrinsic.data* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L90)*
*__description__*: The actual data for the Method *__description__*: The actual data for the Method
@@ -139,7 +139,7 @@ ___
*Overrides Struct.encodedLength* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L97)*
*__description__*: The length of the value when encoded as a Uint8Array *__description__*: The length of the value when encoded as a Uint8Array
@@ -154,7 +154,7 @@ ___
*Inherited from Extrinsic.hash* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L106)*
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash *__description__*: Convernience function, encodes the extrinsic and returns the actual hash
@@ -169,7 +169,7 @@ ___
*Inherited from Struct.isEmpty* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Checks if the value is an empty value *__description__*: Checks if the value is an empty value
@@ -184,7 +184,7 @@ ___
*Inherited from Extrinsic.isSigned* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L115)*
*__description__*: `true` id the extrinsic is signed *__description__*: `true` id the extrinsic is signed
@@ -199,7 +199,7 @@ ___
*Inherited from Extrinsic.length* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L122)*
*__description__*: The length of the encoded value *__description__*: The length of the encoded value
@@ -214,7 +214,7 @@ ___
*Inherited from Extrinsic.meta* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L129)*
*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic *__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic
@@ -229,7 +229,7 @@ ___
*Inherited from Extrinsic.method* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L136)*
*__description__*: The \[\[Method\]\] this extrinsic wraps *__description__*: The \[\[Method\]\] this extrinsic wraps
@@ -244,7 +244,7 @@ ___
*Inherited from Extrinsic.signature* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L143)*
*__description__*: The \[\[ExtrinsicSignature\]\] *__description__*: The \[\[ExtrinsicSignature\]\]
@@ -277,7 +277,7 @@ ___
*Inherited from Extrinsic.addSignature* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L150)*
*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated) *__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated)
@@ -348,7 +348,7 @@ ___
*Inherited from Struct.eq* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L176)*
*__description__*: Compares the value of the input to see if there is a match *__description__*: Compares the value of the input to see if there is a match
@@ -391,7 +391,7 @@ ___
*Overrides Map.get* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L184)*
*__description__*: Returns a specific names entry in the structure *__description__*: Returns a specific names entry in the structure
@@ -412,7 +412,7 @@ ___
*Inherited from Struct.getAtIndex* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L191)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) *__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`> ▸ **send**(statusCb: *`function`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:135](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/SubmittableExtrinsic.ts#L135)* *Defined in [SubmittableExtrinsic.ts:135](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/SubmittableExtrinsic.ts#L135)*
**Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> **Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:136](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/SubmittableExtrinsic.ts#L136)* *Defined in [SubmittableExtrinsic.ts:136](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/SubmittableExtrinsic.ts#L136)*
**Parameters:** **Parameters:**
@@ -510,7 +510,7 @@ ___
*Overrides Extrinsic.sign* *Overrides Extrinsic.sign*
*Defined in [SubmittableExtrinsic.ts:153](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/SubmittableExtrinsic.ts#L153)* *Defined in [SubmittableExtrinsic.ts:153](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/SubmittableExtrinsic.ts#L153)*
**Parameters:** **Parameters:**
@@ -530,7 +530,7 @@ ___
▸ **signAndSend**(account: *`KeyringPair` \| `string` \| `AccountId` \| `Address`*, statusCb: *`StatusCb`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> ▸ **signAndSend**(account: *`KeyringPair` \| `string` \| `AccountId` \| `Address`*, statusCb: *`StatusCb`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:165](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/SubmittableExtrinsic.ts#L165)* *Defined in [SubmittableExtrinsic.ts:165](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/SubmittableExtrinsic.ts#L165)*
**Parameters:** **Parameters:**
@@ -541,7 +541,7 @@ ___
**Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> **Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`>
*Defined in [SubmittableExtrinsic.ts:166](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/SubmittableExtrinsic.ts#L166)* *Defined in [SubmittableExtrinsic.ts:166](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/SubmittableExtrinsic.ts#L166)*
**Parameters:** **Parameters:**
@@ -561,7 +561,7 @@ ___
*Inherited from Struct.toArray* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L198)*
*__description__*: Converts the Object to an standard JavaScript Array *__description__*: Converts the Object to an standard JavaScript Array
@@ -578,7 +578,7 @@ ___
*Overrides Struct.toHex* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L168)*
*__description__*: Returns a hex string representation of the value *__description__*: Returns a hex string representation of the value
@@ -595,7 +595,7 @@ ___
*Overrides Struct.toJSON* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L175)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers *__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -610,7 +610,7 @@ ___
*Inherited from Struct.toString* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L226)*
*__description__*: Returns the string representation of the value *__description__*: Returns the string representation of the value
@@ -627,7 +627,7 @@ ___
*Overrides Struct.toU8a* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L183)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -663,7 +663,7 @@ ___
*Inherited from Extrinsic.decodeExtrinsic* *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/0b9484f/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/73a5ea1/packages/types/src/type/Extrinsic.ts#L44)*
**Parameters:** **Parameters:**
@@ -682,7 +682,7 @@ ___
*Inherited from Struct.with* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L125)*
**Type parameters:** **Type parameters:**
docs/api/classes/_submittableextrinsic_.submittableresult.html
+21
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* *Overrides Struct.__constructor*
*Defined in [SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/SubmittableExtrinsic.ts#L28)* *Defined in [SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/SubmittableExtrinsic.ts#L28)*
**Parameters:** **Parameters:**
@@ -72,7 +72,7 @@ ___
*Inherited from Struct.Type* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L160)*
*__description__*: Returns the Type description to sthe structure *__description__*: Returns the Type description to sthe structure
@@ -87,7 +87,7 @@ ___
*Inherited from Struct.encodedLength* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L167)*
*__description__*: The length of the value when encoded as a Uint8Array *__description__*: The length of the value when encoded as a Uint8Array
@@ -100,7 +100,7 @@ ___
**get events**(): `Array`<`EventRecord`> **get events**(): `Array`<`EventRecord`>
*Defined in [SubmittableExtrinsic.ts:40](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/SubmittableExtrinsic.ts#L40)* *Defined in [SubmittableExtrinsic.ts:40](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/SubmittableExtrinsic.ts#L40)*
*__description__*: the contained events *__description__*: the contained events
@@ -115,7 +115,7 @@ ___
*Inherited from Struct.isEmpty* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Checks if the value is an empty value *__description__*: Checks if the value is an empty value
@@ -128,7 +128,7 @@ ___
**get status**(): `ExtrinsicStatus` **get status**(): `ExtrinsicStatus`
*Defined in [SubmittableExtrinsic.ts:47](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/SubmittableExtrinsic.ts#L47)* *Defined in [SubmittableExtrinsic.ts:47](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/SubmittableExtrinsic.ts#L47)*
*__description__*: the status *__description__*: the status
@@ -141,7 +141,7 @@ ___
**get type**(): `string` **get type**(): `string`
*Defined in [SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/0b9484f/packages/api/src/SubmittableExtrinsic.ts#L54)* *Defined in [SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/SubmittableExtrinsic.ts#L54)*
*__description__*: the type *__description__*: the type
@@ -221,7 +221,7 @@ ___
*Inherited from Struct.eq* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L176)*
*__description__*: Compares the value of the input to see if there is a match *__description__*: Compares the value of the input to see if there is a match
@@ -264,7 +264,7 @@ ___
*Overrides Map.get* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L184)*
*__description__*: Returns a specific names entry in the structure *__description__*: Returns a specific names entry in the structure
@@ -285,7 +285,7 @@ ___
*Inherited from Struct.getAtIndex* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L191)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) *__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* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L198)*
*__description__*: Converts the Object to an standard JavaScript Array *__description__*: Converts the Object to an standard JavaScript Array
@@ -375,7 +375,7 @@ ___
*Inherited from Struct.toHex* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L205)*
*__description__*: Returns a hex string representation of the value *__description__*: Returns a hex string representation of the value
@@ -390,7 +390,7 @@ ___
*Inherited from Struct.toJSON* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L212)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers *__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -405,7 +405,7 @@ ___
*Inherited from Struct.toString* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L226)*
*__description__*: Returns the string representation of the value *__description__*: Returns the string representation of the value
@@ -420,7 +420,7 @@ ___
*Inherited from Struct.toU8a* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L234)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -456,7 +456,7 @@ ___
*Inherited from Struct.with* *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/0b9484f/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/73a5ea1/packages/types/src/codec/Struct.ts#L125)*
**Type parameters:** **Type parameters:**

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