Fix api.derive.staking.eraExposure [WIP]

CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 10.12.2 Mar 11, 2024
+
+Contributed:
+
+- fix cache key (rpc-provider) (Thanks to https://github.com/ermalkaleci)
+
+Changes:
+
+- Update to latest Substrate metadata
+
+
 ## 10.12.1 Mar 4, 2024
 
 Contributed:

CONTRIBUTORS

@@ -8,7 +8,7 @@
       14	Nikos Kontakis                	Bump substrate connect to 0.7.16 (#5307)
       11	Ian He                        	HttpProvider support clone() (#3949)
       10	Axel Chalon                   	Make Enum/Tuple constructor use value directly if instance (#1954)
-       9	Tarik Gul                     	Update docs in types-support for retrieving metadata for typegen (#5809)
+      10	Tarik Gul                     	10.12.2 (#5814)
        6	Andreea Eftene                	Update check for contract instantiation (#5699)
        5	Chevdor                       	Fix metadata package link (#3458)
        5	Jake Naviasky                 	Fixing approvalFlagsToBools. (#1250)

package.json

@@ -14,10 +14,10 @@
   },
   "sideEffects": false,
   "type": "module",
-  "version": "10.12.2-2-x",
+  "version": "10.12.2",
   "versions": {
-    "git": "10.12.2-2-x",
-    "npm": "10.12.1"
+    "git": "10.12.2",
+    "npm": "10.12.2"
   },
   "workspaces": [
     "packages/*"

packages/api-augment/package.json

@@ -18,14 +18,14 @@
     "./packageDetect.cjs"
   ],
   "type": "module",
-  "version": "10.12.2-2-x",
+  "version": "10.12.2",
   "main": "index.js",
   "dependencies": {
-    "@polkadot/api-base": "10.12.2-2-x",
-    "@polkadot/rpc-augment": "10.12.2-2-x",
-    "@polkadot/types": "10.12.2-2-x",
-    "@polkadot/types-augment": "10.12.2-2-x",
-    "@polkadot/types-codec": "10.12.2-2-x",
+    "@polkadot/api-base": "10.12.2",
+    "@polkadot/rpc-augment": "10.12.2",
+    "@polkadot/types": "10.12.2",
+    "@polkadot/types-augment": "10.12.2",
+    "@polkadot/types-codec": "10.12.2",
     "@polkadot/util": "^12.6.2",
     "tslib": "^2.6.2"
   }

packages/api-augment/src/packageInfo.ts

@@ -3,4 +3,4 @@
 
 // Do not edit, auto-generated by @polkadot/dev
 
-export const packageInfo = { name: '@polkadot/api-augment', path: 'auto', type: 'auto', version: '10.12.2-2-x' };
+export const packageInfo = { name: '@polkadot/api-augment', path: 'auto', type: 'auto', version: '10.12.2' };

packages/api-base/package.json

@@ -18,11 +18,11 @@
     "./packageDetect.cjs"
   ],
   "type": "module",
-  "version": "10.12.2-2-x",
+  "version": "10.12.2",
   "main": "index.js",
   "dependencies": {
-    "@polkadot/rpc-core": "10.12.2-2-x",
-    "@polkadot/types": "10.12.2-2-x",
+    "@polkadot/rpc-core": "10.12.2",
+    "@polkadot/types": "10.12.2",
     "@polkadot/util": "^12.6.2",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.2"

packages/api-base/src/packageInfo.ts

@@ -3,4 +3,4 @@
 
 // Do not edit, auto-generated by @polkadot/dev
 
-export const packageInfo = { name: '@polkadot/api-base', path: 'auto', type: 'auto', version: '10.12.2-2-x' };
+export const packageInfo = { name: '@polkadot/api-base', path: 'auto', type: 'auto', version: '10.12.2' };

packages/api-contract/package.json

@@ -18,22 +18,22 @@
     "./packageDetect.cjs"
   ],
   "type": "module",
-  "version": "10.12.2-2-x",
+  "version": "10.12.2",
   "main": "index.js",
   "dependencies": {
-    "@polkadot/api": "10.12.2-2-x",
-    "@polkadot/api-augment": "10.12.2-2-x",
-    "@polkadot/types": "10.12.2-2-x",
-    "@polkadot/types-codec": "10.12.2-2-x",
-    "@polkadot/types-create": "10.12.2-2-x",
+    "@polkadot/api": "10.12.2",
+    "@polkadot/api-augment": "10.12.2",
+    "@polkadot/types": "10.12.2",
+    "@polkadot/types-codec": "10.12.2",
+    "@polkadot/types-create": "10.12.2",
     "@polkadot/util": "^12.6.2",
     "@polkadot/util-crypto": "^12.6.2",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@polkadot/api-augment": "10.12.2-2-x",
+    "@polkadot/api-augment": "10.12.2",
     "@polkadot/keyring": "^12.6.2",
-    "@polkadot/types-support": "10.12.2-2-x"
+    "@polkadot/types-support": "10.12.2"
   }
 }

packages/api-contract/src/packageInfo.ts

@@ -3,4 +3,4 @@
 
 // Do not edit, auto-generated by @polkadot/dev
 
-export const packageInfo = { name: '@polkadot/api-contract', path: 'auto', type: 'auto', version: '10.12.2-2-x' };
+export const packageInfo = { name: '@polkadot/api-contract', path: 'auto', type: 'auto', version: '10.12.2' };

packages/api-derive/package.json

@@ -18,25 +18,25 @@
     "./packageDetect.cjs"
   ],
   "type": "module",
-  "version": "10.12.2-2-x",
+  "version": "10.12.2",
   "main": "index.js",
   "dependencies": {
-    "@polkadot/api": "10.12.2-2-x",
-    "@polkadot/api-augment": "10.12.2-2-x",
-    "@polkadot/api-base": "10.12.2-2-x",
-    "@polkadot/rpc-core": "10.12.2-2-x",
-    "@polkadot/types": "10.12.2-2-x",
-    "@polkadot/types-codec": "10.12.2-2-x",
+    "@polkadot/api": "10.12.2",
+    "@polkadot/api-augment": "10.12.2",
+    "@polkadot/api-base": "10.12.2",
+    "@polkadot/rpc-core": "10.12.2",
+    "@polkadot/types": "10.12.2",
+    "@polkadot/types-codec": "10.12.2",
     "@polkadot/util": "^12.6.2",
     "@polkadot/util-crypto": "^12.6.2",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@polkadot/api": "10.12.2-2-x",
-    "@polkadot/api-augment": "10.12.2-2-x",
-    "@polkadot/rpc-augment": "10.12.2-2-x",
-    "@polkadot/rpc-provider": "10.12.2-2-x",
-    "@polkadot/types-support": "10.12.2-2-x"
+    "@polkadot/api": "10.12.2",
+    "@polkadot/api-augment": "10.12.2",
+    "@polkadot/rpc-augment": "10.12.2",
+    "@polkadot/rpc-provider": "10.12.2",
+    "@polkadot/types-support": "10.12.2"
   }
 }

packages/api-derive/src/packageInfo.ts

@@ -3,4 +3,4 @@
 
 // Do not edit, auto-generated by @polkadot/dev
 
-export const packageInfo = { name: '@polkadot/api-derive', path: 'auto', type: 'auto', version: '10.12.2-2-x' };
+export const packageInfo = { name: '@polkadot/api-derive', path: 'auto', type: 'auto', version: '10.12.2' };

packages/api-derive/src/staking/erasExposure.ts

@@ -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,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 = {};
 
@@ -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)))
+        );
   });
 }
 

