@paraswap/dex-lib 3.2.5-return-amount-pos.7 → 3.3.0-v6-only

package/src/executor/Executor02BytecodeBuilder.ts

@@ -22,7 +22,6 @@ import {
   ZEROS_20_BYTES,
   ZEROS_28_BYTES,
   ZEROS_4_BYTES,
-  DEFAULT_RETURN_AMOUNT_POS,
 } from './constants';
 import { assert } from 'ts-essentials';
 
@@ -277,16 +276,6 @@ export class Executor02BytecodeBuilder extends ExecutorBytecodeBuilder<
     let { exchangeData, specialDexFlag, targetExchange, needWrapNative } =
       exchangeParam;
 
-    const routeNeedsRootUnwrapEth = this.doesRouteNeedsRootUnwrapEth(
-      priceRoute,
-      exchangeParams,
-    );
-
-    const returnAmountPos =
-      exchangeParam.returnAmountPos !== undefined && !routeNeedsRootUnwrapEth // prevent returnAmoutPos optimisation if route needs root unwrap eth
-        ? exchangeParam.returnAmountPos
-        : DEFAULT_RETURN_AMOUNT_POS;
-
     const applyVerticalBranching = this.doesSwapNeedToApplyVerticalBranching(
       priceRoute,
       routeIndex,
@@ -354,8 +343,6 @@ export class Executor02BytecodeBuilder extends ExecutorBytecodeBuilder<
       destTokenPos,
       specialDexFlag || SpecialDex.DEFAULT,
       flag,
-      undefined,
-      returnAmountPos,
     );
   }
 

package/src/executor/ExecutorBytecodeBuilder.ts

