@paraswap/dex-lib 3.4.2-balancer-v2-single-swap.0 → 3.4.2

package/src/executor/ExecutorDetector.ts

@@ -1,131 +1,131 @@
-import { IDexHelper } from '../dex-helper';
-import { Address, OptimalRate, SwapSide } from '@paraswap/core';
-import { ExecutorBytecodeBuilder } from './ExecutorBytecodeBuilder';
-import { Executor01BytecodeBuilder } from './Executor01BytecodeBuilder';
-import { Executor02BytecodeBuilder } from './Executor02BytecodeBuilder';
-import { Executors, RouteExecutionType } from './types';
-import { Executor03BytecodeBuilder } from './Executor03BytecodeBuilder';
-import { WETHBytecodeBuilder, isSingleWrapRoute } from './WETHBytecodeBuilder';
-
-export class ExecutorDetector {
-  private executor01BytecodeBuilder: ExecutorBytecodeBuilder;
-  private executor02BytecodeBuilder: ExecutorBytecodeBuilder;
-  private executor03BytecodeBuilder: ExecutorBytecodeBuilder;
-  private wethBytecodeBuilder: ExecutorBytecodeBuilder;
-
-  protected routeExecutionTypeToExecutorMap: Record<
-    SwapSide,
-    Partial<Record<RouteExecutionType, Executors>>
-  > = {
-    [SwapSide.SELL]: {
-      [RouteExecutionType.SINGLE_STEP]: Executors.ONE, // simpleSwap via Executor01
-      [RouteExecutionType.HORIZONTAL_SEQUENCE]: Executors.ONE, // multiSwap via Executor01
-      [RouteExecutionType.VERTICAL_BRANCH]: Executors.TWO, // simpleSwap with percentage on a path via Executor02
-      [RouteExecutionType.VERTICAL_BRANCH_HORIZONTAL_SEQUENCE]: Executors.TWO, // multiSwap with percentages on paths via Executor02
-      // megaSwap via Executor02
-      [RouteExecutionType.NESTED_VERTICAL_BRANCH_HORIZONTAL_SEQUENCE]:
-        Executors.TWO,
-    },
-    [SwapSide.BUY]: {
-      [RouteExecutionType.SINGLE_STEP]: Executors.THREE, // simpleBuy via Executor03
-      [RouteExecutionType.VERTICAL_BRANCH]: Executors.THREE, // simpleBuy via Executor03
-    },
-  };
-
-  constructor(protected dexHelper: IDexHelper) {
-    this.executor01BytecodeBuilder = new Executor01BytecodeBuilder(
-      this.dexHelper,
-    );
-    this.executor02BytecodeBuilder = new Executor02BytecodeBuilder(
-      this.dexHelper,
-    );
-    this.executor03BytecodeBuilder = new Executor03BytecodeBuilder(
-      this.dexHelper,
-    );
-
-    this.wethBytecodeBuilder = new WETHBytecodeBuilder(this.dexHelper);
-  }
-
-  public getRouteExecutionType(priceRoute: OptimalRate): RouteExecutionType {
-    if (
-      priceRoute.bestRoute.length === 1 &&
-      priceRoute.bestRoute[0].percent === 100 &&
-      priceRoute.bestRoute[0].swaps.length === 1 &&
-      priceRoute.bestRoute[0].swaps[0].swapExchanges.length > 1
-    ) {
-      return RouteExecutionType.VERTICAL_BRANCH;
-    } else if (
-      priceRoute.bestRoute.length === 1 &&
-      priceRoute.bestRoute[0].percent === 100 &&
-      priceRoute.bestRoute[0].swaps.length === 1
-    ) {
-      return RouteExecutionType.SINGLE_STEP;
-    } else if (
-      priceRoute.bestRoute.length === 1 &&
-      priceRoute.bestRoute[0].percent === 100 &&
-      priceRoute.bestRoute[0].swaps.length > 1
-    ) {
-      let has100PercentOnEachPath = true;
-      priceRoute.bestRoute[0].swaps.map(swap => {
-        swap.swapExchanges.map(se => {
-          if (se.percent !== 100) {
-            has100PercentOnEachPath = false;
-          }
-        });
-      });
-
-      if (has100PercentOnEachPath) {
-        return RouteExecutionType.HORIZONTAL_SEQUENCE;
-      } else {
-        return RouteExecutionType.VERTICAL_BRANCH_HORIZONTAL_SEQUENCE;
-      }
-    } else if (priceRoute.bestRoute.length > 1) {
-      return RouteExecutionType.NESTED_VERTICAL_BRANCH_HORIZONTAL_SEQUENCE;
-    }
-
-    throw new Error('Route type is not supported yet');
-  }
-
-  detectSpecialExecutor(priceRoute: OptimalRate): Executors | null {
-    if (isSingleWrapRoute(priceRoute)) return Executors.WETH;
-    return null;
-  }
-
-  getExecutorByPriceRoute(priceRoute: OptimalRate): Executors {
-    const specialExecutor = this.detectSpecialExecutor(priceRoute);
-    if (specialExecutor) return specialExecutor;
-
-    const routeExecutionType = this.getRouteExecutionType(priceRoute);
-    const executorName =
-      this.routeExecutionTypeToExecutorMap[priceRoute.side][routeExecutionType];
-
-    if (executorName) {
-      return executorName;
-    }
-
-    throw new Error(`${executorName} is not implemented`);
-  }
-
-  getAddress(executorName: Executors): Address {
-    if (!Object.values(Executors).includes(executorName)) {
-      throw new Error(`${executorName} is not supported`);
-    }
-
-    return this.dexHelper.config.data.executorsAddresses![executorName];
-  }
-
-  getBytecodeBuilder(executorName: Executors): ExecutorBytecodeBuilder {
-    switch (executorName) {
-      case Executors.ONE:
-        return this.executor01BytecodeBuilder;
-      case Executors.TWO:
-        return this.executor02BytecodeBuilder;
-      case Executors.THREE:
-        return this.executor03BytecodeBuilder;
-      case Executors.WETH:
-        return this.wethBytecodeBuilder;
-      default:
-        throw new Error(`${executorName} is not supported`);
-    }
-  }
-}
+import { IDexHelper } from '../dex-helper';
+import { Address, OptimalRate, SwapSide } from '@paraswap/core';
+import { ExecutorBytecodeBuilder } from './ExecutorBytecodeBuilder';
+import { Executor01BytecodeBuilder } from './Executor01BytecodeBuilder';
+import { Executor02BytecodeBuilder } from './Executor02BytecodeBuilder';
+import { Executors, RouteExecutionType } from './types';
+import { Executor03BytecodeBuilder } from './Executor03BytecodeBuilder';
+import { WETHBytecodeBuilder, isSingleWrapRoute } from './WETHBytecodeBuilder';
+
+export class ExecutorDetector {
+  private executor01BytecodeBuilder: ExecutorBytecodeBuilder;
+  private executor02BytecodeBuilder: ExecutorBytecodeBuilder;
+  private executor03BytecodeBuilder: ExecutorBytecodeBuilder;
+  private wethBytecodeBuilder: ExecutorBytecodeBuilder;
+
+  protected routeExecutionTypeToExecutorMap: Record<
+    SwapSide,
+    Partial<Record<RouteExecutionType, Executors>>
+  > = {
+    [SwapSide.SELL]: {
+      [RouteExecutionType.SINGLE_STEP]: Executors.ONE, // simpleSwap via Executor01
+      [RouteExecutionType.HORIZONTAL_SEQUENCE]: Executors.ONE, // multiSwap via Executor01
+      [RouteExecutionType.VERTICAL_BRANCH]: Executors.TWO, // simpleSwap with percentage on a path via Executor02
+      [RouteExecutionType.VERTICAL_BRANCH_HORIZONTAL_SEQUENCE]: Executors.TWO, // multiSwap with percentages on paths via Executor02
+      // megaSwap via Executor02
+      [RouteExecutionType.NESTED_VERTICAL_BRANCH_HORIZONTAL_SEQUENCE]:
+        Executors.TWO,
+    },
+    [SwapSide.BUY]: {
+      [RouteExecutionType.SINGLE_STEP]: Executors.THREE, // simpleBuy via Executor03
+      [RouteExecutionType.VERTICAL_BRANCH]: Executors.THREE, // simpleBuy via Executor03
+    },
+  };
+
+  constructor(protected dexHelper: IDexHelper) {
+    this.executor01BytecodeBuilder = new Executor01BytecodeBuilder(
+      this.dexHelper,
+    );
+    this.executor02BytecodeBuilder = new Executor02BytecodeBuilder(
+      this.dexHelper,
+    );
+    this.executor03BytecodeBuilder = new Executor03BytecodeBuilder(
+      this.dexHelper,
+    );
+
+    this.wethBytecodeBuilder = new WETHBytecodeBuilder(this.dexHelper);
+  }
+
+  public getRouteExecutionType(priceRoute: OptimalRate): RouteExecutionType {
+    if (
+      priceRoute.bestRoute.length === 1 &&
+      priceRoute.bestRoute[0].percent === 100 &&
+      priceRoute.bestRoute[0].swaps.length === 1 &&
+      priceRoute.bestRoute[0].swaps[0].swapExchanges.length > 1
+    ) {
+      return RouteExecutionType.VERTICAL_BRANCH;
+    } else if (
+      priceRoute.bestRoute.length === 1 &&
+      priceRoute.bestRoute[0].percent === 100 &&
+      priceRoute.bestRoute[0].swaps.length === 1
+    ) {
+      return RouteExecutionType.SINGLE_STEP;
+    } else if (
+      priceRoute.bestRoute.length === 1 &&
+      priceRoute.bestRoute[0].percent === 100 &&
+      priceRoute.bestRoute[0].swaps.length > 1
+    ) {
+      let has100PercentOnEachPath = true;
+      priceRoute.bestRoute[0].swaps.map(swap => {
+        swap.swapExchanges.map(se => {
+          if (se.percent !== 100) {
+            has100PercentOnEachPath = false;
+          }
+        });
+      });
+
+      if (has100PercentOnEachPath) {
+        return RouteExecutionType.HORIZONTAL_SEQUENCE;
+      } else {
+        return RouteExecutionType.VERTICAL_BRANCH_HORIZONTAL_SEQUENCE;
+      }
+    } else if (priceRoute.bestRoute.length > 1) {
+      return RouteExecutionType.NESTED_VERTICAL_BRANCH_HORIZONTAL_SEQUENCE;
+    }
+
+    throw new Error('Route type is not supported yet');
+  }
+
+  detectSpecialExecutor(priceRoute: OptimalRate): Executors | null {
+    if (isSingleWrapRoute(priceRoute)) return Executors.WETH;
+    return null;
+  }
+
+  getExecutorByPriceRoute(priceRoute: OptimalRate): Executors {
+    const specialExecutor = this.detectSpecialExecutor(priceRoute);
+    if (specialExecutor) return specialExecutor;
+
+    const routeExecutionType = this.getRouteExecutionType(priceRoute);
+    const executorName =
+      this.routeExecutionTypeToExecutorMap[priceRoute.side][routeExecutionType];
+
+    if (executorName) {
+      return executorName;
+    }
+
+    throw new Error(`${executorName} is not implemented`);
+  }
+
+  getAddress(executorName: Executors): Address {
+    if (!Object.values(Executors).includes(executorName)) {
+      throw new Error(`${executorName} is not supported`);
+    }
+
+    return this.dexHelper.config.data.executorsAddresses![executorName];
+  }
+
+  getBytecodeBuilder(executorName: Executors): ExecutorBytecodeBuilder {
+    switch (executorName) {
+      case Executors.ONE:
+        return this.executor01BytecodeBuilder;
+      case Executors.TWO:
+        return this.executor02BytecodeBuilder;
+      case Executors.THREE:
+        return this.executor03BytecodeBuilder;
+      case Executors.WETH:
+        return this.wethBytecodeBuilder;
+      default:
+        throw new Error(`${executorName} is not supported`);
+    }
+  }
+}

