@paraswap/dex-lib 3.0.6 → 3.2.5-return-amount-pos.4

package/src/dex/swell/swell.ts

@@ -14,18 +14,20 @@ import {
 } from '../../types';
 import { IDex } from '../idex';
 import SWETH_ABI from '../../abi/swETH.json';
-import { ETHER_ADDRESS, Network } from '../../constants';
+import RSWETH_ABI from '../../abi/rswETH.json';
+import { ETHER_ADDRESS, Network, NULL_ADDRESS } from '../../constants';
 import { IDexHelper } from '../../dex-helper';
 import { SimpleExchange } from '../simple-exchange';
 import { BI_POWS } from '../../bigint-constants';
 import { AsyncOrSync } from 'ts-essentials';
-import { getOnChainState } from './utils';
 import { SwethPool } from './sweth-pool';
 import { getDexKeysWithNetwork, isETHAddress } from '../../utils';
 import { WethFunctions } from '../weth/types';
 import * as CALLDATA_GAS_COST from '../../calldata-gas-cost';
 import _ from 'lodash';
 import { SwellConfig, Adapters } from './config';
+import { RswethPool } from './rsweth-pool';
+import { ethers } from 'ethers';
 
 export enum swETHFunctions {
   deposit = 'deposit',
@@ -40,10 +42,13 @@ export class Swell
 {
   static dexKeys = ['Swell'];
   swETHInterface: Interface;
+  rswETHInterface: Interface;
   needWrapNative = false;
   hasConstantPriceLargeAmounts: boolean = true;
   swETHAddress: string;
-  eventPool: SwethPool;
+  rswETHAddress: string;
+  swethPool: SwethPool;
+  rswethPool: RswethPool;
   logger: Logger;
 
   public static dexKeysWithNetwork: { key: string; networks: Network[] }[] =
@@ -60,32 +65,62 @@ export class Swell
 
     this.network = dexHelper.config.data.network;
     this.swETHInterface = new Interface(SWETH_ABI as JsonFragment[]);
+    this.rswETHInterface = new Interface(RSWETH_ABI as JsonFragment[]);
     this.swETHAddress = this.config.swETH.toLowerCase();
+    this.rswETHAddress = this.config.rswETH.toLowerCase();
     this.logger = dexHelper.getLogger(this.dexKey);
-    this.eventPool = new SwethPool(
+    this.swethPool = new SwethPool(
       this.dexKey,
       dexHelper,
       this.swETHAddress,
       this.swETHInterface,
       this.logger,
     );
+    this.rswethPool = new RswethPool(
+      this.dexKey,
+      dexHelper,
+      this.rswETHAddress,
+      this.rswETHInterface,
+      this.logger,
+    );
   }
 
   async initializePricing(blockNumber: number) {
-    const poolState = await getOnChainState(
-      this.dexHelper.multiContract,
-      this.swETHAddress,
-      this.swETHInterface,
-      blockNumber,
-    );
+    const data: { returnData: any[] } =
+      await this.dexHelper.multiContract.methods
+        .aggregate([
+          {
+            target: this.swETHAddress,
+            callData: this.swETHInterface.encodeFunctionData(
+              'swETHToETHRate',
+              [],
+            ),
+          },
+          {
+            target: this.rswETHAddress,
+            callData: this.rswETHInterface.encodeFunctionData(
+              'rswETHToETHRate',
+              [],
+            ),
+          },
+        ])
+        .call({}, blockNumber);
 
-    await this.eventPool.initialize(blockNumber, {
-      state: poolState,
-    });
-  }
+    const decodedData = data.returnData.map(d =>
+      ethers.utils.defaultAbiCoder.decode(['uint256'], d),
+    );
+    const [swETHToETHRateFixed, rswETHToETHRateFixed] = decodedData.map(d =>
+      BigInt(d[0].toString()),
+    );
 
-  getPoolIdentifierKey(): string {
-    return `${ETHER_ADDRESS}_${this.swETHAddress}`.toLowerCase();
+    await Promise.all([
+      this.swethPool.initialize(blockNumber, {
+        state: { swETHToETHRateFixed },
+      }),
+      this.rswethPool.initialize(blockNumber, {
+        state: { rswETHToETHRateFixed },
+      }),
+    ]);
   }
 
   isEligibleSwap(
@@ -103,7 +138,9 @@ export class Swell
     ).toLowerCase();
 
     return (
-      isETHAddress(srcTokenAddress) && destTokenAddress === this.swETHAddress
+      (isETHAddress(srcTokenAddress) || this.isWETH(srcTokenAddress)) &&
+      (destTokenAddress === this.swETHAddress ||
+        destTokenAddress === this.rswETHAddress)
     );
   }
 
@@ -113,7 +150,9 @@ export class Swell
     side: SwapSide,
   ) {
     if (!this.isEligibleSwap(srcToken, destToken, side)) {
-      throw new Error('Only eth/weth -> swETH swaps are supported');
+      throw new Error(
+        'Only eth/weth -> swETH or eth/weth -> rswETH swaps are supported',
+      );
     }
   }
 
