@nexusmutual/sdk 1.6.0 → 1.6.1-rc.1

package/README.md

@@ -48,9 +48,9 @@ Copy the `.env.example` file into `.env` and populate with the required values.
 npm build
 ```
 
-## IPFS Upload Utils
+## IPFS Upload
 
-Use the `uploadIPFSContent` function from `src/ipfs/uploadIPFSContent.ts` to upload the content to IPFS. The function takes the following parameters:
+Use the `uploadIPFSContent` method in `Ipfs` class to upload the content to IPFS. The function takes the following parameters:
 
 - `type`: The type of the content. Based on ContentType enum.
 - `content`: The content to be uploaded to IPFS as IPFSContentTypes.
@@ -60,81 +60,159 @@ The function returns the IPFS hash of the uploaded content.
 ### Example
 
 ```typescript
-import { uploadIPFSContent, ContentType, IPFSContentTypes } from '@nexusmutual/sdk';
+import { Ipfs } from '@nexusmutual/sdk';
 
 const content: IPFSContentTypes = {
   version: '2.0',
   walletAddresses: ['0x1234567890'],
 };
 
-const ipfsHash = await uploadIPFSContent([ContentType.coverWalletAddresses, content]);
+const ipfs = new Ipfs(config: NexusSDKConfig = {});
+const ipfsHash = await ipfs.uploadIPFSContent([ContentType.coverWalletAddresses, content]);
 
 console.log(ipfsHash);
 ```
 
-## getQuoteAndBuyCoverInputs
+## Quote
 
-Use the `getQuoteAndBuyCoverInputs` function from `src/cover/getQuoteAndBuyCoverInputs.ts` to get the inputs required to get a quote and buy cover. The function has 2 overloads. One allows you to pass an IPFS Cid for the cover metadata, and the other allows you to pass the cover metadata directly. The function returns the inputs required to get a quote and buy cover.
+Use the `NexusSDK` or `Quote` class directly to get the inputs required to get a quote and buy cover.
 
-### Example
+```typescript
+interface NexusSDKConfig {
+  apiUrl?: string;
+}
+```
+```typescript
+const nexusSDK = new NexusSDK(config: NexusSDKConfig = {}, ipfs?: Ipfs)
+````
 
-1st overload:
+```typescript
+const quote = new Quote(config: NexusSDKConfig = {}, ipfs?: Ipfs)
+````
 
+### Params
 ```typescript
-import { CoverAsset, getQuoteAndBuyCoverInputs } from '@nexusmutual/sdk';
+export interface GetQuoteAndBuyCoverInputsParams {
+  /**
+   * ID of the product to buy cover for
+   */
+  productId: number;
+
+  /**
+   * Amount of cover to buy, as a string
+   */
+  amount: string;
+
+  /**
+   * Cover period in days
+   */
+  period: number;
+
+  /**
+   * Asset to use for cover
+   * Must be a valid CoverAsset enum value
+   */
+  coverAsset: number;
+
+  /**
+   * Address of the cover buyer
+   * Must be a valid Ethereum address
+   */
+  buyerAddress: string;
+
+  /**
+   * ID of the cover to edit
+   */
+  coverId?: number;
+
+  /**
+   * Optional slippage tolerance percentage
+   * Value between 0-1 (defaults to 0.001 ~ 0.1%)
+   */
+  slippage?: number;
+
+  /**
+   * Optional IPFS CID string or content object to upload
+   */
+  ipfsCidOrContent?: string | Record<string, unknown>;
+
+  /**
+   * Optional commission ratio
+   */
+  commissionRatio?: number;
+
+  /**
+   * Optional address of the commission receiver
+   */
+  commissionDestination?: string;
+
+  /**
+   * Asset to use for cover payment
+   * Must be a valid PaymentAsset enum value
+   */
+  paymentAsset?: number;
+}
+```
+
+### Example 1
+
+```typescript
+import { NexusSDK } from '@nexusmutual/sdk';
 
 const productId = 247; // Elite Cover Product - Nexus Mutual Cover Product Type
-const coverAmount = '100';
-const coverPeriod = 30;
+const amount = '100';
+const period = 30;
 const coverAsset = CoverAsset.ETH;
+const paymentAsset = CoverAsset.ETH;
 const buyerAddress = '0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5';
-const ipfsCid = 'QmXUzXDMbeKSCewUie34vPD7mCAGnshi4ULRy4h7DLmoRS';
+const ipfsCidOrContent = 'QmXUzXDMbeKSCewUie34vPD7mCAGnshi4ULRy4h7DLmoRS';
+
+const nexusSDK = new NexusSDK();
 
-const quoteAndBuyCoverInputs = await getQuoteAndBuyCoverInputs(
+const { result, error } = await nexusSDK.quote.getQuoteAndBuyCoverInputs({
   productId,
-  coverAmount,
-  coverPeriod,
+  amount,
+  period,
   coverAsset,
+  paymentAsset,
   buyerAddress,
-  undefined,
-  ipfsCid,
-);
+  ipfsCidOrContent,
+});
 
