feat: coretime implementation

src/chains-config/coretimeControllers.ts

@@ -0,0 +1,54 @@
+// Copyright 2017-2024 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/>.
+
+import { ControllerConfig } from '../types/chains-config';
+import { initLRUCache, QueryFeeDetailsCache } from './cache';
+
+/**
+ * Polkadot configuration for Sidecar.
+ */
+export const coretimeControllers: ControllerConfig = {
+	controllers: [
+		'AccountsBalanceInfo',
+		'AccountsConvert',
+		'AccountsProxyInfo',
+		'Blocks',
+		'BlocksExtrinsics',
+		'BlocksTrace',
+		'BlocksRawExtrinsics',
+		'NodeNetwork',
+		'NodeVersion',
+		'PalletsConsts',
+		'PalletsErrors',
+		'PalletsEvents',
+		'PalletsNominationPools',
+		'PalletsOnGoingReferenda',
+		'PalletsStakingProgress',
+		'PalletsStakingValidators',
+		'PalletsStorage',
+		'RuntimeCode',
+		'RuntimeMetadata',
+		'RuntimeSpec',
+		'CoretimeGeneric',
+		'CoretimeChain',
+	],
+	options: {
+		finalizes: true,
+		minCalcFeeRuntime: 0,
+		blockStore: initLRUCache(),
+		hasQueryFeeApi: new QueryFeeDetailsCache(27, 28),
+	},
+};

src/chains-config/index.ts

@@ -28,6 +28,7 @@ import { astarControllers } from './astarControllers';
 import { bifrostControllers } from './bifrostControllers';
 import { bifrostPolkadotControllers } from './bifrostPolkadotControllers';
 import { calamariControllers } from './calamariControllers';
+import { coretimeControllers } from './coretimeControllers';
 import { crustControllers } from './crustControllers';
 import { defaultControllers } from './defaultControllers';
 import { dockMainnetControllers } from './dockMainnetControllers';
