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

package/src/dex/algebra/algebra.ts

@@ -52,6 +52,7 @@ import { AlgebraEventPoolV1_9 } from './algebra-pool-v1_9';
 import { AlgebraFactory, OnPoolCreatedCallback } from './algebra-factory';
 import { applyTransferFee } from '../../lib/token-transfer-fee';
 import { AlgebraEventPoolV1_9_bidirectional_fee } from './algebra-pool-v1_9_bidirectional_fee';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 type PoolPairsInfo = {
   token0: Address;
@@ -942,6 +943,14 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
       dexFuncHasRecipient: true,
       exchangeData,
       targetExchange: this.config.router,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.routerIface,
+              swapFunction,
+              'amountOut',
+            )
+          : undefined,
     };
   }
 

package/src/dex/angle-staked-stable/angle-staked-stable.ts

@@ -12,7 +12,7 @@ import type {
   NumberAsString,
   DexExchangeParam,
 } from '../../types';
-import { SwapSide, type Network } from '../../constants';
+import { SwapSide, Network } from '../../constants';
 import * as CALLDATA_GAS_COST from '../../calldata-gas-cost';
 import { getDexKeysWithNetwork } from '../../utils';
 import type { Context, IDex } from '../../dex/idex';
@@ -263,6 +263,7 @@ export class AngleStakedStable
       dexFuncHasRecipient: true,
       exchangeData: swapData,
       targetExchange: exchange,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/bProtocol/bProtocol.ts

@@ -12,6 +12,7 @@ import { SimpleExchange } from '../simple-exchange';
 import BProtocolABI from '../../abi/BProtocol.json';
 import { IDexHelper } from '../../dex-helper';
 import { BProtocolData, BProtocolFunctions, BProtocolParam } from './types';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class BProtocol
   extends SimpleExchange
@@ -95,6 +96,13 @@ export class BProtocol
       dexFuncHasRecipient: true,
       exchangeData: swapData,
       targetExchange: data.exchange,
+      returnAmountPos:
+        _side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.exchangeRouterInterface,
+              swapFunction,
+            )
+          : undefined,
     };
   }
 }

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

@@ -43,6 +43,7 @@ import BalancerCustomMulticallABI from '../../abi/BalancerCustomMulticall.json';
 import { NumberAsString, SwapSide } from '@paraswap/core';
 import { BigNumber, ethers } from 'ethers';
 import { SpecialDex } from '../../executor/types';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 const {
   utils: { hexlify, hexZeroPad, solidityPack },
@@ -416,6 +417,14 @@ export class BalancerV1
       dexFuncHasRecipient: false,
       exchangeData: exchangeData,
       targetExchange: this.config.exchangeProxy,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              BalancerV1.proxyIface,
+              swapFunction,
+              'totalAmountOut',
+            )
+          : undefined,
     };
   }
 

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

@@ -1142,9 +1142,9 @@ export class BalancerV2
             sender = recipient = augustusV6
         else (so generic swaps)
           if sell
-            if swap.destToken = priceRoute.destToken <> ETH (need withdraw for eth currently, need fix in future) 
+            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 
+              else
                   sender = recipient = executor
               # note: we pass sender=null then the address of the executor is inferred contract side
           else (so buy)
@@ -1585,6 +1585,7 @@ export class BalancerV2
       exchangeData,
       specialDexFlag,
       targetExchange: this.vaultAddress,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/bancor/bancor.ts

@@ -13,6 +13,7 @@ import BancorABI from '../../abi/Bancor.json';
 import { IDexHelper } from '../../dex-helper';
 import { BancorData, BancorFunctions, BancorParam } from './types';
 import { BANCOR_NETWORK, BancorRegistry } from './config';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class Bancor
   extends SimpleExchange
@@ -115,6 +116,13 @@ export class Bancor
       dexFuncHasRecipient: false,
       exchangeData: swapData,
       targetExchange: data.bancorNetwork || BANCOR_NETWORK[this.network],
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.exchangeRouterInterface,
+              swapMethod,
+            )
+          : undefined,
     };
   }
 }

package/src/dex/camelot/camelot.ts

@@ -867,6 +867,7 @@ export class Camelot
       transferSrcTokenBeforeSwap: data.isFeeTokenInRoute
         ? undefined
         : data.pools[0].address,
+      returnAmountPos: undefined,
     };
   }
 }

