@ensuro/core 2.0.0-beta1 → 2.0.0-beta11

package/js/test-utils.js

@@ -1,61 +1,87 @@
 const { expect } = require("chai");
+const hre = require("hardhat");
 const { BigNumber } = require("ethers");
-const {LogDescription} = require("ethers/lib/utils");
+const { LogDescription } = require("ethers/lib/utils");
+const { findAll } = require("solidity-ast/utils");
+
 exports.WEEK = 3600 * 24 * 7;
 exports.DAY = 3600 * 24;
 
-exports.initCurrency = async function(options, initial_targets, initial_balances) {
-  const Currency = await ethers.getContractFactory("TestCurrency");
+exports.initCurrency = async function (options, initial_targets, initial_balances) {
+  const Currency = await hre.ethers.getContractFactory("TestCurrency");
   let currency = await Currency.deploy(
     options.name || "Test Currency",
     options.symbol || "TEST",
     options.initial_supply,
-    options.decimals || 18,
+    options.decimals || 18
   );
   initial_targets = initial_targets || [];
-  await Promise.all(initial_targets.map(async function (user, index) {
-    await currency.transfer(user.address, initial_balances[index]);
-  }));
+  await Promise.all(
+    initial_targets.map(async function (user, index) {
+      await currency.transfer(user.address, initial_balances[index]);
+    })
+  );
   return currency;
-}
+};
 
-exports.approve_multiple = async function(currency, spender, sources, amounts) {
-  return Promise.all(sources.map(async function (source, index) {
-    await currency.connect(source).approve(spender.address, amounts[index]);
-  }));
-}
+exports.approve_multiple = async function (currency, spender, sources, amounts) {
+  return Promise.all(
+    sources.map(async function (source, index) {
+      await currency.connect(source).approve(spender.address, amounts[index]);
+    })
+  );
+};
 
-exports.check_balances = async function(currency, users, amounts) {
-  return Promise.all(users.map(async function (user, index) {
-    expect(await currency.balanceOf(user.address)).to.equal(amounts[index]);
-  }));
-}
+exports.check_balances = async function (currency, users, amounts) {
+  return Promise.all(
+    users.map(async function (user, index) {
+      expect(await currency.balanceOf(user.address)).to.equal(amounts[index]);
+    })
+  );
+};
 
