aave-protocol-v2/test/__setup.spec.ts

import rawBRE from "@nomiclabs/buidler";
import {MockContract} from "ethereum-waffle";
import {
  deployLendingPoolAddressesProvider,
  deployMintableErc20,
  deployLendingPoolAddressesProviderRegistry,
  deployFeeProvider,
  deployLendingPoolParametersProvider,
  deployLendingPoolCore,
  deployLendingPoolConfigurator,
  deployLendingPoolDataProvider,
  deployLendingPool,
  deployPriceOracle,
  getLendingPoolConfiguratorProxy,
  getLendingPoolCore,
  deployMockAggregator,
  deployChainlinkProxyPriceProvider,
  deployLendingRateOracle,
  deployDefaultReserveInterestRateStrategy,
  deployLendingPoolLiquidationManager,
  deployMockOneSplit,
  deployOneSplitAdapter,
  deployTokenDistributor,
  deployInitializableAdminUpgradeabilityProxy,
  deployMockFlashLoanReceiver,
  deployWalletBalancerProvider,
  getFeeProvider,
  getLendingPoolParametersProvider,
  getLendingPoolDataProvider,
  getLendingPool,
  insertContractAddressInDb,
  deployAaveProtocolTestHelpers,
  getEthersSigners,
  registerContractInJsonDb,
} from "../helpers/contracts-helpers";
import {LendingPoolAddressesProvider} from "../types/LendingPoolAddressesProvider";
import {Wallet, ContractTransaction, ethers, Signer} from "ethers";
import {
  TokenContractId,
  eContractid,
  iAssetBase,
  tEthereumAddress,
  iAssetAggregatorBase,
  IMarketRates,
  iMultiPoolsAssets,
  AavePools,
  IReserveParams,
} from "../helpers/types";
import {MintableErc20} from "../types/MintableErc20";
import {
  MOCK_USD_PRICE_IN_WEI,
  ALL_ASSETS_INITIAL_PRICES,
  MOCK_ETH_ADDRESS,
  USD_ADDRESS,
  MOCK_CHAINLINK_AGGREGATORS_PRICES,
  LENDING_RATE_ORACLE_RATES_COMMON,
  getReservesConfigByPool,
  getFeeDistributionParamsCommon,
  ZERO_ADDRESS,
} from "../helpers/constants";
import {PriceOracle} from "../types/PriceOracle";
import {MockAggregator} from "../types/MockAggregator";
import {LendingRateOracle} from "../types/LendingRateOracle";
import {LendingPoolCore} from "../types/LendingPoolCore";
import {LendingPoolConfigurator} from "../types/LendingPoolConfigurator";

const deployAllMockTokens = async (deployer: Signer) => {
  const tokens: {[symbol: string]: MockContract | MintableErc20} = {};

  for (const tokenSymbol of Object.keys(TokenContractId)) {
    if (tokenSymbol !== "ETH") {
      tokens[tokenSymbol] = await deployMintableErc20([
        tokenSymbol,
        tokenSymbol,
        18,
      ]);
      await registerContractInJsonDb(
        tokenSymbol.toUpperCase(),
        tokens[tokenSymbol]
      );
    }
  }

  return tokens;
};

const setInitialAssetPricesInOracle = async (
  prices: iAssetBase<tEthereumAddress>,
  assetsAddresses: iAssetBase<tEthereumAddress>,
  priceOracleInstance: PriceOracle
) => {
  for (const [assetSymbol, price] of Object.entries(prices) as [
    string,
    string
  ][]) {
    const assetAddressIndex = Object.keys(assetsAddresses).findIndex(
      (value) => value === assetSymbol
    );
    const [, assetAddress] = (Object.entries(assetsAddresses) as [
      string,
      string
    ][])[assetAddressIndex];
    await waitForTx(
      await priceOracleInstance.setAssetPrice(assetAddress, price)
    );
  }
};

const deployAllMockAggregators = async (
  initialPrices: iAssetAggregatorBase<string>
) => {
  const aggregators: {[tokenSymbol: string]: MockAggregator} = {};
  for (const tokenContractName of Object.keys(initialPrices)) {
    if (tokenContractName !== "ETH") {
      const priceIndex = Object.keys(initialPrices).findIndex(
        (value) => value === tokenContractName
      );
      const [, price] = (Object.entries(initialPrices) as [string, string][])[
        priceIndex
      ];
      aggregators[tokenContractName] = await deployMockAggregator(price);
    }
  }
  return aggregators;
};

