[ENG-900] [Turnkey] Add safe slippageTolerance. (backport #3118) (#3273)

Co-authored-by: Kefan Cao <76069770+Kefancao@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: 3 people

indexer/services/comlink/__tests__/helpers/skip-helper.test.ts

@@ -3,6 +3,7 @@ import {
   nobleToHex,
   encodeToHexAndPad,
   nobleToSolana,
+  getSlippageTolerancePercent,
 } from '../../src/helpers/skip-helper';
 import { getETHPrice } from '../../src/helpers/alchemy-helpers';
 import { ethDenomByChainId, ETH_WEI_QUANTUM, ETH_USDC_QUANTUM } from '../../src/lib/smart-contract-constants';
@@ -18,6 +19,8 @@ jest.mock('../../src/config', () => ({
   TURNKEY_API_BASE_URL: 'https://api.turnkey.com',
   TURNKEY_API_SENDER_PUBLIC_KEY: 'test-public-key',
   TURNKEY_API_SENDER_PRIVATE_KEY: 'test-private-key',
+  SKIP_SLIPPAGE_TOLERANCE_USDC: 100,
+  SKIP_SLIPPAGE_TOLERANCE_PERCENTAGE: '0.1',
 }));
 
 jest.mock('@dydxprotocol-indexer/base', () => ({
@@ -432,4 +435,27 @@ describe('skip-helper', () => {
     });
   });
 
+  describe('getSlippageTolerancePercent', () => {
+    it('should return the percentage-based tolerance when it is smaller than USDC-based tolerance', () => {
+      // When estimatedAmountOut is large, USDC-based tolerance becomes very small
+      const estimatedAmountOut = '1000000000'; // 1000 USDC (assuming 6 decimals)
+      // USDC-based: 100 * 100000000 / 1000000000 = 0.1 (10%)
+      const result = getSlippageTolerancePercent(estimatedAmountOut);
+
+      // Should return the smaller value: 0.1% default.
+      expect(result).toBe('0.1');
+    });
+
+    it('should return the USDC-based tolerance when it is smaller than percentage-based tolerance', () => {
+      // When estimatedAmountOut is small, USDC-based tolerance becomes large
+      const estimatedAmountOut = '1000000000000'; // 1,000,000 USDC (1 million with 6 decimals)
+      const result = getSlippageTolerancePercent(estimatedAmountOut);
+
+      // USDC-based: 10_000_000_000 / 1_000_000_000_000 = 0.01 (1%)
+      // Percentage-based: 0.1 (10%)
+      // Should return the smaller value: 0.01 (1%)
+      expect(result).toBe('0.01');
+    });
+  });
+
 });

indexer/services/comlink/src/config.ts

@@ -123,6 +123,8 @@ export const configSchema = {
   TURNKEY_ORGANIZATION_ID: parseString({ default: '' }),
   SOLANA_SPONSOR_PUBLIC_KEY: parseString({ default: '' }),
   SKIP_SLIPPAGE_TOLERANCE_PERCENTAGE: parseString({ default: '0' }),
+  // this is the largest allowed slippage amount in USDC.
+  SKIP_SLIPPAGE_TOLERANCE_USDC: parseInteger({ default: 100 }),
   TURNKEY_EMAIL_SENDER_ADDRESS: parseString({ default: 'notifications@mail.dydx.trade' }),
   TURNKEY_EMAIL_SENDER_NAME: parseString({ default: 'dYdX Notifications' }),
   // Alchemy auth token for the skip bridge.
@@ -139,7 +141,7 @@ export const configSchema = {
   // if policy approvals are enabled.
   APPROVAL_ENABLED: parseBoolean({ default: true }),
   // largest amount we will tolerate to swap in usdc.
-  MAXIMUM_BRIDGE_AMOUNT_USDC: parseInteger({ default: 99_900 }),
+  MAXIMUM_BRIDGE_AMOUNT_USDC: parseInteger({ default: 999_000 }),
 
   // Apple Sign-In configuration
   APPLE_TEAM_ID: parseString({ default: '' }),

indexer/services/comlink/src/helpers/skip-helper.ts

@@ -49,7 +49,6 @@ export async function buildUserAddresses(
 const nobleForwardingModule = 'https://api.noble.xyz/noble/forwarding/v1/address/channel';
 const skipMessagesTimeoutSeconds = '60';
 const dydxNobleChannel = 33;
-const slippageTolerancePercent = config.SKIP_SLIPPAGE_TOLERANCE_PERCENTAGE;
 // Grabs the raw skip route data to carry out the bridge on our own.
 export async function getSkipCallData(
   sourceAddress: string,
@@ -63,7 +62,6 @@ export async function getSkipCallData(
   if (amount.startsWith('0x')) {
     amountToUse = parseInt(amount, 16).toString();
   }
-
   const routeResult = await route({
     amountIn: amountToUse, // Desired amount in smallest denomination (e.g., uatom)
     sourceAssetDenom,
@@ -88,13 +86,6 @@ export async function getSkipCallData(
     throw new Error('Failed to find a route');
   }
 
-  logger.info({
-    at: 'skip-helper#getSkipCallData',
-    message: 'Route result obtained',
-    routeResult,
-    dydxAddress,
-  });
-
   const userAddresses = await buildUserAddresses(
     routeResult.requiredChainAddresses,
     sourceAddress,
@@ -121,6 +112,9 @@ export async function getSkipCallData(
     throw new Error('executeRoute error: invalid address list');
   }
 
+  // acceptable slippage is smallest of SKIP_SLIPPAGE_TOLERANCE_USDC (Default $100) divided
+  // by the estimatedAmountOut or the SKIP_SLIPPAGE_TOLERANCE_PERCENTAGE.
+  const slippageTolerancePercent = getSlippageTolerancePercent(routeResult.estimatedAmountOut);
   const response = await messages({
     timeoutSeconds: skipMessagesTimeoutSeconds,
     amountIn: routeResult?.amountIn,
@@ -394,3 +388,13 @@ export async function limitAmount(
   const maxDepositInUsdc = config.MAXIMUM_BRIDGE_AMOUNT_USDC;
   return min([amountToUse, BigInt(maxDepositInUsdc * ETH_USDC_QUANTUM)])!.toString();
 }
+
+// getSlippageTolerancePercent returns the acceptable slippage is smallest of
+// SKIP_SLIPPAGE_TOLERANCE_USDC (Default $100) divided by the estimatedAmountOut
+// or the SKIP_SLIPPAGE_TOLERANCE_PERCENTAGE.
+export function getSlippageTolerancePercent(estAmountOut: string): string {
+  return min([
+    (100 * (config.SKIP_SLIPPAGE_TOLERANCE_USDC * ETH_USDC_QUANTUM)) / parseInt(estAmountOut, 10),
+    parseFloat(config.SKIP_SLIPPAGE_TOLERANCE_PERCENTAGE),
+  ])!.toString();
+}