adjust type logic to prevent function duplication and Type casting in…

… Mrl Asset Routes
moonbeam-foundation · Jan 23, 2025 · c9252e4 · c9252e4
1 parent 562d7df
commit c9252e4
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 21 deletions.
diff --git a/packages/config/src/types/ChainRoutes.ts b/packages/config/src/types/ChainRoutes.ts
@@ -18,11 +18,11 @@ interface RoutesParam extends Omit<AssetRouteConstructorParams, 'source'> {
 export class ChainRoutes {
   readonly chain: AnyChain;
 
-  readonly #routes: Map<string, AssetRoute>;
+  protected routes: Map<string, AssetRoute>;
 
   constructor({ chain, routes }: ChainRoutesConstructorParams) {
     this.chain = chain;
-    this.#routes = new Map(
+    this.routes = new Map(
       routes.map(({ source, destination, contract, extrinsic }) => [
         `${source.asset.key}-${destination.chain.key}`,
         new AssetRoute({
@@ -36,7 +36,7 @@ export class ChainRoutes {
   }
 
   getRoutes(): AssetRoute[] {
-    return Array.from(this.#routes.values());
+    return Array.from(this.routes.values());
   }
 
   getAssetRoutes(keyOrAsset: string | AnyAsset): AssetRoute[] {
@@ -65,7 +65,7 @@ export class ChainRoutes {
   ): AssetRoute {
     const assetKey = getKey(asset);
     const destKey = getKey(destination);
-    const route = this.#routes.get(`${assetKey}-${destKey}`);
+    const route = this.routes.get(`${assetKey}-${destKey}`);
 
     if (!route) {
       throw new Error(

diff --git a/packages/config/src/types/MrlChainRoutes.ts b/packages/config/src/types/MrlChainRoutes.ts
@@ -1,5 +1,4 @@
 import type { AnyAsset, AnyChain } from '@moonbeam-network/xcm-types';
-import { getKey } from '../config.utils';
 import { ChainRoutes, type ChainRoutesConstructorParams } from './ChainRoutes';
 import {
   MrlAssetRoute,
@@ -18,11 +17,11 @@ interface MrlRoutesParam
 }
 
 export class MrlChainRoutes extends ChainRoutes {
-  readonly #routes: Map<string, MrlAssetRoute>;
+  protected routes: Map<string, MrlAssetRoute>;
 
   constructor({ chain, routes }: MrlChainRoutesConstructorParams) {
     super({ chain, routes });
-    this.#routes = new Map(
+    this.routes = new Map(
       routes.map(({ source, destination, contract, extrinsic, mrl }) => [
         `${source.asset.key}-${destination.chain.key}`,
         new MrlAssetRoute({
@@ -37,23 +36,16 @@ export class MrlChainRoutes extends ChainRoutes {
   }
 
   getRoutes(): MrlAssetRoute[] {
-    return Array.from(this.#routes.values());
+    return Array.from(this.routes.values());
   }
 
   getAssetRoute(
     asset: string | AnyAsset,
     destination: string | AnyChain,
   ): MrlAssetRoute {
-    const assetKey = getKey(asset);
-    const destKey = getKey(destination);
-    const route = this.#routes.get(`${assetKey}-${destKey}`);
-
-    if (!route) {
-      throw new Error(
-        `AssetRoute for asset ${assetKey} and destination ${destKey} not found`,
-      );
-    }
-
-    return route;
+    const route = super.getAssetRoute(asset, destination);
+    // Since we know this class only stores MrlAssetRoute instances,
+    // we can safely cast the parent's return value
+    return route as MrlAssetRoute;
   }
 }
diff --git a/packages/mrl/src/mrl.ts b/packages/mrl/src/mrl.ts
@@ -1,6 +1,6 @@
 import {
   ConfigService,
-  type MrlAssetRoute,
+  MrlAssetRoute,
   mrlRoutesMap,
 } from '@moonbeam-network/xcm-config';
 import type {
@@ -44,6 +44,10 @@ export function Mrl(options?: MrlOptions) {
                 destination,
               });
 
+              if (!(route instanceof MrlAssetRoute)) {
+                throw new Error('Route must be an MrlAssetRoute');
+              }
+
               return {
                 setIsAutomatic(isAutomatic: boolean) {
                   return {
@@ -55,7 +59,7 @@ export function Mrl(options?: MrlOptions) {
                       destinationAddress: string;
                     }) {
                       return getTransferData({
-                        route: route as MrlAssetRoute,
+                        route,
                         sourceAddress,
                         destinationAddress,
                         isAutomatic,