const getPairsTokenAggregator = (
  allAssetsAddresses: {
    [tokenSymbol: string]: tEthereumAddress;
  },
  aggregatorsAddresses: {[tokenSymbol: string]: tEthereumAddress}
): [string[], string[]] => {
  const {ETH, ...assetsAddressesWithoutEth} = allAssetsAddresses;

  const pairs = Object.entries(assetsAddressesWithoutEth).map(
    ([tokenSymbol, tokenAddress]) => {
      if (tokenSymbol !== "ETH") {
        const aggregatorAddressIndex = Object.keys(
          aggregatorsAddresses
        ).findIndex((value) => value === tokenSymbol);
        const [, aggregatorAddress] = (Object.entries(aggregatorsAddresses) as [
          string,
          tEthereumAddress
        ][])[aggregatorAddressIndex];
        return [tokenAddress, aggregatorAddress];
      }
    }
  );

  const mappedPairs = pairs.map(([asset]) => asset);
  const mappedAggregators = pairs.map(([, source]) => source);

  return [mappedPairs, mappedAggregators];
};

const setInitialMarketRatesInRatesOracle = async (
  marketRates: iMultiPoolsAssets<IMarketRates>,
  assetsAddresses: {[x: string]: tEthereumAddress},
  lendingRateOracleInstance: LendingRateOracle
) => {
  for (const [assetSymbol, {borrowRate}] of Object.entries(marketRates) as [
    string,
    IMarketRates
  ][]) {
    const assetAddressIndex = Object.keys(assetsAddresses).findIndex(
      (value) => value === assetSymbol
    );
    const [, assetAddress] = (Object.entries(assetsAddresses) as [
      string,
      string
    ][])[assetAddressIndex];
    await lendingRateOracleInstance.setMarketBorrowRate(
      assetAddress,
      borrowRate
    );
  }
};

const initReserves = async (
  reservesParams: iMultiPoolsAssets<IReserveParams>,
  tokenAddresses: {[symbol: string]: tEthereumAddress},
  lendingPoolAddressesProvider: LendingPoolAddressesProvider,
  lendingPoolCore: LendingPoolCore,
  lendingPoolConfigurator: LendingPoolConfigurator,
  aavePool: AavePools
) => {
  if (aavePool !== AavePools.proto && aavePool !== AavePools.secondary) {
    console.log(`Invalid Aave pool ${aavePool}`);
    process.exit(1);
  }

  for (let [assetSymbol, {reserveDecimals}] of Object.entries(
    reservesParams
  ) as [string, IReserveParams][]) {
    const assetAddressIndex = Object.keys(tokenAddresses).findIndex(
      (value) => value === assetSymbol
    );
    const [, tokenAddress] = (Object.entries(tokenAddresses) as [
      string,
      string
    ][])[assetAddressIndex];
    const reserveInitialized = await lendingPoolCore.getReserveIsActive(
      tokenAddress
    );

    if (reserveInitialized) {
      console.log(
        `Reserve ${assetSymbol} is already active, skipping configuration`
      );
      continue;
    }

    try {
      const reserveParamIndex = Object.keys(reservesParams).findIndex(
        (value) => value === assetSymbol
      );
      const [
        ,
        {
          baseVariableBorrowRate,
          variableRateSlope1,
          variableRateSlope2,
          stableRateSlope1,
          stableRateSlope2,
        },
      ] = (Object.entries(reservesParams) as [string, IReserveParams][])[
        reserveParamIndex
      ];
      const rateStrategyContract = await deployDefaultReserveInterestRateStrategy(
        [
          tokenAddress,
          lendingPoolAddressesProvider.address,
          baseVariableBorrowRate,
          variableRateSlope1,
          variableRateSlope2,
          stableRateSlope1,
          stableRateSlope2,
        ]
      );

      if (process.env.POOL === AavePools.secondary) {
        if (assetSymbol.search("UNI") === -1) {
          assetSymbol = `Uni${assetSymbol}`;
        } else {
          assetSymbol = assetSymbol.replace(/_/g, "").replace("UNI", "Uni");
        }
      }

      await lendingPoolConfigurator.initReserveWithData(
        tokenAddress,
        `Aave Interest bearing ${assetSymbol}`,
        `a${assetSymbol}`,
        reserveDecimals,
        rateStrategyContract.address
      );
    } catch (e) {
      console.log(
        `Reserve initialization for ${assetSymbol} failed with error ${e}. Skipped.`
      );
    }
  }
};

