feat: add pallets/foreign-assets endpoint

src/chains-config/assetHubKusamaControllers.ts

@@ -34,6 +34,7 @@ export const assetHubKusamaControllers: ControllerConfig = {
 		'PalletsConsts',
 		'PalletsErrors',
 		'PalletsEvents',
+		'PalletsForeignAssets',
 		'RuntimeCode',
 		'RuntimeMetadata',
 		'RuntimeSpec',

src/chains-config/assetHubPolkadotControllers.ts

@@ -35,6 +35,7 @@ export const assetHubPolkadotControllers: ControllerConfig = {
 		'PalletsConsts',
 		'PalletsEvents',
 		'PalletsErrors',
+		'PalletsForeignAssets',
 		'RuntimeCode',
 		'RuntimeMetadata',
 		'RuntimeSpec',

src/chains-config/defaultControllers.ts

@@ -40,6 +40,7 @@ export const defaultControllers: ControllerConfig = {
 		'PalletsConsts',
 		'PalletsErrors',
 		'PalletsEvents',
+		'PalletsForeignAssets',
 		'PalletsStakingProgress',
 		'PalletsStorage',
 		'Paras',

src/controllers/index.ts

@@ -33,6 +33,7 @@ import {
 	PalletsDispatchables,
 	PalletsErrors,
 	PalletsEvents,
+	PalletsForeignAssets,
 	PalletsNominationPools,
 	PalletsStakingProgress,
 	PalletsStakingValidators,
@@ -68,6 +69,7 @@ export const controllers = {
 	PalletsConsts,
 	PalletsErrors,
 	PalletsEvents,
+	PalletsForeignAssets,
 	PalletsNominationPools,
 	PalletsStakingProgress,
 	PalletsStakingValidators,

src/controllers/pallets/PalletsForeignAssetsController.ts

@@ -0,0 +1,58 @@
+// Copyright 2017-2022 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 { PalletsForeignAssetsService } from '../../services';
+import AbstractController from '../AbstractController';
+
+/**
+ * GET asset information for all foreign assets.
+ *
+ * Query:
+ * - (Optional)`at`: Block at which to retrieve runtime version information at. Block
+ *  	identifier, as the block height or block hash. Defaults to most recent block.
+ *
+ * `/pallets/foreign-assets`
+ * Returns:
+ * - `at`: Block number and hash at which the call was made.
+ * - `items`: An array containing the `AssetDetails` and `AssetMetadata` of every foreign asset.
+ *
+ * Substrate References:
+ * - Foreign Assets Pallet Instance in Kusama Asset Hub: https://github.com/paritytech/cumulus/blob/master/parachains/runtimes/assets/asset-hub-kusama/src/lib.rs#L295
+ */
+export default class PalletsForeignAssetsController extends AbstractController<PalletsForeignAssetsService> {
+	constructor(api: ApiPromise) {
+		super(api, '/pallets/foreign-assets', new PalletsForeignAssetsService(api));
+		this.initRoutes();
+	}
+
+	protected initRoutes(): void {
+		this.safeMountAsyncGetHandlers([['', this.getForeignAssets]]);
+	}
+
+	private getForeignAssets: RequestHandler = async (
+		{ query: { at } },
+		res
+	): Promise<void> => {
+		const hash = await this.getHashFromAt(at);
+		PalletsForeignAssetsController.sanitizedSend(
+			res,
+			await this.service.fetchForeignAssets(hash)
+		);
+	};
+}

src/controllers/pallets/index.ts

@@ -20,6 +20,7 @@ export { default as PalletsConsts } from './PalletsConstsController';
 export { default as PalletsDispatchables } from './PalletsDispatchablesController';
 export { default as PalletsErrors } from './PalletsErrorsController';
 export { default as PalletsEvents } from './PalletsEventsController';
+export { default as PalletsForeignAssets } from './PalletsForeignAssetsController';
 export { default as PalletsNominationPools } from './PalletsNominationPoolsController';
 export { default as PalletsStakingProgress } from './PalletsStakingProgressController';
 export { default as PalletsStakingValidators } from './PalletsStakingValidatorsController';

src/services/pallets/PalletsDispatchablesService.ts

@@ -108,7 +108,7 @@ export class PalletsDispatchablesService extends AbstractPalletsService {
 			);
 		} else {
 			items = Object.entries(dispatchables).map(
-				(disaptchableItem) => disaptchableItem[1].meta
+				(dispatchableItem) => dispatchableItem[1].meta
 			);
 		}
 

src/services/pallets/PalletsForeignAssetsService.spec.ts

@@ -0,0 +1,85 @@
+// Copyright 2017-2022 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 { sanitizeNumbers } from '../../sanitize/sanitizeNumbers';
+import { assetsMetadata } from '../test-helpers/mock/assets/mockAssetHubKusamaData';
+import { foreignAssetsEntries } from '../test-helpers/mock/data/foreignAssetsEntries';
+import { mockAssetHubKusamaApi } from '../test-helpers/mock/mockAssetHubKusamaApi';
+import { blockHash523510 } from '../test-helpers/mock/mockBlock523510';
+import { PalletsForeignAssetsService } from './PalletsForeignAssetsService';
+
+const foreignAssetsEntriesAt = () =>
+	Promise.resolve().then(() => foreignAssetsEntries());
+
+const mockApi = {
+	...mockAssetHubKusamaApi,
+	query: {
+		foreignAssets: {
+			asset: {
+				entries: foreignAssetsEntriesAt,
+			},
+			metadata: assetsMetadata,
+		},
+	},
+} as unknown as ApiPromise;
+
+const palletsForeignAssetsService = new PalletsForeignAssetsService(mockApi);
+
+describe('PalletsForeignAssetsService', () => {
+	describe('PalletsForeignAssetsService.fetchForeignAssets', () => {
+		it('Should return the correct response for Foreign Assets', async () => {
+			const expectedResponse = {
+				at: {
+					hash: '0x814bb69eba28cf13066aa025d39526b503fc563162f1301c627548b9ccec54c8',
+					height: '523510',
+				},
+				items: [
+					{
+						foreignAssetInfo: {
+							owner: 'FBeL7DiQ6JkoypYATheXhH3GQr5de2L3hL444TP6qQr3yA9',
+							issuer: 'FBeL7DiQ6JkoypYATheXhH3GQr5de2L3hL444TP6qQr3yA9',
+							admin: 'FBeL7DiQ6JkoypYATheXhH3GQr5de2L3hL444TP6qQr3yA9',
+							freezer: 'FBeL7DiQ6JkoypYATheXhH3GQr5de2L3hL444TP6qQr3yA9',
+							supply: '0',
+							deposit: '100000000000',
+							minBalance: '1000000000',
+							isSufficient: false,
+							accounts: '0',
+							sufficients: '0',
+							approvals: '0',
+							isFrozen: false,
+						},
+						foreignAssetMetadata: {
+							deposit: '6693666633',
+							name: '0x54696e6b65726e6574',
+							symbol: '0x544e4b52',
+							decimals: '12',
+							isFrozen: false,
+						},
+					},
+				],
+			};
+
+			const response = await palletsForeignAssetsService.fetchForeignAssets(
+				blockHash523510
+			);
+
+			expect(sanitizeNumbers(response)).toStrictEqual(expectedResponse);
+		});
+	});
+});

src/services/pallets/PalletsForeignAssetsService.ts

@@ -0,0 +1,90 @@
+// Copyright 2017-2022 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 { BlockHash } from '@polkadot/types/interfaces';
+import { AnyJson } from 'src/types/polkadot-js';
+
+import { IForeignAssetInfo, IForeignAssets } from '../../types/responses';
+import { AbstractService } from '../AbstractService';
+
+export class PalletsForeignAssetsService extends AbstractService {
+	constructor(api: ApiPromise) {
+		super(api);
+	}
+
+	/**
+	 * Fetch all foreign asset's `AssetDetails` and `AssetMetadata`.
+	 *
+	 * @param hash `BlockHash` to make call at
+	 */
+	async fetchForeignAssets(hash: BlockHash): Promise<IForeignAssets> {
+		const { api } = this;
+
+		const [{ number }, foreignAssetInfo] = await Promise.all([
+			api.rpc.chain.getHeader(hash),
+			api.query.foreignAssets.asset.entries(),
+		]);
+
+		const items: IForeignAssetInfo[] = [];
+
+		/**
+		 * This will iterate through all the foreign asset entries and for each entry it will create
+		 * the `foreignAssetMultiLocation` variable based on the MultiLocation of the foreign asset.
+		 * This variable will then be used as the key to get the corresponding metadata of the foreign asset.
+		 *
+		 * This is based on the logic implemented by marshacb in asset-transfer-api-registry
+		 * https://github.com/paritytech/asset-transfer-api-registry/blob/main/src/createRegistry.ts#L193-L238
+		 */
+		for (const [assetStorageKeyData, assetInfo] of foreignAssetInfo) {
+			const foreignAssetData = assetStorageKeyData.toHuman();
+
+			if (foreignAssetData) {
+				// remove any commas from multilocation key values e.g. Parachain: 2,125 -> Parachain: 2125
+				const foreignAssetMultiLocationStr = JSON.stringify(
+					foreignAssetData[0]
+				).replace(/(\d),/g, '$1');
+				const foreignAssetMultiLocation = api.registry.createType(
+					'MultiLocation',
+					JSON.parse(foreignAssetMultiLocationStr)
+				);
+
+				const assetMetadata = await api.query.foreignAssets.metadata(
+					foreignAssetMultiLocation
+				);
+
+				if (assetMetadata) {
+					const item: IForeignAssetInfo = {
+						foreignAssetInfo: assetInfo as unknown as AnyJson,
+						foreignAssetMetadata: assetMetadata as unknown as AnyJson,
+					};
+
+					items.push(item);
+				}
+			}
+		}
+
+		const at = {
+			hash,
+			height: number.unwrap().toString(10),
+		};
+
+		return {
+			at,
+			items,
+		};
+	}
+}

src/services/pallets/index.ts

@@ -20,6 +20,7 @@ export * from './PalletsAssetConversionService';
 export * from './PalletsAssetsService';
 export * from './PalletsConstantsService';
 export * from './PalletsDispatchablesService';
+export * from './PalletsForeignAssetsService';
 export * from './PalletsNominationPoolsService';
 export * from './PalletsStakingProgressService';
 export * from './PalletsStakingValidatorsService';

src/services/test-helpers/mock/assets/mockAssetHubKusamaData.ts

@@ -0,0 +1,73 @@
+// Copyright 2017-2022 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 { AssetDetails, AssetMetadata } from '@polkadot/types/interfaces';
+import { Option } from '@polkadot/types-codec/base';
+
+import { assetHubKusamaRegistryV9430 } from '../../../../test-helpers/registries';
+
+/**
+ * This mock data uses Asset Hub Kusama specVersion V9430
+ */
+
+const falseBool = assetHubKusamaRegistryV9430.createType('bool', false);
+
+const accountId = assetHubKusamaRegistryV9430.createType(
+	'AccountId',
+	'FBeL7DiQ6JkoypYATheXhH3GQr5de2L3hL444TP6qQr3yA9'
+);
+const balanceOf = assetHubKusamaRegistryV9430.createType(
+	'BalanceOf',
+	6693666633
+);
+
+export const foreignAssetInfo = (): Option<AssetDetails> => {
+	const responseObj = {
+		owner: accountId,
+		issuer: accountId,
+		admin: accountId,
+		freezer: accountId,
+		supply: assetHubKusamaRegistryV9430.createType('u64', 0),
+		deposit: assetHubKusamaRegistryV9430.createType('BalanceOf', 100000000000),
+		minBalance: assetHubKusamaRegistryV9430.createType('u64', 1000000000),
+		isSufficient: falseBool,
+		accounts: assetHubKusamaRegistryV9430.createType('u8', 0),
+		sufficients: assetHubKusamaRegistryV9430.createType('u8', 0),
+		approvals: assetHubKusamaRegistryV9430.createType('u8', 0),
+		isFrozen: falseBool,
+	};
+
+	return assetHubKusamaRegistryV9430.createType(
+		'Option<AssetDetails>',
+		responseObj
+	);
+};
+
+export const assetsMetadata = (): Promise<Option<AssetMetadata>> =>
+	Promise.resolve().then(() => {
+		const responseObj = {
+			deposit: balanceOf,
+			name: assetHubKusamaRegistryV9430.createType('Bytes', 'Tinkernet'),
+			symbol: assetHubKusamaRegistryV9430.createType('Bytes', 'TNKR'),
+			decimals: assetHubKusamaRegistryV9430.createType('u8', 12),
+			isFrozen: falseBool,
+		};
+
+		return assetHubKusamaRegistryV9430.createType(
+			'Option<AssetMetadata>',
+			responseObj
+		);
+	});