package/src/dex/compound/compound.ts

@@ -101,6 +101,7 @@ export class Compound
       dexFuncHasRecipient: false,
       exchangeData: swapData,
       targetExchange: cToken,
+      returnAmountPos: undefined,
     };
   }
 }

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

@@ -1075,6 +1075,7 @@ export class CurveV1
       sendEthButSupportsInsertFromAmount: true,
       dexFuncHasRecipient: false,
       targetExchange: exchange,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/curve-v1-factory/curve-v1-factory.ts

@@ -1176,6 +1176,7 @@ export class CurveV1Factory
       sendEthButSupportsInsertFromAmount: true,
       dexFuncHasRecipient: false,
       targetExchange: exchange,
+      returnAmountPos: undefined,
     };
   }
 

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

@@ -434,6 +434,7 @@ export class CurveV2
       dexFuncHasRecipient: false,
       exchangeData: swapData,
       targetExchange: exchange,
+      returnAmountPos: undefined,
     };
   }
 }

package/src/dex/dexalot/dexalot.ts

@@ -1021,6 +1021,7 @@ export class Dexalot extends SimpleExchange implements IDex<DexalotData> {
       needWrapNative: this.needWrapNative,
       dexFuncHasRecipient: false,
       targetExchange: this.mainnetRFQAddress,
+      returnAmountPos: undefined,
     };
   }
 

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

@@ -13,6 +13,7 @@ import { NumberAsString } from '@paraswap/core';
 import { IDexHelper } from '../../dex-helper';
 import { DodoV1Data, DodoV1Functions, DodoV1Param } from './types';
 import { DODOAproveAddress, DODOV2ProxyAddress } from './config';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class DodoV1
   extends SimpleExchange
@@ -118,6 +119,14 @@ export class DodoV1
       exchangeData: swapData,
       targetExchange: DODOV2ProxyAddress[this.network],
       spender: DODOAproveAddress[this.network],
+      returnAmountPos:
+        _side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.dodoV2Proxy,
+              swapFunction,
+              'returnAmount',
+            )
+          : undefined,
     };
   }
 }

package/src/dex/dodo-v2.ts

@@ -13,6 +13,7 @@ import { NumberAsString } from '@paraswap/core';
 import { isETHAddress } from '../utils';
 import Web3 from 'web3';
 import { IDexHelper } from '../dex-helper';
+import { extractReturnAmountPosition } from '../executor/utils';
 
 const DODOAproveAddress: { [network: number]: Address } = {
   [Network.MAINNET]: '0xCB859eA579b28e02B87A1FDE08d087ab9dbE5149',
@@ -252,6 +253,14 @@ export class DodoV2
       exchangeData: swapData,
       targetExchange: data.dodoProxy,
       spender: maybeSpender,
+      returnAmountPos:
+        _side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.exchangeRouterInterface,
+              swapFunction,
+              'returnAmount',
+            )
+          : undefined,
     };
   }
 }

package/src/dex/etherfi.ts

@@ -15,6 +15,7 @@ import { IDexHelper } from '../dex-helper';
 import { isETHAddress } from '../utils';
 import { assert } from 'ts-essentials';
 import { WethFunctions } from './weth/types';
+import { extractReturnAmountPosition } from '../executor/utils';
 
 type EtherFiData = void;
 
@@ -217,6 +218,7 @@ export class EtherFi
             srcAmount,
           ])
         : undefined,
+      returnAmountPos: extractReturnAmountPosition(Interface, swapFunction)
     };
   }
 

package/src/dex/generic-rfq/generic-rfq.ts

@@ -302,6 +302,7 @@ export class GenericRFQ extends ParaSwapLimitOrders {
       specialDexFlag: SpecialDex.SWAP_ON_AUGUSTUS_RFQ,
       targetExchange: this.augustusRFQAddress,
       specialDexSupportsInsertFromAmount: true,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/gmx/gmx.ts

@@ -22,6 +22,7 @@ import { SimpleExchange } from '../simple-exchange';
 import { GMXConfig, Adapters } from './config';
 import { Vault } from './vault';
 import ERC20ABI from '../../abi/erc20.json';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 const GMXGasCost = 300 * 1000;
 
@@ -231,6 +232,13 @@ export class GMX extends SimpleExchange implements IDex<GMXData> {
       swappedAmountNotPresentInExchangeData: true,
       exchangeData,
       targetExchange: this.params.vault,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              Vault.interface,
+              'swap',
+            )
+          : undefined,
     };
   }
 

