@ensuro/core 2.0.0-beta9 → 2.0.0

package/js/test-utils.js

@@ -2,6 +2,8 @@ const { expect } = require("chai");
 const hre = require("hardhat");
 const { BigNumber } = require("ethers");
 const { LogDescription } = require("ethers/lib/utils");
+const { findAll } = require("solidity-ast/utils");
+
 exports.WEEK = 3600 * 24 * 7;
 exports.DAY = 3600 * 24;
 
@@ -42,7 +44,7 @@ exports.now = function () {
   return Math.floor(new Date().getTime() / 1000);
 };
 
-exports.addRiskModule = async function (
+const createRiskModule = async function (
   pool,
   premiumsAccount,
   contractFactory,
@@ -68,7 +70,7 @@ exports.addRiskModule = async function (
       rmName || "RiskModule",
       _W(scrPercentage) || _W(1),
       _W(ensuroFee) || _W(0),
-      _W(scrInterestRate) || _W(0.1),
+      _W(scrInterestRate) || _W("0.1"),
       _A(maxScrPerPolicy) || _A(1000),
       _A(scrLimit) || _A(1000000),
       wallet || "0xdD2FD4581271e230360230F9337D5c0430Bf44C0", // Random address
@@ -87,11 +89,46 @@ exports.addRiskModule = async function (
     moc = _W(moc);
     await rm.setParam(0, moc);
   }
+  return rm;
+};
+
+exports.createRiskModule = createRiskModule;
+
+exports.addRiskModule = async function (
+  pool,
+  premiumsAccount,
+  contractFactory,
+  {
+    rmName,
+    scrPercentage,
+    scrInterestRate,
+    ensuroFee,
+    maxScrPerPolicy,
+    scrLimit,
+    moc,
+    wallet,
+    extraArgs,
+    extraConstructorArgs,
+  }
+) {
+  const rm = await createRiskModule(pool, premiumsAccount, contractFactory, {
+    rmName,
+    scrPercentage,
+    scrInterestRate,
+    ensuroFee,
+    maxScrPerPolicy,
+    scrLimit,
+    moc,
+    wallet,
+    extraArgs,
+    extraConstructorArgs,
+  });
+
   await pool.addComponent(rm.address, 2);
   return rm;
 };
 
-exports.addEToken = async function (
+const createEToken = async function (
   pool,
   { etkName, etkSymbol, maxUtilizationRate, poolLoanInterestRate, extraArgs, extraConstructorArgs }
 ) {
@@ -101,8 +138,8 @@ exports.addEToken = async function (
   const etk = await hre.upgrades.deployProxy(
     EToken,
     [
-      etkName || "EToken",
-      etkSymbol || "eUSD1YEAR",
+      etkName === undefined ? "EToken" : etkName,
+      etkSymbol === undefined ? "eUSD1YEAR" : etkSymbol,
       _W(maxUtilizationRate) || _W(1),
       _W(poolLoanInterestRate) || _W("0.05"),
       ...extraArgs,
@@ -115,6 +152,23 @@ exports.addEToken = async function (
   );
 
   await etk.deployed();
+  return etk;
+};
+
+exports.createEToken = createEToken;
+
+exports.addEToken = async function (
+  pool,
+  { etkName, etkSymbol, maxUtilizationRate, poolLoanInterestRate, extraArgs, extraConstructorArgs }
+) {
+  const etk = await createEToken(pool, {
+    etkName,
+    etkSymbol,
+    maxUtilizationRate,
+    poolLoanInterestRate,
+    extraArgs,
+    extraConstructorArgs,
+  });
   await pool.addComponent(etk.address, 1);
   return etk;
 };
@@ -161,21 +215,42 @@ const getTransactionEvent = function (interface, receipt, eventName) {
 
 exports.getTransactionEvent = getTransactionEvent;
 
+const randomAddress = "0x89cDb70Fee571251a66E34caa1673cE40f7549Dc";
+
+/**
+ * Deploys de PolicyPool contract and AccessManager
+ *
+ * By default deployes de PolicyPool and AccessManager and grants LEVEL 1, 2, 3 permissions
+ *
+ * options:
+ * - .currency: mandatory, the address of the currency used in the PolicyPool
+ * - .access: if specified, doesn't create an AccessManager, uses this address.toLowerCase
+ * - .nftName: default "Policy NFT"
+ * - .nftSymbol: default "EPOL"
+ * - .treasuryAddress: default randomAddress
+ * - .grantRoles: default []. List of additional roles to grant
+ * - .dontGrantL123Roles: if specified, doesn't grants LEVEL1, 2 and 3 roles.
+ */
 exports.deployPool = async function (hre, options) {
   const PolicyPool = await hre.ethers.getContractFactory("PolicyPool");
   const AccessManager = await hre.ethers.getContractFactory("AccessManager");
 
-  // Deploy AccessManager
-  const accessManager = await hre.upgrades.deployProxy(AccessManager, [], { kind: "uups" });
+  let accessManager;
 
-  await accessManager.deployed();
+  if (options.access === undefined) {
+    // Deploy AccessManager
+    accessManager = await hre.upgrades.deployProxy(AccessManager, [], { kind: "uups" });
+    await accessManager.deployed();
+  } else {
+    accessManager = await hre.ethers.getContractAt("AccessManager", options.access);
+  }
 
   const policyPool = await hre.upgrades.deployProxy(
     PolicyPool,
     [
-      options.nftName || "Policy NFT",
-      options.nftSymbol || "EPOL",
-      options.treasuryAddress || hre.ethers.constants.AddressZero,
+      options.nftName === undefined ? "Policy NFT" : options.nftName,
+      options.nftSymbol === undefined ? "EPOL" : options.nftSymbol,
+      options.treasuryAddress || randomAddress,
     ],
     {
       constructorArgs: [accessManager.address, options.currency],
@@ -190,9 +265,12 @@ exports.deployPool = async function (hre, options) {
     await grantRole(hre, accessManager, role);
   }
 
-  await grantRole(hre, accessManager, "LEVEL1_ROLE");
-  await grantRole(hre, accessManager, "LEVEL2_ROLE");
-  await grantRole(hre, accessManager, "LEVEL3_ROLE");
+  if (options.dontGrantL123Roles === undefined) {
+    await grantRole(hre, accessManager, "LEVEL1_ROLE");
+    await grantRole(hre, accessManager, "LEVEL2_ROLE");
+    await grantRole(hre, accessManager, "LEVEL3_ROLE");
+  }
+
   return policyPool;
 };
 
@@ -251,41 +329,48 @@ async function grantComponentRole(hre, accessManager, component, role, user) {
 
 exports.grantComponentRole = grantComponentRole;
 
-exports._E = hre.ethers.utils.parseEther;
+const _E = hre.ethers.utils.parseEther;
+exports._E = _E;
 
 const _BN = hre.ethers.BigNumber.from;
-const WAD = _BN(1e10).mul(_BN(1e8)); // 1e10*1e8=1e18
-const RAY = WAD.mul(_BN(1e9)); // 1e18*1e9=1e27
-
 exports._BN = _BN;
 
-const _W = function (value) {
-  if (value === undefined) return undefined;
-  if (!Number.isInteger(value)) return _BN(Math.round(value * 1e9)).mul(_BN(1e9));
-  return _BN(value).mul(WAD);
-};
-
-exports._W = _W;
+const WAD = _BN(10).pow(18); // 1e18
+exports.WAD = WAD;
 
-const _R = function (value) {
-  if (value === undefined) return undefined;
-  if (!Number.isInteger(value)) return _BN(Math.round(value * 1e9)).mul(WAD);
-  return _BN(value).mul(RAY);
-};
-
-exports._R = _R;
+const RAY = _BN(10).pow(27); // 1e27
+exports.RAY = RAY;
 
-exports.amountFunction = function (decimals) {
-  // Decimals must be at least 6
+/**
+ * Creates a fixed-point conversion function for the desired number of decimals
+ * @param decimals The number of decimals. Must be >= 6.
+ * @returns The amount function created. The function can receive strings (recommended),
+ *          floats/doubles (not recommended) and integers.
+ *
+ *          Floats will be rounded to 6 decimal before scaling.
+ */
+function amountFunction(decimals) {
   return function (value) {
     if (value === undefined) return undefined;
+
     if (typeof value === "string" || value instanceof String) {
-      return _BN(value).mul(_BN(Math.pow(10, decimals)));
-    } else {
+      return hre.ethers.utils.parseUnits(value, decimals);
+    }
+
+    if (!Number.isInteger(value)) {
       return _BN(Math.round(value * 1e6)).mul(_BN(Math.pow(10, decimals - 6)));
     }
+
+    return _BN(value).mul(_BN(10).pow(decimals));
   };
-};
+}
+exports.amountFunction = amountFunction;
+
+const _W = amountFunction(18);
+exports._W = _W;
+
+const _R = amountFunction(27);
+exports._R = _R;
 
 /**
  * Builds the component role identifier
@@ -353,4 +438,21 @@ function getRole(role) {
 
 exports.getRole = getRole;
 
+async function getStorageLayout(contractSrc, contractName) {
+  const buildInfo = await hre.artifacts.getBuildInfo(`${contractSrc}:${contractName}`);
+  if (buildInfo === undefined) throw new Error(`Contract ${contractSrc}:${contractName} not in artifacts`);
+
+  const solcOutput = buildInfo.output;
+
+  const storageLayouts = {};
+
+  for (const def of findAll("ContractDefinition", solcOutput.sources[contractSrc].ast)) {
+    storageLayouts[def.name] = solcOutput.contracts[contractSrc][def.name].storageLayout;
+  }
+
+  return storageLayouts[contractName];
+}
+
+exports.getStorageLayout = getStorageLayout;
+
 if (process.env.ENABLE_HH_WARNINGS !== "yes") hre.upgrades.silenceWarnings();

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@ensuro/core",
   "description": "Ensuro - Decentralized insurance protocol",
-  "version": "v2.0.0-beta9",
+  "version": "2.0.0",
   "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,65 @@
+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() {
+    if [ -z $ADDRESSES_FILENAME ]; then
+        export ADDRESSES_FILENAME=".addresses-$NETWORK.json"
+    fi
+    python -c "import json; print(json.load(open('$ADDRESSES_FILENAME'))['$1'])"
+    exit $?
+}
+
+resetAddresses() {
+    if [ -z $ADDRESSES_FILENAME ]; then
+        export ADDRESSES_FILENAME=".addresses-$NETWORK.json"
+    fi
+    python -c "open('$ADDRESSES_FILENAME', 'wt').write('{}')"
+}
+
+readPK() {
+    if [ $NETWORK != "localhost" ]; then
+        PK_VAR=${NETWORK^^}_ACCOUNTPK_1
+
+        if [ -z ${!PK_VAR} ]; then
+            read -p "Please enter the PK for the account: " -s $PK_VAR
+            export $PK_VAR
+        fi
+    fi
+}
+
+killPID() {
+    if [ ! -z $1 ]; then
+        kill $1
+    fi
+}