@ensuro/core 1.2.7 → 2.0.0-beta10

package/contracts/BaseAssetManager.sol

@@ -1,301 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.0;
-
-import {WadRayMath} from "./WadRayMath.sol";
-import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import {IPolicyPool} from "../interfaces/IPolicyPool.sol";
-import {PolicyPoolComponent} from "./PolicyPoolComponent.sol";
-import {IAssetManager} from "../interfaces/IAssetManager.sol";
-import {IEToken} from "../interfaces/IEToken.sol";
-import {IPolicyPoolConfig} from "../interfaces/IPolicyPoolConfig.sol";
-import {Policy} from "./Policy.sol";
-import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
-
-/**
- * @title Ensuro Asset Manager base contract
- * @dev Base class for asset managers that reinvest the assets of the protocol to get additional returns.
- *      The specific asset management strategy needs to be implemented by child contracts.
- *      Settings liquidityMin, liquidityMiddle, liquidityMax are the thresholds used to define how much liquidity
- *      to keep in the PolicyPool and when to invest/deinvest. Every invest/deinvest operation tries to leave the
- *      PolicyPool at liquidityMiddle.
- * @custom:security-contact security@ensuro.co
- * @author Ensuro
- */
-abstract contract BaseAssetManager is IAssetManager, PolicyPoolComponent {
-  using WadRayMath for uint256;
-
-  uint256 internal _liquidityMin;
-  uint256 internal _liquidityMiddle;
-  uint256 internal _liquidityMax;
-
-  uint256 internal _lastInvestmentValue;
-
-  event MoneyInvested(uint256 amount);
-  event MoneyDeinvested(uint256 amount);
-  event EarningsDistributed(bool positive, uint256 amount);
-
-  /// @custom:oz-upgrades-unsafe-allow constructor
-  // solhint-disable-next-line no-empty-blocks
-  constructor(IPolicyPool policyPool_) PolicyPoolComponent(policyPool_) {}
-
-  /**
-   * @dev Initializes the asset manager
-   * @param liquidityMin_ Minimal liquidity to keep in pool's wallet
-   * @param liquidityMiddle_ Target liquidity when doing rebalance
-   * @param liquidityMax_ Maximum liquidity to keep in pool's wallet
-   */
-  // solhint-disable-next-line func-name-mixedcase
-  function __BaseAssetManager_init(
-    uint256 liquidityMin_,
-    uint256 liquidityMiddle_,
-    uint256 liquidityMax_
-  ) internal initializer {
-    __PolicyPoolComponent_init();
-    __BaseAssetManager_init_unchained(liquidityMin_, liquidityMiddle_, liquidityMax_);
-  }
-
-  // solhint-disable-next-line func-name-mixedcase
-  function __BaseAssetManager_init_unchained(
-    uint256 liquidityMin_,
-    uint256 liquidityMiddle_,
-    uint256 liquidityMax_
-  ) internal initializer {
-    /*
-    _lastInvestmentValue = 0;
-    */
-    _liquidityMin = liquidityMin_;
-    _liquidityMiddle = liquidityMiddle_;
-    _liquidityMax = liquidityMax_;
-    _validateParameters();
-  }
-
-  function _validateParameters() internal view override {
-    require(
-      _liquidityMin <= _liquidityMiddle && _liquidityMiddle <= _liquidityMax,
-      "Validation: Liquidity limits are invalid"
-    );
-  }
-
-  /**
-   * @dev Returns the total amount that is available to invest by the asset manager
-   */
-  function totalInvestable() public view returns (uint256) {
-    uint256 poolInvestable = _policyPool.getInvestable();
-    uint256 etksInvestable = 0;
-    for (uint256 i = 0; i < _policyPool.getETokenCount(); i++) {
-      IEToken etk = _policyPool.getETokenAt(i);
-      etksInvestable += etk.getInvestable();
-    }
-    return poolInvestable + etksInvestable;
-  }
-
-  /**
-   * @dev Calculates asset earnings and distributes them updating accounting in PolicyPool and eTokens
-   */
-  function distributeEarnings() public virtual whenNotPaused {
-    // TODO Check: Anyone can call this funcion. This could be a potencial surface of flash loan attack?
-    _distributeEarnings(getInvestmentValue());
-  }
-
-  function _distributeEarnings(uint256 investmentValue) internal virtual whenNotPaused {
-    bool positive;
-    uint256 earnings;
-    if (investmentValue > _lastInvestmentValue) {
-      earnings = investmentValue - _lastInvestmentValue;
-      positive = true;
-    } else if (investmentValue < _lastInvestmentValue) {
-      earnings = _lastInvestmentValue - investmentValue;
-      positive = false;
-    } else {
-      return; // No earnings
-    }
-
-    uint256 totalInv = totalInvestable();
-
-    uint256 remaining = earnings;
-    for (uint256 i = 0; i < _policyPool.getETokenCount(); i++) {
-      IEToken etk = _policyPool.getETokenAt(i);
-      uint256 aux = earnings.wadMul(etk.getInvestable().wadDiv(totalInv));
-      if (aux > 0) {
-        etk.assetEarnings(aux, positive);
-        remaining -= aux;
-      }
-    }
-
-    if (remaining > 0) _policyPool.assetEarnings(remaining, positive);
-
-    _lastInvestmentValue = investmentValue;
-    emit EarningsDistributed(positive, earnings);
-  }
-
-  /**
-   * @dev Returns the current value of the investment portfolio
-   */
-  function getInvestmentValue() public view virtual returns (uint256);
-
-  /**
-   * @dev Rebalances cash between PolicyPool wallet and
-   */
-  function rebalance() public virtual whenNotPaused {
-    // TODO Check: Anyone can call this funcion. This could be a potencial surface of flash loan attack?
-    uint256 poolCash = currency().balanceOf(address(_policyPool));
-    if (poolCash > _liquidityMax) {
-      _invest(poolCash - _liquidityMiddle);
-    } else if (poolCash < _liquidityMin) {
-      uint256 deinvestAmount = Math.min(getInvestmentValue(), _liquidityMiddle - poolCash);
-      if (deinvestAmount > 0) {
-        _deinvest(deinvestAmount);
-      }
-    }
-  }
-
-  /**
-   * @dev Function to be called automatically by a crontask - Distributes and rebalances
-   */
-  function checkpoint() external {
-    distributeEarnings();
-    rebalance();
-  }
-
-  /**
-   * @dev This is called from PolicyPool when doesn't have enought money for payment.
-   *      After the call, there should be enought money in PolicyPool.currency().balanceOf(this) to
-   *      do the payment
-   * @param paymentAmount The amount of the payment
-   */
-  function refillWallet(uint256 paymentAmount) external override onlyPolicyPool {
-    uint256 poolCash = currency().balanceOf(address(_policyPool));
-    require(poolCash < paymentAmount, "No need to refill the wallet for this payment");
-    uint256 investmentValue = getInvestmentValue();
-    // try to leave the pool balance at liquidity_middle after the payment
-    uint256 deinvest = paymentAmount + _liquidityMiddle - poolCash;
-    if (deinvest > investmentValue) deinvest = investmentValue;
-    _deinvest(deinvest);
-  }
-
-  function _invest(uint256 amount) internal virtual {
-    _lastInvestmentValue += amount;
-    emit MoneyInvested(amount);
-    // must be reimplemented do the actual cash movement
-  }
-
-  function _deinvest(uint256 amount) internal virtual {
-    _lastInvestmentValue -= Math.min(_lastInvestmentValue, amount);
-    emit MoneyDeinvested(amount);
-    // must be reimplemented do the actual cash movement
-  }
-
-  /**
-   * @dev Deinvest all the assets and return the cash back to the PolicyPool.
-   *      Called from PolicyPool when new asset manager is assigned
-   */
-  function deinvestAll() external virtual override onlyPolicyPool {
-    uint256 poolBalanceBefore = currency().balanceOf(address(_policyPool));
-    _liquidateAll();
-    uint256 poolBalanceAfter = currency().balanceOf(address(_policyPool));
-    _distributeEarnings(poolBalanceAfter - poolBalanceBefore);
-    _lastInvestmentValue = 0;
-    emit MoneyDeinvested(poolBalanceAfter - poolBalanceBefore);
-  }
-
-  function _liquidateAll() internal virtual;
-
-  function liquidityMin() external view returns (uint256) {
-    return _liquidityMin;
-  }
-
-  function liquidityMiddle() external view returns (uint256) {
-    return _liquidityMiddle;
-  }
-
-  function liquidityMax() external view returns (uint256) {
-    return _liquidityMax;
-  }
-
-  function setLiquidityMin(uint256 newValue) external onlyPoolRole2(LEVEL2_ROLE, LEVEL3_ROLE) {
-    bool tweak = !hasPoolRole(LEVEL2_ROLE);
-    require(
-      !tweak || _isTweakRay(_liquidityMin, newValue, 3e26),
-      "Tweak exceeded: liquidityMin tweaks only up to 30%"
-    );
-    _liquidityMin = newValue;
-    _parameterChanged(IPolicyPoolConfig.GovernanceActions.setLiquidityMin, newValue, tweak);
-  }
-
-  function setLiquidityMiddle(uint256 newValue) external onlyPoolRole2(LEVEL2_ROLE, LEVEL3_ROLE) {
-    bool tweak = !hasPoolRole(LEVEL2_ROLE);
-    require(
-      !tweak || _isTweakRay(_liquidityMiddle, newValue, 3e26),
-      "Tweak exceeded: liquidityMiddle tweaks only up to 30%"
-    );
-    _liquidityMiddle = newValue;
-    _parameterChanged(IPolicyPoolConfig.GovernanceActions.setLiquidityMiddle, newValue, tweak);
-  }
-
-  function setLiquidityMax(uint256 newValue) external onlyPoolRole2(LEVEL2_ROLE, LEVEL3_ROLE) {
-    bool tweak = !hasPoolRole(LEVEL2_ROLE);
-    require(
-      !tweak || _isTweakRay(_liquidityMax, newValue, 3e26),
-      "Tweak exceeded: liquidityMax tweaks only up to 30%"
-    );
-    _liquidityMax = newValue;
-    _parameterChanged(IPolicyPoolConfig.GovernanceActions.setLiquidityMax, newValue, tweak);
-  }
-
-  function setLiquidityMultiple(
-    uint256 min,
-    uint256 middle,
-    uint256 max
-  ) external onlyPoolRole2(LEVEL2_ROLE, LEVEL3_ROLE) {
-    bool setMin = min != type(uint256).max;
-    bool setMiddle = middle != type(uint256).max;
-    bool setMax = max != type(uint256).max;
-    bool tweak = !hasPoolRole(LEVEL2_ROLE);
-    // First set all - Then call _parameterChanged
-    if (setMin) {
-      require(
-        !tweak || _isTweakRay(_liquidityMin, min, 3e26),
-        "Tweak exceeded: liquidityMin tweaks only up to 30%"
-      );
-      _liquidityMin = min;
-    }
-    if (setMiddle) {
-      require(
-        !tweak || _isTweakRay(_liquidityMiddle, middle, 3e26),
-        "Tweak exceeded: liquidityMiddle tweaks only up to 30%"
-      );
-      _liquidityMiddle = middle;
-    }
-    if (setMax) {
-      require(
-        !tweak || _isTweakRay(_liquidityMax, max, 3e26),
-        "Tweak exceeded: liquidityMax tweaks only up to 30%"
-      );
-      _liquidityMax = max;
-    }
-    if (setMin) _parameterChanged(IPolicyPoolConfig.GovernanceActions.setLiquidityMin, min, tweak);
-    if (setMiddle)
-      _parameterChanged(IPolicyPoolConfig.GovernanceActions.setLiquidityMiddle, middle, tweak);
-    if (setMax) _parameterChanged(IPolicyPoolConfig.GovernanceActions.setLiquidityMax, max, tweak);
-  }
-
-  function _setLiquidityMiddle(uint256 newValue) internal {
-    bool tweak = !hasPoolRole(LEVEL2_ROLE);
-    require(
-      !tweak || _isTweakRay(_liquidityMiddle, newValue, 3e26),
-      "Tweak exceeded: liquidityMiddle tweaks only up to 30%"
-    );
-    _liquidityMiddle = newValue;
-    _parameterChanged(IPolicyPoolConfig.GovernanceActions.setLiquidityMiddle, newValue, tweak);
-  }
-
-  function _setLiquidityMax(uint256 newValue) internal {
-    bool tweak = !hasPoolRole(LEVEL2_ROLE);
-    require(
-      !tweak || _isTweakRay(_liquidityMax, newValue, 3e26),
-      "Tweak exceeded: liquidityMax tweaks only up to 30%"
-    );
-    _liquidityMax = newValue;
-    _parameterChanged(IPolicyPoolConfig.GovernanceActions.setLiquidityMax, newValue, tweak);
-  }
-}

