BIP-34: Sunrise Improvements

.gitignore

@@ -9,14 +9,22 @@ temp
 .env
 archived
 .vscode
+
+# Diamond Cut Outputs
 diamondCut-*.json
 
+#Open Zeppelin Local Config
+.openzeppelin/unknown-1337.json
+
 #Editors
 .idea/
 
 # Foundry
 cache/
 out/
+coverage_data/
+protocol/remappings.txt
+.gas-snapshot
 
 # From SDK Monorepo Join:
 node_modules

.gitmodules

@@ -1,3 +1,9 @@
 [submodule "protocol/lib/forge-std"]
 	path = protocol/lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
+[submodule "protocol/lib/prb-math"]
+	path = protocol/lib/prb-math
+	url = https://github.com/paulrberg/prb-math
+[submodule "protocol/lib/solmate"]
+	path = protocol/lib/solmate
+	url = https://github.com/transmissions11/solmate

protocol/contracts/C.sol

@@ -1,6 +1,4 @@
-/*
- SPDX-License-Identifier: MIT
-*/
+// SPDX-License-Identifier: MIT
 
 pragma solidity =0.7.6;
 pragma experimental ABIEncoderV2;
@@ -12,62 +10,53 @@ import "./interfaces/IProxyAdmin.sol";
 import "./libraries/Decimal.sol";
 
 /**
+ * @title C
  * @author Publius
- * @title C holds the contracts for Beanstalk.
-**/
+ * @notice Contains constants used throughout Beanstalk.
+ */
 library C {
-
     using Decimal for Decimal.D256;
     using SafeMath for uint256;
 
-    // Constants
-    uint256 private constant PERCENT_BASE = 1e18;
-    uint256 private constant PRECISION = 1e18;
+    //////////////////// Globals ////////////////////
+
+    uint256 internal constant PRECISION = 1e18;
+    uint256 private constant CHAIN_ID = 1;
+
+    /// @dev The block time for the chain in seconds.
+    uint256 internal constant BLOCK_LENGTH_SECONDS = 12;
 
-    // Chain
-    uint256 private constant CHAIN_ID = 1; // Mainnet
+    //////////////////// Season ////////////////////
 
-    // Season
+    /// @dev The length of a Season meaured in seconds.
     uint256 private constant CURRENT_SEASON_PERIOD = 3600; // 1 hour
-    uint256 private constant BASE_ADVANCE_INCENTIVE = 25e6; // 25 beans
-    uint256 private constant SOP_PRECISION = 1e24;
-
-    // Sun
-    uint256 private constant FERTILIZER_DENOMINATOR = 3;
-    uint256 private constant HARVEST_DENOMINATOR = 2;
-    uint256 private constant SOIL_COEFFICIENT_HIGH = 0.5e18;
-    uint256 private constant SOIL_COEFFICIENT_LOW = 1.5e18;
-
-    // Weather
-    uint256 private constant POD_RATE_LOWER_BOUND = 0.05e18; // 5%
-    uint256 private constant OPTIMAL_POD_RATE = 0.15e18; // 15%
-    uint256 private constant POD_RATE_UPPER_BOUND = 0.25e18; // 25%
-    uint32 private constant STEADY_SOW_TIME = 60; // 1 minute
-
-    uint256 private constant DELTA_POD_DEMAND_LOWER_BOUND = 0.95e18; // 95%
-    uint256 private constant DELTA_POD_DEMAND_UPPER_BOUND = 1.05e18; // 105%
-
-    // Silo
-    uint256 private constant SEEDS_PER_BEAN = 2;
-    uint256 private constant STALK_PER_BEAN = 10000;
+    uint256 internal constant SOP_PRECISION = 1e24;
+
+    //////////////////// Silo ////////////////////
+
+    uint256 internal constant SEEDS_PER_BEAN = 2;
+    uint256 internal constant STALK_PER_BEAN = 10000;
     uint256 private constant ROOTS_BASE = 1e12;
 
+    //////////////////// Exploit Migration ////////////////////
 
-    // Exploit
     uint256 private constant UNRIPE_LP_PER_DOLLAR = 1884592; // 145_113_507_403_282 / 77_000_000
     uint256 private constant ADD_LP_RATIO = 866616;
-    uint256 private constant INITIAL_HAIRCUT = 185564685220298701; // SET
+    uint256 private constant INITIAL_HAIRCUT = 185564685220298701;
+
+    //////////////////// Contracts ////////////////////
+
+    address internal constant BEAN = 0xBEA0000029AD1c77D3d5D23Ba2D8893dB9d1Efab;
+    address internal constant CURVE_BEAN_METAPOOL = 0xc9C32cd16Bf7eFB85Ff14e0c8603cc90F6F2eE49;
+
+    address internal constant UNRIPE_BEAN = 0x1BEA0050E63e05FBb5D8BA2f10cf5800B6224449;
+    address internal constant UNRIPE_LP = 0x1BEA3CcD22F4EBd3d37d731BA31Eeca95713716D;
 
-    // Contracts
-    address private constant BEAN = 0xBEA0000029AD1c77D3d5D23Ba2D8893dB9d1Efab;
-    address private constant CURVE_BEAN_METAPOOL = 0xc9C32cd16Bf7eFB85Ff14e0c8603cc90F6F2eE49;
     address private constant CURVE_3_POOL = 0xbEbc44782C7dB0a1A60Cb6fe97d0b483032FF1C7;
     address private constant THREE_CRV = 0x6c3F90f043a72FA612cbac8115EE7e52BDe6E490;
-    address private constant UNRIPE_BEAN = 0x1BEA0050E63e05FBb5D8BA2f10cf5800B6224449;
-    address private constant UNRIPE_LP = 0x1BEA3CcD22F4EBd3d37d731BA31Eeca95713716D;
+
     address private constant FERTILIZER = 0x402c84De2Ce49aF88f5e2eF3710ff89bFED36cB6;
     address private constant FERTILIZER_ADMIN = 0xfECB01359263C12Aa9eD838F878A596F0064aa6e;
-    address private constant USDC = 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48;
 
     address private constant TRI_CRYPTO = 0xc4AD29ba4B3c580e6D59105FFf484999997675Ff;
     address private constant TRI_CRYPTO_POOL = 0xD51a44d3FaE010294C616388b506AcdA1bfAAE46;
@@ -76,54 +65,25 @@ library C {
     address private constant UNRIPE_CURVE_BEAN_LUSD_POOL = 0xD652c40fBb3f06d6B58Cb9aa9CFF063eE63d465D;
     address private constant UNRIPE_CURVE_BEAN_METAPOOL = 0x3a70DfA7d2262988064A2D051dd47521E43c9BdD;
 
-    /**
-     * Getters
-    **/
+    address internal constant USDC = 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48;
+    address internal constant WETH = 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2;
+    address internal constant UNIV3_ETH_USDC_POOL = 0x8ad599c3A0ff1De082011EFDDc58f1908eb6e6D8;
+
+    // Use external contract for block.basefee as to avoid upgrading existing contracts to solidity v8
+    address private constant BASE_FEE_CONTRACT = 0x84292919cB64b590C0131550483707E43Ef223aC;
 
     function getSeasonPeriod() internal pure returns (uint256) {
         return CURRENT_SEASON_PERIOD;
     }
 
-    function getAdvanceIncentive() internal pure returns (uint256) {
-        return BASE_ADVANCE_INCENTIVE;
-    }
-
-    function getFertilizerDenominator() internal pure returns (uint256) {
-        return FERTILIZER_DENOMINATOR;
-    }
-
-    function getHarvestDenominator() internal pure returns (uint256) {
-        return HARVEST_DENOMINATOR;
+    function getBlockLengthSeconds() internal pure returns (uint256) {
+        return BLOCK_LENGTH_SECONDS;
     }
 
     function getChainId() internal pure returns (uint256) {
         return CHAIN_ID;
     }
 
-    function getOptimalPodRate() internal pure returns (Decimal.D256 memory) {
-        return Decimal.ratio(OPTIMAL_POD_RATE, PERCENT_BASE);
-    }
-
-    function getUpperBoundPodRate() internal pure returns (Decimal.D256 memory) {
-        return Decimal.ratio(POD_RATE_UPPER_BOUND, PERCENT_BASE);
-    }
-
-    function getLowerBoundPodRate() internal pure returns (Decimal.D256 memory) {
-        return Decimal.ratio(POD_RATE_LOWER_BOUND, PERCENT_BASE);
-    }
-
-    function getUpperBoundDPD() internal pure returns (Decimal.D256 memory) {
-        return Decimal.ratio(DELTA_POD_DEMAND_UPPER_BOUND, PERCENT_BASE);
-    }
-
-    function getLowerBoundDPD() internal pure returns (Decimal.D256 memory) {
-        return Decimal.ratio(DELTA_POD_DEMAND_LOWER_BOUND, PERCENT_BASE);
-    }
-
-    function getSteadySowTime() internal pure returns (uint32) {
-        return STEADY_SOW_TIME;
-    }
-
     function getSeedsPerBean() internal pure returns (uint256) {
         return SEEDS_PER_BEAN;
     }
@@ -136,18 +96,6 @@ library C {
         return ROOTS_BASE;
     }
 
-    function getSopPrecision() internal pure returns (uint256) {
-        return SOP_PRECISION;
-    }
-
-    function beanAddress() internal pure returns (address) {
-        return BEAN;
-    }
-
-    function curveMetapoolAddress() internal pure returns (address) {
-        return CURVE_BEAN_METAPOOL;
-    }
-
     function unripeLPPool1() internal pure returns (address) {
         return UNRIPE_CURVE_BEAN_METAPOOL;
     }
@@ -156,14 +104,6 @@ library C {
         return UNRIPE_CURVE_BEAN_LUSD_POOL;
     }
 
-    function unripeBeanAddress() internal pure returns (address) {
-        return UNRIPE_BEAN;
-    }
-
-    function unripeLPAddress() internal pure returns (address) {
-        return UNRIPE_LP;
-    }
-
     function unripeBean() internal pure returns (IERC20) {
         return IERC20(UNRIPE_BEAN);
     }
@@ -204,6 +144,10 @@ library C {
         return IERC20(THREE_CRV);
     }
 
+    function UniV3EthUsdc() internal pure returns (address){
+        return UNIV3_ETH_USDC_POOL;
+    }
+
     function fertilizer() internal pure returns (IFertilizer) {
         return IFertilizer(FERTILIZER);
     }
@@ -244,11 +188,4 @@ library C {
         return INITIAL_HAIRCUT;
     }
 
-    function soilCoefficientHigh() internal pure returns (uint256) {
-        return SOIL_COEFFICIENT_HIGH;
-    }
-
-    function soilCoefficientLow() internal pure returns (uint256) {
-        return SOIL_COEFFICIENT_LOW;
-    }
-}
+}