@harvest-finance/harvest-strategy-polygon 0.0.1-security → 1.0.0

package/test/utilities/Utils.js

@@ -0,0 +1,96 @@
+const BigNumber = require('bignumber.js');
+const { time } = require("@openzeppelin/test-helpers");
+BigNumber.config({DECIMAL_PLACES: 0});
+
+let gasLogger = {};
+let gasLoggerNum = {};
+
+async function gasLog(logTo, targetPromise) {
+  let tx = await targetPromise;
+  gasUsed = tx.receipt.gasUsed;
+
+  if(gasLogger[logTo] == undefined) {
+    gasLogger[logTo] = gasUsed;
+    gasLoggerNum[logTo] = 1;
+  }
+  else {
+    gasLogger[logTo] = (gasLogger[logTo])/(gasLoggerNum[logTo]+1) + gasUsed/(gasLoggerNum[logTo]+1);
+    gasLoggerNum[logTo]++;
+  }
+}
+
+async function printGasLog() {
+  console.log(gasLogger);
+}
+
+async function advanceNBlock (n) {
+  let startingBlock = await time.latestBlock();
+  await time.increase(2.3 * Math.round(n));
+  let endBlock = startingBlock.addn(n);
+  await time.advanceBlockTo(endBlock);
+}
+async function waitHours (n) {
+  await time.increase(n * 3600 + 1);
+  let startingBlock = await time.latestBlock();
+  await time.advanceBlockTo(startingBlock.addn(1));
+};
+
+async function waitTime (n) {
+  await time.increase(n);
+  let startingBlock = await time.latestBlock();
+  await time.advanceBlockTo(startingBlock.addn(1));
+};
+
+function assertBNEq(a, b){
+  let _a = new BigNumber(a);
+  let _b = new BigNumber(b);
+  let msg = _a.toFixed() + " != " + _b.toFixed();
+  assert.equal(_a.eq(_b), true, msg);
+}
+
+function assertApproxBNEq(a, b, c){
+  let _a = new BigNumber(a).div(c);
+  let _b = new BigNumber(b).div(c);
+  let msg = _a.toFixed() + " != " + _b.toFixed();
+  assert.equal(_a.eq(_b), true, msg);
+}
+
+function assertBNGt(a, b){
+  let _a = new BigNumber(a);
+  let _b = new BigNumber(b);
+  let msg = _a.toFixed() + " is not greater than " + _b.toFixed();
+  assert.equal(_a.gt(_b), true, msg);
+}
+
+function assertBNGte(a, b){
+  let _a = new BigNumber(a);
+  let _b = new BigNumber(b);
+  let msg = _a.toFixed() + " is not greater than " + _b.toFixed();
+  assert.equal(_a.gte(_b), true, msg);
+}
+
+function assertNEqBN(a, b){
+  let _a = new BigNumber(a);
+  let _b = new BigNumber(b);
+  assert.equal(_a.eq(_b), false);
+}
+
+async function inBNfixed(a) {
+  return await (new BigNumber(a)).toFixed();
+}
+
+module.exports = {
+  gasLogger,
+  gasLoggerNum,
+  gasLog,
+  printGasLog,
+  advanceNBlock,
+  assertBNEq,
+  assertApproxBNEq,
+  assertBNGt,
+  assertNEqBN,
+  inBNfixed,
+  waitHours,
+  waitTime,
+  assertBNGte,
+};

package/test/utilities/hh-utils.js

