@paraswap/dex-lib 2.28.9-take-surplus.0 → 2.28.9-take-surplus.1

package/src/dex/solidly/forks-override/ramses.ts

@@ -0,0 +1,253 @@
+import { Network, SUBGRAPH_TIMEOUT } from '../../../constants';
+import { getDexKeysWithNetwork } from '../../../utils';
+import { SolidlyConfig } from '../config';
+import _ from 'lodash';
+import { Address, PoolLiquidity } from '../../../types';
+import BigNumber from 'bignumber.js';
+import { Solidly } from '../solidly';
+import { IDexHelper } from '../../../dex-helper';
+import { SolidlyPair } from '../types';
+import { Interface } from '@ethersproject/abi';
+
+const RamsesFactoryABI = [
+  {
+    inputs: [{ internalType: 'address', name: '', type: 'address' }],
+    name: 'pairFee',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+];
+
+const ramsesFactoryIface = new Interface(RamsesFactoryABI);
+
+export type RamsesSubgraphPool = {
+  id: string;
+  isStable: boolean;
+  token0: string;
+  reserve0: string;
+  reserve1: string;
+  token1: string;
+};
+
+export type RamsesSubgraphToken = {
+  id: string;
+  decimals: string;
+};
+
+export class Ramses extends Solidly {
+  public static dexKeysWithNetwork: { key: string; networks: Network[] }[] =
+    getDexKeysWithNetwork(_.pick(SolidlyConfig, ['Ramses']));
+
+  constructor(
+    protected network: Network,
+    dexKey: string,
+    protected dexHelper: IDexHelper,
+  ) {
+    super(
+      network,
+      dexKey,
+      dexHelper,
+      true, // dynamic fees
+    );
+  }
+
+  protected getFeesMultiCallData(pair: SolidlyPair) {
+    const callEntry = {
+      target: this.factoryAddress,
+      callData: ramsesFactoryIface.encodeFunctionData('pairFee', [
+        pair.exchange,
+      ]),
+    };
+    const callDecoder = (values: any[]) =>
+      parseInt(
+        ramsesFactoryIface
+          .decodeFunctionResult('pairFee', values)[0]
+          .toString(),
+      );
+
+    return {
+      callEntry,
+      callDecoder,
+    };
+  }
+
+  async getTopPoolsForToken(
+    tokenAddress: Address,
+    count: number,
+  ): Promise<PoolLiquidity[]> {
+    if (!this.subgraphURL) return [];
+
+    const query = `query ($token: Bytes!, $count: Int) {
+      pools0: pairs(first: $count, orderBy: reserve0, orderDirection: desc, where: {token0: $token, reserve0_gt: 1, reserve1_gt: 1}) {
+        id
+        isStable
+        token0
+        token1
+        reserve0,
+        reserve1,
+      }
+      pools1: pairs(first: $count, orderBy: reserve1, orderDirection: desc, where: {token1: $token, reserve0_gt: 1, reserve1_gt: 1}) {
+        id
+        isStable
+        token0
+        token1
+        reserve0,
+        reserve1,
+      }
+    }`;
+
+    const { data } = await this.dexHelper.httpRequest.post(
+      this.subgraphURL,
+      {
+        query,
+        variables: { token: tokenAddress.toLowerCase(), count },
+      },
+      SUBGRAPH_TIMEOUT,
+    );
+
+    if (!(data && data.pools0 && data.pools1))
+      throw new Error("Couldn't fetch the pools from the subgraph");
+
+    const tokenIds = _.uniq(
+      []
+        .concat(data.pools0, data.pools1)
+        .map((pool: RamsesSubgraphPool) => [pool.token0, pool.token1])
+        .flat(),
+    );
+
+    const tokensQuery = `
+      query ($tokenIds: [String!]) {
+        tokens(where: {id_in: $tokenIds}) {
+          id
+          decimals
+        }
+      }`;
+
+    const { data: tokensData } = await this.dexHelper.httpRequest.post(
+      this.subgraphURL,
+      {
+        query: tokensQuery,
+        variables: { tokenIds },
+      },
+      SUBGRAPH_TIMEOUT,
+    );
+
+    const pools0 = await this.prepareSubgraphPools(
+      tokensData.tokens,
+      data.pools0,
+      (
+        pool,
+        { address1, decimals1, liquidityUSDToken0, liquidityUSDToken1 },
+      ) => ({
+        exchange: this.dexKey,
+        stable: pool.isStable,
+        address: pool.id.toLowerCase(),
+        connectorTokens: [
+          {
+            address: address1,
+            decimals: decimals1,
+          },
+        ],
+        liquidityUSD: liquidityUSDToken0 + liquidityUSDToken1,
+      }),
+    );
+
+    const pools1 = await this.prepareSubgraphPools(
+      tokensData.tokens,
+      data.pools1,
+      (
+        pool,
+        { address0, decimals0, liquidityUSDToken0, liquidityUSDToken1 },
+      ) => ({
+        exchange: this.dexKey,
+        stable: pool.isStable,
+        address: pool.id.toLowerCase(),
+        connectorTokens: [
+          {
+            address: address0,
+            decimals: decimals0,
+          },
+        ],
+        liquidityUSD: liquidityUSDToken0 + liquidityUSDToken1,
+      }),
+    );
+
+    return _.slice(
+      _.sortBy(_.concat(pools0, pools1), [pool => -1 * pool.liquidityUSD]),
+      0,
+      count,
+    );
+  }
+
+  protected async prepareSubgraphPools(
+    tokens: RamsesSubgraphToken[],
+    pools: RamsesSubgraphPool[],
+    iterator: (
+      pool: RamsesSubgraphPool,
+      {
+        address0,
+        address1,
+        decimals0,
+        decimals1,
+        reserve0,
+        reserve1,
+        liquidityUSDToken0,
+        liquidityUSDToken1,
+      }: {
+        address0: string;
+        address1: string;
+        decimals0: number;
+        decimals1: number;
+        reserve0: bigint;
+        reserve1: bigint;
+        liquidityUSDToken0: number;
+        liquidityUSDToken1: number;
+      },
+    ) => PoolLiquidity,
+  ): Promise<PoolLiquidity[]> {
+    return Promise.all(
+      pools.map(async (pool: RamsesSubgraphPool) => {
+        const address0 = pool.token0.toLowerCase();
+        const address1 = pool.token1.toLowerCase();
+
+        const decimals0 = parseInt(
+          tokens.find(t => t.id === address0)!.decimals,
+        );
+        const decimals1 = parseInt(
+          tokens.find(t => t.id === address1)!.decimals,
+        );
+
+        const reserve0 = BigInt(new BigNumber(pool.reserve0).toFixed());
+        const reserve1 = BigInt(new BigNumber(pool.reserve1).toFixed());
+
+        const liquidityUSDToken0 = await this.dexHelper.getTokenUSDPrice(
+          {
+            address: address0,
+            decimals: decimals0,
+          },
+          reserve0,
+        );
+
+        const liquidityUSDToken1 = await this.dexHelper.getTokenUSDPrice(
+          {
+            address: address1,
+            decimals: decimals1,
+          },
+          reserve1,
+        );
+
+        return iterator(pool, {
+          address0,
+          address1,
+          decimals0,
+          decimals1,
+          reserve0,
+          reserve1,
+          liquidityUSDToken0,
+          liquidityUSDToken1,
+        });
+      }),
+    );
+  }
+}

package/src/dex/solidly/forks-override/velodromeV2.ts

@@ -0,0 +1,63 @@
+import { Solidly } from '../solidly';
+import { Network } from '../../../constants';
+import { getDexKeysWithNetwork } from '../../../utils';
+import { SolidlyConfig } from '../config';
+import _ from 'lodash';
+import { Address, PoolLiquidity } from '../../../types';
+import { SolidlyPair } from '../types';
+import { Interface } from '@ethersproject/abi';
+import { IDexHelper } from '../../../dex-helper';
+
+const VelodromeV2FactoryABI = [
+  {
+    inputs: [
+      { internalType: 'address', name: 'pool', type: 'address' },
+      { internalType: 'bool', name: '_stable', type: 'bool' },
+    ],
+    name: 'getFee',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+];
+
+const velodromeV2FactoryIface = new Interface(VelodromeV2FactoryABI);
+
+export class VelodromeV2 extends Solidly {
+  public static dexKeysWithNetwork: { key: string; networks: Network[] }[] =
+    getDexKeysWithNetwork(_.pick(SolidlyConfig, ['VelodromeV2']));
+
+  constructor(
+    protected network: Network,
+    dexKey: string,
+    protected dexHelper: IDexHelper,
+  ) {
+    super(
+      network,
+      dexKey,
+      dexHelper,
+      true, // dynamic fees
+    );
+  }
+
+  protected getFeesMultiCallData(pair: SolidlyPair) {
+    const callEntry = {
+      target: this.factoryAddress,
+      callData: velodromeV2FactoryIface.encodeFunctionData('getFee', [
+        pair.exchange,
+        pair.stable,
+      ]),
+    };
+    const callDecoder = (values: any[]) =>
+      parseInt(
+        velodromeV2FactoryIface
+          .decodeFunctionResult('getFee', values)[0]
+          .toString(),
+      );
+
+    return {
+      callEntry,
+      callDecoder,
+    };
+  }
+}

package/src/dex/solidly/solidly-e2e.test.ts

@@ -2,11 +2,95 @@ import dotenv from 'dotenv';
 dotenv.config();
 
 import { testE2E } from '../../../tests/utils-e2e';
-import { Tokens, Holders } from '../../../tests/constants-e2e';
+import {
+  Tokens,
+  Holders,
+  NativeTokenSymbols,
+} from '../../../tests/constants-e2e';
 import { Network, ContractMethod, SwapSide } from '../../constants';
 import { StaticJsonRpcProvider } from '@ethersproject/providers';
 import { generateConfig } from '../../config';
 
+function testForNetwork(
+  network: Network,
+  dexKey: string,
+  tokenASymbol: string,
+  tokenBSymbol: string,
+  tokenAAmount: string,
+  tokenBAmount: string,
+  nativeTokenAmount: string,
+) {
+  const provider = new StaticJsonRpcProvider(
+    generateConfig(network).privateHttpProvider,
+    network,
+  );
+  const tokens = Tokens[network];
+  const holders = Holders[network];
+  const nativeTokenSymbol = NativeTokenSymbols[network];
+
+  // TODO: Add any direct swap contractMethod name if it exists
+  const sideToContractMethods = new Map([
+    [
+      SwapSide.SELL,
+      [
+        ContractMethod.simpleSwap,
+        ContractMethod.multiSwap,
+        ContractMethod.megaSwap,
+      ],
+    ],
+  ]);
+
+  describe(`${network}`, () => {
+    sideToContractMethods.forEach((contractMethods, side) =>
+      describe(`${side}`, () => {
+        contractMethods.forEach((contractMethod: ContractMethod) => {
+          describe(`${contractMethod}`, () => {
+            it(`${nativeTokenSymbol} -> ${tokenASymbol}`, async () => {
+              await testE2E(
+                tokens[nativeTokenSymbol],
+                tokens[tokenASymbol],
+                holders[nativeTokenSymbol],
+                side === SwapSide.SELL ? nativeTokenAmount : tokenAAmount,
+                side,
+                dexKey,
+                contractMethod,
+                network,
+                provider,
+              );
+            });
+            it(`${tokenASymbol} -> ${nativeTokenSymbol}`, async () => {
+              await testE2E(
+                tokens[tokenASymbol],
+                tokens[nativeTokenSymbol],
+                holders[tokenASymbol],
+                side === SwapSide.SELL ? tokenAAmount : nativeTokenAmount,
+                side,
+                dexKey,
+                contractMethod,
+                network,
+                provider,
+              );
+            });
+            it(`${tokenASymbol} -> ${tokenBSymbol}`, async () => {
+              await testE2E(
+                tokens[tokenASymbol],
+                tokens[tokenBSymbol],
+                holders[tokenASymbol],
+                side === SwapSide.SELL ? tokenAAmount : tokenBAmount,
+                side,
+                dexKey,
+                contractMethod,
+                network,
+                provider,
+              );
+            });
+          });
+        });
+      }),
+    );
+  });
+}
+
 describe('Solidly E2E', () => {
   describe('Fantom', () => {
     const network = Network.FANTOM;
@@ -309,6 +393,28 @@ describe('Solidly E2E', () => {
         });
       });
     });
+
+    describe('Equalizer', () => {
+      const dexKey = 'Equalizer';
+      const network = Network.FANTOM;
+
+      const tokenASymbol: string = 'FUSDT';
+      const tokenBSymbol: string = 'USDC';
+
+      const tokenAAmount: string = '111110';
+      const tokenBAmount: string = '100000';
+      const nativeTokenAmount = '11000000000000000';
+
+      testForNetwork(
+        network,
+        dexKey,
+        tokenASymbol,
+        tokenBSymbol,
+        tokenAAmount,
+        tokenBAmount,
+        nativeTokenAmount,
+      );
+    });
   });
 
   describe('Mainnet', () => {
@@ -689,6 +795,29 @@ describe('Solidly E2E', () => {
         });
       });
     });
