@paraswap/dex-lib 3.3.0 → 3.3.1-return-amount-pos.0

package/src/dex/stable-pool/stable-pool.ts

@@ -12,6 +12,7 @@ import { SimpleExchange } from '../simple-exchange';
 import StablePoolABI from '../../abi/StablePool.json';
 import { IDexHelper } from '../../dex-helper';
 import { StablePoolFunctions, StablePoolData, StablePoolParam } from './types';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class StablePool
   extends SimpleExchange
@@ -123,6 +124,13 @@ export class StablePool
       dexFuncHasRecipient: false,
       exchangeData: swapData,
       targetExchange: exchange,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.exchangeRouterInterface,
+              StablePoolFunctions.swap,
+            )
+          : undefined,
     };
   }
 }

package/src/dex/swaap-v1/swaap-v1.ts

@@ -41,6 +41,7 @@ import {
 import { SwaapV1Pool } from './swaap-v1-pool';
 import PoolABI from '../../abi/swaap-v1/pool.json';
 import { PoolQuotations } from './libraries/PoolQuotations';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class SwaapV1 extends SimpleExchange implements IDex<SwaapV1Data> {
   static readonly poolInterface = new Interface(PoolABI);
@@ -286,6 +287,14 @@ export class SwaapV1 extends SimpleExchange implements IDex<SwaapV1Data> {
       dexFuncHasRecipient: false,
       exchangeData: swapData,
       targetExchange: data.pool,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              SwaapV1.poolInterface,
+              functionName,
+              'tokenAmountOut',
+            )
+          : undefined,
     };
   }
 

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

@@ -476,6 +476,7 @@ export class SwaapV2 extends SimpleExchange implements IDex<SwaapV2Data> {
       exchangeData: callData,
       specialDexFlag: SpecialDex.SWAP_ON_SWAAP_V2_SINGLE,
       targetExchange: router,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/swell/swell.ts

@@ -291,6 +291,7 @@ export class Swell
             srcAmount,
           ])
         : undefined,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/synthetix/synthetix.ts

@@ -31,6 +31,7 @@ import { SynthetixState } from './synthetix-state';
 // There are so many ABIs, where I need only one or two functions
 // So, I decided to unite them into one combined interface
 import CombinedSynthetixABI from '../../abi/synthetix/CombinedSynthetix.abi.json';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class Synthetix extends SimpleExchange implements IDex<SynthetixData> {
   readonly hasConstantPriceLargeAmounts = false;
@@ -357,6 +358,16 @@ export class Synthetix extends SimpleExchange implements IDex<SynthetixData> {
       dexFuncHasRecipient: false,
       exchangeData: swapData,
       targetExchange: exchange,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.combinedIface,
+              this.network === Network.OPTIMISM
+                ? 'exchange'
+                : 'exchangeAtomically',
+              'amountReceived',
+            )
+          : undefined,
     };
   }
 

package/src/dex/trader-joe-v2.1/trader-joe-v2.1.ts

@@ -21,6 +21,7 @@ import {
   TraderJoeV2RouterParam,
 } from './types';
 import { TRADERJOE_V2_1_ROUTER_ADDRESS } from './config';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class TraderJoeV21
   extends SimpleExchange
@@ -166,6 +167,14 @@ export class TraderJoeV21
       dexFuncHasRecipient: true,
       exchangeData: swapData,
       targetExchange: this.routerAddress,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.exchangeRouterInterface,
+              swapFunction,
+              'amountOut',
+            )
+          : undefined,
     };
   }
 }

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

@@ -914,6 +914,7 @@ export class UniswapV2
       targetExchange,
       specialDexFlag,
       transferSrcTokenBeforeSwap,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/uniswap-v3/uniswap-v3.ts

@@ -71,6 +71,7 @@ import {
 import { OptimalSwapExchange } from '@paraswap/core';
 import { OnPoolCreatedCallback, UniswapV3Factory } from './uniswap-v3-factory';
 import { hexConcat, hexlify, hexZeroPad, hexValue } from 'ethers/lib/utils';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 type PoolPairsInfo = {
   token0: Address;
@@ -1141,6 +1142,14 @@ export class UniswapV3
       dexFuncHasRecipient: true,
       exchangeData,
       targetExchange: this.config.router,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.routerIface,
+              swapFunction,
+              'amountOut',
+            )
+          : undefined,
     };
   }
 

package/src/dex/uniswap-v3.ts

