patches to coretime controllers

paritytech · Jan 3, 2025 · 1c8dbe4 · 1c8dbe4
1 parent 62523c1
commit 1c8dbe4
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 51 deletions.
diff --git a/docs/src/openapi-v1.yaml b/docs/src/openapi-v1.yaml
@@ -3187,7 +3187,7 @@ components:
       properties:
         at:
           $ref: '#/components/schemas/BlockIdentifiers'
-        regions:
+        leases:
           type: array
           items:
             $ref: '#/components/schemas/CoretimeLease'
@@ -3196,7 +3196,7 @@ components:
       properties:
         at:
           $ref: '#/components/schemas/BlockIdentifiers'
-        regions:
+        reservations:
           type: array
           items:
             $ref: '#/components/schemas/CoretimeReservation'
@@ -3205,7 +3205,7 @@ components:
       properties:
         at:
           $ref: '#/components/schemas/BlockIdentifiers'
-        regions:
+        renewals:
           type: array
           items:
             $ref: '#/components/schemas/CoretimeRenewal'

diff --git a/src/chains-config/polkadotControllers.ts b/src/chains-config/polkadotControllers.ts
@@ -53,7 +53,6 @@ export const polkadotControllers: ControllerConfig = {
 		'TransactionFeeEstimate',
 		'TransactionMaterial',
 		'TransactionSubmit',
-		'CoretimeGeneric',
 	],
 	options: {
 		finalizes: true,

diff --git a/src/controllers/coretime/CoretimeChainController.ts b/src/controllers/coretime/CoretimeChainController.ts
@@ -25,7 +25,7 @@ export default class CoretimeChainController extends AbstractController<Coretime
 		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
@@ -35,42 +35,25 @@ export default class CoretimeChainController extends AbstractController<Coretime
 		]);
 	}
 
-	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));

diff --git a/src/controllers/coretime/CoretimeGenericController.ts b/src/controllers/coretime/CoretimeGenericController.ts
@@ -25,7 +25,7 @@ export default class CoretimeGenericController extends AbstractController<Coreti
 		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],
@@ -34,27 +34,14 @@ export default class CoretimeGenericController extends AbstractController<Coreti
 	}
 
 	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.');
-	};
 }
diff --git a/src/services/coretime/CoretimeService.ts b/src/services/coretime/CoretimeService.ts
@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable @typescript-eslint/no-unsafe-return */
-// Copyright 2017-2024 Parity Technologies (UK) Ltd.
+// Copyright 2017-2025 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
@@ -21,15 +21,6 @@ import type { ApiDecoration, QueryableModuleStorage } from '@polkadot/api/types'
 import type { Option, StorageKey, U32 } from '@polkadot/types';
 import type { BlockHash, ParaId } from '@polkadot/types/interfaces';
 import type {
-	// PalletBrokerConfigRecord,
-	// PalletBrokerLeaseRecordItem,
-	// PalletBrokerPotentialRenewalId,
-	// PalletBrokerPotentialRenewalRecord,
-	// PalletBrokerRegionId,
-	// PalletBrokerRegionRecord,
-	// PalletBrokerSaleInfoRecord,
-	// PalletBrokerScheduleItem,
-	// PalletBrokerStatusRecord,
 	PolkadotRuntimeParachainsAssignerCoretimeCoreDescriptor,
 	PolkadotRuntimeParachainsParasParaLifecycle,
 } from '@polkadot/types/lookup';
@@ -269,7 +260,6 @@ export class CoretimeService extends AbstractService {
 		};
 	};
 
-	// both relay and coretime chain
 	async getCoretimeInfo(hash: BlockHash): Promise<ICoretimeRelayInfo | ICoretimeChainInfo> {
 		const { api } = this;
 
@@ -300,7 +290,6 @@ export class CoretimeService extends AbstractService {
 				maxHistoricalRevenue: maxHistoricalRevenue as unknown as number,
 			};
 		} else {
-			// coretime chain or parachain
 			this.assertCoretimeModule(historicApi, ChainType.Parachain);
 			const [config, saleInfo, timeslicePeriod, status] = await Promise.all([
 				this.getAndDecodeConfiguration(historicApi),
@@ -368,7 +357,6 @@ export class CoretimeService extends AbstractService {
 		if (this.getChainType(specName.toString()) === ChainType.Relay) {
 			throw new Error('This endpoint is only available on coretime chains.');
 		} else {
-			// coretime chain or parachain
 			this.assertCoretimeModule(historicApi, ChainType.Parachain);
 			const [leases, workload] = await Promise.all([
 				this.getAndDecodeLeases(historicApi),
@@ -410,7 +398,6 @@ export class CoretimeService extends AbstractService {
 		if (this.getChainType(specName.toString()) === ChainType.Relay) {
 			throw new Error('This endpoint is only available on coretime chains.');
 		} else {
-			// coretime chain or parachain
 			this.assertCoretimeModule(historicApi, ChainType.Parachain);
 
 			const regions = await this.getAndDecodeRegions(historicApi);
@@ -468,7 +455,6 @@ export class CoretimeService extends AbstractService {
 		if (this.getChainType(specName.toString()) === ChainType.Relay) {
 			throw new Error('This endpoint is only available on coretime chains.');
 		} else {
-			// coretime chain or parachain
 			this.assertCoretimeModule(historicApi, ChainType.Parachain);
 
 			const renewals = await this.getAndDecodePotentialRenewals(historicApi);
@@ -495,6 +481,7 @@ export class CoretimeService extends AbstractService {
 		const blockNumber = number.unwrap();
 
 		if (this.getChainType(specName.toString()) === ChainType.Relay) {
+			this.assertCoretimeModule(historicApi, ChainType.Relay);
 			const [parachains, schedules, descriptors] = await Promise.all([
 				this.getAndDecodeParachainsLifecycle(historicApi),
 				this.getAndDecodeCoreSchedules(historicApi),
@@ -524,6 +511,7 @@ export class CoretimeService extends AbstractService {
 				coreSchedules: schedules,
 			};
 		} else {
+			this.assertCoretimeModule(historicApi, ChainType.Parachain);
 			const [workload, workplan, leases, reservations, regions] = await Promise.all([
 				this.getAndDecodeWorkload(historicApi),
 				this.getAndDecodeWorkplan(historicApi),