package/src/executor/constants.ts

@@ -1,66 +1,66 @@
-import { ethers } from 'ethers';
-import { Network } from '../constants';
-
-const {
-  utils: { hexlify, hexZeroPad },
-} = ethers;
-
-export const BYTES_28_LENGTH = 28;
-export const BYTES_64_LENGTH = 64;
-export const BYTES_96_LENGTH = 96;
-
-export const ZEROS_4_BYTES = hexZeroPad(hexlify(0), 4);
-export const ZEROS_12_BYTES = hexZeroPad(hexlify(0), 12);
-export const ZEROS_20_BYTES = hexZeroPad(hexlify(0), 20);
-export const ZEROS_28_BYTES = hexZeroPad(hexlify(0), 28);
-export const ZEROS_32_BYTES = hexZeroPad(hexlify(0), 32);
-
-export const SWAP_EXCHANGE_100_PERCENTAGE = 100;
-
-export const NOT_EXISTING_EXCHANGE_PARAM_INDEX = -1;
-
-export const ETH_SRC_TOKEN_POS_FOR_MULTISWAP_METADATA = '0xEEEEEEEEEEEEEEEE';
-
-export const EXECUTOR_01_02_FUNCTION_CALL_DATA_TYPES: string[] = [
-  'bytes20', // address
-  'bytes4', // calldata Size
-  'bytes2', // fromAmount Pos
-  'bytes2', // srcTokenPos
-  'bytes1', // returnAmount Pos
-  'bytes1', // specialExchange
-  'bytes2', // flag
-  'bytes28', // zero padding
-  'bytes', // dex calldata
-];
-
-export const EXECUTOR_03_FUNCTION_CALL_DATA_TYPES: string[] = [
-  'bytes20', // address(bytes20)
-  'bytes2', // calldata Size(bytes 2)
-  'bytes2', // toAmount Pos(bytes2)
-  'bytes2', // fromAmount Pos(bytes2)
-  'bytes2', // srcTokenPos(bytes2)
-  'bytes2', // specialExchange (bytes2)
-  'bytes2', // flag(bytes2)
-  'bytes28', // zero padding (bytes28)
-  'bytes', // dex calldata (bytes)
-];
-
-export const APPROVE_CALLDATA_DEST_TOKEN_POS = 68;
-export const WRAP_UNWRAP_FROM_AMOUNT_POS = 4;
-export const DEFAULT_RETURN_AMOUNT_POS = 255;
-
-export const RETURN_AMOUNT_POS_0 = 0;
-export const RETURN_AMOUNT_POS_32 = 32;
-
-// TODO-v6?: can it be removed  after approval/cache task, because we are going to give approvals only once,
-// therefore for any case initial allowance would be 0
-export const DISABLED_MAX_UNIT_APPROVAL_TOKENS: Partial<
-  Record<Network, string[]>
-> = {
-  // USDT don't allow approve for MAX_UINT if current approval is not 0
-  [Network.MAINNET]: [
-    '0xdac17f958d2ee523a2206206994597c13d831ec7',
-    '0xd101dcc414f310268c37eeb4cd376ccfa507f571',
-    '0x0f5d2fb29fb7d3cfee444a200298f468908cc942',
-  ],
-};
+import { ethers } from 'ethers';
+import { Network } from '../constants';
+
+const {
+  utils: { hexlify, hexZeroPad },
+} = ethers;
+
+export const BYTES_28_LENGTH = 28;
+export const BYTES_64_LENGTH = 64;
+export const BYTES_96_LENGTH = 96;
+
+export const ZEROS_4_BYTES = hexZeroPad(hexlify(0), 4);
+export const ZEROS_12_BYTES = hexZeroPad(hexlify(0), 12);
+export const ZEROS_20_BYTES = hexZeroPad(hexlify(0), 20);
+export const ZEROS_28_BYTES = hexZeroPad(hexlify(0), 28);
+export const ZEROS_32_BYTES = hexZeroPad(hexlify(0), 32);
+
+export const SWAP_EXCHANGE_100_PERCENTAGE = 100;
+
+export const NOT_EXISTING_EXCHANGE_PARAM_INDEX = -1;
+
+export const ETH_SRC_TOKEN_POS_FOR_MULTISWAP_METADATA = '0xEEEEEEEEEEEEEEEE';
+
+export const EXECUTOR_01_02_FUNCTION_CALL_DATA_TYPES: string[] = [
+  'bytes20', // address
+  'bytes4', // calldata Size
+  'bytes2', // fromAmount Pos
+  'bytes2', // srcTokenPos
+  'bytes1', // returnAmount Pos
+  'bytes1', // specialExchange
+  'bytes2', // flag
+  'bytes28', // zero padding
+  'bytes', // dex calldata
+];
+
+export const EXECUTOR_03_FUNCTION_CALL_DATA_TYPES: string[] = [
+  'bytes20', // address(bytes20)
+  'bytes2', // calldata Size(bytes 2)
+  'bytes2', // toAmount Pos(bytes2)
+  'bytes2', // fromAmount Pos(bytes2)
+  'bytes2', // srcTokenPos(bytes2)
+  'bytes2', // specialExchange (bytes2)
+  'bytes2', // flag(bytes2)
+  'bytes28', // zero padding (bytes28)
+  'bytes', // dex calldata (bytes)
+];
+
+export const APPROVE_CALLDATA_DEST_TOKEN_POS = 68;
+export const WRAP_UNWRAP_FROM_AMOUNT_POS = 4;
+export const DEFAULT_RETURN_AMOUNT_POS = 255;
+
+export const RETURN_AMOUNT_POS_0 = 0;
+export const RETURN_AMOUNT_POS_32 = 32;
+
+// TODO-v6?: can it be removed  after approval/cache task, because we are going to give approvals only once,
+// therefore for any case initial allowance would be 0
+export const DISABLED_MAX_UNIT_APPROVAL_TOKENS: Partial<
+  Record<Network, string[]>
+> = {
+  // USDT don't allow approve for MAX_UINT if current approval is not 0
+  [Network.MAINNET]: [
+    '0xdac17f958d2ee523a2206206994597c13d831ec7',
+    '0xd101dcc414f310268c37eeb4cd376ccfa507f571',
+    '0x0f5d2fb29fb7d3cfee444a200298f468908cc942',
+  ],
+};