Fix api.derive.staking.eraExposure for compatibility (#5815)

* Fix api.derive.staking.eraExposure

* fix nit
This commit is contained in:
Tarik Gul
2024-03-13 16:17:35 +02:00
committed by GitHub
parent 390610127a
commit 9ecf4f2ee0
4 changed files with 70 additions and 18 deletions
+43 -11
View File
@@ -2,10 +2,10 @@
// SPDX-License-Identifier: Apache-2.0
import type { Observable } from 'rxjs';
import type { StorageKey } from '@polkadot/types';
import type { AccountId, EraIndex } from '@polkadot/types/interfaces';
import type { PalletStakingExposure } from '@polkadot/types/lookup';
import type { DeriveApi, DeriveEraExposure, DeriveEraNominatorExposure, DeriveEraValidatorExposure } from '../types.js';
import type { Option, StorageKey, u32 } from '@polkadot/types';
import type { AccountId, AccountId32, EraIndex } from '@polkadot/types/interfaces';
import type { PalletStakingExposure, SpStakingExposurePage } from '@polkadot/types/lookup';
import type { DeriveApi, DeriveEraExposurePaged, DeriveEraNominatorExposure, DeriveEraValidatorExposure, DeriveEraValidatorExposurePaged } from '../types.js';
import { map, of } from 'rxjs';
@@ -14,10 +14,11 @@ import { getEraCache, setEraCache } from './cache.js';
import { combineEras, erasHistoricApply, singleEra } from './util.js';
type KeysAndExposures = [StorageKey<[EraIndex, AccountId]>, PalletStakingExposure][];
type KeysAndExposuresPaged = [StorageKey<[u32, AccountId32, u32]>, Option<SpStakingExposurePage>][];
const CACHE_KEY = 'eraExposure';
function mapStakers (era: EraIndex, stakers: KeysAndExposures): DeriveEraExposure {
function mapStakersClipped (era: EraIndex, stakers: KeysAndExposures): DeriveEraExposurePaged {
const nominators: DeriveEraNominatorExposure = {};
const validators: DeriveEraValidatorExposure = {};
@@ -37,15 +38,46 @@ function mapStakers (era: EraIndex, stakers: KeysAndExposures): DeriveEraExposur
return { era, nominators, validators };
}
export function _eraExposure (instanceId: string, api: DeriveApi): (era: EraIndex, withActive?: boolean) => Observable<DeriveEraExposure> {
return memo(instanceId, (era: EraIndex, withActive = false): Observable<DeriveEraExposure> => {
const [cacheKey, cached] = getEraCache<DeriveEraExposure>(CACHE_KEY, era, withActive);
function mapStakersPaged (era: EraIndex, stakers: KeysAndExposuresPaged): DeriveEraExposurePaged {
const nominators: DeriveEraNominatorExposure = {};
const validators: DeriveEraValidatorExposurePaged = {};
stakers.forEach(([key, exposureOpt]): void => {
if (exposureOpt.isSome) {
const validatorId = key.args[1].toString();
const exposure = exposureOpt.unwrap();
validators[validatorId] = exposure;
exposure.others.forEach(({ who }, validatorIndex): void => {
const nominatorId = who.toString();
nominators[nominatorId] = nominators[nominatorId] || [];
nominators[nominatorId].push({ validatorId, validatorIndex });
});
}
});
return { era, nominators, validators };
}
/**
* erasStakersClipped will be deprecated and replaced with erasStakersPaged. Therefore support is given for both
* storage queries until erasStakersClipped has been completely out of use.
*/
export function _eraExposure (instanceId: string, api: DeriveApi): (era: EraIndex, withActive?: boolean) => Observable<DeriveEraExposurePaged> {
return memo(instanceId, (era: EraIndex, withActive = false): Observable<DeriveEraExposurePaged> => {
const [cacheKey, cached] = getEraCache<DeriveEraExposurePaged>(CACHE_KEY, era, withActive);
return cached
? of(cached)
: api.query.staking.erasStakersClipped.entries(era).pipe(
map((r) => setEraCache(cacheKey, withActive, mapStakers(era, r)))
);
: api.query.staking.erasStakersPaged
? api.query.staking.erasStakersPaged.entries<Option<SpStakingExposurePage>>(era).pipe(
map((r) => setEraCache(cacheKey, withActive, mapStakersPaged(era, r)))
)
: api.query.staking.erasStakersClipped.entries(era).pipe(
map((r) => setEraCache(cacheKey, withActive, mapStakersClipped(era, r)))
);
});
}
@@ -4,7 +4,7 @@
import type { Observable } from 'rxjs';
import type { EraIndex } from '@polkadot/types/interfaces';
import type { DeriveApi } from '../types.js';
import type { DeriveEraValidatorExposure, DeriveStakerExposure } from './types.js';
import type { DeriveEraValidatorExposurePaged, DeriveStakerExposure } from './types.js';
import { map, switchMap } from 'rxjs';
@@ -19,7 +19,7 @@ export function _stakerExposures (instanceId: string, api: DeriveApi): (accountI
stakerIds.map((stakerId) =>
exposures.map(({ era, nominators: allNominators, validators: allValidators }): DeriveStakerExposure => {
const isValidator = !!allValidators[stakerId];
const validators: DeriveEraValidatorExposure = {};
const validators: DeriveEraValidatorExposurePaged = {};
const nominating = allNominators[stakerId] || [];
if (isValidator) {
@@ -4,7 +4,7 @@
import type { Observable } from 'rxjs';
import type { u32, Vec } from '@polkadot/types';
import type { AccountId, EraIndex } from '@polkadot/types/interfaces';
import type { PalletStakingStakingLedger } from '@polkadot/types/lookup';
import type { PalletStakingExposure, PalletStakingStakingLedger, SpStakingExposurePage } from '@polkadot/types/lookup';
import type { BN } from '@polkadot/util';
import type { DeriveApi, DeriveEraPoints, DeriveEraPrefs, DeriveEraRewards, DeriveEraValPoints, DeriveEraValPrefs, DeriveStakerExposure, DeriveStakerReward, DeriveStakerRewardValidator } from '../types.js';
import type { DeriveStakingQuery } from './types.js';
@@ -38,7 +38,11 @@ function parseRewards (api: DeriveApi, stashId: AccountId, [erasPoints, erasPref
Object.entries(eraValidators).forEach(([validatorId, exposure]): void => {
const valPoints = allValPoints[validatorId] || BN_ZERO;
const valComm = allValPrefs[validatorId]?.commission.unwrap() || BN_ZERO;
const expTotal = exposure.total?.unwrap() || BN_ZERO;
const expTotal = (exposure as PalletStakingExposure).total
? (exposure as PalletStakingExposure).total?.unwrap()
: (exposure as SpStakingExposurePage).pageTotal
? (exposure as SpStakingExposurePage).pageTotal?.unwrap()
: BN_ZERO;
let avail = BN_ZERO;
let value: BN | undefined;
@@ -49,7 +53,15 @@ function parseRewards (api: DeriveApi, stashId: AccountId, [erasPoints, erasPref
let staked: BN;
if (validatorId === stakerId) {
staked = exposure.own.unwrap();
if ((exposure as PalletStakingExposure).own) {
staked = (exposure as PalletStakingExposure).own.unwrap();
} else {
const expAccount = exposure.others.find(({ who }) => who.eq(validatorId));
staked = expAccount
? expAccount.value.unwrap()
: BN_ZERO;
}
} else {
const stakerExp = exposure.others.find(({ who }) => who.eq(stakerId));
+10 -2
View File
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: Apache-2.0
import type { AccountId, Balance, EraIndex, RewardPoint } from '@polkadot/types/interfaces';
import type { PalletStakingExposure, PalletStakingRewardDestination, PalletStakingStakingLedger, PalletStakingValidatorPrefs } from '@polkadot/types/lookup';
import type { PalletStakingExposure, PalletStakingRewardDestination, PalletStakingStakingLedger, PalletStakingValidatorPrefs, SpStakingExposurePage } from '@polkadot/types/lookup';
import type { BN } from '@polkadot/util';
import type { DeriveSessionIndexes } from '../session/types.js';
@@ -55,18 +55,26 @@ export type DeriveEraNominatorExposure = Record<string, DeriveEraExposureNominat
export type DeriveEraValidatorExposure = Record<string, PalletStakingExposure>;
export type DeriveEraValidatorExposurePaged = Record<string, SpStakingExposurePage | PalletStakingExposure>;
export interface DeriveEraExposure {
era: EraIndex;
nominators: DeriveEraNominatorExposure;
validators: DeriveEraValidatorExposure;
}
export interface DeriveEraExposurePaged {
era: EraIndex;
nominators: DeriveEraNominatorExposure;
validators: DeriveEraValidatorExposurePaged;
}
export interface DeriveStakerExposure {
era: EraIndex;
isEmpty: boolean;
isValidator: boolean;
nominating: DeriveEraExposureNominating[];
validators: DeriveEraValidatorExposure;
validators: DeriveEraValidatorExposurePaged;
}
export interface DeriveStakerPrefs {