@nexusmutual/sdk 0.3.3 → 0.3.5

package/dist/data/products.json

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

package/dist/index.d.mts

@@ -1,41 +1,5 @@
 export * from '@nexusmutual/deployments';
 
-type Reserves = {
-    ethReserve: bigint;
-    nxmA: bigint;
-    nxmB: bigint;
-    budget: bigint;
-};
-
-/**
- * Calculates the amount of nxm flowing out of the pool for the given amount of eth flowing in
- */
-declare const calculateExactNxmForEth: (ethIn: bigint, reserves: Reserves) => bigint;
-
-/**
- * Calculates the amount of eth flowing out of the pool for the given amount of nxm flowing in
- */
-declare const calculateExactEthForNxm: (nxmIn: bigint, reserves: Reserves) => bigint;
-
-/**
- * Calculates the amount of nxm needed to flow into the pool to get the exact amount of eth out
- */
-declare const calculateNxmForExactEth: (ethOut: bigint, reserves: Reserves) => bigint;
-
-/**
- * Calculates the amount of eth needed to flow into the pool to get the exact amount of nxm out
- */
-declare const calculateEthForExactNxm: (nxmOut: bigint, reserves: Reserves) => bigint;
-
-declare const calculatePriceImpactA: (ethIn: bigint, reserves: Reserves) => bigint;
-
-declare const calculatePriceImpactB: (nxmIn: bigint, reserves: Reserves) => bigint;
-
-declare const calculateSpotPrice: (reserves: Reserves) => {
-    spotPriceA: bigint;
-    spotPriceB: bigint;
-};
-
 declare enum CoverAsset {
     ETH = 0,
     DAI = 1
@@ -149,17 +113,50 @@ type GetQuoteApiResponse = ApiResponse<GetQuoteResponse, undefined>;
  * @param {Integer} productId - The ID of the product for which cover is being purchased.
  * @param {IntString} coverAmount - The amount of cover in smallest unit of currency (i.e. wei)
  * @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 {CoverAsset} coverAsset - The asset for which cover is being purchased; the purchase must use the same asset.
  * @param {Address} coverBuyerAddress - The Ethereum address of the buyer.
  * @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).
+ * @param {string} coverRouterUrl - Used to override the default CoverRouter URL which is bundled this library.
  * @return {Promise<GetQuoteApiResponse | ErrorApiResponse>} Returns a successful quote response or an error response.
  */