package/src/dex/hashflow/hashflow.ts

@@ -1039,6 +1039,7 @@ export class Hashflow extends SimpleExchange implements IDex<HashflowData> {
       dexFuncHasRecipient: true,
       exchangeData,
       targetExchange: this.routerAddress,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/jarvis-v6/jarvis-v6.ts

@@ -483,6 +483,7 @@ export class JarvisV6
       dexFuncHasRecipient: true,
       exchangeData,
       targetExchange: data.poolAddress.toLowerCase(),
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/jarvis.ts

@@ -12,6 +12,7 @@ import { SimpleExchange } from './simple-exchange';
 import JarvisABI from '../abi/Jarvis.json';
 import Web3 from 'web3';
 import { IDexHelper } from '../dex-helper';
+import { extractReturnAmountPosition } from '../executor/utils';
 
 const THIRTY_MINUTES = 60 * 30;
 
@@ -197,6 +198,8 @@ export class Jarvis
     const swapFunction = data.method;
     const timestamp = (Date.now() / 1000 + THIRTY_MINUTES).toFixed(0);
     let swapFunctionParams: JarvisParam;
+    let outputName: string;
+
     switch (swapFunction) {
       case JarvisFunctions.mint:
         swapFunctionParams = [
@@ -207,6 +210,7 @@ export class Jarvis
           timestamp,
           recipient,
         ];
+        outputName = 'syntheticTokensMinted';
         break;
       case JarvisFunctions.redeem:
         swapFunctionParams = [
@@ -217,6 +221,7 @@ export class Jarvis
           timestamp,
           recipient,
         ];
+        outputName = 'collateralRedeemed';
         break;
       case JarvisFunctions.exchange:
         swapFunctionParams = [
@@ -229,6 +234,7 @@ export class Jarvis
           timestamp,
           recipient,
         ];
+        outputName = 'destNumTokensMinted';
         break;
       default:
         throw new Error(`Unknown function ${swapFunction}`);
@@ -243,6 +249,14 @@ export class Jarvis
       dexFuncHasRecipient: true,
       exchangeData: swapData,
       targetExchange: data.pools[0],
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.poolInterface,
+              swapFunction,
+              outputName,
+            )
+          : undefined,
     };
   }
 }

package/src/dex/kyberdmm/kyberdmm.ts

@@ -38,6 +38,7 @@ import kyberDmmFactoryABI from '../../abi/kyberdmm/kyber-dmm-factory.abi.json';
 import kyberDmmPoolABI from '../../abi/kyberdmm/kyber-dmm-pool.abi.json';
 import KyberDmmExchangeRouterABI from '../../abi/kyberdmm/kyber-dmm-exchange-router.abi.json';
 import { getBigIntPow, getDexKeysWithNetwork } from '../../utils';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 const MAX_TRACKED_PAIR_POOLS = 3;
 
@@ -262,6 +263,14 @@ export class KyberDmm
       dexFuncHasRecipient: true,
       exchangeData,
       targetExchange: data.router,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.exchangeRouterInterface,
+              KyberDMMFunctions.swapExactTokensForTokens,
+              'amounts',
+            )
+          : undefined,
     };
   }
 

package/src/dex/lido/lido.ts

@@ -14,6 +14,7 @@ import { LidoData, stETHFunctions } from './types';
 import { stETH } from './config';
 import { WethFunctions } from '../weth/types';
 import ERC20ABI from '../../abi/erc20.json';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class Lido implements IDexTxBuilder<LidoData, any> {
   static dexKeys = ['lido'];
@@ -97,6 +98,13 @@ export class Lido implements IDexTxBuilder<LidoData, any> {
             srcAmount,
           ])
         : undefined,
+      returnAmountPos:
+        _side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.stETHInterface,
+              stETHFunctions.submit,
+            )
+          : undefined,
     };
   }
 }

package/src/dex/maker-psm/maker-psm.ts

@@ -541,6 +541,7 @@ export class MakerPsm extends SimpleExchange implements IDex<MakerPsmData> {
       targetExchange: data.psmAddress,
       specialDexFlag,
       spender: isGemSell ? data.gemJoinAddress : data.psmAddress,
+      returnAmountPos: undefined,
     };
   }
   // Returns list of top pools based on liquidity. Max

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