-exports.now = function() {
+exports.now = function () {
   return Math.floor(new Date().getTime() / 1000);
-}
-
-exports.addRiskModule = async function(pool, premiumsAccount, contractFactory, {
-      rmName, scrPercentage, scrInterestRate, ensuroFee, maxScrPerPolicy,
-      scrLimit, moc, wallet, extraArgs, extraConstructorArgs
-      }) {
+};
+
+const createRiskModule = async function (
+  pool,
+  premiumsAccount,
+  contractFactory,
+  {
+    rmName,
+    scrPercentage,
+    scrInterestRate,
+    ensuroFee,
+    maxScrPerPolicy,
+    scrLimit,
+    moc,
+    wallet,
+    extraArgs,
+    extraConstructorArgs,
+  }
+) {
   extraArgs = extraArgs || [];
   extraConstructorArgs = extraConstructorArgs || [];
   const _A = pool._A || _W;
-  const rm = await hre.upgrades.deployProxy(contractFactory, [
-    rmName || "RiskModule",
-    _W(scrPercentage) || _W(1),
-    _W(ensuroFee) || _W(0),
-    _W(scrInterestRate) || _W(0.1),
-    _A(maxScrPerPolicy) || _A(1000),
-    _A(scrLimit) || _A(1000000),
-    wallet || "0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC",  // Random address
-    ...extraArgs
-  ], {
-    kind: 'uups',
-    unsafeAllow: ["delegatecall"],
-    constructorArgs: [pool.address, premiumsAccount.address, ...extraConstructorArgs]
-  });
+  const rm = await hre.upgrades.deployProxy(
+    contractFactory,
+    [
+      rmName || "RiskModule",
+      _W(scrPercentage) || _W(1),
+      _W(ensuroFee) || _W(0),
+      _W(scrInterestRate) || _W("0.1"),
+      _A(maxScrPerPolicy) || _A(1000),
+      _A(scrLimit) || _A(1000000),
+      wallet || "0xdD2FD4581271e230360230F9337D5c0430Bf44C0", // Random address
+      ...extraArgs,
+    ],
+    {
+      kind: "uups",
+      unsafeAllow: ["delegatecall"],
+      constructorArgs: [pool.address, premiumsAccount.address, ...extraConstructorArgs],
+    }
+  );
 
   await rm.deployed();
 
@@ -63,66 +89,115 @@ exports.addRiskModule = async function(pool, premiumsAccount, contractFactory, {
     moc = _W(moc);
     await rm.setParam(0, moc);
   }
-  const policyPoolConfig = await hre.ethers.getContractAt("PolicyPoolConfig", await pool.config());
-  await policyPoolConfig.addRiskModule(rm.address);
   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(pool, {
-      etkName, etkSymbol, maxUtilizationRate,
-      poolLoanInterestRate, extraArgs, extraConstructorArgs
-      }) {
-  const EToken = await ethers.getContractFactory("EToken");
+const createEToken = async function (
+  pool,
+  { etkName, etkSymbol, maxUtilizationRate, poolLoanInterestRate, extraArgs, extraConstructorArgs }
+) {
+  const EToken = await hre.ethers.getContractFactory("EToken");
   extraArgs = extraArgs || [];
   extraConstructorArgs = extraConstructorArgs || [];
-  const etk = await hre.upgrades.deployProxy(EToken, [
-    etkName || "EToken",
-    etkSymbol || "eUSD1YEAR",
-    _W(maxUtilizationRate) || _W(1),
-    _W(poolLoanInterestRate) || _W("0.05"),
-    ...extraArgs
-  ], {
-    kind: 'uups',
-    unsafeAllow: ["delegatecall"],
-    constructorArgs: [pool.address, ...extraConstructorArgs]
-  });
+  const etk = await hre.upgrades.deployProxy(
+    EToken,
+    [
+      etkName === undefined ? "EToken" : etkName,
+      etkSymbol === undefined ? "eUSD1YEAR" : etkSymbol,
+      _W(maxUtilizationRate) || _W(1),
+      _W(poolLoanInterestRate) || _W("0.05"),
+      ...extraArgs,
+    ],
+    {
+      kind: "uups",
+      unsafeAllow: ["delegatecall"],
+      constructorArgs: [pool.address, ...extraConstructorArgs],
+    }
+  );
 
   await etk.deployed();
-  await pool.addEToken(etk.address);
   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;
+};
 
-exports.expected_change = async function(protocol_attribute, initial, change) {
+exports.expected_change = async function (protocol_attribute, initial, change) {
   change = BigNumber.from(change);
   let actual_value = await protocol_attribute();
   expect(actual_value.sub(initial)).to.equal(change);
   return actual_value;
-}
+};
 
-exports.impersonate = async function(address, setBalanceTo) {
-  const ok = await hre.network.provider.request(
-    {method: "hardhat_impersonateAccount", params: [address]}
-  );
-  if (!ok)
-    throw "Error impersonatting " + address;
+exports.impersonate = async function (address, setBalanceTo) {
+  const ok = await hre.network.provider.request({ method: "hardhat_impersonateAccount", params: [address] });
+  if (!ok) throw "Error impersonatting " + address;
 
   if (setBalanceTo !== undefined)
-    await hre.network.provider.request(
-      {method: "hardhat_setBalance", params: [address, setBalanceTo.toHexString()]}
-    );
-
-  return await ethers.getSigner(address);
-}
+    await hre.network.provider.request({ method: "hardhat_setBalance", params: [address, setBalanceTo.toHexString()] });
 
+  return await hre.ethers.getSigner(address);
+};
 
 /**
-* Finds an event in the receipt
-* @param {Interface} interface The interface of the contract that contains the requested event
-* @param {TransactionReceipt} receipt Transaction receipt containing the events in the logs
-* @param {String} eventName The name of the event we are interested in
-* @returns {LogDescription}
-*/
-exports.getTransactionEvent = function(interface, receipt, eventName) {
+ * Finds an event in the receipt
+ * @param {Interface} interface The interface of the contract that contains the requested event
+ * @param {TransactionReceipt} receipt Transaction receipt containing the events in the logs
+ * @param {String} eventName The name of the event we are interested in
+ * @returns {LogDescription}
+ */
+const getTransactionEvent = function (interface, receipt, eventName) {
   // for each log in the transaction receipt
   for (const log of receipt.events) {
     let parsedLog;
@@ -135,68 +210,88 @@ exports.getTransactionEvent = function(interface, receipt, eventName) {
       return parsedLog;
     }
   }
-  return null;  // not found
-}
+  return null; // not found
+};
 
-exports.deployPool = async function(hre, options) {
-  const PolicyPool = await ethers.getContractFactory("PolicyPool");
-  const PolicyPoolConfig = await ethers.getContractFactory("PolicyPoolConfig");
-  const PolicyNFT = await ethers.getContractFactory("PolicyNFT");
+exports.getTransactionEvent = getTransactionEvent;
 
-  // Deploy PolicyNFT
-  const policyNFT = await hre.upgrades.deployProxy(
-    PolicyNFT,
+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");
+
+  let accessManager;
+
+  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.policyPoolDetAddress || ethers.constants.AddressZero
+      options.nftName === undefined ? "Policy NFT" : options.nftName,
+      options.nftSymbol === undefined ? "EPOL" : options.nftSymbol,
+      options.treasuryAddress || randomAddress,
     ],
-    {kind: 'uups'}
+    {
+      constructorArgs: [accessManager.address, options.currency],
+      kind: "uups",
+      unsafeAllow: ["delegatecall"],
+    }
   );
-  await policyNFT.deployed();
-
-  // Deploy PolicyPoolConfig
-  const policyPoolConfig = await hre.upgrades.deployProxy(PolicyPoolConfig, [
-    options.policyPoolDetAddress || ethers.constants.AddressZero,
-    options.treasuryAddress || ethers.constants.AddressZero
-  ], {kind: 'uups'});
-
-  await policyPoolConfig.deployed();
-
-  const policyPool = await hre.upgrades.deployProxy(PolicyPool, [], {
-    constructorArgs: [policyPoolConfig.address, policyNFT.address, options.currency],
-    kind: 'uups',
-    unsafeAllow: ["delegatecall"],
-  });
 
   await policyPool.deployed();
 
-  for (const role of (options.grantRoles || [])) {
-    await grantRole(hre, policyPoolConfig, role);
+  for (const role of options.grantRoles || []) {
+    await grantRole(hre, accessManager, role);
+  }
+
+  if (options.dontGrantL123Roles === undefined) {
+    await grantRole(hre, accessManager, "LEVEL1_ROLE");
+    await grantRole(hre, accessManager, "LEVEL2_ROLE");
+    await grantRole(hre, accessManager, "LEVEL3_ROLE");
   }
 
-  await grantRole(hre, policyPoolConfig, "LEVEL1_ROLE");
-  await grantRole(hre, policyPoolConfig, "LEVEL2_ROLE");
-  await grantRole(hre, policyPoolConfig, "LEVEL3_ROLE");
   return policyPool;
-}
+};
 
-exports.deployPremiumsAccount = async function (hre, pool, options) {
-  const PremiumsAccount = await ethers.getContractFactory("PremiumsAccount");
+exports.deployPremiumsAccount = async function (hre, pool, options, addToPool = true) {
+  const PremiumsAccount = await hre.ethers.getContractFactory("PremiumsAccount");
   const premiumsAccount = await hre.upgrades.deployProxy(PremiumsAccount, [], {
     constructorArgs: [
       pool.address,
-      options.jrEtkAddr || ethers.constants.AddressZero,
-      options.srEtkAddr || ethers.constants.AddressZero,
+      options.jrEtkAddr || hre.ethers.constants.AddressZero,
+      options.srEtkAddr || hre.ethers.constants.AddressZero,
     ],
-    kind: 'uups',
+    kind: "uups",
     unsafeAllow: ["delegatecall"],
   });
 
   await premiumsAccount.deployed();
-  await pool.addPremiumsAccount(premiumsAccount.address);
+
+  if (addToPool) await pool.addComponent(premiumsAccount.address, 3);
+
   return premiumsAccount;
-}
+};
 
 async function _getDefaultSigner(hre) {
   const signers = await hre.ethers.getSigners();
@@ -211,68 +306,153 @@ async function grantRole(hre, contract, role, user) {
   } else {
     userAddress = user;
   }
-  const roleHex = ethers.utils.keccak256(ethers.utils.toUtf8Bytes(role));
-  if (!await contract.hasRole(roleHex, userAddress)) {
-    await contract.grantRole(roleHex, userAddress);
+  if (!(await contract.hasRole(getRole(role), userAddress))) {
+    await contract.grantRole(getRole(role), userAddress);
   }
 }
 
 exports.grantRole = grantRole;
 
-async function grantComponentRole(hre, contract, component, role, user) {
+async function grantComponentRole(hre, accessManager, component, role, user) {
   let userAddress;
   if (user === undefined) {
     user = await _getDefaultSigner(hre);
     userAddress = user.address;
   } else {
-    userAddress = user;
+    userAddress = user.address === undefined ? user : user.address;
   }
-  const roleHex = ethers.utils.keccak256(ethers.utils.toUtf8Bytes(role));
-  const componentRole = await contract.getComponentRole(component.address, roleHex);
-  if (!await contract.hasRole(componentRole, userAddress)) {
-    await contract.grantComponentRole(component.address, roleHex, userAddress);
+  const componentRole = getComponentRole(component.address, getRole(role));
+  if (!(await accessManager.hasRole(componentRole, userAddress))) {
+    await accessManager.grantComponentRole(component.address, getRole(role), userAddress);
   }
 }
 
 exports.grantComponentRole = grantComponentRole;
 
-exports._E = ethers.utils.parseEther;
-
-const _BN = ethers.BigNumber.from;
-const WAD = _BN(1e10).mul(_BN(1e8));  // 1e10*1e8=1e18
-const RAY = WAD.mul(_BN(1e9));  // 1e18*1e9=1e27
+const _E = hre.ethers.utils.parseEther;
+exports._E = _E;
 
+const _BN = hre.ethers.BigNumber.from;
 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);
+const WAD = _BN(10).pow(18); // 1e18
+exports.WAD = WAD;
+
+const RAY = _BN(10).pow(27); // 1e27
+exports.RAY = RAY;
+
+/**
+ * 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 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 = function(value) {
-  if (value === undefined)
-    return undefined;
-  if (!Number.isInteger(value))
-    return _BN(Math.round(value * 1e9)).mul(WAD);
-  return _BN(value).mul(RAY);
+const _R = amountFunction(27);
+exports._R = _R;
+
+/**
+ * Builds the component role identifier
+ *
+ * Mimics the behaviour of the PolicyPoolConfig.getComponentRole method
+ *
+ * Component roles are roles created doing XOR between the component
+ * address and the original role.
+ *
+ * Example:
+ *     getComponentRole("0xc6e7DF5E7b4f2A278906862b61205850344D4e7d", "ORACLE_ADMIN_ROLE")
+ *     // "0x05e01b185238b49f750d03d945e38a7f6c3be8b54de0ee42d481eb7814f0d3a8"
+ */
+function getComponentRole(componentAddress, roleName) {
+  // 32 byte array
+  const bytesRole = hre.ethers.utils.arrayify(getRole(roleName));
+
+  // 20 byte array
+  const bytesAddress = hre.ethers.utils.arrayify(componentAddress);
+
+  // xor each byte, padding bytesAddress with zeros at the end
+  return hre.ethers.utils.hexlify(bytesRole.map((elem, idx) => elem ^ (bytesAddress[idx] || 0)));
 }
 
-exports._R = _R;
+exports.getComponentRole = getComponentRole;
 
-exports.amountFunction = function (decimals) {
-  // Decimals must be at least 6
-  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 _BN(Math.round(value * 1e6)).mul(_BN(Math.pow(10, decimals - 6)));
-    }
+/*
+Builds AccessControl error message for comparison in tests
+*/
+function accessControlMessage(address, component, role) {
+  const roleHash = component !== null ? getComponentRole(component, role) : getRole(role);
+
+  return `AccessControl: account ${address.toLowerCase()} is missing role ${roleHash}`;
+}
+
+exports.accessControlMessage = accessControlMessage;
+
+function makePolicyId(rm, internalId) {
+  return hre.ethers.BigNumber.from(rm.address).shl(96).add(internalId);
+}
+
+exports.makePolicyId = makePolicyId;
+
+async function makePolicy(pool, rm, cust, payout, premium, lossProb, expiration, internalId) {
+  let tx = await rm.connect(cust).newPolicy(payout, premium, lossProb, expiration, cust.address, internalId);
+  let receipt = await tx.wait();
+  const newPolicyEvt = getTransactionEvent(pool.interface, receipt, "NewPolicy");
+
+  return newPolicyEvt;
+}
+
+exports.makePolicy = makePolicy;
+
+async function blockchainNow(owner) {
+  return (await owner.provider.getBlock("latest")).timestamp;
+}
+
+exports.blockchainNow = blockchainNow;
+
+function getRole(role) {
+  return role === "DEFAULT_ADMIN_ROLE"
+    ? "0x0000000000000000000000000000000000000000000000000000000000000000"
+    : hre.ethers.utils.keccak256(hre.ethers.utils.toUtf8Bytes(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,7 +1,7 @@
 {
   "name": "@ensuro/core",
   "description": "Ensuro - Decentralized insurance protocol",
-  "version": "2.0.0-beta1",
+  "version": "2.0.0-beta11",
   "files": [
     "**/*.sol",
     "/build/contracts/*.json",