@nexusmutual/sdk 2.1.1-rc.0 → 3.0.0-rc.0

package/dist/index.d.ts

@@ -138,144 +138,101 @@ type GetQuoteResponse = {
 };
 type GetQuoteApiResponse = ApiResponse<GetQuoteResponse, undefined>;
 
-declare const coverValidatorsSchema: z.ZodObject<{
-    version: z.ZodLiteral<"1.0">;
-    validators: z.ZodArray<z.ZodString, "many">;
-}, "strip", z.ZodTypeAny, {
-    version: "1.0";
-    validators: string[];
-}, {
-    version: "1.0";
-    validators: string[];
-}>;
-declare const coverQuotaShareSchema: z.ZodObject<{
-    version: z.ZodLiteral<"1.0">;
-    quotaShare: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    version: "1.0";
-    quotaShare: number;
-}, {
-    version: "1.0";
-    quotaShare: number;
-}>;
-declare const coverAumCoverAmountPercentageSchema: z.ZodObject<{
-    version: z.ZodLiteral<"1.0">;
-    aumCoverAmountPercentage: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    version: "1.0";
-    aumCoverAmountPercentage: number;
-}, {
-    version: "1.0";
-    aumCoverAmountPercentage: number;
-}>;
-declare const coverWalletAddressSchema: z.ZodObject<{
-    version: z.ZodLiteral<"1.0">;
-    walletAddress: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    version: "1.0";
-    walletAddress: string;
-}, {
-    version: "1.0";
-    walletAddress: string;
-}>;
-declare const coverWalletAddressesSchema: z.ZodDiscriminatedUnion<"version", [z.ZodObject<{
-    version: z.ZodLiteral<"1.0">;
-    walletAddresses: z.ZodEffects<z.ZodString, string, string>;
-}, "strip", z.ZodTypeAny, {
-    version: "1.0";
-    walletAddresses: string;
-}, {
-    version: "1.0";
-    walletAddresses: string;
-}>, z.ZodObject<{
-    version: z.ZodLiteral<"2.0">;
-    walletAddresses: z.ZodArray<z.ZodString, "many">;
-}, "strip", z.ZodTypeAny, {
-    version: "2.0";
-    walletAddresses: string[];
-}, {
-    version: "2.0";
-    walletAddresses: string[];
-}>]>;
-declare const coverFreeTextSchema: z.ZodObject<{
-    version: z.ZodLiteral<"1.0">;
-    freeText: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    version: "1.0";
-    freeText: string;
-}, {
-    version: "1.0";
-    freeText: string;
-}>;
-declare const coverDesignatedWalletsSchema: z.ZodObject<{
-    version: z.ZodLiteral<"1.0">;
-    wallets: z.ZodArray<z.ZodObject<{
-        wallet: z.ZodString;
-        amount: z.ZodString;
-        currency: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        wallet: string;
-        amount: string;
-        currency: string;
-    }, {
-        wallet: string;
-        amount: string;
-        currency: string;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    version: "1.0";
-    wallets: {
-        wallet: string;
-        amount: string;
-        currency: string;
-    }[];
-}, {
-    version: "1.0";
-    wallets: {
-        wallet: string;
-        amount: string;
-        currency: string;
-    }[];
-}>;
-declare const defiPassContentSchema: z.ZodUnion<[z.ZodObject<{
-    version: z.ZodLiteral<"1.0">;
-    walletAddress: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    version: "1.0";
-    walletAddress: string;
-}, {
-    version: "1.0";
-    walletAddress: string;
-}>, z.ZodObject<{
-    version: z.ZodLiteral<"1.0">;
-    wallets: z.ZodArray<z.ZodObject<{
-        wallet: z.ZodString;
-        amount: z.ZodString;
-        currency: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        wallet: string;
-        amount: string;
-        currency: string;
-    }, {
-        wallet: string;
-        amount: string;
-        currency: string;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    version: "1.0";
-    wallets: {
-        wallet: string;
-        amount: string;
-        currency: string;
-    }[];
-}, {
-    version: "1.0";
-    wallets: {
-        wallet: string;
-        amount: string;
-        currency: string;
-    }[];
-}>]>;
+interface AddressValue {
+    address: string;
+    label?: string;
+}
+interface FreeTextValue {
+    value: string;
+    label?: string;
+}
+interface ApiKeyValue {
+    credential: string;
+    label: string;
+    role: string;
+}
+interface ValidatorValue {
+    value: string;
+    label?: string;
+    role?: string;
+}
+interface CsvValue {
+    address: string;
+    amount: string;
+    currency: string;
+}
+type ProofOfLossEntry = {
+    type: 'address';
+    content: AddressValue[];
+} | {
+    type: 'api_key';
+    content: ApiKeyValue[];
+} | {
+    type: 'validator';
+    content: ValidatorValue[];
+} | {
+    type: 'csv';
+    content: CsvValue[];
+} | {
+    type: 'free_text';
+    content: FreeTextValue[];
+};
+interface CoverPublicData {
+    quotaShare?: number;
+    aumCoverAmountPercentage?: number;
+}
+interface CoverMetadataInput {
+    proofOfLoss?: ProofOfLossEntry[];
+    publicData?: CoverPublicData;
+}
+interface CoverMetadataResponse {
+    cid: string;
+}
+interface GetCoverResponse {
+    coverId: number;
+    productId: number;
+    coverAsset: number;
+    amount: string;
+    start: string;
+    period: string;
+    gracePeriod: string;
+    coverMetadataId?: string;
+}
+type GetCoverApiResponse = ApiResponse<GetCoverResponse, undefined>;
+interface AuthPayload {
+    timestamp: bigint;
+    message: string;
+}
+interface AuthSignature {
+    signature: string;
+    payload: AuthPayload;
+}
+interface ViewCoverMetadataParams {
+    coverMetadataId: string;
+    signature?: AuthSignature;
+}
+interface PrivateMetadata {
+    proofOfLoss: ProofOfLossEntry[] | null;
+    createdAt: string | null;
+}
+interface ViewCoverMetadataResponse {
+    id: string;
+    coverId: number;
+    createdAt: string;
+    updatedAt: string | null;
+    publicData: CoverPublicData | null;
+    privateData?: PrivateMetadata;
+}
+type ViewCoverMetadataApiResponse = ApiResponse<ViewCoverMetadataResponse, undefined>;
+interface EditCoverMetadataParams {
+    coverMetadataId: string;
+    proofOfLoss: ProofOfLossEntry[];
+    signature: AuthSignature;
+}
+type EditCoverMetadataApiResponse = ApiResponse<{
+    success: boolean;
+}, undefined>;
+
 declare const stakingPoolDetailsSchema: z.ZodObject<{
     version: z.ZodLiteral<"1.0">;
     poolName: z.ZodString;
@@ -433,14 +390,6 @@ declare const coverMetadataRefSchema: z.ZodObject<{
 }>;
 
 declare enum ContentType {
-    coverValidators = "coverValidators",
-    coverQuotaShare = "coverQuotaShare",
-    coverAumCoverAmountPercentage = "coverAumCoverAmountPercentage",
-    coverWalletAddress = "coverWalletAddress",
-    coverWalletAddresses = "coverWalletAddresses",
-    coverFreeText = "coverFreeText",
-    coverDesignatedWallets = "coverDesignatedWallets",
-    defiPassContent = "defiPassContent",
     stakingPoolDetails = "stakingPoolDetails",
     claimProof = "claimProof",
     assessmentCriteriaAnswers = "assessmentCriteriaAnswers",
@@ -451,14 +400,6 @@ declare enum ContentType {
     productAnnex = "productAnnex",
     coverMetadataRef = "coverMetadataRef"
 }
-type CoverValidators = z.infer<typeof coverValidatorsSchema>;
-type CoverQuotaShare = z.infer<typeof coverQuotaShareSchema>;
-type CoverAumCoverAmountPercentage = z.infer<typeof coverAumCoverAmountPercentageSchema>;
-type CoverWalletAddress = z.infer<typeof coverWalletAddressSchema>;
-type CoverWalletAddresses = z.infer<typeof coverWalletAddressesSchema>;
-type CoverFreeText = z.infer<typeof coverFreeTextSchema>;
-type CoverDesignatedWallets = z.infer<typeof coverDesignatedWalletsSchema>;
-type DefiPassContent = z.infer<typeof defiPassContentSchema>;
 type StakingPoolDetails = z.infer<typeof stakingPoolDetailsSchema>;
 type ClaimProof = z.infer<typeof claimProofSchema>;
 type AssessmentCriteriaAnswers = z.infer<typeof assessmentCriteriaAnswersSchema>;
@@ -468,12 +409,50 @@ type File = z.infer<typeof fileSchema>;
 type AssessmentReason = z.infer<typeof assessmentReasonSchema>;
 type ProductAnnex = z.infer<typeof productAnnexSchema>;
 type CoverMetadataRef = z.infer<typeof coverMetadataRefSchema>;
-type IPFSContentTypes = CoverValidators | CoverQuotaShare | CoverAumCoverAmountPercentage | CoverWalletAddress | CoverWalletAddresses | CoverFreeText | CoverDesignatedWallets | DefiPassContent | StakingPoolDetails | ClaimProof | AssessmentCriteriaAnswers | AssessmentReason | GovernanceProposal | GovernanceCategory | File | ProductAnnex | CoverMetadataRef;
-type IPFSTypeContentTuple = [type: ContentType.coverValidators, content: CoverValidators] | [type: ContentType.coverQuotaShare, content: CoverQuotaShare] | [type: ContentType.coverAumCoverAmountPercentage, content: CoverAumCoverAmountPercentage] | [type: ContentType.coverWalletAddress, content: CoverWalletAddress] | [type: ContentType.coverWalletAddresses, content: CoverWalletAddresses] | [type: ContentType.coverFreeText, content: CoverFreeText] | [type: ContentType.coverDesignatedWallets, content: CoverDesignatedWallets] | [type: ContentType.defiPassContent, content: DefiPassContent] | [type: ContentType.stakingPoolDetails, content: StakingPoolDetails] | [type: ContentType.claimProof, content: ClaimProof] | [type: ContentType.assessmentCriteriaAnswers, content: AssessmentCriteriaAnswers] | [type: ContentType.assessmentReason, content: AssessmentReason] | [type: ContentType.governanceProposal, content: GovernanceProposal] | [type: ContentType.governanceCategory, content: GovernanceCategory] | [type: ContentType.file, content: File] | [type: ContentType.productAnnex, content: ProductAnnex] | [type: ContentType.coverMetadataRef, content: CoverMetadataRef];
+type IPFSContentTypes = StakingPoolDetails | ClaimProof | AssessmentCriteriaAnswers | AssessmentReason | GovernanceProposal | GovernanceCategory | File | ProductAnnex | CoverMetadataRef;
+type IPFSTypeContentTuple = [type: ContentType.stakingPoolDetails, content: StakingPoolDetails] | [type: ContentType.claimProof, content: ClaimProof] | [type: ContentType.assessmentCriteriaAnswers, content: AssessmentCriteriaAnswers] | [type: ContentType.assessmentReason, content: AssessmentReason] | [type: ContentType.governanceProposal, content: GovernanceProposal] | [type: ContentType.governanceCategory, content: GovernanceCategory] | [type: ContentType.file, content: File] | [type: ContentType.productAnnex, content: ProductAnnex] | [type: ContentType.coverMetadataRef, content: CoverMetadataRef];
 type IPFSUploadServiceResponse = {
     ipfsHash: string;
 };
 
+type ProductType = {
+    id: Integer;
+    name: string;
+    metadata: string;
+    claimMethod: Integer;
+    gracePeriod: string;
+    assessmentCooldownPeriod: string;
+    payoutRedemptionPeriod: string;
+    commissionRatio: string;
+    commissionDestination: string;
+    buyCoverForm?: BuyCoverFormType;
+};
+type BuyCoverFormType = 'basic' | 'withQuotaShare' | 'withAUM' | 'unsupported';
+type Product = {
+    id: Integer;
+    productType: ProductType['id'];
+    name: string;
+    minPrice: string;
+    coverAssets: Array<{
+        assetId: CoverAsset;
+        assetSymbol: string;
+    }>;
+    initialPriceRatio: string;
+    capacityReductionRatio: string;
+    isDeprecated: boolean;
+    useFixedPrice: boolean;
+    metadata: string | {
+        annex?: string;
+        schedule?: string;
+        exclusions?: string;
+    };
+    allowedPools: Integer[];
+    timestamp: number;
+    isPrivate: boolean;
+    logo?: string;
+    proofOfLossInputTypes?: ProofOfLossEntry['type'][];
+};
+
 /**
  * Configuration options for the Nexus SDK
  */
@@ -519,9 +498,13 @@ interface GetQuoteAndBuyCoverInputsParams {
      */
     slippage?: number;
     /**
-     * Optional IPFS CID string or content object to upload
+     * Optional IPFS CID string
      */
-    ipfsCidOrContent?: string | Record<string, unknown>;
+    ipfsCid?: string;
+    /**
+     * Optional cover metadata (proof of loss and/or public data)
+     */
+    coverMetadata?: CoverMetadataInput;
     /**
      * Optional commission ratio
      */
@@ -569,6 +552,15 @@ declare class NexusSDKBase {
     private parseResponseBody;
 }
 
+declare class CoverData extends NexusSDKBase {
+    constructor(config?: NexusSDKConfig);
+    getCover(coverId: number): Promise<GetCoverApiResponse | ErrorApiResponse>;
+    viewCoverMetadata(params: ViewCoverMetadataParams): Promise<ViewCoverMetadataApiResponse | ErrorApiResponse>;
+    editCoverMetadata(params: EditCoverMetadataParams): Promise<EditCoverMetadataApiResponse | ErrorApiResponse>;
+    createCoverMetadata(input: CoverMetadataInput): Promise<string>;
+    private buildAuthHeaders;
+}
+
 /**
  * Class for handling IPFS-related functionality
  */
@@ -597,34 +589,6 @@ declare class Ipfs extends NexusSDKBase {
      * @returns Validated content
      */
     validateIPFSContent(type: ContentType, content: IPFSContentTypes): {
-        version: "1.0";
-        validators: string[];
-    } | {
-        version: "1.0";
-        quotaShare: number;
-    } | {
-        version: "1.0";
-        aumCoverAmountPercentage: number;
-    } | {
-        version: "1.0";
-        walletAddress: string;
-    } | {
-        version: "1.0";
-        walletAddresses: string;
-    } | {
-        version: "2.0";
-        walletAddresses: string[];
-    } | {
-        version: "1.0";
-        freeText: string;
-    } | {
-        version: "1.0";
-        wallets: {
-            wallet: string;
-            amount: string;
-            currency: string;
-        }[];
-    } | {
         version: "1.0";
         poolName: string;
         poolDescription: string;
@@ -690,12 +654,12 @@ declare class Ipfs extends NexusSDKBase {
 declare class Quote extends NexusSDKBase {
     private ipfs;
     private productAPI;
+    private coverData;
     /**
      * Create a new Quote instance
      * @param config SDK configuration
-     * @param ipfs IPFS instance for content upload and validation
      */
-    constructor(config?: NexusSDKConfig, ipfs?: Ipfs);
+    constructor(config?: NexusSDKConfig);
     /**
      * Get quote and buy cover inputs
      * @param params Parameters for the quote
@@ -803,48 +767,13 @@ declare class Swap {
  * Main Nexus SDK class that provides access to all SDK functionality
  */
 declare class NexusSDK extends NexusSDKBase {
+    cover: CoverData;
     quote: Quote;
     swap: Swap;
     ipfs: Ipfs;
     constructor(config?: NexusSDKConfig);
 }
 
-type ProductType = {
-    id: Integer;
-    name: string;
-    metadata: string;
-    claimMethod: Integer;
-    gracePeriod: string;
-    assessmentCooldownPeriod: string;
-    payoutRedemptionPeriod: string;
-    commissionRatio: string;
-    commissionDestination: string;
-    ipfsContentType?: ContentType;
-};
-type Product = {
-    id: Integer;
-    productType: ProductType['id'];
-    name: string;
-    minPrice: string;
-    coverAssets: Array<{
-        assetId: CoverAsset;
-        assetSymbol: string;
-    }>;
-    initialPriceRatio: string;
-    capacityReductionRatio: string;
-    isDeprecated: boolean;
-    useFixedPrice: boolean;
-    metadata: string | {
-        annex?: string;
-        schedule?: string;
-        exclusions?: string;
-    };
-    allowedPools: Integer[];
-    timestamp: number;
-    isPrivate: boolean;
-    logo?: string;
-};
-
 declare class ProductAPI extends NexusSDKBase {
     /**
      * Create a new ProductAPI instance
@@ -854,9 +783,10 @@ declare class ProductAPI extends NexusSDKBase {
     /**
      * Get product type details by ID
      * @param productTypeId ID of the product type
+     * @param params Optional attributes to include
      * @returns Product type details
      */
-    getProductTypeById(productTypeId: number): Promise<ProductType>;
+    getProductTypeById(productTypeId: number, params?: string[]): Promise<ProductType>;
     /**
      * Get all product types
      * @returns List of product types
@@ -867,7 +797,7 @@ declare class ProductAPI extends NexusSDKBase {
      * @param productId ID of the product
      * @returns Product details
      */
-    getProductById(productId: number): Promise<Product>;
+    getProductById(productId: number, params?: string[]): Promise<Product>;
     /**
      * Get all products
      * @returns List of products
@@ -875,9 +805,99 @@ declare class ProductAPI extends NexusSDKBase {
     getAllProducts(): Promise<Product[]>;
 }
 
+/**
+ * Builds a complete EIP-712 typed-data object for Nexus Mutual API authentication.
+ * Pass the returned object to your wallet's `signTypedData` (viem, ethers, etc.).
+ */
+declare function buildAuthTypedData(message: string): {
+    domain: {
+        readonly name: "Nexus Mutual App";
+        readonly version: "1.0.0";
+    };
+    types: {
+        readonly Authentication: readonly [{
+            readonly name: "timestamp";
+            readonly type: "uint256";
+        }, {
+            readonly name: "message";
+            readonly type: "string";
+        }];
+    };
+    primaryType: "Authentication";
+    value: {
+        timestamp: bigint;
+        message: string;
+    };
+};
+/**
+ * Builds a complete EIP-712 typed-data object for cover metadata authentication.
+ * Pass the returned object to your wallet's `signTypedData` (viem, ethers, etc.).
+ */
+declare function buildCoverMetadataAuthMessage(): {
+    domain: {
+        readonly name: "Nexus Mutual App";
+        readonly version: "1.0.0";
+    };
+    types: {
+        readonly Authentication: readonly [{
+            readonly name: "timestamp";
+            readonly type: "uint256";
+        }, {
+            readonly name: "message";
+            readonly type: "string";
+        }];
+    };
+    primaryType: "Authentication";
+    value: {
+        timestamp: bigint;
+        message: string;
+    };
+};
+
 declare const nexusSdk: {
     NexusSDK: typeof NexusSDK;
     ApiError: typeof ApiError;
+    buildAuthTypedData(message: string): {
+        domain: {
+            readonly name: "Nexus Mutual App";
+            readonly version: "1.0.0";
+        };
+        types: {
+            readonly Authentication: readonly [{
+                readonly name: "timestamp";
+                readonly type: "uint256";
+            }, {
+                readonly name: "message";
+                readonly type: "string";
+            }];
+        };
+        primaryType: "Authentication";
+        value: {
+            timestamp: bigint;
+            message: string;
+        };
+    };
+    buildCoverMetadataAuthMessage(): {
+        domain: {
+            readonly name: "Nexus Mutual App";
+            readonly version: "1.0.0";
+        };
+        types: {
+            readonly Authentication: readonly [{
+                readonly name: "timestamp";
+                readonly type: "uint256";
+            }, {
+                readonly name: "message";
+                readonly type: "string";
+            }];
+        };
+        primaryType: "Authentication";
+        value: {
+            timestamp: bigint;
+            message: string;
+        };
+    };
+    CoverData: typeof CoverData;
     CoverAsset: typeof CoverAsset;
     PaymentAsset: typeof PaymentAsset;
     COMMISSION_DENOMINATOR: 10000;
@@ -36707,4 +36727,4 @@ declare const nexusSdk: {
     }];
 };
 
-export { Address, ApiError, ApiResponse, AssessmentCriteriaAnswers, AssessmentReason, BuyCoverInput, BuyCoverParams, COMMISSION_DENOMINATOR, Capacity, ClaimProof, ContentType, CoverAsset, CoverAumCoverAmountPercentage, CoverDesignatedWallets, CoverFreeText, CoverMetadataRef, CoverQuotaShare, CoverRouterProductCapacityResponse, CoverRouterQuoteResponse, CoverValidators, CoverWalletAddress, CoverWalletAddresses, DEFAULT_SLIPPAGE, DefiPassContent, ErrorApiResponse, ErrorResponse, File, FloatString, GetQuoteAndBuyCoverInputsParams, GetQuoteApiResponse, GetQuoteResponse, GovernanceCategory, GovernanceProposal, IPFSContentTypes, IPFSTypeContentTuple, IPFSUploadServiceResponse, IntString, Integer, Ipfs, MAXIMUM_COVER_PERIOD, MINIMUM_COVER_PERIOD, NEXUS_MUTUAL_DAO_TREASURY_ADDRESS, NexusSDK, NexusSDKConfig, PaymentAsset, PoolAllocationRequest, PoolCapacity, ProductAPI, ProductAnnex, ProductCategoryEnum, Quote, QuoteDisplayInfo, QuoteParams, RequestConfig, Reserves, SLIPPAGE_DENOMINATOR, StakingPoolDetails, Swap, TARGET_PRICE_DENOMINATOR, categoryLabelByEnum, nexusSdk as default, productCategoryMap };
+export { Address, AddressValue, ApiError, ApiKeyValue, ApiResponse, AssessmentCriteriaAnswers, AssessmentReason, AuthPayload, AuthSignature, BuyCoverFormType, BuyCoverInput, BuyCoverParams, COMMISSION_DENOMINATOR, Capacity, ClaimProof, ContentType, CoverAsset, CoverData, CoverMetadataInput, CoverMetadataRef, CoverMetadataResponse, CoverPublicData, CoverRouterProductCapacityResponse, CoverRouterQuoteResponse, CsvValue, DEFAULT_SLIPPAGE, EditCoverMetadataApiResponse, EditCoverMetadataParams, ErrorApiResponse, ErrorResponse, File, FloatString, FreeTextValue, GetCoverApiResponse, GetCoverResponse, GetQuoteAndBuyCoverInputsParams, GetQuoteApiResponse, GetQuoteResponse, GovernanceCategory, GovernanceProposal, IPFSContentTypes, IPFSTypeContentTuple, IPFSUploadServiceResponse, IntString, Integer, Ipfs, MAXIMUM_COVER_PERIOD, MINIMUM_COVER_PERIOD, NEXUS_MUTUAL_DAO_TREASURY_ADDRESS, NexusSDK, NexusSDKConfig, PaymentAsset, PoolAllocationRequest, PoolCapacity, PrivateMetadata, Product, ProductAPI, ProductAnnex, ProductCategoryEnum, ProductType, ProofOfLossEntry, Quote, QuoteDisplayInfo, QuoteParams, RequestConfig, Reserves, SLIPPAGE_DENOMINATOR, StakingPoolDetails, Swap, TARGET_PRICE_DENOMINATOR, ValidatorValue, ViewCoverMetadataApiResponse, ViewCoverMetadataParams, ViewCoverMetadataResponse, buildAuthTypedData, buildCoverMetadataAuthMessage, categoryLabelByEnum, nexusSdk as default, productCategoryMap };