packages/api-derive/src/staking/stakerExposure.ts

@@ -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) {

packages/api-derive/src/staking/stakerRewards.ts

@@ -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,13 @@ 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.toString() === validatorId);
+
+            staked = expAccount ? expAccount.value.unwrap() : BN_ZERO;
+          }
         } else {
           const stakerExp = exposure.others.find(({ who }) => who.eq(stakerId));
 

packages/api-derive/src/staking/types.ts

@@ -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 {

packages/api/package.json

@@ -18,29 +18,29 @@
     "./packageDetect.cjs"
   ],
   "type": "module",
-  "version": "10.12.2-2-x",
+  "version": "10.12.2",
   "main": "index.js",
   "dependencies": {
-    "@polkadot/api-augment": "10.12.2-2-x",
-    "@polkadot/api-base": "10.12.2-2-x",
-    "@polkadot/api-derive": "10.12.2-2-x",
+    "@polkadot/api-augment": "10.12.2",
+    "@polkadot/api-base": "10.12.2",
+    "@polkadot/api-derive": "10.12.2",
     "@polkadot/keyring": "^12.6.2",
-    "@polkadot/rpc-augment": "10.12.2-2-x",
-    "@polkadot/rpc-core": "10.12.2-2-x",
-    "@polkadot/rpc-provider": "10.12.2-2-x",
-    "@polkadot/types": "10.12.2-2-x",
-    "@polkadot/types-augment": "10.12.2-2-x",
-    "@polkadot/types-codec": "10.12.2-2-x",
-    "@polkadot/types-create": "10.12.2-2-x",
-    "@polkadot/types-known": "10.12.2-2-x",
+    "@polkadot/rpc-augment": "10.12.2",
+    "@polkadot/rpc-core": "10.12.2",
+    "@polkadot/rpc-provider": "10.12.2",
+    "@polkadot/types": "10.12.2",
+    "@polkadot/types-augment": "10.12.2",
+    "@polkadot/types-codec": "10.12.2",
+    "@polkadot/types-create": "10.12.2",
+    "@polkadot/types-known": "10.12.2",
     "@polkadot/util": "^12.6.2",
     "@polkadot/util-crypto": "^12.6.2",
     "eventemitter3": "^5.0.1",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@polkadot/api-augment": "10.12.2-2-x",
-    "@polkadot/types-support": "10.12.2-2-x"
+    "@polkadot/api-augment": "10.12.2",
+    "@polkadot/types-support": "10.12.2"
   }
 }

packages/api/src/packageInfo.ts

@@ -3,4 +3,4 @@
 
 // Do not edit, auto-generated by @polkadot/dev
 
-export const packageInfo = { name: '@polkadot/api', path: 'auto', type: 'auto', version: '10.12.2-2-x' };
+export const packageInfo = { name: '@polkadot/api', path: 'auto', type: 'auto', version: '10.12.2' };