@nexusmutual/sdk 0.3.0 → 0.3.2

package/dist/data/products.json

@@ -1360,7 +1360,7 @@
       "DAI"
     ],
     "isPrivate": true,
-    "timestamp": 1704981731
+    "timestamp": 1684312727
   },
   {
     "id": 84,
@@ -1422,7 +1422,7 @@
       "DAI"
     ],
     "isPrivate": true,
-    "timestamp": 1704981731
+    "timestamp": 1684312727
   },
   {
     "id": 88,
@@ -1700,7 +1700,7 @@
       "DAI"
     ],
     "isPrivate": true,
-    "timestamp": 1704980411
+    "timestamp": 1689782903
   },
   {
     "id": 106,

package/dist/index.d.mts

@@ -71,9 +71,13 @@ type Address = string;
  */
 type Integer = number;
 /**
- * Integer values in string format
+ * Integer value in string format
  */
 type IntString = string;
+/**
+ * Float value in string format
+ */
+type FloatString = string;
 
 type BuyCoverParams = {
     coverId: Integer;
@@ -97,6 +101,16 @@ type CoverRouterQuoteResponse = {
     quote: Quote;
     capacities: PoolCapacity[];
 };
+type CoverRouterProductCapacityResponse = {
+    productId: Integer;
+    availableCapacity: Array<{
+        assetId: Integer;
+        amount: IntString;
+    }>;
+    allocatedNxm: IntString;
+    minAnnualPrice: FloatString;
+    maxAnnualPrice: FloatString;
+};
 type Quote = {
     totalCoverAmountInAsset: IntString;
     annualPrice: IntString;
@@ -137,7 +151,7 @@ type GetQuoteApiResponse = ApiResponse<GetQuoteResponse, undefined>;
  * @param {Integer} coverPeriod - The duration of the cover in days (28-365).
  * @param {CoverAsset} coverAsset - The asset for which cover is being purchased (the cover must be purchased using the same asset)
  * @param {Address} coverBuyerAddress - The Ethereum address of the buyer.
- * @param {number} slippage - The acceptable slippage percentage. Must be between 0 - 100_00 (Defaults to 10 ~ 0.1%)
+ * @param {number} slippage - The acceptable slippage percentage. Must be between 0-1 (Defaults to 0.001 ~ 0.1%)
  * @param {string} ipfsCid - The IPFS CID for additional data (optional).
  * @return {Promise<GetQuoteApiResponse | ErrorApiResponse>} Returns a successful quote response or an error response.
  */
@@ -1573,7 +1587,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704981731
+		timestamp: 1684312727
 	},
 	{
 		id: 84,
@@ -1638,7 +1652,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704981731
+		timestamp: 1684312727
 	},
 	{
 		id: 88,
@@ -1928,7 +1942,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704980411
+		timestamp: 1689782903
 	},
 	{
 		id: 106,
@@ -38933,4 +38947,4 @@ declare const nexusSdk: {
     }];
 };
 
-export { Address, ApiResponse, BuyCoverInput, BuyCoverParams, COMMISSION_DENOMINATOR, Capacity, CoverAsset, CoverId, CoverRouterQuoteResponse, DEFAULT_COMMISSION_RATIO, DEFAULT_SLIPPAGE, ErrorApiResponse, ErrorResponse, GetQuoteApiResponse, GetQuoteResponse, IntString, Integer, LogoFileName, LogoName, MAXIMUM_COVER_PERIOD, MINIMUM_COVER_PERIOD, NEXUS_MUTUAL_DAO_TREASURY_ADDRESS, PoolAllocationRequest, PoolCapacity, Quote, QuoteDisplayInfo, Reserves, SLIPPAGE_DENOMINATOR, TARGET_PRICE_DENOMINATOR, allLogoFileNames, allLogoNames, calculateEthForExactNxm, calculateExactEthForNxm, calculateExactNxmForEth, calculateNxmForExactEth, calculatePremiumWithCommissionAndSlippage, calculatePriceImpactA, calculatePriceImpactB, calculateSpotPrice, nexusSdk as default, getQuoteAndBuyCoverInputs, productTypes, products, sumPoolCapacities };
+export { Address, ApiResponse, BuyCoverInput, BuyCoverParams, COMMISSION_DENOMINATOR, Capacity, CoverAsset, CoverId, CoverRouterProductCapacityResponse, CoverRouterQuoteResponse, DEFAULT_COMMISSION_RATIO, DEFAULT_SLIPPAGE, ErrorApiResponse, ErrorResponse, FloatString, GetQuoteApiResponse, GetQuoteResponse, IntString, Integer, LogoFileName, LogoName, MAXIMUM_COVER_PERIOD, MINIMUM_COVER_PERIOD, NEXUS_MUTUAL_DAO_TREASURY_ADDRESS, PoolAllocationRequest, PoolCapacity, Quote, QuoteDisplayInfo, Reserves, SLIPPAGE_DENOMINATOR, TARGET_PRICE_DENOMINATOR, allLogoFileNames, allLogoNames, calculateEthForExactNxm, calculateExactEthForNxm, calculateExactNxmForEth, calculateNxmForExactEth, calculatePremiumWithCommissionAndSlippage, calculatePriceImpactA, calculatePriceImpactB, calculateSpotPrice, nexusSdk as default, getQuoteAndBuyCoverInputs, productTypes, products, sumPoolCapacities };

package/dist/index.d.ts

@@ -71,9 +71,13 @@ type Address = string;
  */
 type Integer = number;
 /**
- * Integer values in string format
+ * Integer value in string format
  */
 type IntString = string;
+/**
+ * Float value in string format
+ */
+type FloatString = string;
 
 type BuyCoverParams = {
     coverId: Integer;
@@ -97,6 +101,16 @@ type CoverRouterQuoteResponse = {
     quote: Quote;
     capacities: PoolCapacity[];
 };
+type CoverRouterProductCapacityResponse = {
+    productId: Integer;
+    availableCapacity: Array<{
+        assetId: Integer;
+        amount: IntString;
+    }>;
+    allocatedNxm: IntString;
+    minAnnualPrice: FloatString;
+    maxAnnualPrice: FloatString;
+};
 type Quote = {
     totalCoverAmountInAsset: IntString;
     annualPrice: IntString;
@@ -137,7 +151,7 @@ type GetQuoteApiResponse = ApiResponse<GetQuoteResponse, undefined>;
  * @param {Integer} coverPeriod - The duration of the cover in days (28-365).
  * @param {CoverAsset} coverAsset - The asset for which cover is being purchased (the cover must be purchased using the same asset)
  * @param {Address} coverBuyerAddress - The Ethereum address of the buyer.
- * @param {number} slippage - The acceptable slippage percentage. Must be between 0 - 100_00 (Defaults to 10 ~ 0.1%)
+ * @param {number} slippage - The acceptable slippage percentage. Must be between 0-1 (Defaults to 0.001 ~ 0.1%)
  * @param {string} ipfsCid - The IPFS CID for additional data (optional).
  * @return {Promise<GetQuoteApiResponse | ErrorApiResponse>} Returns a successful quote response or an error response.
  */
@@ -1573,7 +1587,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704981731
+		timestamp: 1684312727
 	},
 	{
 		id: 84,
@@ -1638,7 +1652,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704981731
+		timestamp: 1684312727
 	},
 	{
 		id: 88,
@@ -1928,7 +1942,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704980411
+		timestamp: 1689782903
 	},
 	{
 		id: 106,
@@ -38933,4 +38947,4 @@ declare const nexusSdk: {
     }];
 };
 
-export { Address, ApiResponse, BuyCoverInput, BuyCoverParams, COMMISSION_DENOMINATOR, Capacity, CoverAsset, CoverId, CoverRouterQuoteResponse, DEFAULT_COMMISSION_RATIO, DEFAULT_SLIPPAGE, ErrorApiResponse, ErrorResponse, GetQuoteApiResponse, GetQuoteResponse, IntString, Integer, LogoFileName, LogoName, MAXIMUM_COVER_PERIOD, MINIMUM_COVER_PERIOD, NEXUS_MUTUAL_DAO_TREASURY_ADDRESS, PoolAllocationRequest, PoolCapacity, Quote, QuoteDisplayInfo, Reserves, SLIPPAGE_DENOMINATOR, TARGET_PRICE_DENOMINATOR, allLogoFileNames, allLogoNames, calculateEthForExactNxm, calculateExactEthForNxm, calculateExactNxmForEth, calculateNxmForExactEth, calculatePremiumWithCommissionAndSlippage, calculatePriceImpactA, calculatePriceImpactB, calculateSpotPrice, nexusSdk as default, getQuoteAndBuyCoverInputs, productTypes, products, sumPoolCapacities };
+export { Address, ApiResponse, BuyCoverInput, BuyCoverParams, COMMISSION_DENOMINATOR, Capacity, CoverAsset, CoverId, CoverRouterProductCapacityResponse, CoverRouterQuoteResponse, DEFAULT_COMMISSION_RATIO, DEFAULT_SLIPPAGE, ErrorApiResponse, ErrorResponse, FloatString, GetQuoteApiResponse, GetQuoteResponse, IntString, Integer, LogoFileName, LogoName, MAXIMUM_COVER_PERIOD, MINIMUM_COVER_PERIOD, NEXUS_MUTUAL_DAO_TREASURY_ADDRESS, PoolAllocationRequest, PoolCapacity, Quote, QuoteDisplayInfo, Reserves, SLIPPAGE_DENOMINATOR, TARGET_PRICE_DENOMINATOR, allLogoFileNames, allLogoNames, calculateEthForExactNxm, calculateExactEthForNxm, calculateExactNxmForEth, calculateNxmForExactEth, calculatePremiumWithCommissionAndSlippage, calculatePriceImpactA, calculatePriceImpactB, calculateSpotPrice, nexusSdk as default, getQuoteAndBuyCoverInputs, productTypes, products, sumPoolCapacities };

package/dist/index.js

@@ -1576,7 +1576,7 @@ var products_default = [
       "DAI"
     ],
     isPrivate: true,
-    timestamp: 1704981731
+    timestamp: 1684312727
   },
   {
     id: 84,
@@ -1638,7 +1638,7 @@ var products_default = [
       "DAI"
     ],
     isPrivate: true,
-    timestamp: 1704981731
+    timestamp: 1684312727
   },
   {
     id: 88,
@@ -1916,7 +1916,7 @@ var products_default = [
       "DAI"
     ],
     isPrivate: true,
-    timestamp: 1704980411
+    timestamp: 1689782903
   },
   {
     id: 106,
@@ -3416,7 +3416,7 @@ __export(quote_exports, {
 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 = "") {
+async function getQuoteAndBuyCoverInputs(productId, coverAmount, coverPeriod, coverAsset, coverBuyerAddress, slippage = DEFAULT_SLIPPAGE / SLIPPAGE_DENOMINATOR, ipfsCid = "") {
   if (!process.env.COVER_ROUTER_URL) {
     return { result: void 0, error: { message: "Missing COVER_ROUTER_URL env var" } };
   }
@@ -3446,15 +3446,16 @@ async function getQuoteAndBuyCoverInputs(productId, coverAmount, coverPeriod, co
   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) {
+  if (typeof slippage !== "number" || slippage < 0 || slippage > 1) {
     return {
       result: void 0,
-      error: { message: `Invalid slippage: must be a number between 0 and ${SLIPPAGE_DENOMINATOR}` }
+      error: { message: "Invalid slippage: must be a number between 0 and 1" }
     };
   }
   if (typeof ipfsCid !== "string") {
     return { result: void 0, error: { message: "Invalid ipfsCid: must be a valid IPFS CID" } };
   }
+  slippage = slippage * SLIPPAGE_DENOMINATOR;
   try {
     const { quote, capacities } = await getQuote(productId, coverAmount, coverPeriod, coverAsset);
     const maxPremiumInAsset = calculatePremiumWithCommissionAndSlippage(
@@ -3494,14 +3495,27 @@ async function getQuoteAndBuyCoverInputs(productId, coverAmount, coverPeriod, co
     };
     return { result, error: void 0 };
   } catch (error) {
-    return handleError(error);
+    const errorResponse = await handleError(error, productId, coverPeriod, coverAsset);
+    return errorResponse;
   }
 }
 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 });
+  if (!response.data) {
+    throw new Error("Failed to fetch cover quote");
+  }
   return response.data;
 }
+async function getProductCapacity(productId, coverPeriod, coverAsset) {
+  const params = { period: coverPeriod };
+  const capacityUrl = process.env.COVER_ROUTER_URL + `/capacity/${productId}`;
+  const response = await import_axios.default.get(capacityUrl, { params });
+  if (!response.data) {
+    throw new Error("Failed to fetch cover capacities");
+  }
+  return response.data.availableCapacity.find((av) => av.assetId === coverAsset)?.amount;
+}
 function sumPoolCapacities(capacities) {
   let totalAmount = BigInt(0);
   capacities.forEach((poolCapacity) => {
@@ -3509,23 +3523,23 @@ function sumPoolCapacities(capacities) {
   });
   return totalAmount.toString();
 }
-async function handleError(error) {
+async function handleError(error, productId, coverPeriod, coverAsset) {
   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")) {
+      const maxCapacity = await getProductCapacity(productId, coverPeriod, coverAsset);
       return {
         result: void 0,
         error: {
           message: axiosError.response?.data.error,
-          data: {}
+          data: maxCapacity ? { maxCapacity } : void 0
         }
       };
     }
   }
   return {
     result: void 0,
-    error: { message: "Something went wrong" }
+    error: { message: error.message || "Something went wrong" }
   };
 }