@@ -25,7 +25,6 @@ import {
 import { Executors, Flag, SpecialDex } from './types';
 import { MAX_UINT, Network } from '../constants';
 import { DexExchangeBuildParam, DexExchangeParam } from '../types';
-import { ExecutorDetector } from './ExecutorDetector';
 
 const {
   utils: { hexlify, hexDataLength, hexConcat, hexZeroPad, solidityPack },
@@ -229,7 +228,6 @@ export abstract class ExecutorBytecodeBuilder<S = {}, D = {}> {
     specialDexFlag: SpecialDex,
     flag: Flag,
     toAmountPos = 0,
-    returnAmountPos = DEFAULT_RETURN_AMOUNT_POS,
   ): string {
     const builder =
       this.type !== Executors.THREE
@@ -244,7 +242,6 @@ export abstract class ExecutorBytecodeBuilder<S = {}, D = {}> {
       specialDexFlag,
       flag,
       toAmountPos,
-      returnAmountPos,
     );
   }
 
@@ -255,15 +252,13 @@ export abstract class ExecutorBytecodeBuilder<S = {}, D = {}> {
     destTokenPos: number,
     specialDexFlag: SpecialDex,
     flag: Flag,
-    toAmountPos = 0, // not used for Executor01 and Executor02, just to follow the same interface
-    returnAmountPos = DEFAULT_RETURN_AMOUNT_POS,
   ) {
     return solidityPack(EXECUTOR_01_02_FUNCTION_CALL_DATA_TYPES, [
       tokenAddress, // token address
       hexZeroPad(hexlify(hexDataLength(calldata) + BYTES_28_LENGTH), 4), // calldata length + bytes28(0)
       hexZeroPad(hexlify(fromAmountPos), 2), // fromAmountPos
       hexZeroPad(hexlify(destTokenPos), 2), // destTokenPos
-      hexZeroPad(hexlify(returnAmountPos), 1), // returnAmountPos
+      hexZeroPad(hexlify(DEFAULT_RETURN_AMOUNT_POS), 1), // TODO: Fix returnAmount Pos
       hexZeroPad(hexlify(specialDexFlag), 1), // special
       hexZeroPad(hexlify(flag), 2), // flag
       ZEROS_28_BYTES, // bytes28(0)

package/src/executor/ExecutorDetector.ts

@@ -21,7 +21,7 @@ export class ExecutorDetector {
       [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
+      [RouteExecutionType.VERTICAL_BRANCH_HORIZONTAL_SEQUENCE]: Executors.TWO, // multiSwap with pecentages on paths via Executor02
       // megaSwap via Executor02
       [RouteExecutionType.NESTED_VERTICAL_BRANCH_HORIZONTAL_SEQUENCE]:
         Executors.TWO,
@@ -46,7 +46,7 @@ export class ExecutorDetector {
     this.wethBytecodeBuilder = new WETHBytecodeBuilder(this.dexHelper);
   }
 
-  public getRouteExecutionType(priceRoute: OptimalRate): RouteExecutionType {
+  protected getRouteExecutionType(priceRoute: OptimalRate): RouteExecutionType {
     if (
       priceRoute.bestRoute.length === 1 &&
       priceRoute.bestRoute[0].percent === 100 &&
@@ -85,7 +85,6 @@ export class ExecutorDetector {
 
     throw new Error('Route type is not supported yet');
   }
-
   detectSpecialExecutor(priceRoute: OptimalRate): Executors | null {
     if (isSingleWrapRoute(priceRoute)) return Executors.WETH;
     return null;

package/src/executor/constants.ts

@@ -47,10 +47,7 @@ export const EXECUTOR_03_FUNCTION_CALL_DATA_TYPES: string[] = [
 
 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;
+export const DEFAULT_RETURN_AMOUNT_POS = '0xff';
 
 // 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
@@ -61,5 +58,6 @@ export const DISABLED_MAX_UNIT_APPROVAL_TOKENS: Partial<
   [Network.MAINNET]: [
     '0xdac17f958d2ee523a2206206994597c13d831ec7',
     '0xd101dcc414f310268c37eeb4cd376ccfa507f571',
+    '0x0f5d2fb29fb7d3cfee444a200298f468908cc942',
   ],
 };

package/src/executor/executor01-bytecode-builder-e2e.test.ts

@@ -183,45 +183,6 @@ describe('Executor01ByteCodeBuilder e2e tests', () => {
             provider,
           );
         });
-
-        it('simpleSwap USDC -> ETH', async () => {
-          await testE2E(
-            tokens['USDC'],
-            tokens['ETH'],
-            holders['USDC'],
-            '100000000',
-            SwapSide.SELL,
-            dexKey,
-            ContractMethod.simpleSwap,
-            network,
-            provider,
-          );
-        });
-      });
-
-      describe('Etherfi', () => {
-        const dexKey = 'EtherFi';
-
-        const tokens = Tokens[network];
-        const holders = Holders[network];
-        const provider = new StaticJsonRpcProvider(
-          generateConfig(network).privateHttpProvider,
-          network,
-        );
-
-        it('simpleSwap eETH -> weETH', async () => {
-          await testE2E(
-            tokens['eETH'],
-            tokens['weETH'],
-            holders['eETH'],
-            '100000000000000000',
-            SwapSide.SELL,
-            dexKey,
-            ContractMethod.simpleSwap,
-            network,
-            provider,
-          );
-        });
       });
 
       describe('BalancerV2', () => {

package/src/router/simpleswap.ts

@@ -135,7 +135,7 @@ export abstract class SimpleRouterBase<RouterParam>
             }
           }
 
-          const simpleParams = await dex.getSimpleParam(
+          const simpleParams = await dex.getSimpleParam?.(
             _src,
             _dest,
             _srcAmount,
@@ -157,7 +157,7 @@ export abstract class SimpleRouterBase<RouterParam>
       simpleExchangeDataList,
       srcAmountWethToDeposit,
       destAmountWethToWithdraw,
-    } = await rawSimpleParams.reduce<{
+    } = rawSimpleParams.reduce<{
       simpleExchangeDataList: SimpleExchangeParam[];
       srcAmountWethToDeposit: bigint;
       destAmountWethToWithdraw: bigint;
@@ -165,7 +165,11 @@ export abstract class SimpleRouterBase<RouterParam>
       (acc, se) => {
         acc.srcAmountWethToDeposit += BigInt(se.wethDeposit);
         acc.destAmountWethToWithdraw += BigInt(se.wethWithdraw);
-        acc.simpleExchangeDataList.push(se.simpleParams);
+        // V6 doesn't have simpleParams
+        if (se.simpleParams) {
+          acc.simpleExchangeDataList.push(se.simpleParams);
+        }
+
         return acc;
       },
       {

package/src/types.ts

@@ -170,7 +170,6 @@ export type DexExchangeParam = {
   specialDexSupportsInsertFromAmount?: boolean;
   swappedAmountNotPresentInExchangeData?: boolean;
   preSwapUnwrapCalldata?: string;
-  returnAmountPos: number | undefined;
 };
 
 export type DexExchangeBuildParam = DexExchangeParam & {

package/tests/constants-e2e.ts

@@ -407,10 +407,6 @@ export const Tokens: {
       address: '0x35fa164735182de50811e8e2e824cfb9b6118ac2',
       decimals: 18,
     },
-    weETH: {
-      address: '0xcd5fe23c85820f7b72d0926fc9b05b43e359b7ee',
-      decimals: 18,
-    },
   },
   [Network.ROPSTEN]: {
     DAI: {
@@ -1379,7 +1375,6 @@ export const Holders: {
     BNT: '0xf727e20e081aAE428E7c6bE07b156bB21ab587a7',
     USDe: '0x74e6c48e667d698a4cf90665b6960a5bae39e603',
     eETH: '0x0f1DfeF1a40557d279d0de6E49aB306891A638b8',
-    weETH: '0xfB4cB868727D9622258bf2B26A8CFc95f6742669',
   },
   [Network.ROPSTEN]: {
     ETH: '0x43262A12d8610AA70C15DbaeAC321d51613c9071',
@@ -1546,7 +1541,7 @@ export const Holders: {
     LINK: '0x7f1fa204bb700853d36994da19f830b6ad18455c',
     DMT: '0x40414f138eb2ef938e6c3629897ef99d4464d4e8',
     PENDLE: '0x5bdf85216ec1e38d6458c870992a69e38e03f7ef',
-    wstETH: '0x27edc7700f1820cb38ec3bbb84c542945f21b5a1',
+    wstETH: '0x916792f7734089470de27297903bed8a4630b26d',
     EURA: '0x6dd7b830896b56812aa667bdd14b71c8b3252f8e',
     stEUR: '0xE588611e7A2392507879E3be80531654b85C16aA',
     USDA: '0xa86ff337db9107b54862d30d1a598f8be847b05e',

package/.github/workflows/release-package.yml

@@ -1,32 +0,0 @@
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - run: yarn
-
-  publish-gpr:
-    needs: build
-    runs-on: ubuntu-latest
-    permissions:
-      packages: write
-      contents: read
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://npm.pkg.github.com/
-      - run: yarn
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/.idea/aws.xml

@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="accountSettings">
-    <option name="activeProfile" value="profile:default" />
-    <option name="activeRegion" value="us-east-1" />
-    <option name="recentlyUsedProfiles">
-      <list>
-        <option value="profile:default" />
-      </list>
-    </option>
-    <option name="recentlyUsedRegions">
-      <list>
-        <option value="us-east-1" />
-      </list>
-    </option>
-  </component>
-</project>

package/.idea/codeStyles/Project.xml

@@ -1,55 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <HTMLCodeStyleSettings>
-      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
-      <option name="HTML_QUOTE_STYLE" value="Single" />
-      <option name="HTML_ENFORCE_QUOTES" value="true" />
-    </HTMLCodeStyleSettings>
-    <JSCodeStyleSettings version="0">
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </JSCodeStyleSettings>
-    <ScalaCodeStyleSettings>
-      <option name="MULTILINE_STRING_CLOSING_QUOTES_ON_NEW_LINE" value="true" />
-    </ScalaCodeStyleSettings>
-    <TypeScriptCodeStyleSettings version="0">
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_WITHIN_ARRAY_INITIALIZER_BRACKETS" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </TypeScriptCodeStyleSettings>
-    <codeStyleSettings language="HTML">
-      <option name="SOFT_MARGINS" value="80" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="JavaScript">
-      <option name="SOFT_MARGINS" value="80" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="TypeScript">
-      <option name="SOFT_MARGINS" value="80" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-  </code_scheme>
-</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-  </state>
-</component>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-  </profile>
-</component>

package/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/paraswap-dex-lib-private.iml" filepath="$PROJECT_DIR$/.idea/paraswap-dex-lib-private.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/paraswap-dex-lib-private.iml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="JAVA_MODULE" version="4">
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/prettier.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="PrettierConfiguration">
-    <option name="myRunOnSave" value="true" />
-    <option name="myRunOnReformat" value="true" />
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
-</project>