@paraswap/dex-lib 3.0.3-fix-for-rc.0 → 3.0.4

package/src/dex/balancer-v2/balancer-v2.ts

@@ -1010,6 +1010,8 @@ export class BalancerV2
       destAmount,
       data,
       side,
+      this.dexHelper.config.data.augustusAddress!,
+      this.dexHelper.config.data.augustusAddress!,
     );
 
     const payload = this.abiCoder.encodeParameter(
@@ -1049,6 +1051,24 @@ export class BalancerV2
     };
   }
 
+  /*
+      Algorithm to determine balancer (sender, recipient) params:
+
+      if version = 5
+          sender = recipient = augustusV5
+      else (so V6)
+        if direct swap
+            sender = recipient = augustusV6
+        else (so generic swaps)
+          if sell
+            if swap.destToken = priceRoute.destToken <> ETH (need withdraw for eth currently, need fix in future) 
+                  sender = executor and recipient = augustusV6 (skip 1 extra transfer)
+              else 
+                  sender = recipient = executor
+              # note: we pass sender=null then the address of the executor is inferred contract side
+          else (so buy)
+              sender = recipient = executor
+*/
   public getBalancerParam(
     srcToken: string,
     destToken: string,
@@ -1056,6 +1076,8 @@ export class BalancerV2
     destAmount: string,
     data: OptimizedBalancerV2Data,
     side: SwapSide,
+    recipient: string,
+    sender: string,
   ): BalancerParam {
     let swapOffset = 0;
     let swaps: BalancerSwap[] = [];
@@ -1115,116 +1137,6 @@ export class BalancerV2
     }
 
     const funds = {
-      sender: this.augustusAddress,
-      recipient: this.augustusAddress,
-      fromInternalBalance: false,
-      toInternalBalance: false,
-    };
-
-    const params: BalancerParam = [
-      side === SwapSide.SELL ? SwapTypes.SwapExactIn : SwapTypes.SwapExactOut,
-      side === SwapSide.SELL ? swaps : swaps.reverse(),
-      assets,
-      funds,
-      limits,
-      MAX_UINT,
-    ];
-
-    return params;
-  }
-
-  public getBalancerParamV6(
-    srcToken: Address,
-    destToken: Address,
-    srcAmount: string,
-    destAmount: string,
-    data: OptimizedBalancerV2Data,
-    side: SwapSide,
-    recipient: Address,
-    sender: Address,
-    isDirect?: boolean,
-  ): BalancerParam {
-    let swapOffset = 0;
-    let swaps: BalancerSwap[] = [];
-    let assets: string[] = [];
-    let limits: string[] = [];
-
-    const isDirectSwap = !!isDirect;
-
-    for (const swapData of data.swaps) {
-      const pool = this.poolIdMap[swapData.poolId];
-      const hasEth = [srcToken.toLowerCase(), destToken.toLowerCase()].includes(
-        ETHER_ADDRESS.toLowerCase(),
-      );
-      const _srcToken = this.dexHelper.config.wrapETH({
-        address: srcToken,
-        decimals: 18,
-      }).address;
-      const _destToken = this.dexHelper.config.wrapETH({
-        address: destToken,
-        decimals: 18,
-      }).address;
-
-      let path = poolGetPathForTokenInOut(
-        _srcToken,
-        _destToken,
-        pool,
-        this.poolAddressMap,
-        side,
-      );
-
-      if (side === SwapSide.BUY) {
-        path = path.reverse();
-      }
-
-      let _swaps = path.map((hop, index) => ({
-        poolId: hop.pool.id,
-        assetInIndex: swapOffset + index,
-        assetOutIndex: swapOffset + index + 1,
-        amount:
-          (side === SwapSide.SELL && index === 0) ||
-          (side === SwapSide.BUY && index === path.length - 1)
-            ? swapData.amount
-            : '0',
-        userData: '0x',
-      }));
-
-      swapOffset += path.length + 1;
-
-      // BalancerV2 Uses Address(0) as ETH
-      let _assets = [_srcToken, ...path.map(hop => hop.tokenOut.address)].map(
-        t => (hasEth && this.dexHelper.config.isWETH(t) ? NULL_ADDRESS : t),
-      );
-
-      if (isDirectSwap && side === SwapSide.BUY) {
-        _assets = _assets.reverse();
-        _swaps = _swaps.map(swap => ({
-          ...swap,
-          assetInIndex: _assets.length - swap.assetInIndex - 1,
-          assetOutIndex: _assets.length - swap.assetOutIndex - 1,
-        }));
-      }
-
-      let _limits: string[];
-      if (isDirectSwap) {
-        _limits = this.createSwapArray(
-          _assets.length,
-          side === SwapSide.SELL ? 0 : 1,
-          srcAmount,
-          destAmount,
-        );
-      } else {
-        _limits = _assets.map(_ => MAX_INT);
-      }
-
-      swaps = swaps.concat(_swaps);
-      assets = assets.concat(_assets);
-      limits = limits.concat(_limits);
-    }
-
-    const funds = {
-      // for Direct: Both sender and recipient is AugustusV6
-      // for Generic, `sender`: BUY -> pass Executor3, for SELL -> pass NULL_ADDRESS (it's gonna be determined in the contract)
       sender,
       recipient,
       fromInternalBalance: false,
@@ -1243,23 +1155,6 @@ export class BalancerV2
     return params;
   }
 
-  private createSwapArray(
-    lengthOfAssets: number,
-    swapKind: 0 | 1,
-    fromAmount: string,
-    toAmount: string,
-  ): string[] {
-    let swapArray = new Array(lengthOfAssets).fill('0');
-
-    // Assign values based on swapKind
-    swapArray[0] =
-      swapKind === 0 ? fromAmount : BigNumber.from(toAmount).mul(-1).toString();
-    swapArray[lengthOfAssets - 1] =
-      swapKind === 0 ? BigNumber.from(toAmount).mul(-1).toString() : fromAmount;
-
-    return swapArray;
-  }
-
   static getDirectFunctionName(): string[] {
     return [DirectMethods.directSell, DirectMethods.directBuy];
   }
@@ -1354,6 +1249,8 @@ export class BalancerV2
       destAmount,
       data,
       side,
+      this.dexHelper.config.data.augustusAddress!,
+      this.dexHelper.config.data.augustusAddress!,
     );
 
     const swapParams: BalancerV2DirectParam = [
@@ -1416,7 +1313,7 @@ export class BalancerV2
       hexZeroPad(hexlify(blockNumber), 16),
     ]);
 
