Add exported return type for GetTotalMintPriceAndFeesReturnType

soundxyz · Dec 28, 2023 · 50dae27 · 50dae27
1 parent 23e48a8
commit 50dae27
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 24 deletions.
diff --git a/.changeset/afraid-cameras-crash.md b/.changeset/afraid-cameras-crash.md
@@ -0,0 +1,5 @@
+---
+'@soundxyz/sdk': patch
+---
+
+Add exported return type for GetTotalMintPriceAndFeesReturnType
diff --git a/packages/sdk/src/contract/edition-v2/read/mint.ts b/packages/sdk/src/contract/edition-v2/read/mint.ts
@@ -15,34 +15,52 @@ export type GetTotalMintPriceAndFeesParams = {
   editionAddress: Address
 }
 
-export type GetTotalMintPriceAndFeesReturnType = {
-  // The required Ether value.
-  // `subTotal + platformFlatFee`.
-  total: bigint
-  // The total price before any additive fees.
-  subTotal: bigint
-  // The price per token.
-  unitPrice: bigint
-  // The total platform fees.
-  // `platformFlatFee + platformMintBPSFee`.
-  platformFee: bigint
-  // The total platform flat fees.
-  // `platformTxFlatFee + platformMintFlatFee`.
-  platformFlatFee: bigint
-  // The platform per-transaction flat fees.
-  platformTxFlatFee: bigint
-  // The total platform per-token flat fees.
-  platformMintFlatFee: bigint
-  // The total platform per-token BPS fees.
-  platformMintBPSFee: bigint
-  // The total affiliate fees.
-  affiliateFee: bigint
-}
+export type GetTotalMintPriceAndFeesReturnType =
+  | {
+      // SuperMinterV1
+      version: '1'
+      // The required Ether value.
+      total: bigint
+      // The total price before any additive fees.
+      subTotal: bigint
+      // The price per token.
+      unitPrice: bigint
+      // The total platform fees.
+      // `platformFlatFee + platformMintBPSFee`.
+      platformFee: bigint
+      // The total platform flat fees.
+      // `platformTxFlatFee + platformMintFlatFee`.
+      platformFlatFee: bigint
+      // The platform per-transaction flat fees.
+      platformTxFlatFee: bigint
+      // The total platform per-token flat fees.
+      platformMintFlatFee: bigint
+      // The total platform per-token BPS fees.
+      platformMintBPSFee: bigint
+      // The total affiliate fees.
+      affiliateFee: bigint
+    }
+  | {
+      // SuperMinterV2
+      version: '2'
+      // The required Ether value.
+      total: bigint
+      // The total price before any additive fees.
+      subTotal: bigint
+      // The price per token.
+      unitPrice: bigint
+      // The total artist fees.
+      finalArtistFee: bigint
+      // The total platform fees.
+      finalAffiliateFee: bigint
+      // The total platform fees.
+      finalPlatformFee: bigint
+    }
 
 export async function getTotalMintPriceAndFees<Client extends Pick<PublicClient, 'readContract' | 'multicall'>>(
   client: Client,
   { tier, scheduleNum, quantity, editionAddress }: GetTotalMintPriceAndFeesParams,
-) {
+): Promise<GetTotalMintPriceAndFeesReturnType> {
   const superMinter = await getSuperMinterForEdition(client, { editionAddress })
 
   switch (superMinter.version) {