@substrate/api-sidecar 14.5.1 → 14.5.3

package/build/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "14.5.1",
+    "version": "14.5.3",
     "name": "@substrate/api-sidecar",
     "description": "REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.",
     "homepage": "https://github.com/paritytech/substrate-api-sidecar#readme",

package/build/src/services/pallets/PalletsStakingValidatorsService.d.ts

@@ -1,5 +1,5 @@
 import { BlockHash } from '@polkadot/types/interfaces';
-import { IPalletStakingValidator } from 'src/types/responses';
+import { IPalletStakingValidator } from '../../types/responses';
 import { AbstractService } from '../AbstractService';
 export declare class PalletsStakingValidatorsService extends AbstractService {
     /**

package/build/src/services/pallets/PalletsStakingValidatorsService.js

@@ -29,7 +29,15 @@ class PalletsStakingValidatorsService extends AbstractService_1.AbstractService
     async derivePalletStakingValidators(hash) {
         const { api } = this;
         const historicApi = await api.at(hash);
-        const validatorSession = await historicApi.query.session.validators();
+        const [{ number }, validatorSession, validatorsEntries] = await Promise.all([
+            api.rpc.chain.getHeader(hash),
+            historicApi.query.session.validators(),
+            historicApi.query.staking.validators.entries(),
+        ]);
+        const at = {
+            hash,
+            height: number.unwrap().toString(10),
+        };
         const validatorsActiveSet = new Set();
         for (const address of validatorSession) {
             validatorsActiveSet.add(address.toString());
@@ -38,16 +46,31 @@ class PalletsStakingValidatorsService extends AbstractService_1.AbstractService
         // status. If the address is found in the `validatorsActiveSet` then
         // status is `active` otherwise is set to `waiting`
         const validators = [];
-        const validatorsEntries = await historicApi.query.staking.validators.entries();
+        // Active validators that wont be part of the next active validator set
+        // for the incoming era.
+        const validatorsToBeChilled = [];
         validatorsEntries.map(([key]) => {
-            const address = key.args.map((k) => k.toHuman())[0];
-            const status = validatorsActiveSet.has(address)
-                ? 'active'
-                : 'waiting';
+            const address = key.args.map((k) => k.toString())[0];
+            let status;
+            if (validatorsActiveSet.has(address)) {
+                status = 'active';
+                validatorsActiveSet.delete(address);
+            }
+            else {
+                status = 'waiting';
+            }
             validators.push({ address, status });
         });
+        if (validatorsActiveSet.size > 0) {
+            validatorsActiveSet.forEach((address) => {
+                validators.push({ address, status: 'active' });
+                validatorsToBeChilled.push({ address, status: 'active' });
+            });
+        }
         return {
+            at,
             validators,
+            validatorsToBeChilled,
         };
     }
 }

package/build/src/services/pallets/PalletsStakingValidatorsService.js.map

@@ -1 +1 @@
-{"version":3,"file":"PalletsStakingValidatorsService.js","sourceRoot":"","sources":["../../../../src/services/pallets/PalletsStakingValidatorsService.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,8CAA8C;AAC9C,EAAE;AACF,gFAAgF;AAChF,uEAAuE;AACvE,oEAAoE;AACpE,sCAAsC;AACtC,EAAE;AACF,kEAAkE;AAClE,iEAAiE;AACjE,gEAAgE;AAChE,+CAA+C;AAC/C,EAAE;AACF,oEAAoE;AACpE,wEAAwE;;;AAKxE,wDAAqD;AAErD,MAAa,+BAAgC,SAAQ,iCAAe;IACnE;;;;;;;OAOG;IACH,KAAK,CAAC,6BAA6B,CAClC,IAAe;QAEf,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QACrB,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAEvC,MAAM,gBAAgB,GAAG,MAAM,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;QACtE,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAU,CAAC;QAC9C,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE;YACvC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;SAC5C;QAED,mEAAmE;QACnE,oEAAoE;QACpE,mDAAmD;QACnD,MAAM,UAAU,GAAiB,EAAE,CAAC;QACpC,MAAM,iBAAiB,GACtB,MAAM,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QACtD,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE;YAC/B,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACpD,MAAM,MAAM,GAAW,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC;gBACtD,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC,SAAS,CAAC;YACb,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,OAAO;YACN,UAAU;SACV,CAAC;IACH,CAAC;CACD;AAvCD,0EAuCC"}
+{"version":3,"file":"PalletsStakingValidatorsService.js","sourceRoot":"","sources":["../../../../src/services/pallets/PalletsStakingValidatorsService.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,8CAA8C;AAC9C,EAAE;AACF,gFAAgF;AAChF,uEAAuE;AACvE,oEAAoE;AACpE,sCAAsC;AACtC,EAAE;AACF,kEAAkE;AAClE,iEAAiE;AACjE,gEAAgE;AAChE,+CAA+C;AAC/C,EAAE;AACF,oEAAoE;AACpE,wEAAwE;;;AAKxE,wDAAqD;AAErD,MAAa,+BAAgC,SAAQ,iCAAe;IACnE;;;;;;;OAOG;IACH,KAAK,CAAC,6BAA6B,CAClC,IAAe;QAEf,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QACrB,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1E;YACC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC;YAC7B,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE;YACtC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE;SAC9C,CACD,CAAC;QAEF,MAAM,EAAE,GAAG;YACV,IAAI;YACJ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;SACpC,CAAC;QAEF,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAU,CAAC;QAC9C,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE;YACvC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;SAC5C;QAED,mEAAmE;QACnE,oEAAoE;QACpE,mDAAmD;QACnD,MAAM,UAAU,GAAiB,EAAE,CAAC;QACpC,uEAAuE;QACvE,wBAAwB;QACxB,MAAM,qBAAqB,GAAiB,EAAE,CAAC;QAE/C,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE;YAC/B,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,IAAI,MAA4B,CAAC;YACjC,IAAI,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBACrC,MAAM,GAAG,QAAQ,CAAC;gBAClB,mBAAmB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;aACpC;iBAAM;gBACN,MAAM,GAAG,SAAS,CAAC;aACnB;YACD,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,IAAI,mBAAmB,CAAC,IAAI,GAAG,CAAC,EAAE;YACjC,mBAAmB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACvC,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAC/C,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC;SACH;QAED,OAAO;YACN,EAAE;YACF,UAAU;YACV,qBAAqB;SACrB,CAAC;IACH,CAAC;CACD;AAjED,0EAiEC"}

package/build/src/services/pallets/PalletsStakingValidatorsService.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/services/pallets/PalletsStakingValidatorsService.spec.js

@@ -0,0 +1,60 @@
+"use strict";
+// Copyright 2017-2023 Parity Technologies (UK) Ltd.
+// This file is part of Substrate API Sidecar.
+//
+// Substrate API Sidecar is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sanitizeNumbers_1 = require("../../sanitize/sanitizeNumbers");
+const registries_1 = require("../../test-helpers/registries");
+const mock_1 = require("../test-helpers/mock");
+const validator14815152Entries_1 = require("../test-helpers/mock/data/validator14815152Entries");
+const validators14815152Hex_1 = require("../test-helpers/mock/data/validators14815152Hex");
+const fetchValidators14815152_json_1 = __importDefault(require("../test-helpers/responses/pallets/fetchValidators14815152.json"));
+const PalletsStakingValidatorsService_1 = require("./PalletsStakingValidatorsService");
+const validatorsAt = () => Promise.resolve().then(() => registries_1.polkadotRegistryV9370.createType('Vec<AccountId32>', validators14815152Hex_1.validators14815152Hex));
+const validatorsEntriesAt = () => Promise.resolve().then(() => (0, validator14815152Entries_1.validatorsEntries)());
+const mockHistoricApi = {
+    query: {
+        session: {
+            validators: validatorsAt,
+        },
+        staking: {
+            validators: {
+                entries: validatorsEntriesAt,
+            },
+        },
+    },
+};
+const mockApi = {
+    ...mock_1.defaultMockApi,
+    at: (_hash) => mockHistoricApi,
+};
+/**
+ * Mock PalletStakingProgressService instance.
+ */
+const palletsStakingValidatorsService = new PalletsStakingValidatorsService_1.PalletsStakingValidatorsService(mockApi);
+describe('PalletsStakingValidatorsService', () => {
+    describe('derivePalletStakingValidators', () => {
+        it('Works for block 14815152', async () => {
+            expect((0, sanitizeNumbers_1.sanitizeNumbers)(
+            // The inputted blockHash does not change the tests since the mocked data is all based
+            // on block 14815152
+            await palletsStakingValidatorsService.derivePalletStakingValidators(mock_1.blockHash789629))).toStrictEqual(fetchValidators14815152_json_1.default);
+        });
+    });
+});
+//# sourceMappingURL=PalletsStakingValidatorsService.spec.js.map

package/build/src/services/pallets/PalletsStakingValidatorsService.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PalletsStakingValidatorsService.spec.js","sourceRoot":"","sources":["../../../../src/services/pallets/PalletsStakingValidatorsService.spec.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,8CAA8C;AAC9C,EAAE;AACF,gFAAgF;AAChF,uEAAuE;AACvE,oEAAoE;AACpE,sCAAsC;AACtC,EAAE;AACF,kEAAkE;AAClE,iEAAiE;AACjE,gEAAgE;AAChE,+CAA+C;AAC/C,EAAE;AACF,oEAAoE;AACpE,wEAAwE;;;;;AAMxE,oEAAiE;AACjE,8DAAsE;AACtE,+CAAuE;AACvE,iGAAuF;AACvF,2FAAwF;AACxF,kIAAqG;AACrG,uFAAoF;AAEpF,MAAM,YAAY,GAAG,GAAG,EAAE,CACzB,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAC3B,kCAAqB,CAAC,UAAU,CAAC,kBAAkB,EAAE,6CAAqB,CAAC,CAC3E,CAAC;AAEH,MAAM,mBAAmB,GAAG,GAAG,EAAE,CAChC,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAA,4CAAiB,GAAE,CAAC,CAAC;AAEnD,MAAM,eAAe,GAAG;IACvB,KAAK,EAAE;QACN,OAAO,EAAE;YACR,UAAU,EAAE,YAAY;SACxB;QACD,OAAO,EAAE;YACR,UAAU,EAAE;gBACX,OAAO,EAAE,mBAAmB;aAC5B;SACD;KACD;CACsC,CAAC;AAEzC,MAAM,OAAO,GAAG;IACf,GAAG,qBAAc;IACjB,EAAE,EAAE,CAAC,KAAW,EAAE,EAAE,CAAC,eAAe;CACX,CAAC;AAC3B;;GAEG;AACH,MAAM,+BAA+B,GAAG,IAAI,iEAA+B,CAC1E,OAAO,CACP,CAAC;AAEF,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAChD,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;QAC9C,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;YACzC,MAAM,CACL,IAAA,iCAAe;YACd,sFAAsF;YACtF,oBAAoB;YACpB,MAAM,+BAA+B,CAAC,6BAA6B,CAClE,sBAAe,CACf,CACD,CACD,CAAC,aAAa,CAAC,sCAAuB,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/build/src/types/responses/PalletStakingValidators.d.ts

@@ -1,3 +1,4 @@
+import { IAt } from './At';
 export interface IValidator {
     /**
      * Address of the validator.
@@ -11,5 +12,7 @@ export interface IValidator {
     status: string;
 }
 export interface IPalletStakingValidator {
+    at: IAt;
     validators: IValidator[];
+    validatorsToBeChilled: IValidator[];
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "14.5.1",
+  "version": "14.5.3",
   "name": "@substrate/api-sidecar",
   "description": "REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.",
   "homepage": "https://github.com/paritytech/substrate-api-sidecar#readme",