-    const balancerParams = this.getBalancerParamV6(
+    const balancerParams = this.getBalancerParam(
       srcToken,
       destToken,
       fromAmount,
@@ -1425,7 +1322,6 @@ export class BalancerV2
       side,
       this.dexHelper.config.data.augustusV6Address!,
       this.dexHelper.config.data.augustusV6Address!,
-      true,
     );
 
     const swapParams: BalancerV2DirectParamV6 = [
@@ -1496,6 +1392,8 @@ export class BalancerV2
       destAmount,
       data,
       side,
+      this.dexHelper.config.data.augustusAddress!,
+      this.dexHelper.config.data.augustusAddress!,
     );
 
     const swapData = this.eventPools.vaultInterface.encodeFunctionData(
@@ -1523,7 +1421,7 @@ export class BalancerV2
     side: SwapSide,
     context: Context,
   ): DexExchangeParam {
-    const params = this.getBalancerParamV6(
+    const params = this.getBalancerParam(
       srcToken,
       destToken,
       srcAmount,

package/src/dex/curve-v2/curve-v2.ts

@@ -94,6 +94,7 @@ export class CurveV2
   exchangeRouterInterface: Interface;
   genericFactoryZapIface: Interface;
   minConversionRate = '1';
+  // TODO: it's wrong, cause some pools can have eth and others can have weth
   needWrapNative = true;
   logger: Logger;
 

package/src/dex/weth/types.ts

@@ -1,4 +1,4 @@
-import { NumberAsString, SwapSide } from '@paraswap/core';
+import { NumberAsString, ParaSwapVersion, SwapSide } from '@paraswap/core';
 import { Address } from '../../types';
 
 export type WethData = null;
@@ -29,5 +29,6 @@ export interface IWethDepositorWithdrawer {
     srcAmount: NumberAsString,
     destAmount: NumberAsString,
     side: SwapSide,
+    version: ParaSwapVersion,
   ): DepositWithdrawReturn;
 }

package/src/dex/weth/weth.ts

@@ -25,7 +25,7 @@ import {
 import { SimpleExchange } from '../simple-exchange';
 import { Adapters, WethConfig } from './config';
 import { BI_POWS } from '../../bigint-constants';
-import { NumberAsString } from '@paraswap/core';
+import { NumberAsString, ParaSwapVersion } from '@paraswap/core';
 
 export class Weth
   extends SimpleExchange
@@ -184,6 +184,7 @@ export class Weth
     srcAmount: string,
     destAmount: string,
     side: SwapSide,
+    version: ParaSwapVersion,
   ): DepositWithdrawReturn {
     const wethToken = this.address;
 
@@ -206,13 +207,18 @@ export class Weth
     }
 
     if (needWithdraw || destAmount !== '0') {
-      const opType = WethFunctions.withdraw;
-      const withdrawWethData = this.erc20Interface.encodeFunctionData(opType, [
-        destAmount,
-      ]);
+      const withdrawWethData =
+        version === ParaSwapVersion.V5
+          ? this.simpleSwapHelper.encodeFunctionData(
+              WethFunctions.withdrawAllWETH,
+              [wethToken],
+            )
+          : this.erc20Interface.encodeFunctionData(WethFunctions.withdraw, [
+              destAmount,
+            ]);
 
       withdraw = {
-        callee: this.augustusAddress,
+        callee: this.augustusAddress, // FXME CALLEE NOT USED IN V6
         calldata: withdrawWethData,
         value: '0',
       };

package/src/executor/Executor02BytecodeBuilder.ts

@@ -176,7 +176,7 @@ export class Executor02BytecodeBuilder extends ExecutorBytecodeBuilder {
     const needCheckEthBalance = isEthDest && !needWrapNative;
 
     const needCheckSrcTokenBalanceOf =
-      (needUnwrap && !applyVerticalBranching && !isLastSwap) ||
+      (needUnwrap && !applyVerticalBranching) ||
       (isHorizontalSequence && !applyVerticalBranching && !isLastSwap);
 
     let dexFlag: Flag;
@@ -719,7 +719,9 @@ export class Executor02BytecodeBuilder extends ExecutorBytecodeBuilder {
     if (
       !exchangeParams[exchangeParamIndex].dexFuncHasRecipient &&
       isETHAddress(swap.destToken) &&
-      isLast
+      isLast &&
+      // don't need to send eth without unwrapping, handling unwrap and sendEth in the end of root branch
+      !this.doesRouteNeedsRootUnwrapEth(priceRoute, exchangeParams)
     ) {
       const finalSpecialFlagCalldata = this.buildFinalSpecialFlagCalldata();
       swapExchangeCallData = hexConcat([
@@ -1168,13 +1170,13 @@ export class Executor02BytecodeBuilder extends ExecutorBytecodeBuilder {
 
     const res = priceRoute.bestRoute.some((route, routeIndex) => {
       const lastSwap = route.swaps[route.swaps.length - 1];
-      const eachDexOnSwapNeedsWrapNative = this.anyDexOnSwapNeedsWrapNative(
+      const anyDexOnSwapNeedsWrapNative = this.anyDexOnSwapNeedsWrapNative(
         priceRoute,
         lastSwap,
         exchangeParams,
       );
 
-      return eachDexOnSwapNeedsWrapNative;
+      return anyDexOnSwapNeedsWrapNative;
     });
 
     return res;

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

@@ -1067,12 +1067,7 @@ describe('Executor02ByteCodeBuilder e2e tests', () => {
       });
 
       describe('lzUSDC -> FTM -> SPIRIT', () => {
-        const dexKeys = [
-          'Morphex',
-          'SpiritSwap',
-          'SpiritSwapV2',
-          'BeetsFi',
-        ];
+        const dexKeys = ['Morphex', 'SpiritSwap', 'SpiritSwapV2', 'BeetsFi'];
 
         const tokenASymbol: string = 'lzUSDC';
         const tokenBSymbol: string = 'SPIRIT';
@@ -1437,7 +1432,7 @@ describe('Executor02ByteCodeBuilder e2e tests', () => {
             false,
           );
         });
-      })
+      });
     });
   });
 

package/src/generic-swap-transaction-builder.ts

@@ -32,6 +32,7 @@ import ERC20ABI from './abi/erc20.json';
 import { ExecutorDetector } from './executor/ExecutorDetector';
 import { ExecutorBytecodeBuilder } from './executor/ExecutorBytecodeBuilder';
 import { IDexTxBuilder } from './dex/idex';
+import { ParaSwapVersion } from '@paraswap/core';
 
 const {
   utils: { hexlify, hexConcat, hexZeroPad },
@@ -92,6 +93,7 @@ export class GenericSwapTransactionBuilder {
       srcAmountWeth.toString(),
       destAmountWeth.toString(),
       side,
+      ParaSwapVersion.V6,
     );
   }
 

package/src/router/simpleswap.ts

@@ -19,6 +19,7 @@ import {
   encodeFeePercentForReferrer,
   encodePartnerAddressForFeeLogic,
 } from './payload-encoder';
+import { ParaSwapVersion } from '@paraswap/core';
 
 type SimpleSwapParam = [ConstractSimpleData];
 
@@ -244,6 +245,7 @@ export abstract class SimpleRouterBase<RouterParam>
       srcAmountWeth.toString(),
       destAmountWeth.toString(),
       this.side,
+      ParaSwapVersion.V5,
     );
   }
 }

package/tests/debug-price-route.json

@@ -1 +1,87 @@
-{ "priceRoute" : { "blockNumber" : 19433584, "network" : 1, "srcToken" : "0xae7ab96520de3a18e5e111b5eaab095312d7fe84", "srcDecimals" : 18, "srcAmount" : "864303161674786484853", "destToken" : "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee", "destDecimals" : 18, "destAmount" : "863477638047664488829", "bestRoute" : [ { "percent" : 18, "swaps" : [ { "srcToken" : "0xae7ab96520de3a18e5e111b5eaab095312d7fe84", "srcDecimals" : 18, "destToken" : "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee", "destDecimals" : 18, "swapExchanges" : [ { "exchange" : "CurveV1", "srcAmount" : "155574569101461567274", "destAmount" : "155426142829423771521", "percent" : 100, "poolAddresses" : [ "0xdc24316b9ae028f1497c275eb9192a3ea0f67022" ], "data" : { "exchange" : "0xdc24316b9ae028f1497c275eb9192a3ea0f67022", "i" : 1, "j" : 0, "underlyingSwap" : false, "deadline" : 0, "gasUSD" : "50.718266" } } ] } ] }, { "percent" : 82, "swaps" : [ { "srcToken" : "0xae7ab96520de3a18e5e111b5eaab095312d7fe84", "srcDecimals" : 18, "destToken" : "0x7f39c581f595b53c5cb19bd0b3f8da6c935e2ca0", "destDecimals" : 18, "swapExchanges" : [ { "exchange" : "wstETH", "srcAmount" : "708728592573324917579", "destAmount" : "610809583801027512819", "percent" : 100, "poolAddresses" : [ "0x7f39c581f595b53c5cb19bd0b3f8da6c935e2ca0" ], "data" : { "gasUSD" : "15.215480" } } ] }, { "srcToken" : "0x7f39c581f595b53c5cb19bd0b3f8da6c935e2ca0", "srcDecimals" : 18, "destToken" : "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee", "destDecimals" : 18, "swapExchanges" : [ { "exchange" : "UniswapV3", "srcAmount" : "566098322266792298881", "destAmount" : "656241721408829891190", "percent" : 92.68, "poolAddresses" : [ "0x109830a1aaad605bbf02a9dfa7b0b92ec2fb7daa" ], "data" : { "path" : [ { "tokenIn" : "0x7f39c581f595b53c5cb19bd0b3f8da6c935e2ca0", "tokenOut" : "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2", "fee" : "100", "currentFee" : "100" } ], "gasUSD" : "33.727647" } }, { "exchange" : "SolidlyV3", "srcAmount" : "44711261534235213938", "destAmount" : "51809773809410826118", "percent" : 7.32, "poolAddresses" : [ "0x4370e48e610d2e02d3d091a9d79c8eb9a54c5b1c" ], "data" : { "zeroForOne" : true, "poolAddress" : "0x4370e48e610d2e02d3d091a9d79c8eb9a54c5b1c", "gasUSD" : "15.215480" } } ] } ] } ], "gasCostUSD" : "137.167551", "gasCost" : "540900", "side" : "SELL", "tokenTransferProxy" : "0x216b4b4ba9f3e719726886d34a177484278bfcae", "contractAddress" : "0xDEF171Fe48CF0115B1d80b88dc8eAB59176FEe57", "contractMethod" : "megaSwap", "partnerFee" : 0.28, "srcUSD" : "3392761.5599330571", "destUSD" : "3368776.0521803359", "partner" : "ledger2", "maxImpactReached" : false, "hmac" : "ad89afc898d3ab06ec3141992db9c12089749711" }, "minMaxAmount" : "859160249857426166384", "userAddress" : "0x0F0231B43Ee64d53DcAe20b89783ee78a48bBC24", "partnerAddress" : "0x558247e365be655f9144e1a0140D793984372Ef3", "partnerFeePercent" : "28", "takeSurplus" : false, "maxPriorityFeePerGas" : "90000000", "maxFeePerGas" : "80300000000", "deadline" : "1710445007", "uuid" : "a2cbe4f1-79ed-40b6-a95d-581e30eed150", "beneficiary" : "0x0000000000000000000000000000000000000000", "onlyParams" : false, "ignoreChecks" : false, "userIP" : "220.255.55.139", "buildFailed" : false }
+ {
+        "userIP": "78.201.144.55",
+        "priceRoute": {
+            "blockNumber": 54765382,
+            "network": 137,
+            "srcToken": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
+            "srcDecimals": 18,
+            "srcAmount": "1933698735959307184",
+            "destToken": "0x8f3cf7ad23cd3cadbd9735aff958023239c6a063",
+            "destDecimals": 18,
+            "destAmount": "2019182231196365472",
+            "bestRoute": [
+                {
+                    "percent": 100,
+                    "swaps": [
+                        {
+                            "srcToken": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
+                            "srcDecimals": 18,
+                            "destToken": "0x8f3cf7ad23cd3cadbd9735aff958023239c6a063",
+                            "destDecimals": 18,
+                            "swapExchanges": [
+                                {
+                                    "exchange": "BalancerV2",
+                                    "srcAmount": "1915328597967693765",
+                                    "destAmount": "2019182231196365472",
+                                    "percent": 100,
+                                    "poolAddresses": [
+                                        "0x5e6989c0e2b6600ab585d56bf05479d5450a60c8"
+                                    ],
+                                    "data": {
+                                        "swaps": [
+                                            {
+                                                "poolId": "0x5e6989c0e2b6600ab585d56bf05479d5450a60c8000100000000000000000055",
+                                                "amount": "2019182231196365472"
+                                            }
+                                        ],
+                                        "gasUSD": "0.007820"
+                                    }
+                                }
+                            ]
+                        }
+                    ]
+                }
+            ],
+            "gasCostUSD": "0.008971",
+            "gasCost": "168620",
+            "others": [
+                {
+                    "exchange": "BalancerV2",
+                    "srcAmount": "1933698735959307184",
+                    "destAmount": "2019182231196365472",
+                    "unit": "946590620724131563",
+                    "data": {
+                        "poolId": "0x5e6989c0e2b6600ab585d56bf05479d5450a60c8000100000000000000000055",
+                        "gasUSD": "0.012694"
+                    }
+                }
+            ],
+            "side": "BUY",
+            "version": "6",
+            "contractAddress": "0x00000000FdAC7708D0D360BDDc1bc7d097F47439",
+            "tokenTransferProxy": "0x00000000FdAC7708D0D360BDDc1bc7d097F47439",
+            "contractMethod": "swapExactAmountOutOnBalancerV2",
+            "partnerFee": 0.95,
+            "srcUSD": "2.0379096282",
+            "destUSD": "2.0182130237",
+            "partner": "ledger2",
+            "maxImpactReached": false,
+            "hmac": "7f034cb72d31209d2fb9467296042781d0c70b2c"
+        },
+        "minMaxAmount": "1943367229639103719",
+        "userAddress": "0x5AC840Fb4738C36467aC673E87aaFa26C9397dcd",
+        "txOrigin": "0x5AC840Fb4738C36467aC673E87aaFa26C9397dcd",
+        "beneficiary": "0x0000000000000000000000000000000000000000",
+        "partnerAddress": "0x558247e365be655f9144e1a0140D793984372Ef3",
+        "partnerFeePercent": "95",
+        "takeSurplus": false,
+        "gasPrice": "52000000000",
+        "onlyParams": false,
+        "ignoreChecks": false,
+        "ignoreAllowance": false,
+        "ignoreGasEstimate": false,
+        "signCalldata": false,
+        "ignoreImpactCheck": false,
+        "partner": "ledger2",
+        "isCapSurplus": true
+    }