@nexusmutual/sdk 0.7.0-rc2 → 0.7.0

package/README.md

@@ -63,11 +63,11 @@ The function returns the IPFS hash of the uploaded content.
 import { uploadIPFSContent, ContentType, IPFSContentTypes } from '@nexusmutual/sdk';
 
 const content: IPFSContentTypes = {
-  version: '2.0.',
+  version: '2.0',
   walletAddresses: ['0x1234567890'],
 };
 
-const ipfsHash = await uploadIPFSContent(ContentType.coverWalletAddresses, content);
+const ipfsHash = await uploadIPFSContent([ContentType.coverWalletAddresses, content]);
 
 console.log(ipfsHash);
 ```
@@ -81,7 +81,7 @@ Use the `getQuoteAndBuyCoverInputs` function from `src/cover/getQuoteAndBuyCover
 1st overload:
 
 ```typescript
-import { getQuoteAndBuyCoverInputs } from '@nexusmutual/sdk';
+import { CoverAsset, getQuoteAndBuyCoverInputs } from '@nexusmutual/sdk';
 
 const productId = 1;
 const coverAmount = '100';
@@ -106,7 +106,7 @@ console.log(quoteAndBuyCoverInputs);
 2nd overload:
 
 ```typescript
-import { getQuoteAndBuyCoverInputs, IPFSContentTypes } from '@nexusmutual/sdk';
+import { CoverAsset, getQuoteAndBuyCoverInputs, IPFSContentTypes } from '@nexusmutual/sdk';
 
 const productId = 247;
 const coverAmount = '100';