@@ -0,0 +1,242 @@
+const makeVault = require("./make-vault.js");
+const addresses = require("../test-config.js");
+const IController = artifacts.require("IControllerV2");
+const IRewardForwarder = artifacts.require("IRewardForwarder");
+const IUniswapRouterV2 = artifacts.require("contracts/base/interface/uniswap/IUniswapV2Router02.sol:IUniswapV2Router02");
+const IERC20 = artifacts.require("IERC20");
+const Vault = artifacts.require("VaultV2");
+const WMATIC = artifacts.require("WMATIC")
+const IUpgradeableStrategy = artifacts.require("IUpgradeableStrategy");
+const ILiquidatorRegistry = artifacts.require("IUniversalLiquidatorRegistry");
+
+const Utils = require("./Utils.js");
+
+async function impersonates(targetAccounts){
+  console.log("Impersonating...");
+  for(i = 0; i < targetAccounts.length ; i++){
+    console.log(targetAccounts[i]);
+    await hre.network.provider.request({
+      method: "hardhat_impersonateAccount",
+      params: [
+        targetAccounts[i]
+      ]
+    });
+  }
+}
+
+async function setupCoreProtocol(config) {
+  // Set vault (or Deploy new vault), underlying, underlying Whale,
+  // amount the underlying whale should send to farmers
+  if(config.existingVaultAddress != null){
+    vault = await Vault.at(config.existingVaultAddress);
+    console.log("Fetching Vault at: ", vault.address);
+  } else {
+    const implAddress = config.vaultImplementationOverride || addresses.VaultImplementationV2;
+    vault = await makeVault(implAddress, addresses.Storage, config.underlying.address, 100, 100, {
+      from: config.governance,
+    });
+    console.log("New Vault Deployed: ", vault.address);
+  }
+
+  controller = await IController.at(addresses.Controller);
+  feeRewardForwarder = await IRewardForwarder.at(await controller.rewardForwarder());
+
+
+  if (config.feeRewardForwarder) {/*
+    const FeeRewardForwarder = artifacts.require("FeeRewardForwarder");
+    const feeRewardForwarder = await FeeRewardForwarder.new(
+      addresses.Storage,
+      addresses.FARM,
+      addresses.miFARM,
+      addresses.UniversalLiquidatorRegistry
+    );
+
+    config.feeRewardForwarder = feeRewardForwarder.address;*/
+    console.log("Setting up a custom fee reward forwarder...");
+    await controller.setFeeRewardForwarder(
+      config.feeRewardForwarder,
+      { from: config.governance }
+    );
+
+    const NoMintRewardPool = artifacts.require("NoMintRewardPool");
+    const farmRewardPool = await NoMintRewardPool.at("0x8f5adC58b32D4e5Ca02EAC0E293D35855999436C");
+    await farmRewardPool.setRewardDistribution(config.feeRewardForwarder, {from: config.governance});
+
+    console.log("Done setting up fee reward forwarder!");
+  }
+
+  let rewardPool = null;
+
+  if (!config.rewardPoolConfig) {
+    config.rewardPoolConfig = {};
+  }
+  // if reward pool is required, then deploy it
+  if(config.rewardPool != null && config.existingRewardPoolAddress == null) {
+    const rewardTokens = config.rewardPoolConfig.rewardTokens || [addresses.FARM];
+    const rewardDistributions = [config.governance];
+    if (config.feeRewardForwarder) {
+      rewardDistributions.push(config.feeRewardForwarder);
+    }
+
+    if (config.rewardPoolConfig.type === 'PotPool') {
+      const PotPool = artifacts.require("PotPool");
+      console.log("reward pool needs to be deployed");
+      rewardPool = await PotPool.new(
+        rewardTokens,
+        vault.address,
+        64800,
+        rewardDistributions,
+        addresses.Storage,
+        "fPool",
+        "fPool",
+        18,
+        {from: config.governance }
+      );
+      console.log("New PotPool deployed: ", rewardPool.address);
+    } else {
+      const NoMintRewardPool = artifacts.require("NoMintRewardPool");
+      console.log("reward pool needs to be deployed");
+      rewardPool = await NoMintRewardPool.new(
+        rewardTokens[0],
+        vault.address,
+        64800,
+        rewardDistributions,
+        addresses.Storage,
+        "0x0000000000000000000000000000000000000000",
+        "0x0000000000000000000000000000000000000000",
+        {from: config.governance }
+      );
+      console.log("New NoMintRewardPool deployed: ", rewardPool.address);
+    }
+  } else if(config.existingRewardPoolAddress != null) {
+    const PotPool = artifacts.require("PotPool");
+    rewardPool = await PotPool.at(config.existingRewardPoolAddress);
+    console.log("Fetching Reward Pool deployed: ", rewardPool.address);
+  }
+
+  // default arguments are storage and vault addresses
+  config.strategyArgs = config.strategyArgs || [
+    addresses.Storage,
+    vault.address
+  ];
+
+  for(i = 0; i < config.strategyArgs.length ; i++){
+    if(config.strategyArgs[i] == "storageAddr") {
+      config.strategyArgs[i] = addresses.Storage;
+    } else if(config.strategyArgs[i] == "vaultAddr") {
+      config.strategyArgs[i] = vault.address;
+    } else if(config.strategyArgs[i] == "poolAddr" ){
+      config.strategyArgs[i] = rewardPool.address;
+    } else if(config.strategyArgs[i] == "universalLiquidatorRegistryAddr"){
+      config.strategyArgs[i] = universalLiquidatorRegistry.address;
+    }
+  }
+
+  let strategyImpl = null;
+
+  if (!config.strategyArtifactIsUpgradable) {
+    strategy = await config.strategyArtifact.new(
+      ...config.strategyArgs,
+      { from: config.governance }
+    );
+  } else {
+    strategyImpl = await config.strategyArtifact.new();
+    const StrategyProxy = artifacts.require("StrategyProxy");
+
+    const strategyProxy = await StrategyProxy.new(strategyImpl.address);
+    strategy = await config.strategyArtifact.at(strategyProxy.address);
+    await strategy.initializeStrategy(
+      ...config.strategyArgs,
+      { from: config.governance }
+    );
+  }
+
+  console.log("Strategy Deployed: ", strategy.address);
+
+  let universalLiquidatorRegistry = await ILiquidatorRegistry.at(addresses.UniversalLiquidatorRegistry);
+  // set liquidation paths
+  if(config.liquidation) {
+    for (i=0;i<config.liquidation.length;i++) {
+      dex = Object.keys(config.liquidation[i])[0];
+      await universalLiquidatorRegistry.setPath(
+        web3.utils.keccak256(dex),
+        config.liquidation[i][dex],
+        {from: config.ULOwner}
+      );
+    }
+  }
+
+  if (config.announceStrategy === true) {
+    // Announce switch, time pass, switch to strategy
+    await vault.announceStrategyUpdate(strategy.address, { from: config.governance });
+    console.log("Strategy switch announced. Waiting...");
+    await Utils.waitHours(13);
+    await vault.setStrategy(strategy.address, { from: config.governance });
+    await vault.setVaultFractionToInvest(100, 100, { from: config.governance });
+    console.log("Strategy switch completed.");
+  } else if (config.upgradeStrategy === true) {
+    // Announce upgrade, time pass, upgrade the strategy
+    const strategyAsUpgradable = await IUpgradeableStrategy.at(await vault.strategy());
+    await strategyAsUpgradable.scheduleUpgrade(strategyImpl.address, { from: config.governance });
+    console.log("Upgrade scheduled. Waiting...");
+    await Utils.waitHours(13);
+    await strategyAsUpgradable.upgrade({ from: config.governance });
+    await vault.setVaultFractionToInvest(100, 100, { from: config.governance });
+    strategy = await config.strategyArtifact.at(await vault.strategy());
+    console.log("Strategy upgrade completed.");
+  } else {
+    await vault.setStrategy(strategy.address, {from: config.governance});
+  }
+
+  return [controller, vault, strategy, rewardPool];
+}
+
+async function depositVault(_farmer, _underlying, _vault, _amount) {
+  await _underlying.approve(_vault.address, _amount, { from: _farmer });
+  await _vault.deposit(_amount, _farmer, { from: _farmer });
+}
+
+async function swapMaticToToken(_farmer, _path, _amountMatic, _router) {
+  router = await IUniswapRouterV2.at(_router);
+
+  await router.swapExactETHForTokens(
+    0,
+    _path,
+    _farmer,
+    Date.now() + 900000,
+    { value:_amountMatic, from: _farmer });
+}
+
+async function wrapMATIC(_farmer, _amount) {
+  wbnb = await WMATIC.at(addresses.WMATIC);
+  await wbnb.deposit({value:_amount, from:_farmer});
+}
+
+async function addLiquidity(_farmer, _token0, _token1, _amount0, _amount1, _router) {
+  router = await IUniswapRouterV2.at(_router);
+  if (_token0 == "Matic") {
+    wrapMATIC(_farmer, _amount0);
+    _token0 = await IERC20.at(addresses.WMATIC);
+  }
+  await _token0.approve(router.address, _amount0, { from:_farmer});
+  await _token1.approve(router.address, _amount1, { from:_farmer});
+  await router.addLiquidity(
+    _token0.address,
+    _token1.address,
+    _amount0,
+    _amount1,
+    0,
+    0,
+    _farmer,
+    Date.now() + 900000,
+    { from: _farmer });
+}
+
+module.exports = {
+  impersonates,
+  setupCoreProtocol,
+  depositVault,
+  swapMaticToToken,
+  wrapMATIC,
+  addLiquidity
+};