@@ -77,6 +78,9 @@ const specToControllerMap: { [x: string]: ControllerConfig } = {
 	bifrost_polkadot: bifrostPolkadotControllers,
 	heiko: heikoControllers,
 	parallel: parallelControllers,
+	'coretime-westend': coretimeControllers,
+	'coretime-polkadot': coretimeControllers,
+	'coretime-kusama': coretimeControllers,
 };
 
 /**

src/chains-config/kusamaControllers.ts

@@ -53,6 +53,7 @@ export const kusamaControllers: ControllerConfig = {
 		'TransactionFeeEstimate',
 		'TransactionMaterial',
 		'TransactionSubmit',
+		'CoretimeGeneric',
 	],
 	options: {
 		finalizes: true,

src/chains-config/polkadotControllers.ts

@@ -53,6 +53,7 @@ export const polkadotControllers: ControllerConfig = {
 		'TransactionFeeEstimate',
 		'TransactionMaterial',
 		'TransactionSubmit',
+		'CoretimeGeneric',
 	],
 	options: {
 		finalizes: true,

src/chains-config/westendControllers.ts

@@ -52,6 +52,7 @@ export const westendControllers: ControllerConfig = {
 		'TransactionFeeEstimate',
 		'TransactionMaterial',
 		'TransactionSubmit',
+		'CoretimeGeneric',
 	],
 	options: {
 		finalizes: true,

src/controllers/coretime/CoretimeChainController.ts

@@ -0,0 +1,78 @@
+// Copyright 2017-2024 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/>.
+
+import { ApiPromise } from '@polkadot/api';
+import { RequestHandler } from 'express';
+
+import { CoretimeService } from '../../services';
+import AbstractController from '../AbstractController';
+
+export default class CoretimeChainController extends AbstractController<CoretimeService> {
+	constructor(api: ApiPromise) {
+		super(api, '/coretime', new CoretimeService(api));
+		this.initRoutes();
+	}
+	// TODO: check if its either coretime or relay chain, if neither error out
+	protected initRoutes(): void {
+		this.safeMountAsyncGetHandlers([
+			['/leases', this.getLeases], // :taskId
+			['/regions', this.getRegions],
+			['/renewals', this.getRenewals],
+			['/reservations', this.getReservations],
+		]);
+	}
+
+	private checkCoretimeModule = (): void => {
+		if (this.api.query.onDemandAssignmentProvider && this.api.query.coretimeAssignmentProvider) {
+			return;
+		} else if (this.api.query.broker) {
+			return;
+		}
+		throw new Error('One or more coretime modules are not available on this network.');
+	};
+
+	private getLeases: RequestHandler = async ({ query: { at } }, res): Promise<void> => {
+		this.checkCoretimeModule();
+
+		const hash = await this.getHashFromAt(at);
+
+		CoretimeChainController.sanitizedSend(res, await this.service.getCoretimeLeases(hash));
+	};
+
+	private getRegions: RequestHandler = async ({ query: { at } }, res): Promise<void> => {
+		this.checkCoretimeModule();
+
+		const hash = await this.getHashFromAt(at);
+
+		CoretimeChainController.sanitizedSend(res, await this.service.getCoretimeRegions(hash));
+	};
+
+	private getReservations: RequestHandler = async ({ query: { at } }, res): Promise<void> => {
+		this.checkCoretimeModule();
+
+		const hash = await this.getHashFromAt(at);
+
+		CoretimeChainController.sanitizedSend(res, await this.service.getCoretimeReservations(hash));
+	};
+
+	private getRenewals: RequestHandler = async ({ query: { at } }, res): Promise<void> => {
+		this.checkCoretimeModule();
+
+		const hash = await this.getHashFromAt(at);
+
+		CoretimeChainController.sanitizedSend(res, await this.service.getCoretimeRenewals(hash));
+	};
+}

src/controllers/coretime/CoretimeGenericController.ts

@@ -0,0 +1,60 @@
+// Copyright 2017-2024 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/>.
+
+import { ApiPromise } from '@polkadot/api';
+import { RequestHandler } from 'express';
+
+import { CoretimeService } from '../../services';
+import AbstractController from '../AbstractController';
+
+export default class CoretimeGenericController extends AbstractController<CoretimeService> {
+	constructor(api: ApiPromise) {
+		super(api, '/coretime', new CoretimeService(api));
+		this.initRoutes();
+	}
+	// TODO: check if its either coretime or relay chain, if neither error out
+	protected initRoutes(): void {
+		this.safeMountAsyncGetHandlers([
+			['/info', this.getCoretimeOverview],
+			['/overview', this.getCoretimeCores],
+		]);
+	}
+
+	private getCoretimeOverview: RequestHandler = async ({ query: { at } }, res): Promise<void> => {
+		this.checkCoretimeModule();
+
+		const hash = await this.getHashFromAt(at);
+
+		CoretimeGenericController.sanitizedSend(res, await this.service.getCoretimeInfo(hash));
+	};
+
+	private getCoretimeCores: RequestHandler = async ({ query: { at } }, res): Promise<void> => {
+		this.checkCoretimeModule();
+
+		const hash = await this.getHashFromAt(at);
+
+		CoretimeGenericController.sanitizedSend(res, await this.service.getCoretimeCores(hash));
+	};
+
+	private checkCoretimeModule = (): void => {
+		if (this.api.query.onDemandAssignmentProvider && this.api.query.coretimeAssignmentProvider) {
+			return;
+		} else if (this.api.query.broker) {
+			return;
+		}
+		throw new Error('One or more coretime modules are not available on this network.');
+	};
+}

src/controllers/coretime/index.ts

@@ -0,0 +1,18 @@
+// Copyright 2017-2024 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/>.
+
+export { default as CoretimeChain } from './CoretimeChainController';
+export { default as CoretimeGeneric } from './CoretimeGenericController';

src/controllers/index.ts

@@ -27,6 +27,7 @@ import {
 } from './accounts';
 import { Blocks, BlocksExtrinsics, BlocksRawExtrinsics, BlocksTrace } from './blocks';
 import { ContractsInk } from './contracts';
+import { CoretimeChain, CoretimeGeneric } from './coretime';
 import { NodeNetwork, NodeTransactionPool, NodeVersion } from './node';
 import {
 	PalletsAssetConversion,
@@ -89,4 +90,6 @@ export const controllers = {
 	TransactionMaterial,
 	TransactionSubmit,
 	Paras,
+	CoretimeGeneric,
+	CoretimeChain,
 };