@paraswap/dex-lib 4.0.16 → 4.0.17-usual-pp.0

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

@@ -19,16 +19,6 @@ import { FluidDex } from './fluid-dex';
   README
   ======
 
-  This test script should add e2e tests for FluidDex. The tests
-  should cover as many cases as possible. Most of the DEXes follow
-  the following test structure:
-    - DexName
-      - ForkName + Network
-        - ContractMethod
-          - ETH -> Token swap
-          - Token -> ETH swap
-          - Token -> Token swap
-
   The template already enumerates the basic structure which involves
   testing simpleSwap, multiSwap, megaSwap contract methods for
   ETH <> TOKEN and TOKEN <> TOKEN swaps. You should replace tokenA and

package/src/dex/fluid-dex/fluid-dex.ts

@@ -206,6 +206,12 @@ export class FluidDex extends SimpleExchange implements IDex<FluidDexData> {
         pools = pools.filter(pool => limitPools.includes(pool.id));
       }
 
+      // temporarily limit FLUID-ETH Dex Pool.
+      pools = pools.filter(
+        pool =>
+          pool.id != 'FluidDex_0xc800b0e15c40a1ff0539218100c86f4c1bac8d9c',
+      );
+
       if (!pools.length) return null;
 
       const liquidityProxyState = await this.liquidityProxy.getStateOrGenerate(

package/src/dex/index.ts

@@ -100,6 +100,7 @@ import { Stader } from './stader/stader';
 import { UsualBond } from './usual/usual-bond';
 import { UsualMWrappedM } from './usual/usual-m-wrapped-m';
 import { UsualMUsd0 } from './usual/usual-m-usd0';
+import { UsualPP } from './usual-pp/usual-pp';
 
 const LegacyDexes = [
   CurveV2,
@@ -194,6 +195,7 @@ const Dexes = [
   FluidDex,
   UsualMWrappedM,
   UsualMUsd0,
+  UsualPP,
 ];
 
 export type LegacyDexConstructor = new (dexHelper: IDexHelper) => IDexTxBuilder<

package/src/dex/usual/usual.ts

@@ -72,7 +72,7 @@ export class Usual extends SimpleExchange implements IDex<UsualBondData> {
     }
 
     if (this.isValidTokens(srcTokenAddress, destTokenAddress)) {
-      return [`${this.dexKey}_${this.config.toToken}`];
+      return [`${this.dexKey}_${this.config.toToken.address}`];
     }
 
     return [];

package/src/dex/usual-pp/config.ts

@@ -0,0 +1,18 @@
+import { Network } from '../../constants';
+import { DexConfigMap } from '../../types';
+import { DexParams } from './types';
+
+export const Config: DexConfigMap<DexParams> = {
+  UsualPP: {
+    [Network.MAINNET]: {
+      USD0: {
+        address: '0x73a15fed60bf67631dc6cd7bc5b6e8da8190acf5',
+        decimals: 18,
+      },
+      USD0PP: {
+        address: '0x35d8949372d46b7a3d5a56006ae77b215fc69bc0',
+        decimals: 18,
+      },
+    },
+  },
+};

package/src/dex/usual-pp/pool.ts

@@ -0,0 +1,77 @@
+import _ from 'lodash';
+import { Interface } from '@ethersproject/abi';
+import { IDexHelper } from '../../dex-helper';
+import { StatefulEventSubscriber } from '../../stateful-event-subscriber';
+import { Address, Log, Logger } from '../../types';
+import { AsyncOrSync, DeepReadonly } from 'ts-essentials';
+import { PoolState } from './types';
+import { getOnChainState } from './utils';
+
+export class UsualPool extends StatefulEventSubscriber<PoolState> {
+  decoder = (log: Log) => this.poolInterface.parseLog(log);
+
+  constructor(
+    parentName: string,
+    protected dexHelper: IDexHelper,
+    private poolAddress: Address,
+    private poolInterface: Interface,
+    logger: Logger,
+  ) {
+    super(parentName, 'UsualPool', dexHelper, logger);
+    this.addressesSubscribed = [poolAddress];
+  }
+
+  protected processLog(
+    state: DeepReadonly<PoolState>,
+    log: Readonly<Log>,
+  ): AsyncOrSync<DeepReadonly<PoolState> | null> {
+    const event = this.decoder(log);
+    const _state: PoolState = _.cloneDeep(state);
+    if (event.name === 'FloorPriceUpdated') {
+      _state.price = BigInt(event.args.newFloorPrice);
+      return _state;
+    }
+    return null;
+  }
+
+  async generateState(
+    blockNumber: number | 'latest' = 'latest',
+  ): Promise<DeepReadonly<PoolState>> {
+    const state = await getOnChainState(
+      this.dexHelper.multiContract,
+      this.poolAddress,
+      this.poolInterface,
+      blockNumber,
+    );
+    return state;
+  }
+
+  async getPrice(blockNumber: number): Promise<bigint> {
+    const state = await this.getOrGenerateState(blockNumber);
+    if (!state) throw new Error('Cannot compute state');
+    return state.price;
+  }
+
+  async getOrGenerateState(
+    blockNumber: number,
+  ): Promise<DeepReadonly<PoolState> | null> {
+    const state = this.getState(blockNumber);
+    if (state) {
+      return state;
+    }
+
+    this.logger.debug(
+      `No state found for ${this.addressesSubscribed[0]}, generating new one`,
+    );
+    const newState = await this.generateState(blockNumber);
+
+    if (!newState) {
+      this.logger.debug(
+        `Could not regenerate state for ${this.addressesSubscribed[0]}`,
+      );
+      return null;
+    }
+    this.setState(newState, blockNumber);
+    return newState;
+  }
+}

package/src/dex/usual-pp/types.ts

@@ -0,0 +1,12 @@
+import { Address } from '../../types';
+
+export type PoolState = {
+  price: bigint;
+};
+
+export type UsualPPData = {};
+
+export type DexParams = {
+  USD0: { address: Address; decimals: number };
+  USD0PP: { address: Address; decimals: number };
+};

package/src/dex/usual-pp/usual-events.test.ts

@@ -0,0 +1,70 @@
+import dotenv from 'dotenv';
+dotenv.config();
+
+import { Network } from '../../constants';
+import { DummyDexHelper } from '../../dex-helper/index';
+import { testEventSubscriber } from '../../../tests/utils-events';
+import { PoolState } from './types';
+import { Config } from './config';
+import { UsualPool } from './pool';
+import { PoolConfig } from '../curve-v1/types';
+import UsualPoolAbi from '../../abi/usual-pp/abi.json';
+import { Interface } from '@ethersproject/abi';
+
+jest.setTimeout(50 * 1000);
+const dexKey = 'UsualPP';
+const network = Network.MAINNET;
+const config = Config[dexKey][network];
+const dexHelper = new DummyDexHelper(network);
+const logger = dexHelper.getLogger(dexKey);
+
+async function fetchPoolState(
+  usualPool: UsualPool,
+  blockNumber: number,
+): Promise<PoolState> {
+  return usualPool.generateState(blockNumber);
+}
+
+function compareState(state: PoolState, expectedState: PoolState) {
+  expect(state).toEqual(expectedState);
+}
+
+describe('UsualPP Event', function () {
+  const blockNumbers: { [eventName: string]: number[] } = {
+    FloorPriceUpdated: [21589702],
+  };
+
+  describe('UsualPool', function () {
+    let usualPool: UsualPool;
+    let blockNumber: number;
+
+    const usualPoolIface = new Interface(UsualPoolAbi);
+
+    beforeAll(async function () {
+      blockNumber = await dexHelper.web3Provider.eth.getBlockNumber();
+    });
+
+    Object.keys(blockNumbers).forEach((event: string) => {
+      blockNumbers[event].forEach((blockNumber: number) => {
+        it(`Should return the correct state after the ${blockNumber}:${event}`, async function () {
+          usualPool = new UsualPool(
+            dexKey,
+            dexHelper,
+            config.USD0PP.address,
+            usualPoolIface,
+            logger,
+          );
+          await testEventSubscriber(
+            usualPool,
+            usualPool.addressesSubscribed,
+            (_blockNumber: number) => fetchPoolState(usualPool, _blockNumber),
+            blockNumber,
+            `${dexKey}_${config.USD0PP.address}`,
+            dexHelper.provider,
+            compareState,
+          );
+        });
+      });
+    });
+  });
+});

package/src/dex/usual-pp/usual-integration.test.ts

@@ -0,0 +1,143 @@
+/* eslint-disable no-console */
+import dotenv from 'dotenv';
+dotenv.config();
+
+import { Interface } from '@ethersproject/abi';
+import { DummyDexHelper } from '../../dex-helper/index';
+import { Network, SwapSide } from '../../constants';
+import { BI_POWS } from '../../bigint-constants';
+import {
+  checkPoolPrices,
+  checkConstantPoolPrices,
+  checkPoolsLiquidity,
+} from '../../../tests/utils';
+import { Tokens } from '../../../tests/constants-e2e';
+import { UsualPP } from './usual-pp';
+
+async function testPricingOnNetwork(
+  usual: UsualPP,
+  network: Network,
+  dexKey: string,
+  blockNumber: number,
+  srcTokenSymbol: string,
+  destTokenSymbol: string,
+  side: SwapSide,
+  amounts: bigint[],
+  funcNameToCheck: string,
+) {
+  const networkTokens = Tokens[network];
+
+  console.log(amounts);
+
+  const pools = await usual.getPoolIdentifiers(
+    networkTokens[srcTokenSymbol],
+    networkTokens[destTokenSymbol],
+    side,
+    blockNumber,
+  );
+  console.log(
+    `${srcTokenSymbol} <> ${destTokenSymbol} Pool Identifiers: `,
+    pools,
+  );
+
+  expect(pools.length).toBeGreaterThan(0);
+
+  const poolPrices = await usual.getPricesVolume(
+    networkTokens[srcTokenSymbol],
+    networkTokens[destTokenSymbol],
+    amounts,
+    side,
+    blockNumber,
+    pools,
+  );
+  console.log(
+    `${srcTokenSymbol} <> ${destTokenSymbol} Pool Prices: `,
+    poolPrices,
+  );
+
+  expect(poolPrices).not.toBeNull();
+  // Check if onchain pricing equals to calculated ones
+}
+
+describe('UsualPP', function () {
+  const dexKey = 'UsualPP';
+  let blockNumber: number;
+  let usualPP: UsualPP;
+
+  describe('Mainnet', () => {
+    const network = Network.MAINNET;
+    const dexHelper = new DummyDexHelper(network);
+
+    // Don't forget to update relevant tokens in constant-e2e.ts
+
+    const amountsForSell = [
+      0n,
+      1n * BI_POWS[18],
+      2n * BI_POWS[18],
+      3n * BI_POWS[18],
+      4n * BI_POWS[18],
+      5n * BI_POWS[18],
+      6n * BI_POWS[18],
+      7n * BI_POWS[18],
+      8n * BI_POWS[18],
+      9n * BI_POWS[18],
+      10n * BI_POWS[18],
+    ];
+
+    beforeAll(async () => {
+      blockNumber = await dexHelper.web3Provider.eth.getBlockNumber();
+      usualPP = new UsualPP(network, dexKey, dexHelper);
+      if (usualPP.initializePricing) {
+        await usualPP.initializePricing(blockNumber);
+      }
+    });
+
+    it('getPoolIdentifiers and getPricesVolume SELL', async function () {
+      await testPricingOnNetwork(
+        usualPP,
+        network,
+        dexKey,
+        blockNumber,
+        'USD0++',
+        'USD0',
+        SwapSide.SELL,
+        amountsForSell,
+        '',
+      );
+    });
+
+    it('getTopPoolsForToken: USD0', async function () {
+      const tokenA = Tokens[network]['USD0'];
+      const dexHelper = new DummyDexHelper(network);
+      const usualPP = new UsualPP(network, dexKey, dexHelper);
+
+      const poolLiquidity = await usualPP.getTopPoolsForToken(
+        tokenA.address,
+        10,
+      );
+      console.log(
+        `${tokenA.symbol} Top Pools:`,
+        JSON.stringify(poolLiquidity, null, 2),
+      );
+
+      checkPoolsLiquidity(poolLiquidity, tokenA.address, dexKey);
+    });
+
+    it('getTopPoolsForToken: USD0++', async function () {
+      const tokenA = Tokens[network]['USD0++'];
+      const dexHelper = new DummyDexHelper(network);
+      const usualPP = new UsualPP(network, dexKey, dexHelper);
+
+      const poolLiquidity = await usualPP.getTopPoolsForToken(
+        tokenA.address,
+        10,
+      );
+      console.log(
+        `${tokenA.symbol} Top Pools:`,
+        JSON.stringify(poolLiquidity, null, 2),
+      );
+
+      checkPoolsLiquidity(poolLiquidity, tokenA.address, dexKey);
+    });
+  });
+});

package/src/dex/usual-pp/usual-pp.e2e.test.ts

@@ -0,0 +1,76 @@
+/* eslint-disable no-console */
+import dotenv from 'dotenv';
+dotenv.config();
+
+import { testE2E } from '../../../tests/utils-e2e';
+import { Tokens, Holders } 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,
+) {
+  const provider = new StaticJsonRpcProvider(
+    generateConfig(network).privateHttpProvider,
+    network,
+  );
+  const tokens = Tokens[network];
+  const holders = Holders[network];
+
+  const sideToContractMethods = new Map([
+    [SwapSide.SELL, [ContractMethod.swapExactAmountIn]],
+  ]);
+
+  describe(`${network}`, () => {
+    sideToContractMethods.forEach((contractMethods, side) =>
+      describe(`${side}`, () => {
+        contractMethods.forEach((contractMethod: ContractMethod) => {
+          describe(`${contractMethod}`, () => {
+            it(`${tokenASymbol} -> ${tokenBSymbol}`, async () => {
+              await testE2E(
+                tokens[tokenASymbol],
+                tokens[tokenBSymbol],
+                holders[tokenASymbol],
+                side === SwapSide.SELL ? tokenAAmount : tokenBAmount,
+                side,
+                dexKey,
+                contractMethod,
+                network,
+                provider,
+              );
+            });
+          });
+        });
+      }),
+    );
+  });
+}
+
+describe('UsualPP E2E', () => {
+  const dexKey = 'UsualPP';
+
+  describe('Mainnet', () => {
+    const network = Network.MAINNET;
+
+    const tokenASymbol: string = 'USD0++';
+    const tokenBSymbol: string = 'USD0';
+
+    const tokenAAmount: string = '1000000000000000000';
+    const tokenBAmount: string = '1000000000000000000';
+
+    testForNetwork(
+      network,
+      dexKey,
+      tokenASymbol,
+      tokenBSymbol,
+      tokenAAmount,
+      tokenBAmount,
+    );
+  });
+});

package/src/dex/usual-pp/usual-pp.ts

@@ -0,0 +1,208 @@
+import {
+  Token,
+  Address,
+  ExchangePrices,
+  PoolPrices,
+  AdapterExchangeParam,
+  Logger,
+  PoolLiquidity,
+  DexExchangeParam,
+  NumberAsString,
+} from '../../types';
+import { SwapSide, Network } from '../../constants';
+import * as CALLDATA_GAS_COST from '../../calldata-gas-cost';
+import { IDex } from '../idex';
+import { IDexHelper } from '../../dex-helper/idex-helper';
+import { SimpleExchange } from '../simple-exchange';
+import { BI_POWS } from '../../bigint-constants';
+import { DexParams, UsualPPData } from './types';
+import { UsualPool } from './pool';
+import { Interface } from '@ethersproject/abi';
+import UsualPoolAbi from '../../abi/usual-pp/abi.json';
+import { Config } from './config';
+import { getDexKeysWithNetwork } from '../../utils';
+import { UsualBondData } from '../usual/types';
+
+export class UsualPP extends SimpleExchange implements IDex<UsualPPData> {
+  readonly hasConstantPriceLargeAmounts = false;
+  readonly needWrapNative = false;
+  readonly isFeeOnTransferSupported = false;
+
+  private usualPool: UsualPool;
+  private usualPoolIface: Interface;
+  private config: DexParams;
+
+  logger: Logger;
+
+  public static dexKeysWithNetwork: { key: string; networks: Network[] }[] =
+    getDexKeysWithNetwork(Config);
+
+  constructor(
+    readonly network: Network,
+    readonly dexKey: string,
+    readonly dexHelper: IDexHelper,
+    protected adapters = {},
+  ) {
+    super(dexHelper, dexKey);
+    this.config = Config[dexKey][network];
+    this.logger = dexHelper.getLogger(dexKey);
+    this.usualPoolIface = new Interface(UsualPoolAbi);
+    this.usualPool = new UsualPool(
+      this.dexKey,
+      dexHelper,
+      this.config.USD0PP.address,
+      this.usualPoolIface,
+      this.logger,
+    );
+  }
+
+  async initializePricing(blockNumber: number) {
+    await this.usualPool.initialize(blockNumber);
+  }
+
+  isUsd0PP(token: string) {
+    return token.toLowerCase() === this.config.USD0PP.address.toLowerCase();
+  }
+
+  isUsd0(token: string) {
+    return token.toLowerCase() === this.config.USD0.address.toLowerCase();
+  }
+
+  isValidTokens(srcToken: string, destToken: string) {
+    return this.isUsd0PP(srcToken) && this.isUsd0(destToken);
+  }
+
+  getAdapters() {
+    return null;
+  }
+
+  async getPoolIdentifiers(
+    srcToken: Token,
+    destToken: Token,
+    side: SwapSide,
+    blockNumber: number,
+  ): Promise<string[]> {
+    if (!srcToken || !destToken) {
+      this.logger.error('Source or destination token is undefined');
+      return [];
+    }
+
+    const srcTokenAddress = srcToken.address?.toLowerCase();
+    const destTokenAddress = destToken.address?.toLowerCase();
+
+    if (!srcTokenAddress || !destTokenAddress) {
+      this.logger.error('Source or destination token address is undefined');
+      return [];
+    }
+
+    if (this.isValidTokens(srcTokenAddress, destTokenAddress)) {
+      return [`${this.dexKey}_${this.config.USD0.address}`];
+    }
+
+    return [];
+  }
+
+  async getPricesVolume(
+    srcToken: Token,
+    destToken: Token,
+    amounts: bigint[],
+    side: SwapSide,
+    blockNumber: number,
+    limitPools?: string[],
+  ): Promise<null | ExchangePrices<UsualPPData>> {
+    if (side === SwapSide.BUY) {
+      return null;
+    }
+
+    const isValidSwap = this.isValidTokens(srcToken.address, destToken.address);
+
+    if (!isValidSwap) {
+      return null;
+    }
+
+    const price = await this.usualPool.getPrice(blockNumber);
+    const unitOut = price;
+
+    const amountsOut = amounts.map(
+      amount => (amount * price) / BI_POWS[this.config.USD0PP.decimals],
+    );
+
+    return [
+      {
+        unit: unitOut,
+        prices: amountsOut,
+        data: {},
+        poolAddresses: [this.config.USD0.address],
+        exchange: this.dexKey,
+        gasCost: 70000,
+        poolIdentifier: this.dexKey,
+      },
+    ];
+  }
+
+  getCalldataGasCost(poolPrices: PoolPrices<UsualPPData>): number | number[] {
+    return CALLDATA_GAS_COST.DEX_NO_PAYLOAD;
+  }
+
+  getAdapterParam(
+    srcToken: string,
+    destToken: string,
+    srcAmount: string,
+    destAmount: string,
+    data: UsualPPData,
+    side: SwapSide,
+  ): AdapterExchangeParam {
+    const payload = '0x';
+
+    return {
+      targetExchange: this.config.USD0.address,
+      payload,
+      networkFee: '0',
+    };
+  }
+
+  async getTopPoolsForToken(
+    tokenAddress: Address,
+    limit: number,
+  ): Promise<PoolLiquidity[]> {
+    const isUsd0PP = this.isUsd0PP(tokenAddress);
+    const isUsd0 = this.isUsd0(tokenAddress);
+
+    if (!(isUsd0PP || isUsd0)) return [];
+
+    return [
+      {
+        exchange: this.dexKey,
+        address: this.config.USD0PP.address,
+        connectorTokens: [isUsd0PP ? this.config.USD0 : this.config.USD0PP],
+        liquidityUSD: 1000000000, // Just returning a big number so this DEX will be preferred
+      },
+    ];
+  }
+
+  async getDexParam(
+    srcToken: Address,
+    destToken: Address,
+    srcAmount: NumberAsString,
+    destAmount: NumberAsString,
+    recipient: Address,
+    data: UsualBondData,
+    side: SwapSide,
+  ): Promise<DexExchangeParam> {
+    if (this.isUsd0PP(srcToken) && this.isUsd0(destToken)) {
+      const exchangeData = this.usualPoolIface.encodeFunctionData(
+        'unlockUsd0ppFloorPrice',
+        [srcAmount],
+      );
+
+      return {
+        needWrapNative: false,
+        dexFuncHasRecipient: false,
+        exchangeData,
+        targetExchange: this.config.USD0PP.address,
+        returnAmountPos: undefined,
+      };
+    }
+    throw new Error('LOGIC ERROR');
+  }
+}

package/src/dex/usual-pp/utils.ts

@@ -0,0 +1,27 @@
+import { Contract } from 'web3-eth-contract';
+import { Interface } from '@ethersproject/abi';
+import { PoolState } from './types';
+
+export async function getOnChainState(
+  multiContract: Contract,
+  poolAddress: string,
+  poolInterface: Interface,
+  blockNumber: number | 'latest',
+): Promise<PoolState> {
+  const data: { returnData: any[] } = await multiContract.methods
+    .aggregate([
+      {
+        target: poolAddress,
+        callData: poolInterface.encodeFunctionData('getFloorPrice', []),
+      },
+    ])
+    .call({}, blockNumber);
+
+  const price = BigInt(
+    poolInterface.decodeFunctionResult('getFloorPrice', data.returnData[0])[0],
+  );
+
+  return {
+    price,
+  };
+}