@nexusmutual/sdk 0.2.31 → 0.3.0

package/dist/index.js

@@ -1,8 +1,13 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -16,11 +21,179 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
+// node_modules/dotenv/package.json
+var require_package = __commonJS({
+  "node_modules/dotenv/package.json"(exports, module2) {
+    module2.exports = {
+      name: "dotenv",
+      version: "16.0.3",
+      description: "Loads environment variables from .env file",
+      main: "lib/main.js",
+      types: "lib/main.d.ts",
+      exports: {
+        ".": {
+          require: "./lib/main.js",
+          types: "./lib/main.d.ts",
+          default: "./lib/main.js"
+        },
+        "./config": "./config.js",
+        "./config.js": "./config.js",
+        "./lib/env-options": "./lib/env-options.js",
+        "./lib/env-options.js": "./lib/env-options.js",
+        "./lib/cli-options": "./lib/cli-options.js",
+        "./lib/cli-options.js": "./lib/cli-options.js",
+        "./package.json": "./package.json"
+      },
+      scripts: {
+        "dts-check": "tsc --project tests/types/tsconfig.json",
+        lint: "standard",
+        "lint-readme": "standard-markdown",
+        pretest: "npm run lint && npm run dts-check",
+        test: "tap tests/*.js --100 -Rspec",
+        prerelease: "npm test",
+        release: "standard-version"
+      },
+      repository: {
+        type: "git",
+        url: "git://github.com/motdotla/dotenv.git"
+      },
+      keywords: [
+        "dotenv",
+        "env",
+        ".env",
+        "environment",
+        "variables",
+        "config",
+        "settings"
+      ],
+      readmeFilename: "README.md",
+      license: "BSD-2-Clause",
+      devDependencies: {
+        "@types/node": "^17.0.9",
+        decache: "^4.6.1",
+        dtslint: "^3.7.0",
+        sinon: "^12.0.1",
+        standard: "^16.0.4",
+        "standard-markdown": "^7.1.0",
+        "standard-version": "^9.3.2",
+        tap: "^15.1.6",
+        tar: "^6.1.11",
+        typescript: "^4.5.4"
+      },
+      engines: {
+        node: ">=12"
+      }
+    };
+  }
+});
+
+// node_modules/dotenv/lib/main.js
+var require_main = __commonJS({
+  "node_modules/dotenv/lib/main.js"(exports, module2) {
+    "use strict";
+    var fs = require("fs");
+    var path = require("path");
+    var os = require("os");
+    var packageJson = require_package();
+    var version = packageJson.version;
+    var LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\\'|[^'])*'|\s*"(?:\\"|[^"])*"|\s*`(?:\\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg;
+    function parse(src) {
+      const obj = {};
+      let lines = src.toString();
+      lines = lines.replace(/\r\n?/mg, "\n");
+      let match;
+      while ((match = LINE.exec(lines)) != null) {
+        const key = match[1];
+        let value = match[2] || "";
+        value = value.trim();
+        const maybeQuote = value[0];
+        value = value.replace(/^(['"`])([\s\S]*)\1$/mg, "$2");
+        if (maybeQuote === '"') {
+          value = value.replace(/\\n/g, "\n");
+          value = value.replace(/\\r/g, "\r");
+        }
+        obj[key] = value;
+      }
+      return obj;
+    }
+    function _log(message) {
+      console.log(`[dotenv@${version}][DEBUG] ${message}`);
+    }
+    function _resolveHome(envPath) {
+      return envPath[0] === "~" ? path.join(os.homedir(), envPath.slice(1)) : envPath;
+    }
+    function config(options) {
+      let dotenvPath = path.resolve(process.cwd(), ".env");
+      let encoding = "utf8";
+      const debug = Boolean(options && options.debug);
+      const override = Boolean(options && options.override);
+      if (options) {
+        if (options.path != null) {
+          dotenvPath = _resolveHome(options.path);
+        }
+        if (options.encoding != null) {
+          encoding = options.encoding;
+        }
+      }
+      try {
+        const parsed = DotenvModule.parse(fs.readFileSync(dotenvPath, { encoding }));
+        Object.keys(parsed).forEach(function(key) {
+          if (!Object.prototype.hasOwnProperty.call(process.env, key)) {
+            process.env[key] = parsed[key];
+          } else {
+            if (override === true) {
+              process.env[key] = parsed[key];
+            }
+            if (debug) {
+              if (override === true) {
+                _log(`"${key}" is already defined in \`process.env\` and WAS overwritten`);
+              } else {
+                _log(`"${key}" is already defined in \`process.env\` and was NOT overwritten`);
+              }
+            }
+          }
+        });
+        return { parsed };
+      } catch (e) {
+        if (debug) {
+          _log(`Failed to load ${dotenvPath} ${e.message}`);
+        }
+        return { error: e };
+      }
+    }
+    var DotenvModule = {
+      config,
+      parse
+    };
+    module2.exports.config = DotenvModule.config;
+    module2.exports.parse = DotenvModule.parse;
+    module2.exports = DotenvModule;
+  }
+});
+
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  COMMISSION_DENOMINATOR: () => COMMISSION_DENOMINATOR,
+  CoverAsset: () => CoverAsset,
+  CoverId: () => CoverId,
+  DEFAULT_COMMISSION_RATIO: () => DEFAULT_COMMISSION_RATIO,
+  DEFAULT_SLIPPAGE: () => DEFAULT_SLIPPAGE,
+  MAXIMUM_COVER_PERIOD: () => MAXIMUM_COVER_PERIOD,
+  MINIMUM_COVER_PERIOD: () => MINIMUM_COVER_PERIOD,
+  NEXUS_MUTUAL_DAO_TREASURY_ADDRESS: () => NEXUS_MUTUAL_DAO_TREASURY_ADDRESS,
+  SLIPPAGE_DENOMINATOR: () => SLIPPAGE_DENOMINATOR,
+  TARGET_PRICE_DENOMINATOR: () => TARGET_PRICE_DENOMINATOR,
   allLogoFileNames: () => allLogoFileNames,
   allLogoNames: () => allLogoNames,
   calculateEthForExactNxm: () => calculateEthForExactNxm,
@@ -31,11 +204,14 @@ __export(src_exports, {
   calculatePriceImpactA: () => calculatePriceImpactA,
   calculatePriceImpactB: () => calculatePriceImpactB,
   calculateSpotPrice: () => calculateSpotPrice,
+  default: () => src_default,
+  getQuoteAndBuyCoverInputs: () => getQuoteAndBuyCoverInputs,
   productTypes: () => product_types_default,
-  products: () => products_default
+  products: () => products_default,
+  sumPoolCapacities: () => sumPoolCapacities
 });
 module.exports = __toCommonJS(src_exports);
-__reExport(src_exports, require("@nexusmutual/deployments"), module.exports);
+var deployments = __toESM(require("@nexusmutual/deployments"));
 
 // generated/products.json
 var products_default = [
@@ -1400,7 +1576,7 @@ var products_default = [
       "DAI"
     ],
     isPrivate: true,
-    timestamp: 1684312727
+    timestamp: 1704981731
   },
   {
     id: 84,
@@ -1462,7 +1638,7 @@ var products_default = [
       "DAI"
     ],
     isPrivate: true,
-    timestamp: 1684312727
+    timestamp: 1704981731
   },
   {
     id: 88,
@@ -1556,7 +1732,7 @@ var products_default = [
       "DAI"
     ],
     isPrivate: true,
-    timestamp: 1684312727
+    timestamp: 1704981731
   },
   {
     id: 94,
@@ -1740,7 +1916,7 @@ var products_default = [
       "DAI"
     ],
     isPrivate: true,
-    timestamp: 1689782903
+    timestamp: 1704980411
   },
   {
     id: 106,
@@ -2205,7 +2381,7 @@ var products_default = [
       "ETH"
     ],
     isPrivate: false,
-    timestamp: 1709311739
+    timestamp: 1709310707
   },
   {
     id: 137,
@@ -2531,7 +2707,7 @@ var products_default = [
     productType: 11,
     isDeprecated: false,
     useFixedPrice: false,
-    logo: "eigenlayer-renzo.svg",
+    logo: "lyra-synthetix.svg",
     metadata: {
       annex: "QmYfSDbuQLqJ2MAG3ATRjUPVFQubAhAM5oiYuuu9Kfs8RY"
     },
@@ -2548,7 +2724,7 @@ var products_default = [
     productType: 11,
     isDeprecated: false,
     useFixedPrice: false,
-    logo: "lyra-synthetix.svg",
+    logo: "eigenlayer-renzo.svg",
     metadata: {
       annex: "QmWWBqHBumXtHTkD6coEio8rWCJ68s9xheCqFS4kMRpW2R"
     },
@@ -2572,7 +2748,7 @@ var products_default = [
       "ETH",
       "DAI"
     ],
-    isPrivate: false,
+    isPrivate: true,
     timestamp: 1712739011
   }
 ];
@@ -2673,6 +2849,11 @@ var product_types_default = [
 ];
 
 // generated/types.ts
+var types_exports = {};
+__export(types_exports, {
+  allLogoFileNames: () => allLogoFileNames,
+  allLogoNames: () => allLogoNames
+});
 var allLogoFileNames = [
   "zerox.svg",
   "oneinch.svg",
@@ -2831,8 +3012,8 @@ var allLogoFileNames = [
   "eigenlayer-renzo-pendle.svg",
   "eigenlayer-swell-pendle.svg",
   "arcadia.svg",
-  "eigenlayer-renzo.svg",
   "lyra-synthetix.svg",
+  "eigenlayer-renzo.svg",
   "liquidcollective.svg",
   "aave-v1.svg",
   "akropolis.svg",
@@ -3046,8 +3227,8 @@ var allLogoNames = [
   "eigenlayer-renzo-pendle",
   "eigenlayer-swell-pendle",
   "arcadia",
-  "eigenlayer-renzo",
   "lyra-synthetix",
+  "eigenlayer-renzo",
   "liquidcollective",
   "aave-v1",
   "akropolis",
@@ -3104,6 +3285,18 @@ var allLogoNames = [
   "zksync"
 ];
 
+// src/swap/index.ts
+var swap_exports = {};
+__export(swap_exports, {
+  calculateEthForExactNxm: () => calculateEthForExactNxm,
+  calculateExactEthForNxm: () => calculateExactEthForNxm,
+  calculateExactNxmForEth: () => calculateExactNxmForEth,
+  calculateNxmForExactEth: () => calculateNxmForExactEth,
+  calculatePriceImpactA: () => calculatePriceImpactA,
+  calculatePriceImpactB: () => calculatePriceImpactB,
+  calculateSpotPrice: () => calculateSpotPrice
+});
+
 // src/swap/calculateExactNxmForEth.ts
 var calculateExactNxmForEth = (ethIn, reserves) => {
   if (ethIn <= 0n)
@@ -3177,9 +3370,30 @@ var calculatePriceImpactB = (nxmIn, reserves) => {
   return BigInt(1e6) - BigInt(1e6) * ethOut / ethOutAtSpotPrice;
 };
 
+// src/buyCover/index.ts
+var buyCover_exports = {};
+__export(buyCover_exports, {
+  calculatePremiumWithCommissionAndSlippage: () => calculatePremiumWithCommissionAndSlippage
+});
+
 // src/constants/buyCover.ts
+var CoverAsset = /* @__PURE__ */ ((CoverAsset2) => {
+  CoverAsset2[CoverAsset2["ETH"] = 0] = "ETH";
+  CoverAsset2[CoverAsset2["DAI"] = 1] = "DAI";
+  return CoverAsset2;
+})(CoverAsset || {});
+var CoverId = /* @__PURE__ */ ((CoverId2) => {
+  CoverId2[CoverId2["BUY"] = 0] = "BUY";
+  return CoverId2;
+})(CoverId || {});
 var COMMISSION_DENOMINATOR = 1e4;
 var SLIPPAGE_DENOMINATOR = 1e4;
+var TARGET_PRICE_DENOMINATOR = 1e4;
+var MINIMUM_COVER_PERIOD = 28;
+var MAXIMUM_COVER_PERIOD = 365;
+var DEFAULT_SLIPPAGE = 10;
+var DEFAULT_COMMISSION_RATIO = 1500;
+var NEXUS_MUTUAL_DAO_TREASURY_ADDRESS = "0x586b9b2F8010b284A0197f392156f1A7Eb5e86e9";
 
 // src/buyCover/calculatePremiumWithCommissionAndSlippage.ts
 var calculatePremiumWithCommissionAndSlippage = (premium, commission = 0, slippage = 0) => {
@@ -3187,8 +3401,175 @@ var calculatePremiumWithCommissionAndSlippage = (premium, commission = 0, slippa
   const premiumWithCommissionAndSlippage = premiumWithCommission * BigInt(SLIPPAGE_DENOMINATOR + slippage) / BigInt(SLIPPAGE_DENOMINATOR);
   return premiumWithCommissionAndSlippage;
 };
+
+// src/types/index.ts
+var types_exports2 = {};
+
+// src/quote/index.ts
+var quote_exports = {};
+__export(quote_exports, {
+  getQuoteAndBuyCoverInputs: () => getQuoteAndBuyCoverInputs,
+  sumPoolCapacities: () => sumPoolCapacities
+});
+
+// src/quote/getQuoteAndBuyCoverInputs.ts
+var import_axios = __toESM(require("axios"));
+var import_dotenv = __toESM(require_main());
+import_dotenv.default.config();
+async function getQuoteAndBuyCoverInputs(productId, coverAmount, coverPeriod, coverAsset, coverBuyerAddress, slippage = DEFAULT_SLIPPAGE, ipfsCid = "") {
+  if (!process.env.COVER_ROUTER_URL) {
+    return { result: void 0, error: { message: "Missing COVER_ROUTER_URL env var" } };
+  }
+  if (!Number.isInteger(productId) || productId <= 0) {
+    return { result: void 0, error: { message: "Invalid productId: must be a positive integer" } };
+  }
+  if (typeof coverAmount !== "string" || !/^\d+$/.test(coverAmount) || parseInt(coverAmount, 10) <= 0) {
+    return { result: void 0, error: { message: "Invalid coverAmount: must be a positive integer string" } };
+  }
+  if (!Number.isInteger(coverPeriod) || coverPeriod < MINIMUM_COVER_PERIOD || coverPeriod > MAXIMUM_COVER_PERIOD) {
+    return {
+      result: void 0,
+      error: {
+        message: `Invalid coverPeriod: must be between ${MINIMUM_COVER_PERIOD} and ${MAXIMUM_COVER_PERIOD} days`
+      }
+    };
+  }
+  const coverAssetsString = Object.keys(CoverAsset).filter((k) => isNaN(+k)).map((k) => `CoverAsset.${k}`).join(", ");
+  if (!Object.values(CoverAsset).includes(coverAsset)) {
+    return {
+      result: void 0,
+      error: {
+        message: `Invalid coverAsset: must be one of ${coverAssetsString}`
+      }
+    };
+  }
+  if (!/^0x[a-fA-F0-9]{40}$/.test(coverBuyerAddress)) {
+    return { result: void 0, error: { message: "Invalid coverBuyerAddress: must be a valid Ethereum address" } };
+  }
+  if (typeof slippage !== "number" || slippage < 0 || slippage > SLIPPAGE_DENOMINATOR) {
+    return {
+      result: void 0,
+      error: { message: `Invalid slippage: must be a number between 0 and ${SLIPPAGE_DENOMINATOR}` }
+    };
+  }
+  if (typeof ipfsCid !== "string") {
+    return { result: void 0, error: { message: "Invalid ipfsCid: must be a valid IPFS CID" } };
+  }
+  try {
+    const { quote, capacities } = await getQuote(productId, coverAmount, coverPeriod, coverAsset);
+    const maxPremiumInAsset = calculatePremiumWithCommissionAndSlippage(
+      BigInt(quote.premiumInAsset),
+      DEFAULT_COMMISSION_RATIO,
+      slippage
+    );
+    const yearlyCostPerc = calculatePremiumWithCommissionAndSlippage(
+      BigInt(quote.annualPrice),
+      DEFAULT_COMMISSION_RATIO,
+      slippage
+    );
+    const result = {
+      displayInfo: {
+        premiumInAsset: maxPremiumInAsset.toString(),
+        coverAmount,
+        yearlyCostPerc: Number(yearlyCostPerc) / TARGET_PRICE_DENOMINATOR,
+        maxCapacity: sumPoolCapacities(capacities)
+      },
+      buyCoverInput: {
+        buyCoverParams: {
+          coverId: 0 /* BUY */,
+          owner: coverBuyerAddress,
+          productId,
+          coverAsset,
+          amount: coverAmount,
+          period: coverPeriod * 60 * 60 * 24,
+          // seconds
+          maxPremiumInAsset: maxPremiumInAsset.toString(),
+          paymentAsset: coverAsset,
+          commissionRatio: DEFAULT_COMMISSION_RATIO,
+          commissionDestination: NEXUS_MUTUAL_DAO_TREASURY_ADDRESS,
+          ipfsData: ipfsCid
+        },
+        poolAllocationRequests: quote.poolAllocationRequests
+      }
+    };
+    return { result, error: void 0 };
+  } catch (error) {
+    return handleError(error);
+  }
+}
+async function getQuote(productId, coverAmount, coverPeriod, coverAsset) {
+  const params = { productId, amount: coverAmount, period: coverPeriod, coverAsset };
+  const response = await import_axios.default.get(process.env.COVER_ROUTER_URL + "/quote", { params });
+  return response.data;
+}
+function sumPoolCapacities(capacities) {
+  let totalAmount = BigInt(0);
+  capacities.forEach((poolCapacity) => {
+    poolCapacity.capacity.forEach((capacity) => totalAmount += BigInt(capacity.amount));
+  });
+  return totalAmount.toString();
+}
+async function handleError(error) {
+  const axiosError = error;
+  if (axiosError.isAxiosError) {
+    console.log("axiosError.response.data: ", require("util").inspect(axiosError.response?.data, { depth: null }));
+    if (axiosError.response?.data?.error?.includes("Not enough capacity")) {
+      return {
+        result: void 0,
+        error: {
+          message: axiosError.response?.data.error,
+          data: {}
+        }
+      };
+    }
+  }
+  return {
+    result: void 0,
+    error: { message: "Something went wrong" }
+  };
+}
+
+// src/constants/index.ts
+var constants_exports = {};
+__export(constants_exports, {
+  COMMISSION_DENOMINATOR: () => COMMISSION_DENOMINATOR,
+  CoverAsset: () => CoverAsset,
+  CoverId: () => CoverId,
+  DEFAULT_COMMISSION_RATIO: () => DEFAULT_COMMISSION_RATIO,
+  DEFAULT_SLIPPAGE: () => DEFAULT_SLIPPAGE,
+  MAXIMUM_COVER_PERIOD: () => MAXIMUM_COVER_PERIOD,
+  MINIMUM_COVER_PERIOD: () => MINIMUM_COVER_PERIOD,
+  NEXUS_MUTUAL_DAO_TREASURY_ADDRESS: () => NEXUS_MUTUAL_DAO_TREASURY_ADDRESS,
+  SLIPPAGE_DENOMINATOR: () => SLIPPAGE_DENOMINATOR,
+  TARGET_PRICE_DENOMINATOR: () => TARGET_PRICE_DENOMINATOR
+});
+
+// src/index.ts
+__reExport(src_exports, require("@nexusmutual/deployments"), module.exports);
+var nexusSdk = {
+  ...deployments,
+  products: products_default,
+  productTypes: product_types_default,
+  ...types_exports,
+  ...swap_exports,
+  ...buyCover_exports,
+  ...types_exports2,
+  ...quote_exports,
+  ...constants_exports
+};
+var src_default = nexusSdk;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  COMMISSION_DENOMINATOR,
+  CoverAsset,
+  CoverId,
+  DEFAULT_COMMISSION_RATIO,
+  DEFAULT_SLIPPAGE,
+  MAXIMUM_COVER_PERIOD,
+  MINIMUM_COVER_PERIOD,
+  NEXUS_MUTUAL_DAO_TREASURY_ADDRESS,
+  SLIPPAGE_DENOMINATOR,
+  TARGET_PRICE_DENOMINATOR,
   allLogoFileNames,
   allLogoNames,
   calculateEthForExactNxm,
@@ -3199,8 +3580,10 @@ var calculatePremiumWithCommissionAndSlippage = (premium, commission = 0, slippa
   calculatePriceImpactA,
   calculatePriceImpactB,
   calculateSpotPrice,
+  getQuoteAndBuyCoverInputs,
   productTypes,
   products,
+  sumPoolCapacities,
   ...require("@nexusmutual/deployments")
 });
 //# sourceMappingURL=index.js.map