SOR - Update StableSurge hook support

.changeset/modern-shrimps-sneeze.md

@@ -0,0 +1,5 @@
+---
+'backend': patch
+---
+
+SOR - Update stable surge hook support

modules/sor/sor-debug.test.ts

@@ -40,13 +40,14 @@ describe('sor debugging', () => {
 
     it('sor v3', async () => {
         const useProtocolVersion = 3;
-        const chain = Chain.MAINNET;
+        const chain = Chain.SEPOLIA;
 
         const chainId = Object.keys(chainIdToChain).find((key) => chainIdToChain[key] === chain) as string;
         initRequestScopedContext();
         setRequestScopedContextValue('chainId', chainId);
         // only do once before starting to debug
         // await PoolController().reloadPoolsV3(chain);
+        // await PoolController().syncHookData(chain);
         // await TokenController().syncErc4626Tokens(chain);
         // await TokenController().syncErc4626UnwrapRates(chain);
 
@@ -56,12 +57,13 @@ describe('sor debugging', () => {
 
         const swaps = await sorService.getSorSwapPaths({
             chain,
-            tokenIn: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', // USDC
-            tokenOut: '0x7204b7dbf9412567835633b6f00c3edc3a8d6330', // csUSDC
+            tokenIn: '0x94a9d9ac8a22534e3faca9f4e7f2e2cf85d5e4c8', // USDCaave
+            tokenOut: '0xaa8e23fb1079ea71e0a56f48a2aa51851d8433d0', // USDTaave
             swapType: 'EXACT_IN',
-            swapAmount: '1000',
+            swapAmount: '10000',
             useProtocolVersion,
-            // poolIds: ['0x10a04efba5b880e169920fd4348527c64fb29d4d'], // boosted
+            considerPoolsWithHooks: true,
+            // poolIds: ['0x9b677c72a1160e1e03fe542bfd2b0f373fa94a8c'], // boosted
         });
 
         console.log(swaps.returnAmount);

modules/sor/sorV2/lib/poolsV3/stable/stablePool.ts

@@ -95,11 +95,6 @@ export class StablePoolV3 implements BasePoolV3 {
         //transform
         const hookState = getHookState(pool);
 
-        // typeguard
-        if (!isLiquidityManagement(pool.liquidityManagement)) {
-            throw new Error('LiquidityManagement must be of type LiquidityManagement and cannot be null');
-        }
-
         return new StablePoolV3(
             pool.id as Hex,
             pool.address,
@@ -109,7 +104,7 @@ export class StablePoolV3 implements BasePoolV3 {
             poolTokens,
             totalShares,
             pool.dynamicData.tokenPairsData as TokenPairData[],
-            pool.liquidityManagement,
+            pool.liquidityManagement as unknown as LiquidityManagement,
             hookState,
         );
     }

modules/sor/sorV2/lib/poolsV3/weighted/weightedPool.ts

@@ -92,11 +92,6 @@ export class WeightedPoolV3 implements BasePoolV3 {
         //transform
         const hookState = getHookState(pool);
 
-        // typeguard
-        if (!isLiquidityManagement(pool.liquidityManagement)) {
-            throw new Error('LiquidityManagement must be of type LiquidityManagement and cannot be null');
-        }
-
         return new WeightedPoolV3(
             pool.id as Hex,
             pool.address,
@@ -106,7 +101,7 @@ export class WeightedPoolV3 implements BasePoolV3 {
             parseEther(pool.dynamicData.totalShares),
             poolTokens,
             pool.dynamicData.tokenPairsData as TokenPairData[],
-            pool.liquidityManagement,
+            pool.liquidityManagement as unknown as LiquidityManagement,
             hookState,
         );
     }

modules/sor/sorV2/lib/static.ts

@@ -1,6 +1,6 @@
 import { Router } from './router';
 import { PrismaPoolAndHookWithDynamic } from '../../../../prisma/prisma-types';
-import { checkInputs } from './utils/helpers';
+import { checkInputs, isLiquidityManagement } from './utils/helpers';
 import {
     ComposableStablePool,
     FxPool,
@@ -32,6 +32,13 @@ export async function sorGetPathsWithPools(
     const basePools: BasePool[] = [];
 
     for (const prismaPool of prismaPools) {
+        // typeguard
+        if (prismaPool.protocolVersion === 3) {
+            if (!isLiquidityManagement(prismaPool.liquidityManagement)) {
+                console.log('LiquidityManagement incorrect for pool', prismaPool.id);
+                continue;
+            }
+        }
         switch (prismaPool.type) {
             case 'WEIGHTED':
             /// LBPs can be handled like weighted pools

modules/sor/sorV2/lib/utils/helpers.ts

@@ -15,6 +15,8 @@ import { HookState } from '@balancer-labs/balancer-maths';
 import { LiquidityManagement } from '../../../types';
 
 import { parseEther, parseUnits } from 'viem';
+import { PrismaPoolAndHookWithDynamic } from '../../../../../prisma/prisma-types';
+import { HookData } from '../../../../sources/transformers';
 
 export function checkInputs(
     tokenIn: Token,
@@ -77,41 +79,53 @@ export function getOutputAmount(paths: PathWithAmount[]): TokenAmount {
     return amounts.reduce((a, b) => a.add(b));
 }
 
-export function getHookState(pool: any): HookState | undefined {
-    if (pool.hook === undefined || pool.hook === null) {
+export function getHookState(pool: PrismaPoolAndHookWithDynamic): HookState | undefined {
+    if (!pool.hook) {
         return undefined;
     }
 
-    if (pool.hook.name === 'ExitFee') {
-        // api for this hook is an Object with removeLiquidityFeePercentage key & fee as string
-        const dynamicData = pool.hook.dynamicData as { removeLiquidityFeePercentage: string };
-
-        return {
-            tokens: pool.tokens.map((token: { address: string }) => token.address),
-            // ExitFeeHook will always have dynamicData as part of the API response
-            removeLiquidityHookFeePercentage: parseEther(dynamicData.removeLiquidityFeePercentage),
-            hookType: pool.hook.name,
-        };
-    }
-
-    if (pool.hook.name === 'DirectionalFee') {
-        // this hook does not require a hook state to be passed
-        return {
-            hookType: pool.hook.name,
-        } as HookState;
+    const hookData = pool.hook as HookData;
+
+    switch (hookData.type) {
+        case 'EXIT_FEE': {
+            // api for this hook is an Object with removeLiquidityFeePercentage key & fee as string
+            const dynamicData = hookData.dynamicData as { removeLiquidityFeePercentage: string };
+
+            return {
+                tokens: pool.tokens.map((token: { address: string }) => token.address),
+                // ExitFeeHook will always have dynamicData as part of the API response
+                removeLiquidityHookFeePercentage: parseEther(dynamicData.removeLiquidityFeePercentage),
+                hookType: 'ExitFee',
+            };
+        }
+        case 'DIRECTIONAL_FEE': {
+            // this hook does not require a hook state to be passed
+            return {
+                hookType: 'DirectionalFee',
+            } as HookState;
+        }
+        case 'STABLE_SURGE': {
+            const typeData = pool.typeData as { amp: string };
+            const dynamicData = hookData.dynamicData as {
+                surgeThresholdPercentage: string;
+                maxSurgeFeePercentage: string;
+            };
+            return {
+                // amp onchain precision is 1000. Api returns 200 means onchain value is 200000
+                amp: parseUnits(typeData.amp, 3),
+                // 18 decimal precision.
+                surgeThresholdPercentage: parseEther(dynamicData.surgeThresholdPercentage),
+                maxSurgeFeePercentage: parseEther(dynamicData.maxSurgeFeePercentage),
+                hookType: 'StableSurge',
+            };
+        }
+        default:
+            if (hookData.type) {
+                console.warn(`pool ${pool.id} with hook type ${hookData.type} not implemented`);
+            }
+
+            return undefined;
     }
-
-    if (pool.hook.name === 'StableSurge') {
-        return {
-            // amp onchain precision is 1000. Api returns 200 means onchain value is 200000
-            amp: parseUnits(pool.typeData.amp, 3),
-            // 18 decimal precision.
-            surgeThresholdPercentage: parseEther(pool.hook.dynamicData.surgeThresholdPercentage),
-            hookType: pool.hook.name,
-        };
-    }
-
-    throw new Error(`${pool.hook.name} hook not implemented`);
 }
 
 export function isLiquidityManagement(value: any): value is LiquidityManagement {

package.json

@@ -22,7 +22,7 @@
         "@aws-sdk/client-cloudwatch": "^3.734.0",
         "@aws-sdk/client-secrets-manager": "^3.734.0",
         "@aws-sdk/client-sqs": "^3.734.0",
-        "@balancer-labs/balancer-maths": "^0.0.20",
+        "@balancer-labs/balancer-maths": "^0.0.21",
         "@balancer/sdk": "^1.4.1",
         "@ethersproject/address": "^5.7.0",
         "@ethersproject/bignumber": "^5.7.0",