feat: inject controllers using metadata's definition of pallets (#1592)

* adds naming to AbstractController and to controllers

* wip:injected controllers

* inject controllers using metadata

* inject controllers using metadata

* removed unused method

* injects controllers using pallets in metadata

* lint

* update requiredPallets abstract definition

* update injected flag to make injected controllers not default (no breaking changes)

* Update README.md

Co-authored-by: Dominique <[email protected]>

* Update src/chains-config/index.ts

Co-authored-by: Dominique <[email protected]>

* fix default options

* remove log

* update readme

* Update src/controllers/coretime/CoretimeChainController.ts

Co-authored-by: Dominique <[email protected]>

* Update src/controllers/coretime/CoretimeGenericController.ts

Co-authored-by: Dominique <[email protected]>

* linting

* rebase and fix tests

---------

Co-authored-by: Dominique <[email protected]>

Author: filvecchiato

README.md

@@ -165,6 +165,7 @@ For more information on our configuration manager visit its readme [here](https:
 - `SAS_EXPRESS_PORT`: port on which the server will be listening, defaults to `8080`.
 - `SAS_EXPRESS_KEEP_ALIVE_TIMEOUT`: Set the `keepAliveTimeout` in express.
 - `SAS_EXPRESS_MAX_BODY`: Set the size of request body payload, defaults to `100kb`
+- `SAS_EXPRESS_INJECTED_CONTROLLERS`: When set (_e.g. SAS_EXPRESS_INJECTED_CONTROLLERS=true_), automatically detects the available pallets in the chain's metadata and injects the appropriate controllers. If set to `false`, it uses the controllers defined in the chains configuration files. Defaults to `false` when the flag is not defined. Note: This flag does not replace completely the need of the chains-config files since we are still retrieving the options from that file. 
 
 ### Substrate node
 

src/SidecarConfig.ts

@@ -55,6 +55,7 @@ export class SidecarConfig {
 				PORT: config.Get(MODULES.EXPRESS, CONFIG.PORT) as number,
 				KEEP_ALIVE_TIMEOUT: config.Get(MODULES.EXPRESS, CONFIG.KEEP_ALIVE_TIMEOUT) as number,
 				MAX_BODY: config.Get(MODULES.EXPRESS, CONFIG.MAX_BODY) as string,
+				INJECTED_CONTROLLERS: config.Get(MODULES.EXPRESS, CONFIG.INJECTED_CONTROLLERS) as boolean,
 			},
 			SUBSTRATE: {
 				URL: config.Get(MODULES.SUBSTRATE, CONFIG.URL) as string,

src/Specs.ts

@@ -95,6 +95,19 @@ export class Specs {
 				type: 'string',
 			}),
 		);
+
+		this._specs.appendSpec(
+			MODULES.EXPRESS,
+			this._specs.getSpec(
+				CONFIG.INJECTED_CONTROLLERS,
+				'Use the controllers from the chain configuration or use controllers injected from pallets definitions',
+				{
+					default: 'false',
+					type: 'boolean',
+					regexp: /^true|false$/,
+				},
+			),
+		);
 	}
 
 	/**

src/chains-config/astarControllers.ts

@@ -35,7 +35,6 @@ export const astarControllers: ControllerConfig = {
 		'PalletsAssets',
 		'PalletsErrors',
 		'PalletsStorage',
-		'Paras',
 		'RuntimeCode',
 		'RuntimeMetadata',
 		'RuntimeSpec',

src/chains-config/bifrostControllers.ts

@@ -31,7 +31,6 @@ export const bifrostControllers: ControllerConfig = {
 		'NodeTransactionPool',
 		'NodeVersion',
 		'PalletsStorage',
-		'Paras',
 		'RuntimeCode',
 		'RuntimeMetadata',
 		'RuntimeSpec',

src/chains-config/bifrostPolkadotControllers.ts

@@ -31,7 +31,6 @@ export const bifrostPolkadotControllers: ControllerConfig = {
 		'NodeTransactionPool',
 		'NodeVersion',
 		'PalletsStorage',
-		'Paras',
 		'RuntimeCode',
 		'RuntimeMetadata',
 		'RuntimeSpec',

src/chains-config/calamariControllers.ts

@@ -35,7 +35,6 @@ export const calamariControllers: ControllerConfig = {
 		'NodeVersion',
 		'PalletsStakingProgress',
 		'PalletsStorage',
-		'Paras',
 		'RuntimeCode',
 		'RuntimeMetadata',
 		'RuntimeSpec',

src/chains-config/coretimeControllers.ts

@@ -22,23 +22,11 @@ import { initLRUCache, QueryFeeDetailsCache } from './cache';
  */
 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',

src/chains-config/index.ts

@@ -15,6 +15,7 @@
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import { ApiPromise } from '@polkadot/api';
+import { ISidecarConfig } from 'src/types/sidecar-config';
 
 import { controllers } from '../controllers';
 import AbstractController from '../controllers/AbstractController';
@@ -49,7 +50,7 @@ import { shidenControllers } from './shidenControllers';
 import { soraControllers } from './soraControllers';
 import { westendControllers } from './westendControllers';
 
-const specToControllerMap: { [x: string]: ControllerConfig } = {
+export const specToControllerMap: { [x: string]: ControllerConfig } = {
 	westend: westendControllers,
 	polkadot: polkadotControllers,
 	polymesh: polymeshControllers,
@@ -117,3 +118,39 @@ function getControllersFromConfig(api: ApiPromise, config: ControllerConfig) {
 		return acc;
 	}, [] as AbstractController<AbstractService>[]);
 }
+
+/**
+ * Return an array of instantiated controller instances based off of a `specName`.
+ * @param pallets pallets available to define controllers
+ * @param api ApiPromise to inject into controllers
+ * @param specName specName of chain to get options
+ */
+
+export const getControllersByPallets = (pallets: string[], api: ApiPromise, specName: string) => {
+	const controllersSet: AbstractController<AbstractService>[] = [];
+	const config = specToControllerMap?.[specName]?.options || defaultControllers?.options;
+
+	Object.values(controllers).forEach((controller) => {
+		if (controller.canInjectByPallets(pallets)) {
+			controllersSet.push(new controller(api, config));
+		}
+	});
+
+	return controllersSet;
+};
+
+export const getControllers = (
+	api: ApiPromise,
+	config: ISidecarConfig,
+	specName: string,
+): AbstractController<AbstractService>[] => {
+	if (config.EXPRESS.INJECTED_CONTROLLERS) {
+		return getControllersByPallets(
+			(api.registry.metadata.toJSON().pallets as unknown as Record<string, unknown>[]).map((p) => p.name as string),
+			api,
+			specName,
+		);
+	} else {
+		return getControllersForSpec(api, specName);
+	}
+};

src/chains-config/karuraControllers.ts

@@ -31,7 +31,6 @@ export const karuraControllers: ControllerConfig = {
 		'NodeTransactionPool',
 		'NodeVersion',
 		'PalletsStorage',
-		'Paras',
 		'RuntimeCode',
 		'RuntimeMetadata',
 		'RuntimeSpec',