@@ -123,9 +162,9 @@ export class Swell
     side: SwapSide,
     blockNumber: number,
   ): Promise<string[]> {
-    return this.isEligibleSwap(srcToken, destToken, side)
-      ? [this.getPoolIdentifierKey()]
-      : [];
+    if (!this.isEligibleSwap(srcToken, destToken, side)) return [];
+
+    return [`${ETHER_ADDRESS}_${destToken.address}`.toLowerCase()];
   }
 
   async getPricesVolume(
@@ -139,12 +178,18 @@ export class Swell
     isFirstSwap?: boolean | undefined,
   ): Promise<ExchangePrices<SwellData> | null> {
     if (!this.isEligibleSwap(srcToken, destToken, side)) return null;
-    if (this.eventPool.getState(blockNumber) === null) return null;
+
+    const pool =
+      destToken.address === this.swETHAddress
+        ? this.swethPool
+        : this.rswethPool;
+
+    if (!pool.getState(blockNumber)) return null;
 
     const unitIn = BI_POWS[18];
-    const unitOut = this.eventPool.getPrice(blockNumber, unitIn);
+    const unitOut = pool.getPrice(blockNumber, unitIn);
     const amountsOut = amountsIn.map(amountIn =>
-      this.eventPool.getPrice(blockNumber, amountIn),
+      pool.getPrice(blockNumber, amountIn),
     );
 
     return [
@@ -153,9 +198,9 @@ export class Swell
         unit: unitOut,
         data: {},
         exchange: this.dexKey,
-        poolIdentifier: this.getPoolIdentifierKey(),
+        poolIdentifier: `${ETHER_ADDRESS}_${destToken.address}`.toLowerCase(),
         gasCost: 120_000,
-        poolAddresses: [this.swETHAddress],
+        poolAddresses: [destToken.address],
       },
     ];
   }
@@ -171,7 +216,7 @@ export class Swell
     this.assertEligibility(srcToken, destToken, side);
 
     return {
-      targetExchange: this.swETHAddress, // not used contract side
+      targetExchange: NULL_ADDRESS,
       payload: '0x',
       networkFee: '0',
     };
@@ -202,13 +247,13 @@ export class Swell
       values.push('0');
     }
 
-    const swapData = this.swETHInterface.encodeFunctionData(
-      swETHFunctions.deposit,
-      [],
+    callees.push(destToken);
+    calldata.push(
+      this.swETHInterface.encodeFunctionData(
+        swETHFunctions.deposit, // rswETH has the same interface
+        [],
+      ),
     );
-
-    callees.push(this.swETHAddress);
-    calldata.push(swapData);
     values.push(srcAmount);
 
     return {
@@ -219,7 +264,6 @@ export class Swell
     };
   }
 
-  // FIXME: Add WETH -> swWETH support
   getDexParam(
     srcToken: Address,
     destToken: Address,
@@ -240,16 +284,25 @@ export class Swell
       needWrapNative: this.needWrapNative,
       dexFuncHasRecipient: false,
       exchangeData: swapData,
-      targetExchange: this.swETHAddress,
+      targetExchange: destToken,
+      swappedAmountNotPresentInExchangeData: true,
+      preSwapUnwrapCalldata: this.isWETH(srcToken)
+        ? this.erc20Interface.encodeFunctionData(WethFunctions.withdraw, [
+            srcAmount,
+          ])
+        : undefined,
+      returnAmountPos: undefined,
     };
   }
 
   getCalldataGasCost(poolPrices: PoolPrices<SwellData>): number | number[] {
     return CALLDATA_GAS_COST.DEX_OVERHEAD + CALLDATA_GAS_COST.LENGTH_SMALL;
   }
+
   getAdapters(side: SwapSide): { name: string; index: number }[] | null {
     return this.adapters?.[side] || null;
   }