+
+    describe('VelodromeV2', () => {
+      const dexKey = 'VelodromeV2';
+
+      const network = Network.OPTIMISM;
+
+      const tokenASymbol: string = 'USDC';
+      const tokenBSymbol: string = 'USDT';
+
+      const tokenAAmount: string = '111110000';
+      const tokenBAmount: string = '1100000000';
+      const nativeTokenAmount = '11000000000000000';
+
+      testForNetwork(
+        network,
+        dexKey,
+        tokenASymbol,
+        tokenBSymbol,
+        tokenAAmount,
+        tokenBAmount,
+        nativeTokenAmount,
+      );
+    });
   });
 
   describe('BSC', () => {
@@ -1179,5 +1308,188 @@ describe('Solidly E2E', () => {
         }),
       );
     });
+
+    describe('Ramses', () => {
+      const dexKey = 'Ramses';
+
+      const sideToContractMethods = new Map([
+        [
+          SwapSide.SELL,
+          [
+            ContractMethod.simpleSwap,
+            ContractMethod.multiSwap,
+            ContractMethod.megaSwap,
+          ],
+        ],
+      ]);
+
+      const pairs: { name: string; sellAmount: string }[][] = [
+        [
+          {
+            name: 'ETH',
+            sellAmount: '10000000000000',
+          },
+          {
+            name: 'USDCe',
+            sellAmount: '100000000',
+          },
+        ],
+        [
+          {
+            name: 'WETH',
+            sellAmount: '10000000000000',
+          },
+          {
+            name: 'USDCe',
+            sellAmount: '100000000',
+          },
+        ],
+        [
+          {
+            name: 'USDT',
+            sellAmount: '100000000',
+          },
+          {
+            name: 'USDCe',
+            sellAmount: '100000000',
+          },
+        ],
+        [
+          {
+            name: 'USDCe',
+            sellAmount: '500000',
+          },
+          {
+            name: 'DAI',
+            sellAmount: '1000000000000000000',
+          },
+        ],
+      ];
+
+      sideToContractMethods.forEach((contractMethods, side) =>
+        describe(`${side}`, () => {
+          contractMethods.forEach((contractMethod: ContractMethod) => {
+            pairs.forEach(pair => {
+              describe(`${contractMethod}`, () => {
+                it(`${pair[0].name} -> ${pair[1].name}`, async () => {
+                  await testE2E(
+                    tokens[pair[0].name],
+                    tokens[pair[1].name],
+                    holders[pair[0].name],
+                    pair[0].sellAmount,
+                    side,
+                    dexKey,
+                    contractMethod,
+                    network,
+                    provider,
+                  );
+                });
+                it(`${pair[1].name} -> ${pair[0].name}`, async () => {
+                  await testE2E(
+                    tokens[pair[1].name],
+                    tokens[pair[0].name],
+                    holders[pair[1].name],
+                    pair[1].sellAmount,
+                    side,
+                    dexKey,
+                    contractMethod,
+                    network,
+                    provider,
+                  );
+                });
+              });
+            });
+          });
+        }),
+      );
+    });
+  });
+
+  describe('Base', () => {
+    const network = Network.BASE;
+
+    describe('Aerodrome', () => {
+      const dexKey = 'Aerodrome';
+      const tokenASymbol: string = 'USDbC';
+      const tokenBSymbol: string = 'DAI';
+
+      const tokenAAmount: string = '1111100000';
+      const tokenBAmount: string = '100000000000000000';
+      const nativeTokenAmount = '100000000000000000';
+
+      testForNetwork(
+        network,
+        dexKey,
+        tokenASymbol,
+        tokenBSymbol,
+        tokenAAmount,
+        tokenBAmount,
+        nativeTokenAmount,
+      );
+    });
+
+    describe('Equalizer', () => {
+      const dexKey = 'Equalizer';
+      const network = Network.BASE;
+
+      const tokenASymbol: string = 'USDbC';
+      const tokenAAmount: string = '1111100000';
+      const nativeTokenAmount = '110000000000000000';
+
+      const provider = new StaticJsonRpcProvider(
+        generateConfig(network).privateHttpProvider,
+        network,
+      );
+      const tokens = Tokens[network];
+      const holders = Holders[network];
+      const nativeTokenSymbol = NativeTokenSymbols[network];
+
+      // TODO: Add any direct swap contractMethod name if it exists
+      const sideToContractMethods = new Map([
+        [
+          SwapSide.SELL,
+          [
+            ContractMethod.simpleSwap,
+            ContractMethod.multiSwap,
+            ContractMethod.megaSwap,
+          ],
+        ],
+      ]);
+
+      sideToContractMethods.forEach((contractMethods, side) =>
+        describe(`${side}`, () => {
+          contractMethods.forEach((contractMethod: ContractMethod) => {
+            describe(`${contractMethod}`, () => {
+              it(`${nativeTokenSymbol} -> ${tokenASymbol}`, async () => {
+                await testE2E(
+                  tokens[nativeTokenSymbol],
+                  tokens[tokenASymbol],
+                  holders[nativeTokenSymbol],
+                  side === SwapSide.SELL ? nativeTokenAmount : tokenAAmount,
+                  side,
+                  dexKey,
+                  contractMethod,
+                  network,
+                  provider,
+                );
+              });
+              it(`${tokenASymbol} -> ${nativeTokenSymbol}`, async () => {
+                await testE2E(
+                  tokens[tokenASymbol],
+                  tokens[nativeTokenSymbol],
+                  holders[tokenASymbol],
+                  side === SwapSide.SELL ? tokenAAmount : nativeTokenAmount,
+                  side,
+                  dexKey,
+                  contractMethod,
+                  network,
+                  provider,
+                );
+              });
+            });
+          });
+        }),
+      );
+    });
   });
 });