fix: remove getChainIdBySpecName and add caching system (#288)

src/AssetTransferApi.ts

@@ -26,7 +26,6 @@ import {
 import { establishXcmPallet, XcmPalletName } from './createXcmCalls/util/establishXcmPallet';
 import { assetIdsContainRelayAsset } from './createXcmTypes/util/assetIdsContainsRelayAsset';
 import { getAssetId } from './createXcmTypes/util/getAssetId';
-import { getChainIdBySpecName } from './createXcmTypes/util/getChainIdBySpecName';
 import { isParachainPrimaryNativeAsset } from './createXcmTypes/util/isParachainPrimaryNativeAsset';
 import { isSystemChain } from './createXcmTypes/util/isSystemChain';
 import { multiLocationAssetIsParachainsNativeAsset } from './createXcmTypes/util/multiLocationAssetIsParachainsNativeAsset';
@@ -161,7 +160,7 @@ export class AssetTransferApi {
 		 */
 		const addr = sanitizeAddress(destAddr);
 
-		const originChainId = getChainIdBySpecName(registry, _specName);
+		const originChainId = registry.lookupChainIdBySpecName(_specName);
 		const isLocalSystemTx = isOriginSystemParachain && isDestSystemParachain && originChainId === destChainId;
 		const isLocalRelayTx = destChainId === '0' && RELAY_CHAIN_NAMES.includes(_specName.toLowerCase());
 		const relayChainID = RELAY_CHAIN_IDS[0];

src/createXcmTypes/SystemToPara.ts

@@ -13,7 +13,6 @@ import type {
 import type { XcmV3MultiassetMultiAssets } from '@polkadot/types/lookup';
 import { isEthereumAddress } from '@polkadot/util-crypto';
 
-import { getChainIdBySpecName } from '../createXcmTypes/util/getChainIdBySpecName';
 import { BaseError, BaseErrorsEnum } from '../errors';
 import type { Registry } from '../registry';
 import { MultiAsset } from '../types';
@@ -205,7 +204,7 @@ export const SystemToPara: ICreateXcmType = {
 				isLiquidTokenTransfer
 			);
 
-			const systemChainId = getChainIdBySpecName(registry, specName);
+			const systemChainId = registry.lookupChainIdBySpecName(specName);
 			if (!isSystemChain(systemChainId)) {
 				throw new BaseError(
 					`specName ${specName} did not match a valid system chain ID. Found ID ${systemChainId}`,
@@ -248,7 +247,7 @@ export const createSystemToParaMultiAssets = async (
 ): Promise<MultiAsset[]> => {
 	let multiAssets: MultiAsset[] = [];
 	const palletId = fetchPalletInstanceId(api, isLiquidTokenTransfer, isForeignAssetsTransfer);
-	const systemChainId = getChainIdBySpecName(registry, specName);
+	const systemChainId = registry.lookupChainIdBySpecName(specName);
 
 	if (!isSystemChain(systemChainId)) {
 		throw new BaseError(

src/createXcmTypes/SystemToSystem.ts

@@ -12,7 +12,6 @@ import type {
 } from '@polkadot/types/interfaces';
 import type { XcmV3MultiassetMultiAssets } from '@polkadot/types/lookup';
 
-import { getChainIdBySpecName } from '../createXcmTypes/util/getChainIdBySpecName';
 import { BaseError, BaseErrorsEnum } from '../errors';
 import type { Registry } from '../registry';
 import { getFeeAssetItemIndex } from '../util/getFeeAssetItemIndex';
@@ -198,7 +197,7 @@ export const SystemToSystem: ICreateXcmType = {
 				isLiquidTokenTransfer
 			);
 
-			const systemChainId = getChainIdBySpecName(registry, specName);
+			const systemChainId = registry.lookupChainIdBySpecName(specName);
 
 			if (!isSystemChain(systemChainId)) {
 				throw new BaseError(
@@ -242,7 +241,7 @@ export const createSystemToSystemMultiAssets = async (
 	isLiquidTokenTransfer: boolean
 ): Promise<MultiAsset[]> => {
 	let multiAssets: MultiAsset[] = [];
-	const systemChainId = getChainIdBySpecName(registry, specName);
+	const systemChainId = registry.lookupChainIdBySpecName(specName);
 	const palletId = fetchPalletInstanceId(api, isLiquidTokenTransfer, isForeignAssetsTransfer);
 
 	if (!isSystemChain(systemChainId)) {

src/createXcmTypes/util/getAssetId.ts

@@ -9,7 +9,6 @@ import { Registry } from '../../registry';
 import { validateNumber } from '../../validate';
 import { foreignAssetMultiLocationIsInCacheOrRegistry } from './foreignAssetMultiLocationIsInCacheOrRegistry';
 import { foreignAssetsMultiLocationExists } from './foreignAssetsMultiLocationExists';
-import { getChainIdBySpecName } from './getChainIdBySpecName';
 
 /**
  *
@@ -30,7 +29,7 @@ export const getAssetId = async (
 	specName: string,
 	isForeignAssetsTransfer?: boolean
 ): Promise<string> => {
-	const currentChainId = getChainIdBySpecName(registry, specName);
+	const currentChainId = registry.lookupChainIdBySpecName(specName);
 	const assetIsValidInt = validateNumber(asset);
 	const isParachain = new BN(currentChainId).gte(new BN(2000));
 

src/createXcmTypes/util/isParachainPrimaryNativeAsset.ts

@@ -2,7 +2,6 @@
 
 import { Registry } from '../../registry';
 import { Direction } from '../../types';
-import { getChainIdBySpecName } from './getChainIdBySpecName';
 
 export const isParachainPrimaryNativeAsset = (
 	registry: Registry,
@@ -26,7 +25,7 @@ export const isParachainPrimaryNativeAsset = (
 		return true;
 	}
 
-	const currentChainId = getChainIdBySpecName(registry, specName);
+	const currentChainId = registry.lookupChainIdBySpecName(specName);
 	const { tokens } = registry.currentRelayRegistry[currentChainId];
 	const primaryParachainNativeAsset = tokens[0];
 	if (primaryParachainNativeAsset.toLowerCase() === assetId.toLowerCase()) {

src/errors/checkLocalTxInputs.ts

@@ -5,7 +5,6 @@ import { ApiPromise } from '@polkadot/api';
 import { foreignAssetMultiLocationIsInCacheOrRegistry } from '../createXcmTypes/util/foreignAssetMultiLocationIsInCacheOrRegistry';
 import { foreignAssetsMultiLocationExists } from '../createXcmTypes/util/foreignAssetsMultiLocationExists';
 import { getAssetId } from '../createXcmTypes/util/getAssetId';
-import { getChainIdBySpecName } from '../createXcmTypes/util/getChainIdBySpecName';
 import { checkLiquidTokenValidity } from '../errors/checkXcmTxInputs';
 import { Registry } from '../registry';
 import { BaseError, BaseErrorsEnum } from './BaseError';
@@ -65,7 +64,7 @@ export const checkLocalTxInput = async (
 		}
 	} else if (isLiquidTokenTransfer) {
 		const relayChainInfo = registry.currentRelayRegistry;
-		const systemChainId = getChainIdBySpecName(registry, specName);
+		const systemChainId = registry.lookupChainIdBySpecName(specName);
 		const systemParachainInfo = relayChainInfo[systemChainId];
 
 		// If anything is incorrect this will throw an error.
@@ -74,7 +73,7 @@ export const checkLocalTxInput = async (
 		return LocalTxType.PoolAssets;
 	} else {
 		const relayChainInfo = registry.currentRelayRegistry;
-		const systemChainId = getChainIdBySpecName(registry, specName);
+		const systemChainId = registry.lookupChainIdBySpecName(specName);
 		const systemParachainInfo = relayChainInfo[systemChainId];
 
 		/**

src/errors/checkXcmTxInputs.ts

@@ -9,7 +9,6 @@ import { XcmPalletName } from '../createXcmCalls/util/establishXcmPallet';
 import { CheckXcmTxInputsOpts } from '../createXcmTypes/types';
 import { foreignAssetMultiLocationIsInCacheOrRegistry } from '../createXcmTypes/util/foreignAssetMultiLocationIsInCacheOrRegistry';
 import { foreignAssetsMultiLocationExists } from '../createXcmTypes/util/foreignAssetsMultiLocationExists';
-import { getChainIdBySpecName } from '../createXcmTypes/util/getChainIdBySpecName';
 import { isParachainPrimaryNativeAsset } from '../createXcmTypes/util/isParachainPrimaryNativeAsset';
 import { multiLocationAssetIsParachainsNativeAsset } from '../createXcmTypes/util/multiLocationAssetIsParachainsNativeAsset';
 import { Registry } from '../registry';
@@ -433,7 +432,7 @@ const checkSystemAssets = async (
 	isForeignAssetsTransfer: boolean,
 	isLiquidTokenTransfer?: boolean
 ) => {
-	const currentChainId = getChainIdBySpecName(registry, specName);
+	const currentChainId = registry.lookupChainIdBySpecName(specName);
 
 	if (isForeignAssetsTransfer) {
 		// check that the asset id is a valid multilocation
@@ -685,7 +684,7 @@ export const checkIsValidSystemChainAssetId = async (
 	isForeignAssetsTransfer: boolean,
 	isLiquidTokenTransfer: boolean
 ) => {
-	const systemChainId = getChainIdBySpecName(registry, specName);
+	const systemChainId = registry.lookupChainIdBySpecName(specName);
 	const systemParachainInfo = relayChainInfo[systemChainId];
 
 	if (typeof assetId === 'string') {

src/registry/Registry.spec.ts

@@ -95,7 +95,20 @@ describe('Registry', () => {
 			expect(res).toEqual(expected);
 		});
 	});
-
+	describe('lookupChainIdBySpecName', () => {
+		it('Should return the correct result', () => {
+			const res = registry.lookupChainIdBySpecName('moonbeam');
+			expect(res).toEqual('2004');
+		});
+		it('Should correctly cache specNames when they have Ids', () => {
+			registry.lookupChainIdBySpecName('statemint');
+			registry.lookupChainIdBySpecName('moonbeam');
+			registry.lookupChainIdBySpecName('acala');
+			expect(registry.specNameToIdCache.has('statemint')).toEqual(true);
+			expect(registry.specNameToIdCache.has('moonbeam')).toEqual(true);
+			expect(registry.specNameToIdCache.has('acala')).toEqual(true);
+		});
+	});
 	describe('Registry cache', () => {
 		it('Should correctly add an asset to the assetsInfo cache ', () => {
 			registry.setAssetInCache('1984', 'USDt');

src/registry/Registry.ts

@@ -1,5 +1,9 @@
-import { ASSET_HUB_CHAIN_ID } from '../consts';
-import { getChainIdBySpecName } from '../createXcmTypes/util/getChainIdBySpecName';
+import {
+	ASSET_HUB_CHAIN_ID,
+	KUSAMA_ASSET_HUB_SPEC_NAMES,
+	POLKADOT_ASSET_HUB_SPEC_NAMES,
+	WESTEND_ASSET_HUB_SPEC_NAMES,
+} from '../consts';
 import type { AssetTransferApiOpts } from '../types';
 import { findRelayChain, parseRegistry } from './';
 import type {
@@ -18,13 +22,15 @@ export class Registry {
 	readonly currentRelayRegistry: ChainInfo;
 	readonly xcAssets: XCMChainInfoRegistry;
 	cache: ChainInfoRegistry;
+	specNameToIdCache: Map<string, string>;
 
 	constructor(specName: string, opts: AssetTransferApiOpts) {
 		this.specName = specName;
 		this.registry = parseRegistry(opts);
 		this.relayChain = findRelayChain(this.specName, this.registry);
 		this.currentRelayRegistry = this.registry[this.relayChain];
 		this.xcAssets = this.registry.xcAssets;
+		this.specNameToIdCache = new Map<string, string>();
 		this.cache = {
 			polkadot: {},
 			kusama: {},
@@ -42,7 +48,7 @@ export class Registry {
 	 * Initialize the cache for the current chain that is connected
 	 */
 	private initializeCurrentChainIdCache() {
-		const currentChainId = getChainIdBySpecName(this, this.specName);
+		const currentChainId = this.lookupChainIdBySpecName(this.specName);
 		if (!this.cache[this.relayChain][currentChainId]) {
 			this.cache[this.relayChain][currentChainId] = {
 				assetsInfo: {},
@@ -74,7 +80,7 @@ export class Registry {
 	 * @param assetKey string
 	 */
 	public cacheLookupForeignAsset(assetKey: string): ForeignAssetsData | undefined {
-		const currentChainId = getChainIdBySpecName(this, this.specName);
+		const currentChainId = this.lookupChainIdBySpecName(this.specName);
 		const lookup = this.cache[this.relayChain][currentChainId]['foreignAssetsInfo'];
 
 		return lookup[assetKey] ? lookup[assetKey] : undefined;
@@ -87,7 +93,7 @@ export class Registry {
 	 * @param assetValue ForeignAssetData
 	 */
 	public setForeignAssetInCache(assetKey: string, assetValue: ForeignAssetsData) {
-		const currentChainId = getChainIdBySpecName(this, this.specName);
+		const currentChainId = this.lookupChainIdBySpecName(this.specName);
 
 		this.cache[this.relayChain][currentChainId]['foreignAssetsInfo'][assetKey] = assetValue;
 	}
@@ -98,7 +104,7 @@ export class Registry {
 	 * @param assetKey string
 	 */
 	public cacheLookupPoolAsset(assetKey: string): { lpToken: string; pairInfo: string } | undefined {
-		const currentChainId = getChainIdBySpecName(this, this.specName);
+		const currentChainId = this.lookupChainIdBySpecName(this.specName);
 		const lookup = this.cache[this.relayChain][currentChainId]['poolPairsInfo'];
 
 		return lookup[assetKey] ? lookup[assetKey] : undefined;
@@ -111,7 +117,7 @@ export class Registry {
 	 * @param assetValue { lpToken: string; pairInfo: string }
 	 */
 	public setLiquidPoolTokenInCache(assetKey: string, assetValue: { lpToken: string; pairInfo: string }) {
-		const currentChainId = getChainIdBySpecName(this, this.specName);
+		const currentChainId = this.lookupChainIdBySpecName(this.specName);
 
 		this.cache[this.relayChain][currentChainId]['poolPairsInfo'][assetKey] = assetValue;
 	}
@@ -122,7 +128,7 @@ export class Registry {
 	 * @param assetKey string
 	 */
 	public cacheLookupAsset(assetKey: string): string | undefined {
-		const currentChainId = getChainIdBySpecName(this, this.specName);
+		const currentChainId = this.lookupChainIdBySpecName(this.specName);
 		const lookup = this.cache[this.relayChain][currentChainId]['assetsInfo'];
 
 		return lookup[assetKey] ? lookup[assetKey] : undefined;
@@ -135,7 +141,7 @@ export class Registry {
 	 * @param assetValue string
 	 */
 	public setAssetInCache(assetKey: string, assetValue: string) {
-		const currentChainId = getChainIdBySpecName(this, this.specName);
+		const currentChainId = this.lookupChainIdBySpecName(this.specName);
 
 		this.cache[this.relayChain][currentChainId]['assetsInfo'][assetKey] = assetValue;
 	}
@@ -227,4 +233,36 @@ export class Registry {
 		}
 		return [];
 	}
+
+	/**
+	 * Return the Id of a parachain given its specName.
+	 *
+	 * @param specName
+	 */
+	public lookupChainIdBySpecName(specName: string): string {
+		if (this.specNameToIdCache.has(specName)) {
+			return this.specNameToIdCache.get(specName) as string;
+		}
+
+		if (
+			POLKADOT_ASSET_HUB_SPEC_NAMES.includes(specName.toLowerCase()) ||
+			KUSAMA_ASSET_HUB_SPEC_NAMES.includes(specName.toLowerCase()) ||
+			WESTEND_ASSET_HUB_SPEC_NAMES.includes(specName.toLowerCase())
+		) {
+			this.specNameToIdCache.set(specName, '1000');
+			return '1000';
+		}
+
+		const paraIds = Object.keys(this.currentRelayRegistry);
+		for (let i = 0; i < paraIds.length; i++) {
+			const id = paraIds[i];
+			const chain = this.currentRelayRegistry[id];
+			if (chain.specName.toLowerCase() === specName.toLowerCase()) {
+				this.specNameToIdCache.set(specName, id);
+				return id;
+			}
+		}
+
+		return '';
+	}
 }