@@ -15,6 +15,7 @@ import {
 import UniswapV3RouterABI from '../abi/UniswapV3Router.json';
 import { NumberAsString } from '@paraswap/core';
 import { IDexHelper } from '../dex-helper';
+import { extractReturnAmountPosition } from '../executor/utils';
 
 const UNISWAP_V3_ROUTER_ADDRESSES: { [network: number]: Address } = {
   [Network.MAINNET]: '0xE592427A0AEce92De3Edee1F18E0157C05861564',
@@ -228,6 +229,14 @@ export class UniswapV3
       dexFuncHasRecipient: true,
       exchangeData,
       targetExchange: this.routerAddress,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.exchangeRouterInterface,
+              swapFunction,
+              'amountOut',
+            )
+          : undefined,
     };
   }
 }

package/src/dex/weth/weth.ts

@@ -170,6 +170,7 @@ export class Weth
       dexFuncHasRecipient: false,
       exchangeData: swapData,
       targetExchange: this.address,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/wombat/wombat.ts

@@ -32,6 +32,7 @@ import { WombatBmw } from './wombat-bmw';
 import { fromWad } from './utils';
 import { WombatPool } from './wombat-pool';
 import { StatePollingManager } from '../../lib/stateful-rpc-poller/state-polling-manager';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class Wombat extends SimpleExchange implements IDex<WombatData> {
   // contract interfaces
@@ -339,6 +340,14 @@ export class Wombat extends SimpleExchange implements IDex<WombatData> {
       dexFuncHasRecipient: true,
       exchangeData: swapData,
       targetExchange: exchange,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              Wombat.poolInterface,
+              'swap',
+              'actualToAmount',
+            )
+          : undefined,
     };
   }
 

package/src/dex/woo-fi-v2/woo-fi-v2.ts

@@ -28,6 +28,7 @@ import { addressDecode } from '../../lib/decoders';
 import { ifaces } from './utils';
 import { StatePollingManager } from '../../lib/stateful-rpc-poller/state-polling-manager';
 import { solidityPack } from 'ethers/lib/utils';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class WooFiV2 extends SimpleExchange implements IDex<WooFiV2Data> {
   readonly math: WooFiV2Math;
@@ -357,6 +358,10 @@ export class WooFiV2 extends SimpleExchange implements IDex<WooFiV2Data> {
       exchangeData: swapData,
       targetExchange: this.config.wooPPV2Address,
       transferSrcTokenBeforeSwap: this.config.wooPPV2Address,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(ifaces.PPV2, 'swap', 'realToAmount')
+          : undefined,
     };
   }
 

package/src/dex/wsteth/wsteth.ts

@@ -23,6 +23,7 @@ import { uint256ToBigInt } from '../../lib/decoders';
 import { Utils } from '../../utils';
 import WSTETH_ABI from '../../abi/wstETH.json';
 import STETH_ABI from '../../abi/stETH.json';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class WstETH extends SimpleExchange implements IDex<WstETHData> {
   static readonly wstETHIface = new Interface(WSTETH_ABI);
@@ -252,16 +253,24 @@ export class WstETH extends SimpleExchange implements IDex<WstETHData> {
     data: WstETHData,
     side: SwapSide,
   ): Promise<DexExchangeParam> {
-    const exchangeData = WstETH.wstETHIface.encodeFunctionData(
-      srcToken.toLowerCase() === this.config.stETHAddress ? 'wrap' : 'unwrap',
-      [srcAmount],
-    );
+    const swapFunction =
+      srcToken.toLowerCase() === this.config.stETHAddress ? 'wrap' : 'unwrap';
+    const exchangeData = WstETH.wstETHIface.encodeFunctionData(swapFunction, [
+      srcAmount,
+    ]);
 
     return {
       needWrapNative: this.needWrapNative,
       dexFuncHasRecipient: false,
       exchangeData,
       targetExchange: this.config.wstETHAddress,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              WstETH.wstETHIface,
+              swapFunction,
+            )
+          : undefined,
     };
   }
 

package/src/dex/zerox/index.ts

@@ -257,6 +257,7 @@ export class ZeroX
       dexFuncHasRecipient: false,
       exchangeData: swapData,
       targetExchange: this.getExchange(data),
+      returnAmountPos: undefined,
     };
   }
 

package/src/executor/Executor01BytecodeBuilder.ts

@@ -4,7 +4,7 @@ import { OptimalRate } from '@paraswap/core';
 import { isETHAddress } from '../utils';
 import { DepositWithdrawReturn } from '../dex/weth/types';
 import { Executors, Flag, SpecialDex } from './types';
