@ensuro/core 2.6.1 → 2.7.0

package/contracts/mocks/PolicyHolderMock.sol

@@ -3,18 +3,36 @@ pragma solidity ^0.8.0;
 
 import {IPolicyHolder} from "../interfaces/IPolicyHolder.sol";
 import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 contract PolicyHolderMock is IPolicyHolder {
   uint256 public policyId;
   uint256 public payout;
   bool public fail;
+  bool public emptyRevert;
   bool public notImplemented;
+  bool public badlyImplemented;
+  bool public noERC165;
 
-  event NotificationReceived(uint256 kind, uint256 policyId, address operator, address from);
+  enum NotificationKind {
+    PolicyReceived,
+    PayoutReceived,
+    PolicyExpired
+  }
 
-  constructor(bool fail_) {
-    fail = fail_;
+  event NotificationReceived(
+    NotificationKind kind,
+    uint256 policyId,
+    address operator,
+    address from
+  );
+
+  constructor() {
+    fail = false;
     notImplemented = false;
+    badlyImplemented = false;
+    emptyRevert = false;
+    noERC165 = false;
     payout = type(uint256).max;
   }
 
@@ -26,20 +44,50 @@ contract PolicyHolderMock is IPolicyHolder {
     notImplemented = notImplemented_;
   }
 
+  function setBadlyImplemented(bool badlyImplemented_) external {
+    badlyImplemented = badlyImplemented_;
+  }
+
+  function setNoERC165(bool noERC165_) external {
+    noERC165 = noERC165_;
+  }
+
+  function setEmptyRevert(bool emptyRevert_) external {
+    emptyRevert = emptyRevert_;
+  }
+
+  /**
+   * @dev See {IERC165-supportsInterface}.
+   */
+  function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
+    if (noERC165)
+      assembly {
+        revert(0, 0)
+      }
+    if (notImplemented) return false;
+    return
+      interfaceId == type(IPolicyHolder).interfaceId || interfaceId == type(IERC165).interfaceId;
+  }
+
   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");
+    if (fail)
+      if (emptyRevert)
+        assembly {
+          revert(0, 0)
+        }
+      else revert("onERC721Received: They told me I have to fail");
+
     policyId = policyId_;
-    emit NotificationReceived(0, policyId_, operator, from);
+    payout = type(uint256).max;
+    emit NotificationReceived(NotificationKind.PolicyReceived, policyId_, operator, from);
+
+    if (badlyImplemented) return bytes4(0x0badf00d);
+
     return IERC721Receiver.onERC721Received.selector;
   }
 
@@ -48,15 +96,18 @@ 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");
+    if (fail)
+      if (emptyRevert)
+        assembly {
+          revert(0, 0)
+        }
+      else revert("onPolicyExpired: They told me I have to fail");
     policyId = policyId_;
     payout = 0;
-    emit NotificationReceived(1, policyId_, operator, from);
+    emit NotificationReceived(NotificationKind.PolicyExpired, policyId_, operator, from);
+
+    if (badlyImplemented) return bytes4(0x0badf00d);
+
     return IPolicyHolder.onPolicyExpired.selector;
   }
 
@@ -75,15 +126,18 @@ 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");
+    if (fail)
+      if (emptyRevert)
+        assembly {
+          revert(0, 0)
+        }
+      else revert("onPayoutReceived: They told me I have to fail");
     policyId = policyId_;
     payout = amount;
-    emit NotificationReceived(2, policyId_, operator, from);
+    emit NotificationReceived(NotificationKind.PayoutReceived, policyId_, operator, from);
+
+    if (badlyImplemented) return bytes4(0x0badf00d);
+
     return IPolicyHolder.onPayoutReceived.selector;
   }
 }

package/js/constants.js

@@ -1,7 +1,13 @@
-const WEEK = 3600 * 24 * 7;
-const DAY = 3600 * 24;
+const HOUR = 3600;
+const WEEK = HOUR * 24 * 7;
+const DAY = HOUR * 24;
+
+// From https://eips.ethereum.org/EIPS/eip-1967
+const IMPLEMENTATION_SLOT = "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc";
 
 module.exports = {
   WEEK,
   DAY,
+  HOUR,
+  IMPLEMENTATION_SLOT,
 };

package/js/deploy.js