@@ -41,6 +41,7 @@ import {
 import { SUBGRAPH_TIMEOUT } from '../../constants';
 import RouterABI from '../../abi/maverick-v1/router.json';
 import { NumberAsString } from '@paraswap/core';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 const MAX_POOL_CNT = 1000;
 
@@ -402,6 +403,14 @@ export class MaverickV1
       dexFuncHasRecipient: true,
       exchangeData,
       targetExchange: this.config.routerAddress,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.routerIface,
+              MaverickV1Functions.exactInputSingle,
+              'amountOut',
+            )
+          : undefined,
     };
   }
 

package/src/dex/nerve/nerve.ts

@@ -33,6 +33,7 @@ import { NerveConfig, Adapters, NERVE_GAS_COST } from './config';
 import { NerveEventPool } from './nerve-pool';
 import _ from 'lodash';
 import { bigIntify } from './utils';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class Nerve
   extends SimpleExchange
@@ -382,6 +383,13 @@ export class Nerve
       dexFuncHasRecipient: false,
       exchangeData: swapData,
       targetExchange: exchange,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.nervePoolIface,
+              NervePoolFunctions.swap,
+            )
+          : undefined,
     };
   }
 

package/src/dex/onebit/onebit.ts

@@ -13,6 +13,7 @@ import { SimpleExchange } from '../simple-exchange';
 import OnebitABI from '../../abi/Onebit.json';
 import { IDexHelper } from '../../dex-helper';
 import { OnebitData, OnebitFunctions, OnebitParam } from './types';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class Onebit
   extends SimpleExchange
@@ -100,6 +101,13 @@ export class Onebit
       dexFuncHasRecipient: true,
       exchangeData: swapData,
       targetExchange: data.router,
+      returnAmountPos:
+        _side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.exchangeRouterInterface,
+              swapFunction,
+            )
+          : undefined,
     };
   }
 }

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

@@ -61,6 +61,7 @@ import {
   OnPoolCreatedCallback,
   PancakeswapV3Factory,
 } from './pancakeswap-v3-factory';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 type PoolPairsInfo = {
   token0: Address;
@@ -894,6 +895,14 @@ export class PancakeswapV3
       dexFuncHasRecipient: true,
       exchangeData,
       targetExchange: this.config.router,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              this.routerIface,
+              swapFunction,
+              'amountOut',
+            )
+          : undefined,
     };
   }
 

package/src/dex/paraswap-limit-orders/paraswap-limit-orders.ts

@@ -398,6 +398,7 @@ export class ParaSwapLimitOrders
       dexFuncHasRecipient: true,
       exchangeData: swapData,
       targetExchange: this.augustusRFQAddress,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/platypus/platypus.ts

