Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix api.derive.staking.eraExposure [WIP] #5813

Closed
wants to merge 7 commits into from
Closed

Fix api.derive.staking.eraExposure [WIP] #5813

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
12c35f8
Fix api.derive.staking.eraExposure
TarikGul Mar 8, 2024
4201815
small type changes
TarikGul Mar 8, 2024
ba9dc64
linter suggestion
TarikGul Mar 8, 2024
8289e18
10.12.2 (#5814)
TarikGul Mar 11, 2024
da28923
[CI Skip] release/stable 10.12.2
github-actions[bot] Mar 11, 2024
c473551
Merge branch 'tg-derive-exposure' of github.com:polkadot-js/api into …
TarikGul Mar 11, 2024
ac7103d
add compatibility
TarikGul Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 44 additions & 11 deletions packages/api-derive/src/staking/erasExposure.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand All @@ -14,10 +14,12 @@ 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 {
// Legacy usage for erasStakersClipped. Giving support for compatibility.
function mapStakersClipped (era: EraIndex, stakers: KeysAndExposures): DeriveEraExposurePaged {
const nominators: DeriveEraNominatorExposure = {};
const validators: DeriveEraValidatorExposure = {};

Expand All @@ -37,15 +39,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)))
);
});
}

Expand Down
4 changes: 2 additions & 2 deletions packages/api-derive/src/staking/stakerExposure.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand All @@ -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) {
Expand Down
8 changes: 4 additions & 4 deletions packages/api-derive/src/staking/stakerRewards.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 } 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';
Expand Down Expand Up @@ -38,7 +38,7 @@ 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() : BN_ZERO;
let avail = BN_ZERO;
let value: BN | undefined;

Expand All @@ -48,8 +48,8 @@ function parseRewards (api: DeriveApi, stashId: AccountId, [erasPoints, erasPref
const valCut = valComm.mul(avail).div(BN_BILLION);
let staked: BN;

if (validatorId === stakerId) {
staked = exposure.own.unwrap();
if (validatorId === stakerId && (exposure as PalletStakingExposure).own) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this is valid. Need to double check

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I need to add the storage call to ErasStakersOverview , and do this correctly so we don't need to come back to it.

staked = (exposure as PalletStakingExposure).own.unwrap();
} else {
const stakerExp = exposure.others.find(({ who }) => who.eq(stakerId));

Expand Down
12 changes: 10 additions & 2 deletions packages/api-derive/src/staking/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand Down Expand Up @@ -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 {
Expand Down
Loading