@ensuro/core 2.0.0-beta8 → 2.0.0

package/contracts/interfaces/IPolicyPoolComponent.sol

@@ -2,12 +2,16 @@
 pragma solidity ^0.8.0;
 
 import {IPolicyPool} from "./IPolicyPool.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 /**
  * @title IPolicyPoolComponent interface
  * @dev Interface for Contracts linked (owned) by a PolicyPool. Useful to avoid cyclic dependencies
  * @author Ensuro
  */
-interface IPolicyPoolComponent {
+interface IPolicyPoolComponent is IERC165 {
+  /**
+   * @dev Returns the address of the PolicyPool (see {PolicyPool}) where this component belongs.
+   */
   function policyPool() external view returns (IPolicyPool);
 }

package/contracts/interfaces/IRiskModule.sol

@@ -9,6 +9,9 @@ import {IPremiumsAccount} from "./IPremiumsAccount.sol";
  * @author Ensuro
  */
 interface IRiskModule {
+  /**
+   * @dev Enum with the different parameters of the risk module, used in {RiskModule-setParam}.
+   */
   enum Parameter {
     moc,
     jrCollRatio,
@@ -22,28 +25,85 @@ interface IRiskModule {
     maxDuration
   }
 
+  /**
+   * Struct of the parameters of the risk module that are used to calculate the different Policy fields (see
+   * {Policy-PolicyData}.
+   */
   struct Params {
+    /**
+     * @dev MoC (Margin of Conservativism) is a factor that multiplies the lossProb to increase or decrease the pure
+     * premium.
+     */
     uint256 moc;
+    /**
+     * @dev Junior Collateralization Ratio is the percentage of policy exposure (payout) that will be covered with the
+     * purePremium and the Junior EToken
+     */
     uint256 jrCollRatio;
+    /**
+     * @dev Collateralization Ratio is the percentage of policy exposure (payout) that will be covered by the
+     * purePremium and the Junior and Senior EToken. Usually is calculated as the relation between VAR99.5% and VAR100
+     * (full collateralization).
+     */
     uint256 collRatio;
+    /**
+     * @dev Ensuro PurePremium Fee is the percentage that will be multiplied by the pure premium to obtain the part of
+     * the Ensuro Fee that's proportional to the pure premium.
+     */
     uint256 ensuroPpFee;
+    /**
+     * @dev Ensuro Cost of Capital Fee is the percentage that will be multiplied by the cost of capital (CoC) to
+     * obtain the part of the Ensuro Fee that's proportional to the CoC.
+     */
     uint256 ensuroCocFee;
+    /**
+     * @dev Junior Return on Capital is the annualized interest rate that's charged for the capital locked in the Junior
+     * EToken.
+     */
     uint256 jrRoc;
+    /**
+     * @dev Senior Return on Capital is the annualized interest rate that's charged for the capital locked in the Senior
+     * EToken.
+     */
     uint256 srRoc;
   }
 
+  /**
+   * @dev A readable name of this risk module. Never changes.
+   */
   function name() external view returns (string memory);
 
+  /**
+   * @dev Returns different parameters of the risk module (see {Params})
+   */
   function params() external view returns (Params memory);
 
-  function maxPayoutPerPolicy() external view returns (uint256);
-
-  function exposureLimit() external view returns (uint256);
-
+  /**
+   * @dev Returns the maximum duration (in hours) of the policies of this risk module.
+   *      The `expiration` of the policies has to be `<= (block.timestamp + 3600 * maxDuration())`
+   */
   function maxDuration() external view returns (uint256);
 
+  /**
+   * @dev Returns the maximum payout accepted for new policies.
+   */
+  function maxPayoutPerPolicy() external view returns (uint256);
+
+  /**
+   * @dev Returns sum of the (maximum) payout of the active policies of this risk module, i.e. the maximum possible
+   * amount of money that's exposed for this risk module.
+   */
   function activeExposure() external view returns (uint256);
 
+  /**
+   * @dev Returns maximum exposure (sum of the (maximum) payout of the active policies) of this risk module.
+   * `activeExposure() <= exposureLimit()` always
+   */
+  function exposureLimit() external view returns (uint256);
+
+  /**
+   * @dev Returns the address of the partner that receives the partnerCommission
+   */
   function wallet() external view returns (address);
 
   /**
@@ -56,5 +116,8 @@ interface IRiskModule {
    */
   function releaseExposure(uint256 payout) external;
 
+  /**
+   * @dev Returns the {PremiumsAccount} where the premiums of this risk module are collected. Never changes.
+   */
   function premiumsAccount() external view returns (IPremiumsAccount);
 }

package/contracts/mocks/InterfaceIdCalculator.sol

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import {IAccessControl} from "@openzeppelin/contracts/access/IAccessControl.sol";
+import {IPolicyPool} from "../interfaces/IPolicyPool.sol";
+import {IPolicyPoolComponent} from "../interfaces/IPolicyPoolComponent.sol";
+import {IEToken} from "../interfaces/IEToken.sol";
+import {IRiskModule} from "../interfaces/IRiskModule.sol";
+import {IPremiumsAccount} from "../interfaces/IPremiumsAccount.sol";
+import {ILPWhitelist} from "../interfaces/ILPWhitelist.sol";
+import {IAccessManager} from "../interfaces/IAccessManager.sol";
+import {IAssetManager} from "../interfaces/IAssetManager.sol";
+
+contract InterfaceIdCalculator {
+  bytes4 public constant IERC165_INTERFACEID = type(IERC165).interfaceId;
+  bytes4 public constant IERC20_INTERFACEID = type(IERC20).interfaceId;
+  bytes4 public constant IERC20METADATA_INTERFACEID = type(IERC20Metadata).interfaceId;
+  bytes4 public constant IERC721_INTERFACEID = type(IERC721).interfaceId;
+  bytes4 public constant IACCESSCONTROL_INTERFACEID = type(IAccessControl).interfaceId;
+  bytes4 public constant IPOLICYPOOL_INTERFACEID = type(IPolicyPool).interfaceId;
+  bytes4 public constant IPOLICYPOOLCOMPONENT_INTERFACEID = type(IPolicyPoolComponent).interfaceId;
+  bytes4 public constant IETOKEN_INTERFACEID = type(IEToken).interfaceId;
+  bytes4 public constant IRISKMODULE_INTERFACEID = type(IRiskModule).interfaceId;
+  bytes4 public constant IPREMIUMSACCOUNT_INTERFACEID = type(IPremiumsAccount).interfaceId;
+  bytes4 public constant ILPWHITELIST_INTERFACEID = type(ILPWhitelist).interfaceId;
+  bytes4 public constant IACCESSMANAGER_INTERFACEID = type(IAccessManager).interfaceId;
+  bytes4 public constant IASSETMANAGER_INTERFACEID = type(IAssetManager).interfaceId;
+}

package/contracts/mocks/PolicyHolderMock.sol

@@ -8,11 +8,13 @@ contract PolicyHolderMock is IPolicyHolder {
   uint256 public policyId;
   uint256 public payout;
   bool public fail;
+  bool public notImplemented;
 
   event NotificationReceived(uint256 kind, uint256 policyId, address operator, address from);
 
   constructor(bool fail_) {
     fail = fail_;
+    notImplemented = false;
     payout = type(uint256).max;
   }
 
@@ -20,12 +22,21 @@ contract PolicyHolderMock is IPolicyHolder {
     fail = fail_;
   }
 
+  function setNotImplemented(bool notImplemented_) external {
+    notImplemented = notImplemented_;
+  }
+
   function onERC721Received(
     address operator,
     address from,
     uint256 policyId_,
     bytes calldata
   ) external override returns (bytes4) {
+    if (notImplemented)
+      // solhint-disable-next-line no-inline-assembly
+      assembly {
+        revert(0, 0)
+      }
     if (fail) revert("onERC721Received: They told me I have to fail");
     policyId = policyId_;
     emit NotificationReceived(0, policyId_, operator, from);
@@ -37,6 +48,11 @@ contract PolicyHolderMock is IPolicyHolder {
     address from,
     uint256 policyId_
   ) external override returns (bytes4) {
+    if (notImplemented)
+      // solhint-disable-next-line no-inline-assembly
+      assembly {
+        revert(0, 0)
+      }
     if (fail) revert("onPolicyExpired: They told me I have to fail");
     policyId = policyId_;
     payout = 0;
@@ -59,6 +75,11 @@ contract PolicyHolderMock is IPolicyHolder {
     uint256 policyId_,
     uint256 amount
   ) external override returns (bytes4) {
+    if (notImplemented)
+      // solhint-disable-next-line no-inline-assembly
+      assembly {
+        revert(0, 0)
+      }
     if (fail) revert("onPayoutReceived: They told me I have to fail");
     policyId = policyId_;
     payout = amount;

package/contracts/mocks/PolicyPoolComponentMock.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import {IPolicyPool} from "../interfaces/IPolicyPool.sol";
 import {IPolicyPoolComponent} from "../interfaces/IPolicyPoolComponent.sol";
 
@@ -14,4 +15,13 @@ contract PolicyPoolComponentMock is IPolicyPoolComponent {
   function policyPool() external view override returns (IPolicyPool) {
     return _policyPool;
   }
+
+  /**
+   * @dev See {IERC165-supportsInterface}.
+   */
+  function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
+    return
+      interfaceId == type(IERC165).interfaceId ||
+      interfaceId == type(IPolicyPoolComponent).interfaceId;
+  }
 }

package/contracts/mocks/PolicyPoolMock.sol

@@ -81,6 +81,14 @@ contract PolicyPoolMock is IPolicyPool {
     return _resolvePolicy(policy, customerWon ? policy.payout : 0);
   }
 
+  function isActive(uint256 policyId) external view override returns (bool) {
+    return policyHashes[policyId] != bytes32(0);
+  }
+
+  function getPolicyHash(uint256 policyId) external view override returns (bytes32) {
+    return policyHashes[policyId];
+  }
+
   function deposit(IEToken, uint256) external pure override {
     revert("Not Implemented deposit");
   }
@@ -88,6 +96,29 @@ contract PolicyPoolMock is IPolicyPool {
   function withdraw(IEToken, uint256) external pure override returns (uint256) {
     revert("Not Implemented withdraw");
   }
+
+  /**
+   * @dev Simple passthrough method for testing Policy.initialize
+   */
+  function initializeAndEmitPolicy(
+    IRiskModule riskModule,
+    IRiskModule.Params memory rmParams,
+    uint256 premium,
+    uint256 payout,
+    uint256 lossProb,
+    uint40 expiration
+  ) external {
+    Policy.PolicyData memory policy = Policy.initialize(
+      riskModule,
+      rmParams,
+      premium,
+      payout,
+      lossProb,
+      expiration
+    );
+
+    emit NewPolicy(riskModule, policy);
+  }
 }
 
 /**

package/contracts/mocks/RiskModuleMock.sol

@@ -1,5 +1,4 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 import {IPolicyPool} from "../interfaces/IPolicyPool.sol";
@@ -66,4 +65,11 @@ contract RiskModuleMock is RiskModule {
   ) external onlyComponentRole(PRICER_ROLE) returns (uint256) {
     return _newPolicy(payout, premium, lossProb, expiration, payer, onBehalfOf, internalId).id;
   }
+
+  function resolvePolicy(Policy.PolicyData calldata policy, uint256 payout)
+    external
+    onlyComponentRole(RESOLVER_ROLE)
+  {
+    _policyPool.resolvePolicy(policy, payout);
+  }
 }