fix: tweak payments language, fix minor flow issues (#22)

Author: rvagg

src/payments/auto.ts

@@ -39,7 +39,7 @@ function createSpinner() {
 
   if (isTTY) {
     // Use the real spinner for TTY
-    return clackSpinner()
+    return clackSpinner({ indicator: 'timer' })
   } else {
     // Non-TTY fallback - just print messages without spinners
     return {
@@ -252,7 +252,7 @@ export async function runAutoSetup(options: PaymentSetupOptions): Promise<void>
       // Display new permissions with capacity info
       const monthlyRate = allowances.ratePerEpoch * TIME_CONSTANTS.EPOCHS_PER_MONTH
       displayServicePermissions(
-        'New WarmStorage Service Permissions:',
+        'New WarmStorage Service Limits:',
         monthlyRate,
         allowances.lockupAmount,
         totalDeposit,
@@ -264,7 +264,7 @@ export async function runAutoSetup(options: PaymentSetupOptions): Promise<void>
       // Display current permissions with capacity info
       const monthlyRate = currentAllowances.rateAllowance * TIME_CONSTANTS.EPOCHS_PER_MONTH
       displayServicePermissions(
-        'Current WarmStorage Service Permissions:',
+        'Your Current WarmStorage Service Limits:',
         monthlyRate,
         currentAllowances.lockupAllowance,
         totalDeposit,

src/payments/interactive.ts

@@ -18,6 +18,7 @@ import {
   checkUSDFCBalance,
   createProvider,
   depositUSDFC,
+  displayCapacity,
   displayDepositWarning,
   displayServicePermissions,
   formatFIL,
@@ -80,7 +81,7 @@ export async function runInteractiveSetup(options: PaymentSetupOptions): Promise
     }
 
     // Step 2: Initialize Synapse
-    const s = spinner()
+    const s = spinner({ indicator: 'timer' })
     s.start('Initializing connection...')
 
     const rpcUrl = options.rpcUrl || RPC_URLS.calibration.websocket
@@ -206,7 +207,7 @@ export async function runInteractiveSetup(options: PaymentSetupOptions): Promise
     }
 
     // Step 5: Set storage allowances
-    console.log(`\n${pc.bold('WarmStorage Service Payment Limits:')}`)
+    console.log(`\n${pc.bold('Your Current WarmStorage Service Limits:')}`)
 
     // Show current allowances
     let currentAllowances = status.currentAllowances
@@ -223,17 +224,9 @@ export async function runInteractiveSetup(options: PaymentSetupOptions): Promise
       console.log(`  Max payment: ${formatUSDFC(monthlyRate)} USDFC/month`)
       console.log(`  Max reserve: ${formatUSDFC(currentAllowances.lockupAllowance)} USDFC (10-day lockup)`)
 
-      if (capacity.isDepositLimited) {
-        console.log(
-          `  → Current capacity: ~${capacity.actualGB.toLocaleString()} GB/month ${pc.yellow('(deposit-limited)')}`
-        )
-        console.log(`  → Potential: ~${capacity.potentialGB.toLocaleString()} GB/month`)
-      } else {
-        console.log(`  → Estimated capacity: ~${capacity.actualGB.toLocaleString()} GB/month`)
-        console.log(pc.gray('    (varies with CDN usage and data set fees)'))
-      }
+      displayCapacity(capacity)
     } else {
-      console.log(pc.gray('  No WarmStorage service permissions set yet'))
+      console.log(pc.gray('  No limits set yet'))
     }
 
     // Ask about setting/updating storage limits
@@ -252,7 +245,7 @@ export async function runInteractiveSetup(options: PaymentSetupOptions): Promise
       console.log(`\n${pc.bold('Storage Pricing:')}`)
       console.log(`  1 GiB/month: ${formatUSDFC(pricePerGiBPerMonth)} USDFC`)
       console.log(`  1 TiB/month: ${formatUSDFC(pricePerTiBPerMonth)} USDFC`)
-      console.log(pc.gray('  (WarmStorage service will reserve 10 days of costs as security)'))
+      console.log(pc.gray('  (for each upload, WarmStorage service will reserve 10 days of costs as security)'))
 
       const allowanceStr = await text({
         message: 'Enter storage allowance',
@@ -299,7 +292,7 @@ export async function runInteractiveSetup(options: PaymentSetupOptions): Promise
 
       // Display the new permissions with capacity info
       displayServicePermissions(
-        'New WarmStorage Service Permissions:',
+        'New WarmStorage Service Limits:',
         monthlyRate,
         allowances.lockupAmount,
         totalDeposit,
@@ -420,14 +413,6 @@ export async function runInteractiveSetup(options: PaymentSetupOptions): Promise
     const finalStatus = await getPaymentStatus(synapse)
     s.stop(`${pc.green('✓')} Setup complete`)
 
-    // Calculate actual vs potential capacity using existing pricePerTiBPerEpoch
-    const capacity = calculateActualCapacity(
-      finalStatus.depositedAmount,
-      finalStatus.currentAllowances.rateAllowance,
-      finalStatus.currentAllowances.lockupAllowance,
-      pricePerTiBPerEpoch
-    )
-
     // Final summary with three clear sections
     outro(pc.bold('━━━ Setup Complete ━━━'))
     console.log(`Network: ${pc.bold(network)}`)
@@ -444,21 +429,13 @@ export async function runInteractiveSetup(options: PaymentSetupOptions): Promise
 
     // Section 3: WarmStorage service permissions
     const monthlyRate = finalStatus.currentAllowances.rateAllowance * TIME_CONSTANTS.EPOCHS_PER_MONTH
-    console.log(`\n${pc.bold('WarmStorage Service Permissions')}`)
-    console.log(`  Max payment: ${formatUSDFC(monthlyRate)} USDFC/month`)
-    console.log(`  Max reserve: ${formatUSDFC(finalStatus.currentAllowances.lockupAllowance)} USDFC (10-day lockup)`)
-
-    if (capacity.isDepositLimited) {
-      console.log(
-        `  → Current capacity: ~${capacity.actualGB.toLocaleString()} GB/month ${pc.yellow('(deposit-limited)')}`
-      )
-      console.log(
-        `  → Potential: ~${capacity.potentialGB.toLocaleString()} GB/month (deposit ${formatUSDFC(capacity.additionalDepositNeeded)} more)`
-      )
-    } else {
-      console.log(`  → Estimated capacity: ~${capacity.actualGB.toLocaleString()} GB/month`)
-      console.log(pc.gray('    (varies with CDN usage and data set fees)'))
-    }
+    displayServicePermissions(
+      'Your WarmStorage Service Limits',
+      monthlyRate,
+      finalStatus.currentAllowances.lockupAllowance,
+      finalStatus.depositedAmount,
+      pricePerTiBPerEpoch
+    )
 
     // Show deposit warning if needed
     displayDepositWarning(finalStatus.depositedAmount, finalStatus.currentAllowances.lockupUsed)

src/payments/setup.ts

@@ -210,7 +210,9 @@ export async function calculateStorageAllowances(synapse: Synapse, tibPerMonth:
   const pricePerTiBPerEpoch = storageInfo.pricing.noCDN.perTiBPerEpoch
 
   // Calculate rate allowance (price for desired storage per epoch)
-  const ratePerEpoch = pricePerTiBPerEpoch * BigInt(Math.floor(tibPerMonth))
+  // Handle fractional TiB by converting to milliTiB for precision
+  const milliTiBPerMonth = Math.round(tibPerMonth * 1000)
+  const ratePerEpoch = (pricePerTiBPerEpoch * BigInt(milliTiBPerMonth)) / 1000n
 
   // Lockup is always 10 days worth of payments for WarmStorage
   const lockupAmount = ratePerEpoch * TIME_CONSTANTS.EPOCHS_PER_DAY * BigInt(DEFAULT_LOCKUP_DAYS)
@@ -469,27 +471,16 @@ export function displayPaymentSummary(
   // Section 3: WarmStorage service permissions
   if (rateAllowance > 0n) {
     const monthlyRate = rateAllowance * TIME_CONSTANTS.EPOCHS_PER_MONTH
-    console.log(`\n${pc.bold('WarmStorage Service Permissions')}`)
+    console.log(`\n${pc.bold('Your WarmStorage Service Limits')}`)
     console.log(`  Max payment: ${formatUSDFC(monthlyRate)} USDFC/month`)
     console.log(`  Max reserve: ${formatUSDFC(lockupAllowance)} USDFC (10-day lockup)`)
 
-    // Calculate actual vs potential capacity
+    // Calculate and display capacity
     const capacity = calculateActualCapacity(depositedAmount, rateAllowance, lockupAllowance, pricePerTiBPerEpoch)
-
-    if (capacity.isDepositLimited) {
-      console.log(
-        `  → Current capacity: ~${capacity.actualGB.toLocaleString()} GB/month ${pc.yellow('(deposit-limited)')}`
-      )
-      console.log(
-        `  → Potential: ~${capacity.potentialGB.toLocaleString()} GB/month (deposit ${formatUSDFC(capacity.additionalDepositNeeded)} more)`
-      )
-    } else {
-      console.log(`  → Estimated capacity: ~${capacity.actualGB.toLocaleString()} GB/month`)
-      console.log(pc.gray('    (varies with CDN usage and data set fees)'))
-    }
+    displayCapacity(capacity)
   } else {
-    console.log(`\n${pc.bold('WarmStorage Service Permissions')}`)
-    console.log(pc.gray('  No permissions set'))
+    console.log(`\n${pc.bold('Your WarmStorage Service Limits')}`)
+    console.log(pc.gray('  No limits set'))
   }
 }
 
@@ -522,6 +513,25 @@ export function displayDepositWarning(depositedAmount: bigint, lockupUsed: bigin
   }
 }
 
+/**
+ * Display capacity information based on deposit and limits
+ *
+ * @param capacity - Calculated capacity information
+ */
+export function displayCapacity(capacity: ReturnType<typeof calculateActualCapacity>): void {
+  if (capacity.isDepositLimited) {
+    console.log(
+      `  → Current capacity: ~${capacity.actualGB.toLocaleString()} GB/month ${pc.yellow('(deposit-limited)')}`
+    )
+    console.log(
+      `  → Potential: ~${capacity.potentialGB.toLocaleString()} GB/month (deposit ${formatUSDFC(capacity.additionalDepositNeeded)} more)`
+    )
+  } else {
+    console.log(`  → Estimated capacity: ~${capacity.actualGB.toLocaleString()} GB/month`)
+    console.log(pc.gray('    (excludes data set creation fee and optional CDN add-on rates)'))
+  }
+}
+
 /**
  * Display WarmStorage service permissions with capacity information
  *
@@ -546,17 +556,7 @@ export function displayServicePermissions(
   console.log(`  Max payment: ${formatUSDFC(monthlyRate)} USDFC/month`)
   console.log(`  Max reserve: ${formatUSDFC(lockupAmount)} USDFC (10-day lockup)`)
 
-  if (capacity.isDepositLimited) {
-    console.log(
-      `  → Current capacity: ~${capacity.actualGB.toLocaleString()} GB/month ${pc.yellow('(deposit-limited)')}`
-    )
-    console.log(
-      `  → Potential: ~${capacity.potentialGB.toLocaleString()} GB/month (deposit ${formatUSDFC(capacity.additionalDepositNeeded)} more)`
-    )
-  } else {
-    console.log(`  → Estimated capacity: ~${capacity.actualGB.toLocaleString()} GB/month`)
-    console.log(pc.gray('    (varies with CDN usage and data set fees)'))
-  }
+  displayCapacity(capacity)
 }
 
 /**

src/test/unit/payments-setup.test.ts

@@ -210,7 +210,19 @@ describe('Payment Setup Tests', () => {
       const allowances = await calculateStorageAllowances(mockSynapse, 0.5)
 
       expect(allowances.tibPerMonth).toBe(0.5)
-      expect(allowances.ratePerEpoch).toBe(0n) // Floor of 0.5 is 0
+      // 0.5 TiB = 500 milliTiB, so (0.0000565 * 500) / 1000 = 0.00002825
+      expect(allowances.ratePerEpoch).toBe(ethers.parseUnits('0.00002825', 18))
+    })
+
+    it('should calculate allowances for 1.5 TiB correctly', async () => {
+      const allowances = await calculateStorageAllowances(mockSynapse, 1.5)
+
+      expect(allowances.tibPerMonth).toBe(1.5)
+      // 1.5 TiB = 1500 milliTiB, so (0.0000565 * 1500) / 1000 = 0.00008475
+      expect(allowances.ratePerEpoch).toBe(ethers.parseUnits('0.00008475', 18))
+      expect(allowances.lockupAmount).toBe(
+        ethers.parseUnits('0.00008475', 18) * 2880n * 10n // rate * epochs/day * 10 days
+      )
     })
   })