@ensuro/core 2.0.0-beta11 → 2.0.0-beta12

package/contracts/SignedQuoteRiskModule.sol

@@ -22,6 +22,12 @@ contract SignedQuoteRiskModule is RiskModule {
   /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
   bool internal immutable _creationIsOpen;
 
+  /**
+   * @dev Event emitted every time a new policy is created. It allows to link the policyData with a particular policy
+   *
+   * @param policyId The id of the policy
+   * @param policyData The value sent in `policyData` parameter that's the hash of the off-chain stored data.
+   */
   event NewSignedPolicy(uint256 indexed policyId, bytes32 policyData);
 
   /// @custom:oz-upgrades-unsafe-allow constructor
@@ -74,7 +80,7 @@ contract SignedQuoteRiskModule is RiskModule {
     uint40 quoteValidUntil,
     address payer,
     address onBehalfOf
-  ) internal returns (uint256 policyId) {
+  ) internal returns (Policy.PolicyData memory createdPolicy) {
     if (!_creationIsOpen)
       _policyPool.access().checkComponentRole(
         address(this),
@@ -108,33 +114,92 @@ contract SignedQuoteRiskModule is RiskModule {
     _policyPool.access().checkComponentRole(address(this), PRICER_ROLE, signer, false);
     uint96 internalId = uint96(uint256(policyData) % 2**96);
 
-    policyId = _newPolicy(payout, premium, lossProb, expiration, payer, onBehalfOf, internalId).id;
-    emit NewSignedPolicy(policyId, policyData);
-    return policyId;
+    createdPolicy = _newPolicy(
+      payout,
+      premium,
+      lossProb,
+      expiration,
+      payer,
+      onBehalfOf,
+      internalId
+    );
+    emit NewSignedPolicy(createdPolicy.id, policyData);
+    return createdPolicy;
+  }
+
+  /**
+  * @dev Creates a new Policy using a signed quote. The caller is the payer of the policy. Returns all the struct, not
+   * just the id.
+   *
+   * Same as {newPolicy} but returns all the PolicyData struct, usefull if the PolicyData needs to be stored on-chain.
+  *
+  * Requirements:
+  * - The caller approved the spending of the premium to the PolicyPool
+  * - The quote has been signed by an address with the component role PRICER_ROLE
+  *
+  * Emits:
+  * - {PolicyPool.NewPolicy}
+  * - {NewSignedPolicy}
+  *
+  * @param payout The exposure (maximum payout) of the policy
+  * @param premium The premium that will be paid by the payer
+  * @param lossProb The probability of having to pay the maximum payout (wad)
+  * @param expiration The expiration of the policy (timestamp)
+  * @param onBehalfOf The policy holder
+  * @param policyData A hash of the private details of the policy. The last 96 bits will be used as internalId
+  * @param quoteSignatureR The signature of the quote. R component (EIP-2098 signature)
+  * @param quoteSignatureVS The signature of the quote. VS component (EIP-2098 signature)
+  * @param quoteValidUntil The expiration of the quote
+  * @return createdPolicy Returns the created policy
+  */
+  function newPolicyFull(
+    uint256 payout,
+    uint256 premium,
+    uint256 lossProb,
+    uint40 expiration,
+    address onBehalfOf,
+    bytes32 policyData,
+    bytes32 quoteSignatureR,
+    bytes32 quoteSignatureVS,
+    uint40 quoteValidUntil
+  ) external returns (Policy.PolicyData memory createdPolicy) {
+    return
+      _newPolicySigned(
+        payout,
+        premium,
+        lossProb,
+        expiration,
+        policyData,
+        quoteSignatureR,
+        quoteSignatureVS,
+        quoteValidUntil,
+        _msgSender(),
+        onBehalfOf
+      );
   }
 
   /**
-   * @dev Creates a new Policy using a signed quote. The caller is the payer of the policy.
-   *
-   * Requirements:
-   * - The caller approved the spending of the premium to the PolicyPool
-   * - The quote has been signed by an address with the component role PRICER_ROLE
-   *
-   * Emits:
-   * - {PolicyPool.NewPolicy}
-   * - {NewSignedPolicy}
-   *
-   * @param payout The exposure (maximum payout) of the policy
-   * @param premium The premium that will be paid by the payer
-   * @param lossProb The probability of having to pay the maximum payout (wad)
-   * @param expiration The expiration of the policy (timestamp)
-   * @param onBehalfOf The policy holder
-   * @param policyData A hash of the private details of the policy. The last 96 bits will be used as internalId
-   * @param quoteSignatureR The signature of the "quote". R component (EIP-2098 signature)
-   * @param quoteSignatureVS The signature of the "quote". VS component (EIP-2098 signature)
-   * @param quoteValidUntil The expiration of the quote
-   * @return Returns the id of the created policy
-   */
+  * @dev Creates a new Policy using a signed quote. The caller is the payer of the policy.
+  *
+  * Requirements:
+  * - The caller approved the spending of the premium to the PolicyPool
+  * - The quote has been signed by an address with the component role PRICER_ROLE
+  *
+  * Emits:
+  * - {PolicyPool.NewPolicy}
+  * - {NewSignedPolicy}
+  *
+  * @param payout The exposure (maximum payout) of the policy
+  * @param premium The premium that will be paid by the payer
+  * @param lossProb The probability of having to pay the maximum payout (wad)
+  * @param expiration The expiration of the policy (timestamp)
+  * @param onBehalfOf The policy holder
+  * @param policyData A hash of the private details of the policy. The last 96 bits will be used as internalId
+  * @param quoteSignatureR The signature of the quote. R component (EIP-2098 signature)
+  * @param quoteSignatureVS The signature of the quote. VS component (EIP-2098 signature)
+  * @param quoteValidUntil The expiration of the quote
+  * @return Returns the id of the created policy
+  */
   function newPolicy(
     uint256 payout,
     uint256 premium,
@@ -158,31 +223,31 @@ contract SignedQuoteRiskModule is RiskModule {
         quoteValidUntil,
         _msgSender(),
         onBehalfOf
-      );
+      ).id;
   }
 
   /**
-   * @dev Creates a new Policy using a signed quote. The payer is the policy holder
-   *
-   * Requirements:
-   * - currency().allowance(onBehalfOf, _msgSender()) > 0
-   * - The quote has been signed by an address with the component role PRICER_ROLE
-   *
-   * Emits:
-   * - {PolicyPool.NewPolicy}
-   * - {NewSignedPolicy}
-   *
-   * @param payout The exposure (maximum payout) of the policy
-   * @param premium The premium that will be paid by the payer
-   * @param lossProb The probability of having to pay the maximum payout (wad)
-   * @param expiration The expiration of the policy (timestamp)
-   * @param onBehalfOf The policy holder
-   * @param policyData A hash of the private details of the policy. The last 96 bits will be used as internalId
-   * @param quoteSignatureR The signature of the "quote". R component (EIP-2098 signature)
-   * @param quoteSignatureVS The signature of the "quote". VS component (EIP-2098 signature)
-   * @param quoteValidUntil The expiration of the quote
-   * @return Returns the id of the created policy
-   */
+  * @dev Creates a new Policy using a signed quote. The payer is the policy holder
+  *
+  * Requirements:
+  * - currency().allowance(onBehalfOf, _msgSender()) > 0
+  * - The quote has been signed by an address with the component role PRICER_ROLE
+  *
+  * Emits:
+  * - {PolicyPool.NewPolicy}
+  * - {NewSignedPolicy}
+  *
+  * @param payout The exposure (maximum payout) of the policy
+  * @param premium The premium that will be paid by the payer
+  * @param lossProb The probability of having to pay the maximum payout (wad)
+  * @param expiration The expiration of the policy (timestamp)
+  * @param onBehalfOf The policy holder
+  * @param policyData A hash of the private details of the policy. The last 96 bits will be used as internalId
+  * @param quoteSignatureR The signature of the quote. R component (EIP-2098 signature)
+  * @param quoteSignatureVS The signature of the quote. VS component (EIP-2098 signature)
+  * @param quoteValidUntil The expiration of the quote
+  * @return Returns the id of the created policy
+  */
   function newPolicyPaidByHolder(
     uint256 payout,
     uint256 premium,
@@ -220,7 +285,7 @@ contract SignedQuoteRiskModule is RiskModule {
         quoteValidUntil,
         onBehalfOf,
         onBehalfOf
-      );
+      ).id;
   }
 
   function resolvePolicy(Policy.PolicyData calldata policy, uint256 payout)

package/contracts/TrustfulRiskModule.sol

@@ -79,7 +79,57 @@ contract TrustfulRiskModule is RiskModule {
     address onBehalfOf,
     uint96 internalId
   ) external onlyComponentRole(PRICER_ROLE) returns (uint256) {
-    address payer = onBehalfOf;
+    return
+      _newPolicy(
+        payout,
+        premium,
+        lossProb,
+        expiration,
+        _getPayer(onBehalfOf, premium),
+        onBehalfOf,
+        internalId
+      ).id;
+  }
+
+  /**
+   * @dev Creates a new Policy. Version that returns all the PolicyData struct, not just the id.
+   *
+   * Requirements:
+   * - The caller has been granted componentRole(PRICER_ROLE)
+   *
+   * Emits:
+   * - {PolicyPool.NewPolicy}
+   *
+   * @param payout The exposure (maximum payout) of the policy
+   * @param premium The premium that will be paid by the policyHolder
+   * @param lossProb The probability of having to pay the maximum payout (wad)
+   * @param expiration The expiration of the policy (timestamp)
+   * @param onBehalfOf The policy holder
+   * @param internalId An id that's unique within this module and it will be used to identify the policy
+   * @return createdPolicy Returns the id of the created policy
+   */
+  function newPolicyFull(
+    uint256 payout,
+    uint256 premium,
+    uint256 lossProb,
+    uint40 expiration,
+    address onBehalfOf,
+    uint96 internalId
+  ) external onlyComponentRole(PRICER_ROLE) returns (Policy.PolicyData memory createdPolicy) {
+    return
+      _newPolicy(
+        payout,
+        premium,
+        lossProb,
+        expiration,
+        _getPayer(onBehalfOf, premium),
+        onBehalfOf,
+        internalId
+      );
+  }
+
+  function _getPayer(address onBehalfOf, uint256 premium) internal returns (address payer) {
+    payer = onBehalfOf;
     if (payer != _msgSender() && _policyPool.currency().allowance(payer, _msgSender()) < premium)
       /**
        * The standard is the payer should be the _msgSender() but usually, in this type of module,
@@ -93,8 +143,7 @@ contract TrustfulRiskModule is RiskModule {
        * premium even for multiple policies.
        */
       payer = _msgSender();
-
-    return _newPolicy(payout, premium, lossProb, expiration, payer, onBehalfOf, internalId).id;
+    return payer;
   }
 
   /**

package/contracts/interfaces/IPolicyPool.sol

@@ -101,12 +101,23 @@ interface IPolicyPool {
   function expirePolicy(Policy.PolicyData calldata policy) external;
 
   /**
-   * @dev Returns whether or not a policy is active
-   * @param policyId The id of the policy we are querying
-   * @return Returns true if a policy with that id was created and wasn't yet resolved or expired, or false otherwise.
+   * @dev Returns whether a policy is active, i.e., it's still in the PolicyPool, not yet resolved or expired.
+   *      Be aware that a policy might be active but the `block.timestamp` might be after the expiration date, so it
+   *      can't be triggered with a payout.
+   *
+   * @param policyId The id of the policy queried
+   * @return Whether the policy is active or not
    */
   function isActive(uint256 policyId) external view returns (bool);
 
+  /**
+   * @dev Returns the stored hash of the policy. It's `bytes32(0)` is the policy isn't active.
+   *
+   * @param policyId The id of the policy queried
+   * @return Returns the hash of a given policy id
+   */
+  function getPolicyHash(uint256 policyId) external view returns (bytes32);
+
   /**
    * @dev Deposits liquidity into an eToken. Forwards the call to {EToken-deposit}, after transferring the funds.
    * The user will receive etokens for the same amount deposited.

package/contracts/mocks/PolicyPoolMock.sol

@@ -85,6 +85,10 @@ contract PolicyPoolMock is IPolicyPool {
     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");
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ensuro/core",
   "description": "Ensuro - Decentralized insurance protocol",
-  "version": "2.0.0-beta11",
+  "version": "2.0.0-beta12",
   "files": [
     "**/*.sol",
     "/build/contracts/*.json",