@@ -38,6 +38,7 @@ import PoolABI from '../../abi/platypus/pool.json';
 import AvaxPoolABI from '../../abi/platypus/avax-pool.json';
 import AssetABI from '../../abi/platypus/asset.json';
 import OracleABI from '../../abi/platypus/oracle.json';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class Platypus extends SimpleExchange implements IDex<PlatypusData> {
   static readonly erc20Interface = new Interface(ERC20ABI);
@@ -497,22 +498,34 @@ export class Platypus extends SimpleExchange implements IDex<PlatypusData> {
     data: PlatypusData,
     side: SwapSide,
   ): DexExchangeParam {
+    const iface = isETHAddress(srcToken)
+      ? Platypus.avaxPoolInterface
+      : isETHAddress(destToken)
+      ? Platypus.avaxPoolInterface
+      : Platypus.poolInterface;
+
+    const swapFunction = isETHAddress(srcToken)
+      ? 'swapFromETH'
+      : isETHAddress(destToken)
+      ? 'swapToETH'
+      : 'swap';
+
     const swapData = isETHAddress(srcToken)
-      ? Platypus.avaxPoolInterface.encodeFunctionData('swapFromETH', [
+      ? iface.encodeFunctionData(swapFunction, [
           destToken,
           1,
           recipient,
           getLocalDeadlineAsFriendlyPlaceholder(),
         ])
       : isETHAddress(destToken)
-      ? Platypus.avaxPoolInterface.encodeFunctionData('swapToETH', [
+      ? iface.encodeFunctionData(swapFunction, [
           srcToken,
           srcAmount,
           1,
           recipient,
           getLocalDeadlineAsFriendlyPlaceholder(),
         ])
-      : Platypus.poolInterface.encodeFunctionData('swap', [
+      : iface.encodeFunctionData(swapFunction, [
           srcToken,
           destToken,
           srcAmount,
@@ -526,6 +539,10 @@ export class Platypus extends SimpleExchange implements IDex<PlatypusData> {
       dexFuncHasRecipient: true,
       exchangeData: swapData,
       targetExchange: data.pool,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(iface, swapFunction, 'actualToAmount')
+          : undefined,
     };
   }
 

package/src/dex/polygon-migrator/polygon-migrator.ts

@@ -181,6 +181,7 @@ export class PolygonMigrator
       dexFuncHasRecipient: false,
       exchangeData: swapData,
       targetExchange: this.migratorAddress,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/quick-perps/quick-perps.ts

@@ -24,6 +24,7 @@ import { QuickPerpsConfig, Adapters } from './config';
 import { Vault } from './vault';
 import ERC20ABI from '../../abi/erc20.json';
 import { solidityPack } from 'ethers/lib/utils';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 const QuickPerpsGasCost = 300 * 1000;
 
@@ -228,7 +229,9 @@ export class QuickPerps extends SimpleExchange implements IDex<QuickPerpsData> {
     data: QuickPerpsData,
     side: SwapSide,
   ): DexExchangeParam {
-    const swapData = Vault.interface.encodeFunctionData('swap', [
+    const iface = Vault.interface;
+    const functionName = 'swap';
+    const swapData = iface.encodeFunctionData(functionName, [
       srcToken,
       destToken,
       recipient,
@@ -241,6 +244,13 @@ export class QuickPerps extends SimpleExchange implements IDex<QuickPerpsData> {
       targetExchange: this.params.vault,
       swappedAmountNotPresentInExchangeData: true,
       transferSrcTokenBeforeSwap: this.params.vault,
+      returnAmountPos:
+        side === SwapSide.SELL
+          ? extractReturnAmountPosition(
+              iface,
+              functionName,
+            )
+          : undefined,
     };
   }
 

package/src/dex/smoothy/smoothy.ts

@@ -104,6 +104,7 @@ export class Smoothy
       dexFuncHasRecipient: false,
       exchangeData: swapData,
       targetExchange: exchange,
+      returnAmountPos: undefined,
     };
   }
 }

package/src/dex/solidly/solidly.ts

@@ -683,6 +683,7 @@ export class Solidly extends UniswapV2 {
       transferSrcTokenBeforeSwap: data.isFeeTokenInRoute
         ? undefined
         : data.pools[0].address,
+      returnAmountPos: undefined,
     };
   }
 }

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

@@ -47,7 +47,6 @@ import { assert, DeepReadonly } from 'ts-essentials';
 import { uniswapV3Math } from './contract-math/uniswap-v3-math';
 import { Contract } from 'web3-eth-contract';
 import { AbiItem } from 'web3-utils';
-import { OptimalSwapExchange } from '@paraswap/core';
 import { TickMath } from './contract-math/TickMath';
 import { OnPoolCreatedCallback, SolidlyV3Factory } from './solidly-v3-factory';
 
@@ -725,6 +724,7 @@ export class SolidlyV3
       dexFuncHasRecipient: true,
       exchangeData: swapData,
       targetExchange: data.poolAddress,
+      returnAmountPos: undefined,
     };
   }
 

package/src/dex/spark/spark.ts

@@ -24,6 +24,7 @@ import { Interface } from 'ethers/lib/utils';
 import { SparkSDaiEventPool } from './spark-sdai-pool';
 import { BI_POWS } from '../../bigint-constants';
 import { SDAI_DEPOSIT_GAS_COST, SDAI_REDEEM_GAS_COST } from './constants';
+import { extractReturnAmountPosition } from '../../executor/utils';
 
 export class Spark
   extends SimpleExchange
@@ -241,6 +242,15 @@ export class Spark
       dexFuncHasRecipient: true,
       exchangeData: swapData,
       targetExchange: exchange,
+      returnAmountPos: isSell
+        ? extractReturnAmountPosition(
+            this.sdaiInterface,
+            this.isDai(srcToken)
+              ? SparkSDaiFunctions.deposit
+              : SparkSDaiFunctions.redeem,
+            this.isDai(srcToken) ? 'shares' : 'assets',
+          )
+        : undefined,
     };
   }