+
   getTopPoolsForToken(
     tokenAddress: string,
     limit: number,

package/src/dex/swell/sweth-pool.ts

@@ -4,7 +4,7 @@ import { StatefulEventSubscriber } from '../../stateful-event-subscriber';
 import { Address, Log, Logger } from '../../types';
 import { AsyncOrSync, DeepReadonly } from 'ts-essentials';
 import { SWETHPoolState } from './type';
-import { getOnChainState } from './utils';
+import { getOnChainStateSwETH } from './utils';
 import { BI_POWS } from '../../bigint-constants';
 
 export class SwethPool extends StatefulEventSubscriber<SWETHPoolState> {
@@ -37,7 +37,7 @@ export class SwethPool extends StatefulEventSubscriber<SWETHPoolState> {
   async generateState(
     blockNumber: number | 'latest' = 'latest',
   ): Promise<DeepReadonly<SWETHPoolState>> {
-    const state = await getOnChainState(
+    const state = await getOnChainStateSwETH(
       this.dexHelper.multiContract,
       this.poolAddress,
       this.poolInterface,

package/src/dex/swell/type.ts

@@ -1,3 +1,7 @@
 export type SWETHPoolState = {
   swETHToETHRateFixed: bigint;
 };
+
+export type RSWETHPoolState = {
+  rswETHToETHRateFixed: bigint;
+};

package/src/dex/swell/utils.ts

@@ -1,10 +1,10 @@
 import { Contract } from 'web3-eth-contract';
-import { SWETHPoolState } from './type';
+import { RSWETHPoolState, SWETHPoolState } from './type';
 import { Interface, AbiCoder } from '@ethersproject/abi';
 
 const coder = new AbiCoder();
 
-export async function getOnChainState(
+export async function getOnChainStateSwETH(
   multiContract: Contract,
   poolAddress: string,
   poolInterface: Interface,
@@ -27,3 +27,27 @@ export async function getOnChainState(
     swETHToETHRateFixed,
   };
 }
+
+export async function getOnChainStateRswETH(
+  multiContract: Contract,
+  poolAddress: string,
+  poolInterface: Interface,
+  blockNumber: number | 'latest',
+): Promise<RSWETHPoolState> {
+  const data: { returnData: any[] } = await multiContract.methods
+    .aggregate([
+      {
+        target: poolAddress,
+        callData: poolInterface.encodeFunctionData('rswETHToETHRate', []),
+      },
+    ])
+    .call({}, blockNumber);
+
+  const decodedData = coder.decode(['uint256'], data.returnData[0]);
+
+  const rswETHToETHRateFixed = BigInt(decodedData[0].toString());
+
+  return {
+    rswETHToETHRateFixed,
+  };
+}

package/src/dex/synthetix/synthetix-state.ts

@@ -407,7 +407,7 @@ export class SynthetixState {
       Address,
       bigint,
       bigint,
-      ...Address[]
+      ...Address[],
     ];
 
     const [
@@ -437,7 +437,7 @@ export class SynthetixState {
       Address,
       Address,
       bigint,
-      ...string[]
+      ...string[],
     ];
 
     _require(

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/config.ts

@@ -313,6 +313,12 @@ export const UniswapV2Config: DexConfigMap<DexParams> = {
       poolGasCost: 80 * 1000,
       feeCode: 30,
     },
+    [Network.BASE]: {
+      factoryAddress: '0xfbb4E52FEcc90924c79F980eb24a9794ae4aFFA4',
+      initCode: '0x', // deprecated
+      poolGasCost: 80 * 1000,
+      feeCode: 30,
+    },
   },
   JulSwap: {
     [Network.BSC]: {
@@ -761,4 +767,56 @@ export const UniswapV2Config: DexConfigMap<DexParams> = {
       feeCode: 25,
     },
   },
+  Alien: {
+    [Network.BASE]: {
+      factoryAddress: '0x3e84d913803b02a4a7f027165e8ca42c14c0fde7',
+      subgraphURL:
+        'https://api.thegraph.com/subgraphs/name/alienbase-xyz/alien-base',
+      initCode: '0x', // deprecated
+      poolGasCost: 90 * 1000,
+      feeCode: 16,
+    },
+  },
+  RocketSwap: {
+    [Network.BASE]: {
+      factoryAddress: '0x1b8128c3a1b7d20053d10763ff02466ca7ff99fc',
+      initCode: '0x', // deprecated
+      poolGasCost: 90 * 1000,
+      feeCode: 30,
+    },
+  },
+  SoSwap: {
+    [Network.BASE]: {
+      factoryAddress: '0x539db2B4FE8016DB2594d7CfbeAb4d2B730b723E',
+      initCode: '0x', // deprecated
+      poolGasCost: 90 * 1000,
+      feeCode: 30,
+    },
+  },
+  SwapBased: {
+    [Network.BASE]: {
+      factoryAddress: '0x04C9f118d21e8B767D2e50C946f0cC9F6C367300',
+      initCode: '0x', // deprecated
+      poolGasCost: 90 * 1000,
+      feeCode: 30,
+      subgraphURL:
+        'https://api.thegraph.com/subgraphs/name/chimpydev/swapbase/graphql',
+    },
+  },
+  SharkSwap: {
+    [Network.BASE]: {
+      factoryAddress: '0x57592d44eb60011500961ef177bff8d8691d5a8b',
+      initCode: '0x', // deprecated
+      poolGasCost: 90 * 1000,
+      feeCode: 30,
+    },
+  },
+  DackieSwap: {
+    [Network.BASE]: {
+      factoryAddress: '0x591f122D1df761E616c13d265006fcbf4c6d6551',
+      initCode: '0x', // deprecated
+      poolGasCost: 90 * 1000,
+      feeCode: 25,
+    },
+  },
 };

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

@@ -37,8 +37,8 @@ export type UniswapV2ParamsDirectBase = [
   srcToken: Address,
   destToken: Address,
   fromAmount: NumberAsString,
-  quotedAmount: NumberAsString,
   toAmount: NumberAsString,
+  quotedAmount: NumberAsString,
   metadata: string,
   beneficiary: Address,
   pools: string,
@@ -145,7 +145,7 @@ export type UniswapV2Data = {
 export interface DexParams {
   subgraphURL?: string;
   factoryAddress: Address;
-  initCode: string;
+  initCode: string; // deprecated
   poolGasCost?: number;
   feeCode: number;
   router?: Address;

package/src/dex/uniswap-v2/uniswap-v2-e2e-base.test.ts

@@ -0,0 +1,48 @@
+import { constructE2ETests } from '../../../tests/utils-e2e';
+import { Network } from '../../constants';
+
+constructE2ETests('UniswapV2 E2E Base', Network.BASE, {
+  Alien: [
+    [
+      { name: 'WETH', sellAmount: '700000000000', buyAmount: '1000' },
+      { name: 'USDbC', sellAmount: '100000', buyAmount: '4000' },
+    ],
+  ],
+  RocketSwap: [
+    [
+      { name: 'WETH', sellAmount: '700000000000', buyAmount: '1000' },
+      { name: 'USDbC', sellAmount: '100000', buyAmount: '4000' },
+    ],
+  ],
+  SoSwap: [
+    [
+      { name: 'WETH', sellAmount: '700000000000', buyAmount: '1000' },
+      { name: 'USDbC', sellAmount: '100000', buyAmount: '4000' },
+    ],
+  ],
+
+  SwapBased: [
+    [
+      { name: 'WETH', sellAmount: '700000000000', buyAmount: '1000' },
+      { name: 'USDbC', sellAmount: '100000', buyAmount: '4000' },
+    ],
+  ],
+  SharkSwap: [
+    [
+      { name: 'WETH', sellAmount: '700000000000', buyAmount: '1000' },
+      { name: 'USDbC', sellAmount: '100000', buyAmount: '4000' },
+    ],
+  ],
+  DackieSwap: [
+    [
+      { name: 'WETH', sellAmount: '700000000000', buyAmount: '1000' },
+      { name: 'USDbC', sellAmount: '100000', buyAmount: '4000' },
+    ],
+  ],
+  ElkFinance: [
+    [
+      { name: 'WETH', sellAmount: '700000000000', buyAmount: '1000' },
+      { name: 'USDbC', sellAmount: '100000', buyAmount: '4000' },
+    ],
+  ],
+});

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

@@ -914,6 +914,7 @@ export class UniswapV2
       targetExchange,
       specialDexFlag,
       transferSrcTokenBeforeSwap,
+      returnAmountPos: undefined,
     };
   }
 
@@ -1042,8 +1043,8 @@ export class UniswapV2
       srcToken,
       destToken,
       fromAmount,
-      quotedAmount,
       toAmount,
+      quotedAmount,
       metadata,
       beneficiary,
       encodedPath,