-import { BYTES_64_LENGTH } from './constants';
+import { BYTES_64_LENGTH, DEFAULT_RETURN_AMOUNT_POS } from './constants';
 import {
   DexCallDataParams,
   ExecutorBytecodeBuilder,
@@ -351,6 +351,11 @@ export class Executor01BytecodeBuilder extends ExecutorBytecodeBuilder<
     const swap = priceRoute.bestRoute[routeIndex].swaps[swapIndex];
     let { exchangeData, specialDexFlag } = exchangeParam;
 
+    const returnAmountPos =
+      exchangeParam.returnAmountPos !== undefined
+        ? exchangeParam.returnAmountPos
+        : DEFAULT_RETURN_AMOUNT_POS;
+
     let destTokenPos = 0;
     if (checkDestTokenBalanceAfterSwap && !dontCheckBalanceAfterSwap) {
       const destTokenAddr = isETHAddress(swap.destToken)
@@ -393,6 +398,8 @@ export class Executor01BytecodeBuilder extends ExecutorBytecodeBuilder<
       destTokenPos,
       specialDexFlag || SpecialDex.DEFAULT,
       flag,
+      undefined,
+      returnAmountPos,
     );
   }
 

package/src/executor/Executor02BytecodeBuilder.ts

@@ -22,6 +22,7 @@ import {
   ZEROS_20_BYTES,
   ZEROS_28_BYTES,
   ZEROS_4_BYTES,
+  DEFAULT_RETURN_AMOUNT_POS,
 } from './constants';
 import { assert } from 'ts-essentials';
 
@@ -276,6 +277,16 @@ 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,
@@ -343,6 +354,8 @@ export class Executor02BytecodeBuilder extends ExecutorBytecodeBuilder<
       destTokenPos,
       specialDexFlag || SpecialDex.DEFAULT,
       flag,
+      undefined,
+      returnAmountPos,
     );
   }
 

package/src/executor/ExecutorBytecodeBuilder.ts

@@ -25,6 +25,7 @@ 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 },
@@ -228,6 +229,7 @@ export abstract class ExecutorBytecodeBuilder<S = {}, D = {}> {
     specialDexFlag: SpecialDex,
     flag: Flag,
     toAmountPos = 0,
+    returnAmountPos = DEFAULT_RETURN_AMOUNT_POS,
   ): string {
     const builder =
       this.type !== Executors.THREE
@@ -242,6 +244,7 @@ export abstract class ExecutorBytecodeBuilder<S = {}, D = {}> {
       specialDexFlag,
       flag,
       toAmountPos,
+      returnAmountPos,
     );
   }
 
@@ -252,13 +255,15 @@ 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(DEFAULT_RETURN_AMOUNT_POS), 1), // TODO: Fix returnAmount Pos
+      hexZeroPad(hexlify(returnAmountPos), 1), // returnAmountPos
       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 pecentages on paths 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,
@@ -46,7 +46,7 @@ export class ExecutorDetector {
     this.wethBytecodeBuilder = new WETHBytecodeBuilder(this.dexHelper);
   }
 
-  protected getRouteExecutionType(priceRoute: OptimalRate): RouteExecutionType {
+  public getRouteExecutionType(priceRoute: OptimalRate): RouteExecutionType {
     if (
       priceRoute.bestRoute.length === 1 &&
       priceRoute.bestRoute[0].percent === 100 &&
@@ -85,6 +85,7 @@ 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,7 +47,10 @@ 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 = '0xff';
+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

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

@@ -183,6 +183,45 @@ 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/executor/utils.ts

@@ -0,0 +1,44 @@
+import { FunctionFragment, Interface } from '@ethersproject/abi';
+import { RETURN_AMOUNT_POS_0, RETURN_AMOUNT_POS_32 } from './constants';
+
+export const extractReturnAmountPosition = (
+  iface: Interface,
+  functionName: string | FunctionFragment,
+  outputName = '',
+): number => {
+  const func =
+    typeof functionName === 'string'
+      ? iface.getFunction(functionName)
+      : functionName;
+  const outputs = func.outputs || [];
+  const index = outputs.findIndex(
+    ({ name }) => name === outputName || (outputName === '' && name === null),
+  );
+
+  if (index < 0) {
+    throw new Error(
+      `Function ${functionName} was not found in the provided abi`,
+    );
+  }
+
+  if (index === 0) {
+    return RETURN_AMOUNT_POS_0;
+  }
+
+  let position = RETURN_AMOUNT_POS_0;
+  let curIndex = 0;
+  while (curIndex < index) {
+    const output = outputs[curIndex];
+
+    if (output.type.includes('[]') || output.type.includes('struct')) {
+      throw new Error(
+        `extractReturnAmountPosition doesn't support outputs of type array or struct. Please define returnAmountPos manually for this case.`,
+      );
+    }
+
+    position += RETURN_AMOUNT_POS_32;
+    curIndex++;
+  }
+
+  return position;
+};

package/src/types.ts

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

package/tests/constants-e2e.ts

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