const enableReservesToBorrow = async (
  reservesParams: iMultiPoolsAssets<IReserveParams>,
  tokenAddresses: {[symbol: string]: tEthereumAddress},
  lendingPoolCore: LendingPoolCore,
  lendingPoolConfigurator: LendingPoolConfigurator
) => {
  for (const [
    assetSymbol,
    {borrowingEnabled, stableBorrowRateEnabled},
  ] of Object.entries(reservesParams) as [string, IReserveParams][]) {
    if (!borrowingEnabled) continue;
    try {
      const assetAddressIndex = Object.keys(tokenAddresses).findIndex(
        (value) => value === assetSymbol
      );
      const [, tokenAddress] = (Object.entries(tokenAddresses) as [
        string,
        string
      ][])[assetAddressIndex];
      const borrowingAlreadyEnabled = await lendingPoolCore.isReserveBorrowingEnabled(
        tokenAddress
      );

      if (borrowingAlreadyEnabled) {
        console.log(
          `Reserve ${assetSymbol} is already enabled for borrowing, skipping`
        );
        continue;
      }

      await lendingPoolConfigurator.enableBorrowingOnReserve(
        tokenAddress,
        stableBorrowRateEnabled
      );
    } catch (e) {
      console.log(
        `Enabling reserve for borrowings for ${assetSymbol} failed with error ${e}. Skipped.`
      );
    }
  }
};

const enableReservesAsCollateral = async (
  reservesParams: iMultiPoolsAssets<IReserveParams>,
  tokenAddresses: {[symbol: string]: tEthereumAddress},
  lendingPoolCore: LendingPoolCore,
  lendingPoolConfigurator: LendingPoolConfigurator
) => {
  for (const [
    assetSymbol,
    {baseLTVAsCollateral, liquidationBonus, liquidationThreshold},
  ] of Object.entries(reservesParams) as [string, IReserveParams][]) {
    if (baseLTVAsCollateral === "-1") continue;

    const assetAddressIndex = Object.keys(tokenAddresses).findIndex(
      (value) => value === assetSymbol
    );
    const [, tokenAddress] = (Object.entries(tokenAddresses) as [
      string,
      string
    ][])[assetAddressIndex];
    const alreadyEnabled = await lendingPoolCore.isReserveUsageAsCollateralEnabled(
      tokenAddress
    );

    if (alreadyEnabled) {
      console.log(
        `Reserve ${assetSymbol} is already enabled as collateral, skipping`
      );
      continue;
    }

    try {
      await lendingPoolConfigurator.enableReserveAsCollateral(
        tokenAddress,
        baseLTVAsCollateral,
        liquidationThreshold,
        liquidationBonus
      );
    } catch (e) {
      console.log(
        `Enabling reserve as collateral for ${assetSymbol} failed with error ${e}. Skipped.`
      );
    }
  }
};

export const waitForTx = async (tx: ContractTransaction) => await tx.wait();

