@ensuro/core 2.8.3 → 2.9.1

package/js/utils.js

@@ -1,182 +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.parseEther;
-const WAD = 10n ** 18n; // 1e18
-const RAY = 10n ** 27n; // 1e27
-
-function getAddress(addressable) {
-  return addressable.address || addressable.target || addressable;
-}
-
-async function getStorageLayout(hre, 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];
-}
-
-/**
- * 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 ethers.parseUnits(value, decimals);
-    }
-
-    if (!Number.isInteger(value)) {
-      return BigInt(Math.round(value * 1e6).toString()) * BigInt(Math.pow(10, decimals - 6).toString());
-    }
-
-    return BigInt(value.toString()) * BigInt("10") ** BigInt(decimals.toString());
-  };
-}
-
-/** Wad function */
-const _W = amountFunction(18);
-
-/** Ray function */
-const _R = amountFunction(27);
-
-/**
- * Returns a role identifier by computing the keccak of the role name.
- */
-function getRole(role) {
-  if (role.startsWith("0x")) return role;
-  return role === "DEFAULT_ADMIN_ROLE" ? ethers.ZeroHash : ethers.keccak256(ethers.toUtf8Bytes(role));
-}
-
-/**
- * Builds the component role identifier
- *
- * Mimics the behaviour of the AccessManager.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, role) {
-  if (!role.startsWith("0x")) role = getRole(role);
-
-  // 32 byte array
-  const bytesRole = ethers.getBytes(role);
-
-  // 20 byte array
-  const bytesAddress = ethers.getBytes(componentAddress);
-
-  // xor each byte, padding bytesAddress with zeros at the end
-  // eslint-disable-next-line no-bitwise
-  return ethers.hexlify(bytesRole.map((elem, idx) => elem ^ (bytesAddress[idx] || 0)));
-}
-
-async function getDefaultSigner(hre) {
-  const signers = await hre.ethers.getSigners();
-  return signers[0];
-}
-
-/**
- * Grant a component role to a user.
- */
-// eslint-disable-next-line no-empty-function
-async function grantComponentRole(hre, contract, component, role, user, txOverrides = {}, log = () => {}) {
-  let userAddress;
-  if (user === undefined) {
-    user = await getDefaultSigner(hre);
-    userAddress = user.address;
-  } else {
-    userAddress = user.address === undefined ? user : user.address;
-  }
-  const roleHex = getRole(role);
-  const componentAddress = component.address || component;
-  const componentRole = await contract.getComponentRole(componentAddress, roleHex);
-  if (!(await contract.hasRole(componentRole, userAddress))) {
-    await contract.grantComponentRole(componentAddress, roleHex, userAddress, txOverrides);
-    log(`Role ${role} (${roleHex}) Component ${componentAddress} granted to ${userAddress}`);
-  } else {
-    log(`Role ${role} (${roleHex}) Component ${componentAddress} already granted to ${userAddress}`);
-  }
-}
-
-/**
- * Grant a role to a user
- */
-// eslint-disable-next-line no-empty-function
-async function grantRole(hre, contract, role, user, txOverrides = {}, log = () => {}) {
-  let userAddress;
-  if (user === undefined) {
-    user = await getDefaultSigner(hre);
-    userAddress = user.address;
-  } else {
-    userAddress = user.address === undefined ? user : user.address;
-  }
-  const roleHex = getRole(role);
-  if (!(await contract.hasRole(roleHex, userAddress))) {
-    await contract.grantRole(roleHex, userAddress, txOverrides);
-    log(`Role ${role} (${roleHex}) granted to ${userAddress}`);
-  } else {
-    log(`Role ${role} (${roleHex}) already granted to ${userAddress}`);
-  }
-}
-
-/**
- * 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
- * @param {Boolean} firstOnly If false, returns all the events matching the name
- * @param {String} contractAddress If not null, if returns only those events generated by the specified contract
- * @returns {LogDescription}
- */
-function getTransactionEvent(interface, receipt, eventName, firstOnly = true, contractAddress = null) {
-  const ret = [];
-  // for each log in the transaction receipt
-  for (const log of receipt.logs) {
-    let parsedLog;
-    if (contractAddress !== null && contractAddress !== log.address) continue;
-    try {
-      parsedLog = interface.parseLog(log);
-    } catch (error) {
-      continue;
-    }
-    if (parsedLog?.name == eventName) {
-      if (firstOnly) return parsedLog;
-      ret.push(parsedLog);
-    }
-  }
-  return firstOnly ? null : ret;
-}
-
-/**
- * Builds AccessControl error message for comparison in tests
- */
-function accessControlMessage(user, component, role) {
-  const userAddr = getAddress(user);
-  const compAddr = component !== null ? getAddress(component) : component;
-  const roleHash = component !== null ? getComponentRole(compAddr, role) : getRole(role);
-
-  return `AccessControl: account ${userAddr.toLowerCase()} is missing role ${roleHash}`;
-}
+const { DAY } = require("@ensuro/utils/js/constants");
+const { amountFunction, getAddress, _W } = require("@ensuro/utils/js/utils");
 
 /**
  * Create a policy id by combining the riskmodule address and the internal id.
@@ -203,6 +28,31 @@ function makeQuoteMessage({ rmAddress, payout, premium, lossProb, expiration, po
   );
 }
 
+function paramsAsUint256(params) {
+  /* eslint no-bitwise: "off" */
+  return (
+    (params.moc << 240n) |
+    (params.jrCollRatio << 224n) |
+    (params.collRatio << 208n) |
+    (params.ensuroPpFee << 192n) |
+    (params.ensuroCocFee << 176n) |
+    (params.jrRoc << 160n) |
+    (params.srRoc << 144n)
+  );
+}
+
+/**
+ * Create a packed quote message for later signing or hashing.
+ *
+ * Mimics the behaviour of the FullSignedBucketRiskModule._checkFullSignature method.
+ */
+function makeFullQuoteMessage({ rmAddress, payout, premium, lossProb, expiration, policyData, params, validUntil }) {
+  return ethers.solidityPacked(
+    ["address", "uint256", "uint256", "uint256", "uint40", "bytes32", "uint256", "uint40"],
+    [rmAddress, payout, premium, lossProb, expiration, policyData, paramsAsUint256(params), validUntil]
+  );
+}
+
 /**
  * Create a packed quote message for later signing or hashing.
  *
@@ -263,6 +113,42 @@ async function defaultPolicyParams(
   };
 }
 
+async function defaultPolicyParamsWithBucket(opts, _A = amountFunction(6)) {
+  const ret = await defaultPolicyParams(opts, _A);
+  return { bucketId: opts.bucketId || 0, ...ret };
+}
+
+async function defaultPolicyParamsWithParams(opts, _A = amountFunction(6)) {
+  const ret = await defaultPolicyParams(opts, _A);
+  // struct PackedParams {
+  //   uint16 moc; // Margin Of Conservativism - factor that multiplies lossProb - 4 decimals
+  //   uint16 jrCollRatio; // Collateralization Ratio to compute Junior solvency as % of payout - 4 decimals
+  //   uint16 collRatio; // Collateralization Ratio to compute solvency requirement as % of payout - 4 decimals
+  //   uint16 ensuroPpFee; // % of pure premium that will go for Ensuro treasury - 4 decimals
+  //   uint16 ensuroCocFee; // % of CoC that will go for Ensuro treasury - 4 decimals
+  //   uint16 jrRoc; // Return on Capital paid to Junior LPs - Annualized Percentage - 4 decimals
+  //   uint16 srRoc; // Return on Capital paid to Senior LPs - Annualized Percentage - 4 decimals
+  //   uint32 maxPayoutPerPolicy; // Max Payout per Policy - 2 decimals
+  //   uint32 exposureLimit; // Max exposure (sum of payouts) to be allocated to this module - 0 decimals
+  //   uint16 maxDuration; // Max policy duration (in hours)
+  // }
+  const optsParams = opts.params || {};
+  const wadTo4Decimals = 10n ** 14n;
+  const params = {
+    moc: (optsParams.moc || _W(1)) / wadTo4Decimals,
+    jrCollRatio: (optsParams.jrCollRatio || 0n) / wadTo4Decimals,
+    collRatio: (optsParams.collRatio || _W(1)) / wadTo4Decimals,
+    ensuroPpFee: (optsParams.ensuroPpFee || 0n) / wadTo4Decimals,
+    ensuroCocFee: (optsParams.ensuroCocFee || 0n) / wadTo4Decimals,
+    jrRoc: (optsParams.jrRoc || 0n) / wadTo4Decimals,
+    srRoc: (optsParams.srRoc || _W("0.1")) / wadTo4Decimals, // 10%
+    maxPayoutPerPolicy: 0n, // Not used
+    exposureLimit: 0n, // Not used
+    maxDuration: 0n, // Not used
+  };
+  return { params, ...ret };
+}
+
 function defaultBucketParams({ moc, jrCollRatio, collRatio, ensuroPpFee, ensuroCocFee, jrRoc, srRoc }) {
   return {
     moc: moc !== undefined ? moc : _W("1.1"),
@@ -278,43 +164,16 @@ function defaultBucketParams({ moc, jrCollRatio, collRatio, ensuroPpFee, ensuroC
   };
 }
 
-async function readImplementationAddress(hre, contractAddress) {
-  const implStorage = await hre.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 BigInt(ethers.keccak256(ethers.toUtf8Bytes(value)));
-}
-
 module.exports = {
-  _E,
-  _R,
-  _W,
-  accessControlMessage,
-  amountFunction,
   defaultPolicyParams,
+  defaultPolicyParamsWithBucket,
+  defaultPolicyParamsWithParams,
   defaultBucketParams,
-  getAddress,
-  getComponentRole,
-  getDefaultSigner,
-  getRole,
-  getStorageLayout,
-  getTransactionEvent,
-  grantComponentRole,
-  grantRole,
   makeBucketQuoteMessage,
+  makeFullQuoteMessage,
+  paramsAsUint256,
   makePolicyId,
   makeQuoteMessage,
   makeSignedQuote,
-  RAY,
-  readImplementationAddress,
   recoverAddress,
-  uintKeccak,
-  WAD,
 };

package/package.json

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

package/scripts/deploySmokeTest-fork.sh

@@ -26,7 +26,7 @@ POOL=`readAddress POOL`
 ACCESSMANAGER=`readAddress ACCESSMANAGER`
 echo "PolicyPool = $POOL / AccessManager = $ACCESSMANAGER"
 
-for ROLE in LEVEL1 LEVEL2 LEVEL3; do
+for ROLE in LEVEL1 LEVEL2; do
   npx hardhat --network $NETWORK ens:grantRole --contract-address $ACCESSMANAGER \
       --role ${ROLE}_ROLE || die "Error granting ${ROLE}_ROLE"
 done

package/scripts/deploySmokeTest.sh

@@ -17,7 +17,7 @@ POOL=`readAddress POOL`
 ACCESSMANAGER=`readAddress ACCESSMANAGER`
 echo "PolicyPool = $POOL / AccessManager = $ACCESSMANAGER"
 
-for ROLE in LEVEL1 LEVEL2 LEVEL3; do
+for ROLE in LEVEL1 LEVEL2; do
   npx hardhat --network $NETWORK ens:grantRole --contract-address $ACCESSMANAGER \
       --role ${ROLE}_ROLE || die "Error granting ${ROLE}_ROLE"
 done