Improve pool type mapper safety by checking for unsupported types

src/data/providers/balancer-api/modules/nested-pool-state/index.ts

@@ -2,6 +2,7 @@ import { BalancerApiClient } from '../../client';
 import { NestedPool, NestedPoolState } from '../../../../../entities';
 import { MinimalToken } from '../../../../types';
 import { Address, Hex, PoolType } from '../../../../../types';
+import { mapPoolType } from '@/utils/poolTypeMapper';
 
 type PoolGetPool = {
     id: Hex;
@@ -181,7 +182,7 @@ export class NestedPools {
             {
                 id: pool.id,
                 address: pool.address,
-                type: this.mapPoolType(pool.type),
+                type: mapPoolType(pool.type),
                 level: 1,
                 tokens: pool.tokens.map((t) => {
                     const minimalToken: MinimalToken = {
@@ -203,7 +204,7 @@ export class NestedPools {
                 id: token.pool.id,
                 address: token.pool.address,
                 level: 0,
-                type: this.mapPoolType(token.pool.type),
+                type: mapPoolType(token.pool.type),
                 tokens: token.pool.tokens.map((t) => {
                     const minimalToken: MinimalToken = {
                         address: t.address,

src/data/providers/balancer-api/modules/pool-state/index.ts

@@ -1,6 +1,6 @@
 import { BalancerApiClient } from '../../client';
 import { PoolState } from '../../../../../entities';
-import { poolTypeFromApi } from '../../../../../utils/poolTypeMapper';
+import { mapPoolType } from '../../../../../utils/poolTypeMapper';
 
 export class Pools {
     readonly poolStateQuery = `query GetPool($id: String!){
@@ -86,6 +86,6 @@ export class Pools {
             },
         });
         const poolGetPool: PoolState = data.poolGetPool;
-        return { ...poolGetPool, type: poolTypeFromApi[poolGetPool.type] };
+        return { ...poolGetPool, type: mapPoolType(poolGetPool.type) };
     }
 }

src/utils/poolTypeMapper.ts

@@ -1,9 +1,20 @@
 import { PoolType } from '../types';
 
-export const poolTypeFromApi = {
+// map pool type from the api to the sdk
+const poolTypeMap = {
     WEIGHTED: PoolType.Weighted,
     COMPOSABLE_STABLE: PoolType.ComposableStable,
     GYRO3: PoolType.Gyro3,
     GYRO2: PoolType.Gyro2,
     GYROE: PoolType.GyroE,
 };
+
+export const mapPoolType = (type: string): PoolType => {
+    const supportedPoolTypes = Object.keys(poolTypeMap);
+
+    if (!supportedPoolTypes.includes(type)) {
+        throw new Error(`Unsupported pool type ${type}`);
+    }
+
+    return poolTypeMap[type];
+};

test/v2/data/balancerApi.test.ts

@@ -3,7 +3,7 @@ import { BalancerApi, ChainId, NestedPoolState, PoolState } from '../../../src';
 
 // Placeholder test to help validate the impact of API updates
 // Note: should not be included to CI checks
-describe.skip(
+describe(
     'BalancerApi Provider',
     () => {
         test('CS Pool - Should add BPT to tokens', async () => {