@ensuro/core 2.0.0-beta11 → 2.0.0-beta13

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,12 +1,14 @@
 {
   "name": "@ensuro/core",
   "description": "Ensuro - Decentralized insurance protocol",
-  "version": "2.0.0-beta11",
+  "version": "2.0.0-beta13",
   "files": [
     "**/*.sol",
     "/build/contracts/*.json",
     "/build/interfaces/*.json",
-    "/js/*.js"
+    "/js/*.js",
+    "/scripts/*.sh",
+    "/scripts/*.js"
   ],
   "repository": {
     "type": "git",

package/scripts/change-pragma.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+if [ $# -ne 2 ]; then
+    echo "Usage $0 <contracts-dir> <new-pragma>"
+    exit 1
+fi
+
+CONTRACTS_DIR=$1
+NEW_PRAGMA=$2
+
+MD5S=`mktemp`
+
+md5sum `find $CONTRACTS_DIR -name "*.sol"` > $MD5S
+
+for SOLFILE in `find $CONTRACTS_DIR -name "*.sol"`; do
+    sed -i -r "s/^pragma solidity [0-9^~.]+;/pragma solidity $NEW_PRAGMA;/g" $SOLFILE
+done
+
+md5sum --check $MD5S | sed 's/: OK/: UNCHANGED/g' | sed 's/: FAILED/: MODIFIED/g' | grep -v "md5sum: "

package/scripts/deploySmokeTest-fork.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+source `dirname $0`/utils.sh
+
+export DEPLOY_AMOUNT_DECIMALS=6
+
+resetAddresses
+
+if [ -z $ALCHEMY_URL ]; then
+    echo "Must set environment variable $ALCHEMY_URL"
+    exit 1
+fi
+
+startHHNode --fork $ALCHEMY_URL
+
+USDC=0x2791bca1f2de4661ed88a30c99a7a9449aa84174
+AAVE_ADDR_PROV=0xd05e3E715d945B59290df0ae8eF85c1BdB684744  # Polygon Aave
+SWAP_ROUTER=0x1b02dA8Cb0d097eB8D57A175b88c7D8b47997506  # Polygon SushiSwap
+PRICE_ORACLE=0x0229f777b0fab107f9591a41d5f02e4e98db6f2d  # Polygon Price Oracle of AAVE
+ENSURO_TREASURY=0xFDa400f51aD6490542Bc6336Ea14b2D8bf7b0c34
+
+npx hardhat --network $NETWORK deploy $VERIFY --currency-address $USDC \
+    --treasury-address $ENSURO_TREASURY || die "Error deploying pool"
+
+POOL=`readAddress POOL`
+ACCESSMANAGER=`readAddress ACCESSMANAGER`
+echo "PolicyPool = $POOL / AccessManager = $ACCESSMANAGER"
+
+for ROLE in LEVEL1 LEVEL2 LEVEL3; do
+  npx hardhat --network $NETWORK ens:grantRole --contract-address $ACCESSMANAGER \
+      --role ${ROLE}_ROLE || die "Error granting ${ROLE}_ROLE"
+done
+
+npx hardhat --network $NETWORK deploy:eToken  \
+    --etk-name "Junior ETK" --etk-symbol "eUSDJr" --save-addr JRETK \
+    --pool-address $POOL $VERIFY || die "Error deploying eToken"
+
+npx hardhat --network $NETWORK deploy:eToken  \
+    --etk-name "Senior ETK" --etk-symbol "eUSDSr" --save-addr SRETK \
+    --pool-address $POOL $VERIFY || die "Error deploying eToken"
+
+JRETK=`readAddress JRETK`
+SRETK=`readAddress SRETK`
+
+npx hardhat --network $NETWORK deploy:premiumsAccount $VERIFY \
+    --junior-etk $JRETK --senior-etk $SRETK \
+    --pool-address $POOL || die "Error deploying PremiumsAccount"
+
+PREMIUMS_ACCOUNT=`readAddress PA`
+
+echo "PremiumsAccount = $PREMIUMS_ACCOUNT"
+
+killPID $HHNODE_PID

package/scripts/deploySmokeTest.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+
+source `dirname $0`/utils.sh
+
+export DEPLOY_AMOUNT_DECIMALS=6
+
+resetAddresses
+
+startHHNode
+
+ENSURO_TREASURY=0xFDa400f51aD6490542Bc6336Ea14b2D8bf7b0c34
+
+npx hardhat --network $NETWORK deploy $VERIFY \
+    --treasury-address $ENSURO_TREASURY || die "Error deploying pool"
+
+POOL=`readAddress POOL`
+ACCESSMANAGER=`readAddress ACCESSMANAGER`
+echo "PolicyPool = $POOL / AccessManager = $ACCESSMANAGER"
+
+for ROLE in LEVEL1 LEVEL2 LEVEL3; do
+  npx hardhat --network $NETWORK ens:grantRole --contract-address $ACCESSMANAGER \
+      --role ${ROLE}_ROLE || die "Error granting ${ROLE}_ROLE"
+done
+
+npx hardhat --network $NETWORK deploy:eToken  \
+    --etk-name "Junior ETK" --etk-symbol "eUSDJr" --save-addr JRETK \
+    --pool-address $POOL $VERIFY || die "Error deploying eToken"
+
+npx hardhat --network $NETWORK deploy:eToken  \
+    --etk-name "Senior ETK" --etk-symbol "eUSDSr" --save-addr SRETK \
+    --pool-address $POOL $VERIFY || die "Error deploying eToken"
+
+JRETK=`readAddress JRETK`
+SRETK=`readAddress SRETK`
+
+npx hardhat --network $NETWORK deploy:premiumsAccount $VERIFY --pool-address $POOL \
+    --junior-etk $JRETK --senior-etk $SRETK || die "Error deploying Premiums Account"
+
+PREMIUMS_ACCOUNT=`readAddress PA`
+
+echo "PremiumsAccount = $PREMIUMS_ACCOUNT"
+
+npx hardhat --network $NETWORK deploy:riskModule $VERIFY --pool-address $POOL \
+    --pa-address $PREMIUMS_ACCOUNT \
+    --wallet 0x951B9B8a7b0e3701E757c015F43df9F2F867B824 || die "Error deploying riskModule"
+
+# Whitelist
+npx hardhat --network $NETWORK deploy:whitelist $VERIFY \
+    --pool-address $POOL --e-token $SRETK || die "Error deploying Whitelist"
+
+killPID $HHNODE_PID

package/scripts/storageLayout.js

@@ -0,0 +1,33 @@
+const hre = require("hardhat");
+const { artifacts } = require("hardhat");
+const { findAll } = require("solidity-ast/utils");
+const { getStorageLayout } = require("../test/test-utils");
+
+/**
+ * Script to print a contracts storage layout as a table.
+ *
+ * Example usage: node scripts/storageLayout.js EToken
+ */
+
+//
+
+async function main(contractSrc, contractName) {
+  await hre.run("compile");
+  const layout = await getStorageLayout(contractSrc, contractName);
+
+  const summary = layout.storage.map((item) => ({
+    slot: parseInt(item.slot),
+    label: item.label,
+    type: item.type,
+    numberOfBytes: parseInt(layout.types[item.type].numberOfBytes),
+    endSlot: parseInt(item.slot) + Math.floor(parseInt(layout.types[item.type].numberOfBytes) / 32),
+  }));
+  console.table(summary);
+}
+
+const [contractSrc, contractName] = [`contracts/${process.argv[2]}.sol`, process.argv[2]];
+
+console.log(`Storage layout for ${contractSrc}:${contractName}`);
+main(contractSrc, contractName).then(() => {
+  process.exit(0);
+});

package/scripts/utils.sh

@@ -0,0 +1,48 @@
+die() {
+    printf "ERROR: %s\n" "$*"
+    exit 1
+}
+
+dieOnError() {
+    if [ $? -ne 0 ]; then
+        die $1
+    fi
+}
+
+export DEPLOY_AMOUNT_DECIMALS=6
+
+NETWORK=${NETWORK:-localhost}
+
+startHHNode() {
+    if [ $NETWORK == "localhost" ]; then
+        HHNODE_RUNNING=`ps aux | grep "/.bin/hardhat node" | grep -v grep  | cut -c10-15`
+        if [ -z $HHNODE_RUNNING ]; then
+            START_HHNODE=1
+        fi
+    fi
+
+    if [ ! -z $START_HHNODE ]; then
+        echo "Starting hardhat node"
+        # npx hardhat node $* >/dev/null &
+        node_modules/.bin/hardhat node $* >/dev/null &
+
+        HHNODE_PID=$!
+        sleep 5
+        kill -0 $HHNODE_PID || die "Error launching hardhat node localhost"
+    fi
+}
+
+readAddress() {
+    python -c "import json; print(json.load(open('.addresses.json'))['$1'])"
+    exit $?
+}
+
+resetAddresses() {
+    python -c "open('.addresses.json', 'wt').write('{}')"
+}
+
+killPID() {
+    if [ ! -z $1 ]; then
+        kill $1
+    fi
+}