feat: Experimental PLO endpoints

package.json

@@ -36,7 +36,7 @@
     "test": "jest --silent"
   },
   "dependencies": {
-    "@polkadot/api": "^4.4.1",
+    "@polkadot/api": "^4.4.2-0",
     "@polkadot/apps-config": "^0.86.2",
     "@polkadot/util-crypto": "^6.0.5",
     "@substrate/calc": "^0.2.0",
@@ -47,15 +47,15 @@
     "winston": "^3.3.3"
   },
   "devDependencies": {
-    "@substrate/dev": "^0.3.0",
+    "@substrate/dev": "^0.4.0",
     "@types/express": "^4.17.11",
-    "@types/express-serve-static-core": "^4.17.18",
+    "@types/express-serve-static-core": "^4.17.19",
     "@types/http-errors": "^1.6.3",
     "@types/morgan": "^1.9.2",
     "@types/triple-beam": "^1.3.2",
     "rimraf": "^3.0.2",
     "standard-version": "^9.1.1",
-    "ts-jest": "^26.5.3",
+    "ts-jest": "^26.5.4",
     "tsc-watch": "^4.2.9",
     "typescript": "4.2.3"
   },

src/chains-config/defaultControllers.ts

@@ -24,6 +24,7 @@ export const defaultControllers: ControllerConfig = {
 		TransactionSubmit: true,
 		PalletsStakingProgress: true,
 		PalletsStorage: true,
+		Paras: true,
 	},
 	options: {
 		finalizes: true,

src/chains-config/dockMainnetControllers.ts

@@ -23,6 +23,7 @@ export const dockMainnetControllers: ControllerConfig = {
 		TransactionSubmit: true,
 		PalletsStakingProgress: false,
 		PalletsStorage: true,
+		Paras: false,
 	},
 	options: {
 		finalizes: true,

src/chains-config/dockTestnetControllers.ts

@@ -23,6 +23,7 @@ export const dockTestnetControllers: ControllerConfig = {
 		TransactionSubmit: true,
 		PalletsStakingProgress: false,
 		PalletsStorage: true,
+		Paras: false,
 	},
 	options: {
 		finalizes: true,

src/chains-config/kulupuControllers.ts

@@ -20,6 +20,7 @@ export const kulupuControllers: ControllerConfig = {
 		TransactionSubmit: true,
 		PalletsStakingProgress: false,
 		PalletsStorage: true,
+		Paras: false,
 	},
 	options: {
 		finalizes: false,

src/chains-config/kusamaControllers.ts

@@ -24,6 +24,7 @@ export const kusamaControllers: ControllerConfig = {
 		TransactionSubmit: true,
 		PalletsStakingProgress: true,
 		PalletsStorage: true,
+		Paras: true,
 	},
 	options: {
 		finalizes: true,

src/chains-config/mandalaControllers.ts

@@ -23,6 +23,7 @@ export const mandalaControllers: ControllerConfig = {
 		TransactionSubmit: true,
 		PalletsStakingProgress: true,
 		PalletsStorage: true,
+		Paras: true,
 	},
 	options: {
 		finalizes: true,

src/chains-config/metadata-consts/index.ts

@@ -1,6 +1,8 @@
 import {
 	BlockWeightStore,
 	ExtBaseWeightValue,
+	isExtBaseWeightValue,
+	isPerClassValue,
 	MetadataConsts,
 	PerClassValue,
 } from '../../types/chains-config';
@@ -39,14 +41,11 @@ export function generateBlockWeightStore(
 		for (const version of runtimeVersions) {
 			blockWeightStore[version] = {};
 
-			if ((def as ExtBaseWeightValue).extrinsicBaseWeight) {
-				(blockWeightStore[
-					version
-				] as ExtBaseWeightValue).extrinsicBaseWeight = (def as ExtBaseWeightValue).extrinsicBaseWeight;
-			} else if ((def as PerClassValue).perClass) {
-				(blockWeightStore[
-					version
-				] as PerClassValue).perClass = (def as PerClassValue).perClass;
+			if (isExtBaseWeightValue(def)) {
+				(blockWeightStore[version] as ExtBaseWeightValue).extrinsicBaseWeight =
+					def.extrinsicBaseWeight;
+			} else if (isPerClassValue(def)) {
+				(blockWeightStore[version] as PerClassValue).perClass = def.perClass;
 			} else {
 				throw new Error(
 					'No Valid weight type found while generating block weight store'

src/chains-config/polkadotControllers.ts

@@ -24,6 +24,7 @@ export const polkadotControllers: ControllerConfig = {
 		TransactionSubmit: true,
 		PalletsStakingProgress: true,
 		PalletsStorage: true,
+		Paras: true,
 	},
 	options: {
 		finalizes: true,

src/chains-config/westendControllers.ts

@@ -24,6 +24,7 @@ export const westendControllers: ControllerConfig = {
 		TransactionSubmit: true,
 		PalletsStakingProgress: true,
 		PalletsStorage: true,
+		Paras: true,
 	},
 	options: {
 		finalizes: true,

src/controllers/AbstractController.ts

@@ -10,6 +10,7 @@ import {
 	IAddressNumberParams,
 	IAddressParam,
 	INumberParam,
+	IParaIdParam,
 } from 'src/types/requests';
 
 import { sanitizeNumbers } from '../sanitize';
@@ -19,6 +20,7 @@ type SidecarRequestHandler =
 	| RequestHandler<IAddressParam>
 	| RequestHandler<IAddressNumberParams>
 	| RequestHandler<INumberParam>
+	| RequestHandler<IParaIdParam>
 	| RequestHandler;
 
 /**

src/controllers/index.ts

@@ -7,6 +7,7 @@ import {
 import { Blocks, BlocksExtrinsics } from './blocks';
 import { NodeNetwork, NodeTransactionPool, NodeVersion } from './node';
 import { PalletsStakingProgress, PalletsStorage } from './pallets';
+import { Paras } from './paras';
 import { RuntimeCode, RuntimeMetadata, RuntimeSpec } from './runtime';
 import {
 	TransactionDryRun,
@@ -37,4 +38,5 @@ export const controllers = {
 	TransactionFeeEstimate,
 	TransactionMaterial,
 	TransactionSubmit,
+	Paras,
 };

src/controllers/paras/ParasController.ts

@@ -0,0 +1,104 @@
+import { ApiPromise } from '@polkadot/api';
+import { RequestHandler } from 'express';
+import { IParaIdParam } from 'src/types/requests';
+
+import { ParasService } from '../../services';
+import AbstractController from '../AbstractController';
+
+export default class ParasController extends AbstractController<ParasService> {
+	constructor(api: ApiPromise) {
+		super(api, '/experimental/paras', new ParasService(api));
+		this.initRoutes();
+	}
+
+	protected initRoutes(): void {
+		this.safeMountAsyncGetHandlers([
+			['/', this.getParas],
+			['/crowdloans', this.getCrowdloans],
+			['/:paraId/crowdloan-info', this.getCrowdloanInfo],
+			['/:paraId/lease-info', this.getLeaseInfo],
+			['/leases/current', this.getLeasesCurrent],
+			['/auctions/current', this.getAuctionsCurrent],
+		]);
+	}
+
+	private getParas: RequestHandler = async (
+		{ query: { at } },
+		res
+	): Promise<void> => {
+		const hash = await this.getHashFromAt(at);
+		ParasController.sanitizedSend(res, await this.service.paras(hash));
+	};
+
+	private getCrowdloanInfo: RequestHandler<IParaIdParam> = async (
+		{ params: { paraId }, query: { at } },
+		res
+	): Promise<void> => {
+		const hash = await this.getHashFromAt(at);
+		const paraIdArg = this.parseNumberOrThrow(
+			paraId,
+			'paraId must be an integer'
+		);
+
+		ParasController.sanitizedSend(
+			res,
+			await this.service.crowdloansInfo(hash, paraIdArg)
+		);
+	};
+
+	private getCrowdloans: RequestHandler = async (
+		{ query: { at, fundInfo } },
+		res
+	): Promise<void> => {
+		const hash = await this.getHashFromAt(at);
+
+		const includeFundInfo = fundInfo === 'true' ? true : false;
+
+		ParasController.sanitizedSend(
+			res,
+			await this.service.crowdloans(hash, includeFundInfo)
+		);
+	};
+
+	private getLeaseInfo: RequestHandler<IParaIdParam> = async (
+		{ params: { paraId }, query: { at } },
+		res
+	): Promise<void> => {
+		const hash = await this.getHashFromAt(at);
+		const paraIdArg = this.parseNumberOrThrow(
+			paraId,
+			'paraId must be an integer'
+		);
+
+		ParasController.sanitizedSend(
+			res,
+			await this.service.leaseInfo(hash, paraIdArg)
+		);
+	};
+
+	private getLeasesCurrent: RequestHandler = async (
+		{ query: { at, currentLeaseHolders } },
+		res
+	): Promise<void> => {
+		const hash = await this.getHashFromAt(at);
+		const includeCurrentLeaseHolders =
+			currentLeaseHolders === 'false' ? false : true;
+
+		ParasController.sanitizedSend(
+			res,
+			await this.service.leasesCurrent(hash, includeCurrentLeaseHolders)
+		);
+	};
+
+	private getAuctionsCurrent: RequestHandler = async (
+		{ query: { at } },
+		res
+	): Promise<void> => {
+		const hash = await this.getHashFromAt(at);
+
+		ParasController.sanitizedSend(
+			res,
+			await this.service.auctionsCurrent(hash)
+		);
+	};
+}

src/controllers/paras/index.ts

@@ -0,0 +1 @@
+export { default as Paras } from './ParasController';

src/services/blocks/BlocksService.ts

@@ -21,9 +21,9 @@ import { BadRequest, InternalServerError } from 'http-errors';
 
 import {
 	BlockWeightStore,
-	ExtBaseWeightValue,
 	IPerClass,
-	PerClassValue,
+	isExtBaseWeightValue,
+	isPerClassValue,
 	WeightValue,
 } from '../../types/chains-config';
 import {
@@ -261,21 +261,14 @@ export class BlocksService extends AbstractService {
 			 * https://github.com/paritytech/substrate-api-sidecar/issues/393 .
 			 * https://github.com/polkadot-js/api/issues/2365
 			 */
+			// This makes the compiler happy for below type guards
+			const weightStored = this.blockWeightStore[specVersion];
 			let extrinsicBaseWeight;
-			if (
-				// 0 is a falsy value so we need to check if undefined
-				(this.blockWeightStore[specVersion] as ExtBaseWeightValue)
-					.extrinsicBaseWeight !== undefined
-			) {
-				extrinsicBaseWeight = (this.blockWeightStore[
-					specVersion
-				] as ExtBaseWeightValue).extrinsicBaseWeight;
-			} else if (
-				(this.blockWeightStore[specVersion] as PerClassValue).perClass
-			) {
-				extrinsicBaseWeight = (this.blockWeightStore[
-					specVersion
-				] as PerClassValue)?.perClass[weightInfoClass]?.baseExtrinsic;
+			if (isExtBaseWeightValue(weightStored)) {
+				extrinsicBaseWeight = weightStored.extrinsicBaseWeight;
+			} else if (isPerClassValue(weightStored)) {
+				extrinsicBaseWeight =
+					weightStored.perClass[weightInfoClass]?.baseExtrinsic;
 			}
 
 			if (!extrinsicBaseWeight) {

src/services/index.ts

@@ -2,5 +2,6 @@ export * from './accounts';
 export * from './blocks';
 export * from './node';
 export * from './pallets';
+export * from './paras';
 export * from './runtime';
 export * from './transaction';