package/test/utilities/make-vault.js

@@ -0,0 +1,10 @@
+const Vault = artifacts.require("VaultERC4626");
+const VaultProxy = artifacts.require("VaultProxy");
+
+module.exports = async function(implementationAddress, ...args) {
+  const fromParameter = args[args.length - 1]; // corresponds to {from: governance}
+  const vaultAsProxy = await VaultProxy.new(implementationAddress, fromParameter);
+  const vault = await Vault.at(vaultAsProxy.address);
+  await vault.initializeVault(...args);
+  return vault;
+};

package/test/yel/yel-wmatic.js

@@ -0,0 +1,129 @@
+// Utilities
+const Utils = require("../utilities/Utils.js");
+const { impersonates, setupCoreProtocol, depositVault } = require("../utilities/hh-utils.js");
+
+const addresses = require("../test-config.js");
+const { send } = require("@openzeppelin/test-helpers");
+const BigNumber = require("bignumber.js");
+const IERC20 = artifacts.require("@openzeppelin/contracts/token/ERC20/IERC20.sol:IERC20");
+
+const Strategy = artifacts.require("YelStrategyMainnet_YEL_WMATIC");
+const FeeRewardForwarder = artifacts.require("FeeRewardForwarder");
+
+//This test was developed at blockNumber 23558000
+
+// Vanilla Mocha test. Increased compatibility with tools that integrate Mocha.
+describe("Mainnet YEL YEL-WMATIC compounding", function() {
+  let accounts;
+
+  // external contracts
+  let underlying;
+
+  // external setup
+  let underlyingWhale = "0x4e5b3043FEB9f939448e2F791a66C4EA65A315a8";
+  let feeForwarderAddr = "0x9A56E4e1845b021FE63EBCE922bD1c31e87eEA5A";
+  let quickRouter = "0xa5E0829CaCEd8fFDD4De3c43696c57F7D7A678ff";
+  let weth = "0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619";
+  let yel = "0xD3b71117E6C1558c1553305b44988cd944e97300";
+  let wmatic = "0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270";
+
+  // parties in the protocol
+  let governance;
+  let farmer1;
+
+  // numbers used in tests
+  let farmerBalance;
+
+  // Core protocol contracts
+  let controller;
+  let vault;
+  let strategy;
+
+  async function setupExternalContracts() {
+    underlying = await IERC20.at("0x8bAb87ECF28Bf45507Bd745bc70532e968b5c2De");
+    console.log("Fetching Underlying at: ", underlying.address);
+  }
+
+  async function setupBalance(){
+    let etherGiver = accounts[9];
+    // Give whale some ether to make sure the following actions are good
+    await web3.eth.sendTransaction({ from: etherGiver, to: underlyingWhale, value: 10e18});
+    await web3.eth.sendTransaction({ from: etherGiver, to: governance, value: 10e18});
+
+    farmerBalance = await underlying.balanceOf(underlyingWhale);
+    await underlying.transfer(farmer1, farmerBalance, { from: underlyingWhale });
+  }
+
+  before(async function() {
+    governance = "0xf00dD244228F51547f0563e60bCa65a30FBF5f7f";
+    accounts = await web3.eth.getAccounts();
+
+    farmer1 = accounts[1];
+
+    // impersonate accounts
+    await impersonates([governance, underlyingWhale]);
+
+    await setupExternalContracts();
+
+    // whale send underlying to farmers
+    await setupBalance();
+
+    [controller, vault, strategy] = await setupCoreProtocol({
+      "existingVaultAddress": null,
+      "strategyArtifact": Strategy,
+      "strategyArtifactIsUpgradable": true,
+      "underlying": underlying,
+      "governance": governance,
+    });
+
+    feeForwarder = await FeeRewardForwarder.at(feeForwarderAddr);
+    let path = [yel, wmatic, weth];
+    let dexes = [quickRouter];
+    await feeForwarder.setConversionPath(path, dexes, { from: governance });
+  });
+
+  describe("Happy path", function() {
+    it("Farmer should earn money", async function() {
+      let farmerOldBalance = new BigNumber(await underlying.balanceOf(farmer1));
+      await depositVault(farmer1, underlying, vault, farmerBalance);
+      let fTokenBalance = await vault.balanceOf(farmer1);
+
+      // Using half days is to simulate how we doHardwork in the real world
+      let hours = 10;
+      let blocksPerHour = 1565;
+      let oldSharePrice;
+      let newSharePrice;
+      for (let i = 0; i < hours; i++) {
+        console.log("loop ", i);
+
+        oldSharePrice = new BigNumber(await vault.getPricePerFullShare());
+        await controller.doHardWork(vault.address, { from: governance });
+        newSharePrice = new BigNumber(await vault.getPricePerFullShare());
+
+        console.log("old shareprice: ", oldSharePrice.toFixed());
+        console.log("new shareprice: ", newSharePrice.toFixed());
+        console.log("growth: ", newSharePrice.toFixed() / oldSharePrice.toFixed());
+
+        apr = (newSharePrice.toFixed()/oldSharePrice.toFixed()-1)*(24/(blocksPerHour/1565))*365;
+        apy = ((newSharePrice.toFixed()/oldSharePrice.toFixed()-1)*(24/(blocksPerHour/1565))+1)**365;
+
+        console.log("instant APR:", apr*100, "%");
+        console.log("instant APY:", (apy-1)*100, "%");
+
+        await Utils.advanceNBlock(blocksPerHour);
+      }
+      await vault.withdraw(fTokenBalance, { from: farmer1 });
+      let farmerNewBalance = new BigNumber(await underlying.balanceOf(farmer1));
+      Utils.assertBNGt(farmerNewBalance, farmerOldBalance);
+
+      apr = (farmerNewBalance.toFixed()/farmerOldBalance.toFixed()-1)*(24/(blocksPerHour*hours/1565))*365;
+      apy = ((farmerNewBalance.toFixed()/farmerOldBalance.toFixed()-1)*(24/(blocksPerHour*hours/1565))+1)**365;
+
+      console.log("earned!");
+      console.log("Overall APR:", apr*100, "%");
+      console.log("Overall APY:", (apy-1)*100, "%");
+
+      await strategy.withdrawAllToVault({ from: governance }); // making sure can withdraw all for a next switch
+    });
+  });
+});