const buildTestEnv = async (deployer: Signer, secondaryWallet: Signer) => {
  console.time("setup");
  const lendingPoolManager = await deployer.getAddress();

  const mockTokens = await deployAllMockTokens(deployer);

  const addressesProvider = await deployLendingPoolAddressesProvider();
  await waitForTx(
    await addressesProvider.setLendingPoolManager(lendingPoolManager)
  );

  const addressesProviderRegistry = await deployLendingPoolAddressesProviderRegistry();
  await waitForTx(
    await addressesProviderRegistry.registerAddressesProvider(
      addressesProvider.address,
      0
    )
  );

  const feeProviderImpl = await deployFeeProvider();
  await waitForTx(
    await addressesProvider.setFeeProviderImpl(feeProviderImpl.address)
  );
  const feeProviderProxy = await getFeeProvider(
    await addressesProvider.getFeeProvider()
  );
  await insertContractAddressInDb(
    eContractid.FeeProvider,
    feeProviderProxy.address
  );

  const parametersProviderImpl = await deployLendingPoolParametersProvider();
  await waitForTx(
    await addressesProvider.setLendingPoolParametersProviderImpl(
      parametersProviderImpl.address
    )
  );
  const parametersProviderProxy = await getLendingPoolParametersProvider(
    await addressesProvider.getLendingPoolParametersProvider()
  );
  await insertContractAddressInDb(
    eContractid.LendingPoolParametersProvider,
    parametersProviderProxy.address
  );

  const lendingPoolCoreImpl = await deployLendingPoolCore();
  await waitForTx(
    await addressesProvider.setLendingPoolCoreImpl(lendingPoolCoreImpl.address)
  );
  const lendingPoolCoreProxy = await getLendingPoolCore(
    await addressesProvider.getLendingPoolCore()
  );
  await insertContractAddressInDb(
    eContractid.LendingPoolCore,
    lendingPoolCoreProxy.address
  );

  const lendingPoolConfiguratorImpl = await deployLendingPoolConfigurator();
  await waitForTx(
    await addressesProvider.setLendingPoolConfiguratorImpl(
      lendingPoolConfiguratorImpl.address
    )
  );
  const lendingPoolConfiguratorProxy = await getLendingPoolConfiguratorProxy(
    await addressesProvider.getLendingPoolConfigurator()
  );
  await insertContractAddressInDb(
    eContractid.LendingPoolConfigurator,
    lendingPoolConfiguratorProxy.address
  );

  const dataProviderImpl = await deployLendingPoolDataProvider();
  await waitForTx(
    await addressesProvider.setLendingPoolDataProviderImpl(
      dataProviderImpl.address
    )
  );
  const dataProviderProxy = await getLendingPoolDataProvider(
    await addressesProvider.getLendingPoolDataProvider()
  );
  await insertContractAddressInDb(
    eContractid.LendingPoolDataProvider,
    dataProviderProxy.address
  );

  const lendingPoolImpl = await deployLendingPool();
  await waitForTx(
    await addressesProvider.setLendingPoolImpl(lendingPoolImpl.address)
  );
  const lendingPoolProxy = await getLendingPool(
    await addressesProvider.getLendingPool()
  );
  await insertContractAddressInDb(
    eContractid.LendingPool,
    lendingPoolProxy.address
  );

  await waitForTx(
    await lendingPoolConfiguratorProxy.refreshLendingPoolCoreConfiguration()
  );

  const fallbackOracle = await deployPriceOracle();
  await waitForTx(await fallbackOracle.setEthUsdPrice(MOCK_USD_PRICE_IN_WEI));
  await setInitialAssetPricesInOracle(
    ALL_ASSETS_INITIAL_PRICES,
    {
      ETH: MOCK_ETH_ADDRESS,
      DAI: mockTokens.DAI.address,
      TUSD: mockTokens.TUSD.address,
      USDC: mockTokens.USDC.address,
      USDT: mockTokens.USDT.address,
      SUSD: mockTokens.SUSD.address,
      LEND: mockTokens.LEND.address,
      BAT: mockTokens.BAT.address,
      REP: mockTokens.REP.address,
      MKR: mockTokens.MKR.address,
      LINK: mockTokens.LINK.address,
      KNC: mockTokens.KNC.address,
      WBTC: mockTokens.WBTC.address,
      MANA: mockTokens.MANA.address,
      ZRX: mockTokens.ZRX.address,
      SNX: mockTokens.SNX.address,
      BUSD: mockTokens.BUSD.address,

      USD: USD_ADDRESS,

      UNI_DAI_ETH: mockTokens.UNI_DAI_ETH.address,
      UNI_USDC_ETH: mockTokens.UNI_USDC_ETH.address,
      UNI_SETH_ETH: mockTokens.UNI_SETH_ETH.address,
      UNI_LEND_ETH: mockTokens.UNI_LEND_ETH.address,
      UNI_MKR_ETH: mockTokens.UNI_MKR_ETH.address,
      UNI_LINK_ETH: mockTokens.UNI_LINK_ETH.address,
    },
    fallbackOracle
  );

  const mockAggregators = await deployAllMockAggregators(
    MOCK_CHAINLINK_AGGREGATORS_PRICES
  );

  const allTokenAddresses = Object.entries(mockTokens).reduce(
    (
      accum: {[tokenSymbol: string]: tEthereumAddress},
      [tokenSymbol, tokenContract]
    ) => ({
      ...accum,
      [tokenSymbol]: tokenContract.address,
    }),
    {}
  );
  const allAggregatorsAddresses = Object.entries(mockAggregators).reduce(
    (
      accum: {[tokenSymbol: string]: tEthereumAddress},
      [tokenSymbol, aggregator]
    ) => ({
      ...accum,
      [tokenSymbol]: aggregator.address,
    }),
    {}
  );

  const [tokens, aggregators] = getPairsTokenAggregator(
    allTokenAddresses,
    allAggregatorsAddresses
  );

  const chainlinkProxyPriceProvider = await deployChainlinkProxyPriceProvider([
    tokens,
    aggregators,
    fallbackOracle.address,
  ]);
  await waitForTx(
    await addressesProvider.setPriceOracle(chainlinkProxyPriceProvider.address)
  );

  const lendingRateOracle = await deployLendingRateOracle();
  await waitForTx(
    await addressesProvider.setLendingRateOracle(lendingRateOracle.address)
  );

  const {USD, ...tokensAddressesWithoutUsd} = allTokenAddresses;
  const allReservesAddresses = {
    ETH: MOCK_ETH_ADDRESS,
    ...tokensAddressesWithoutUsd,
  };
  await setInitialMarketRatesInRatesOracle(
    LENDING_RATE_ORACLE_RATES_COMMON,
    allReservesAddresses,
    lendingRateOracle
  );

  const {
    UNI_DAI_ETH,
    UNI_USDC_ETH,
    UNI_SETH_ETH,
    UNI_LINK_ETH,
    UNI_MKR_ETH,
    UNI_LEND_ETH,
    ...protoPoolReservesAddresses
  } = <{[symbol: string]: tEthereumAddress}>allReservesAddresses;

  const reservesParams = getReservesConfigByPool(AavePools.proto);

  await initReserves(
    reservesParams,
    protoPoolReservesAddresses,
    addressesProvider,
    lendingPoolCoreProxy,
    lendingPoolConfiguratorProxy,
    AavePools.proto
  );
  await enableReservesToBorrow(
    reservesParams,
    protoPoolReservesAddresses,
    lendingPoolCoreProxy,
    lendingPoolConfiguratorProxy
  );
  await enableReservesAsCollateral(
    reservesParams,
    protoPoolReservesAddresses,
    lendingPoolCoreProxy,
    lendingPoolConfiguratorProxy
  );

  const liquidationManager = await deployLendingPoolLiquidationManager();
  await waitForTx(
    await addressesProvider.setLendingPoolLiquidationManager(
      liquidationManager.address
    )
  );

  const {receivers, percentages} = getFeeDistributionParamsCommon(
    lendingPoolManager
  );

  await deployMockOneSplit(tokensAddressesWithoutUsd.LEND);
  const oneSplitAdapter = await deployOneSplitAdapter();
  const tokenDistributorImpl = await deployTokenDistributor();
  const tokenDistributorProxy = await deployInitializableAdminUpgradeabilityProxy();
  const implementationParams = tokenDistributorImpl.interface.functions.initialize.encode(
    [
      ZERO_ADDRESS,
      tokensAddressesWithoutUsd.LEND,
      oneSplitAdapter.address,
      receivers,
      percentages,
      Object.values(tokensAddressesWithoutUsd),
    ]
  );
  await waitForTx(
    await tokenDistributorProxy.initialize(
      tokenDistributorImpl.address,
      await secondaryWallet.getAddress(),
      implementationParams
    )
  );
  await waitForTx(
    await addressesProvider.setTokenDistributor(tokenDistributorProxy.address)
  );

  await insertContractAddressInDb(
    eContractid.TokenDistributor,
    tokenDistributorProxy.address
  );

  const mockFlashLoanReceiver = await deployMockFlashLoanReceiver(
    addressesProvider.address
  );
  await insertContractAddressInDb(
    eContractid.MockFlashLoanReceiver,
    mockFlashLoanReceiver.address
  );

  await deployWalletBalancerProvider(addressesProvider.address);

  const testHelpers = await deployAaveProtocolTestHelpers(
    addressesProvider.address
  );

  await insertContractAddressInDb(
    eContractid.AaveProtocolTestHelpers,
    testHelpers.address
  );

  console.timeEnd("setup");
};

before(async () => {
  await rawBRE.run("set-bre");
  const [deployer, secondaryWallet] = await getEthersSigners();
  console.log("-> Deploying test environment...");
  await buildTestEnv(deployer, secondaryWallet);
  console.log("\n***************");
  console.log("Setup and snapshot finished");
  console.log("***************\n");
});