@ensuro/core 2.6.2 → 2.8.0-beta1

package/README.md

@@ -85,11 +85,11 @@ Have in mind the new versions of the contracts might or might not be covered by
 
 ## Development
 
-For coding the smart contracts the approach we took was prototyping initially in Python (see folder `prototype`), and later we coded in Solidity. The tests run the same test case both on the Python prototype code and the Solidity code. To adapt the Solidity code that is called using [brownie](https://eth-brownie.readthedocs.io/en/stable/), we have some glue code implemented in `tests/wrappers.py`.
+For coding the smart contracts the approach we took was prototyping initially in Python (see folder `prototype`), and later we coded in Solidity. The tests run the same test case both on the Python prototype code and the Solidity code. To adapt the Solidity code that is called using [ethproto](https://github.com/gnarvaja/eth-prototype), we have some glue code implemented in `tests/wrappers.py`.
 
 ### Without docker
 
-You can also run the development environment without using docker, just Python (>=3.9) and Node v16 are required as pre-requisits.
+You can also run the development environment without using docker, just Python (>=3.9) and Node v20 are required as pre-requisits.
 
 Initial setup:
 
@@ -101,15 +101,21 @@ source venv/bin/activate
 pip install -r requirements.txt
 pip install -r requirements-dev.txt
 # Install javascript dependencies
-nvm use  # To change to node v16
+nvm use  # To change to node v20
 npm install
 ```
 
 Then, you can run the tests with:
 
 ```bash
-brownie test -v
-npx hardhat test
+# Start a local node
+npx hardhat node
+
+# Run python tests
+pytest
+
+# Run js tests
+npx hardhat test --network localhost
 ```
 
 ### Using docker

package/contracts/AccessManager.sol

@@ -102,12 +102,7 @@ contract AccessManager is Initializable, AccessControlUpgradeable, UUPSUpgradeab
    * @param role The role to get
    * @return The component role
    */
-  function getComponentRole(address component, bytes32 role)
-    public
-    pure
-    override
-    returns (bytes32)
-  {
+  function getComponentRole(address component, bytes32 role) public pure override returns (bytes32) {
     return bytes32(bytes20(component)) ^ role;
   }
 
@@ -125,8 +120,7 @@ contract AccessManager is Initializable, AccessControlUpgradeable, UUPSUpgradeab
     address account,
     bool alsoGlobal
   ) public view override returns (bool) {
-    return
-      (alsoGlobal && hasRole(role, account)) || hasRole(getComponentRole(component, role), account);
+    return (alsoGlobal && hasRole(role, account)) || hasRole(getComponentRole(component, role), account);
   }
 
   /**
@@ -183,11 +177,7 @@ contract AccessManager is Initializable, AccessControlUpgradeable, UUPSUpgradeab
    * @param role2 The second role to check.
    * @param account The account to check for the role.
    */
-  function checkRole2(
-    bytes32 role1,
-    bytes32 role2,
-    address account
-  ) external view override {
+  function checkRole2(bytes32 role1, bytes32 role2, address account) external view override {
     if (!hasRole(role1, account)) _checkRole(role2, account);
   }
 

package/contracts/EToken.sol

@@ -151,10 +151,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
       _params.maxUtilizationRate >= MAX_UR_MIN && _params.maxUtilizationRate <= HUNDRED_PERCENT,
       "Validation: maxUtilizationRate must be [0.5, 1]"
     );
-    require(
-      _params.minUtilizationRate <= HUNDRED_PERCENT,
-      "Validation: minUtilizationRate must be [0, 1]"
-    );
+    require(_params.minUtilizationRate <= HUNDRED_PERCENT, "Validation: minUtilizationRate must be [0, 1]");
     /*
      * We don't validate minUtilizationRate < maxUtilizationRate because the opposite is valid too.
      * These limits aren't strong limits on the values the utilization rate can take, but instead they are
@@ -164,10 +161,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
      * `maxUtilizationRate` is used to prevent selling more coverage when UR is too high, only checked on `lockScr`
      * operations, but not in withdrawals or other operations.
      */
-    require(
-      _params.internalLoanInterestRate <= INT_LOAN_IR_MAX,
-      "Validation: internalLoanInterestRate must be <= 50%"
-    );
+    require(_params.internalLoanInterestRate <= INT_LOAN_IR_MAX, "Validation: internalLoanInterestRate must be <= 50%");
   }
 
   /*** BEGIN ERC20 methods - mainly copied from OpenZeppelin but changes in events and scaledAmount */
@@ -266,13 +260,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
   /**
    * @dev See {IERC20-allowance}.
    */
-  function allowance(address owner, address spender)
-    public
-    view
-    virtual
-    override
-    returns (uint256)
-  {
+  function allowance(address owner, address spender) public view virtual override returns (uint256) {
     return _allowances[owner][spender];
   }
 
@@ -301,11 +289,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
    * - the caller must have allowance for ``sender``'s tokens of at least
    * `amount`.
    */
-  function transferFrom(
-    address sender,
-    address recipient,
-    uint256 amount
-  ) public virtual override returns (bool) {
+  function transferFrom(address sender, address recipient, uint256 amount) public virtual override returns (bool) {
     address spender = _msgSender();
     _spendAllowance(sender, spender, amount);
     _transfer(sender, recipient, amount);
@@ -320,11 +304,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
    *
    * Might emit an {Approval} event.
    */
-  function _spendAllowance(
-    address owner,
-    address spender,
-    uint256 amount
-  ) internal virtual {
+  function _spendAllowance(address owner, address spender, uint256 amount) internal virtual {
     uint256 currentAllowance = allowance(owner, spender);
     if (currentAllowance != type(uint256).max) {
       require(currentAllowance >= amount, "EToken: insufficient allowance");
@@ -365,11 +345,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
    * - `spender` must have allowance for the caller of at least
    * `subtractedValue`.
    */
-  function decreaseAllowance(address spender, uint256 subtractedValue)
-    public
-    virtual
-    returns (bool)
-  {
+  function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
     uint256 currentAllowance = _allowances[_msgSender()][spender];
     require(currentAllowance >= subtractedValue, "EToken: decreased allowance below zero");
     _approve(_msgSender(), spender, currentAllowance - subtractedValue);
@@ -391,11 +367,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
    * - `recipient` cannot be the zero address.
    * - `sender` must have a balance of at least `amount`.
    */
-  function _transfer(
-    address sender,
-    address recipient,
-    uint256 amount
-  ) internal virtual {
+  function _transfer(address sender, address recipient, uint256 amount) internal virtual {
     require(sender != address(0), "EToken: transfer from the zero address");
     require(recipient != address(0), "EToken: transfer to the zero address");
 
@@ -465,11 +437,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
    * - `owner` cannot be the zero address.
    * - `spender` cannot be the zero address.
    */
-  function _approve(
-    address owner,
-    address spender,
-    uint256 amount
-  ) internal virtual {
+  function _approve(address owner, address spender, uint256 amount) internal virtual {
     require(owner != address(0), "EToken: approve from the zero address");
     require(spender != address(0), "EToken: approve to the zero address");
 
@@ -491,11 +459,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
    *
    * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
    */
-  function _beforeTokenTransfer(
-    address from,
-    address to,
-    uint256 amount
-  ) internal virtual whenNotPaused {
+  function _beforeTokenTransfer(address from, address to, uint256 amount) internal virtual whenNotPaused {
     require(
       from == address(0) ||
         to == address(0) ||
@@ -511,9 +475,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
     uint256 totalSupply_ = this.totalSupply();
     if (totalSupply_ == 0) _scr.tokenInterestRate = 0;
     else {
-      uint256 newTokenInterestRate = uint256(_scr.interestRate).wadMul(uint256(_scr.scr)).wadDiv(
-        totalSupply_
-      );
+      uint256 newTokenInterestRate = uint256(_scr.interestRate).wadMul(uint256(_scr.scr)).wadDiv(totalSupply_);
       _scr.tokenInterestRate = (newTokenInterestRate > type(uint64).max)
         ? type(uint64).max
         : newTokenInterestRate.toUint64();
@@ -586,16 +548,8 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
     return uint256(_scr.scr).wadDiv(this.totalSupply());
   }
 
-  function lockScr(uint256 scrAmount, uint256 policyInterestRate)
-    external
-    override
-    onlyBorrower
-    whenNotPaused
-  {
-    require(
-      scrAmount <= this.fundsAvailableToLock(),
-      "Not enough funds available to cover the SCR"
-    );
+  function lockScr(uint256 scrAmount, uint256 policyInterestRate) external override onlyBorrower whenNotPaused {
+    require(scrAmount <= this.fundsAvailableToLock(), "Not enough funds available to cover the SCR");
     _tsScaled.updateScale(tokenInterestRate());
     if (_scr.scr == 0) {
       _scr.scr = scrAmount.toUint128();
@@ -603,8 +557,9 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
     } else {
       uint256 origScr = uint256(_scr.scr);
       uint256 newScr = origScr + scrAmount;
-      _scr.interestRate = (uint256(_scr.interestRate).wadMul(origScr) +
-        policyInterestRate.wadMul(scrAmount)).wadDiv(newScr).toUint64();
+      _scr.interestRate = (uint256(_scr.interestRate).wadMul(origScr) + policyInterestRate.wadMul(scrAmount))
+        .wadDiv(newScr)
+        .toUint64();
       _scr.scr = newScr.toUint128();
     }
     emit SCRLocked(policyInterestRate, scrAmount);
@@ -625,8 +580,9 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
     } else {
       uint256 origScr = uint256(_scr.scr);
       uint256 newScr = origScr - scrAmount;
-      _scr.interestRate = (uint256(_scr.interestRate).wadMul(origScr) -
-        policyInterestRate.wadMul(scrAmount)).wadDiv(newScr).toUint64();
+      _scr.interestRate = (uint256(_scr.interestRate).wadMul(origScr) - policyInterestRate.wadMul(scrAmount))
+        .wadDiv(newScr)
+        .toUint64();
       _scr.scr = newScr.toUint128();
     }
     emit SCRUnlocked(policyInterestRate, scrAmount);
@@ -642,15 +598,9 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
     _updateTokenInterestRate();
   }
 
-  function deposit(address provider, uint256 amount)
-    external
-    override
-    onlyPolicyPool
-    returns (uint256)
-  {
+  function deposit(address provider, uint256 amount) external override onlyPolicyPool returns (uint256) {
     require(
-      address(_params.whitelist) == address(0) ||
-        _params.whitelist.acceptsDeposit(this, provider, amount),
+      address(_params.whitelist) == address(0) || _params.whitelist.acceptsDeposit(this, provider, amount),
       "Liquidity Provider not whitelisted"
     );
     _mint(provider, amount);
@@ -666,12 +616,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
     else return 0;
   }
 
-  function withdraw(address provider, uint256 amount)
-    external
-    override
-    onlyPolicyPool
-    returns (uint256)
-  {
+  function withdraw(address provider, uint256 amount) external override onlyPolicyPool returns (uint256) {
     /**
      * Here we don't check for maxUtilizationRate because that limit only affects locking more capital (`lockScr`), but
      * doesn't affects the right of liquidity providers to withdraw their funds.
@@ -683,8 +628,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
     if (amount == 0) return 0;
     require(amount <= maxWithdraw, "amount > max withdrawable");
     require(
-      address(_params.whitelist) == address(0) ||
-        _params.whitelist.acceptsWithdrawal(this, provider, amount),
+      address(_params.whitelist) == address(0) || _params.whitelist.acceptsWithdrawal(this, provider, amount),
       "Liquidity Provider not whitelisted"
     );
     _burn(provider, amount);
@@ -717,13 +661,10 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
     return totalSupply() - _tsScaled.minValue(); // Min value accepted by _tsScaled
   }
 
-  function internalLoan(uint256 amount, address receiver)
-    external
-    override
-    onlyBorrower
-    whenNotPaused
-    returns (uint256)
-  {
+  function internalLoan(
+    uint256 amount,
+    address receiver
+  ) external override onlyBorrower whenNotPaused returns (uint256) {
     uint256 amountAsked = amount;
     amount = Math.min(amount, maxNegativeAdjustment());
     if (amount == 0) return amountAsked;
@@ -756,10 +697,7 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
     return _4toWad(_params.internalLoanInterestRate);
   }
 
-  function setParam(Parameter param, uint256 newValue)
-    external
-    onlyGlobalOrComponentRole2(LEVEL2_ROLE, LEVEL3_ROLE)
-  {
+  function setParam(Parameter param, uint256 newValue) external onlyGlobalOrComponentRole2(LEVEL2_ROLE, LEVEL3_ROLE) {
     bool tweak = !hasPoolRole(LEVEL2_ROLE);
     if (param == Parameter.liquidityRequirement) {
       require(
@@ -799,13 +737,9 @@ contract EToken is Reserve, IERC20Metadata, IEToken {
     );
   }
 
-  function setWhitelist(ILPWhitelist lpWhitelist_)
-    external
-    onlyGlobalOrComponentRole2(GUARDIAN_ROLE, LEVEL1_ROLE)
-  {
+  function setWhitelist(ILPWhitelist lpWhitelist_) external onlyGlobalOrComponentRole2(GUARDIAN_ROLE, LEVEL1_ROLE) {
     require(
-      address(lpWhitelist_) == address(0) ||
-        IPolicyPoolComponent(address(lpWhitelist_)).policyPool() == _policyPool,
+      address(lpWhitelist_) == address(0) || IPolicyPoolComponent(address(lpWhitelist_)).policyPool() == _policyPool,
       "Component not linked to this PolicyPool"
     );
     _params.whitelist = lpWhitelist_;

package/contracts/LPManualWhitelist.sol

@@ -48,28 +48,22 @@ contract LPManualWhitelist is ILPWhitelist, PolicyPoolComponent {
   }
 
   // solhint-disable-next-line func-name-mixedcase
-  function __LPManualWhitelist_init(WhitelistStatus calldata defaultStatus)
-    internal
-    onlyInitializing
-  {
+  function __LPManualWhitelist_init(WhitelistStatus calldata defaultStatus) internal onlyInitializing {
     __PolicyPoolComponent_init();
     __LPManualWhitelist_init_unchained(defaultStatus);
   }
 
   // solhint-disable-next-line func-name-mixedcase
-  function __LPManualWhitelist_init_unchained(WhitelistStatus calldata defaultStatus)
-    internal
-    onlyInitializing
-  {
+  function __LPManualWhitelist_init_unchained(WhitelistStatus calldata defaultStatus) internal onlyInitializing {
     _checkDefaultStatus(defaultStatus);
     _wlStatus[address(0)] = defaultStatus;
     emit LPWhitelistStatusChanged(address(0), defaultStatus);
   }
 
-  function whitelistAddress(address provider, WhitelistStatus calldata newStatus)
-    external
-    onlyComponentRole(LP_WHITELIST_ROLE)
-  {
+  function whitelistAddress(
+    address provider,
+    WhitelistStatus calldata newStatus
+  ) external onlyComponentRole(LP_WHITELIST_ROLE) {
     require(provider != address(0), "You can't change the defaults");
     _whitelistAddress(provider, newStatus);
   }
@@ -84,10 +78,9 @@ contract LPManualWhitelist is ILPWhitelist, PolicyPoolComponent {
     );
   }
 
-  function setWhitelistDefaults(WhitelistStatus calldata newStatus)
-    external
-    onlyComponentRole(LP_WHITELIST_ADMIN_ROLE)
-  {
+  function setWhitelistDefaults(
+    WhitelistStatus calldata newStatus
+  ) external onlyComponentRole(LP_WHITELIST_ADMIN_ROLE) {
     _checkDefaultStatus(newStatus);
     _whitelistAddress(address(0), newStatus);
   }
@@ -108,11 +101,7 @@ contract LPManualWhitelist is ILPWhitelist, PolicyPoolComponent {
     return super.supportsInterface(interfaceId) || interfaceId == type(ILPWhitelist).interfaceId;
   }
 
-  function acceptsDeposit(
-    IEToken,
-    address provider,
-    uint256
-  ) external view override returns (bool) {
+  function acceptsDeposit(IEToken, address provider, uint256) external view override returns (bool) {
     WhitelistOptions wl = _wlStatus[provider].deposit;
     if (wl == WhitelistOptions.undefined) {
       wl = _wlStatus[address(0)].deposit;
@@ -120,11 +109,7 @@ contract LPManualWhitelist is ILPWhitelist, PolicyPoolComponent {
     return wl == WhitelistOptions.whitelisted;
   }
 
-  function acceptsWithdrawal(
-    IEToken,
-    address provider,
-    uint256
-  ) external view override returns (bool) {
+  function acceptsWithdrawal(IEToken, address provider, uint256) external view override returns (bool) {
     WhitelistOptions wl = _wlStatus[provider].withdraw;
     if (wl == WhitelistOptions.undefined) {
       wl = _wlStatus[address(0)].withdraw;

package/contracts/LiquidityThresholdAssetManager.sol

@@ -40,10 +40,7 @@ abstract contract LiquidityThresholdAssetManager is IAssetManager {
   }
 
   constructor(IERC20Metadata asset_) {
-    require(
-      address(asset_) != address(0),
-      "LiquidityThresholdAssetManager: asset cannot be zero address"
-    );
+    require(address(asset_) != address(0), "LiquidityThresholdAssetManager: asset cannot be zero address");
     _asset = asset_;
   }
 
@@ -67,10 +64,7 @@ abstract contract LiquidityThresholdAssetManager is IAssetManager {
   }
 
   function connect() public virtual override {
-    require(
-      IPolicyPoolComponent(address(this)).policyPool().currency() == _asset,
-      "Asset mismatch"
-    );
+    require(IPolicyPoolComponent(address(this)).policyPool().currency() == _asset, "Asset mismatch");
     DiamondStorage storage ds = diamondStorage();
     // When connecting I make sure the storage is clean, to avoid reusing data from previous AM that left
     // the data in a wrong state.
@@ -141,33 +135,29 @@ abstract contract LiquidityThresholdAssetManager is IAssetManager {
   }
 
   function liquidityMin() public view returns (uint256) {
-    return diamondStorage().liquidityMin * 10**_asset.decimals();
+    return diamondStorage().liquidityMin * 10 ** _asset.decimals();
   }
 
   function liquidityMiddle() public view returns (uint256) {
-    return diamondStorage().liquidityMiddle * 10**_asset.decimals();
+    return diamondStorage().liquidityMiddle * 10 ** _asset.decimals();
   }
 
   function liquidityMax() public view returns (uint256) {
-    return diamondStorage().liquidityMax * 10**_asset.decimals();
+    return diamondStorage().liquidityMax * 10 ** _asset.decimals();
   }
 
-  function setLiquidityThresholds(
-    uint256 min,
-    uint256 middle,
-    uint256 max
-  ) external validateParamsAfterChange {
+  function setLiquidityThresholds(uint256 min, uint256 middle, uint256 max) external validateParamsAfterChange {
     DiamondStorage storage ds = diamondStorage();
     if (min != type(uint256).max) {
-      ds.liquidityMin = (min / 10**_asset.decimals()).toUint32();
+      ds.liquidityMin = (min / 10 ** _asset.decimals()).toUint32();
       emit GovernanceAction(IAccessManager.GovernanceActions.setLiquidityMin, min);
     }
     if (middle != type(uint256).max) {
-      ds.liquidityMiddle = (middle / 10**_asset.decimals()).toUint32();
+      ds.liquidityMiddle = (middle / 10 ** _asset.decimals()).toUint32();
       emit GovernanceAction(IAccessManager.GovernanceActions.setLiquidityMiddle, middle);
     }
     if (max != type(uint256).max) {
-      ds.liquidityMax = (max / 10**_asset.decimals()).toUint32();
+      ds.liquidityMax = (max / 10 ** _asset.decimals()).toUint32();
       emit GovernanceAction(IAccessManager.GovernanceActions.setLiquidityMax, max);
     }
   }
@@ -176,7 +166,6 @@ abstract contract LiquidityThresholdAssetManager is IAssetManager {
    * @dev See {IERC165-supportsInterface}.
    */
   function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
-    return
-      interfaceId == type(IERC165).interfaceId || interfaceId == type(IAssetManager).interfaceId;
+    return interfaceId == type(IERC165).interfaceId || interfaceId == type(IAssetManager).interfaceId;
   }
 }

package/contracts/Policy.sol

@@ -66,27 +66,17 @@ library Policy {
       policy.srScr = 0;
     }
     // Calculate CoCs
-    policy.jrCoc = policy.jrScr.wadMul(
-      (rmParams.jrRoc * (policy.expiration - policy.start)) / SECONDS_PER_YEAR
-    );
-    policy.srCoc = policy.srScr.wadMul(
-      (rmParams.srRoc * (policy.expiration - policy.start)) / SECONDS_PER_YEAR
-    );
+    policy.jrCoc = policy.jrScr.wadMul((rmParams.jrRoc * (policy.expiration - policy.start)) / SECONDS_PER_YEAR);
+    policy.srCoc = policy.srScr.wadMul((rmParams.srRoc * (policy.expiration - policy.start)) / SECONDS_PER_YEAR);
     uint256 coc = policy.jrCoc + policy.srCoc;
-    policy.ensuroCommission =
-      policy.purePremium.wadMul(rmParams.ensuroPpFee) +
-      coc.wadMul(rmParams.ensuroCocFee);
-    require(
-      (policy.purePremium + policy.ensuroCommission + coc) <= premium,
-      "Premium less than minimum"
-    );
+    policy.ensuroCommission = policy.purePremium.wadMul(rmParams.ensuroPpFee) + coc.wadMul(rmParams.ensuroCocFee);
+    require((policy.purePremium + policy.ensuroCommission + coc) <= premium, "Premium less than minimum");
     policy.partnerCommission = premium - policy.purePremium - coc - policy.ensuroCommission;
     return policy;
   }
 
   function jrInterestRate(PolicyData memory policy) internal pure returns (uint256) {
-    return
-      ((policy.jrCoc * SECONDS_PER_YEAR) / (policy.expiration - policy.start)).wadDiv(policy.jrScr);
+    return ((policy.jrCoc * SECONDS_PER_YEAR) / (policy.expiration - policy.start)).wadDiv(policy.jrScr);
   }
 
   function jrAccruedInterest(PolicyData memory policy) internal view returns (uint256) {
@@ -94,8 +84,7 @@ library Policy {
   }
 
   function srInterestRate(PolicyData memory policy) internal pure returns (uint256) {
-    return
-      ((policy.srCoc * SECONDS_PER_YEAR) / (policy.expiration - policy.start)).wadDiv(policy.srScr);
+    return ((policy.srCoc * SECONDS_PER_YEAR) / (policy.expiration - policy.start)).wadDiv(policy.srScr);
   }
 
   function srAccruedInterest(PolicyData memory policy) internal view returns (uint256) {