BIP-38: Migrate urBEAN3CRV to urBEANETH

protocol/abi/Beanstalk.json

@@ -99,6 +99,25 @@
     "name": "Pick",
     "type": "event"
   },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "token",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "underlyingToken",
+        "type": "address"
+      }
+    ],
+    "name": "SwitchUnderlyingToken",
+    "type": "event"
+  },
   {
     "inputs": [
       {
@@ -128,6 +147,24 @@
     "stateMutability": "view",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "unripeToken",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "addMigratedUnderlying",
+    "outputs": [],
+    "stateMutability": "payable",
+    "type": "function"
+  },
   {
     "inputs": [
       {
@@ -480,46 +517,41 @@
     "type": "function"
   },
   {
-    "anonymous": false,
     "inputs": [
       {
-        "indexed": false,
-        "internalType": "uint128",
-        "name": "id",
-        "type": "uint128"
+        "internalType": "address",
+        "name": "unripeToken",
+        "type": "address"
       },
       {
-        "indexed": false,
-        "internalType": "uint128",
-        "name": "bpf",
-        "type": "uint128"
+        "internalType": "address",
+        "name": "newUnderlyingToken",
+        "type": "address"
       }
     ],
-    "name": "SetFertilizer",
-    "type": "event"
+    "name": "switchUnderlyingToken",
+    "outputs": [],
+    "stateMutability": "payable",
+    "type": "function"
   },
   {
+    "anonymous": false,
     "inputs": [
       {
+        "indexed": false,
         "internalType": "uint128",
         "name": "id",
         "type": "uint128"
       },
       {
+        "indexed": false,
         "internalType": "uint128",
-        "name": "amount",
+        "name": "bpf",
         "type": "uint128"
-      },
-      {
-        "internalType": "uint256",
-        "name": "minLP",
-        "type": "uint256"
       }
     ],
-    "name": "addFertilizerOwner",
-    "outputs": [],
-    "stateMutability": "payable",
-    "type": "function"
+    "name": "SetFertilizer",
+    "type": "event"
   },
   {
     "inputs": [
@@ -800,6 +832,25 @@
     "stateMutability": "view",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "uint256",
+        "name": "wethAmountIn",
+        "type": "uint256"
+      }
+    ],
+    "name": "getMintFertilizerOut",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "fertilizerAmountOut",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [
       {
@@ -835,13 +886,18 @@
   {
     "inputs": [
       {
-        "internalType": "uint128",
-        "name": "amount",
-        "type": "uint128"
+        "internalType": "uint256",
+        "name": "wethAmountIn",
+        "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "minLP",
+        "name": "minFertilizerOut",
+        "type": "uint256"
+      },
+      {
+        "internalType": "uint256",
+        "name": "minLPTokensOut",
         "type": "uint256"
       },
       {
@@ -851,7 +907,13 @@
       }
     ],
     "name": "mintFertilizer",
-    "outputs": [],
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "fertilizerAmountOut",
+        "type": "uint256"
+      }
+    ],
     "stateMutability": "payable",
     "type": "function"
   },
@@ -4358,6 +4420,25 @@
     "stateMutability": "payable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "token",
+        "type": "address"
+      }
+    ],
+    "name": "totalMigratedBdv",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "anonymous": false,
     "inputs": [

protocol/contracts/C.sol

@@ -78,8 +78,8 @@ library C {
     //////////////////// Well ////////////////////
 
     uint256 internal constant WELL_MINIMUM_BEAN_BALANCE = 1000_000_000; // 1,000 Beans
-    address constant internal BEANSTALK_PUMP = 0xBA510f10E3095B83a0F33aa9ad2544E22570a87C;
-    address constant BEAN_ETH_WELL = 0xBEA0e11282e2bB5893bEcE110cF199501e872bAd;
+    address internal constant BEANSTALK_PUMP = 0xBA510f10E3095B83a0F33aa9ad2544E22570a87C;
+    address internal constant BEAN_ETH_WELL = 0xBEA0e11282e2bB5893bEcE110cF199501e872bAd;
 
     function getSeasonPeriod() internal pure returns (uint256) {
         return CURRENT_SEASON_PERIOD;

protocol/contracts/beanstalk/AppStorage.sol

@@ -487,6 +487,7 @@ contract Storage {
  * @param ownerCandidate Stores a candidate address to transfer ownership to. The owner must claim the ownership transfer.
  * @param wellOracleSnapshots A mapping from Well Oracle address to the Well Oracle Snapshot.
  * @param beanEthPrice Stores the beanEthPrice during the sunrise() function. Returns 1 otherwise.
+ * @param migratedBdvs Stores the total migrated BDV since the implementation of the migrated BDV counter. See {LibLegacyTokenSilo.incrementMigratedBdv} for more info.
  */
 struct AppStorage {
     uint8 deprecated_index;
@@ -547,4 +548,7 @@ struct AppStorage {
     // Well
     mapping(address => bytes) wellOracleSnapshots;
     uint256 beanEthPrice;
+
+    // Silo V3 BDV Migration
+    mapping(address => uint256) migratedBdvs;
 }

protocol/contracts/beanstalk/barn/FertilizerFacet.sol

@@ -5,30 +5,45 @@
 pragma solidity ^0.7.6;
 pragma experimental ABIEncoderV2;
 
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {SafeCast} from "@openzeppelin/contracts/utils/SafeCast.sol";
+import {SafeMath} from "@openzeppelin/contracts/math/SafeMath.sol";
+import {IFertilizer} from "contracts/interfaces/IFertilizer.sol";
 import {AppStorage} from "../AppStorage.sol";
-import "contracts/libraries/Token/LibTransfer.sol";
-import "contracts/libraries/LibFertilizer.sol";
-import "contracts/C.sol";
+import {LibTransfer} from "contracts/libraries/Token/LibTransfer.sol";
+import {LibEthUsdOracle} from "contracts/libraries/Oracle/LibEthUsdOracle.sol";
+import {LibFertilizer} from "contracts/libraries/LibFertilizer.sol";
+import {LibSafeMath128} from "contracts/libraries/LibSafeMath128.sol";
+import {C} from "contracts/C.sol";
 import {LibDiamond} from "contracts/libraries/LibDiamond.sol";
 
 /**
  * @author Publius
- * @title Handles Sprouting Beans from Sprout Tokens
+ * @title FertilizerFacet handles Minting Fertilizer and Rinsing Sprouts earned from Fertilizer.
  **/
 
 contract FertilizerFacet {
     using SafeMath for uint256;
+    using SafeCast for uint256;
     using LibSafeMath128 for uint128;
 
     event SetFertilizer(uint128 id, uint128 bpf);
 
+    uint256 private constant FERTILIZER_AMOUNT_PRECISION = 1e24;
+
     AppStorage internal s;
 
     struct Supply {
         uint128 endBpf;
         uint256 supply;
     }
 
+
+    /**
+     * @notice Rinses Rinsable Sprouts earned from Fertilizer.
+     * @param ids The ids of the Fertilizer to rinse.
+     * @param mode The balance to transfer Beans to; see {LibTrasfer.To}
+     */
     function claimFertilized(uint256[] calldata ids, LibTransfer.To mode)
         external
         payable
@@ -37,41 +52,49 @@ contract FertilizerFacet {
         LibTransfer.sendToken(C.bean(), amount, msg.sender, mode);
     }
 
+    /**
+     * @notice Purchase Fertilizer from the Barn Raise with WETH.
+     * @param wethAmountIn Amount of WETH to buy Fertilizer with 18 decimal precision.
+     * @param minFertilizerOut The minimum amount of Fertilizer to purchase. Protects against a significant ETH/USD price decrease.
+     * @param minLPTokensOut The minimum amount of LP tokens to receive after adding liquidity with `weth`.
+     * @param mode The balance to transfer Beans to; see {LibTrasfer.To}
+     * @dev The # of Fertilizer minted is equal to the value of the Ether paid in USD.
+     */
     function mintFertilizer(
-        uint128 amount,
-        uint256 minLP,
+        uint256 wethAmountIn,
+        uint256 minFertilizerOut,
+        uint256 minLPTokensOut,
         LibTransfer.From mode
-    ) external payable {
-        uint128 remaining = uint128(LibFertilizer.remainingRecapitalization().div(1e6)); // remaining <= 77_000_000 so downcasting is safe.
-        if (amount > remaining) amount = remaining;
-        amount = uint128(LibTransfer.receiveToken(
-            C.usdc(),
-            uint256(amount).mul(1e6),
+    ) external payable returns (uint256 fertilizerAmountOut) {
+        // Transfer the WETH directly to the Well for gas efficiency purposes. The WETH is later synced in {LibFertilizer.addUnderlying}.
+        wethAmountIn = LibTransfer.transferToken(
+            IERC20(C.WETH),
             msg.sender,
-            mode
-        ).div(1e6)); // return value <= amount, so downcasting is safe.
-        uint128 id = LibFertilizer.addFertilizer(
-            uint128(s.season.current),
-            amount,
-            minLP
+            C.BEAN_ETH_WELL,
+            uint256(wethAmountIn),
+            mode,
+            LibTransfer.To.EXTERNAL
         );
-        C.fertilizer().beanstalkMint(msg.sender, uint256(id), amount, s.bpf);
-    }
 
-    function addFertilizerOwner(
-        uint128 id,
-        uint128 amount,
-        uint256 minLP
-    ) external payable {
-        LibDiamond.enforceIsContractOwner();
-        C.usdc().transferFrom(
-            msg.sender,
-            address(this),
-            uint256(amount).mul(1e6)
+        fertilizerAmountOut = getMintFertilizerOut(wethAmountIn);
+
+        require(fertilizerAmountOut >= minFertilizerOut, "Fertilizer: Not enough bought.");
+        require(fertilizerAmountOut > 0, "Fertilizer: None bought.");
+
+        uint128 remaining = uint128(LibFertilizer.remainingRecapitalization().div(1e6)); // remaining <= 77_000_000 so downcasting is safe.
+        require(fertilizerAmountOut <= remaining, "Fertilizer: Not enough remaining.");
+
+        uint128 id = LibFertilizer.addFertilizer(
+            uint128(s.season.current),
+            fertilizerAmountOut,
+            minLPTokensOut
         );
-        LibFertilizer.addFertilizer(id, amount, minLP);
+        C.fertilizer().beanstalkMint(msg.sender, uint256(id), (fertilizerAmountOut).toUint128(), s.bpf);
     }
 
+    /**
+     * @dev Callback from Fertilizer contract in `claimFertilized` function.
+     */
     function payFertilizer(address account, uint256 amount) external payable {
         require(msg.sender == C.fertilizerAddress());
         LibTransfer.sendToken(
@@ -82,6 +105,19 @@ contract FertilizerFacet {
         );
     }
 
+    /**
+     * @dev Returns the amount of Fertilizer that can be purchased with `wethAmountIn` WETH.
+     * Can be used to help calculate `minFertilizerOut` in `mintFertilizer`.
+     * `wethAmountIn` has 18 decimals, `getEthUsdPrice()` has 6 decimals and `fertilizerAmountOut` has 0 decimals.
+     */
+    function getMintFertilizerOut(
+        uint256 wethAmountIn
+    ) public view returns (uint256 fertilizerAmountOut) {
+        fertilizerAmountOut = wethAmountIn.mul(
+            LibEthUsdOracle.getEthUsdPrice()
+        ).div(FERTILIZER_AMOUNT_PRECISION);
+    }
+
     function totalFertilizedBeans() external view returns (uint256 beans) {
         return s.fertilizedIndex;
     }