-declare function getQuoteAndBuyCoverInputs(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsCid?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
+declare function getQuoteAndBuyCoverInputs(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsCid?: string, coverRouterUrl?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
+
+type Reserves = {
+    ethReserve: bigint;
+    nxmA: bigint;
+    nxmB: bigint;
+    budget: bigint;
+};
+
+/**
+ * Calculates the amount of nxm flowing out of the pool for the given amount of eth flowing in
+ */
+declare const calculateExactNxmForEth: (ethIn: bigint, reserves: Reserves) => bigint;
+
+/**
+ * Calculates the amount of eth flowing out of the pool for the given amount of nxm flowing in
+ */
+declare const calculateExactEthForNxm: (nxmIn: bigint, reserves: Reserves) => bigint;
+
+/**
+ * Calculates the amount of nxm needed to flow into the pool to get the exact amount of eth out
+ */
+declare const calculateNxmForExactEth: (ethOut: bigint, reserves: Reserves) => bigint;
+
 /**
- * Calculates the max capacity by summing up all the amounts in the given array of pool capacities.
+ * Calculates the amount of eth needed to flow into the pool to get the exact amount of nxm out
  */
-declare function sumPoolCapacities(capacities: PoolCapacity[]): IntString;
+declare const calculateEthForExactNxm: (nxmOut: bigint, reserves: Reserves) => bigint;
+
+declare const calculatePriceImpactA: (ethIn: bigint, reserves: Reserves) => bigint;
+
+declare const calculatePriceImpactB: (nxmIn: bigint, reserves: Reserves) => bigint;
+
+declare const calculateSpotPrice: (reserves: Reserves) => {
+    spotPriceA: bigint;
+    spotPriceB: bigint;
+};
 
 var products = [
 	{
@@ -1587,7 +1584,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704980411
+		timestamp: 1684312727
 	},
 	{
 		id: 84,
@@ -1652,7 +1649,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1684312727
+		timestamp: 1704981731
 	},
 	{
 		id: 88,
@@ -1669,7 +1666,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704980411
+		timestamp: 1684312727
 	},
 	{
 		id: 89,
@@ -1942,7 +1939,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704981731
+		timestamp: 1689782903
 	},
 	{
 		id: 106,
@@ -2071,7 +2068,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1691495087
+		timestamp: 1691493035
 	},
 	{
 		id: 114,
@@ -2975,7 +2972,6 @@ declare const nexusSdk: {
     DEFAULT_SLIPPAGE: 10;
     DEFAULT_COMMISSION_RATIO: 1500;
     NEXUS_MUTUAL_DAO_TREASURY_ADDRESS: "0x586b9b2F8010b284A0197f392156f1A7Eb5e86e9";
-    sumPoolCapacities: typeof sumPoolCapacities;
     getQuoteAndBuyCoverInputs: typeof getQuoteAndBuyCoverInputs;
     calculatePremiumWithCommissionAndSlippage: (premium: bigint, commission?: number, slippage?: number) => bigint;
     calculateExactNxmForEth: (ethIn: bigint, reserves: Reserves) => bigint;
@@ -38995,4 +38991,4 @@ declare const nexusSdk: {
     }];
 };
 
-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 };
+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 };

package/dist/index.d.ts

@@ -1,41 +1,5 @@
 export * from '@nexusmutual/deployments';
 
-type Reserves = {
-    ethReserve: bigint;
-    nxmA: bigint;
-    nxmB: bigint;
-    budget: bigint;
-};
-
-/**
- * Calculates the amount of nxm flowing out of the pool for the given amount of eth flowing in
- */
-declare const calculateExactNxmForEth: (ethIn: bigint, reserves: Reserves) => bigint;
-
-/**
- * Calculates the amount of eth flowing out of the pool for the given amount of nxm flowing in
- */
-declare const calculateExactEthForNxm: (nxmIn: bigint, reserves: Reserves) => bigint;
-
-/**
- * Calculates the amount of nxm needed to flow into the pool to get the exact amount of eth out
- */
-declare const calculateNxmForExactEth: (ethOut: bigint, reserves: Reserves) => bigint;
-
-/**
- * Calculates the amount of eth needed to flow into the pool to get the exact amount of nxm out
- */
-declare const calculateEthForExactNxm: (nxmOut: bigint, reserves: Reserves) => bigint;
-
-declare const calculatePriceImpactA: (ethIn: bigint, reserves: Reserves) => bigint;
-
-declare const calculatePriceImpactB: (nxmIn: bigint, reserves: Reserves) => bigint;
-
-declare const calculateSpotPrice: (reserves: Reserves) => {
-    spotPriceA: bigint;
-    spotPriceB: bigint;
-};
-
 declare enum CoverAsset {
     ETH = 0,
     DAI = 1
@@ -149,17 +113,50 @@ type GetQuoteApiResponse = ApiResponse<GetQuoteResponse, undefined>;
  * @param {Integer} productId - The ID of the product for which cover is being purchased.
  * @param {IntString} coverAmount - The amount of cover in smallest unit of currency (i.e. wei)
  * @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 {CoverAsset} coverAsset - The asset for which cover is being purchased; the purchase must use the same asset.
  * @param {Address} coverBuyerAddress - The Ethereum address of the buyer.
  * @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).
+ * @param {string} coverRouterUrl - Used to override the default CoverRouter URL which is bundled this library.
  * @return {Promise<GetQuoteApiResponse | ErrorApiResponse>} Returns a successful quote response or an error response.
  */
-declare function getQuoteAndBuyCoverInputs(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsCid?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
+declare function getQuoteAndBuyCoverInputs(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsCid?: string, coverRouterUrl?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
+
+type Reserves = {
+    ethReserve: bigint;
+    nxmA: bigint;
+    nxmB: bigint;
+    budget: bigint;
+};
+
+/**
+ * Calculates the amount of nxm flowing out of the pool for the given amount of eth flowing in
+ */
+declare const calculateExactNxmForEth: (ethIn: bigint, reserves: Reserves) => bigint;
+
+/**
+ * Calculates the amount of eth flowing out of the pool for the given amount of nxm flowing in
+ */
+declare const calculateExactEthForNxm: (nxmIn: bigint, reserves: Reserves) => bigint;
+
+/**
+ * Calculates the amount of nxm needed to flow into the pool to get the exact amount of eth out
+ */
+declare const calculateNxmForExactEth: (ethOut: bigint, reserves: Reserves) => bigint;
+
 /**
- * Calculates the max capacity by summing up all the amounts in the given array of pool capacities.
+ * Calculates the amount of eth needed to flow into the pool to get the exact amount of nxm out
  */
-declare function sumPoolCapacities(capacities: PoolCapacity[]): IntString;
+declare const calculateEthForExactNxm: (nxmOut: bigint, reserves: Reserves) => bigint;
+
+declare const calculatePriceImpactA: (ethIn: bigint, reserves: Reserves) => bigint;
+
+declare const calculatePriceImpactB: (nxmIn: bigint, reserves: Reserves) => bigint;
+
+declare const calculateSpotPrice: (reserves: Reserves) => {
+    spotPriceA: bigint;
+    spotPriceB: bigint;
+};
 
 var products = [
 	{
@@ -1587,7 +1584,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704980411
+		timestamp: 1684312727
 	},
 	{
 		id: 84,
@@ -1652,7 +1649,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1684312727
+		timestamp: 1704981731
 	},
 	{
 		id: 88,
@@ -1669,7 +1666,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704980411
+		timestamp: 1684312727
 	},
 	{
 		id: 89,
@@ -1942,7 +1939,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1704981731
+		timestamp: 1689782903
 	},
 	{
 		id: 106,
@@ -2071,7 +2068,7 @@ var products = [
 			"DAI"
 		],
 		isPrivate: true,
-		timestamp: 1691495087
+		timestamp: 1691493035
 	},
 	{
 		id: 114,
@@ -2975,7 +2972,6 @@ declare const nexusSdk: {
     DEFAULT_SLIPPAGE: 10;
     DEFAULT_COMMISSION_RATIO: 1500;
     NEXUS_MUTUAL_DAO_TREASURY_ADDRESS: "0x586b9b2F8010b284A0197f392156f1A7Eb5e86e9";
-    sumPoolCapacities: typeof sumPoolCapacities;
     getQuoteAndBuyCoverInputs: typeof getQuoteAndBuyCoverInputs;
     calculatePremiumWithCommissionAndSlippage: (premium: bigint, commission?: number, slippage?: number) => bigint;
     calculateExactNxmForEth: (ethIn: bigint, reserves: Reserves) => bigint;
@@ -38995,4 +38991,4 @@ declare const nexusSdk: {
     }];
 };
 
-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 };
+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 };