-console.log(quoteAndBuyCoverInputs);
+console.log(result);
 ```
 
-2nd overload:
+### Example 2
 
 ```typescript
-import { CoverAsset, getQuoteAndBuyCoverInputs, IPFSContentTypes } from '@nexusmutual/sdk';
+import { Quote } from '@nexusmutual/sdk';
 
 const productId = 247; // Elite Cover Product - Nexus Mutual Cover Product Type
-const coverAmount = '100';
-const coverPeriod = 30;
+const amount = '100';
+const period = 30;
 const coverAsset = CoverAsset.ETH;
+const paymentAsset = CoverAsset.ETH;
 const buyerAddress = '0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5';
-const ipfsContent: IPFSContentTypes = {
-  version: '2.0',
-  walletAddresses: ['0x1234567890123456789012345678901234567890'],
-};
+const ipfsCidOrContent = 'QmXUzXDMbeKSCewUie34vPD7mCAGnshi4ULRy4h7DLmoRS';
+
+const quote = new Quote();
 
-const quoteAndBuyCoverInputs = await getQuoteAndBuyCoverInputs(
+const { result, error } = await quote.getQuoteAndBuyCoverInputs({
   productId,
-  coverAmount,
-  coverPeriod,
+  amount,
+  period,
   coverAsset,
+  paymentAsset,
   buyerAddress,
-  undefined,
-  ipfsContent,
-);
+  ipfsCidOrContent,
+});
 
-console.log(quoteAndBuyCoverInputs);
+console.log(result);
 ```
 
-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.
+If the productId's type needs an IPFS upload, you can pass the `ipfsCidOrContent` param and the function will upload the content to IPFS and use the IPFS hash returned or you can pass the hash if you manually uploaded.
 
-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`.
+The `ipfsCidOrContent` param must be a valid IPFS Cid or a valid `IPFSContentTypes` - the allowed types can be found in `src/types/ipfs.ts`.
 
 ### Product Types and IPFS Content Mapping
 

package/dist/data/products.json

@@ -2429,7 +2429,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1739447471,
+    "timestamp": 1753877075,
     "minPrice": 100
   },
   {
@@ -3853,7 +3853,7 @@
       "ETH"
     ],
     "isPrivate": false,
-    "timestamp": 1734557999,
+    "timestamp": 1731583079,
     "minPrice": 100
   },
   {
@@ -4040,7 +4040,7 @@
       "USDC"
     ],
     "isPrivate": false,
-    "timestamp": 1723127459,
+    "timestamp": 1722950807,
     "minPrice": 100
   },
   {
@@ -4115,7 +4115,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1724341943,
+    "timestamp": 1734557999,
     "minPrice": 100
   },
   {
@@ -4134,7 +4134,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1734557999,
+    "timestamp": 1726227311,
     "minPrice": 100
   },
   {
@@ -4210,7 +4210,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1749739367,
+    "timestamp": 1751550659,
     "minPrice": 100
   },
   {
@@ -4229,7 +4229,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1749739367,
+    "timestamp": 1753877075,
     "minPrice": 100
   },
   {
@@ -4509,7 +4509,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1740672395,
+    "timestamp": 1733326763,
     "minPrice": 49
   },
   {
@@ -4528,7 +4528,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1740672395,
+    "timestamp": 1733326763,
     "minPrice": 225
   },
   {
@@ -4547,7 +4547,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1749739367,
+    "timestamp": 1753877075,
     "minPrice": 310
   },
   {
@@ -4797,7 +4797,7 @@
       "USDC"
     ],
     "isPrivate": false,
-    "timestamp": 1747055891,
+    "timestamp": 1744902863,
     "minPrice": 50
   },
   {
@@ -5028,7 +5028,7 @@
       "ETH"
     ],
     "isPrivate": true,
-    "timestamp": 1740672395,
+    "timestamp": 1741267523,
     "minPrice": 95
   },
   {
@@ -5248,7 +5248,7 @@
       "USDC"
     ],
     "isPrivate": false,
-    "timestamp": 1747055891,
+    "timestamp": 1742481059,
     "minPrice": 100
   },
   {
@@ -5320,7 +5320,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1751550659,
+    "timestamp": 1743519947,
     "minPrice": 100
   },
   {
@@ -5356,7 +5356,7 @@
       "USDC"
     ],
     "isPrivate": true,
-    "timestamp": 1743670835,
+    "timestamp": 1743603467,
     "minPrice": 1586
   },
   {
@@ -5463,7 +5463,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1747055891,
+    "timestamp": 1751550659,
     "minPrice": 309
   },
   {
@@ -5620,7 +5620,7 @@
       "cbBTC"
     ],
     "isPrivate": false,