@@ -1,7 +1,6 @@
 const upgrades_core = require("@openzeppelin/upgrades-core");
 const helpers = require("@nomicfoundation/hardhat-network-helpers");
 const fs = require("fs");
-const { request } = require("undici");
 const ethers = require("ethers");
 const { task, types } = require("hardhat/config");
 const { WhitelistStatus } = require("../js/enums");
@@ -78,39 +77,33 @@ async function logContractCreated(hre, contractName, address) {
 async function verifyContract(hre, contract, isProxy, constructorArguments) {
   if (isProxy === undefined) isProxy = false;
   if (constructorArguments === undefined) constructorArguments = [];
-  let address = contract.address;
-  if (isProxy) address = await upgrades_core.getImplementationAddress(hre.network.provider, address);
+  const address = isProxy
+    ? await upgrades_core.getImplementationAddress(hre.network.provider, contract.address)
+    : contract.address;
   try {
     await hre.run("verify:verify", {
       address: address,
       constructorArguments: constructorArguments,
     });
+  } catch (error) {
+    console.log("Error verifying contract implementation: ", error);
+    console.log("You can retry with:");
+    console.log(
+      `    npx hardhat verify --network '${hre.network.name}' '${address}' ${constructorArguments
+        .map((a) => `'${a.toString()}'`)
+        .join(" ")}`
+    );
+  }
+  try {
     if (isProxy) {
-      // the following should work but it fails with the current @openzeppelin/hardhat-upgrades version (1.20.0)
-      // await hre.run("verify:verify", {
-      //   address: contract.address,
-      // });
-
-      // so we use the following workaround
-      const endpoints = await hre.run("verify:get-etherscan-endpoint");
-      const params = new URLSearchParams({
-        module: "contract",
-        action: "verifyproxycontract",
-        apiKey: hre.config.etherscan.apiKey,
+      await hre.run("verify:verify", {
         address: contract.address,
       });
-      const response = await request(endpoints.urls.apiURL, {
-        method: "POST",
-        headers: { "Content-Type": "application/x-www-form-urlencoded" },
-        body: params.toString(),
-      });
-      if (response.statusCode != 200)
-        throw new Error(`Etherscan replied with ${response.statusCode}: ${await response.body.text()}`);
-      const body = await response.body.json();
-      if (body.status != 1) throw new Error(`Etherscan replied with ${body}`);
     }
   } catch (error) {
-    console.log("Error verifying contract", error);
+    console.log("Error verifying contract proxy: ", error);
+    const endpoints = await hre.run("verify:get-etherscan-endpoint");
+    console.log(`You should do it manually at ${endpoints.urls.browserURL}/proxyContractChecker?a=${contract.address}`);
   }
 }
 
@@ -264,8 +257,11 @@ async function deployRiskModule(
   },
   hre
 ) {
-  extraArgs = extraArgs || [];
-  extraConstructorArgs = extraConstructorArgs || [];
+  extraArgs = typeof extraArgs === "string" ? JSON.parse(extraArgs) : extraArgs || [];
+
+  extraConstructorArgs =
+    typeof extraConstructorArgs === "string" ? JSON.parse(extraConstructorArgs) : extraConstructorArgs || [];
+
   const { contract } = await deployProxyContract(
     {
       contractClass: rmClass,
@@ -583,6 +579,8 @@ function add_task() {
     .addOptionalParam("exposureLimit", "Exposure (sum of payouts) limit for the RM", 1e6, types.float)
     .addOptionalParam("maxDuration", "Maximum policy duration in hours", 24 * 365, types.int)
     .addOptionalParam("moc", "Margin of Conservativism", 1.0, types.float)
+    .addOptionalParam("extraConstructorArgs", "Additional constructor args", undefined, types.str)
+    .addOptionalParam("extraArgs", "Additional initializer args", undefined, types.str)
     .addParam("wallet", "RM address", types.address)
     .setAction(deployRiskModule);
 

package/js/enums.js

@@ -4,7 +4,29 @@ const WhitelistStatus = {
   blacklisted: 2,
 };
 
+const ComponentKind = {
+  eToken: 1,
+  riskModule: 2,
+  premiumsAccount: 3,
+};
+
+const ComponentStatus = {
+  inactive: 0,
+  active: 1,
+  deprecated: 2,
+  suspended: 3,
+};
+
+const ETokenParameter = {
+  // From IEToken.Parameter
+  liquidityRequirement: 0,
+  minUtilizationRate: 1,
+  maxUtilizationRate: 2,
+  internalLoanInterestRate: 3,
+};
+
 const RiskModuleParameter = {
+  // From IRiskModule.Parameter
   moc: 0,
   jrCollRatio: 1,
   collRatio: 2,
@@ -17,14 +39,10 @@ const RiskModuleParameter = {
   maxDuration: 9,
 };
 
-const ComponentKind = {
-  eToken: 1,
-  riskModule: 2,
-  premiumsAccount: 3,
-};
-
 module.exports = {
-  WhitelistStatus,
-  RiskModuleParameter,
   ComponentKind,
+  ComponentStatus,
+  ETokenParameter,
+  RiskModuleParameter,
+  WhitelistStatus,
 };

package/js/test-utils.js

@@ -1,11 +1,13 @@
 const hre = require("hardhat");
 const { _W, grantRole, getTransactionEvent } = require("../js/utils");
 const { RiskModuleParameter } = require("../js/enums");
+const helpers = require("@nomicfoundation/hardhat-network-helpers");
 
-const { AddressZero } = hre.ethers.constants;
+const { ethers } = hre;
+const { AddressZero } = ethers.constants;
 
 async function initCurrency(options, initial_targets, initial_balances) {
-  const Currency = await hre.ethers.getContractFactory("TestCurrency");
+  const Currency = await ethers.getContractFactory(options.contractClass || "TestCurrency");
   let currency = await Currency.deploy(
     options.name || "Test Currency",
     options.symbol || "TEST",
@@ -21,6 +23,26 @@ async function initCurrency(options, initial_targets, initial_balances) {
   return currency;
 }
 
+/**
+ *
+ * @param currencyAddress The currency contract address, for example the USDC address
+ * @param currencyOrigin An account that holds at least sum(initialBalances) of currency tokens
+ * @param initialTargets Array of addresses that will receive the initial balances
+ * @param initialBalances Initial balances for each address
+ */
+async function initForkCurrency(currencyAddress, currencyOrigin, initialTargets, initialBalances) {
+  const currency = await ethers.getContractAt("IERC20", currencyAddress);
+  await helpers.impersonateAccount(currencyOrigin);
+  await helpers.setBalance(currencyOrigin, ethers.utils.parseEther("100"));
+  const whale = await ethers.getSigner(currencyOrigin);
+  await Promise.all(
+    initialTargets.map(async function (user, index) {
+      await currency.connect(whale).transfer(user.address, initialBalances[index]);
+    })
+  );
+  return currency;
+}
+
 async function createRiskModule(
   pool,
   premiumsAccount,
@@ -106,7 +128,7 @@ async function createEToken(
   pool,
   { etkName, etkSymbol, maxUtilizationRate, poolLoanInterestRate, extraArgs, extraConstructorArgs }
 ) {
-  const EToken = await hre.ethers.getContractFactory("EToken");
+  const EToken = await ethers.getContractFactory("EToken");
   extraArgs = extraArgs || [];
   extraConstructorArgs = extraConstructorArgs || [];
   const etk = await hre.upgrades.deployProxy(
@@ -162,8 +184,8 @@ const randomAddress = "0x89cDb70Fee571251a66E34caa1673cE40f7549Dc";
  * - .dontGrantL123Roles: if specified, doesn't grants LEVEL1, 2 and 3 roles.
  */
 async function deployPool(options) {
-  const PolicyPool = await hre.ethers.getContractFactory("PolicyPool");
-  const AccessManager = await hre.ethers.getContractFactory("AccessManager");
+  const PolicyPool = await ethers.getContractFactory("PolicyPool");
+  const AccessManager = await ethers.getContractFactory("AccessManager");
 
   let accessManager;
 
@@ -172,7 +194,7 @@ async function deployPool(options) {
     accessManager = await hre.upgrades.deployProxy(AccessManager, [], { kind: "uups" });
     await accessManager.deployed();
   } else {
-    accessManager = await hre.ethers.getContractAt("AccessManager", options.access);
+    accessManager = await ethers.getContractAt("AccessManager", options.access);
   }
 
   const policyPool = await hre.upgrades.deployProxy(
@@ -204,7 +226,7 @@ async function deployPool(options) {
 }
 
 async function deployPremiumsAccount(pool, options, addToPool = true) {
-  const PremiumsAccount = await hre.ethers.getContractFactory("PremiumsAccount");
+  const PremiumsAccount = await ethers.getContractFactory("PremiumsAccount");
   const premiumsAccount = await hre.upgrades.deployProxy(PremiumsAccount, [], {
     constructorArgs: [pool.address, options.jrEtkAddr || AddressZero, options.srEtkAddr || AddressZero],
     kind: "uups",
@@ -226,6 +248,51 @@ async function makePolicy(pool, rm, cust, payout, premium, lossProb, expiration,
   return newPolicyEvt;
 }
 
+/**
+ * Resets hardhat network to fork on the specified block and url
+ */
+async function setupChain(block, alchemyUrlEnv = "ALCHEMY_URL") {
+  const alchemyUrl = process.env[alchemyUrlEnv];
+  if (alchemyUrl === undefined) throw new Error(`Define envvar ${alchemyUrlEnv} for this test`);
+
+  if (block === undefined) throw new Error("Block can't be undefined use null for the current block");
+  if (block === null) block = undefined;
+  return hre.network.provider.request({
+    method: "hardhat_reset",
+    params: [
+      {
+        forking: {
+          jsonRpcUrl: alchemyUrl,
+          blockNumber: block,
+        },
+      },
+    ],
+  });
+}
+
+const skipForkTests = process.env.SKIP_FORK_TESTS === "true";
+
+/**
+ * Chai test case wrapper for tests that require forking a live chain.
+ *
+ * It validates that the chain node URL is set, forks the chain at the specified block and adds the
+ * block number to the test name.
+ */
+const fork = {
+  it: (name, blockNumber, test, alchemyUrlEnv = "ALCHEMY_URL") => {
+    const fullName = `[FORK ${blockNumber}] ${name}`;
+
+    // eslint-disable-next-line func-style
+    const wrapped = async (...args) => {
+      await setupChain(blockNumber, alchemyUrlEnv);
+
+      return test(...args);
+    };
+
+    return (skipForkTests ? it.skip : it)(fullName, wrapped);
+  },
+};
+
 if (process.env.ENABLE_HH_WARNINGS !== "yes") hre.upgrades.silenceWarnings();
 
 module.exports = {
@@ -235,6 +302,10 @@ module.exports = {
   createRiskModule,
   deployPool,
   deployPremiumsAccount,
+  fork,
   initCurrency,
+  initForkCurrency,
   makePolicy,
+  setupChain,
+  skipForkTests,
 };

package/js/utils.js

@@ -1,6 +1,7 @@
 const { findAll } = require("solidity-ast/utils");
 const ethers = require("ethers");
 const helpers = require("@nomicfoundation/hardhat-network-helpers");
+const { DAY, IMPLEMENTATION_SLOT } = require("./constants");
 
 const _E = ethers.utils.parseEther;
 const _BN = ethers.BigNumber.from;
@@ -234,12 +235,26 @@ async function defaultPolicyParams(
     payout: payout || _A(1000),
     premium: premium || ethers.constants.MaxUint256,
     lossProb: lossProb || _W(0.1),
-    expiration: expiration || now + 3600 * 24 * 30,
+    expiration: expiration || now + DAY * 30,
     policyData: policyData || ethers.utils.hexlify(ethers.utils.randomBytes(32)),
-    validUntil: validUntil || now + 3600 * 24 * 30,
+    validUntil: validUntil || now + DAY * 30,
   };
 }
 
+async function readImplementationAddress(contractAddress) {
+  const implStorage = await ethers.provider.getStorageAt(contractAddress, IMPLEMENTATION_SLOT);
+  return ethers.utils.getAddress(ethers.utils.hexDataSlice(implStorage, 12));
+}
+
+/**
+ * Converts a string value to uint256(keccak(value))
+ * @param {string} value
+ * @returns {ethers.BigNumber}
+ */
+function uintKeccak(value) {
+  return ethers.BigNumber.from(ethers.utils.keccak256(ethers.utils.toUtf8Bytes(value)));
+}
+
 module.exports = {
   _BN,
   _E,
@@ -260,5 +275,7 @@ module.exports = {
   makeQuoteMessage,
   makeSignedQuote,
   RAY,
+  readImplementationAddress,
+  uintKeccak,
   WAD,
 };

package/package.json

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