[PAY-1861] Expose Pay Extra details in purchase/sales tables (#6209)

AudiusProject · Oct 3, 2023 · 9f7cf0c · 9f7cf0c
1 parent d90897f
commit 9f7cf0c
Show file tree

Hide file tree

Showing 12 changed files with 156 additions and 56 deletions.
diff --git a/packages/common/src/api/purchases.ts b/packages/common/src/api/purchases.ts
@@ -21,13 +21,21 @@ type GetPurchaseListArgs = {
 }
 
 const parsePurchase = (purchase: full.Purchase): USDCPurchaseDetails => {
-  const { contentId, contentType, amount, buyerUserId, sellerUserId, ...rest } =
-    purchase
+  const {
+    contentId,
+    contentType,
+    extraAmount,
+    amount,
+    buyerUserId,
+    sellerUserId,
+    ...rest
+  } = purchase
   return {
     ...rest,
     contentType: contentType as USDCContentPurchaseType,
     contentId: HashId.parse(contentId),
     amount: amount as StringUSDC,
+    extraAmount: extraAmount as StringUSDC,
     buyerUserId: HashId.parse(buyerUserId),
     sellerUserId: HashId.parse(sellerUserId)
   }

diff --git a/packages/common/src/models/USDCTransactions.ts b/packages/common/src/models/USDCTransactions.ts
@@ -22,6 +22,7 @@ export type USDCPurchaseDetails = {
   sellerUserId: number
   buyerUserId: number
   amount: StringUSDC
+  extraAmount: StringUSDC
   contentType: USDCContentPurchaseType
   contentId: number
   createdAt: string

diff --git a/packages/common/src/utils/wallet.ts b/packages/common/src/utils/wallet.ts
@@ -162,10 +162,16 @@ export const floorBNUSDCToNearestCent = (value: BNUSDC): BNUSDC => {
 }
 
 /** Formats a USDC wei string (full precision) to a fixed string suitable for
-display as a dollar amount. Note: will lose precision by rounding _up_ to nearest cent */
-export const formatUSDCWeiToUSDString = (amount: StringUSDC, precision = 2) => {
+display as a dollar amount. Note: will lose precision by rounding _up_ to nearest
+cent and will drop negative signs
+*/
+export const formatUSDCWeiToUSDString = (
+  amount: StringUSDC | BN,
+  precision = 2
+) => {
+  const amountBN = BN.isBN(amount) ? amount : new BN(amount)
   // remove negative sign if present.
-  const amountPos = amount.replace('-', '')
+  const amountPos = amountBN.abs()
   // Since we only need two digits of precision, we will multiply up by 1000
   // with BN, divide by $1 Wei, ceiling up to the nearest cent,
   //  and then convert to JS number and divide back down before formatting to

diff --git a/...ges/web/src/components/premium-content-purchase-modal/components/PurchaseSummaryTable.tsx b/...ges/web/src/components/premium-content-purchase-modal/components/PurchaseSummaryTable.tsx
@@ -1,11 +1,9 @@
 import { formatPrice } from '@audius/common'
 
-import { Text } from 'components/typography'
-
-import styles from './PurchaseSummaryTable.module.css'
+import { SummaryTable, SummaryTableItem } from 'components/summary-table'
 
 const messages = {
-  summary: 'Summary',
+  summary: 'Transaction Summary',
   premiumTrack: 'Premium Track',
   existingBalance: 'Existing USDC Balance',
   payExtra: 'Pay Extra',
@@ -30,33 +28,37 @@ export const PurchaseSummaryTable = ({
   existingBalance,
   isPurchased
 }: PurchaseSummaryTableProps) => {
+  const items: SummaryTableItem[] = [
+    {
+      id: 'premiumTrack',
+      label: messages.premiumTrack,
+      value: messages.price(formatPrice(basePrice))
+    }
+  ]
+  if (extraAmount != null) {
+    items.push({
+      id: 'payExtra',
+      label: messages.payExtra,
+      value: messages.price(formatPrice(extraAmount))
+    })
+  }
+  if (existingBalance != null) {
+    items.push({
+      id: 'existingBalance',
+      label: messages.existingBalance,
+      value: `-${messages.price(formatPrice(existingBalance))}`
+    })
+  }
+
   return (
-    <Text className={styles.container}>
-      <Text className={styles.row} variant='label' size='large'>
-        {messages.summary}
-      </Text>
-      <div className={styles.row}>
-        <span>{messages.premiumTrack}</span>
-        <span>{messages.price(formatPrice(basePrice))}</span>
-      </div>
-      {extraAmount != null ? (
-        <div className={styles.row}>
-          <span>{messages.payExtra}</span>
-          <span>{messages.price(formatPrice(extraAmount))}</span>
-        </div>
-      ) : null}
-      {existingBalance != null ? (
-        <div className={styles.row}>
-          <span>{messages.existingBalance}</span>
-          <span>{`-${messages.price(formatPrice(existingBalance))}`}</span>
-        </div>
-      ) : null}
-      <Text className={styles.row} variant='title'>
-        <span>{isPurchased ? messages.youPaid : messages.total}</span>
-        <span className={styles.finalPrice}>
-          {messages.price(formatPrice(amountDue))}
-        </span>
-      </Text>
-    </Text>
+    <SummaryTable
+      items={items}
+      title={messages.summary}
+      summaryItem={{
+        id: 'total',
+        label: isPurchased ? messages.youPaid : messages.total,
+        value: messages.price(formatPrice(amountDue))
+      }}
+    />
   )
 }
diff --git a/...omponents/PurchaseSummaryTable.module.css → ...nts/summary-table/SummaryTable.module.css b/...omponents/PurchaseSummaryTable.module.css → ...nts/summary-table/SummaryTable.module.css
@@ -26,7 +26,3 @@
 .row:last-child {
   background: var(--background-surface-1);
 }
-
-.finalPrice {
-  color: var(--focus);
-}
diff --git a/packages/web/src/components/summary-table/SummaryTable.tsx b/packages/web/src/components/summary-table/SummaryTable.tsx
@@ -0,0 +1,45 @@
+import { ReactNode } from 'react'
+
+import { Text } from 'components/typography'
+
+import styles from './SummaryTable.module.css'
+
+export type SummaryTableItem = {
+  id: string
+  label: ReactNode
+  value: ReactNode
+}
+
+export type SummaryTableProps = {
+  items: SummaryTableItem[]
+  summaryItem: SummaryTableItem
+  title: ReactNode
+}
+
+export const SummaryTable = ({
+  items,
+  summaryItem,
+  title
+}: SummaryTableProps) => {
+  return (
+    <div className={styles.container}>
+      <Text className={styles.row} variant='title' size='large'>
+        {title}
+      </Text>
+      {items.map(({ id, label, value }) => (
+        <div key={id} className={styles.row}>
+          <Text>{label}</Text>
+          <Text>{value}</Text>
+        </div>
+      ))}
+      <div className={styles.row}>
+        <Text variant='title' size='medium'>
+          {summaryItem.label}
+        </Text>
+        <Text variant='title' size='medium' color='secondary'>
+          {summaryItem.value}
+        </Text>
+      </div>
+    </div>
+  )
+}
diff --git a/packages/web/src/components/summary-table/index.ts b/packages/web/src/components/summary-table/index.ts
@@ -0,0 +1 @@
+export * from './SummaryTable'
diff --git a/packages/web/src/components/usdc-purchase-details-modal/components/PurchaseModalContent.tsx b/packages/web/src/components/usdc-purchase-details-modal/components/PurchaseModalContent.tsx
@@ -1,6 +1,6 @@
 import { useCallback } from 'react'
 
-import { useGetTrackById, formatUSDCWeiToUSDString } from '@audius/common'
+import { useGetTrackById } from '@audius/common'
 import {
   ModalHeader,
   ModalTitle,
@@ -21,12 +21,12 @@ import { useGoToRoute } from 'hooks/useGoToRoute'
 
 import { DetailSection } from './DetailSection'
 import { TrackLink } from './TrackLink'
+import { TransactionSummary } from './TransactionSummary'
 import styles from './styles.module.css'
 import { ContentProps } from './types'
 
 const messages = {
   by: 'By',
-  cost: 'Cost',
   date: 'Date',
   done: 'Done',
   purchaseDetails: 'Purchase Details',
@@ -75,11 +75,7 @@ export const PurchaseModalContent = ({
             {moment(purchaseDetails.createdAt).format('MMM DD, YYYY')}
           </Text>
         </DetailSection>
-        <DetailSection label={messages.cost}>
-          <Text size='large'>{`$${formatUSDCWeiToUSDString(
-            purchaseDetails.amount
-          )}`}</Text>
-        </DetailSection>
+        <TransactionSummary transaction={purchaseDetails} />
       </ModalContent>
       <ModalFooter className={styles.footer}>
         <HarmonyButton

diff --git a/packages/web/src/components/usdc-purchase-details-modal/components/SaleModalContent.tsx b/packages/web/src/components/usdc-purchase-details-modal/components/SaleModalContent.tsx
@@ -4,7 +4,6 @@ import {
   CommonState,
   chatActions,
   chatSelectors,
-  formatUSDCWeiToUSDString,
   useInboxUnavailableModal
 } from '@audius/common'
 import {
@@ -27,14 +26,14 @@ import { UserNameAndBadges } from 'components/user-name-and-badges/UserNameAndBa
 
 import { DetailSection } from './DetailSection'
 import { TrackLink } from './TrackLink'
+import { TransactionSummary } from './TransactionSummary'
 import styles from './styles.module.css'
 import { ContentProps } from './types'
 
 const { getCanCreateChat } = chatSelectors
 const { createChat } = chatActions
 
 const messages = {
-  cost: 'Cost',
   date: 'Date',
   done: 'Done',
   messageBuyer: 'Message Buyer',
@@ -97,11 +96,7 @@ export const SaleModalContent = ({
             {moment(purchaseDetails.createdAt).format('MMM DD, YYYY')}
           </Text>
         </DetailSection>
-        <DetailSection label={messages.cost}>
-          <Text size='large'>{`$${formatUSDCWeiToUSDString(
-            purchaseDetails.amount
-          )}`}</Text>
-        </DetailSection>
+        <TransactionSummary transaction={purchaseDetails} />
       </ModalContent>
       <ModalFooter className={styles.footer}>
         <HarmonyButton

diff --git a/packages/web/src/components/usdc-purchase-details-modal/components/TransactionSummary.tsx b/packages/web/src/components/usdc-purchase-details-modal/components/TransactionSummary.tsx
@@ -0,0 +1,46 @@
+import { USDCPurchaseDetails, formatUSDCWeiToUSDString } from '@audius/common'
+import BN from 'bn.js'
+
+import { SummaryTable, SummaryTableItem } from 'components/summary-table'
+
+const messages = {
+  cost: 'Cost of Track',
+  payExtra: 'Pay Extra',
+  title: 'Transaction Summary',
+  total: 'Total'
+}
+
+export const TransactionSummary = ({
+  transaction
+}: {
+  transaction: USDCPurchaseDetails
+}) => {
+  const amountBN = new BN(transaction.amount)
+  const items: SummaryTableItem[] = [
+    {
+      id: 'cost',
+      label: messages.cost,
+      value: `$${formatUSDCWeiToUSDString(amountBN)}`
+    }
+  ]
+  const extraAmountBN = new BN(transaction.extraAmount)
+  if (!extraAmountBN.isZero()) {
+    items.push({
+      id: 'payExtra',
+      label: messages.payExtra,
+      value: `$${formatUSDCWeiToUSDString(extraAmountBN)}`
+    })
+  }
+
+  return (
+    <SummaryTable
+      title={messages.title}
+      items={items}
+      summaryItem={{
+        id: 'total',
+        label: messages.total,
+        value: `$${formatUSDCWeiToUSDString(amountBN.add(extraAmountBN))}`
+      }}
+    />
+  )
+}
diff --git a/packages/web/src/pages/purchases-and-sales/PurchasesTable.tsx b/packages/web/src/pages/purchases-and-sales/PurchasesTable.tsx
@@ -5,6 +5,7 @@ import {
   USDCContentPurchaseType,
   USDCPurchaseDetails
 } from '@audius/common'
+import BN from 'bn.js'
 import moment from 'moment'
 
 import { Table } from 'components/table'
@@ -76,7 +77,8 @@ const renderDateCell = (cellInfo: PurchaseCell) => {
 
 const renderValueCell = (cellInfo: PurchaseCell) => {
   const transaction = cellInfo.row.original
-  return `$${formatUSDCWeiToUSDString(transaction.amount)}`
+  const total = new BN(transaction.amount).add(new BN(transaction.extraAmount))
+  return `$${formatUSDCWeiToUSDString(total)}`
 }
 
 // Columns

diff --git a/packages/web/src/pages/purchases-and-sales/SalesTable.tsx b/packages/web/src/pages/purchases-and-sales/SalesTable.tsx
@@ -5,6 +5,7 @@ import {
   USDCContentPurchaseType,
   USDCPurchaseDetails
 } from '@audius/common'
+import { BN } from 'bn.js'
 import moment from 'moment'
 
 import { Table } from 'components/table'
@@ -73,7 +74,8 @@ const renderDateCell = (cellInfo: PurchaseCell) => {
 
 const renderValueCell = (cellInfo: PurchaseCell) => {
   const transaction = cellInfo.row.original
-  return `$${formatUSDCWeiToUSDString(transaction.amount)}`
+  const total = new BN(transaction.amount).add(new BN(transaction.extraAmount))
+  return `$${formatUSDCWeiToUSDString(total)}`
 }
 
 // Columns