@paraswap/dex-lib 2.14.0 → 2.14.2

package/src/dex/woo-fi/woo-fi.ts

@@ -1,693 +0,0 @@
-import _ from 'lodash';
-import { Interface, Result } from '@ethersproject/abi';
-import {
-  Token,
-  Address,
-  ExchangePrices,
-  PoolPrices,
-  AdapterExchangeParam,
-  SimpleExchangeParam,
-  PoolLiquidity,
-  Logger,
-} from '../../types';
-import { SwapSide, Network } from '../../constants';
-import * as CALLDATA_GAS_COST from '../../calldata-gas-cost';
-import { getBigIntPow, getDexKeysWithNetwork } from '../../utils';
-import { IDex } from '../../dex/idex';
-import { IDexHelper } from '../../dex-helper/idex-helper';
-import {
-  DexParams,
-  LatestRoundData,
-  PoolState,
-  RefInfo,
-  WooFiData,
-} from './types';
-import { SimpleExchange } from '../simple-exchange';
-import { WooFiConfig, Adapters } from './config';
-import { WooFiMath } from './woo-fi-math';
-import { MIN_CONVERSION_RATE, WOO_FI_GAS_COST } from './constants';
-import wooPPABI from '../../abi/woo-fi/WooPP.abi.json';
-import wooFeeManagerABI from '../../abi/woo-fi/WooFeeManager.abi.json';
-import woOracleABI from '../../abi/woo-fi/Wooracle.abi.json';
-
-export class WooFi extends SimpleExchange implements IDex<WooFiData> {
-  readonly math: WooFiMath;
-
-  latestState: PoolState | null = null;
-
-  latestBlockNumber: number = 0;
-
-  vaultUSDBalance: number = 0;
-
-  tokenByAddress: Record<Address, Token>;
-
-  private _refInfos: Record<Address, RefInfo> = {};
-
-  private _encodedStateRequestCalldata?: {
-    target: Address;
-    callData: string;
-  }[];
-
-  static readonly ifaces = {
-    PP: new Interface(wooPPABI),
-    fee: new Interface(wooFeeManagerABI),
-    oracle: new Interface(woOracleABI),
-    guardian: new Interface([
-      'function globalBound() view returns (uint64)',
-      'function refInfo(address) view ' +
-        'returns(tuple(address chainlinkRefOracle, uint96 refPriceFixCoeff, ' +
-        'uint96 minInputAmount, uint96 maxInputAmount, uint64 bound))',
-    ]),
-    chainlink: new Interface([
-      'function latestRoundData() view returns (tuple(uint80 roundId, ' +
-        'int256 answer, uint256 startedAt, uint256 updatedAt, ' +
-        'uint80 answeredInRound))',
-    ]),
-    erc20BalanceOf: new Interface([
-      'function balanceOf(address) view returns (uint256)',
-    ]),
-  };
-
-  readonly hasConstantPriceLargeAmounts = false;
-  readonly needWrapNative = true;
-  readonly isFeeOnTransferSupported = false;
-
-  readonly quoteTokenAddress: Address;
-
-  public static dexKeysWithNetwork: {
-    key: string;
-    networks: Network[];
-  }[] = getDexKeysWithNetwork(WooFiConfig);
-
-  logger: Logger;
-
-  constructor(
-    protected network: Network,
-    dexKey: string,
-    protected dexHelper: IDexHelper,
-    protected adapters = Adapters[network] || {},
-    readonly config = WooFiConfig[dexKey][network],
-  ) {
-    super(dexHelper, dexKey);
-    this.logger = dexHelper.getLogger(dexKey);
-
-    // Normalise once all config addresses and use across all scenarios
-    this.config = this._toLowerForAllConfigAddresses();
-
-    this.quoteTokenAddress = this.config.quoteToken.address;
-
-    // Do not do it singleton, because different networks will have different
-    // states at the same time
-    this.math = new WooFiMath(
-      dexHelper.getLogger(`${dexKey}_math`),
-      this.quoteTokenAddress,
-    );
-
-    this.tokenByAddress = Object.values(this.baseTokens).reduce(
-      (acc, cur) => {
-        acc[cur.address] = cur;
-        return acc;
-      },
-      { [this.quoteTokenAddress]: this.config.quoteToken },
-    );
-  }
-
-  private _toLowerForAllConfigAddresses() {
-    // If new config property will be added, the TS will throw compile error
-    const newConfig: DexParams = {
-      wooPPAddress: this.config.wooPPAddress.toLowerCase(),
-      wooOracleAddress: this.config.wooOracleAddress.toLowerCase(),
-      wooFeeManagerAddress: this.config.wooFeeManagerAddress.toLowerCase(),
-      wooGuardianAddress: this.config.wooGuardianAddress.toLowerCase(),
-      rebateTo: this.config.rebateTo.toLowerCase(),
-      quoteToken: {
-        ...this.config.quoteToken,
-        address: this.config.quoteToken.address.toLowerCase(),
-      },
-      baseTokens: Object.keys(this.config.baseTokens).reduce<
-        Record<string, Token>
-      >((acc, cur) => {
-        const token = this.config.baseTokens[cur];
-        token.address = token.address.toLowerCase();
-        acc[cur] = token;
-        return acc;
-      }, {}),
-    };
-    return newConfig;
-  }
-
-  private async _getRefInfos() {
-    const calldata = this.baseTokens
-      .map(t => [
-        {
-          target: this.config.wooGuardianAddress,
-          callData: WooFi.ifaces.guardian.encodeFunctionData('refInfo', [
-            t.address,
-          ]),
-        },
-      ])
-      .flat();
-
-    calldata.push({
-      target: this.config.wooGuardianAddress,
-      callData: WooFi.ifaces.guardian.encodeFunctionData('refInfo', [
-        this.quoteTokenAddress,
-      ]),
-    });
-
-    const data = await this.dexHelper.multiContract.methods
-      .tryAggregate(false, calldata)
-      .call({}, 'latest');
-
-    const parsed = data.map(([success, _data]: [boolean, string]) => {
-      if (!success)
-        throw new Error(
-          `Unexpected multicall error in ${this.dexKey} _getRefInfos`,
-        );
-
-      const decoded = WooFi.ifaces.guardian.decodeFunctionResult(
-        'refInfo',
-        _data,
-      )[0];
-      return {
-        chainlinkRefOracle: decoded.chainlinkRefOracle.toLowerCase(),
-        refPriceFixCoeff: decoded.refPriceFixCoeff.toBigInt(),
-        minInputAmount: decoded.minInputAmount.toBigInt(),
-        maxInputAmount: decoded.maxInputAmount.toBigInt(),
-        bound: decoded.bound.toBigInt(),
-      };
-    });
-
-    return this.baseTokens.reduce<Record<string, RefInfo>>(
-      (acc, curr, ind) => {
-        acc[curr.address] = parsed[ind];
-        return acc;
-      },
-      { [this.quoteTokenAddress]: parsed.slice(-1)[0] },
-    );
-  }
-
-  get baseTokens(): Token[] {
-    return Object.values(this.config.baseTokens);
-  }
-
-  get isRefInfosEmpty(): boolean {
-    return Object.keys(this._refInfos).length === 0;
-  }
-
-  protected _fillTokenInfoState(
-    state: PoolState,
-    address: string,
-    values: Result,
-  ) {
-    state.tokenInfos[address] = {
-      reserve: BigInt(values.reserve._hex),
-      R: BigInt(values.R._hex),
-      threshold: BigInt(values.threshold._hex),
-      target: BigInt(values.target._hex),
-      lastResetTimestamp: BigInt(values.lastResetTimestamp),
-    };
-  }
-
-  private _readChanLinkResponse(data: [boolean, string]): LatestRoundData {
-    const [success, returnData] = data;
-    const answer =
-      success === false || returnData === '0x'
-        ? -1n
-        : WooFi.ifaces.chainlink
-            .decodeFunctionResult('latestRoundData', returnData)[0]
-            .answer.toBigInt();
-    return { answer };
-  }
-
-  protected _getStateRequestCallData() {
-    if (!this._encodedStateRequestCalldata) {
-      const calldata = this.baseTokens
-        .map(t => [
-          {
-            target: this.config.wooFeeManagerAddress,
-            callData: WooFi.ifaces.fee.encodeFunctionData('feeRate', [
-              t.address,
-            ]),
-          },
-          {
-            target: this.config.wooOracleAddress,
-            callData: WooFi.ifaces.oracle.encodeFunctionData('state', [
-              t.address,
-            ]),
-          },
-          {
-            target: this.config.wooPPAddress,
-            callData: WooFi.ifaces.PP.encodeFunctionData('tokenInfo', [
-              t.address,
-            ]),
-          },
-          {
-            target: this._refInfos[t.address].chainlinkRefOracle,
-            callData: WooFi.ifaces.chainlink.encodeFunctionData(
-              'latestRoundData',
-              [],
-            ),
-          },
-          {
-            target: t.address,
-            callData: WooFi.ifaces.erc20BalanceOf.encodeFunctionData(
-              'balanceOf',
-              [this.config.wooPPAddress],
-            ),
-          },
-        ])
-        .flat();
-
-      calldata.push({
-        target: this.config.wooPPAddress,
-        callData: WooFi.ifaces.PP.encodeFunctionData('tokenInfo', [
-          this.quoteTokenAddress,
-        ]),
-      });
-
-      calldata.push({
-        target: this._refInfos[this.quoteTokenAddress].chainlinkRefOracle,
-        callData: WooFi.ifaces.chainlink.encodeFunctionData(
-          'latestRoundData',
-          [],
-        ),
-      });
-
-      calldata.push({
-        target: this.config.wooOracleAddress,
-        callData: WooFi.ifaces.oracle.encodeFunctionData('timestamp', []),
-      });
-
-      calldata.push({
-        target: this.config.wooPPAddress,
-        callData: WooFi.ifaces.PP.encodeFunctionData('paused', []),
-      });
-
-      calldata.push({
-        target: this.config.wooGuardianAddress,
-        callData: WooFi.ifaces.guardian.encodeFunctionData('globalBound', []),
-      });
-
-      calldata.push({
-        target: this.quoteTokenAddress,
-        callData: WooFi.ifaces.erc20BalanceOf.encodeFunctionData('balanceOf', [
-          this.config.wooPPAddress,
-        ]),
-      });
-
-      this._encodedStateRequestCalldata = calldata;
-    }
-
-    return this._encodedStateRequestCalldata;
-  }
-
-  private async _fetchStateForBlockNumber(
-    blockNumber?: number,
-  ): Promise<PoolState> {
-    const calldata = this._getStateRequestCallData();
-
-    const data = await this.dexHelper.multiContract.methods
-      .tryAggregate(false, calldata)
-      .call({}, blockNumber || 'latest');
-
-    // Last requests are standalone
-    const maxNumber = calldata.length - 6;
-
-    const [
-      baseFeeRates,
-      baseInfos,
-      baseTokenInfos,
-      chainlinkLatestRoundDatas,
-      baseTokenBalances,
-      quoteTokenInfo,
-      quoteChainlinkAnswer,
-      oracleTimestamp,
-      isPaused,
-      globalBound,
-      quoteTokenBalance,
-    ] = [
-      // Skip n steps as they are infos, tokenInfo and latestRoundData etc.
-      _.range(0, maxNumber, 5).map(index =>
-        WooFi.ifaces.fee.decodeFunctionResult('feeRate', data[index][1]),
-      ),
-      _.range(1, maxNumber, 5).map(index =>
-        WooFi.ifaces.oracle.decodeFunctionResult('state', data[index][1]),
-      ),
-      _.range(2, maxNumber, 5).map(index =>
-        WooFi.ifaces.PP.decodeFunctionResult('tokenInfo', data[index][1]),
-      ),
-      _.range(3, maxNumber, 5).map(index =>
-        this._readChanLinkResponse(data[index]),
-      ),
-      _.range(4, maxNumber, 5).map(index =>
-        WooFi.ifaces.erc20BalanceOf.decodeFunctionResult(
-          'balanceOf',
-          data[index][1],
-        ),
-      ),
-      WooFi.ifaces.PP.decodeFunctionResult('tokenInfo', data[maxNumber][1]),
-      this._readChanLinkResponse(data[maxNumber + 1]),
-      WooFi.ifaces.oracle
-        .decodeFunctionResult('timestamp', data[maxNumber + 2][1])[0]
-        .toBigInt(),
-      WooFi.ifaces.PP.decodeFunctionResult('paused', data[maxNumber + 3][1])[0],
-      WooFi.ifaces.guardian
-        .decodeFunctionResult('globalBound', data[maxNumber + 4][1])[0]
-        .toBigInt(),
-      WooFi.ifaces.erc20BalanceOf
-        .decodeFunctionResult('balanceOf', data[maxNumber + 5][1])[0]
-        .toBigInt(),
-    ];
-
-    const state: PoolState = {
-      feeRates: {},
-      tokenInfos: {},
-      tokenStates: {},
-      oracleTimestamp,
-      isPaused,
-      guardian: {
-        globalBound,
-        refInfos: this._refInfos,
-      },
-      chainlink: {
-        latestRoundDatas: {},
-      },
-      wooPPBalances: {},
-    };
-
-    this._fillTokenInfoState(state, this.quoteTokenAddress, quoteTokenInfo);
-    state.chainlink.latestRoundDatas[
-      this._refInfos[this.quoteTokenAddress].chainlinkRefOracle
-    ] = quoteChainlinkAnswer;
-
-    baseFeeRates.map((value, index) => {
-      state.feeRates[this.baseTokens[index].address] = BigInt(value[0]._hex);
-    });
-    baseInfos.map((value, index) => {
-      state.tokenStates[this.baseTokens[index].address] = {
-        priceNow: BigInt(value.priceNow._hex),
-        coeffNow: BigInt(value.coeffNow._hex),
-        spreadNow: BigInt(value.spreadNow._hex),
-      };
-    });
-    baseTokenInfos.map((values, index) => {
-      this._fillTokenInfoState(state, this.baseTokens[index].address, values);
-    });
-    chainlinkLatestRoundDatas.map((value, index) => {
-      const refInfo = this._refInfos[this.baseTokens[index].address];
-      state.chainlink.latestRoundDatas[refInfo.chainlinkRefOracle] = value;
-    });
-
-    baseTokenBalances.map((value, index) => {
-      state.wooPPBalances[this.baseTokens[index].address] = BigInt(
-        value[0]._hex,
-      );
-    });
-    state.wooPPBalances[this.config.quoteToken.address] = quoteTokenBalance;
-
-    return state;
-  }
-
-  async initializePricing(blockNumber: number) {
-    this._refInfos = await this._getRefInfos();
-    await this.getState(blockNumber);
-  }
-
-  getAdapters(side: SwapSide): { name: string; index: number }[] | null {
-    return this.adapters[side] ? this.adapters[side] : null;
-  }
-
-  getIdentifier(isSrcQuote: boolean) {
-    // Expected lower cased addresses
-    // And checks if one of the tokens is quote already done outside
-    return isSrcQuote ? `${this.dexKey}_qb` : `${this.dexKey}_bq`;
-  }
-
-  async getPoolIdentifiers(
-    srcToken: Token,
-    destToken: Token,
-    side: SwapSide,
-    blockNumber: number,
-  ): Promise<string[]> {
-    if (side === SwapSide.BUY) return [];
-
-    const _srcToken = this.dexHelper.config.wrapETH(srcToken);
-    const _destToken = this.dexHelper.config.wrapETH(destToken);
-
-    const _srcAddress = _srcToken.address.toLowerCase();
-    const _destAddress = _destToken.address.toLowerCase();
-
-    if (_srcAddress === _destAddress) return [];
-
-    if (
-      !this.tokenByAddress[_srcAddress] ||
-      !this.tokenByAddress[_destAddress]
-    ) {
-      return [];
-    }
-
-    const { isSrcQuote, isDestQuote } = this._identifyQuote(
-      _srcAddress,
-      _destAddress,
-    );
-
-    if (!isSrcQuote && !isDestQuote) return [];
-
-    return [this.getIdentifier(isSrcQuote)];
-  }
-
-  async getPricesVolume(
-    srcToken: Token,
-    destToken: Token,
-    amounts: bigint[],
-    side: SwapSide,
-    blockNumber: number,
-    limitPools?: string[],
-  ): Promise<null | ExchangePrices<WooFiData>> {
-    if (side === SwapSide.BUY) return null;
-
-    try {
-      const _srcToken = this.dexHelper.config.wrapETH(srcToken);
-      const _destToken = this.dexHelper.config.wrapETH(destToken);
-
-      const _srcAddress = _srcToken.address.toLowerCase();
-      const _destAddress = _destToken.address.toLowerCase();
-
-      if (_srcAddress === _destAddress) return null;
-
-      if (
-        !this.tokenByAddress[_srcAddress] ||
-        !this.tokenByAddress[_destAddress]
-      )
-        return null;
-
-      const { isSrcQuote, isDestQuote } = this._identifyQuote(
-        _srcAddress,
-        _destAddress,
-      );
-
-      if (!isSrcQuote && !isDestQuote) return null;
-
-      const expectedIdentifier = this.getIdentifier(isSrcQuote);
-
-      if (
-        limitPools !== undefined &&
-        !limitPools.some(p => p === expectedIdentifier)
-      )
-        return null;
-
-      const unitVolume = getBigIntPow(_srcToken.decimals);
-
-      const _amounts = [unitVolume, ...amounts.slice(1)];
-
-      const state = await this.getState(blockNumber);
-
-      if (state.isPaused) {
-        this.logger.warn(
-          `${this.dexKey} is paused on ${this.network} in getPricesVolume`,
-        );
-        return null;
-      }
-
-      let _prices: bigint[] | null;
-      if (isSrcQuote) {
-        _prices = this.math.querySellQuote(_destAddress, _amounts);
-      } else {
-        _prices = this.math.querySellBase(_srcAddress, _amounts);
-      }
-
-      if (!_prices) return null;
-
-      const unit = _prices[0];
-
-      return [
-        {
-          unit,
-          prices: [0n, ..._prices.slice(1)],
-          data: {},
-          poolIdentifier: expectedIdentifier,
-          exchange: this.dexKey,
-          gasCost: WOO_FI_GAS_COST,
-          poolAddresses: [this.config.wooPPAddress],
-        },
-      ];
-    } catch (e) {
-      this.logger.error(
-        `Error_getPricesVolume ${srcToken.symbol || srcToken.address}, ${
-          destToken.symbol || destToken.address
-        }, ${side}:`,
-        e,
-      );
-      return null;
-    }
-  }
-
-  // Returns estimated gas cost of calldata for this DEX in multiSwap
-  getCalldataGasCost(poolPrices: PoolPrices<WooFiData>): number | number[] {
-    return CALLDATA_GAS_COST.DEX_NO_PAYLOAD;
-  }
-
-  getAdapterParam(
-    srcToken: string,
-    destToken: string,
-    srcAmount: string,
-    destAmount: string,
-    data: WooFiData,
-    side: SwapSide,
-  ): AdapterExchangeParam {
-    if (side === SwapSide.BUY) throw new Error(`Buy not supported`);
-
-    const payload = this.abiCoder.encodeParameter(
-      'address',
-      this.config.rebateTo,
-    );
-
-    return {
-      targetExchange: this.config.wooPPAddress,
-      payload,
-      networkFee: '0',
-    };
-  }
-
-  async getSimpleParam(
-    srcToken: string,
-    destToken: string,
-    srcAmount: string,
-    destAmount: string,
-    data: WooFiData,
-    side: SwapSide,
-  ): Promise<SimpleExchangeParam> {
-    if (side === SwapSide.BUY) throw new Error(`Buy not supported`);
-
-    const _srcToken = srcToken.toLowerCase();
-    const _destToken = destToken.toLowerCase();
-
-    let funcName: string;
-    let _amount: string;
-    let baseToken: string;
-    if (_srcToken === this.quoteTokenAddress) {
-      baseToken = _destToken;
-      funcName = 'sellQuote';
-      _amount = srcAmount;
-    } else if (_destToken === this.quoteTokenAddress) {
-      baseToken = _srcToken;
-      funcName = 'sellBase';
-      _amount = srcAmount;
-    } else {
-      throw new Error(
-        `srcToken ${srcToken} or destToken ${destToken} must be quoteToken`,
-      );
-    }
-
-    const swapData = WooFi.ifaces.PP.encodeFunctionData(funcName, [
-      baseToken, // baseToken
-      _amount, // amount
-      MIN_CONVERSION_RATE, // minAmount
-      this.augustusAddress, // to
-      this.config.rebateTo, // rebateTo
-    ]);
-
-    return this.buildSimpleParamWithoutWETHConversion(
-      srcToken,
-      srcAmount,
-      destToken,
-      destAmount,
-      swapData,
-      this.config.wooPPAddress,
-    );
-  }
-
-  async updatePoolState(): Promise<void> {
-    if (this.isRefInfosEmpty) {
-      this._refInfos = await this._getRefInfos();
-    }
-
-    const state = await this.getState();
-
-    const tokenBalancesUSD = await Promise.all(
-      Object.values(this.tokenByAddress).map(t =>
-        this.dexHelper.getTokenUSDPrice(t, state.tokenInfos[t.address].reserve),
-      ),
-    );
-    this.vaultUSDBalance = tokenBalancesUSD.reduce(
-      (sum: number, curr: number) => sum + curr,
-    );
-  }
-
-  async getTopPoolsForToken(
-    tokenAddress: Address,
-    limit: number,
-  ): Promise<PoolLiquidity[]> {
-    const wrappedTokenAddress = this.dexHelper.config
-      .wrapETH({ address: tokenAddress, decimals: 0 })
-      .address.toLowerCase();
-
-    if (!this.tokenByAddress[wrappedTokenAddress]) return [];
-    if (!this.latestState) return [];
-
-    if (this.latestState.isPaused) {
-      this.logger.warn(
-        `${this.dexKey} is paused on ${this.network} in getTopPoolsForToken`,
-      );
-      return [];
-    }
-
-    const connectorTokens =
-      wrappedTokenAddress === this.quoteTokenAddress
-        ? this.baseTokens
-        : [this.tokenByAddress[this.quoteTokenAddress]];
-
-    return [
-      {
-        exchange: this.dexKey,
-        address: this.config.wooPPAddress,
-        connectorTokens,
-        liquidityUSD: this.vaultUSDBalance,
-      },
-    ];
-  }
-
-  async getState(blockNumber?: number): Promise<PoolState> {
-    if (
-      blockNumber !== undefined &&
-      this.latestBlockNumber === blockNumber &&
-      this.latestState !== null
-    ) {
-      return this.latestState;
-    }
-    this.latestState = await this._fetchStateForBlockNumber(blockNumber);
-    this.latestBlockNumber = blockNumber ? blockNumber : 0;
-
-    this.math.state = this.latestState;
-
-    return this.latestState;
-  }
-
-  private _identifyQuote(srcAddress: Address, destAddress: Address) {
-    return {
-      isSrcQuote: srcAddress === this.quoteTokenAddress,
-      isDestQuote: destAddress === this.quoteTokenAddress,
-    };
-  }
-}