@paraswap/dex-lib 2.42.20 → 2.42.21

package/src/dex/algebra/algebra.ts

@@ -4,21 +4,34 @@ import { AbiItem } from 'web3-utils';
 import { pack } from '@ethersproject/solidity';
 import _ from 'lodash';
 import {
-  Token,
-  Address,
   ExchangePrices,
   PoolPrices,
   AdapterExchangeParam,
   SimpleExchangeParam,
-  PoolLiquidity,
   Logger,
+  TransferFeeParams,
+  Address,
+  PoolLiquidity,
+  Token,
 } from '../../types';
 import { SwapSide, Network, CACHE_PREFIX } from '../../constants';
 import * as CALLDATA_GAS_COST from '../../calldata-gas-cost';
-import { getBigIntPow, getDexKeysWithNetwork, interpolate } from '../../utils';
+import {
+  _require,
+  getBigIntPow,
+  getDexKeysWithNetwork,
+  interpolate,
+  isDestTokenTransferFeeToBeExchanged,
+  isSrcTokenTransferFeeToBeExchanged,
+} from '../../utils';
 import { IDex } from '../../dex/idex';
 import { IDexHelper } from '../../dex-helper/idex-helper';
-import { AlgebraData, DexParams, IAlgebraPoolState } from './types';
+import {
+  AlgebraData,
+  AlgebraFunctions,
+  DexParams,
+  IAlgebraPoolState,
+} from './types';
 import {
   SimpleExchange,
   getLocalDeadlineAsFriendlyPlaceholder,
@@ -26,19 +39,16 @@ import {
 import { AlgebraConfig, Adapters } from './config';
 import { Contract } from 'web3-eth-contract';
 import { Interface } from 'ethers/lib/utils';
-import UniswapV3RouterABI from '../../abi/uniswap-v3/UniswapV3Router.abi.json';
+import SwapRouter from '../../abi/algebra/SwapRouter.json';
 import AlgebraQuoterABI from '../../abi/algebra/AlgebraQuoter.abi.json';
 import UniswapV3MultiABI from '../../abi/uniswap-v3/UniswapMulti.abi.json';
 import AlgebraStateMulticallABI from '../../abi/algebra/AlgebraStateMulticall.abi.json';
-import {
-  OutputResult,
-  UniswapV3Functions,
-  UniswapV3SimpleSwapParams,
-} from '../uniswap-v3/types';
+import { OutputResult } from '../uniswap-v3/types';
 import { AlgebraMath } from './lib/AlgebraMath';
 import { AlgebraEventPoolV1_1 } from './algebra-pool-v1_1';
 import { AlgebraEventPoolV1_9 } from './algebra-pool-v1_9';
 import { AlgebraFactory, OnPoolCreatedCallback } from './algebra-factory';
+import { applyTransferFee } from '../../lib/token-transfer-fee';
 
 type PoolPairsInfo = {
   token0: Address;
@@ -61,7 +71,7 @@ type IAlgebraEventPool = AlgebraEventPoolV1_1 | AlgebraEventPoolV1_9;
 
 export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
   private readonly factory: AlgebraFactory;
-  readonly isFeeOnTransferSupported: boolean = false;
+  readonly isFeeOnTransferSupported: boolean = true;
   protected eventPools: Record<string, IAlgebraEventPool | null> = {};
 
   private newlyCreatedPoolKeys: Set<string> = new Set();
@@ -85,12 +95,15 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
     | typeof AlgebraEventPoolV1_1
     | typeof AlgebraEventPoolV1_9;
 
+  readonly SRC_TOKEN_DEX_TRANSFERS = 1;
+  readonly DEST_TOKEN_DEX_TRANSFERS = 1;
+
   constructor(
     protected network: Network,
     dexKey: string,
     protected dexHelper: IDexHelper,
     protected adapters = Adapters[network] || {},
-    readonly routerIface = new Interface(UniswapV3RouterABI), // same abi as uniswapV3
+    readonly routerIface = new Interface(SwapRouter),
     readonly quoterIface = new Interface(AlgebraQuoterABI),
     readonly config = AlgebraConfig[dexKey][network],
   ) {
@@ -409,6 +422,12 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
     amounts: bigint[],
     side: SwapSide,
     pool: IAlgebraEventPool,
+    transferFees: TransferFeeParams = {
+      srcFee: 0,
+      destFee: 0,
+      srcDexFee: 0,
+      destDexFee: 0,
+    },
   ): Promise<ExchangePrices<AlgebraData> | null> {
     if (!this.config.forceRPC) {
       this.logger.warn(
@@ -416,6 +435,11 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
       );
     }
 
+    const _isSrcTokenTransferFeeToBeExchanged =
+      isSrcTokenTransferFeeToBeExchanged(transferFees);
+    const _isDestTokenTransferFeeToBeExchanged =
+      isDestTokenTransferFeeToBeExchanged(transferFees);
+
     const unitVolume = getBigIntPow(
       (side === SwapSide.SELL ? from : to).decimals,
     );
@@ -430,7 +454,16 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
       ),
     );
 
-    const calldata = _amounts.map(_amount => ({
+    const _amountsWithFee = _isSrcTokenTransferFeeToBeExchanged
+      ? applyTransferFee(
+          _amounts,
+          side,
+          transferFees.srcDexFee,
+          this.SRC_TOKEN_DEX_TRANSFERS,
+        )
+      : _amounts;
+
+    const calldata = _amountsWithFee.map(_amount => ({
       target: this.config.quoter,
       gasLimit: ALGEBRA_QUOTE_GASLIMIT,
       callData:
@@ -471,12 +504,22 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
       : Math.round(totalGasCost / totalSuccessFullSwaps);
 
     let i = 0;
-    const _rates = _amounts.map(() => decode(i++));
-    const unit: bigint = _rates[0];
+    const _rates = _amountsWithFee.map(() => decode(i++));
+
+    const _ratesWithFee = _isDestTokenTransferFeeToBeExchanged
+      ? applyTransferFee(
+          _rates,
+          side,
+          transferFees.destDexFee,
+          this.DEST_TOKEN_DEX_TRANSFERS,
+        )
+      : _rates;
+
+    const unit: bigint = _ratesWithFee[0];
 
     const prices = interpolate(
-      _amounts.slice(1),
-      _rates.slice(1),
+      _amountsWithFee.slice(1),
+      _ratesWithFee.slice(1),
       amounts,
       side,
     );
@@ -486,6 +529,7 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
         prices,
         unit,
         data: {
+          feeOnTransfer: _isSrcTokenTransferFeeToBeExchanged,
           path: [
             {
               tokenIn: from.address,
@@ -508,6 +552,12 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
     side: SwapSide,
     blockNumber: number,
     limitPools?: string[],
+    transferFees: TransferFeeParams = {
+      srcFee: 0,
+      destFee: 0,
+      srcDexFee: 0,
+      destDexFee: 0,
+    },
   ): Promise<null | ExchangePrices<AlgebraData>> {
     try {
       const _srcToken = this.dexHelper.config.wrapETH(srcToken);
@@ -518,6 +568,11 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
         _destToken,
       );
 
+      const _isSrcTokenTransferFeeToBeExchanged =
+        isSrcTokenTransferFeeToBeExchanged(transferFees);
+      const _isDestTokenTransferFeeToBeExchanged =
+        isDestTokenTransferFeeToBeExchanged(transferFees);
+
       if (_srcAddress === _destAddress) return null;
 
       if (
@@ -526,9 +581,15 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
         return null;
 
       const pool = await this.getPool(_srcAddress, _destAddress, blockNumber);
-
       if (!pool) return null;
 
+      if (_isSrcTokenTransferFeeToBeExchanged && side == SwapSide.BUY) {
+        this.logger.error(
+          `pool: ${pool.poolAddress} doesn't support buy for tax srcToken ${srcToken.address}`,
+        );
+        return null;
+      }
+
       if (this.config.forceRPC) {
         const rpcPrice = await this.getPricingFromRpc(
           _srcToken,
@@ -536,6 +597,7 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
           amounts,
           side,
           pool,
+          transferFees,
         );
 
         return rpcPrice;
@@ -570,6 +632,7 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
             amounts,
             side,
             pool,
+            transferFees,
           );
 
           return rpcPrice;
@@ -601,16 +664,26 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
       const balanceDestToken =
         _destAddress === pool.token0 ? state.balance0 : state.balance1;
 
+      const [unitAmountWithFee, ...amountsWithFee] =
+        _isSrcTokenTransferFeeToBeExchanged
+          ? applyTransferFee(
+              [unitAmount, ..._amounts],
+              side,
+              transferFees.srcDexFee,
+              this.SRC_TOKEN_DEX_TRANSFERS,
+            )
+          : [unitAmount, ..._amounts];
+
       const unitResult = this._getOutputs(
         state,
-        [unitAmount],
+        [unitAmountWithFee],
         zeroForOne,
         side,
         balanceDestToken,
       );
       const pricesResult = this._getOutputs(
         state,
-        _amounts,
+        amountsWithFee,
         zeroForOne,
         side,
         balanceDestToken,
@@ -621,10 +694,20 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
         return null;
       }
 
-      const prices = [0n, ...pricesResult.outputs];
+      const [unitResultWithFee, ...pricesResultWithFee] =
+        _isDestTokenTransferFeeToBeExchanged
+          ? applyTransferFee(
+              [unitResult.outputs[0], ...pricesResult.outputs],
+              side,
+              transferFees.destDexFee,
+              this.DEST_TOKEN_DEX_TRANSFERS,
+            )
+          : [unitResult.outputs[0], ...pricesResult.outputs];
+
+      const prices = [0n, ...pricesResultWithFee];
       const gasCost = [
         0,
-        ...pricesResult.outputs.map((p, index) => {
+        ...pricesResultWithFee.map((p, index) => {
           if (p == 0n) {
             return 0;
           } else {
@@ -639,9 +722,10 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
 
       return [
         {
-          unit: unitResult.outputs[0],
+          unit: unitResultWithFee,
           prices,
           data: {
+            feeOnTransfer: _isSrcTokenTransferFeeToBeExchanged,
             path: [
               {
                 tokenIn: _srcAddress,
@@ -674,19 +758,20 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
     data: AlgebraData,
     side: SwapSide,
   ): AdapterExchangeParam {
-    const { path: rawPath } = data;
-    const path = this._encodePath(rawPath, side);
+    let path = this._encodePath(data.path, side);
 
     const payload = this.abiCoder.encodeParameter(
       {
         ParentStruct: {
           path: 'bytes',
           deadline: 'uint256',
+          feeOnTransfer: 'bool',
         },
       },
       {
         path,
         deadline: getLocalDeadlineAsFriendlyPlaceholder(), // FIXME: more gas efficient to pass block.timestamp in adapter
+        feeOnTransfer: data.feeOnTransfer,
       },
     );
 
@@ -730,30 +815,52 @@ export class Algebra extends SimpleExchange implements IDex<AlgebraData> {
     data: AlgebraData,
     side: SwapSide,
   ): Promise<SimpleExchangeParam> {
-    const swapFunction =
-      side === SwapSide.SELL
-        ? UniswapV3Functions.exactInput
-        : UniswapV3Functions.exactOutput;
-
-    const path = this._encodePath(data.path, side);
-    const swapFunctionParams: UniswapV3SimpleSwapParams =
-      side === SwapSide.SELL
-        ? {
-            recipient: this.augustusAddress,
-            deadline: getLocalDeadlineAsFriendlyPlaceholder(),
-            amountIn: srcAmount,
-            amountOutMinimum: destAmount,
-            path,
-          }
-        : {
-            recipient: this.augustusAddress,
-            deadline: getLocalDeadlineAsFriendlyPlaceholder(),
-            amountOut: destAmount,
-            amountInMaximum: srcAmount,
-            path,
-          };
+    let swapFunction;
+    let swapParams;
+
+    if (data.feeOnTransfer) {
+      _require(
+        data.path.length !== 1,
+        `LOGIC ERROR: multihop is not supported for feeOnTransfer token, passed: ${data.path
+          .map(p => `${p?.tokenIn}->${p?.tokenOut}`)
+          .join(' ')}`,
+      );
+      swapFunction = AlgebraFunctions.exactInputWithFeeToken;
+      swapParams = {
+        limitSqrtPrice: '0',
+        recipient: this.augustusAddress,
+        deadline: getLocalDeadlineAsFriendlyPlaceholder(),
+        amountIn: srcAmount,
+        amountOutMinimum: destAmount,
+        tokenIn: data.path[0].tokenIn,
+        tokenOut: data.path[0].tokenOut,
+      };
+    } else {
+      swapFunction =
+        side === SwapSide.SELL
+          ? AlgebraFunctions.exactInput
+          : AlgebraFunctions.exactOutput;
+      const path = this._encodePath(data.path, side);
+      swapParams =
+        side === SwapSide.SELL
+          ? {
+              recipient: this.augustusAddress,
+              deadline: getLocalDeadlineAsFriendlyPlaceholder(),
+              amountIn: srcAmount,
+              amountOutMinimum: destAmount,
+              path,
+            }
+          : {
+              recipient: this.augustusAddress,
+              deadline: getLocalDeadlineAsFriendlyPlaceholder(),
+              amountOut: destAmount,
+              amountInMaximum: srcAmount,
+              path,
+            };
+    }
+
     const swapData = this.routerIface.encodeFunctionData(swapFunction, [
-      swapFunctionParams,
+      swapParams,
     ]);
 
     return this.buildSimpleParamWithoutWETHConversion(

package/src/dex/algebra/config.ts

@@ -98,7 +98,7 @@ export const Adapters: Record<number, AdapterMappings> = {
     [SwapSide.BUY]: [{ name: 'PolygonZkEvmBuyAdapter', index: 1 }],
   },
   [Network.ARBITRUM]: {
-    [SwapSide.SELL]: [{ name: 'ArbitrumAdapter01', index: 3 }],
+    [SwapSide.SELL]: [{ name: 'ArbitrumAdapter02', index: 7 }],
     [SwapSide.BUY]: [{ name: 'ArbitrumBuyAdapter', index: 2 }],
   },
   [Network.OPTIMISM]: {

package/src/dex/algebra/types.ts

@@ -58,9 +58,21 @@ export type AlgebraData = {
     tokenIn: Address;
     tokenOut: Address;
   }[];
+  feeOnTransfer: boolean;
   isApproved?: boolean;
 };
 
+export type AlgebraDataWithFee = {
+  tokenIn: Address;
+  tokenOut: Address;
+};
+
+export enum AlgebraFunctions {
+  exactInput = 'exactInput',
+  exactOutput = 'exactOutput',
+  exactInputWithFeeToken = 'exactInputSingleSupportingFeeOnTransferTokens',
+}
+
 export type DexParams = {
   router: Address;
   quoter: Address;

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

@@ -30,9 +30,7 @@ export const SWAAP_429_TTL_S = 60 * 60 * 1; // 1 hour
 
 export const SWAAP_POOL_RESTRICT_TTL_S = 60 * 30; // 30 minutes
 
-export const STABLE_SWAP_GAS_COST_ESTIMATION = 130_000;
-
-export const VOLATILE_SWAP_GAS_COST_ESTIMATION = 150_000;
+export const GAS_COST_ESTIMATION = 170_000;
 
 export const BATCH_SWAP_SELECTOR = '0x945bcec9';
 

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

@@ -45,8 +45,7 @@ import {
   SWAAP_RFQ_QUOTE_ENDPOINT,
   SWAAP_RFQ_API_PRICES_POLLING_INTERVAL_MS,
   SWAAP_RFQ_PRICES_CACHES_TTL_S,
-  STABLE_SWAP_GAS_COST_ESTIMATION,
-  VOLATILE_SWAP_GAS_COST_ESTIMATION,
+  GAS_COST_ESTIMATION,
   BATCH_SWAP_SELECTOR,
   CALLER_SLOT,
   SWAAP_403_TTL_S,
@@ -63,12 +62,7 @@ import {
   SWAAP_BANNED_CODE,
   SWAAP_NOTIFY_ENDPOINT,
 } from './constants';
-import {
-  getPoolIdentifier,
-  normalizeTokenAddress,
-  getPairName,
-  isStablePair,
-} from './utils';
+import { getPoolIdentifier, normalizeTokenAddress, getPairName } from './utils';
 import { Method } from '../../dex-helper/irequest-wrapper';
 import {
   SlippageCheckError,
@@ -410,16 +404,8 @@ export class SwaapV2 extends SimpleExchange implements IDex<SwaapV2Data> {
           return null;
         }
 
-        const gasCost = isStablePair(
-          this.network,
-          normalizedSrcToken.address,
-          normalizedDestToken.address,
-        )
-          ? STABLE_SWAP_GAS_COST_ESTIMATION
-          : VOLATILE_SWAP_GAS_COST_ESTIMATION;
-
         return {
-          gasCost: gasCost,
+          gasCost: GAS_COST_ESTIMATION,
           exchange: this.dexKey,
           data: {},
           prices,

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

@@ -1,7 +1,5 @@
-import { Address, Token } from '../../types';
+import { Address } from '../../types';
 import { ETHER_ADDRESS, NULL_ADDRESS } from '../../constants';
-import { Network } from '../../constants';
-import { STABLE_COINS } from './stable-coins';
 
 export const getIdentifierPrefix = (
   dexKey: string,
@@ -29,18 +27,3 @@ export const normalizeTokenAddress = (address: string): string => {
     ? NULL_ADDRESS
     : address.toLowerCase();
 };
-
-export const isStablePair = (
-  network: Network,
-  normalizedSrcTokenAddress: string,
-  normalizedDestTokenAddress: string,
-): boolean => {
-  const networkStableCoins = STABLE_COINS[network];
-  if (networkStableCoins === undefined) {
-    return false;
-  }
-  return (
-    networkStableCoins[normalizedSrcTokenAddress] === true &&
-    networkStableCoins[normalizedDestTokenAddress] === true
-  );
-};

package/tests/constants-e2e.ts

@@ -853,6 +853,10 @@ export const Tokens: {
       address: '0x3d9907f9a368ad0a51be60f7da3b97cf940982d8',
       decimals: 18,
     },
+    RDPX: {
+      address: '0x32eb7902d4134bf98a28b963d26de779af92a212',
+      decimals: 18,
+    },
   },
   [Network.OPTIMISM]: {
     DAI: {
@@ -1145,12 +1149,13 @@ export const Holders: {
     AMPL: '0xfcaA5ea7F8eb0631BcA72C345025C0A5a6D93f0E',
   },
   [Network.ARBITRUM]: {
+    RDPX: '0x2fa6f21ecfe274f594f470c376f5bdd061e08a37',
     ARB: '0xb65edba80a3d81903ecd499c8eb9cf0e19096bd0',
     ETH: '0xF977814e90dA44bFA03b6295A0616a897441aceC',
     DAI: '0x07d7f291e731a41d3f0ea4f1ae5b6d920ffb3fe0',
     WETH: '0xc31e54c7a869b9fcbecc14363cf510d1c41fa443',
     USDCe: '0x62383739d68dd0f844103db8dfb05a7eded5bbe6',
-    USDC: '0xa843392198862f98d17e3aa1421b08f2c2020cff',
+    USDC: '0x489ee077994b6658eafa855c308275ead8097c4a',
     OHM: '0xebce5f29ff5ca9aa330ebdf7ec6b5f474bff271e',
     USDT: '0x5ff47d4ab75bcaff6807c81f1367abb53439883c',
     POPS: '0x4b78b52e7de4d8b7d367297cb8a87c1875a9d591',

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

@@ -1,25 +0,0 @@
-import { Network } from '../../constants';
-
-// addresses must be consistant with utils.normalizeTokenAddress
-export const STABLE_COINS: {
-  [network: number]: { [symbol: string]: boolean };
-} = {
-  [Network.MAINNET]: {
-    '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48': true, // USDT
-    '0xdac17f958d2ee523a2206206994597c13d831ec7': true, // USDC
-    '0x6b175474e89094c44da98b954eedeac495271d0f': true, // DAI
-    '0x853d955acef822db058eb8505911ed77f175b99e': true, // FRAX
-  },
-  [Network.POLYGON]: {
-    '0x3c499c542cef5e3811e1192ce70d8cc03d5c3359': true, // USDC
-    '0x2791bca1f2de4661ed88a30c99a7a9449aa84174': true, // USDC.e
-    '0xc2132d05d31c914a87c6611c10748aeb04b58e8f': true, // USDT
-    '0x8f3cf7ad23cd3cadbd9735aff958023239c6a063': true, // DAI
-  },
-  [Network.ARBITRUM]: {
-    '0xaf88d065e77c8cc2239327c5edb3a432268e5831': true, // USDC
-    '0xff970a61a04b1ca14834a43f5de4533ebddb5cc8': true, // USDC.e
-    '0xfd086bc7cd5c481dcc9c85ebe478a1c0b69fcbb9': true, // USDT
-    '0xda10009cbd5d07dd0cecc66161fc93d7c9000da1': true, // DAI
-  },
-};