-    "timestamp": 1750162583,
+    "timestamp": 1751550659,
     "minPrice": 100
   },
   {

package/dist/index.d.mts

@@ -3278,7 +3278,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1739447471,
+		timestamp: 1753877075,
 		minPrice: 100
 	},
 	{
@@ -4724,7 +4724,7 @@ var products = [
 			"ETH"
 		],
 		isPrivate: false,
-		timestamp: 1734557999,
+		timestamp: 1731583079,
 		minPrice: 100
 	},
 	{
@@ -4916,7 +4916,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: false,
-		timestamp: 1723127459,
+		timestamp: 1722950807,
 		minPrice: 100
 	},
 	{
@@ -4991,7 +4991,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1724341943,
+		timestamp: 1734557999,
 		minPrice: 100
 	},
 	{
@@ -5010,7 +5010,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1734557999,
+		timestamp: 1726227311,
 		minPrice: 100
 	},
 	{
@@ -5087,7 +5087,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1749739367,
+		timestamp: 1751550659,
 		minPrice: 100
 	},
 	{
@@ -5106,7 +5106,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1749739367,
+		timestamp: 1753877075,
 		minPrice: 100
 	},
 	{
@@ -5394,7 +5394,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1740672395,
+		timestamp: 1733326763,
 		minPrice: 49
 	},
 	{
@@ -5413,7 +5413,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1740672395,
+		timestamp: 1733326763,
 		minPrice: 225
 	},
 	{
@@ -5432,7 +5432,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1749739367,
+		timestamp: 1753877075,
 		minPrice: 310
 	},
 	{
@@ -5688,7 +5688,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: false,
-		timestamp: 1747055891,
+		timestamp: 1744902863,
 		minPrice: 50
 	},
 	{
@@ -5919,7 +5919,7 @@ var products = [
 			"ETH"
 		],
 		isPrivate: true,
-		timestamp: 1740672395,
+		timestamp: 1741267523,
 		minPrice: 95
 	},
 	{
@@ -6142,7 +6142,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: false,
-		timestamp: 1747055891,
+		timestamp: 1742481059,
 		minPrice: 100
 	},
 	{
@@ -6214,7 +6214,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1751550659,
+		timestamp: 1743519947,
 		minPrice: 100
 	},
 	{
@@ -6250,7 +6250,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: true,
-		timestamp: 1743670835,
+		timestamp: 1743603467,
 		minPrice: 1586
 	},
 	{
@@ -6359,7 +6359,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1747055891,
+		timestamp: 1751550659,
 		minPrice: 309
 	},
 	{
@@ -6521,7 +6521,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1750162583,
+		timestamp: 1751550659,
 		minPrice: 100
 	},
 	{

package/dist/index.d.ts

@@ -3278,7 +3278,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1739447471,
+		timestamp: 1753877075,
 		minPrice: 100
 	},
 	{
@@ -4724,7 +4724,7 @@ var products = [
 			"ETH"
 		],
 		isPrivate: false,
-		timestamp: 1734557999,
+		timestamp: 1731583079,
 		minPrice: 100
 	},
 	{
@@ -4916,7 +4916,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: false,
-		timestamp: 1723127459,
+		timestamp: 1722950807,
 		minPrice: 100
 	},
 	{
@@ -4991,7 +4991,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1724341943,
+		timestamp: 1734557999,
 		minPrice: 100
 	},
 	{
@@ -5010,7 +5010,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1734557999,
+		timestamp: 1726227311,
 		minPrice: 100
 	},
 	{
@@ -5087,7 +5087,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1749739367,
+		timestamp: 1751550659,
 		minPrice: 100
 	},
 	{
@@ -5106,7 +5106,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1749739367,
+		timestamp: 1753877075,
 		minPrice: 100
 	},
 	{
@@ -5394,7 +5394,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1740672395,
+		timestamp: 1733326763,
 		minPrice: 49
 	},
 	{
@@ -5413,7 +5413,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1740672395,
+		timestamp: 1733326763,
 		minPrice: 225
 	},
 	{
@@ -5432,7 +5432,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1749739367,
+		timestamp: 1753877075,
 		minPrice: 310
 	},
 	{
@@ -5688,7 +5688,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: false,
-		timestamp: 1747055891,
+		timestamp: 1744902863,
 		minPrice: 50
 	},
 	{
@@ -5919,7 +5919,7 @@ var products = [
 			"ETH"
 		],
 		isPrivate: true,
-		timestamp: 1740672395,
+		timestamp: 1741267523,
 		minPrice: 95
 	},
 	{
@@ -6142,7 +6142,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: false,
-		timestamp: 1747055891,
+		timestamp: 1742481059,
 		minPrice: 100
 	},
 	{
@@ -6214,7 +6214,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1751550659,
+		timestamp: 1743519947,
 		minPrice: 100
 	},
 	{
@@ -6250,7 +6250,7 @@ var products = [
 			"USDC"
 		],
 		isPrivate: true,
-		timestamp: 1743670835,
+		timestamp: 1743603467,
 		minPrice: 1586
 	},
 	{
@@ -6359,7 +6359,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1747055891,
+		timestamp: 1751550659,
 		minPrice: 309
 	},
 	{
@@ -6521,7 +6521,7 @@ var products = [
 			"cbBTC"
 		],
 		isPrivate: false,
-		timestamp: 1750162583,
+		timestamp: 1751550659,
 		minPrice: 100
 	},
 	{