package/contracts/DataTypes.sol

@@ -1,287 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-
-pragma solidity ^0.8.0;
-
-import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
-import {IEToken} from "../interfaces/IEToken.sol";
-
-/**
- * @title DataTypes library
- * @dev Library with two EnumerableSet:
- *      - ETokenToWadMap: enumerable mapping(EToken ==> amount)
- *      - ETokenStatusMap: enumerable mapping(EToken ==> ETokenStatus)
- * @custom:security-contact security@ensuro.co
- * @author Ensuro
- */
-library DataTypes {
-  using EnumerableSet for EnumerableSet.AddressSet;
-
-  enum ETokenStatus {
-    inactive, // doesn't exists - All operations rejected
-    active, // deposit / withdraw / lockScr / unlockScr OK
-    deprecated, // withdraw OK, unlockScr OK, deposit rejected, no new policies
-    suspended // all operations temporarily rejected
-  }
-
-  // Copied from OpenZeppelin's EnumerableMap but with address as keys
-  // and reimplemented with interfaces as keys
-  // To implement this library for multiple types with as little code
-  // repetition as possible, we write it in terms of a generic Map type with
-  // address keys and uint256 values.
-  // The Map implementation uses private functions, and user-facing
-  // implementations (such as Uint256ToAddressMap) are just wrappers around
-  // the underlying Map.
-
-  struct Map {
-    // Storage of keys
-    EnumerableSet.AddressSet _keys;
-    mapping(address => uint256) _values;
-  }
-
-  /**
-   * @dev Adds a key-value pair to a map, or updates the value for an existing
-   * key. O(1).
-   *
-   * Returns true if the key was added to the map, that is if it was not
-   * already present.
-   */
-  function _set(
-    Map storage map,
-    address key,
-    uint256 value
-  ) private returns (bool) {
-    map._values[key] = value;
-    return map._keys.add(key);
-  }
-
-  /**
-   * @dev Removes a key-value pair from a map. O(1).
-   *
-   * Returns true if the key was removed from the map, that is if it was present.
-   */
-  function _remove(Map storage map, address key) private returns (bool) {
-    delete map._values[key];
-    return map._keys.remove(key);
-  }
-
-  /**
-   * @dev Returns true if the key is in the map. O(1).
-   */
-  function _contains(Map storage map, address key) private view returns (bool) {
-    return map._keys.contains(key);
-  }
-
-  /**
-   * @dev Returns the number of key-value pairs in the map. O(1).
-   */
-  function _length(Map storage map) private view returns (uint256) {
-    return map._keys.length();
-  }
-
-  /**
-   * @dev Returns the key-value pair stored at position `index` in the map. O(1).
-   *
-   * Note that there are no guarantees on the ordering of entries inside the
-   * array, and it may change when more entries are added or removed.
-   *
-   * Requirements:
-   *
-   * - `index` must be strictly less than {length}.
-   */
-  function _at(Map storage map, uint256 index) private view returns (address, uint256) {
-    address key = map._keys.at(index);
-    return (key, map._values[key]);
-  }
-
-  /**
-   * @dev Tries to returns the value associated with `key`.  O(1).
-   * Does not revert if `key` is not in the map.
-   */
-  function _tryGet(Map storage map, address key) private view returns (bool, uint256) {
-    uint256 value = map._values[key];
-    if (value == 0) {
-      return (_contains(map, key), 0);
-    } else {
-      return (true, value);
-    }
-  }
-
-  /**
-   * @dev Returns the value associated with `key`.  O(1).
-   *
-   * Requirements:
-   *
-   * - `key` must be in the map.
-   */
-  function _get(Map storage map, address key) private view returns (uint256) {
-    uint256 value = map._values[key];
-    require(value != 0 || _contains(map, key), "EnumerableMap: nonexistent key");
-    return value;
-  }
-
-  // ETokenToWadMap
-  struct ETokenToWadMap {
-    Map _inner;
-  }
-
-  /**
-   * @dev Adds a key-value pair to a map, or updates the value for an existing
-   * key. O(1).
-   *
-   * Returns true if the key was added to the map, that is if it was not
-   * already present.
-   */
-  function set(
-    ETokenToWadMap storage map,
-    IEToken key,
-    uint256 value
-  ) internal returns (bool) {
-    return _set(map._inner, address(key), value);
-  }
-
-  /**
-   * @dev Removes a value from a set. O(1).
-   *
-   * Returns true if the key was removed from the map, that is if it was present.
-   */
-  function remove(ETokenToWadMap storage map, IEToken key) internal returns (bool) {
-    return _remove(map._inner, address(key));
-  }
-
-  /**
-   * @dev Returns true if the key is in the map. O(1).
-   */
-  function contains(ETokenToWadMap storage map, IEToken key) internal view returns (bool) {
-    return _contains(map._inner, address(key));
-  }
-
-  /**
-   * @dev Returns the number of elements in the map. O(1).
-   */
-  function length(ETokenToWadMap storage map) internal view returns (uint256) {
-    return _length(map._inner);
-  }
-
-  /**
-   * @dev Returns the element stored at position `index` in the set. O(1).
-   * Note that there are no guarantees on the ordering of values inside the
-   * array, and it may change when more values are added or removed.
-   *
-   * Requirements:
-   *
-   * - `index` must be strictly less than {length}.
-   */
-  function at(ETokenToWadMap storage map, uint256 index) internal view returns (IEToken, uint256) {
-    (address key, uint256 value) = _at(map._inner, index);
-    return (IEToken(key), value);
-  }
-
-  /**
-   * @dev Tries to returns the value associated with `key`.  O(1).
-   * Does not revert if `key` is not in the map.
-   *
-   * _Available since v3.4._
-   */
-  function tryGet(ETokenToWadMap storage map, IEToken key) internal view returns (bool, uint256) {
-    (bool success, uint256 value) = _tryGet(map._inner, address(key));
-    return (success, value);
-  }
-
-  /**
-   * @dev Returns the value associated with `key`.  O(1).
-   *
-   * Requirements:
-   *
-   * - `key` must be in the map.
-   */
-  function get(ETokenToWadMap storage map, IEToken key) internal view returns (uint256) {
-    return uint256(_get(map._inner, address(key)));
-  }
-
-  // ETokenStatusMap
-  struct ETokenStatusMap {
-    Map _inner;
-  }
-
-  /**
-   * @dev Adds a key-value pair to a map, or updates the value for an existing
-   * key. O(1).
-   *
-   * Returns true if the key was added to the map, that is if it was not
-   * already present.
-   */
-  function set(
-    ETokenStatusMap storage map,
-    IEToken key,
-    ETokenStatus value
-  ) internal returns (bool) {
-    return _set(map._inner, address(key), uint256(value));
-  }
-
-  /**
-   * @dev Removes a value from a set. O(1).
-   *
-   * Returns true if the key was removed from the map, that is if it was present.
-   */
-  function remove(ETokenStatusMap storage map, IEToken key) internal returns (bool) {
-    return _remove(map._inner, address(key));
-  }
-
-  /**
-   * @dev Returns true if the key is in the map. O(1).
-   */
-  function contains(ETokenStatusMap storage map, IEToken key) internal view returns (bool) {
-    return _contains(map._inner, address(key));
-  }
-
-  /**
-   * @dev Returns the number of elements in the map. O(1).
-   */
-  function length(ETokenStatusMap storage map) internal view returns (uint256) {
-    return _length(map._inner);
-  }
-
-  /**
-   * @dev Returns the element stored at position `index` in the set. O(1).
-   * Note that there are no guarantees on the ordering of values inside the
-   * array, and it may change when more values are added or removed.
-   *
-   * Requirements:
-   *
-   * - `index` must be strictly less than {length}.
-   */
-  function at(ETokenStatusMap storage map, uint256 index)
-    internal
-    view
-    returns (IEToken, ETokenStatus)
-  {
-    (address key, uint256 value) = _at(map._inner, index);
-    return (IEToken(key), ETokenStatus(value));
-  }
-
-  /**
-   * @dev Tries to returns the value associated with `key`.  O(1).
-   * Does not revert if `key` is not in the map.
-   *
-   * _Available since v3.4._
-   */
-  function tryGet(ETokenStatusMap storage map, IEToken key)
-    internal
-    view
-    returns (bool, ETokenStatus)
-  {
-    (bool success, uint256 value) = _tryGet(map._inner, address(key));
-    return (success, ETokenStatus(value));
-  }
-
-  /**
-   * @dev Returns the value associated with `key`.  O(1).
-   *
-   * Requirements:
-   *
-   * - `key` must be in the map.
-   */
-  function get(ETokenStatusMap storage map, IEToken key) internal view returns (ETokenStatus) {
-    return ETokenStatus(_get(map._inner, address(key)));
-  }
-}