|
|
@@ -59,7 +59,7 @@ declare module '@polkadot/api/types/storage' {
|
|
|
initialized: AugmentedQuery<ApiType, () => Observable<Option<MaybeRandomness>>, []>;
|
|
|
/**
|
|
|
* How late the current block is compared to its parent.
|
|
|
- *
|
|
|
+ *
|
|
|
* This entry is populated as part of block execution and is cleaned up
|
|
|
* on block finalization. Querying this storage entry outside of block
|
|
|
* execution context should always yield zero.
|
|
|
@@ -75,9 +75,9 @@ declare module '@polkadot/api/types/storage' {
|
|
|
nextRandomness: AugmentedQuery<ApiType, () => Observable<Randomness>, []>;
|
|
|
/**
|
|
|
* The epoch randomness for the *current* epoch.
|
|
|
- *
|
|
|
+ *
|
|
|
* # Security
|
|
|
- *
|
|
|
+ *
|
|
|
* This MUST NOT be used for gambling, as it can be influenced by a
|
|
|
* malicious validator in the short term. It MAY be used in many
|
|
|
* cryptographic protocols, however, so long as one remembers that this
|
|
|
@@ -88,11 +88,11 @@ declare module '@polkadot/api/types/storage' {
|
|
|
randomness: AugmentedQuery<ApiType, () => Observable<Randomness>, []>;
|
|
|
/**
|
|
|
* Randomness under construction.
|
|
|
- *
|
|
|
+ *
|
|
|
* We make a tradeoff between storage accesses and list length.
|
|
|
* We store the under-construction randomness in segments of up to
|
|
|
* `UNDER_CONSTRUCTION_SEGMENT_LENGTH`.
|
|
|
- *
|
|
|
+ *
|
|
|
* Once a segment reaches this length, we begin the next one.
|
|
|
* We reset all segments and return to `0` at the beginning of every
|
|
|
* epoch.
|
|
|
@@ -106,7 +106,7 @@ declare module '@polkadot/api/types/storage' {
|
|
|
balances: {
|
|
|
/**
|
|
|
* The balance of an account.
|
|
|
- *
|
|
|
+ *
|
|
|
* NOTE: This is only used in the case that this module is used to store balances.
|
|
|
**/
|
|
|
account: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<AccountData>, [AccountId]>;
|
|
|
@@ -117,7 +117,7 @@ declare module '@polkadot/api/types/storage' {
|
|
|
locks: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<Vec<BalanceLock>>, [AccountId]>;
|
|
|
/**
|
|
|
* Storage version of the pallet.
|
|
|
- *
|
|
|
+ *
|
|
|
* This is set to v2.0.0 for new networks.
|
|
|
**/
|
|
|
storageVersion: AugmentedQuery<ApiType, () => Observable<Releases>, []>;
|
|
|
@@ -441,7 +441,7 @@ declare module '@polkadot/api/types/storage' {
|
|
|
/**
|
|
|
* A mapping from grandpa set ID to the index of the *most recent* session for which its
|
|
|
* members were responsible.
|
|
|
- *
|
|
|
+ *
|
|
|
* TWOX-NOTE: `SetId` is not under user control.
|
|
|
**/
|
|
|
setIdSession: AugmentedQuery<ApiType, (arg: SetId | AnyNumber | Uint8Array) => Observable<Option<SessionIndex>>, [SetId]>;
|
|
|
@@ -484,7 +484,7 @@ declare module '@polkadot/api/types/storage' {
|
|
|
authoredBlocks: AugmentedQueryDoubleMap<ApiType, (key1: SessionIndex | AnyNumber | Uint8Array, key2: ValidatorId | string | Uint8Array) => Observable<u32>, [SessionIndex, ValidatorId]>;
|
|
|
/**
|
|
|
* The block number after which it's ok to send heartbeats in current session.
|
|
|
- *
|
|
|
+ *
|
|
|
* At the beginning of each session we set this to a value that should
|
|
|
* fall roughly in the middle of the session duration.
|
|
|
* The idea is to first wait for the validators to produce a block
|
|
|
@@ -575,9 +575,9 @@ declare module '@polkadot/api/types/storage' {
|
|
|
reports: AugmentedQuery<ApiType, (arg: ReportIdOf | string | Uint8Array) => Observable<Option<OffenceDetails>>, [ReportIdOf]>;
|
|
|
/**
|
|
|
* Enumerates all reports of a kind along with the time they happened.
|
|
|
- *
|
|
|
+ *
|
|
|
* All reports are sorted by the time of offence.
|
|
|
- *
|
|
|
+ *
|
|
|
* Note that the actual type of this mapping is `Vec<u8>`, this is because values of
|
|
|
* different types are not supported at the moment so we are doing the manual serialization.
|
|
|
**/
|
|
|
@@ -837,7 +837,7 @@ declare module '@polkadot/api/types/storage' {
|
|
|
currentIndex: AugmentedQuery<ApiType, () => Observable<SessionIndex>, []>;
|
|
|
/**
|
|
|
* Indices of disabled validators.
|
|
|
- *
|
|
|
+ *
|
|
|
* The set is cleared when `on_session_ending` returns a new set of identities.
|
|
|
**/
|
|
|
disabledValidators: AugmentedQuery<ApiType, () => Observable<Vec<u32>>, []>;
|
|
|
@@ -878,7 +878,7 @@ declare module '@polkadot/api/types/storage' {
|
|
|
staking: {
|
|
|
/**
|
|
|
* The active era information, it holds index and start.
|
|
|
- *
|
|
|
+ *
|
|
|
* The active era is the era currently rewarded.
|
|
|
* Validator set of this era must be equal to `SessionInterface::validators`.
|
|
|
**/
|
|
|
@@ -889,7 +889,7 @@ declare module '@polkadot/api/types/storage' {
|
|
|
bonded: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<Option<AccountId>>, [AccountId]>;
|
|
|
/**
|
|
|
* A mapping from still-bonded eras to the first session index of that era.
|
|
|
- *
|
|
|
+ *
|
|
|
* Must contains information for eras for the range:
|
|
|
* `[active_era - bounding_duration; active_era]`
|
|
|
**/
|
|
|
@@ -901,7 +901,7 @@ declare module '@polkadot/api/types/storage' {
|
|
|
canceledSlashPayout: AugmentedQuery<ApiType, () => Observable<BalanceOf>, []>;
|
|
|
/**
|
|
|
* The current era index.
|
|
|
- *
|
|
|
+ *
|
|
|
* This is the latest planned era, depending on how the Session pallet queues the validator
|
|
|
* set, it might be active or not.
|
|
|
**/
|
|
|
@@ -922,23 +922,23 @@ declare module '@polkadot/api/types/storage' {
|
|
|
erasRewardPoints: AugmentedQuery<ApiType, (arg: EraIndex | AnyNumber | Uint8Array) => Observable<EraRewardPoints>, [EraIndex]>;
|
|
|
/**
|
|
|
* Exposure of validator at era.
|
|
|
- *
|
|
|
+ *
|
|
|
* This is keyed first by the era index to allow bulk deletion and then the stash account.
|
|
|
- *
|
|
|
+ *
|
|
|
* Is it removed after `HISTORY_DEPTH` eras.
|
|
|
* If stakers hasn't been set or has been removed then empty exposure is returned.
|
|
|
**/
|
|
|
erasStakers: AugmentedQueryDoubleMap<ApiType, (key1: EraIndex | AnyNumber | Uint8Array, key2: AccountId | string | Uint8Array) => Observable<Exposure>, [EraIndex, AccountId]>;
|
|
|
/**
|
|
|
* Clipped Exposure of validator at era.
|
|
|
- *
|
|
|
+ *
|
|
|
* This is similar to [`ErasStakers`] but number of nominators exposed is reduced to the
|
|
|
* `T::MaxNominatorRewardedPerValidator` biggest stakers.
|
|
|
* (Note: the field `total` and `own` of the exposure remains unchanged).
|
|
|
* This is used to limit the i/o cost for the nominator payout.
|
|
|
- *
|
|
|
+ *
|
|
|
* This is keyed fist by the era index to allow bulk deletion and then the stash account.
|
|
|
- *
|
|
|
+ *
|
|
|
* Is it removed after `HISTORY_DEPTH` eras.
|
|
|
* If stakers hasn't been set or has been removed then empty exposure is returned.
|
|
|
**/
|
|
|
@@ -954,15 +954,15 @@ declare module '@polkadot/api/types/storage' {
|
|
|
erasTotalStake: AugmentedQuery<ApiType, (arg: EraIndex | AnyNumber | Uint8Array) => Observable<BalanceOf>, [EraIndex]>;
|
|
|
/**
|
|
|
* Similar to `ErasStakers`, this holds the preferences of validators.
|
|
|
- *
|
|
|
+ *
|
|
|
* This is keyed first by the era index to allow bulk deletion and then the stash account.
|
|
|
- *
|
|
|
+ *
|
|
|
* Is it removed after `HISTORY_DEPTH` eras.
|
|
|
**/
|
|
|
erasValidatorPrefs: AugmentedQueryDoubleMap<ApiType, (key1: EraIndex | AnyNumber | Uint8Array, key2: AccountId | string | Uint8Array) => Observable<ValidatorPrefs>, [EraIndex, AccountId]>;
|
|
|
/**
|
|
|
* The total validator era payout for the last `HISTORY_DEPTH` eras.
|
|
|
- *
|
|
|
+ *
|
|
|
* Eras that haven't finished yet or has been removed doesn't have reward.
|
|
|
**/
|
|
|
erasValidatorReward: AugmentedQuery<ApiType, (arg: EraIndex | AnyNumber | Uint8Array) => Observable<Option<BalanceOf>>, [EraIndex]>;
|
|
|
@@ -972,9 +972,9 @@ declare module '@polkadot/api/types/storage' {
|
|
|
forceEra: AugmentedQuery<ApiType, () => Observable<Forcing>, []>;
|
|
|
/**
|
|
|
* Number of eras to keep in history.
|
|
|
- *
|
|
|
+ *
|
|
|
* Information is kept for eras in `[current_era - history_depth; current_era]`.
|
|
|
- *
|
|
|
+ *
|
|
|
* Must be more than the number of eras delayed by session otherwise. I.e. active era must
|
|
|
* always be in history. I.e. `active_era > current_era - history_depth` must be
|
|
|
* guaranteed.
|
|
|
@@ -1027,7 +1027,7 @@ declare module '@polkadot/api/types/storage' {
|
|
|
slashingSpans: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<Option<SlashingSpans>>, [AccountId]>;
|
|
|
/**
|
|
|
* The percentage of the slash that is distributed to reporters.
|
|
|
- *
|
|
|
+ *
|
|
|
* The rest of the slashed value is handled by the `Slash`.
|
|
|
**/
|
|
|
slashRewardFraction: AugmentedQuery<ApiType, () => Observable<Perbill>, []>;
|
|
|
@@ -1049,7 +1049,7 @@ declare module '@polkadot/api/types/storage' {
|
|
|
/**
|
|
|
* True if network has been upgraded to this version.
|
|
|
* Storage version of the pallet.
|
|
|
- *
|
|
|
+ *
|
|
|
* This is set to v3.0.0 for new networks.
|
|
|
**/
|
|
|
storageVersion: AugmentedQuery<ApiType, () => Observable<Releases>, []>;
|
|
|
@@ -1246,11 +1246,11 @@ declare module '@polkadot/api/types/storage' {
|
|
|
/**
|
|
|
* Mapping between a topic (represented by T::Hash) and a vector of indexes
|
|
|
* of events in the `<Events<T>>` list.
|
|
|
- *
|
|
|
+ *
|
|
|
* All topic vectors have deterministic storage locations depending on the topic. This
|
|
|
* allows light-clients to leverage the changes trie storage tracking mechanism and
|
|
|
* in case of changes fetch the list of events of interest.
|
|
|
- *
|
|
|
+ *
|
|
|
* The value has the type `(T::BlockNumber, EventIndex)` because if we used only just
|
|
|
* the `EventIndex` then in case if the topic has the same contents on the next block
|
|
|
* no notification will be triggered thus the event might be lost.
|
Leszek Wiesner