[WIP] Remove mAPT dependence from Index Token

contracts/index/IFeePool.sol → contracts/index/IFeeVault.sol

@@ -2,9 +2,9 @@
 pragma solidity 0.6.11;
 
 /**
- * @notice For pools that can charge an early withdraw fee
+ * @notice For vaults that can charge an early withdraw fee
  */
-interface IFeePool {
+interface IFeeVault {
     /**
      * @notice Log when the arbitrage fee period changes
      * @param arbitrageFeePeriod The new period

contracts/index/ILockingPool.sol → contracts/index/ILockingVault.sol

@@ -2,9 +2,9 @@
 pragma solidity 0.6.11;
 
 /**
- * @notice For pools that can be locked and unlocked in emergencies
+ * @notice For vaults that can be locked and unlocked in emergencies
  */
-interface ILockingPool {
+interface ILockingVault {
     /** @notice Log when deposits are locked */
     event DepositLocked();
 

contracts/index/IReservePool.sol

@@ -2,9 +2,9 @@
 pragma solidity 0.6.11;
 
 /**
- * @notice For pools that keep a separate reserve of tokens
+ * @notice For vaults that keep a separate reserve of tokens
  */
-interface IReservePool {
+interface IReserveVault {
     /**
      * @notice Log when the percent held in reserve is changed
      * @param reservePercentage The new percent held in reserve
@@ -19,7 +19,7 @@ interface IReservePool {
 
     /**
      * @notice Transfer an amount of tokens to the LP Account
-     * @dev This should only be callable by the `MetaPoolToken`
+     * @dev This should only be callable by the `LpAccountFunder`
      * @param amount The amount of tokens
      */
     function transferToLpAccount(uint256 amount) external;

contracts/index/IReserveVault.sol

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: BUSDL-1.1
+pragma solidity 0.6.11;
+
+/**
+ * @notice For vaults that keep a separate reserve of tokens
+ */
+interface IReserveVault {
+    /**
+     * @notice Log when the percent held in reserve is changed
+     * @param reservePercentage The new percent held in reserve
+     */
+    event ReservePercentageChanged(uint256 reservePercentage);
+
+    /**
+     * @notice Set a new percent of tokens to hold in reserve
+     * @param reservePercentage_ The new percent
+     */
+    function setReservePercentage(uint256 reservePercentage_) external;
+
+    /**
+     * @notice Transfer an amount of tokens to the LP Account
+     * @dev This should only be callable by the `LpAccountFunder`
+     * @param amount The amount of tokens
+     */
+    function transferToLpAccount(uint256 amount) external;
+
+    /**
+     * @notice Get the amount of tokens missing from the reserve
+     * @dev A negative amount indicates extra tokens not needed for the reserve
+     * @return The amount of missing tokens
+     */
+    function getReserveTopUpValue() external view returns (int256);
+
+    /**
+     * @notice Get the current percentage of tokens held in reserve
+     * @return The percent
+     */
+    function reservePercentage() external view returns (uint256);
+}

contracts/index/Imports.sol

@@ -2,6 +2,6 @@
 pragma solidity 0.6.11;
 
 import {IERC4626} from "./IERC4626.sol";
-import {IFeePool} from "./IFeePool.sol";
-import {ILockingPool} from "./ILockingPool.sol";
-import {IReservePool} from "./IReservePool.sol";
+import {IFeeVault} from "./IFeeVault.sol";
+import {ILockingVault} from "./ILockingVault.sol";
+import {IReserveVault} from "./IReserveVault.sol";