refactor(renterd): contract total cost initial renter funds

SiaFoundation · Dec 2, 2024 · 48995db · 48995db
1 parent 8cdd612
commit 48995db
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 22 deletions.
diff --git a/.changeset/grumpy-badgers-share.md b/.changeset/grumpy-badgers-share.md
@@ -0,0 +1,8 @@
+---
+'renterd': minor
+'@siafoundation/renterd-js': minor
+'@siafoundation/renterd-react': minor
+'@siafoundation/renterd-types': minor
+---
+
+The contract total cost value is now called initial renter funds.
diff --git a/apps/renterd/contexts/contracts/columns.tsx b/apps/renterd/contexts/contracts/columns.tsx
@@ -376,23 +376,23 @@ export const columns: ContractsTableColumn[] = [
     },
   },
   {
-    id: 'totalCost',
-    label: 'total cost',
+    id: 'initialRenterFunds',
+    label: 'initial renter funds',
     category: 'financial',
     contentClassName: 'w-[120px] justify-end',
-    render: ({ data: { totalCost } }) => (
-      <ValueScFiat displayBoth size="12" value={totalCost.negated()} />
+    render: ({ data: { initialRenterFunds } }) => (
+      <ValueScFiat displayBoth size="12" value={initialRenterFunds.negated()} />
     ),
     summary: ({ context: { filteredStats } }) => {
-      if (!filteredStats.totalCostTotal) {
+      if (!filteredStats.initialRenterFundsTotal) {
         return null
       }
       return (
         <ValueScFiat
           displayBoth
           size="12"
-          value={filteredStats.totalCostTotal.negated()}
-          tooltip="Total cost across the filtered set of active contracts"
+          value={filteredStats.initialRenterFundsTotal.negated()}
+          tooltip="Total initial renter funds across the filtered set of active contracts"
         />
       )
     },

diff --git a/apps/renterd/contexts/contracts/dataset.tsx b/apps/renterd/contexts/contracts/dataset.tsx
@@ -57,7 +57,7 @@ export function useDataset() {
           revisionHeight: c.revisionHeight,
           isRenewed,
           renewedFrom: c.renewedFrom,
-          totalCost: new BigNumber(c.totalCost),
+          initialRenterFunds: new BigNumber(c.initialRenterFunds),
           spendingUploads: new BigNumber(c.spending.uploads),
           spendingDeletions: new BigNumber(c.spending.deletions),
           spendingSectorRoots: new BigNumber(c.spending.sectorRoots),

diff --git a/apps/renterd/contexts/contracts/types.ts b/apps/renterd/contexts/contracts/types.ts
@@ -37,7 +37,7 @@ export type ContractData = {
   proofWindowHeightEnd: number
   proofHeight: number
   revisionHeight: number
-  totalCost: BigNumber
+  initialRenterFunds: BigNumber
   spendingUploads: BigNumber
   spendingDeletions: BigNumber
   spendingSectorRoots: BigNumber
@@ -75,7 +75,7 @@ export type TableColumnId =
   | 'endTime'
   | 'size'
   | 'prunableSize'
-  | 'totalCost'
+  | 'initialRenterFunds'
   | 'spendingUploads'
   | 'spendingDeletions'
   | 'spendingFundAccount'
@@ -90,7 +90,7 @@ export const columnsDefaultVisible: TableColumnId[] = [
   'timeline',
   'size',
   'prunableSize',
-  'totalCost',
+  'initialRenterFunds',
   'spendingUploads',
   'spendingDeletions',
   'spendingFundAccount',
@@ -107,7 +107,7 @@ export type SortField =
   | 'endTime'
   | 'size'
   | 'prunableSize'
-  | 'totalCost'
+  | 'initialRenterFunds'
   | 'spendingUploads'
   | 'spendingDeletions'
   | 'spendingFundAccount'
@@ -166,8 +166,8 @@ export const sortOptions: {
     category: 'general',
   },
   {
-    id: 'totalCost',
-    label: 'total cost',
+    id: 'initialRenterFunds',
+    label: 'initial renter funds',
     category: 'financial',
   },
   {

diff --git a/apps/renterd/contexts/contracts/useFilteredStats.tsx b/apps/renterd/contexts/contracts/useFilteredStats.tsx
@@ -28,12 +28,12 @@ export function useFilteredStats({
     }, new BigNumber(0))
   }, [datasetFiltered])
 
-  const totalCostTotal = useMemo(() => {
+  const initialRenterFundsTotal = useMemo(() => {
     if (!datasetFiltered) {
       return undefined
     }
     return datasetFiltered.reduce((acc, datum) => {
-      return acc.plus(datum.totalCost)
+      return acc.plus(datum.initialRenterFunds)
     }, new BigNumber(0))
   }, [datasetFiltered])
 
@@ -77,7 +77,7 @@ export function useFilteredStats({
     return {
       sizeTotal,
       prunableSizeTotal,
-      totalCostTotal,
+      initialRenterFundsTotal,
       spendingUploadsTotal,
       spendingDeletionsTotal,
       spendingFundAccountTotal,
@@ -86,7 +86,7 @@ export function useFilteredStats({
   }, [
     sizeTotal,
     prunableSizeTotal,
-    totalCostTotal,
+    initialRenterFundsTotal,
     spendingUploadsTotal,
     spendingDeletionsTotal,
     spendingFundAccountTotal,

diff --git a/libs/react-core/README.md b/libs/react-core/README.md
@@ -89,7 +89,7 @@ function handleSubmit(values: Values) {
     payload: {
       contract: contractRevision
       startHeight: 40000
-      totalCost: '2424242421223232'
+      initialRenterFunds: '2424242421223232'
     }
   })
 }

diff --git a/libs/renterd-types/src/bus.ts b/libs/renterd-types/src/bus.ts
@@ -320,7 +320,7 @@ export type ContractsAddParams = {
 export type ContractsAddPayload = {
   contract: ContractRevision
   startHeight: number
-  totalCost: Currency
+  initialRenterFunds: Currency
 }
 export type ContractsAddResponse = Contract
 
@@ -331,7 +331,7 @@ export type ContractRenewedPayload = {
   contract: ContractRevision
   renewedFrom: string
   startHeight: number
-  totalCost: Currency
+  initialRenterFunds: Currency
 }
 export type ContractRenewedResponse = Contract
 

diff --git a/libs/renterd-types/src/types.ts b/libs/renterd-types/src/types.ts
@@ -155,7 +155,7 @@ export type Contract = {
   windowEnd: number
   renewedFrom: string
   spending: ContractSpending
-  totalCost: Currency
+  initialRenterFunds: Currency
   size: number
   state: ContractState
 }