feat: coretime implementation #1558

filvecchiato · 2024-11-29T15:50:04Z

New Feature: Implements the coretime endpoints for relay chain and for coretime chain.

It includes basic endpoints for single information record recovery, and more advanced endpoints with precomputed calculations and information.

TarikGul · 2024-12-20T13:17:18Z

src/services/coretime/CoretimeService.ts

+	}
+
+	private getChainType(specName: string): ChainType {
+		const relay = ['polkadot', 'kusama', 'westend', 'rococo', 'paseo'];


We can remove rococo from here.

TarikGul · 2024-12-20T13:17:52Z

src/controllers/coretime/CoretimeChainController.ts

+	}
+
+	private checkCoretimeModule = (): void => {
+		if (this.api.query.onDemandAssignmentProvider && this.api.query.coretimeAssignmentProvider) {


So if I understand this correct - either broker needs to exist or onDemandAssignmentProvider and coretimeAssignmentProvider?

Would there ever be a case where they all need to exists at once?

TarikGul · 2024-12-20T13:18:35Z

src/controllers/coretime/CoretimeGenericController.ts

+		CoretimeGenericController.sanitizedSend(res, await this.service.getCoretimeCores(hash));
+	};
+
+	private checkCoretimeModule = (): void => {


Same sentiment as the comment in CoretimeChain

TarikGul · 2024-12-20T13:20:58Z

src/services/coretime/CoretimeService.spec.ts

+// 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 type for the types.

TarikGul · 2024-12-20T13:21:12Z

src/services/coretime/CoretimeService.ts

+// 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 { ApiDecoration, QueryableModuleStorage } from '@polkadot/api/types';


All the types can have import type

TarikGul · 2024-12-20T13:27:08Z

src/services/coretime/CoretimeService.ts

+
+const SCALE = new BN(10000);
+
+export class CoretimeService extends AbstractService {


I checked locally, and all the types are correctly generated for all the storage queries so there isn't a need to typecast here. At least for me I had no errors building when removing all the typecasts.

TarikGul · 2024-12-20T13:27:57Z

src/services/coretime/CoretimeService.ts

+const SCALE = new BN(10000);
+
+export class CoretimeService extends AbstractService {
+	private getAndDecodeRegions = async (api: ApiDecoration<'promise'>): Promise<TRegionInfo[]> => {


Suggested change

private getAndDecodeRegions = async (api: ApiDecoration<'promise'>): Promise<TRegionInfo[]> => {

private getAndDecodeRegions = async (api: ApiDecoration<'promise'>): Promise<TRegionInfo[]> => {

const regions = await api.query.broker.regions.entries();

const regionsInfo = regions.map((region) => {

return extractRegionInfo([region[0], region[1]]);

});

return regionsInfo;

};

TarikGul · 2024-12-20T13:28:28Z

src/services/coretime/CoretimeService.ts

+
+	private getAndDecodeLeases = async (api: ApiDecoration<'promise'>): Promise<TLeaseInfo[]> => {
+		const leases = await api.query.broker.leases();
+		return (leases as unknown as Vec<PalletBrokerLeaseRecordItem>).map((lease) => extractLeaseInfo(lease));


Suggested change

return (leases as unknown as Vec<PalletBrokerLeaseRecordItem>).map((lease) => extractLeaseInfo(lease));

return leases.map((lease) => extractLeaseInfo(lease));

TarikGul · 2024-12-20T13:28:50Z

src/services/coretime/CoretimeService.ts

+		return (leases as unknown as Vec<PalletBrokerLeaseRecordItem>).map((lease) => extractLeaseInfo(lease));
+	};
+
+	private getAndDecodeWorkload = async (api: ApiDecoration<'promise'>): Promise<TWorkloadInfo[]> => {


Suggested change

private getAndDecodeWorkload = async (api: ApiDecoration<'promise'>): Promise<TWorkloadInfo[]> => {

private getAndDecodeWorkload = async (api: ApiDecoration<'promise'>): Promise<TWorkloadInfo[]> => {

const workloads = await api.query.broker.workload.entries();

return sortByCore(

workloads.map((workload) => {

return extractWorkloadInfo(workload[1], workload[0].args[0].toNumber());

}),

);

};

TarikGul · 2024-12-20T13:29:43Z

src/services/coretime/CoretimeService.ts

+		);
+	};
+
+	private getAndDecodeWorkplan = async (api: ApiDecoration<'promise'>): Promise<TWorkplanInfo[]> => {


Suggested change

private getAndDecodeWorkplan = async (api: ApiDecoration<'promise'>): Promise<TWorkplanInfo[]> => {

private getAndDecodeWorkplan = async (api: ApiDecoration<'promise'>): Promise<TWorkplanInfo[]> => {

const workplans = await api.query.broker.workplan.entries();

const wplsInfo = sortByCore(

workplans.map(([key, val]) => {

const [timeslice, core] = key.args[0].toArray();

return extractWorkplanInfo(val, core, timeslice);

}),

);

return wplsInfo;

};

TarikGul · 2024-12-20T13:30:11Z

src/services/coretime/CoretimeService.ts

+	};
+
+	private getAndDecodeSaleInfo = async (api: ApiDecoration<'promise'>): Promise<TSaleInfo | null> => {
+		const saleInfo = (await api.query.broker.saleInfo()) as unknown as Option<PalletBrokerSaleInfoRecord>;


Suggested change

const saleInfo = (await api.query.broker.saleInfo()) as unknown as Option<PalletBrokerSaleInfoRecord>;

const saleInfo = await api.query.broker.saleInfo();

TarikGul · 2024-12-20T13:30:56Z

src/services/coretime/CoretimeService.ts

+	private getAndDecodeStatus = async (api: ApiDecoration<'promise'>): Promise<TStatusInfo> => {
+		const status = await api.query.broker.status();
+
+		return extractStatusInfo(status as unknown as Option<PalletBrokerStatusRecord>);


Suggested change

return extractStatusInfo(status as unknown as Option<PalletBrokerStatusRecord>);

return extractStatusInfo(status);

TarikGul · 2024-12-20T13:31:07Z

src/services/coretime/CoretimeService.ts

+	private getAndDecodeConfiguration = async (api: ApiDecoration<'promise'>): Promise<TConfigInfo> => {
+		const configuration = await api.query.broker.configuration();
+
+		return extractConfigInfo(configuration as unknown as Option<PalletBrokerConfigRecord>);


Suggested change

return extractConfigInfo(configuration as unknown as Option<PalletBrokerConfigRecord>);

return extractConfigInfo(configuration);

TarikGul · 2024-12-20T13:31:33Z

src/services/coretime/CoretimeService.ts

+		return extractConfigInfo(configuration as unknown as Option<PalletBrokerConfigRecord>);
+	};
+
+	private getAndDecodePotentialRenewals = async (api: ApiDecoration<'promise'>): Promise<TPotentialRenewalInfo[]> => {


Suggested change

private getAndDecodePotentialRenewals = async (api: ApiDecoration<'promise'>): Promise<TPotentialRenewalInfo[]> => {

private getAndDecodePotentialRenewals = async (api: ApiDecoration<'promise'>): Promise<TPotentialRenewalInfo[]> => {

const potentialRenewals = await api.query.broker.potentialRenewals.entries();

const potentialRenewalsInfo = sortByCore(

potentialRenewals.map((renewal) => extractPotentialRenewalInfo(renewal[1], renewal[0])),

);

return potentialRenewalsInfo;

};

TarikGul · 2024-12-20T13:32:11Z

src/services/coretime/CoretimeService.ts

+	private getAndDecodeReservations = async (api: ApiDecoration<'promise'>): Promise<TReservationInfo[]> => {
+		const reservations = await api.query.broker.reservations();
+
+		return (reservations as unknown as Vec<Vec<PalletBrokerScheduleItem>>).map((res) => extractReservationInfo(res));


Suggested change

return (reservations as unknown as Vec<Vec<PalletBrokerScheduleItem>>).map((res) => extractReservationInfo(res));

return reservations.map((res) => extractReservationInfo(res));

TarikGul · 2024-12-20T13:32:24Z

src/services/coretime/CoretimeService.ts

+
+	private getAndDecodeCoreSchedules = async (api: ApiDecoration<'promise'>): Promise<Record<string, unknown>[]> => {
+		const coreSchedules = await api.query.coretimeAssignmentProvider.coreSchedules.entries();
+		return coreSchedules as unknown as Record<string, unknown>[];


Suggested change

return coreSchedules as unknown as Record<string, unknown>[];

return coreSchedules;

TarikGul · 2024-12-20T13:32:55Z

src/services/coretime/CoretimeService.ts

+		return coreSchedules as unknown as Record<string, unknown>[];
+	};
+
+	private getAndDecodeCoreDescriptors = async (api: ApiDecoration<'promise'>): Promise<TCoreDescriptor[]> => {


Suggested change

private getAndDecodeCoreDescriptors = async (api: ApiDecoration<'promise'>): Promise<TCoreDescriptor[]> => {

private getAndDecodeCoreDescriptors = async (api: ApiDecoration<'promise'>): Promise<TCoreDescriptor[]> => {

const coreDescriptors = await api.query.coretimeAssignmentProvider.coreDescriptors.entries();

return coreDescriptors.map((descriptor) => extractCoreDescriptorInfo(descriptor[0], descriptor[1]));

};

TarikGul · 2024-12-20T13:33:28Z

src/services/coretime/CoretimeService.ts

+		return descriptors.map((descriptor) => extractCoreDescriptorInfo(descriptor[0], descriptor[1]));
+	};
+
+	private getAndDecodeParachainsLifecycle = async (api: ApiDecoration<'promise'>): Promise<TParaLifecycle[]> => {


Suggested change

private getAndDecodeParachainsLifecycle = async (api: ApiDecoration<'promise'>): Promise<TParaLifecycle[]> => {

private getAndDecodeParachainsLifecycle = async (api: ApiDecoration<'promise'>): Promise<TParaLifecycle[]> => {

const parachains = await api.query.paras.paraLifecycles.entries();

return parachains.map((para) =>

extractParachainLifecycleInfo(

para[0],

para[1],

),

);

};

TarikGul · 2024-12-20T13:35:48Z

src/services/coretime/util.ts

+	};
+}
+
+export function extractCoreScheduleInfo() {}


Unused function?

TarikGul

Overall amazing PR! I have a few nits:

The typecasting can be removed. AFAIU the types are correctly passed down from PJS so you should be good.
For any imported types we can use import type.

Other than that the PR looks really great!

filvecchiato force-pushed the filippo_coretime_implementation branch from 744895d to 6de3395 Compare November 29, 2024 15:52

filvecchiato changed the title ~~Filippo coretime implementation~~ Feat: coretime implementation Nov 29, 2024

filvecchiato force-pushed the filippo_coretime_implementation branch from 4efc743 to f6e8a77 Compare December 9, 2024 15:15

filvecchiato changed the title ~~Feat: coretime implementation~~ feat: coretime implementation Dec 9, 2024

filvecchiato added 15 commits December 19, 2024 16:58

init coretime

99163a5

prep for coretime support

2673c2b

update coretime service:

59d7235

feat: first iteration at coretime impl

8709dfb

fix coretime service

b2d5d54

update blocks per timeslice

b55f820

impl registries kusama and coretime chain v1003003

7e06e4b

housekeep for coretime tests

14ee64b

linting

4e0775d

tests passing for leases, renewals, regions

8240c6a

passing reservations

46ce0d3

passing tests cores info

fdf0498

tests for cores endpoint

9fe08da

prep for api docs for coretime

99c0239

coretime docs updated

e8a0808

filvecchiato force-pushed the filippo_coretime_implementation branch from 9ef9d68 to e8a0808 Compare December 19, 2024 15:59

filvecchiato added 4 commits December 20, 2024 11:29

reworked coretime/info endpoint to be more informative

2fc1636

change endpoint from cores to overview

a05d3e5

passing tests

e4e995f

update docs

4dcdf17

filvecchiato force-pushed the filippo_coretime_implementation branch from 142039d to 4dcdf17 Compare December 20, 2024 11:12

Delete .env

8c3a776

filvecchiato marked this pull request as ready for review December 20, 2024 11:13

filvecchiato requested a review from a team as a code owner December 20, 2024 11:13

filvecchiato requested review from IkerAlus and Imod7 December 20, 2024 11:41

TarikGul reviewed Dec 20, 2024

View reviewed changes

src/services/coretime/util.ts

};

}

export function extractCoreScheduleInfo() {}

Copy link

Member

TarikGul Dec 20, 2024 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unused function?

TarikGul requested changes Dec 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: coretime implementation #1558

feat: coretime implementation #1558

filvecchiato commented Nov 29, 2024 •

edited

Loading

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024

TarikGul Dec 20, 2024 •

edited

Loading

TarikGul left a comment


		const SCALE = new BN(10000);

		export class CoretimeService extends AbstractService {

-	private getAndDecodeRegions = async (api: ApiDecoration<'promise'>): Promise<TRegionInfo[]> => {
+	private getAndDecodeRegions = async (api: ApiDecoration<'promise'>): Promise<TRegionInfo[]> => {
+		const regions = await api.query.broker.regions.entries();
+		const regionsInfo = regions.map((region) => {
+			return extractRegionInfo([region[0], region[1]]);
+		});
+		return regionsInfo;
+	};

	return (leases as unknown as Vec<PalletBrokerLeaseRecordItem>).map((lease) => extractLeaseInfo(lease));
	return leases.map((lease) => extractLeaseInfo(lease));

-	private getAndDecodeWorkload = async (api: ApiDecoration<'promise'>): Promise<TWorkloadInfo[]> => {
+	private getAndDecodeWorkload = async (api: ApiDecoration<'promise'>): Promise<TWorkloadInfo[]> => {
+		const workloads = await api.query.broker.workload.entries();
+		return sortByCore(
+			workloads.map((workload) => {
+				return extractWorkloadInfo(workload[1], workload[0].args[0].toNumber());
+			}),
+		);
+	};

-	private getAndDecodeWorkplan = async (api: ApiDecoration<'promise'>): Promise<TWorkplanInfo[]> => {
+	private getAndDecodeWorkplan = async (api: ApiDecoration<'promise'>): Promise<TWorkplanInfo[]> => {
+		const workplans = await api.query.broker.workplan.entries();
+		const wplsInfo = sortByCore(
+			workplans.map(([key, val]) => {
+				const [timeslice, core] = key.args[0].toArray();
+				return extractWorkplanInfo(val, core, timeslice);
+			}),
+		);
+		return wplsInfo;
+	};

	const saleInfo = (await api.query.broker.saleInfo()) as unknown as Option<PalletBrokerSaleInfoRecord>;
	const saleInfo = await api.query.broker.saleInfo();

	return extractStatusInfo(status as unknown as Option<PalletBrokerStatusRecord>);
	return extractStatusInfo(status);

	return extractConfigInfo(configuration as unknown as Option<PalletBrokerConfigRecord>);
	return extractConfigInfo(configuration);

-	private getAndDecodePotentialRenewals = async (api: ApiDecoration<'promise'>): Promise<TPotentialRenewalInfo[]> => {
+	private getAndDecodePotentialRenewals = async (api: ApiDecoration<'promise'>): Promise<TPotentialRenewalInfo[]> => {
+		const potentialRenewals = await api.query.broker.potentialRenewals.entries();
+		const potentialRenewalsInfo = sortByCore(
+			potentialRenewals.map((renewal) => extractPotentialRenewalInfo(renewal[1], renewal[0])),
+		);
+		return potentialRenewalsInfo;
+	};

	return (reservations as unknown as Vec<Vec<PalletBrokerScheduleItem>>).map((res) => extractReservationInfo(res));
	return reservations.map((res) => extractReservationInfo(res));

	return coreSchedules as unknown as Record<string, unknown>[];
	return coreSchedules;

-	private getAndDecodeParachainsLifecycle = async (api: ApiDecoration<'promise'>): Promise<TParaLifecycle[]> => {
+	private getAndDecodeParachainsLifecycle = async (api: ApiDecoration<'promise'>): Promise<TParaLifecycle[]> => {
+		const parachains = await api.query.paras.paraLifecycles.entries();
+		return parachains.map((para) =>
+			extractParachainLifecycleInfo(
+				para[0],
+				para[1],
+			),
+		);
+	};

feat: coretime implementation #1558

Are you sure you want to change the base?

feat: coretime implementation #1558

Conversation

filvecchiato commented Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TarikGul Dec 20, 2024 • edited Loading

Choose a reason for hiding this comment

TarikGul left a comment

Choose a reason for hiding this comment

filvecchiato commented Nov 29, 2024 •

edited

Loading

TarikGul Dec 20, 2024 •

edited

Loading