@@ -114,8 +114,8 @@ const coverPeriod = 30;
 const coverAsset = CoverAsset.ETH;
 const buyerAddress = '0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5';
 const ipfsContent: IPFSContentTypes = {
-  version: '2.0.',
-  walletAddresses: ['0x1234567890'],
+  version: '2.0',
+  walletAddresses: ['0x1234567890123456789012345678901234567890'],
 };
 
 const quoteAndBuyCoverInputs = await getQuoteAndBuyCoverInputs(
@@ -130,7 +130,7 @@ const quoteAndBuyCoverInputs = await getQuoteAndBuyCoverInputs(
 console.log(quoteAndBuyCoverInputs);
 ```
 
-If you pass The `ipfsContent` param, the function will upload the content to IPFS and use the IPFS hash returned for the buy cover inputs `ipfsData` param. If you pass the `ipfsCid` param, the function will use the IPFS hash directly.
+If the productId's type needs an IPFS upload, you can pass the `ipfsContent` param and the function will upload the content to IPFS and use the IPFS hash returned for the buy cover inputs `ipfsData` param. If you pass the `ipfsCid` param, the function will use the IPFS hash directly.
 
 The `ipfsCid` param must be a valid IPFS Cid.
 The `ipfsContent` param must be a valid `IPFSContentTypes` - the allowed types can be found in `src/types/ipfs.ts`.

package/dist/data/products.json

@@ -3048,7 +3048,7 @@
       "cbBTC"
     ],
     "isPrivate": true,
-    "timestamp": 1736430671,
+    "timestamp": 1725537203,
     "minPrice": 100
   },
   {
@@ -3507,7 +3507,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1734557999,
+    "timestamp": 1725264851,
     "minPrice": 100
   },
   {
@@ -4049,7 +4049,7 @@
       "USDC"
     ],
     "isPrivate": false,
-    "timestamp": 1723127459,
+    "timestamp": 1722950807,
     "minPrice": 100
   },
   {
@@ -4084,7 +4084,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1734557999,
+    "timestamp": 1731583079,
     "minPrice": 100
   },
   {
@@ -4143,7 +4143,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1726227311,
+    "timestamp": 1734557999,
     "minPrice": 100
   },
   {
@@ -4201,7 +4201,7 @@
       "cbBTC"
     ],
     "isPrivate": true,
-    "timestamp": 1725264851,
+    "timestamp": 1726227311,
     "minPrice": 100
   },
   {
@@ -4220,7 +4220,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1726758407,
+    "timestamp": 1736430671,
     "minPrice": 100
   },
   {
@@ -4239,7 +4239,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1731583079,
+    "timestamp": 1734557999,
     "minPrice": 100
   },
   {
@@ -4467,7 +4467,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1734557999,
+    "timestamp": 1731583079,
     "minPrice": 100
   },
   {
@@ -4518,7 +4518,7 @@
       "USDC"
     ],
     "isPrivate": true,
-    "timestamp": 1733753135,
+    "timestamp": 1733326763,
     "minPrice": 100
   },
   {
@@ -4552,7 +4552,7 @@
       "USDC"
     ],
     "isPrivate": true,
-    "timestamp": 1733753135,
+    "timestamp": 1733326763,
     "minPrice": 100
   },
   {

package/dist/index.d.mts

@@ -243,8 +243,8 @@ type IPFSUploadServiceResponse = {
     ipfsHash: string;
 };
 
-declare function getQuoteAndBuyCoverInputs(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsCid?: string, coverRouterUrl?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
-declare function getQuoteAndBuyCoverInputs<ProductTypes extends keyof IPFSContentForProductType>(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsContent?: IPFSContentForProductType[ProductTypes], coverRouterUrl?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
+declare function getQuoteAndBuyCoverInputs(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsCid?: string, nexusApiUrl?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
+declare function getQuoteAndBuyCoverInputs<ProductTypes extends keyof IPFSContentForProductType>(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsContent?: IPFSContentForProductType[ProductTypes], nexusApiUrl?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
 
 type Reserves = {
     ethReserve: bigint;
@@ -3475,7 +3475,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: true,
-		timestamp: 1736430671,
+		timestamp: 1725537203,
 		minPrice: 100
 	},
 	{
@@ -3939,7 +3939,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1734557999,
+		timestamp: 1725264851,
 		minPrice: 100
 	},
 	{
@@ -4491,7 +4491,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: false,
-		timestamp: 1723127459,
+		timestamp: 1722950807,
 		minPrice: 100
 	},
 	{
@@ -4526,7 +4526,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1734557999,
+		timestamp: 1731583079,
 		minPrice: 100
 	},
 	{
@@ -4585,7 +4585,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1726227311,
+		timestamp: 1734557999,
 		minPrice: 100
 	},
 	{
@@ -4644,7 +4644,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: true,
-		timestamp: 1725264851,
+		timestamp: 1726227311,
 		minPrice: 100
 	},
 	{
@@ -4663,7 +4663,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1726758407,
+		timestamp: 1736430671,
 		minPrice: 100
 	},
 	{
@@ -4682,7 +4682,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1731583079,
+		timestamp: 1734557999,
 		minPrice: 100
 	},
 	{
@@ -4916,7 +4916,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1734557999,
+		timestamp: 1731583079,
 		minPrice: 100
 	},
 	{
@@ -4969,7 +4969,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: true,
-		timestamp: 1733753135,
+		timestamp: 1733326763,
 		minPrice: 100
 	},
 	{
@@ -5003,7 +5003,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: true,
-		timestamp: 1733753135,
+		timestamp: 1733326763,
 		minPrice: 100
 	},
 	{
@@ -5254,6 +5254,34 @@ var productTypes = [
 
 declare const calculatePremiumWithCommissionAndSlippage: (premium: bigint, commission?: number, slippage?: number) => bigint;
 
+/**
+ *  Uploads data to IPFS
+ * @param {IPFSContentAndType} typeAndContent  - The type of content and the content to be uploaded
+ * @returns {Promise<string>} hash Returns the IPFS hash of the uploaded data
+ *
+ * @example
+ * ```ts
+ * uploadIPFSData(ContentType.coverValidators, { version: '1.0', validators: ['1', '2', '3'] });
+ *
+ * uploadIPFSData(ContentType.coverQuotaShare, { version: '1.0', quotaShare: 25 });
+ *
+ * uploadIPFSData(ContentType.coverAumCoverAmountPercentage, { version: '1.0', aumCoverAmountPercentage: 15 });
+ *
+ * uploadIPFSData(ContentType.coverWalletAddresses, { version: '1.0', walletAddresses: ['0x1', '0x2', '0x3'] });
+ *
+ * uploadIPFSData(ContentType.coverFreeText, { version: '1.0', freeText: 'This is a free text' });
+ * ```
+ */
+declare const uploadIPFSContent: (ipfsContentAndType: IPFSContentAndType, nexusApiUrl?: string) => Promise<string>;
+
+/**
+ * Wrapper method for IPFS CID string validation
+ *
+ * @param ipfsCid - The CID string to validate.
+ * @throws Throw an error if CID is not valid
+ */
+declare const validateIPFSCid: (ipfsCid: string) => void;
+
 declare const nexusSdk: {
     allPrivateProductsIds: number[];
     CoverAsset: typeof CoverAsset;
@@ -5271,7 +5299,7 @@ declare const nexusSdk: {
     productCategoryMap: {
         [productId: number]: ProductCategoryEnum;
     };
-    uploadIPFSContent: (...[type, content]: IPFSContentAndType) => Promise<string>;
+    uploadIPFSContent: (ipfsContentAndType: IPFSContentAndType, nexusApiUrl?: string) => Promise<string>;
     validateIPFSCid: (ipfsCid: string) => void;
     getQuoteAndBuyCoverInputs: typeof getQuoteAndBuyCoverInputs;
     ContentType: typeof ContentType;
@@ -42231,4 +42259,4 @@ declare const productsMap: Record<number, {
     minPrice: number;
 }>;
 
-export { Address, ApiResponse, BuyCoverInput, BuyCoverParams, COMMISSION_DENOMINATOR, Capacity, ContentType, CoverAsset, CoverId, CoverRouterProductCapacityResponse, CoverRouterQuoteResponse, DEFAULT_COMMISSION_RATIO, DEFAULT_SLIPPAGE, ErrorApiResponse, ErrorResponse, FloatString, GetQuoteApiResponse, GetQuoteResponse, IPFSContentAndType, IPFSContentForProductType, IPFSContentTypes, IPFSUploadServiceResponse, IPFS_CONTENT_TYPE_BY_PRODUCT_TYPE, IntString, Integer, LogoFileName, LogoName, MAXIMUM_COVER_PERIOD, MINIMUM_COVER_PERIOD, NEXUS_MUTUAL_DAO_TREASURY_ADDRESS, PoolAllocationRequest, PoolCapacity, ProductCategoryEnum, ProductTypes, Quote, QuoteDisplayInfo, Reserves, SLIPPAGE_DENOMINATOR, TARGET_PRICE_DENOMINATOR, allLogoFileNames, allLogoNames, allPrivateProductsIds, calculateEthForExactNxm, calculateExactEthForNxm, calculateExactNxmForEth, calculateNxmForExactEth, calculatePremiumWithCommissionAndSlippage, calculatePriceImpactA, calculatePriceImpactB, calculateSpotPrice, categoryLabelByEnum, nexusSdk as default, getQuoteAndBuyCoverInputs, productCategoryMap, productTypes, products, productsMap };
+export { Address, ApiResponse, BuyCoverInput, BuyCoverParams, COMMISSION_DENOMINATOR, Capacity, ContentType, CoverAsset, CoverId, CoverRouterProductCapacityResponse, CoverRouterQuoteResponse, DEFAULT_COMMISSION_RATIO, DEFAULT_SLIPPAGE, ErrorApiResponse, ErrorResponse, FloatString, GetQuoteApiResponse, GetQuoteResponse, IPFSContentAndType, IPFSContentForProductType, IPFSContentTypes, IPFSUploadServiceResponse, IPFS_CONTENT_TYPE_BY_PRODUCT_TYPE, IntString, Integer, LogoFileName, LogoName, MAXIMUM_COVER_PERIOD, MINIMUM_COVER_PERIOD, NEXUS_MUTUAL_DAO_TREASURY_ADDRESS, PoolAllocationRequest, PoolCapacity, ProductCategoryEnum, ProductTypes, Quote, QuoteDisplayInfo, Reserves, SLIPPAGE_DENOMINATOR, TARGET_PRICE_DENOMINATOR, allLogoFileNames, allLogoNames, allPrivateProductsIds, calculateEthForExactNxm, calculateExactEthForNxm, calculateExactNxmForEth, calculateNxmForExactEth, calculatePremiumWithCommissionAndSlippage, calculatePriceImpactA, calculatePriceImpactB, calculateSpotPrice, categoryLabelByEnum, nexusSdk as default, getQuoteAndBuyCoverInputs, productCategoryMap, productTypes, products, productsMap, uploadIPFSContent, validateIPFSCid };

package/dist/index.d.ts

@@ -243,8 +243,8 @@ type IPFSUploadServiceResponse = {
     ipfsHash: string;
 };
 
-declare function getQuoteAndBuyCoverInputs(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsCid?: string, coverRouterUrl?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
-declare function getQuoteAndBuyCoverInputs<ProductTypes extends keyof IPFSContentForProductType>(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsContent?: IPFSContentForProductType[ProductTypes], coverRouterUrl?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
+declare function getQuoteAndBuyCoverInputs(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsCid?: string, nexusApiUrl?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
+declare function getQuoteAndBuyCoverInputs<ProductTypes extends keyof IPFSContentForProductType>(productId: Integer, coverAmount: IntString, coverPeriod: Integer, coverAsset: CoverAsset, coverBuyerAddress: Address, slippage?: number, ipfsContent?: IPFSContentForProductType[ProductTypes], nexusApiUrl?: string): Promise<GetQuoteApiResponse | ErrorApiResponse>;
 
 type Reserves = {
     ethReserve: bigint;
@@ -3475,7 +3475,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: true,
-		timestamp: 1736430671,
+		timestamp: 1725537203,
 		minPrice: 100
 	},
 	{
@@ -3939,7 +3939,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1734557999,
+		timestamp: 1725264851,
 		minPrice: 100
 	},
 	{
@@ -4491,7 +4491,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: false,
-		timestamp: 1723127459,
+		timestamp: 1722950807,
 		minPrice: 100
 	},
 	{
@@ -4526,7 +4526,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1734557999,
+		timestamp: 1731583079,
 		minPrice: 100
 	},
 	{
@@ -4585,7 +4585,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1726227311,
+		timestamp: 1734557999,
 		minPrice: 100
 	},
 	{
@@ -4644,7 +4644,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: true,
-		timestamp: 1725264851,
+		timestamp: 1726227311,
 		minPrice: 100
 	},
 	{
@@ -4663,7 +4663,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1726758407,
+		timestamp: 1736430671,
 		minPrice: 100
 	},
 	{
@@ -4682,7 +4682,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1731583079,
+		timestamp: 1734557999,
 		minPrice: 100
 	},
 	{
@@ -4916,7 +4916,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1734557999,
+		timestamp: 1731583079,
 		minPrice: 100
 	},
 	{
@@ -4969,7 +4969,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: true,
-		timestamp: 1733753135,
+		timestamp: 1733326763,
 		minPrice: 100
 	},
 	{
@@ -5003,7 +5003,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: true,
-		timestamp: 1733753135,
+		timestamp: 1733326763,
 		minPrice: 100
 	},
 	{
@@ -5254,6 +5254,34 @@ var productTypes = [
 
 declare const calculatePremiumWithCommissionAndSlippage: (premium: bigint, commission?: number, slippage?: number) => bigint;
 
+/**
+ *  Uploads data to IPFS
+ * @param {IPFSContentAndType} typeAndContent  - The type of content and the content to be uploaded
+ * @returns {Promise<string>} hash Returns the IPFS hash of the uploaded data
+ *
+ * @example
+ * ```ts
+ * uploadIPFSData(ContentType.coverValidators, { version: '1.0', validators: ['1', '2', '3'] });
+ *
+ * uploadIPFSData(ContentType.coverQuotaShare, { version: '1.0', quotaShare: 25 });
+ *
+ * uploadIPFSData(ContentType.coverAumCoverAmountPercentage, { version: '1.0', aumCoverAmountPercentage: 15 });
+ *
+ * uploadIPFSData(ContentType.coverWalletAddresses, { version: '1.0', walletAddresses: ['0x1', '0x2', '0x3'] });
+ *
+ * uploadIPFSData(ContentType.coverFreeText, { version: '1.0', freeText: 'This is a free text' });
+ * ```
+ */
+declare const uploadIPFSContent: (ipfsContentAndType: IPFSContentAndType, nexusApiUrl?: string) => Promise<string>;
+
+/**
+ * Wrapper method for IPFS CID string validation
+ *
+ * @param ipfsCid - The CID string to validate.
+ * @throws Throw an error if CID is not valid
+ */
+declare const validateIPFSCid: (ipfsCid: string) => void;
+
 declare const nexusSdk: {
     allPrivateProductsIds: number[];
     CoverAsset: typeof CoverAsset;
@@ -5271,7 +5299,7 @@ declare const nexusSdk: {
     productCategoryMap: {
         [productId: number]: ProductCategoryEnum;
     };
-    uploadIPFSContent: (...[type, content]: IPFSContentAndType) => Promise<string>;
+    uploadIPFSContent: (ipfsContentAndType: IPFSContentAndType, nexusApiUrl?: string) => Promise<string>;
     validateIPFSCid: (ipfsCid: string) => void;
     getQuoteAndBuyCoverInputs: typeof getQuoteAndBuyCoverInputs;
     ContentType: typeof ContentType;
@@ -42231,4 +42259,4 @@ declare const productsMap: Record<number, {
     minPrice: number;
 }>;
 
-export { Address, ApiResponse, BuyCoverInput, BuyCoverParams, COMMISSION_DENOMINATOR, Capacity, ContentType, CoverAsset, CoverId, CoverRouterProductCapacityResponse, CoverRouterQuoteResponse, DEFAULT_COMMISSION_RATIO, DEFAULT_SLIPPAGE, ErrorApiResponse, ErrorResponse, FloatString, GetQuoteApiResponse, GetQuoteResponse, IPFSContentAndType, IPFSContentForProductType, IPFSContentTypes, IPFSUploadServiceResponse, IPFS_CONTENT_TYPE_BY_PRODUCT_TYPE, IntString, Integer, LogoFileName, LogoName, MAXIMUM_COVER_PERIOD, MINIMUM_COVER_PERIOD, NEXUS_MUTUAL_DAO_TREASURY_ADDRESS, PoolAllocationRequest, PoolCapacity, ProductCategoryEnum, ProductTypes, Quote, QuoteDisplayInfo, Reserves, SLIPPAGE_DENOMINATOR, TARGET_PRICE_DENOMINATOR, allLogoFileNames, allLogoNames, allPrivateProductsIds, calculateEthForExactNxm, calculateExactEthForNxm, calculateExactNxmForEth, calculateNxmForExactEth, calculatePremiumWithCommissionAndSlippage, calculatePriceImpactA, calculatePriceImpactB, calculateSpotPrice, categoryLabelByEnum, nexusSdk as default, getQuoteAndBuyCoverInputs, productCategoryMap, productTypes, products, productsMap };
+export { Address, ApiResponse, BuyCoverInput, BuyCoverParams, COMMISSION_DENOMINATOR, Capacity, ContentType, CoverAsset, CoverId, CoverRouterProductCapacityResponse, CoverRouterQuoteResponse, DEFAULT_COMMISSION_RATIO, DEFAULT_SLIPPAGE, ErrorApiResponse, ErrorResponse, FloatString, GetQuoteApiResponse, GetQuoteResponse, IPFSContentAndType, IPFSContentForProductType, IPFSContentTypes, IPFSUploadServiceResponse, IPFS_CONTENT_TYPE_BY_PRODUCT_TYPE, IntString, Integer, LogoFileName, LogoName, MAXIMUM_COVER_PERIOD, MINIMUM_COVER_PERIOD, NEXUS_MUTUAL_DAO_TREASURY_ADDRESS, PoolAllocationRequest, PoolCapacity, ProductCategoryEnum, ProductTypes, Quote, QuoteDisplayInfo, Reserves, SLIPPAGE_DENOMINATOR, TARGET_PRICE_DENOMINATOR, allLogoFileNames, allLogoNames, allPrivateProductsIds, calculateEthForExactNxm, calculateExactEthForNxm, calculateExactNxmForEth, calculateNxmForExactEth, calculatePremiumWithCommissionAndSlippage, calculatePriceImpactA, calculatePriceImpactB, calculateSpotPrice, categoryLabelByEnum, nexusSdk as default, getQuoteAndBuyCoverInputs, productCategoryMap, productTypes, products, productsMap, uploadIPFSContent, validateIPFSCid };