Added ConfigService, support mutability of static xcm configs (#124)

Author: nohaapav

.changeset/gold-tips-travel.md

@@ -0,0 +1,6 @@
+---
+'@moonbeam-network/xcm-config': minor
+'@moonbeam-network/xcm-sdk': minor
+---
+
+Introduce config service to support mutability of static xcm config

.gitignore

@@ -111,3 +111,6 @@ dist
 
 # mac
 .DS_Store
+
+# IntelliJ Idea
+.idea

packages/config/src/ConfigBuilder/ConfigBuilder.test.ts

@@ -1,5 +1,6 @@
 /* eslint-disable sort-keys */
 import { Ecosystem } from '@moonbeam-network/xcm-types';
+import { ConfigService } from '../ConfigService';
 import { dev } from '../assets';
 import { equilibriumAlphanet, moonbaseAlpha } from '../chains';
 import { equilibriumAlphanetConfig } from '../configs/equilibriumAlphanet';
@@ -33,4 +34,32 @@ describe('configBuilder', () => {
       },
     });
   });
+
+  it('should return correct dev config using mutable service', () => {
+    const configService = new ConfigService();
+    const config = ConfigBuilder(configService)
+      .assets(Ecosystem.AlphanetRelay)
+      .asset(dev)
+      .source(moonbaseAlpha)
+      .destination(equilibriumAlphanet)
+      .build();
+
+    expect(config).toStrictEqual({
+      asset: dev,
+      source: {
+        chain: moonbaseAlpha,
+        config: moonbaseAlphaConfig.getAssetDestinationConfig(
+          dev,
+          equilibriumAlphanet,
+        ),
+      },
+      destination: {
+        chain: equilibriumAlphanet,
+        config: equilibriumAlphanetConfig.getAssetDestinationConfig(
+          dev,
+          moonbaseAlpha,
+        ),
+      },
+    });
+  });
 });

packages/config/src/ConfigBuilder/ConfigBuilder.ts

@@ -1,45 +1,42 @@
 /* eslint-disable sort-keys */
 import { AnyChain, Asset, Ecosystem } from '@moonbeam-network/xcm-types';
+import { ConfigService, IConfigService } from '../ConfigService';
 import { TransferConfig } from './ConfigBuilder.interfaces';
-import {
-  getAsset,
-  getAssetDestinationConfig,
-  getChain,
-  getDestinationChains,
-  getEcosystemAssets,
-  getSourceChains,
-} from './ConfigBuilder.utils';
 
-export function ConfigBuilder() {
+export function ConfigBuilder(service?: IConfigService) {
+  const config = service ?? new ConfigService();
   return {
     assets: (ecosystem?: Ecosystem) => {
-      const assets = getEcosystemAssets(ecosystem);
+      const assets = config.getEcosystemAssets(ecosystem);
 
       return {
         assets,
         asset: (keyOrAsset: string | Asset) => {
-          const asset = getAsset(keyOrAsset);
-          const sourceChains = getSourceChains(asset, ecosystem);
+          const asset = config.getAsset(keyOrAsset);
+          const sourceChains = config.getSourceChains(asset, ecosystem);
 
           return {
             sourceChains,
             source: (keyOrChain: string | AnyChain) => {
-              const source = getChain(keyOrChain);
-              const destinationChains = getDestinationChains(asset, source);
+              const source = config.getChain(keyOrChain);
+              const destinationChains = config.getDestinationChains(
+                asset,
+                source,
+              );
 
               return {
                 destinationChains,
                 destination: (
                   // eslint-disable-next-line @typescript-eslint/no-shadow
                   keyOrChain: string | AnyChain,
                 ) => {
-                  const destination = getChain(keyOrChain);
-                  const sourceConfig = getAssetDestinationConfig(
+                  const destination = config.getChain(keyOrChain);
+                  const sourceConfig = config.getAssetDestinationConfig(
                     asset,
                     source,
                     destination,
                   );
-                  const destinationConfig = getAssetDestinationConfig(
+                  const destinationConfig = config.getAssetDestinationConfig(
                     asset,
                     destination,
                     source,

packages/config/src/ConfigBuilder/ConfigBuilder.utils.test.ts

@@ -0,0 +1,20 @@
+import { AnyChain, Asset, Ecosystem } from '@moonbeam-network/xcm-types';
+import { AssetConfig } from '../types/AssetConfig';
+
+export interface IConfigService {
+  getEcosystemAssets(ecosystem?: Ecosystem): Asset[];
+
+  getAsset(keyOrAsset: string | Asset): Asset;
+
+  getChain(keyOrAsset: string | AnyChain): AnyChain;
+
+  getSourceChains(asset: Asset, ecosystem: Ecosystem | undefined): AnyChain[];
+
+  getDestinationChains(asset: Asset, source: AnyChain): AnyChain[];
+
+  getAssetDestinationConfig(
+    asset: Asset,
+    source: AnyChain,
+    destination: AnyChain,
+  ): AssetConfig;
+}